POST api/mws/shipment/CreateShipment

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. The CreateShipment operation also returns a Base64-encoded MD5 hash to validate the document data. Important: The CreateShipment operation returns a ShipmentId value. Be sure to store this value for future use, as it is a required request parameter for the GetShipment and CancelShipment operations. 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.AmzCreateShipmentRequest
NameDescriptionTypeAdditional information
ShipmentRequestDetails

Shipment information required for requesting shipping service offers or for creating a shipment.

MWSMerchantFulfillmentService.Model.ShipmentRequestDetails

Required

ShippingServiceId

An Amazon-defined shipping service identifier. Get the ShippingServiceId value from a previous call to the GetEligibleShippingServices operation.

string

Required

ShippingServiceOfferId

An Amazon-defined shipping service identifier. Get the ShippingServiceOfferId value from a previous call to the GetEligibleShippingServices operation.

string

None.

HazmatType

Hazardous materials options for a package. None - This package does not contain hazardous material. LQHazmat - This package contains limited quantities of hazardous material.

string

None.

UnzipLabelContent

Flag to return the content of the zip file Data for printing labels, in the form of a Base64-encoded string unzipped

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ShipmentRequestDetails": {
    "AmazonOrderId": "sample string 1",
    "SellerOrderId": "sample string 2",
    "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"
    },
    "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"
    },
    "MustArriveByDate": "2026-01-12T23:52:44.6242049+00:00",
    "ShipDate": "2026-01-12T23:52:44.6242049+00:00",
    "ShippingServiceOptions": {
      "DeliveryExperience": "sample string 1",
      "DeclaredValue": {
        "CurrencyCode": "sample string 1",
        "Amount": 2.0
      },
      "CarrierWillPickUp": true,
      "LabelFormat": "sample string 3"
    },
    "LabelCustomization": {
      "CustomTextForLabel": "sample string 1",
      "StandardIdForLabel": "sample string 2"
    }
  },
  "ShippingServiceId": "sample string 1",
  "ShippingServiceOfferId": "sample string 2",
  "HazmatType": "sample string 3",
  "UnzipLabelContent": true
}

application/xml, text/xml

Sample:
<AmzCreateShipmentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ShipmentRequestDetails>
    <AmazonOrderId>sample string 1</AmazonOrderId>
    <SellerOrderId>sample string 2</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>
    <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>
    <MustArriveByDate>2026-01-12T23:52:44.6242049+00:00</MustArriveByDate>
    <ShipDate>2026-01-12T23:52:44.6242049+00:00</ShipDate>
    <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>
    <LabelCustomization>
      <CustomTextForLabel>sample string 1</CustomTextForLabel>
      <StandardIdForLabel>sample string 2</StandardIdForLabel>
    </LabelCustomization>
  </ShipmentRequestDetails>
  <ShippingServiceId>sample string 1</ShippingServiceId>
  <ShippingServiceOfferId>sample string 2</ShippingServiceOfferId>
  <HazmatType>sample string 3</HazmatType>
  <UnzipLabelContent>true</UnzipLabelContent>
</AmzCreateShipmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Create Shipment Response

MWSMerchantFulfillmentService.Model.CreateShipmentResponse
NameDescriptionTypeAdditional information
CreateShipmentResult

Gets and sets the CreateShipmentResult property.

MWSMerchantFulfillmentService.Model.CreateShipmentResult

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:
{
  "CreateShipmentResult": {
    "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:52:44.6554564+00:00",
        "EarliestEstimatedDeliveryDate": "2026-01-12T23:52:44.6554564+00:00",
        "LatestEstimatedDeliveryDate": "2026-01-12T23:52:44.6554564+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:52:44.6554564+00:00",
      "LastUpdatedDate": "2026-01-12T23:52:44.6554564+00:00"
    }
  },
  "ResponseMetadata": {
    "RequestId": "sample string 1"
  },
  "ResponseHeaderMetadata": {
    "RequestId": null,
    "ResponseContext": "",
    "Timestamp": null,
    "QuotaMax": null,
    "QuotaRemaining": null,
    "QuotaResetsAt": null
  }
}

application/xml, text/xml

Sample:
<CreateShipmentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CreateShipmentResult>
    <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:52:44.6554564+00:00</ShipDate>
        <EarliestEstimatedDeliveryDate>2026-01-12T23:52:44.6554564+00:00</EarliestEstimatedDeliveryDate>
        <LatestEstimatedDeliveryDate>2026-01-12T23:52:44.6554564+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:52:44.6554564+00:00</CreatedDate>
      <LastUpdatedDate>2026-01-12T23:52:44.6554564+00:00</LastUpdatedDate>
    </Shipment>
  </CreateShipmentResult>
  <ResponseMetadata>
    <RequestId>sample string 1</RequestId>
  </ResponseMetadata>
  <ResponseHeaderMetadata />
</CreateShipmentResponse>