Shipping2 Service Description

The following methods are available at the servlet path /rest/1.3/shipping2
GET  /1.3/shipping2/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.

Request Parameters :

NameRequiredDescription
statusfalseCan be 'shipped', 'notshipped' or 'all' - to find related orders.
daysfalseReturn orders within the last n days. If start and end date are specified, they will take precedence over this value. If neither days, startDate or endDate is specified, it will default to last 30 days or orders.
startDatefalseInstead of using the days parameter, a user can specify a date range (yyyy-mm-dd). This is the start date
endDatefalseInstead of using the days parameter, a user can specify a date range (yyyy-mm-dd). This is the endDate
receiptfalseSearch the physical good order by receipt. If this parameter is specified, the other search parameters will be ignored.

Supported Output Types : application/xml, application/json

Required Roles : api_order_read, HAS_DEVELOPER_KEY

GET  /1.3/shipping2/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.

Request Parameters :

NameRequiredDescription
statusfalseCan be 'shipped', 'notshipped' or 'all' - to find related orders.
daysfalseReturn orders within the last n days. If start and end date are specified, they will take precedence over this value. If neither days, startDate or endDate is specified, it will default to last 30 days or orders.
startDatefalseInstead of using the days parameter, a user can specify a date range (yyyy-mm-dd). This is the start date
endDatefalseInstead of using the days parameter, a user can specify a date range (yyyy-mm-dd). This is the endDate
receiptfalseSearch the physical good order by receipt. If this parameter is specified, the other search parameters will be ignored.

Supported Output Types : application/xml, application/json

Required Roles : api_order_read, HAS_DEVELOPER_KEY

/1.3/shipping2/shipnotice
[Nested Service]
GET  /1.3/shipping2/schema
Returns the XML Schema that describes the format of the retrieved data when the shipping API calls are made.

Supported Output Types : application/xml