getEligibleShipmentServices

Returns a list of shipping service offers that satisfy the specified shipment request details.

Usage Plan:

Rate (requests per second)	Burst
6	12

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.

Request

Body Params application/json

Request schema.

ShipmentRequestDetails

object (ShipmentRequestDetails)

required

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

AmazonOrderId

string

required

An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.

SellerOrderId

string

optional

A seller-defined order identifier.

<= 64 characters

ItemList

array[object (Item) {7}]

required

The list of items you want to include in a shipment.

ShipFromAddress

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

PackageDimensions

object (PackageDimensions)

required

Dimensions of the package.

Weight

object (Weight)

required

The weight of the scheduled package

MustArriveByDate

string <date-time>

optional

Date timestamp

ShipDate

string <date-time>

optional

Date timestamp

ShippingServiceOptions

object (ShippingServiceOptions)

required

Extra services provided by a carrier.

LabelCustomization

object (LabelCustomization)

optional

Custom text for shipping labels.

ShippingOfferingFilter

object (ShippingOfferingFilter)

optional

Filter for use when requesting eligible shipping services.

IncludePackingSlipWithLabel

boolean

optional

When true, include a packing slip with the label.

IncludeComplexShippingOptions

boolean

optional

When true, include complex shipping options.

CarrierWillPickUp

enum<string>

optional

Carrier will pick up option.

Allowed values:

CarrierWillPickUpShipperWillDropOffNoPreference

DeliveryExperience

enum<string>

optional

The delivery confirmation level.

Allowed values:

DeliveryConfirmationWithAdultSignatureDeliveryConfirmationWithSignatureDeliveryConfirmationWithoutSignatureNoTrackingNoPreference

Example

{
    "ShipmentRequestDetails": {
        "AmazonOrderId": "string",
        "SellerOrderId": "string",
        "ItemList": [
            {
                "sku": "string",
                "summaries": [
                    {
                        "marketplaceId": "string",
                        "asin": "string",
                        "productType": "string",
                        "conditionType": "new_new",
                        "status": [
                            "BUYABLE"
                        ],
                        "fnSku": "string",
                        "itemName": "string",
                        "createdDate": "2019-08-24T14:15:22Z",
                        "lastUpdatedDate": "2019-08-24T14:15:22Z",
                        "mainImage": {
                            "link": "string",
                            "height": 0,
                            "width": 0
                        }
                    }
                ],
                "attributes": {},
                "issues": [
                    {
                        "code": "string",
                        "message": "string",
                        "severity": "ERROR",
                        "attributeNames": [
                            "string"
                        ],
                        "categories": [
                            "INVALID_ATTRIBUTE"
                        ],
                        "enforcements": {
                            "actions": [
                                {
                                    "action": "LISTING_SUPPRESSED"
                                }
                            ],
                            "exemption": {
                                "status": "EXEMPT",
                                "expiryDate": "2023-10-28T00:36:48.914Z"
                            }
                        }
                    }
                ],
                "offers": [
                    {
                        "marketplaceId": "string",
                        "offerType": "B2C",
                        "price": {
                            "currencyCode": "string",
                            "amount": "string"
                        },
                        "points": {
                            "pointsNumber": 0,
                            "pointsMonetaryValue": {
                                "currencyCode": "string",
                                "amount": 0
                            }
                        },
                        "audience": {
                            "value": "ALL",
                            "displayName": "string"
                        }
                    }
                ],
                "fulfillmentAvailability": [
                    {
                        "fulfillmentChannelCode": "string",
                        "quantity": 0
                    }
                ],
                "procurement": [
                    {
                        "costPrice": {
                            "currencyCode": "string",
                            "amount": "string"
                        }
                    }
                ]
            }
        ],
        "ShipFromAddress": {
            "addressLine1": "address_1",
            "addressLine2": "address_2",
            "addressLine3": "address_3",
            "city": "Seattle",
            "countryCode": "US",
            "county": "Washington",
            "district": "District1",
            "name": "address_name",
            "phoneNumber": "+14155552671",
            "postalCode": "123456",
            "stateOrRegion": "Washington"
        },
        "PackageDimensions": {
            "height": 0,
            "length": 0,
            "unitOfMeasurement": "INCHES",
            "width": 0
        },
        "Weight": {
            "value": 11,
            "unit": "Grams"
        },
        "MustArriveByDate": "2019-08-24T14:15:22Z",
        "ShipDate": "2019-08-24T14:15:22Z",
        "ShippingServiceOptions": {
            "DeliveryExperience": "DeliveryConfirmationWithAdultSignature",
            "DeclaredValue": {
                "CurrencyCode": "str",
                "Amount": 0
            },
            "CarrierWillPickUp": true,
            "CarrierWillPickUpOption": "CarrierWillPickUp",
            "LabelFormat": "PDF"
        },
        "LabelCustomization": {
            "CustomTextForLabel": "string",
            "StandardIdForLabel": "AmazonOrderId"
        }
    },
    "ShippingOfferingFilter": {
        "IncludePackingSlipWithLabel": true,
        "IncludeComplexShippingOptions": true,
        "CarrierWillPickUp": "CarrierWillPickUp",
        "DeliveryExperience": "DeliveryConfirmationWithAdultSignature"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/mfn/v0/eligibleShippingServices' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ShipmentRequestDetails": {
        "AmazonOrderId": "string",
        "SellerOrderId": "string",
        "ItemList": [
            {
                "sku": "string",
                "summaries": [
                    {
                        "marketplaceId": "string",
                        "asin": "string",
                        "productType": "string",
                        "conditionType": "new_new",
                        "status": [
                            "BUYABLE"
                        ],
                        "fnSku": "string",
                        "itemName": "string",
                        "createdDate": "2019-08-24T14:15:22Z",
                        "lastUpdatedDate": "2019-08-24T14:15:22Z",
                        "mainImage": {
                            "link": "string",
                            "height": 0,
                            "width": 0
                        }
                    }
                ],
                "attributes": {},
                "issues": [
                    {
                        "code": "string",
                        "message": "string",
                        "severity": "ERROR",
                        "attributeNames": [
                            "string"
                        ],
                        "categories": [
                            "INVALID_ATTRIBUTE"
                        ],
                        "enforcements": {
                            "actions": [
                                {
                                    "action": "LISTING_SUPPRESSED"
                                }
                            ],
                            "exemption": {
                                "status": "EXEMPT",
                                "expiryDate": "2023-10-28T00:36:48.914Z"
                            }
                        }
                    }
                ],
                "offers": [
                    {
                        "marketplaceId": "string",
                        "offerType": "B2C",
                        "price": {
                            "currencyCode": "string",
                            "amount": "string"
                        },
                        "points": {
                            "pointsNumber": 0,
                            "pointsMonetaryValue": {
                                "currencyCode": "string",
                                "amount": 0
                            }
                        },
                        "audience": {
                            "value": "ALL",
                            "displayName": "string"
                        }
                    }
                ],
                "fulfillmentAvailability": [
                    {
                        "fulfillmentChannelCode": "string",
                        "quantity": 0
                    }
                ],
                "procurement": [
                    {
                        "costPrice": {
                            "currencyCode": "string",
                            "amount": "string"
                        }
                    }
                ]
            }
        ],
        "ShipFromAddress": {
            "addressLine1": "address_1",
            "addressLine2": "address_2",
            "addressLine3": "address_3",
            "city": "Seattle",
            "countryCode": "US",
            "county": "Washington",
            "district": "District1",
            "name": "address_name",
            "phoneNumber": "+14155552671",
            "postalCode": "123456",
            "stateOrRegion": "Washington"
        },
        "PackageDimensions": {
            "height": 0,
            "length": 0,
            "unitOfMeasurement": "INCHES",
            "width": 0
        },
        "Weight": {
            "value": 11,
            "unit": "Grams"
        },
        "MustArriveByDate": "2019-08-24T14:15:22Z",
        "ShipDate": "2019-08-24T14:15:22Z",
        "ShippingServiceOptions": {
            "DeliveryExperience": "DeliveryConfirmationWithAdultSignature",
            "DeclaredValue": {
                "CurrencyCode": "str",
                "Amount": 0
            },
            "CarrierWillPickUp": true,
            "CarrierWillPickUpOption": "CarrierWillPickUp",
            "LabelFormat": "PDF"
        },
        "LabelCustomization": {
            "CustomTextForLabel": "string",
            "StandardIdForLabel": "AmazonOrderId"
        }
    },
    "ShippingOfferingFilter": {
        "IncludePackingSlipWithLabel": true,
        "IncludeComplexShippingOptions": true,
        "CarrierWillPickUp": "CarrierWillPickUp",
        "DeliveryExperience": "DeliveryConfirmationWithAdultSignature"
    }
}'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Response schema.

payload

object (GetEligibleShipmentServicesResult)

optional

The payload for the getEligibleShipmentServices operation.

ShippingServiceList

array[object (ShippingService) {14}]

required

A list of shipping services offers.

RejectedShippingServiceList

array[object (RejectedShippingService) {5}]

optional

List of services that are for some reason unavailable for this request

TemporarilyUnavailableCarrierList

array[object (TemporarilyUnavailableCarrier) {1}]

optional

A list of temporarily unavailable carriers.

TermsAndConditionsNotAcceptedCarrierList

array[object (TermsAndConditionsNotAcceptedCarrier) {1}]

optional

List of carriers whose terms and conditions were not accepted by the seller.

errors

array[object (Error) {3}]

optional

A list of error responses that are 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

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "ShippingServiceList": [
            {
                "ShippingServiceName": "string",
                "CarrierName": "string",
                "ShippingServiceId": "string",
                "ShippingServiceOfferId": "string",
                "ShipDate": "2019-08-24T14:15:22Z",
                "EarliestEstimatedDeliveryDate": "2019-08-24T14:15:22Z",
                "LatestEstimatedDeliveryDate": "2019-08-24T14:15:22Z",
                "Rate": {
                    "CurrencyCode": "str",
                    "Amount": 0
                },
                "ShippingServiceOptions": {
                    "DeliveryExperience": "DeliveryConfirmationWithAdultSignature",
                    "DeclaredValue": {
                        "CurrencyCode": "str",
                        "Amount": 0
                    },
                    "CarrierWillPickUp": true,
                    "CarrierWillPickUpOption": "CarrierWillPickUp",
                    "LabelFormat": "PDF"
                },
                "AvailableShippingServiceOptions": {
                    "AvailableCarrierWillPickUpOptions": [
                        {
                            "CarrierWillPickUpOption": "CarrierWillPickUp",
                            "Charge": {
                                "CurrencyCode": "str",
                                "Amount": 0
                            }
                        }
                    ],
                    "AvailableDeliveryExperienceOptions": [
                        {
                            "DeliveryExperienceOption": "DeliveryConfirmationWithAdultSignature",
                            "Charge": {
                                "CurrencyCode": "str",
                                "Amount": 0
                            }
                        }
                    ]
                },
                "AvailableLabelFormats": [
                    "PDF"
                ],
                "AvailableFormatOptionsForLabel": [
                    {
                        "IncludePackingSlipWithLabel": true,
                        "LabelFormat": "PDF"
                    }
                ],
                "RequiresAdditionalSellerInputs": true,
                "Benefits": {
                    "IncludedBenefits": [
                        "string"
                    ],
                    "ExcludedBenefits": [
                        {
                            "Benefit": "string",
                            "ReasonCodes": [
                                "string"
                            ]
                        }
                    ]
                }
            }
        ],
        "RejectedShippingServiceList": [
            {
                "CarrierName": "string",
                "ShippingServiceName": "string",
                "ShippingServiceId": "string",
                "RejectionReasonCode": "string",
                "RejectionReasonMessage": "string"
            }
        ],
        "TemporarilyUnavailableCarrierList": [
            {
                "CarrierName": "string"
            }
        ],
        "TermsAndConditionsNotAcceptedCarrierList": [
            {
                "CarrierName": "string"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable