Orders QueryAsk AIpost https://api.shipday.com/partner/ordersReturns a list of orders as per the defined query request object.Body ParamscompanyIdstringrequiredDefaults to 1234, 12345, 1236Single long value or comma separated long values inside quote for querying multiple companies. Examples: 1234 or "1234, 1235, 1236" or "1234"startTimedateDefaults to 2021-02-01T23:00:00ZISO-8601 format date-time in UTC. Starting point of the time range query Default:24 hours past from nowendTimedateDefaults to 2021-04-05T13:42:23ZISO-8601 format date-time in UTC. Ending point of the time range query. Default: current timestartCursorint32Defaults to 1Starting pointer of the retrieved order list. This marker is used for paginating the result.Default: 1endCursorint32Defaults to 25Ending 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: 100orderStatusstringenumDefaults to ACTIVEIndicates what category of orders to retrieve.ACTIVENOT_ASSIGNEDNOT_ACCEPTEDNOT_STARTED_YETSTARTEDPICKED_UPREADY_TO_DELIVERALREADY_DELIVEREDFAILED_DELIVERYINCOMPLETEShow 10 enum valuescarrierIdstringSingle long value or comma separated long values inside quote for querying multiple assigned carriers.pickupIdstringDefaults to TEST#234Manhattan23Pickup identifier. It needs to be exact match with case-sensitivity.HeadersPARTNER-API-KEYstringrequiredDefaults to <partner api key>acceptstringenumDefaults to application/jsonGenerated from available response content typesapplication/jsontext/plainAllowed:application/jsontext/plainResponses 200200 400400 401401 415415Updated 10 months ago
