---
title: "cancelShipment"
method: DELETE
path: "/mfn/v0/shipments/{shipmentId}"
tags: ["Merchant Fulfillment v0"]
---

# cancelShipment

`DELETE /mfn/v0/shipments/{shipmentId}`

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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

## Path parameters

- `shipmentId` string, required

## Response `200`

Success.

- CancelShipmentResponse — Response schema.
  - `payload` Shipment — A list of one or more shipments with respective details.
    - `vendorShipmentIdentifier` string, required — Unique Transportation ID created by Vendor (Should not be used over the last 365 days).
    - `transactionType` 'New' | 'Cancel', required — Indicates the type of transportation request (for example, `New` or `Cancel`). Each `transactionType` has a unique set of operations and there are corresponding details to be populated for each operation.
    - `buyerReferenceNumber` string — The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments.
    - `transactionDate` string, date-time, required — Date on which the transportation request was submitted.
    - `currentShipmentStatus` 'Created' | 'TransportationRequested' | 'CarrierAssigned' | 'Shipped' — Indicates the current shipment status.
    - `currentshipmentStatusDate` string, date-time — Date and time when the last status was updated.
    - `shipmentStatusDetails` ShipmentStatusDetails[] — Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response.
      - `shipmentStatus` 'Created' | 'TransportationRequested' | 'CarrierAssigned' | 'Shipped' — Current status of the shipment on whether it is picked up or scheduled.
      - `shipmentStatusDate` string, date-time — Date and time on last status update received for the shipment
    - `shipmentCreateDate` string, date-time — The date and time of the shipment request created by vendor.
    - `shipmentConfirmDate` string, date-time — The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.
    - `packageLabelCreateDate` string, date-time — The date and time of the package label created for the shipment by buyer.
    - `shipmentFreightTerm` 'Collect' | 'Prepaid' — Specifies if payment is Collect (WePay) or Prepaid (TheyPay). Required.
    - `sellingParty` PartyIdentification, required — Name/Address and tax details of the party.
      - `address` Address — Address of the party.
        - `name` string, required — The name of the person, business or institution at that address.
        - `addressLine1` string, required — First line of the address.
        - `addressLine2` string — Additional street address information, if required.
        - `addressLine3` string — Additional street address information, if required.
        - `city` string — The city where the person, business or institution is located.
        - `county` string — The county where person, business or institution is located.
        - `district` string — The district where person, business or institution is located.
        - `stateOrRegion` string — The state or region where person, business or institution is located.
        - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
        - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
        - `phone` string — The phone number of the person, business or institution located at that address.
      - `partyId` string, required — Assigned identification for the party.
      - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
        - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
        - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
    - `shipFromParty` PartyIdentification, required — Name/Address and tax details of the party.
      - `address` Address — Address of the party.
        - `name` string, required — The name of the person, business or institution at that address.
        - `addressLine1` string, required — First line of the address.
        - `addressLine2` string — Additional street address information, if required.
        - `addressLine3` string — Additional street address information, if required.
        - `city` string — The city where the person, business or institution is located.
        - `county` string — The county where person, business or institution is located.
        - `district` string — The district where person, business or institution is located.
        - `stateOrRegion` string — The state or region where person, business or institution is located.
        - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
        - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
        - `phone` string — The phone number of the person, business or institution located at that address.
      - `partyId` string, required — Assigned identification for the party.
      - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
        - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
        - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
    - `shipToParty` PartyIdentification, required — Name/Address and tax details of the party.
      - `address` Address — Address of the party.
        - `name` string, required — The name of the person, business or institution at that address.
        - `addressLine1` string, required — First line of the address.
        - `addressLine2` string — Additional street address information, if required.
        - `addressLine3` string — Additional street address information, if required.
        - `city` string — The city where the person, business or institution is located.
        - `county` string — The county where person, business or institution is located.
        - `district` string — The district where person, business or institution is located.
        - `stateOrRegion` string — The state or region where person, business or institution is located.
        - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
        - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
        - `phone` string — The phone number of the person, business or institution located at that address.
      - `partyId` string, required — Assigned identification for the party.
      - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
        - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
        - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
    - `shipmentMeasurements` TransportShipmentMeasurements — Shipment measurement details.
      - `totalCartonCount` integer — Total number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments.
      - `totalPalletStackable` integer — Total number of Stackable Pallets present in the shipment.
      - `totalPalletNonStackable` integer — Total number of Non Stackable Pallets present in the shipment.
      - `shipmentWeight` Weight — The weight of the shipment.
        - `unitOfMeasure` 'G' | 'Kg' | 'Oz' | 'Lb', required — The unit of measurement.
        - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
      - `shipmentVolume` Volume — The volume of the shipment.
        - `unitOfMeasure` 'CuFt' | 'CuIn' | 'CuM' | 'CuY', required — The unit of measurement.
        - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
    - `collectFreightPickupDetails` CollectFreightPickupDetails — Transport Request pickup date from Vendor Warehouse by Buyer
      - `requestedPickUp` string, date-time — Date on which the items can be picked up from vendor warehouse by Buyer used for WePay/Collect vendors.
      - `scheduledPickUp` string, date-time — Date on which the items are scheduled to be picked from vendor warehouse by Buyer used for WePay/Collect vendors.
      - `carrierAssignmentDate` string, date-time — Date on which the carrier is being scheduled to pickup items from vendor warehouse by Byer used for WePay/Collect vendors.
    - `purchaseOrders` PurchaseOrders[] — Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect)
      - `purchaseOrderNumber` string — Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment.
      - `purchaseOrderDate` string, date-time — Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment.
      - `shipWindow` string — Date range in which shipment is expected for these purchase orders.
      - `items` PurchaseOrderItems[] — A list of the items that are associated to the PO in this transport and their associated details.
        - `itemSequenceNumber` string, required — Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.
        - `buyerProductIdentifier` string — Amazon Standard Identification Number (ASIN) for a SKU
        - `vendorProductIdentifier` string — The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
        - `shippedQuantity` ItemQuantity, required — Details of item quantity.
          - `amount` integer, required — Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
          - `unitOfMeasure` 'Cases' | 'Eaches', required — Unit of measure for the shipped quantity.
          - `unitSize` integer — The case size, in the event that we ordered using cases. Otherwise, 1.
          - `totalWeight` TotalWeight — The total weight of units that are sold by weight in a shipment.
            - `unitOfMeasure` 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS', required — The unit of measure for the weight of items that are ordered by cases and support pricing by weight.
            - `amount` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `maximumRetailPrice` Money — An amount of money, including units in the form of currency.
          - `currencyCode` string, required — Three digit currency code in ISO 4217 format.
          - `amount` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
    - `importDetails` ImportDetails — Provide these fields only if this shipment is a direct import.
      - `methodOfPayment` 'PaidByBuyer' | 'CollectOnDelivery' | 'DefinedByBuyerAndSeller' | 'FOBPortOfCall' | 'PrepaidBySeller' | 'PaidBySeller' — This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment.
      - `sealNumber` string — The container's seal number.
      - `route` Route — This is used only for direct import shipment confirmations.
        - `stops` Stop[], required — The port or location involved in transporting the cargo, as specified in transportation contracts or operational plans.
          - `functionCode` 'PortOfDischarge' | 'FreightPayableAt' | 'PortOfLoading', required — Provide the function code.
          - `locationIdentification` Location — Location identifier.
            - `type` string — Type of location identification.
            - `locationCode` string — Location code.
            - `countryCode` string — The two digit country code. In ISO 3166-1 alpha-2 format.
          - `arrivalTime` string, date-time — Date and time of the arrival of the cargo.
          - `departureTime` string, date-time — Date and time of the departure of the cargo.
      - `importContainers` string — Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers.
      - `billableWeight` Weight — The weight of the shipment.
        - `unitOfMeasure` 'G' | 'Kg' | 'Oz' | 'Lb', required — The unit of measurement.
        - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
      - `estimatedShipByDate` string, date-time — Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future.
      - `handlingInstructions` 'Oversized' | 'Fragile' | 'Food' | 'HandleWithCare' — Identification of the instructions on how specified item/carton/pallet should be handled.
    - `containers` Containers[] — A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.
      - `containerType` 'carton' | 'pallet', required — The type of container.
      - `containerSequenceNumber` string — An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.
      - `containerIdentifiers` ContainerIdentification[], required — A list of carton identifiers.
        - `containerIdentificationType` 'SSCC' | 'AMZNCC' | 'GTIN' | 'BPS' | 'CID', required — The container identification type.
        - `containerIdentificationNumber` string, required — Container identification number that adheres to the definition of the container identification type.
      - `trackingNumber` string — The tracking number used for identifying the shipment.
      - `dimensions` Dimensions — Physical dimensional measurements of a container.
        - `length` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `width` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `height` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `unitOfMeasure` 'In' | 'Ft' | 'Meter' | 'Yard', required — The unit of measure for dimensions.
      - `weight` Weight — The weight of the shipment.
        - `unitOfMeasure` 'G' | 'Kg' | 'Oz' | 'Lb', required — The unit of measurement.
        - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
      - `tier` integer — Number of layers per pallet.
      - `block` integer — Number of cartons per layer on the pallet.
      - `innerContainersDetails` InnerContainersDetails — Details of the innerContainersDetails.
        - `containerCount` integer — Total containers as part of the shipment
        - `containerSequenceNumbers` ContainerSequenceNumbers[] — Container sequence numbers that are involved in this shipment.
          - `containerSequenceNumber` string — A list of containers shipped
      - `packedItems` PackedItems[] — A list of packed items.
        - `itemSequenceNumber` string — Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.
        - `buyerProductIdentifier` string — Buyer Standard Identification Number (ASIN) of an item.
        - `vendorProductIdentifier` string — The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
        - `packedQuantity` ItemQuantity — Details of item quantity.
          - `amount` integer, required — Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
          - `unitOfMeasure` 'Cases' | 'Eaches', required — Unit of measure for the shipped quantity.
          - `unitSize` integer — The case size, in the event that we ordered using cases. Otherwise, 1.
          - `totalWeight` TotalWeight — The total weight of units that are sold by weight in a shipment.
            - `unitOfMeasure` 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS', required — The unit of measure for the weight of items that are ordered by cases and support pricing by weight.
            - `amount` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
        - `itemDetails` PackageItemDetails — Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.
          - `purchaseOrderNumber` string — The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code.
          - `lotNumber` string — The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items.
          - `expiry` Expiry — Expiry refers to the collection of dates required for certain items. These could be either expiryDate or mfgDate and expiryAfterDuration. These are mandatory for perishable items.
            - `manufacturerDate` string, date-time — Production, packaging or assembly date determined by the manufacturer. Its meaning is determined based on the trade item context.
            - `expiryDate` string, date-time — The date that determines the limit of consumption or use of a product. Its meaning is determined based on the trade item context.
            - `expiryAfterDuration` Duration — Duration after manufacturing date during which the product is valid for consumption.
              - …
    - `transportationDetails` TransportationDetails — Transportation details for this shipment.
      - `shipMode` 'TruckLoad' | 'LessThanTruckLoad' | 'SmallParcel' — The type of shipment.
      - `transportationMode` 'Road' | 'Air' | 'Ocean' — The mode of transportation for this shipment.
      - `shippedDate` string, date-time — Date when shipment is performed by the Vendor to Buyer
      - `estimatedDeliveryDate` string, date-time — Estimated Date on which shipment will be delivered from Vendor to Buyer
      - `shipmentDeliveryDate` string, date-time — Date on which shipment will be delivered from Vendor to Buyer
      - `carrierDetails` CarrierDetails — Indicates the carrier details and their contact informations
        - `name` string — The field is used to represent the carrier used for performing the shipment.
        - `code` string — Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association).
        - `phone` string — The field is used to represent the Carrier contact number.
        - `email` string — The field is used to represent the carrier Email id.
        - `shipmentReferenceNumber` string — The field is also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for US, CA, MX shipment confirmations.
      - `billOfLadingNumber` string — The Bill of Lading (BOL) number is a unique number assigned to each shipment of goods by the vendor or shipper during the creation of the Bill of Lading. This number must be unique for every shipment and cannot be a date/time or single character. The BOL numer is mandatory in Shipment Confirmation message for FTL and LTL shipments, and must match the paper BOL provided with the shipment. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field.
  - `errors` Error[] — A list of error responses returned when a request is unsuccessful.
    - `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.

## Other responses

- `400` — Request has missing or invalid parameters and cannot be parsed.
- `401` — The request's authorization header is not formatted correctly or does not contain a valid token.
- `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
- `404` — The resource specified does not exist.
- `429` — The frequency of requests was greater than allowed.
- `500` — An unexpected condition occurred that prevented the server from fulfilling the request.
- `503` — Temporary overloading or maintenance of the server.

---

[API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)