API ReferenceTutorialsSupport
API Reference

Orders Query

post
https://api.shipday.com/partner/orders

Returns a list of orders as per the defined query request object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to 1234, 12345, 1236

Single long value or comma separated long values inside quote for querying multiple companies.

Examples: 1234 or "1234, 1235, 1236" or "1234"

date
Defaults to 2021-02-01T23:00:00Z

ISO-8601 format date-time in UTC. Starting point of the time range query

Default:24 hours past from now

date
Defaults to 2021-04-05T13:42:23Z

ISO-8601 format date-time in UTC. Ending point of the time range query.

Default: current time

int32
Defaults to 1

Starting pointer of the retrieved order list. This marker is used for paginating the result.

Default: 1

int32
Defaults to 25

Ending pointer of the retrieved order list. This marker is used for paginating the result. In combination with the startCursor it will determine which rows to return.

For example, startCursor=26 and endCursor=50 will return 25 orders data ranging from 26th to 50th rows sorted in descending order of order placement time having the most recent one at the top.

Default: 100

string
enum
Defaults to ACTIVE

Indicates what category of orders to retrieve.

string

Single long value or comma separated long values inside quote for querying multiple assigned carriers.

string
Defaults to TEST#234Manhattan23

Pickup identifier. It needs to be exact match with case-sensitivity.

Headers
string
required
Defaults to <partner api key>
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/plain

Updated 12 months ago