Search for existing orders.

get

https://api.shipium.com/api/v1/deliveryexperience/order/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

shipiumTenantId

string

Whether to constrain the search to a specified Shipium tenantId.

associatedIdentifiers

array of strings

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

associatedIdentifiers

fromDate

date-time

Bounds of the oldest orderDate to search for orders on

toDate

date-time

Bounds of the newest orderDate to search for orders on

orderStatuses

array of strings

Order statuses to constrain results by

include

array of strings

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).

include

anchor

string

Identifier for the current page of data.

count

int32

The number results to include on each page of the response

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The results of the order.