Shipnotice Service Description

The following methods are available at the servlet path /rest/1.3/shipping/shipnotice

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

Return Type: XML Schema of ShippingNotice object.

Supported Output Types : application/xml

POST /1.3/shipping/shipnotice/{receipt}
Creates a shipping notice for the given transaction.

Return Type: ShipNotice

Request Parameters :

Name Required Description
date true The shipping date (yyyy-mm-dd).
carrier true The shipping carrier.
tracking false The tracking id.
comments false The comments associated with the notice.
item false The sku/itemNo of the line item. This parameter is required if the transaction includes multiple physical items.

Supported Output Types : application/xml, application/json

Required Roles : api_order_read, api_order_write, HAS_DEVELOPER_KEY

GET /1.3/shipping/shipnotice/{receipt}
Returns the ship notices for the given transaction.

Return Type: List of ShipNotices

Supported Output Types : application/xml, application/json

Required Roles : api_order_read, HAS_DEVELOPER_KEY