Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

GetEligibleShippingServices

Returns a list of shipping service offers.

Description

The GetEligibleShippingServices operation returns a list of shipping service offers that satisfy the shipment request details that you specify. Use this operation to find a shipping service offer that meets your requirements. If the shipping service offer that you choose requires additional seller inputs (when RequiresAdditionalSellerInputs=true), you must call the GetAdditionalSellerInputs operation to find out which additional seller inputs are required. Specify the ShippingServiceId associated with the shipping service that you want. Get the required additional seller input values from the seller and use them as input to the CreateShipment operation. Specify the ShippingServiceId value, the additional seller inputs (if required), and the optional ShippingServiceOfferId value associated with this shipping service offer. For definitions, see Terminology.

Availability

This operation is only available in the Canada, US, Mexico, Spain, UK, France, Germany, Italy, and India marketplaces.

Throttling

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.

Request parameters

Name Description Required Values
ShipmentRequestDetails Shipment information required for requesting shipping service offers. Yes Type: ShipmentRequestDetails
ShippingOfferingFilter Specifies particular requirements for eligible shipping service offers. No Type: ShippingOfferingFilter

Response elements

Name Description
ShippingServiceList A list of shipping services offers.

Type: List of ShippingService

RejectedShippingServiceList A list of ineligible shipping services.

Type: List of RejectedShippingService

TemporarilyUnavailableCarrierList A list of carriers who are temporarily unavailable, most likely due to a service outage experienced by the carrier. To use a carrier that is on this list, retry at a later time.

Type: List of TemporarilyUnavailableCarrier

TermsAndConditionsNotAcceptedCarrierList A list of carriers whose terms and conditions have not been accepted by the seller. The seller must accept Amazon's terms and conditions and the terms and conditions of any carrier from which they want to purchase shipping labels. The seller can do this on Seller Central (Europe) (US).

Type: List of TemporarilyUnavailableCarrier

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

For domestic shipping (&ShippingOfferingFilter.IncludeComplexShippingOptions=false)

https://mws.amazonservices.com/MerchantFulfillment/2015-06-01
  &Action=GetEligibleShippingServices
  &SellerId=A09087172RPFTMV0PGAN2
  &SignatureVersion=2
  &Timestamp=2015-09-23T18%3A36%3A26Z
  &Version=2015-06-01
  &Signature=vMf6thsqGxfVy2EZBsH5sBPJxQe6VzKL9jli8eS7tvM%3D
  &SignatureMethod=HmacSHA256
  &ShipmentRequestDetails.AmazonOrderId=903-9939455-1336669
  &ShipmentRequestDetails.MustArriveByDate=2015-09-28T07%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-23T19%3A32%3A08.727Z
  &ShipmentRequestDetails.ShipFromAddress.Name=John%20Doe
  &ShipmentRequestDetails.ShipFromAddress.AddressLine1=1234%20Westlake%20Ave%20N
  &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.ItemList.Item.1.OrderItemId=28207139993814
  &ShipmentRequestDetails.ItemList.Item.1.Quantity=1
  &ShippingOfferingFilter.IncludeComplexShippingOptions=false

For international shipping (&ShippingOfferingFilter.IncludeComplexShippingOptions=true)

https://mws.amazonservices.com/MerchantFulfillment/2015-06-01
  &Action=GetEligibleShippingServices
  &SellerId= A46VPI2LR4OTS
  &SignatureVersion=2
  &Timestamp=2019-08-07T18%3A28%3A06Z
  &Version=2015-06-01
  &Signature=upzMoYiuk61LuT3eMkSnSqLHQJHoZfFX3iwxjeV%2F3Qg%3D
  &SignatureMethod=HmacSHA256
  &ShipmentRequestDetails.AmazonOrderId=922-2942641-9412606
  &ShipmentRequestDetails.MustArriveByDate=2019-09-10T07%3A00%3A00Z
  &ShipmentRequestDetails.PackageDimensions.Length=15
  &ShipmentRequestDetails.PackageDimensions.Width=5
  &ShipmentRequestDetails.PackageDimensions.Height=5
  &ShipmentRequestDetails.PackageDimensions.Unit=centimeters
  &ShipmentRequestDetails.Weight.Value=10
  &ShipmentRequestDetails.Weight.Unit=grams
  &ShipmentRequestDetails.ShipDate=2019-08-08T07%3A00%3A00Z
  &ShipmentRequestDetails.ShipFromAddress.Name=Shenzhen%20Address
  &ShipmentRequestDetails.ShipFromAddress.AddressLine1=test%20address
  &ShipmentRequestDetails.ShipFromAddress.City=Shenzhen
  &ShipmentRequestDetails.ShipFromAddress.StateOrProvinceCode=Guangdong
  &ShipmentRequestDetails.ShipFromAddress.PostalCode=510810
  &ShipmentRequestDetails.ShipFromAddress.CountryCode=CN
  &ShipmentRequestDetails.ShipFromAddress.Email=example%40example.com
  &ShipmentRequestDetails.ShipFromAddress.Phone=555-555-5555
  &ShipmentRequestDetails.ShippingServiceOptions.DeliveryExperience=DeliveryConfirmationWithoutSignature
  &ShipmentRequestDetails.ShippingServiceOptions.CarrierWillPickUp=true
  &ShipmentRequestDetails.ShippingServiceOptions.LabelFormat=ShippingServiceDefault
  &ShipmentRequestDetails.ItemList.Item.1.OrderItemId=26249797786670
  &ShipmentRequestDetails.ItemList.Item.1.Quantity=1
  &ShippingOfferingFilter.IncludePackingSlipWithLabel=false
  &ShippingOfferingFilter.IncludeComplexShippingOptions=true

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

For shipping that does not require additional seller inputs.

<?xml version="1.0"?>
<GetEligibleShippingServicesResponse
    xmlns="https://mws.amazonservices.com/MerchantFulfillment/2015-06-01">
    <GetEligibleShippingServicesResult>
        <ShippingServiceList>
            <ShippingService>
                <ShippingServiceName>UPS Ground</ShippingServiceName>
                <CarrierName>UPS</CarrierName>
                <ShippingServiceId>UPS_PTP_GND</ShippingServiceId>
                <ShippingServiceOfferId>ly51yzA1nAXlJzmYlKaH+7WbKOWz2BTujIOPx5PU8luilmZYK/JFhbx177aKey8MdZcG90uABbT5q8WAgPI+uxcxx/XDtIbI7c161j5spbfsiPTwIJg4Bk66bnP6Ip+JJtuSU5++rAdv4mzXvKpisLGYGrc+FuJvBAjTersJhq4=</ShippingServiceOfferId>
                <ShipDate>10/16/2018 07:41:12</ShipDate>
                <EarliestEstimatedDeliveryDate>10/18/2018 02:00:00</EarliestEstimatedDeliveryDate>
                <LatestEstimatedDeliveryDate>10/18/2018 02:00:00</LatestEstimatedDeliveryDate>
                <Rate>
                    <CurrencyCode>USD</CurrencyCode>
                    <Amount>16.83</Amount>
                </Rate>
                <ShippingServiceOptions>
                    <DeliveryExperience>DeliveryConfirmationWithoutSignature</DeliveryExperience>
                    <CarrierWillPickUp>False</CarrierWillPickUp>
                </ShippingServiceOptions>
                <AvailableLabelFormats>
                    <LabelFormat>ZPL203</LabelFormat>
                    <LabelFormat>ShippingServiceDefault</LabelFormat>
                    <LabelFormat>PDF</LabelFormat>
                    <LabelFormat>PNG</LabelFormat>
                </AvailableLabelFormats>
                <RequiresAdditionalSellerInputs>False</RequiresAdditionalSellerInputs>
            </ShippingService>
        </ShippingServiceList>
        <RejectedShippingServiceList>
            <RejectedShippingService>
                <CarrierName>UPS</CarrierName>
                <ShippingServiceId>UPS_PTP_3DS</ShippingServiceId>
                <RejectionReasonCode>INELIGIBLE</RejectionReasonCode>
                <RejectionReasonMessage>This ship method is not eligible for this
                    order.</RejectionReasonMessage>
                <ShippingServiceName>UPS Three Day Saver</ShippingServiceName>
            </RejectedShippingService>
        </RejectedShippingServiceList>
        <TemporarilyUnavailableCarrierList>
            <TemporarilyUnavailableCarrier>
                <CarrierName>DYNAMEX</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>USPS</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>DHLECOMMERCE</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>SELF_DELIVERY</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>ONTRAC</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>DHLMX</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>DHLM</CarrierName>
            </TemporarilyUnavailableCarrier>
            <TemporarilyUnavailableCarrier>
                <CarrierName>FEDEX</CarrierName>
            </TemporarilyUnavailableCarrier>
        </TemporarilyUnavailableCarrierList>
        <TermsAndConditionsNotAcceptedCarrierList>
            <TermsAndConditionsNotAcceptedCarrier>
                <CarrierName>AMZN_US</CarrierName>
            </TermsAndConditionsNotAcceptedCarrier>
            <TermsAndConditionsNotAcceptedCarrier>
                <CarrierName>ONTRAC</CarrierName>
            </TermsAndConditionsNotAcceptedCarrier>
        </TermsAndConditionsNotAcceptedCarrierList>
    </GetEligibleShippingServicesResult>
    <ResponseMetadata>
        <RequestId>5b7997fb-efd1-495b-b7db-03ecfa691038</RequestId>
    </ResponseMetadata>
</GetEligibleShippingServicesResponse>

For shipping that requires additional seller inputs.

<?xml version="1.0"?>
<GetEligibleShippingServicesResponse
    xmlns="https://mws.amazonservices.com/MerchantFulfillment/2015-06-01">
    <GetEligibleShippingServicesResult>
        <ShippingServiceList>
            <ShippingService>
                <EarliestEstimatedDeliveryDate>2019-08-27T18:00:00Z</EarliestEstimatedDeliveryDate>
                <AvailableLabelFormats>
                    <LabelFormat>ShippingServiceDefault</LabelFormat>
                    <LabelFormat>PDF</LabelFormat>
                </AvailableLabelFormats>
                <ShipDate>2019-08-08T07:00:00Z</ShipDate>
                <RequiresAdditionalSellerInputs>true</RequiresAdditionalSellerInputs>
                <AvailableFormatOptionsForLabel>
                    <LabelFormatOption>
                        <IncludePackingSlipWithLabel>false</IncludePackingSlipWithLabel>
                        <LabelFormat>ShippingServiceDefault</LabelFormat>
                    </LabelFormatOption>
                    <LabelFormatOption>
                        <IncludePackingSlipWithLabel>false</IncludePackingSlipWithLabel>
                        <LabelFormat>PDF</LabelFormat>
                    </LabelFormatOption>
                </AvailableFormatOptionsForLabel>
                <ShippingServiceName>CHINA_POST_E_EMS</ShippingServiceName>
                <CarrierName>CHINA_POST</CarrierName>
                <ShippingServiceOptions>
                    <CarrierWillPickUp>true</CarrierWillPickUp>
                    <DeliveryExperience>DeliveryConfirmationWithoutSignature</DeliveryExperience>
                </ShippingServiceOptions>
                <ShippingServiceId>CHINA_POST_E_EMS</ShippingServiceId>
                <Rate>
                    <CurrencyCode>CNY</CurrencyCode>
                    <Amount>90.00</Amount>
                </Rate>
                <LatestEstimatedDeliveryDate>2019-08-27T18:00:00Z</LatestEstimatedDeliveryDate>
                <ShippingServiceOfferId>NH0sNBYSrqUP2+5yJdI14yLsCwFfk2413sYQHKbp0ILv8xkJemzkFK/wgUXeC9y4j6dNKuYn3EpQh7YJSc4gvPUfNDsISoAi9tCikbPjI5KOajdY75KvPLXPEC57Od/gAlOQv07JravlVU6oURFoVtc8nwZDviBPfA43owEPmxPglPTttIuS9LfcI0ky/kIP/OT7h+acfQj8JxAtomwX1WUYGZSbzkSL9c6ic5CAeriif1Kr0k8Y0RuloSZs2ZQwOv//nLvV3ZCZic8vU8cGVGHExM9sMKamBDopoh0Kx2JHcDwWHDcKB+lOntkABC84</ShippingServiceOfferId>
            </ShippingService>
        </ShippingServiceList>
        <RejectedShippingServiceList>
            <RejectedShippingService>
                <CarrierName>CHINA_POST</CarrierName>
                <ShippingServiceId>CHINA_POST_E_PACKET</ShippingServiceId>
                <RejectionReasonCode>INELIGIBLE</RejectionReasonCode>
                <RejectionReasonMessage>This ship method is not eligible for this
                    order.</RejectionReasonMessage>
                <ShippingServiceName>China Post e-Packet</ShippingServiceName>
            </RejectedShippingService>
        </RejectedShippingServiceList>
        <TermsAndConditionsNotAcceptedCarrierList>
            <TermsAndConditionsNotAcceptedCarrier>
                <CarrierName>DHL</CarrierName>
            </TermsAndConditionsNotAcceptedCarrier>
        </TermsAndConditionsNotAcceptedCarrierList>
        <TemporarilyUnavailableCarrierList>
            <TemporarilyUnavailableCarrier>
                <CarrierName>DPD</CarrierName>
            </TemporarilyUnavailableCarrier>
        </TemporarilyUnavailableCarrierList>
    </GetEligibleShippingServicesResult>
    <ResponseMetadata>
        <RequestId>5b7997fb-efd1-495b-b7db-03ecfa691038</RequestId>
    </ResponseMetadata>
</GetEligibleShippingServicesResponse>

↑ Top