HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

getEligibleShipmentServices

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

Usage Plan:

Rate (requests per second)Burst
612

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.

Body Params

The request schema for the GetEligibleShipmentServices operation.

ShipmentRequestDetails
object
required

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

ShippingOfferingFilter
object

Filter for use when requesting eligible shipping services.

Responses

Response body
object
payload
object

The payload for the getEligibleShipmentServices operation.

ShippingServiceList
array of objects
required

A list of shipping services offers.

ShippingServiceList*
object
string
required

A plain text representation of a carrier's shipping service. For example, "UPS Ground" or "FedEx Standard Overnight".

string
required

The name of the carrier.

string
required

An Amazon-defined shipping service identifier.

string
required

An Amazon-defined shipping service offer identifier.

date-time
required

Date-time formatted timestamp.

date-time

Date-time formatted timestamp.

date-time

Date-time formatted timestamp.

Rate
object
required

Currency type and amount.

ShippingServiceOptions
object
required

Extra services provided by a carrier.

AvailableShippingServiceOptions
object

The available shipping service options.

AvailableLabelFormats
array of strings

List of label formats.

Show Details
PDFPortable Document Format (pdf).
PNGPortable Network Graphics (png) format.
ZPL203Zebra Programming Language (zpl) format, 203 dots per inch resolution.
ZPL300Zebra Programming Language (zpl) format, 300 dots per inch resolution.
ShippingServiceDefaultThe default provided by the shipping service.
AvailableLabelFormats
AvailableFormatOptionsForLabel
array of objects

The available label formats.

AvailableFormatOptionsForLabel
object
boolean

When true, include a packing slip with the label.

string

The label format.

PDF PNG ZPL203 ZPL300 ShippingServiceDefault

Show Details
PDFPortable Document Format (pdf).
PNGPortable Network Graphics (png) format.
ZPL203Zebra Programming Language (zpl) format, 203 dots per inch resolution.
ZPL300Zebra Programming Language (zpl) format, 300 dots per inch resolution.
ShippingServiceDefaultThe default provided by the shipping service.
boolean
required

When true, additional seller inputs are required.

Benefits
object

Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, CLAIMS_PROTECTED) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC.

RejectedShippingServiceList
array of objects

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

RejectedShippingServiceList
object
string
required

The rejected shipping carrier name. For example, USPS.

string
required

The rejected shipping service localized name. For example, FedEx Standard Overnight.

string
required

An Amazon-defined shipping service identifier.

string
required

A reason code meant to be consumed programatically. For example, CARRIER_CANNOT_SHIP_TO_POBOX.

string

A localized human readable description of the rejected reason.

TemporarilyUnavailableCarrierList
array of objects

A list of temporarily unavailable carriers.

TemporarilyUnavailableCarrierList
object
string
required

The name of the carrier.

TermsAndConditionsNotAcceptedCarrierList
array of objects

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

TermsAndConditionsNotAcceptedCarrierList
object
string
required

The name of the carrier.

errors
array of objects

A list of error responses returned when a request is unsuccessful.

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition in a human-readable form.

string

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

Headers
object
string

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

string

Unique request reference identifier.

Language