/shipping/v2/shipments/{shipmentId}/documents

get

https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/shipments/{shipmentId}/documents

Returns the shipping documents associated with a package in a shipment.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Path Params

shipmentId

string

required

The shipment identifier originally returned by the purchaseShipment operation.

Query Params

packageClientReferenceId

string

required

The package client reference identifier originally provided in the request body parameter for the getRates operation.

format

string

The file format of the document. Must be one of the supported formats returned by the getRates operation.

dpi

number

The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.

Headers

x-amz-access-token

string

required

Amazon shipping request token

x-amzn-shipping-business-id

string

enum

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Show Details

AmazonShipping_US	The United States Amazon shipping business.
AmazonShipping_IN	The India Amazon shipping business.
AmazonShipping_UK	The United Kingdom Amazon shipping business.
AmazonShipping_IT	The Italy Amazon shipping business.
AmazonShipping_ES	The Spain Amazon shipping business.
AmazonShipping_FR	The France Amazon shipping business.

Allowed:

Responses

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.