searchOrders

Operation Id:
orders/orders/search/post [Official Documentaction]
Methods

  • orderPrepaidStatus String
  • ordersStatuses Array<String>
  • shippmentStatus 'all'|'received'|'non-received'
  • couriersName Array<String>
  • couriersId Array<Integer>
  • orderPaymentType String
  • withMissingSalesDocuments Array<String>
  • orderType 'wholesale'|'retail'|'dropshipping'|'deliverer'
  • dropshippingOrderStatus 'all'|'finished'|'canceled'|'notCanceled'
  • ordersIds Array<String>
  • ordersSerialNumbers Array<Integer>
  • clients Array<Object>
  • ordersRange Object
  • orderSource Object
  • products Array<Object>
  • resultsPage Integer
  • resultsLimit Integer
  • clientRequestInvoice String
  • packages Object
  • stocks Array<Object>
  • campaign Object
  • loyaltyPointsMode 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken'
  • orderOperatorLogin String
  • orderPackingPersonLogin String
  • ordersBy Array<Object>
  • searchingOperatorTypeMatch 'no_assignment'|'no_empty'|'empty'
  • ordersDelayed 'y'|'n'
  • showBundles Boolean
  • orderExternalId String
  • orderCurrency String
  • shopIds value: number|string|number[]|string[]
  • byPackageNumbers value: string|string[]
  • dates dateFrom: DateLike, dateTo: DateLike, type: "add"|"modified"|"dispatch"|"payment"|"last_payments_operation"|"declared_payments"
  • orderBy elementName: "id"|"sn"|"order_time"|"status"|"order_source"|"order_cost"|"discount_code"|"ready_to_send_date", descending: boolean
  • logins values: string|string[]
  • clientIds values: number|string|number[]|string[]
  • productIds values: number|string|number[]|string[]
  • stockIds values: number|string|number[]|string[]
  • campaignIds values: number|string|number[]|string[]
  • discountCodes values: string|string[]
  • hasProduct productId: number|string, sizeId: number|string
  • hasPackage orderHasPackage: boolean
  • fromAllegro allegroAccount: string
  • fromAmazon allegroAccount: string
  • fromEbay allegroAccount: string
Examples

This function filters the list of orders by the status "packed".

const result = await idosellRequest.searchOrders
	.ordersStatuses(["packed"])
	.exec()

This function filters and returns a list of orders with the order type "wholesale".

const result = await idosellRequest.searchOrders
	.orderType("wholesale")
	.exec()

This function sorts the list of orders in descending order based on the "sn" field.

const result = await idosellRequest.searchOrders
	.orderBy("sn", false)
	.exec()

This function returns a list of login records for the user "iai_demo".

const result = await idosellRequest.searchOrders
	.logins(["iai_demo"])
	.exec()

This function returns the orders in the list, starting from the second page and showing 10 orders per page.

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

This function retrieves the stock IDs for the first two orders in the searchOrders.

const result = await idosellRequest.searchOrders
	.stockIds(2)
	.exec()

This function checks if the list of orders has a product with the ID 13.

const result = await idosellRequest.searchOrders
	.hasProduct(13)
	.exec()

This function checks if the list of orders has a product with the ID 13 and size with ID 4.

const result = await idosellRequest.searchOrders
	.hasProduct(13,4)
	.exec()

This function returns the list of orders filtered by package number 5003724016.

const result = await idosellRequest.searchOrders
	.byPackageNumbers([5003724016])
	.exec()

This function checks if a list of orders has any packages.

const result = await idosellRequest.searchOrders
	.hasPackage()
	.exec()

This function returns a list of orders from shop with ID 3.

const result = await idosellRequest.searchOrders
	.shopIds([3])
	.exec()

This function returns a list of orders matched by Allegro auctions.

const result = await idosellRequest.searchOrders
	.fromAllegro()
	.exec()