Search for existing orders.

get/api/v1/deliveryexperience/order/search

Request

Base URL
https://api.shipium.com
Auth
OAuth 2
Password
Token URLhttps://auth.shipium.com/oauth/token
Scopesdelivery-experience-service
TypeScript
https://skmtc.dev/shipium/apis/shipium-api/docs/api/v1/deliveryexperience/order/search/get.ts
A function with typed inputs. Its response is checked against the schema.

shipiumTenantIdstring

Whether to constrain the search to a specified Shipium tenantId.

associatedIdentifiersstring[]

Search by associated identifiers. Identifiers are not constrained to be unique across orders.

fromDatestring date-time

Bounds of the oldest orderDate to search for orders on

toDatestring date-time

Bounds of the newest orderDate to search for orders on

orderStatusesstring[]

Order statuses to constrain results by

includestring[]

All fields that should be included in the response. If this is not provided, all fields will be returned (other parameters may still filter fields).

anchorstring

Identifier for the current page of data.

countinteger

The number results to include on each page of the response

The results of the order.

resultsobject[]

Successful results from processing.

failuresobject[]

Any failures resulting from processing.