POST api/mws/shipment/CancelShipment

Cancels an existing shipment. The CancelShipment operation cancels an existing shipment and requests a refund for the ShipmentId value that you specify. Get the ShipmentId value from a previous call to the CreateShipment operation. Canceling a shipment only succeeds if the cancellation window has not expired and if the shipment has not previously been canceled. Cancellation policies vary by carrier. For more information about carrier cancellation policies, see the Seller Central Help Creating new shipments after canceling These are conditions where you can create new shipments after canceling existing shipments: If only a single shipment was created to fulfill an order, you can cancel the shipment and then create a new shipment for that order using the CancelShipment operation. If multiple shipments were created to fulfill an order, you can cancel the shipments, but cannot create new shipments using the Merchant Fulfillment service. You will need to either create new shipments in Seller Central or arrange for shipping by contacting a carrier directly. Availability - This operation is only available in the Mexico, US, Germany, and UK marketplaces. Throttling - This operation has a maximum request quota of 10 and a restore rate of five requests every second.

Request Information

URI Parameters

None.

Body Parameters

SuiteBridge.Models.AmazonMWS.AmzShipmentRequest
NameDescriptionTypeAdditional information
ShipmentId

An Amazon-defined shipment identifier. Get the ShipmentId value from a previous call to the CreateShipment operation.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ShipmentId": "sample string 1"
}

application/xml, text/xml

Sample:
<AmzShipmentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ShipmentId>sample string 1</ShipmentId>
</AmzShipmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get Shipment Response

MWSMerchantFulfillmentService.Model.CancelShipmentResponse
NameDescriptionTypeAdditional information
CancelShipmentResult

Gets and sets the CancelShipmentResult property.

MWSMerchantFulfillmentService.Model.CancelShipmentResult

None.

ResponseMetadata

Gets and sets the ResponseMetadata property.

MWSMerchantFulfillmentService.Model.ResponseMetadata

None.

ResponseHeaderMetadata

Gets and sets the ResponseHeaderMetadata property.

MWSMerchantFulfillmentService.Model.ResponseHeaderMetadata

None.

Response Formats

application/json, text/json

Sample:
{
  "CancelShipmentResult": {
    "Shipment": {
      "ShipmentId": "sample string 1",
      "AmazonOrderId": "sample string 2",
      "SellerOrderId": "sample string 3",
      "ItemList": [
        {
          "OrderItemId": "sample string 1",
          "Quantity": 2.0
        },
        {
          "OrderItemId": "sample string 1",
          "Quantity": 2.0
        }
      ],
      "ShipFromAddress": {
        "Name": "sample string 1",
        "AddressLine1": "sample string 2",
        "AddressLine2": "sample string 3",
        "AddressLine3": "sample string 4",
        "DistrictOrCounty": "sample string 5",
        "Email": "sample string 6",
        "City": "sample string 7",
        "StateOrProvinceCode": "sample string 8",
        "PostalCode": "sample string 9",
        "CountryCode": "sample string 10",
        "Phone": "sample string 11"
      },
      "ShipToAddress": {
        "Name": "sample string 1",
        "AddressLine1": "sample string 2",
        "AddressLine2": "sample string 3",
        "AddressLine3": "sample string 4",
        "DistrictOrCounty": "sample string 5",
        "Email": "sample string 6",
        "City": "sample string 7",
        "StateOrProvinceCode": "sample string 8",
        "PostalCode": "sample string 9",
        "CountryCode": "sample string 10",
        "Phone": "sample string 11"
      },
      "PackageDimensions": {
        "Length": 1.0,
        "Width": 2.0,
        "Height": 3.0,
        "Unit": "sample string 4",
        "PredefinedPackageDimensions": "sample string 5"
      },
      "Weight": {
        "Value": 1.0,
        "Unit": "sample string 2"
      },
      "Insurance": {
        "CurrencyCode": "sample string 1",
        "Amount": 2.0
      },
      "ShippingService": {
        "ShippingServiceName": "sample string 1",
        "CarrierName": "sample string 2",
        "ShippingServiceId": "sample string 3",
        "ShippingServiceOfferId": "sample string 4",
        "ShipDate": "2026-01-12T23:56:52.620431+00:00",
        "EarliestEstimatedDeliveryDate": "2026-01-12T23:56:52.620431+00:00",
        "LatestEstimatedDeliveryDate": "2026-01-12T23:56:52.620431+00:00",
        "Rate": {
          "CurrencyCode": "sample string 1",
          "Amount": 2.0
        },
        "ShippingServiceOptions": {
          "DeliveryExperience": "sample string 1",
          "DeclaredValue": {
            "CurrencyCode": "sample string 1",
            "Amount": 2.0
          },
          "CarrierWillPickUp": true,
          "LabelFormat": "sample string 3"
        },
        "AvailableLabelFormats": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "Label": {
        "CustomTextForLabel": "sample string 1",
        "Dimensions": {
          "Length": 1.0,
          "Width": 2.0,
          "Unit": "sample string 3"
        },
        "FileContents": {
          "Contents": "sample string 1",
          "FileType": "sample string 2",
          "Checksum": "sample string 3"
        },
        "LabelFormat": "sample string 2",
        "StandardIdForLabel": "sample string 3"
      },
      "Status": "sample string 4",
      "TrackingId": "sample string 5",
      "CreatedDate": "2026-01-12T23:56:52.620431+00:00",
      "LastUpdatedDate": "2026-01-12T23:56:52.620431+00:00"
    }
  },
  "ResponseMetadata": {
    "RequestId": "sample string 1"
  },
  "ResponseHeaderMetadata": {
    "RequestId": null,
    "ResponseContext": "",
    "Timestamp": null,
    "QuotaMax": null,
    "QuotaRemaining": null,
    "QuotaResetsAt": null
  }
}

application/xml, text/xml

Sample:
<CancelShipmentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CancelShipmentResult>
    <Shipment>
      <ShipmentId>sample string 1</ShipmentId>
      <AmazonOrderId>sample string 2</AmazonOrderId>
      <SellerOrderId>sample string 3</SellerOrderId>
      <ItemList>
        <Item>
          <OrderItemId>sample string 1</OrderItemId>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <OrderItemId>sample string 1</OrderItemId>
          <Quantity>2</Quantity>
        </Item>
      </ItemList>
      <ShipFromAddress>
        <Name>sample string 1</Name>
        <AddressLine1>sample string 2</AddressLine1>
        <AddressLine2>sample string 3</AddressLine2>
        <AddressLine3>sample string 4</AddressLine3>
        <DistrictOrCounty>sample string 5</DistrictOrCounty>
        <Email>sample string 6</Email>
        <City>sample string 7</City>
        <StateOrProvinceCode>sample string 8</StateOrProvinceCode>
        <PostalCode>sample string 9</PostalCode>
        <CountryCode>sample string 10</CountryCode>
        <Phone>sample string 11</Phone>
      </ShipFromAddress>
      <ShipToAddress>
        <Name>sample string 1</Name>
        <AddressLine1>sample string 2</AddressLine1>
        <AddressLine2>sample string 3</AddressLine2>
        <AddressLine3>sample string 4</AddressLine3>
        <DistrictOrCounty>sample string 5</DistrictOrCounty>
        <Email>sample string 6</Email>
        <City>sample string 7</City>
        <StateOrProvinceCode>sample string 8</StateOrProvinceCode>
        <PostalCode>sample string 9</PostalCode>
        <CountryCode>sample string 10</CountryCode>
        <Phone>sample string 11</Phone>
      </ShipToAddress>
      <PackageDimensions>
        <Length>1</Length>
        <Width>2</Width>
        <Height>3</Height>
        <Unit>sample string 4</Unit>
        <PredefinedPackageDimensions>sample string 5</PredefinedPackageDimensions>
      </PackageDimensions>
      <Weight>
        <Value>1</Value>
        <Unit>sample string 2</Unit>
      </Weight>
      <Insurance>
        <CurrencyCode>sample string 1</CurrencyCode>
        <Amount>2</Amount>
      </Insurance>
      <ShippingService>
        <ShippingServiceName>sample string 1</ShippingServiceName>
        <CarrierName>sample string 2</CarrierName>
        <ShippingServiceId>sample string 3</ShippingServiceId>
        <ShippingServiceOfferId>sample string 4</ShippingServiceOfferId>
        <ShipDate>2026-01-12T23:56:52.620431+00:00</ShipDate>
        <EarliestEstimatedDeliveryDate>2026-01-12T23:56:52.620431+00:00</EarliestEstimatedDeliveryDate>
        <LatestEstimatedDeliveryDate>2026-01-12T23:56:52.620431+00:00</LatestEstimatedDeliveryDate>
        <Rate>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>2</Amount>
        </Rate>
        <ShippingServiceOptions>
          <DeliveryExperience>sample string 1</DeliveryExperience>
          <DeclaredValue>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Amount>2</Amount>
          </DeclaredValue>
          <CarrierWillPickUp>true</CarrierWillPickUp>
          <LabelFormat>sample string 3</LabelFormat>
        </ShippingServiceOptions>
        <AvailableLabelFormats>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </AvailableLabelFormats>
      </ShippingService>
      <Label>
        <CustomTextForLabel>sample string 1</CustomTextForLabel>
        <Dimensions>
          <Length>1</Length>
          <Width>2</Width>
          <Unit>sample string 3</Unit>
        </Dimensions>
        <FileContents>
          <Contents>sample string 1</Contents>
          <FileType>sample string 2</FileType>
          <Checksum>sample string 3</Checksum>
        </FileContents>
        <LabelFormat>sample string 2</LabelFormat>
        <StandardIdForLabel>sample string 3</StandardIdForLabel>
      </Label>
      <Status>sample string 4</Status>
      <TrackingId>sample string 5</TrackingId>
      <CreatedDate>2026-01-12T23:56:52.620431+00:00</CreatedDate>
      <LastUpdatedDate>2026-01-12T23:56:52.620431+00:00</LastUpdatedDate>
    </Shipment>
  </CancelShipmentResult>
  <ResponseMetadata>
    <RequestId>sample string 1</RequestId>
  </ResponseMetadata>
  <ResponseHeaderMetadata />
</CancelShipmentResponse>