cancelShipment

Cancel the shipment indicated by the specified shipment identifier.

Usage Plan:

Rate (requests per second)	Burst
1	1

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

Responses

🟢200OK

application/json

Success.

Headers

Body

Example

{
    "payload": {
        "destination": {
            "destinationType": "AMAZON_OPTIMIZED"
        },
        "freightInformation": {
            "declaredValue": {
                "amount": 5.5,
                "code": "CAD"
            },
            "freightClass": "FC_50"
        },
        "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
        "placementOptionId": "pl1234abcd-1234-abcd-5678-1234abcd5678",
        "selectedDeliveryWindow": {
            "availabilityType": "AVAILABLE",
            "deliveryWindowOptionId": "dw1234abcd-1234-abcd-5678-1234abcd5678",
            "editableUntil": "2024-01-05T20:00:00.000Z",
            "endDate": "2024-01-05T20:00:00.000Z",
            "startDate": "2024-01-05T14:00:00.000Z"
        },
        "shipmentConfirmationId": "shipmentConfirmationId",
        "shipmentId": "sh1234abcd-1234-abcd-5678-1234abcd5678",
        "source": {
            "sourceType": "SELLER_FACILITY"
        }
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request Code Samples

Responses