9999minutos
📖 Orders

Get orders

The following fields return in the responseBody the possible values by which the search can be filtered.

In case you want to clean the search, they should not be sent in the request.

FIELDS

search * It is used when you want to find a text within the values of the fields: "orders.orderNumber" or "orders.internalKey".

filters[fulfillmentStatus][] * It is used when you want to find a specific state in the field "orders.fulfillmentStatus". * Example: pending

filters[deliveryType][] * It is used when you want to find a specific value in the field "orders.deliveryType". * Example: SMD

get/api/v1/orders

Request

  • Base URL
    http://{{fulfillment_url}}
  • URL
    http://{{fulfillment_url}}/api/v1/orders
  • Auth
    HTTP bearer

Query parameters

pageinteger
searchstring

It is used when you want to find a text within the values of the fields: "orders.orderNumber" or "orders.internalKey".

filters[fulfillmentStatus][]string

It is used when you want to find a specific state in the field "orders.fulfillmentStatus". Example: pending

filters[deliveryType][]string

It is used when you want to find a specific value in the field "orders.deliveryType". Example: SMD

Headers

Content-Typestring
Acceptstring

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.