HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

Get all logistic orders paginated

post
https://example.com/v1/shop/logistic-orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 20

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort
int32
≥ 0
Defaults to 100
Body Params
accountCustomFieldValueCriteria
array of objects

Filter by account-level custom fields and their values.

accountCustomFieldValueCriteria
approvalIds
array of strings
approvalIds
boolean
date-time
date-time
customerAccountIds
array of strings
customerAccountIds
boolean

Filter orders that are marked as incidents.

string
required
logisticStatus
array of objects

Filter by one or more logistic order statuses.

offerCustomFieldValueCriteria
array of objects

Filter by offer-level custom fields and their values

offerCustomFieldValueCriteria
orderLogisticCustomFieldValueCriteria
array of objects

Filter by order-level custom fields and their values.

orderLogisticCustomFieldValueCriteria
paymentOptions
array of objects

Filter orders by available payment methods.

supplierIds
array of strings
supplierIds
date-time
date-time
Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

string

(Optional) Customer account ID in multi-account customer user.

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?