GETTING STARTED

Getting Started

Amazon OAuth API

Obtain Shipping API Access Token
- /auth/o2/tokenpost

Shipping V2 APIs

Get Shipping Rate
- /shipping/v2/shipments/ratespost
Shipment Purchase API
- /shipping/v2/shipmentspost
Smart Shipment Purchase API
- /shipping/v2/oneClickShipmentpost
Shipment Tracking API
- /shipping/v2/trackingget
Cancel Shipment Label API
- /shipping/v2/shipments/{shipmentId}/cancelput
Regenerate Shipping Label
- /shipping/v2/shipments/{shipmentId}/documentsget
Obtain Delivery Counter Location API
- /shipping/v2/accessPointsget
Submit Non-Delivery Report API
- /shipping/v2/ndrFeedbackpost
Provide Additional Input API
- /shipping/v2/shipments/additionalInputs/schemaget

GETTING STARTED

Getting Started

Amazon OAuth API

Obtain Shipping API Access Token
- /auth/o2/tokenpost

Shipping V2 APIs

Get Shipping Rate
- /shipping/v2/shipments/ratespost
Shipment Purchase API
- /shipping/v2/shipmentspost
Smart Shipment Purchase API
- /shipping/v2/oneClickShipmentpost
Shipment Tracking API
- /shipping/v2/trackingget
Cancel Shipment Label API
- /shipping/v2/shipments/{shipmentId}/cancelput
Regenerate Shipping Label
- /shipping/v2/shipments/{shipmentId}/documentsget
Obtain Delivery Counter Location API
- /shipping/v2/accessPointsget
Submit Non-Delivery Report API
- /shipping/v2/ndrFeedbackpost
Provide Additional Input API
- /shipping/v2/shipments/additionalInputs/schemaget

/shipping/v2/shipments/{shipmentId}/cancel

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

Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.

URL Expired

The URL for this request expired after 30 days.

Path Params

shipmentId

string

required

The shipment identifier originally returned by the purchaseShipment operation.

Headers

x-amz-access-token

string

required

Amazon shipping request token

x-amzn-shipping-business-id

string

required

Amazon shipping business to assume for this request.

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.

Responses

Response body

object

payload

object

The payload for the cancelShipment operation.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.

Response body

object

errors

array of objects

required

errors*

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.

Updated 11 months ago

Cancel Shipment Label API

Regenerate Shipping Label

Did this page help you?

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/shipments/shipmentId/cancel \
3
     --header 'accept: application/json' \
4
     --header 'x-amzn-shipping-business-id: AmazonShipping_US'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 11 months ago

Cancel Shipment Label API

Regenerate Shipping Label

Did this page help you?

GETTING STARTED
Getting Started

Amazon OAuth API
Obtain Shipping API Access Token
/auth/o2/tokenpost

Shipping V2 APIs
Get Shipping Rate
/shipping/v2/shipments/ratespost
Shipment Purchase API
/shipping/v2/shipmentspost
Smart Shipment Purchase API
/shipping/v2/oneClickShipmentpost
Shipment Tracking API
/shipping/v2/trackingget
Cancel Shipment Label API
/shipping/v2/shipments/{shipmentId}/cancelput
Regenerate Shipping Label
/shipping/v2/shipments/{shipmentId}/documentsget
Obtain Delivery Counter Location API
/shipping/v2/accessPointsget
Submit Non-Delivery Report API
/shipping/v2/ndrFeedbackpost
Provide Additional Input API
/shipping/v2/shipments/additionalInputs/schemaget

GETTING STARTED
Getting Started

Amazon OAuth API
Obtain Shipping API Access Token
/auth/o2/tokenpost

Shipping V2 APIs
Get Shipping Rate
/shipping/v2/shipments/ratespost
Shipment Purchase API
/shipping/v2/shipmentspost
Smart Shipment Purchase API
/shipping/v2/oneClickShipmentpost
Shipment Tracking API
/shipping/v2/trackingget
Cancel Shipment Label API
/shipping/v2/shipments/{shipmentId}/cancelput
Regenerate Shipping Label
/shipping/v2/shipments/{shipmentId}/documentsget
Obtain Delivery Counter Location API
/shipping/v2/accessPointsget
Submit Non-Delivery Report API
/shipping/v2/ndrFeedbackpost
Provide Additional Input API
/shipping/v2/shipments/additionalInputs/schemaget

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.