getReturns

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

  • order_sn Integer
  • return_id Integer
  • return_shipping_number String
  • range Object
  • results_limit Integer
  • results_page Integer
  • status Integer
  • return_ids Array<Integer>
  • stock_id Integer
  • bundleAsProducts Boolean
  • dates dateFrom: DateLike, dateTo: DateLike, type: "date_add"|"date_end"
Examples

This function retrieves the order serial number corresponding to the given parameter (3471).

const result = await idosellRequest.getReturns
	.order_sn(3471)
	.exec()

This function returns the return ID associated with the input value 179.

const result = await idosellRequest.getReturns
	.return_id(179)
	.exec()

This function retrieves the status of the returns for an item with the ID 14.

const result = await idosellRequest.getReturns
	.status(14)
	.exec()

This function retrieves a list of dates between "2023-12-01" and "2023-12-10" using the "date_add" method.

const result = await idosellRequest.getReturns
	.dates("2023-12-01", "2023-12-10", "date_add")
	.exec()

This function retrieves returns data for page 2 with 10 items per page.

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