GetManifestList
Request Data
<?xml version="1.0" encoding="UTF-8"?>
<Request>
<ManifestType>forward</ManifestType>
<Status>forward_shipped</Status>
<Limit>50</Limit>
<Offset>0</Offset>
</Request>
The XML tags have the following meaning:
Tag |
Type |
Describtion |
---|---|---|
ManifestType |
String |
Either 'forward' or 'return'. Mandatory. If omitted, or if an unsupported manifest type is supplied, an error 'E086: Manifest type "[supplied type]" is not valid'. |
Status |
String |
When set, limits the returned set of manifests to loose manifest, which Return only entries which fit the status provided. Possible values are 'forwardreadytoship', 'forwardreceived', 'forwardshipped', 'returnreadytoship', 'returnreceived' and 'returnshipped',. |
Limit |
Integer |
The maximum number of manifests that should be returned. |
Offset |
Integer |
Number of manifests to skip at the beginning of the list (i.e., an offset into the result set; toghether with the Limit parameter, simple resultset paging is possible; if you do page through results, note that the list of manifests might change during paging). |
Response Data
<?xml version="1.0" encoding="UTF-8"?>
<SuccessResponse>
<Head>
<RequestId></RequestId>
<RequestAction>GetManifestList</RequestAction>
<ResponseType>Manifests</ResponseType>
<Timestamp>2013-08-27T14:44:13+0000</Timestamp>
<TotalCount>15</TotalCount>
</Head>
<Body>
<Manifests>
<Manifest>
<ManifestId>1</ManifestId>
<ShipmentProvider>DHL</ShipmentProvider>
<TrackingCode>123ABC456EFG</TrackingCode>
<OrderItems>
<OrderItem>
<OrderItemId>1</OrderItemId>
<ReturnReason>Product not available</ReturnReason>
</OrderItem>
<OrderItem>
<OrderItemId>2</OrderItemId>
<ReturnReason/>
</OrderItem>
<OrderItem>
<OrderItemId>3</OrderItemId>
<ReturnReason/>
</OrderItem>
</OrderItems>
<Status>forward_ready_to_ship</Status>
<CreatedAt>2013-09-02 02:28:17</CreatedAt>
</Manifest>
</Manifests>
</Body>
</SuccessResponse>
The XML tags have the following meaning:
Value |
Type |
Describtion |
---|---|---|
ManifestId |
Unsigned |
Identifier of this manifest as assigned by SellerCenter. |
ShipmentProvider |
String |
Parcel service which is used to ship the manifest. |
TrackingCode |
String |
Identifier to track the progress of shipping the manifest. |
OrderItems |
Subsection |
Node that contains identifiers of all order items which are send within the manifest as well as the return reason. |
Status |
String |
Status of the manifest. |
CreatedAt |
DateTime |
Date and time when the manifest was created. |
Error Codes
Error Code |
Message |
---|---|
0 |
Invalid Manifest Type: %s |
0 |
Invalid Manifest Status: %s |