Get order list

Authentication: This method requires authentication.

Summary

Get Order List

Description

This method retrieves a list of orders. The list can be adjusted using limit to set a maximum number of orders, skip to skip a certain number of orders, and filter to customize the list based on a query, store IDs, or additional filters.

Parameters

limit

This is an optional parameter. It is a number defaulted to 10, if no value is provided. It is used to limit the number of orders returned.

skip

This is an optional parameter. It is a number defaulted to 0, if no value is provided. It is used to skip a particular number of orders in the order list.

filter

This is an optional object containing:

query: string. A string used to search the orders.
store_ids: [string]. An array of string, each string represents an ID of a store.
filter: [string]. An array of strings, each string represents an additional filter.

Query Parameters

name	type	data type	default	description
limit	optional	integer	20	number of orders
skip	optional	integer	0	number of orders to skip
filter	optional	object of filter	null	additional filter

Filter object

name	type	data type	default	description
query	optional	string	N/A	search query
store_ids	optional	array of string	N/A	limitation by store ids
filter	optional	array of string	N/A	filter by status

Response

The response data is an array of objects of this structure:

_id: integer

Unique id of order

title: string

Title of order (sets on creation)

_status: string

Current status of order (see Statuses)

_substatus: string

Current substatus of order (see Substatuses)

partner: string

Partner name for whom this order was created

partner_details: object

This property contains additional details about the order:

instock: boolean. Flag showing if all order items are in stock
store_id: string. Store id
store_title: string. Store title

created_at: string

String representing creation date of order

Good Response example

{
  "status": "ok",
  "statusCode": 200,
  "data": [
    {
      "_id": 0,
      "title": "your-order-title",
      "_status": "order-status",
      "_substatus": "order-substatus",
      "partner": "partner-name",
      "partner_details": {
        "instock": true,
        "store_id": "your-store-id",
        "store_title": "your-store-title"
      },
      "created_at": "2024-01-22T13:31:07.908Z"
    }
  ]
}

Bad Response Examples

http code	response example
`401`	see 401 Unauthorized
`422`	see 422 ValidationError

Last modified: 09 February 2024