| The following methods are available at the servlet path /rest/1.3/shipping | ||||||||||||||||||
| GET /1.3/shipping/schema Returns the XML Schema that describes the format of the retrieved data when the shipping API calls are made. Return Type: XML Schema of OrderShipData object. Supported Output Types : application/xml | ||||||||||||||||||
| GET /1.3/shipping/count Returns a count of physical goods orders matching the shipping criteria. An important point to note is that this method will only return shippable orders matching search criteria, so if a user wants to get all orders, they will need to use the Orders Service API. Return Type: List of OrderShipDatas (sorted by order date) Request Parameters :
Supported Output Types : application/xml, application/json Required Roles : api_order_read, HAS_DEVELOPER_KEY | ||||||||||||||||||
| /1.3/shipping/shipnotice [Nested Service] | ||||||||||||||||||
| GET /1.3/shipping/list List physical goods orders matching the shipping criteria. Only the first 100 orders will be returned. This method supports pagination, so if the second page of the next 100 items is required a request header 'Page' with value 2 will return them.This method will return 200 if all the orders have been obtained, or a 206 [Partial Return] if there are more results available. An important point to note is that this method will only return shippable orders matching search criteria, so if a user wants to get all orders, they will need to use the Orders Service API. Return Type: List of OrderShipDatas (sorted by order date) Request Parameters :
Supported Output Types : application/xml, application/json Required Roles : api_order_read, HAS_DEVELOPER_KEY |