Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.
The CreateShipment operation purchases shipping and returns PDF, PNG, or ZPL document data for a shipping label, depending on the carrier. Amazon compresses the document data before returning it as a Base64-encoded string. For information about extracting document data from a compressed file, see How to extract a shipping label file. The CreateShipment operation also returns a Base64-encoded MD5 hash to validate the document data. For definitions, see Terminology. For more information, see How to fulfill Seller Fulfilled Prime orders.
This operation is only available in the Canada, US, Mexico, Spain, UK, France, Germany, Italy, and India marketplaces.
This operation has a maximum request quota of 10 and a restore rate of five requests every second. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.
Name | Description | Required | Values |
---|---|---|---|
ShipmentRequestDetails | Shipment information required for creating a shipment. | Yes | Type: ShipmentRequestDetails |
ShippingServiceId |
An Amazon-defined
shipping service identifier. For definitions, see Terminology.
Get the ShippingServiceId value from a previous call to the GetEligibleShippingServices operation. |
Yes | Type: xs:string |
ShippingServiceOfferId |
An Amazon-defined
shipping service offer identifier. For definitions, see Terminology.
Get the ShippingServiceOfferId value from a previous call to the GetEligibleShippingServices operation. |
No | Type: xs:string |
HazmatType |
Hazardous materials options for a package.
Consult the terms and conditions for each carrier for more information about hazardous materials. |
No | Type: HazmatType |
LabelFormatOption | Label options. | No | LabelFormatOption elements:
|
ShipmentLevelSellerInputsList | A list of additional seller inputs, at the shipment level. | No | Type: ShipmentLevelSellerInputsList |
Name | Description |
---|---|
Shipment | The details of a shipment, including the shipment
status. Note: Calls to the
CreateShipment,
GetShipment, and
CancelShipment operations
return empty Phone and
Email elements in the
ShipToAddress response
element.
Type: Shipment |
For information about standard request requirements, see Required request parameters.
For domestic shipping.
https://mws.amazonservices.com/MerchantFulfillment/2015-06-01 &Action=CreateShipment &SellerId=A09087172RPFTMV0PGAN2 &SignatureVersion=2 &Timestamp=2015-09-23T20%3A10%3A56Z &Version=2015-06-01 &Signature=9jIwZLpoKQWja2BlY8TVWHN17UN2x7VIA%2FHib4U4QLA%3D &SignatureMethod=HmacSHA256 &HazmatType=None &ShippingServiceId=FEDEX_PTP_PRIORITY_OVERNIGHT &ShipmentRequestDetails.AmazonOrderId=903-1713775-3598252 &ShipmentRequestDetails.LabelCustomization.CustomTextForLabel=ABC123 &ShipmentRequestDetails.LabelCustomization.StandardIdForLabel=AmazonOrderId &ShipmentRequestDetails.MustArriveByDate=2015-09-25T07%3A00%3A00Z &ShipmentRequestDetails.PackageDimensions.Length=5 &ShipmentRequestDetails.PackageDimensions.Width=5 &ShipmentRequestDetails.PackageDimensions.Height=5 &ShipmentRequestDetails.PackageDimensions.Unit=inches &ShipmentRequestDetails.Weight.Value=10 &ShipmentRequestDetails.Weight.Unit=ounces &ShipmentRequestDetails.ShipDate=2015-09-23T20%3A10%3A56.829Z &ShipmentRequestDetails.ShipFromAddress.Name=John%20Doe &ShipmentRequestDetails.ShipFromAddress.AddressLine1=1234%20Westlake%20Ave &ShipmentRequestDetails.ShipFromAddress.City=Seattle &ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode=WA &ShipmentRequestDetails.ShipFromAddress.PostalCode=98121 &ShipmentRequestDetails.ShipFromAddress.CountryCode=US &ShipmentRequestDetails.ShipFromAddress.Email=example%40example.com &ShipmentRequestDetails.ShipFromAddress.Phone=2061234567 &ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience=DeliveryConfirmationWithoutSignature &ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp=false &ShipmentRequestDetails.ShippingServiceOptions.DeclaredValue.CurrencyCode=USD &ShipmentRequestDetails.ShippingServiceOptions.DeclaredValue.Amount=10.00 &ShipmentRequestDetails.ShippingServiceOptions.LabelFormat=ZPL203 &ShipmentRequestDetails.ItemList.Item.1.OrderItemId=40525960574974 &ShipmentRequestDetails.ItemList.Item.1.Quantity=2 &ShipmentRequestDetails.ItemList.Item.1.TransparencyCodeList.TransparencyCode.1=AZ:QFUL6MXBXE3A2EBC0 &ShipmentRequestDetails.ItemList.Item.1.TransparencyCodeList.TransparencyCode.2=ZA:QFUL6MXBXE3A2EBC0
For international shipping.
POST /MerchantFulfillment/2015-06-01?AWSAccessKeyId=AKIAEE2ISSMCQLNRUXDQ &Action=CreateShipment &SellerId=A46VPI2LR4OTS &SignatureVersion=2 &Timestamp=2019-10-23T22%3A26%3A40Z &Version=2015-06-01 &Signature=xTWZ4NT3UajzfMQsaxx4XSX2np%2F7ZT6SAqCRYpnu5mk%3D &SignatureMethod=HmacSHA256 &ShippingServiceId=CHINA_POST_E_COURIER_PRI &HazmatType=None &ShipmentRequestDetails.AmazonOrderId=911-3199039-9308631 &ShipmentRequestDetails.PackageDimensions.Length=15 &ShipmentRequestDetails.PackageDimensions.Width=5 &ShipmentRequestDetails.PackageDimensions.Height=5 &ShipmentRequestDetails.PackageDimensions.Unit=centimeters &ShipmentRequestDetails.Weight.Value=100 &ShipmentRequestDetails.Weight.Unit=grams &ShipmentRequestDetails.ShipFromAddress.Name=China%20warehouse &ShipmentRequestDetails.ShipFromAddress.AddressLine1=test%20line%201 &ShipmentRequestDetails.ShipFromAddress.City=Shenzhen &ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode=Guangdong &ShipmentRequestDetails.ShipFromAddress.PostalCode=510810 &ShipmentRequestDetails.ShipFromAddress.CountryCode=CN &ShipmentRequestDetails.ShipFromAddress.Email=test%40email.com &ShipmentRequestDetails.ShipFromAddress.Phone=123456789 &ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience=DeliveryConfirmationWithoutSignature &ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp=true &ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUpOption=CarrierWillPickUp &ShipmentRequestDetails.ShippingServiceOptions.DeclaredValue.CurrencyCode=CNY &ShipmentRequestDetails.ShippingServiceOptions.DeclaredValue.Amount=0 &ShipmentRequestDetails.ShippingServiceOptions.LabelFormat=PDF &ShipmentRequestDetails.ItemList.Item.1.OrderItemId=26969160673646 &ShipmentRequestDetails.ItemList.Item.2.OrderItemId=61995533938438 &ShipmentRequestDetails.ItemList.Item.1.Quantity=1 &ShipmentRequestDetails.ItemList.Item.2.Quantity=1 &ShipmentRequestDetails.ItemList.Item.1.ItemWeight.Value=100 &ShipmentRequestDetails.ItemList.Item.2.ItemWeight.Value=200 &ShipmentRequestDetails.ItemList.Item.1.ItemWeight.Unit=grams &ShipmentRequestDetails.ItemList.Item.2.ItemWeight.Unit=grams &ShipmentRequestDetails.ItemList.Item.1.ItemDescription=poster &ShipmentRequestDetails.ItemList.Item.2.ItemDescription=poster &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalInputFieldName=HS_CODE &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalSellerInput.DataType=STRING &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalSellerInput.ValueAsString=12345 &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalInputFieldName=ITEM_DESCRIPTION_TRANSLATED &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.DataType=STRING &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsString=%E6%9E%B6%E5%AD%90 &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalInputFieldName=ITEM_VALUE &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalSellerInput.DataType=CURRENCY &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalSellerInput.ValueAsCurrency.Amount=1 &ShipmentRequestDetails.ItemList.Item.1.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalSellerInput.ValueAsCurrency.CurrencyCode=USD &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalInputFieldName=HS_CODE &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalSellerInput.DataType=STRING &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalSellerInput.ValueAsString=23456 &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalInputFieldName=ITEM_DESCRIPTION_TRANSLATED &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.DataType=STRING &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsString=%E6%B5%B7%E6%8A%A5 &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalInputFieldName=ITEM_VALUE &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalSellerInput.DataType=CURRENCY &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalSellerInput.ValueAsCurrency.Amount=0.7 &ShipmentRequestDetails.ItemList.Item.2.ItemLevelSellerInputsList.AdditionalSellerInputs.3.AdditionalSellerInput.ValueAsCurrency.CurrencyCode=USD &LabelFormatOption.IncludePackingSlipWithLabel=false &ShipmentLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalInputFieldName=NON_DELIVERABLE_INSTRUCTIONS &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalInputFieldName=SENDER_ADDRESS_TRANSLATED &ShipmentLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalSellerInput.DataType=STRING &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.DataType=ADDRESS &ShipmentLevelSellerInputsList.AdditionalSellerInputs.1.AdditionalSellerInput.ValueAsString=RETURN_TO_SELLER &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.Name=%E4%B8%AD%E5%9B%BD%E4%BB%93%E5%BA%93 &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.AddressLine1=%E6%B5%8B%E8%AF%95%E8%A1%8C &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.City=%E6%B7%B1%E5%9C%B3 &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.StateOrProvinceCode=%E5%B9%BF%E4%B8%9C &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.PostalCode=510810 &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.CountryCode=CN &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.Email=test%40email.com &ShipmentLevelSellerInputsList.AdditionalSellerInputs.2.AdditionalSellerInput.ValueAsAddress.Phone=123456789
For information about standard response formatting, see Response format.
<?xml version="1.0"?> <CreateShipmentResponse xmlns="https://mws.amazonservices.com /MerchantFulfillment/2015-06-01"> <CreateShipmentResult> <Shipment> <Insurance> <CurrencyCode>USD</CurrencyCode> <Amount>10.00</Amount> </Insurance> <ShipToAddress> <City>Seattle</City> <Phone/> <CountryCode>US</CountryCode> <PostalCode>98121-2778</PostalCode> <Name>Jane Smith</Name> <AddressLine1>321 Main St</AddressLine1> <StateOrProvinceCode>WA</StateOrProvinceCode> <Email/> </ShipToAddress> <AmazonOrderId>903-1713775-3598252</AmazonOrderId> <Weight> <Value>10</Value> <Unit>oz</Unit> </Weight> <Label> <CustomTextForLabel>ABC123</CustomTextForLabel> <LabelFormat>ZPL203</LabelFormat> <FileContents> <Checksum>DmsWbJpdMPALN3jV4wHOrg==</Checksum> <Contents>H4sIAAAAAAAAAK16WbeqyrLmO2Pc/zBVRLG... ...kI0Ycv76w378UfL6O6ev7UsAwmkWBfL6nycD/Bd+Zx3S8LwAA</Contents> <FileType>application/zpl</FileType> <LabelFormat>ZPL203</LabelFormat> </FileContents> <Dimensions> <Width>8.50000</Width> <Length>11.00000</Length> <Unit>inches</Unit> </Dimensions> <StandardIdForLabel>AmazonOrderId</StandardIdForLabel> </Label> <ShippingService> <CarrierName>FEDEX</CarrierName> <ShippingServiceOptions> <CarrierWillPickUp>false</CarrierWillPickUp> <DeclaredValue> <CurrencyCode>USD</CurrencyCode> <Amount>10.00</Amount> </DeclaredValue> <DeliveryExperience>DELIVERY_CONFIRMATION </DeliveryExperience> </ShippingServiceOptions> <ShippingServiceId>FEDEX_PTP_PRIORITY_OVERNIGHT </ShippingServiceId> <Rate> <CurrencyCode>USD</CurrencyCode> <Amount>27.81</Amount> </Rate> <LatestEstimatedDeliveryDate>2015-09-24T10:30:00Z </LatestEstimatedDeliveryDate> <EarliestEstimatedDeliveryDate>2015-09-24T10:30:00Z </EarliestEstimatedDeliveryDate> <ShippingServiceOfferId>HDDUKqtQVFetpBZAqx5c1yaCZ9vuFfND0kudyw3lLWCa 3mN2+zUOsRCAZS2oYt0ey6fXKdOAucmYVXR9LAkU9O9eys9V3FJCgvQ+vAqm4bSAzHVH04vD8oLy oUPKqxa8Otbek97Z85LFUSsfcUf8frNRMEfNLP8t5RyLXa4ZOjc=</ShippingServiceOfferId> <ShipDate>2015-09-23T20:10:56.829Z</ShipDate> <ShippingServiceName>FedEx Priority Overnight®</ShippingServiceName> </ShippingService> <PackageDimensions> <Width>5</Width> <Length>5</Length> <Unit>inches</Unit> <Height>5</Height> </PackageDimensions> <CreatedDate>2015-09-23T20:11:12.908Z</CreatedDate> <ShipFromAddress> <City>Seattle</City> <Phone>2061234567</Phone> <CountryCode>US</CountryCode> <PostalCode>98121</PostalCode> <Name>John Doe</Name> <AddressLine1>1234 Westlake Ave</AddressLine1> <StateOrProvinceCode>WA</StateOrProvinceCode> </ShipFromAddress> <ShipmentId>6f77095e-9f75-47eb-aaab-a42d5428fa1a</ShipmentId> <ItemList> <Item> <OrderItemId>40525960574974</OrderItemId> <Quantity>1</Quantity> <ItemWeight>200</ItemWeight> <ItemDescription>Poster</ItemDescription> </Item> </ItemList> <Status>Purchased</Status> <TrackingId>794657111237</TrackingId> </Shipment> </CreateShipmentResult> <ResponseMetadata> <RequestId>adb18f0d-2076-48d4-99ef-fb4b9f892a4e</RequestId> </ResponseMetadata> </CreateShipmentResponse>