getClients

Operation Id:
clients/clients/get [Official Documentaction]
Methods

  • clientsIds Array<Integer>
  • clientCodesExternal Array<String>
  • clientTextSearch String
  • clientIsActive 'yes'|'no'
  • clientHasTradeCredit 'nonzero'|'positive'|'negative'|'zero'
  • clientLastPurchaseDate Object
  • clientsLastModificationDate Object
  • returnElements Array<String>
  • resultsPage Integer
  • resultsLimit Integer
  • clientRegistrationDate Object
  • shopId String
Examples

This function returns the client IDs for the clients with IDs 123, 456, and 789.

const result = await idosellRequest.getClients
	.clientsIds([123,456,789])
	.exec()

This function checks if the client has a trade credit greater than zero.

const result = await idosellRequest.getClients
	.clientHasTradeCredit("nonzero")
	.exec()

This function retrieves the last purchase made by clients between January 1, 2023, and January 10, 2023.

const result = await idosellRequest.getClients
	.lastPurchased("2023-01-01", "2023-01-10")
	.exec()

This function retrieves the clients on page 2 with a limit of 10 clients per page.

const result = await idosellRequest.getClients
	.page(2,10)
	.exec()