--- updatedAt: 2026-09-10T19:06:07.000Z agentTools: siteIndex: https://developer-docs.amazon/llms.txt projectIndex: https://developer-docs.amazon/sp-api/llms.txt --- # 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "description": "With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon's Buy Shipping Services.", "version": "v0", "title": "Merchant Fulfillment v0", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" }, "license": { "name": "Apache License 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" } }, "paths": { "/mfn/v0/eligibleShippingServices": { "post": { "tags": [ "Merchant Fulfillment v0" ], "description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 6 | 12 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getEligibleShipmentServices", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesRequest" } } }, "description": "The request schema for the `GetEligibleShipmentServices` operation.", "required": true }, "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "ShipmentRequestDetails": { "AmazonOrderId": "903-5563053-5647845", "ItemList": [ { "OrderItemId": "52986411826454", "Quantity": 1 } ], "ShipFromAddress": { "Name": "John Doe", "AddressLine1": "300 Turnbull Ave", "Email": "jdoeasdfllkj@yahoo.com", "City": "Detroit", "StateOrProvinceCode": "MI", "PostalCode": "48123", "CountryCode": "US", "Phone": "7132341234" }, "PackageDimensions": { "Length": 10.25, "Width": 10.25, "Height": 10.25, "Unit": "inches" }, "Weight": { "Value": 10.25, "Unit": "oz" }, "ShippingServiceOptions": { "DeliveryExperience": "NoTracking", "CarrierWillPickUp": false, "CarrierWillPickUpOption": "ShipperWillDropOff" } } } } } }, "response": { "payload": { "ShippingServiceList": [ { "ShippingServiceName": "UPS 2nd Day Air®", "CarrierName": "UPS®", "ShippingServiceId": "UPS_PTP_2ND_DAY_AIR", "ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKoZAReW8oJ1SMumuBS8lA/Hjuglhyiu0+KRLvyJxFV0PB9YFMDhygs3VyTL0WGYkGxiuRkmuEvpqldUn9rrkWVodqnR4vx2VtXvtER/Ju6RqYoddJZGy6RS2KLzzhQ2NclN0NYXMZVqpOe5RsRBddXaGuJr7oza3M52+JzChocAHzcurIhCRynpbxfmNLzZMQEbgnpGLzuaoSMzfxg90/NaXFR/Ou01du/uKd5AbfMW/AxAKP9ht6Oi9lDHq6WkGqvjkVLW0/jj/fBgblIwcs+t", "ShipDate": "2019-10-28T16:36:36Z", "EarliestEstimatedDeliveryDate": "2019-10-31T06:00:00Z", "LatestEstimatedDeliveryDate": "2019-10-31T06:00:00Z", "Rate": { "CurrencyCode": "USD", "Amount": 34.73 }, "RateWithAdjustments": { "CurrencyCode": "USD", "Amount": 33.73 }, "AdjustmentItemList": [ { "RateItemID": "FBM_SHIP_PLUS_CREDIT", "RateItemType": "INCLUDED", "RateItemCharge": { "CurrencyCode": "USD", "Amount": 1 }, "RateItemNameLocalization": "FBM Ship Plus Credit" } ], "ShippingServiceOptions": { "DeliveryExperience": "NoTracking", "CarrierWillPickUp": false, "LabelFormat": "" }, "AvailableLabelFormats": [ "ZPL203", "ShippingServiceDefault", "PDF", "PNG" ], "AvailableFormatOptionsForLabel": [ { "LabelFormat": "ZPL203" }, { "LabelFormat": "ShippingServiceDefault" }, { "LabelFormat": "PDF" }, { "LabelFormat": "PNG" } ], "RequiresAdditionalSellerInputs": true, "Benefits": { "IncludedBenefits": [ "CLAIMS_PROTECTED", "FBM_SHIP_PLUS" ], "ExcludedBenefits": [] } }, { "ShippingServiceName": "UPS Next Day Air Saver®", "CarrierName": "UPS®", "ShippingServiceId": "UPS_PTP_NEXT_DAY_AIR_SAVER", "ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKqqhKGQ2YZmuxsXKVXmdgdWNvfxb1qfm5bGm8NuqlqnNT3eTiJ4viTctepggbeUKUSykClJ+Qmw43zdA8wsgREhQCmb4Bbo/skapLQS1F9uwH2FgY5SfMsj/egudyocpVRT45KSQAT0H5YiXW3OyyRAae9fZ0RzDJAABHiisOyYyXnB1mtWOZqc7rlGR4yyqN7jmiT4t8dmuGPX7ptY4qskrN+6VHZO9bM9tdDS0ysHhAVv4jO3Q5sWFg4nEPaARWSsrpa6zSGMLxAOj56O3tcP", "ShipDate": "2019-10-28T16:36:36Z", "EarliestEstimatedDeliveryDate": "2019-10-30T06:00:00Z", "LatestEstimatedDeliveryDate": "2019-10-30T06:00:00Z", "Rate": { "CurrencyCode": "USD", "Amount": 98.75 }, "RateWithAdjustments": { "CurrencyCode": "USD", "Amount": 98.75 }, "ShippingServiceOptions": { "DeliveryExperience": "NoTracking", "CarrierWillPickUp": false, "LabelFormat": "" }, "AvailableLabelFormats": [ "ZPL203", "ShippingServiceDefault", "PDF", "PNG" ], "AvailableFormatOptionsForLabel": [ { "LabelFormat": "ZPL203" }, { "LabelFormat": "ShippingServiceDefault" }, { "LabelFormat": "PDF" }, { "LabelFormat": "PNG" } ], "RequiresAdditionalSellerInputs": true, "Benefits": { "IncludedBenefits": [], "ExcludedBenefits": [ { "Benefit": "CLAIMS_PROTECTED", "ReasonCodes": [ "LATE_DELIVERY_RISK" ] } ] } } ], "TemporarilyUnavailableCarrierList": [ { "CarrierName": "UPS®" }, { "CarrierName": "DHLECOMMERCE" } ], "TermsAndConditionsNotAcceptedCarrierList": [ { "CarrierName": "YANWEN" }, { "CarrierName": "CHINA_POST" } ] } } } ] }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "ShipmentRequestDetails": { "AmazonOrderId": "TEST_CASE_400", "ItemList": [ { "OrderItemId": "52986411826454", "Quantity": 1 } ], "ShipFromAddress": { "Name": "John Doe", "AddressLine1": "300 Turnbull Ave", "Email": "jdoeasdfllkj@yahoo.com", "City": "Detroit", "StateOrProvinceCode": "MI", "PostalCode": "48123", "CountryCode": "USA", "Phone": "7132341234" }, "PackageDimensions": { "Length": 10.25, "Width": 10.25, "Height": 10.25, "Unit": "inches" }, "Weight": { "Value": 10.25, "Unit": "oz" }, "ShippingServiceOptions": { "DeliveryExperience": "NoTracking", "CarrierWillPickUp": false, "CarrierWillPickUpOption": "ShipperWillDropOff" } } } } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", "details": "" } ] } } ] }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "401": { "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "404": { "description": "The specified resource does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "429": { "description": "The frequency of requests exceeds the allowed rate.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "500": { "description": "An unexpected condition prevents the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResponse" } } } } }, "summary": "getEligibleShipmentServices" } } }, "x-readme": { "explorer-enabled": false }, "servers": [ { "url": "https://sellingpartnerapi-na.amazon.com" } ], "components": { "schemas": { "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful." }, "ErrorList": { "type": "array", "description": "A list of error responses returned when a request is unsuccessful.", "items": { "$ref": "#/components/schemas/Error" } }, "LabelFormatOption": { "type": "object", "properties": { "IncludePackingSlipWithLabel": { "type": "boolean", "description": "When `true`, include a packing slip with the label." }, "LabelFormat": { "$ref": "#/components/schemas/LabelFormat" } }, "description": "The label format details and whether to include a packing slip." }, "AvailableCarrierWillPickUpOption": { "type": "object", "required": [ "CarrierWillPickUpOption", "Charge" ], "properties": { "CarrierWillPickUpOption": { "$ref": "#/components/schemas/CarrierWillPickUpOption" }, "Charge": { "$ref": "#/components/schemas/CurrencyAmount" } }, "description": "Indicates whether the carrier will pick up the package, and what fee is charged, if any." }, "AvailableCarrierWillPickUpOptionsList": { "type": "array", "description": "List of available carrier pickup options.", "items": { "$ref": "#/components/schemas/AvailableCarrierWillPickUpOption" } }, "AvailableDeliveryExperienceOption": { "type": "object", "required": [ "Charge", "DeliveryExperienceOption" ], "properties": { "DeliveryExperienceOption": { "$ref": "#/components/schemas/DeliveryExperienceOption" }, "Charge": { "$ref": "#/components/schemas/CurrencyAmount" } }, "description": "The available delivery confirmation options, and the fee charged, if any." }, "AvailableDeliveryExperienceOptionsList": { "type": "array", "description": "List of available delivery experience options.", "items": { "$ref": "#/components/schemas/AvailableDeliveryExperienceOption" } }, "AvailableShippingServiceOptions": { "type": "object", "required": [ "AvailableCarrierWillPickUpOptions", "AvailableDeliveryExperienceOptions" ], "properties": { "AvailableCarrierWillPickUpOptions": { "$ref": "#/components/schemas/AvailableCarrierWillPickUpOptionsList" }, "AvailableDeliveryExperienceOptions": { "$ref": "#/components/schemas/AvailableDeliveryExperienceOptionsList" } }, "description": "The available shipping service options." }, "AvailableFormatOptionsForLabelList": { "type": "array", "description": "The available label formats.", "items": { "$ref": "#/components/schemas/LabelFormatOption" } }, "AdditionalSellerInput": { "type": "object", "properties": { "DataType": { "type": "string", "description": "The data type of the additional information." }, "ValueAsString": { "type": "string", "description": "The value when the data type is string." }, "ValueAsBoolean": { "type": "boolean", "description": "The value when the data type is boolean." }, "ValueAsInteger": { "type": "integer", "description": "The value when the data type is integer." }, "ValueAsTimestamp": { "$ref": "#/components/schemas/Timestamp" }, "ValueAsAddress": { "$ref": "#/components/schemas/Address" }, "ValueAsWeight": { "$ref": "#/components/schemas/Weight" }, "ValueAsDimension": { "$ref": "#/components/schemas/Length" }, "ValueAsCurrency": { "$ref": "#/components/schemas/CurrencyAmount" } }, "description": "Additional information required to purchase shipping." }, "AdditionalSellerInputs": { "type": "object", "required": [ "AdditionalInputFieldName", "AdditionalSellerInput" ], "properties": { "AdditionalInputFieldName": { "type": "string", "description": "The name of the additional input field." }, "AdditionalSellerInput": { "$ref": "#/components/schemas/AdditionalSellerInput" } }, "description": "An additional set of seller inputs required to purchase shipping." }, "AdditionalSellerInputsList": { "type": "array", "description": "A list of additional seller input pairs required to purchase shipping.", "items": { "$ref": "#/components/schemas/AdditionalSellerInputs" } }, "Address": { "type": "object", "required": [ "AddressLine1", "City", "CountryCode", "Email", "Name", "Phone", "PostalCode" ], "properties": { "Name": { "$ref": "#/components/schemas/AddressName" }, "AddressLine1": { "$ref": "#/components/schemas/AddressLine1" }, "AddressLine2": { "$ref": "#/components/schemas/AddressLine2" }, "AddressLine3": { "$ref": "#/components/schemas/AddressLine3" }, "DistrictOrCounty": { "$ref": "#/components/schemas/DistrictOrCounty" }, "Email": { "$ref": "#/components/schemas/EmailAddress" }, "City": { "$ref": "#/components/schemas/City" }, "StateOrProvinceCode": { "$ref": "#/components/schemas/StateOrProvinceCode" }, "PostalCode": { "$ref": "#/components/schemas/PostalCode" }, "CountryCode": { "$ref": "#/components/schemas/CountryCode" }, "Phone": { "$ref": "#/components/schemas/PhoneNumber" } }, "description": "The postal address information." }, "AddressLine1": { "type": "string", "description": "The street address information.", "maxLength": 180 }, "AddressLine2": { "type": "string", "description": "Additional street address information.", "maxLength": 60 }, "AddressLine3": { "type": "string", "description": "Additional street address information.", "maxLength": 60 }, "AddressName": { "type": "string", "description": "The name of the addressee, or business name.", "maxLength": 30 }, "AmazonOrderId": { "type": "string", "description": "An Amazon-defined order identifier, in 3-7-7 format." }, "Benefits": { "type": "object", "description": "Benefits that are included and excluded for each shipping offer. Benefits represent services provided by Amazon (for example, `CLAIMS_PROTECTED`) when sellers purchase shipping through Amazon. Benefit details are available for any shipment placed on or after January 1, 2024, 00:00 UTC.", "properties": { "IncludedBenefits": { "$ref": "#/components/schemas/IncludedBenefits" }, "ExcludedBenefits": { "$ref": "#/components/schemas/ExcludedBenefits" } } }, "IncludedBenefits": { "type": "array", "description": "A list of included benefits.", "items": { "type": "string" } }, "ExcludedBenefits": { "type": "array", "description": "A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation.", "items": { "$ref": "#/components/schemas/ExcludedBenefit" } }, "ExcludedBenefit": { "type": "object", "description": "A benefit excluded from a shipping offer or rate.", "properties": { "Benefit": { "description": "The benefit excluded from a shipment.", "type": "string" }, "ReasonCodes": { "$ref": "#/components/schemas/ExcludedBenefitReasonCodes" } } }, "ExcludedBenefitReasonCodes": { "type": "array", "description": "List of reasons why a benefit is excluded for a shipping offer (for example, `LATE_DELIVERY_RISK`).", "items": { "type": "string" } }, "City": { "type": "string", "description": "The city.", "maxLength": 30 }, "CountryCode": { "type": "string", "description": "The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format." }, "CurrencyAmount": { "type": "object", "required": [ "Amount", "CurrencyCode" ], "properties": { "CurrencyCode": { "type": "string", "description": "Three-digit currency code in ISO 4217 format.", "maxLength": 3 }, "Amount": { "type": "number", "format": "double", "description": "The currency amount." } }, "description": "Currency type and amount." }, "CustomTextForLabel": { "type": "string", "description": "Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`.", "maxLength": 14 }, "DeliveryExperienceType": { "type": "string", "description": "The delivery confirmation level.", "enum": [ "DeliveryConfirmationWithAdultSignature", "DeliveryConfirmationWithSignature", "DeliveryConfirmationWithoutSignature", "NoTracking", "DeliveryConfirmationWithIdentityCheck", "DeliveryConfirmationWithNameVerification" ], "x-docgen-enum-table-extension": [ { "value": "DeliveryConfirmationWithAdultSignature", "description": "Delivery confirmation with an adult signature." }, { "value": "DeliveryConfirmationWithSignature", "description": "Delivery confirmation with a signature. Required for DPD (UK)." }, { "value": "DeliveryConfirmationWithoutSignature", "description": "Delivery confirmation without a signature." }, { "value": "NoTracking", "description": "No delivery confirmation." }, { "value": "DeliveryConfirmationWithIdentityCheck", "description": "Delivery confirmation with recipient identity verified and documented." }, { "value": "DeliveryConfirmationWithNameVerification", "description": "Delivery confirmation with recipient name verified." } ] }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "EmailAddress": { "type": "string", "description": "The email address." }, "GetEligibleShipmentServicesRequest": { "type": "object", "required": [ "ShipmentRequestDetails" ], "properties": { "ShipmentRequestDetails": { "$ref": "#/components/schemas/ShipmentRequestDetails" }, "ShippingOfferingFilter": { "$ref": "#/components/schemas/ShippingOfferingFilter" } }, "description": "Request schema." }, "GetEligibleShipmentServicesResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/GetEligibleShipmentServicesResult" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "Response schema." }, "GetEligibleShipmentServicesResult": { "type": "object", "required": [ "ShippingServiceList" ], "properties": { "ShippingServiceList": { "$ref": "#/components/schemas/ShippingServiceList" }, "RejectedShippingServiceList": { "$ref": "#/components/schemas/RejectedShippingServiceList" }, "TemporarilyUnavailableCarrierList": { "$ref": "#/components/schemas/TemporarilyUnavailableCarrierList" }, "TermsAndConditionsNotAcceptedCarrierList": { "$ref": "#/components/schemas/TermsAndConditionsNotAcceptedCarrierList" } }, "description": "The payload for the `getEligibleShipmentServices` operation." }, "Item": { "type": "object", "required": [ "OrderItemId", "Quantity" ], "properties": { "OrderItemId": { "$ref": "#/components/schemas/OrderItemId" }, "Quantity": { "$ref": "#/components/schemas/ItemQuantity" }, "ItemWeight": { "$ref": "#/components/schemas/Weight" }, "ItemDescription": { "$ref": "#/components/schemas/ItemDescription" }, "TransparencyCodeList": { "$ref": "#/components/schemas/TransparencyCodeList" }, "ItemLevelSellerInputsList": { "$ref": "#/components/schemas/AdditionalSellerInputsList" }, "LiquidVolume": { "$ref": "#/components/schemas/LiquidVolume" }, "IsHazmat": { "type": "boolean", "description": "When `true`, the item qualifies as hazardous materials (hazmat). Defaults to `false`." }, "DangerousGoodsDetails": { "$ref": "#/components/schemas/DangerousGoodsDetails" } }, "description": "An Amazon order item identifier and a quantity." }, "ItemList": { "type": "array", "description": "The list of items you want to include in a shipment.", "items": { "$ref": "#/components/schemas/Item" } }, "ItemQuantity": { "type": "integer", "format": "int32", "description": "The number of items." }, "ItemDescription": { "type": "string", "description": "The description of the item." }, "LabelCustomization": { "type": "object", "properties": { "CustomTextForLabel": { "$ref": "#/components/schemas/CustomTextForLabel" }, "StandardIdForLabel": { "$ref": "#/components/schemas/StandardIdForLabel" } }, "description": "Custom text for shipping labels." }, "LabelFormat": { "type": "string", "description": "The label format.", "enum": [ "PDF", "PNG", "ZPL203", "ZPL300", "ShippingServiceDefault" ], "x-docgen-enum-table-extension": [ { "value": "PDF", "description": "Portable Document Format (pdf)." }, { "value": "PNG", "description": "Portable Network Graphics (png) format." }, { "value": "ZPL203", "description": "Zebra Programming Language (zpl) format, 203 dots per inch resolution." }, { "value": "ZPL300", "description": "Zebra Programming Language (zpl) format, 300 dots per inch resolution." }, { "value": "ShippingServiceDefault", "description": "The default provided by the shipping service." } ] }, "LabelFormatList": { "type": "array", "description": "List of label formats.", "items": { "$ref": "#/components/schemas/LabelFormat" } }, "Length": { "type": "object", "properties": { "value": { "type": "number", "description": "The value in units." }, "unit": { "$ref": "#/components/schemas/UnitOfLength" } }, "description": "The length." }, "OrderItemId": { "type": "string", "description": "An Amazon-defined identifier for an individual item in an order." }, "PackageDimension": { "type": "number", "description": "A number that represents the given package dimension.", "format": "double" }, "PackageDimensions": { "type": "object", "properties": { "Length": { "$ref": "#/components/schemas/PackageDimension" }, "Width": { "$ref": "#/components/schemas/PackageDimension" }, "Height": { "$ref": "#/components/schemas/PackageDimension" }, "Unit": { "$ref": "#/components/schemas/UnitOfLength" }, "PredefinedPackageDimensions": { "$ref": "#/components/schemas/PredefinedPackageDimensions" } }, "description": "The dimensions of a package contained in a shipment." }, "PhoneNumber": { "type": "string", "description": "The phone number.", "maxLength": 30 }, "PostalCode": { "type": "string", "description": "The zip code or postal code.", "maxLength": 30 }, "PredefinedPackageDimensions": { "type": "string", "description": "An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box.", "enum": [ "FedEx_Box_10kg", "FedEx_Box_25kg", "FedEx_Box_Extra_Large_1", "FedEx_Box_Extra_Large_2", "FedEx_Box_Large_1", "FedEx_Box_Large_2", "FedEx_Box_Medium_1", "FedEx_Box_Medium_2", "FedEx_Box_Small_1", "FedEx_Box_Small_2", "FedEx_Envelope", "FedEx_Padded_Pak", "FedEx_Pak_1", "FedEx_Pak_2", "FedEx_Tube", "FedEx_XL_Pak", "UPS_Box_10kg", "UPS_Box_25kg", "UPS_Express_Box", "UPS_Express_Box_Large", "UPS_Express_Box_Medium", "UPS_Express_Box_Small", "UPS_Express_Envelope", "UPS_Express_Hard_Pak", "UPS_Express_Legal_Envelope", "UPS_Express_Pak", "UPS_Express_Tube", "UPS_Laboratory_Pak", "UPS_Pad_Pak", "UPS_Pallet", "USPS_Card", "USPS_Flat", "USPS_FlatRateCardboardEnvelope", "USPS_FlatRateEnvelope", "USPS_FlatRateGiftCardEnvelope", "USPS_FlatRateLegalEnvelope", "USPS_FlatRatePaddedEnvelope", "USPS_FlatRateWindowEnvelope", "USPS_LargeFlatRateBoardGameBox", "USPS_LargeFlatRateBox", "USPS_Letter", "USPS_MediumFlatRateBox1", "USPS_MediumFlatRateBox2", "USPS_RegionalRateBoxA1", "USPS_RegionalRateBoxA2", "USPS_RegionalRateBoxB1", "USPS_RegionalRateBoxB2", "USPS_RegionalRateBoxC", "USPS_SmallFlatRateBox", "USPS_SmallFlatRateEnvelope" ], "x-docgen-enum-table-extension": [ { "value": "FedEx_Box_10kg", "description": "15.81 x 12.94 x 10.19 in." }, { "value": "FedEx_Box_25kg", "description": "54.80 x 42.10 x 33.50 in." }, { "value": "FedEx_Box_Extra_Large_1", "description": "11.88 x 11.00 x 10.75 in." }, { "value": "FedEx_Box_Extra_Large_2", "description": "15.75 x 14.13 x 6.00 in." }, { "value": "FedEx_Box_Large_1", "description": "17.50 x 12.38 x 3.00 in." }, { "value": "FedEx_Box_Large_2", "description": "11.25 x 8.75 x 7.75 in." }, { "value": "FedEx_Box_Medium_1", "description": "13.25 x 11.50 x 2.38 in." }, { "value": "FedEx_Box_Medium_2", "description": "11.25 x 8.75 x 4.38 in." }, { "value": "FedEx_Box_Small_1", "description": "12.38 x 10.88 x 1.50 in." }, { "value": "FedEx_Box_Small_2", "description": "8.75 x 2.63 x 11.25 in." }, { "value": "FedEx_Envelope", "description": "12.50 x 9.50 x 0.80 in." }, { "value": "FedEx_Padded_Pak", "description": "11.75 x 14.75 x 2.00 in." }, { "value": "FedEx_Pak_1", "description": "15.50 x 12.00 x 0.80 in." }, { "value": "FedEx_Pak_2", "description": "12.75 x 10.25 x 0.80 in." }, { "value": "FedEx_Tube", "description": "38.00 x 6.00 x 6.00 in." }, { "value": "FedEx_XL_Pak", "description": "17.50 x 20.75 x 2.00 in." }, { "value": "UPS_Box_10kg", "description": "41.00 x 33.50 x 26.50 cm." }, { "value": "UPS_Box_25kg", "description": "48.40 x 43.30 x 35.00 cm." }, { "value": "UPS_Express_Box", "description": "46.00 x 31.50 x 9.50 cm." }, { "value": "UPS_Express_Box_Large", "description": "18.00 x 13.00 x 3.00 in." }, { "value": "UPS_Express_Box_Medium", "description": "15.00 x 11.00 x 3.00 in." }, { "value": "UPS_Express_Box_Small", "description": "13.00 x 11.00 x 2.00 in." }, { "value": "UPS_Express_Envelope", "description": "12.50 x 9.50 x 2.00 in." }, { "value": "UPS_Express_Hard_Pak", "description": "14.75 x 11.50 x 2.00 in." }, { "value": "UPS_Express_Legal_Envelope", "description": "15.00 x 9.50 x 2.00 in." }, { "value": "UPS_Express_Pak", "description": "16.00 x 12.75 x 2.00 in." }, { "value": "UPS_Express_Tube", "description": "97.00 x 19.00 x 16.50 cm." }, { "value": "UPS_Laboratory_Pak", "description": "17.25 x 12.75 x 2.00 in." }, { "value": "UPS_Pad_Pak", "description": "14.75 x 11.00 x 2.00 in." }, { "value": "UPS_Pallet", "description": "120.00 x 80.00 x 200.00 cm." }, { "value": "USPS_Card", "description": "6.00 x 4.25 x 0.01 in." }, { "value": "USPS_Flat", "description": "15.00 x 12.00 x 0.75 in." }, { "value": "USPS_FlatRateCardboardEnvelope", "description": "12.50 x 9.50 x 4.00 in." }, { "value": "USPS_FlatRateEnvelope", "description": "12.50 x 9.50 x 4.00 in." }, { "value": "USPS_FlatRateGiftCardEnvelope", "description": "10.00 x 7.00 x 4.00 in." }, { "value": "USPS_FlatRateLegalEnvelope", "description": "15.00 x 9.50 x 4.00 in." }, { "value": "USPS_FlatRatePaddedEnvelope", "description": "12.50 x 9.50 x 4.00 in." }, { "value": "USPS_FlatRateWindowEnvelope", "description": "10.00 x 5.00 x 4.00 in." }, { "value": "USPS_LargeFlatRateBoardGameBox", "description": "24.06 x 11.88 x 3.13 in." }, { "value": "USPS_LargeFlatRateBox", "description": "12.25 x 12.25 x 6.00 in." }, { "value": "USPS_Letter", "description": "11.50 x 6.13 x 0.25 in." }, { "value": "USPS_MediumFlatRateBox1", "description": "11.25 x 8.75 x 6.00 in." }, { "value": "USPS_MediumFlatRateBox2", "description": "14.00 x 12.00 x 3.50 in." }, { "value": "USPS_RegionalRateBoxA1", "description": "10.13 x 7.13 x 5.00 in." }, { "value": "USPS_RegionalRateBoxA2", "description": "13.06 x 11.06 x 2.50 in." }, { "value": "USPS_RegionalRateBoxB1", "description": "16.25 x 14.50 x 3.00 in." }, { "value": "USPS_RegionalRateBoxB2", "description": "12.25 x 10.50 x 5.50 in." }, { "value": "USPS_RegionalRateBoxC", "description": "15.00 x 12.00 x 12.00 in." }, { "value": "USPS_SmallFlatRateBox", "description": "8.69 x 5.44 x 1.75 in." }, { "value": "USPS_SmallFlatRateEnvelope", "description": "10.00 x 6.00 x 4.00 in." } ] }, "SellerOrderId": { "type": "string", "description": "A seller-defined order identifier.", "maxLength": 64 }, "ShipmentRequestDetails": { "type": "object", "required": [ "AmazonOrderId", "ItemList", "PackageDimensions", "ShipFromAddress", "ShippingServiceOptions", "Weight" ], "properties": { "AmazonOrderId": { "$ref": "#/components/schemas/AmazonOrderId" }, "SellerOrderId": { "$ref": "#/components/schemas/SellerOrderId" }, "ItemList": { "$ref": "#/components/schemas/ItemList" }, "ShipFromAddress": { "$ref": "#/components/schemas/Address" }, "PackageDimensions": { "$ref": "#/components/schemas/PackageDimensions" }, "Weight": { "$ref": "#/components/schemas/Weight" }, "MustArriveByDate": { "$ref": "#/components/schemas/Timestamp" }, "ShipDate": { "$ref": "#/components/schemas/Timestamp" }, "ShippingServiceOptions": { "$ref": "#/components/schemas/ShippingServiceOptions" }, "LabelCustomization": { "$ref": "#/components/schemas/LabelCustomization" } }, "description": "Shipment information required for requesting shipping service offers or for creating a shipment." }, "DeliveryExperienceOption": { "type": "string", "description": "The delivery confirmation level.", "enum": [ "DeliveryConfirmationWithAdultSignature", "DeliveryConfirmationWithSignature", "DeliveryConfirmationWithoutSignature", "NoTracking", "NoPreference", "DeliveryConfirmationWithIdentityCheck", "DeliveryConfirmationWithNameVerification" ], "x-docgen-enum-table-extension": [ { "value": "DeliveryConfirmationWithAdultSignature", "description": "Delivery confirmation with adult signature." }, { "value": "DeliveryConfirmationWithSignature", "description": "Delivery confirmation with signature. Required for DPD (UK)." }, { "value": "DeliveryConfirmationWithoutSignature", "description": "Delivery confirmation without signature." }, { "value": "NoTracking", "description": "No delivery confirmation." }, { "value": "NoPreference", "description": "No preference." }, { "value": "DeliveryConfirmationWithIdentityCheck", "description": "Delivery confirmation with recipient identity verified and documented." }, { "value": "DeliveryConfirmationWithNameVerification", "description": "Delivery confirmation with recipient name verified." } ] }, "ShippingOfferingFilter": { "type": "object", "properties": { "IncludePackingSlipWithLabel": { "type": "boolean", "description": "When `true`, include a packing slip with the label." }, "IncludeComplexShippingOptions": { "type": "boolean", "description": "When `true`, include complex shipping options." }, "CarrierWillPickUp": { "$ref": "#/components/schemas/CarrierWillPickUpOption" }, "DeliveryExperience": { "$ref": "#/components/schemas/DeliveryExperienceOption" } }, "description": "Filter for use when requesting eligible shipping services." }, "ShippingService": { "type": "object", "required": [ "CarrierName", "Rate", "RateWithAdjustments", "RequiresAdditionalSellerInputs", "ShipDate", "ShippingServiceId", "ShippingServiceName", "ShippingServiceOfferId", "ShippingServiceOptions" ], "properties": { "ShippingServiceName": { "type": "string", "description": "The carrier's shipping service name, such as \"UPS Ground\" or \"FedEx Standard Overnight\"." }, "CarrierName": { "type": "string", "description": "The name of the carrier." }, "ShippingServiceId": { "$ref": "#/components/schemas/ShippingServiceIdentifier" }, "ShippingServiceOfferId": { "type": "string", "description": "An Amazon-defined shipping service offer identifier." }, "ShipDate": { "$ref": "#/components/schemas/Timestamp" }, "EarliestEstimatedDeliveryDate": { "$ref": "#/components/schemas/Timestamp" }, "LatestEstimatedDeliveryDate": { "$ref": "#/components/schemas/Timestamp" }, "Rate": { "$ref": "#/components/schemas/CurrencyAmount" }, "RateWithAdjustments": { "$ref": "#/components/schemas/CurrencyAmount" }, "AdjustmentItemList": { "$ref": "#/components/schemas/AdjustmentItemList" }, "ShippingServiceOptions": { "$ref": "#/components/schemas/ShippingServiceOptions" }, "AvailableShippingServiceOptions": { "$ref": "#/components/schemas/AvailableShippingServiceOptions" }, "AvailableLabelFormats": { "$ref": "#/components/schemas/LabelFormatList" }, "AvailableFormatOptionsForLabel": { "$ref": "#/components/schemas/AvailableFormatOptionsForLabelList" }, "RequiresAdditionalSellerInputs": { "type": "boolean", "description": "When `true`, additional seller inputs are required." }, "Benefits": { "$ref": "#/components/schemas/Benefits" } }, "description": "A shipping service offer made by a carrier." }, "ShippingServiceIdentifier": { "type": "string", "description": "An Amazon-defined shipping service identifier." }, "ShippingServiceList": { "type": "array", "description": "A list of shipping services offers.", "items": { "$ref": "#/components/schemas/ShippingService" } }, "ShippingServiceOptions": { "type": "object", "required": [ "CarrierWillPickUp", "DeliveryExperience" ], "properties": { "DeliveryExperience": { "$ref": "#/components/schemas/DeliveryExperienceType" }, "DeclaredValue": { "$ref": "#/components/schemas/CurrencyAmount" }, "CarrierWillPickUp": { "type": "boolean", "description": "When `true`, the carrier picks up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK)." }, "CarrierWillPickUpOption": { "$ref": "#/components/schemas/CarrierWillPickUpOption" }, "LabelFormat": { "$ref": "#/components/schemas/LabelFormat" } }, "description": "Extra services provided by a carrier." }, "CarrierWillPickUpOption": { "type": "string", "description": "Carrier will pick up option.", "enum": [ "CarrierWillPickUp", "ShipperWillDropOff", "NoPreference" ], "x-docgen-enum-table-extension": [ { "value": "CarrierWillPickUp", "description": "The carrier will pick up the package." }, { "value": "ShipperWillDropOff", "description": "The seller is responsible for arranging pickup or dropping off the package to the carrier." }, { "value": "NoPreference", "description": "No preference." } ] }, "StandardIdForLabel": { "type": "string", "description": "The type of standard identifier to print on the label.", "enum": [ "AmazonOrderId" ], "x-docgen-enum-table-extension": [ { "value": "AmazonOrderId", "description": "An Amazon-defined order identifier in 3-7-7 format." } ] }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. This is a required field in Amazon Canada, US, and UK stores, and for shipments that originate in China.", "maxLength": 30 }, "RejectedShippingService": { "type": "object", "required": [ "CarrierName", "RejectionReasonCode", "ShippingServiceId", "ShippingServiceName" ], "properties": { "CarrierName": { "type": "string", "description": "The rejected shipping carrier name. For example, USPS." }, "ShippingServiceName": { "type": "string", "description": "The rejected shipping service localized name. For example, FedEx Standard Overnight." }, "ShippingServiceId": { "$ref": "#/components/schemas/ShippingServiceIdentifier" }, "RejectionReasonCode": { "type": "string", "description": "A reason code meant to be consumed programmatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`." }, "RejectionReasonMessage": { "type": "string", "description": "A localized, human-readable description of the rejected reason." } }, "description": "Information about a rejected shipping service." }, "RejectedShippingServiceList": { "type": "array", "description": "List of services that are for some reason unavailable for this request.", "items": { "$ref": "#/components/schemas/RejectedShippingService" } }, "TemporarilyUnavailableCarrier": { "type": "object", "required": [ "CarrierName" ], "properties": { "CarrierName": { "type": "string", "description": "The name of the carrier." } }, "description": "A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier." }, "TemporarilyUnavailableCarrierList": { "type": "array", "description": "A list of temporarily unavailable carriers.", "items": { "$ref": "#/components/schemas/TemporarilyUnavailableCarrier" } }, "TermsAndConditionsNotAcceptedCarrier": { "type": "object", "required": [ "CarrierName" ], "properties": { "CarrierName": { "type": "string", "description": "The name of the carrier." } }, "description": "A carrier whose terms and conditions have not been accepted by the seller." }, "TermsAndConditionsNotAcceptedCarrierList": { "type": "array", "description": "List of carriers whose terms and conditions were not accepted by the seller.", "items": { "$ref": "#/components/schemas/TermsAndConditionsNotAcceptedCarrier" } }, "Timestamp": { "type": "string", "description": "Date-time formatted timestamp.", "format": "date-time" }, "TransparencyCode": { "type": "string", "description": "The transparency code associated with the item. Determine the transparency serial number with:\n\n**1D or 2D barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D barcode SN:** Submit the 7- to 20-character serial number barcode, that likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." }, "TransparencyCodeList": { "type": "array", "description": "A list of transparency codes.", "items": { "$ref": "#/components/schemas/TransparencyCode" } }, "UnitOfLength": { "type": "string", "description": "The unit of length.", "enum": [ "inches", "centimeters" ], "x-docgen-enum-table-extension": [ { "value": "inches", "description": "The unit of length is inches." }, { "value": "centimeters", "description": "The unit of length is centimeters." } ] }, "UnitOfWeight": { "type": "string", "description": "The unit of weight.", "enum": [ "oz", "g" ], "x-docgen-enum-table-extension": [ { "value": "oz", "description": "The unit of weight is ounces." }, { "value": "g", "description": "The unit of weight is grams." } ] }, "Weight": { "type": "object", "required": [ "Unit", "Value" ], "properties": { "Value": { "$ref": "#/components/schemas/WeightValue" }, "Unit": { "$ref": "#/components/schemas/UnitOfWeight" } }, "description": "The weight." }, "WeightValue": { "type": "number", "format": "double", "description": "The weight value." }, "LiquidVolume": { "type": "object", "required": [ "Unit", "Value" ], "properties": { "Unit": { "type": "string", "description": "The unit of measurement.", "enum": [ "ML", "L", "FL_OZ", "GAL", "PT", "QT", "C" ], "x-docgen-enum-table-extension": [ { "value": "ML", "description": "Milliliter - Metric unit of volume." }, { "value": "L", "description": "Liter - Metric unit of volume." }, { "value": "FL_OZ", "description": "Fluid ounce - Imperial unit of volume." }, { "value": "GAL", "description": "Gallon - Imperial unit of volume." }, { "value": "PT", "description": "Pint - Imperial unit of volume." }, { "value": "QT", "description": "Quart - Imperial unit of volume." }, { "value": "C", "description": "Cup - Imperial unit of volume." } ] }, "Value": { "type": "number", "description": "The measurement value." } }, "description": "Liquid volume." }, "DangerousGoodsDetails": { "type": "object", "description": "Details related to any dangerous goods or items that are shipped.", "properties": { "UnitedNationsRegulatoryId": { "type": "string", "description": "The specific UNID of the item being shipped.", "pattern": "^(UN|ID|NA)[0-9]{4}$" }, "TransportationRegulatoryClass": { "type": "string", "description": "The specific regulatory class of the shipped item.", "pattern": "^[1-9](\\.[1-9])?$" }, "PackingGroup": { "type": "string", "description": "The specific packaging group of the item being shipped.", "enum": [ "I", "II", "III" ], "x-docgen-enum-table-extension": [ { "value": "I", "description": "Packing group I indicates great danger." }, { "value": "II", "description": "Packing group II indicates medium danger." }, { "value": "III", "description": "Packing group III indicates minor danger." } ] }, "PackingInstruction": { "type": "string", "description": "The specific packing instruction of the item being shipped.", "enum": [ "PI965_SECTION_IA", "PI965_SECTION_IB", "PI965_SECTION_II", "PI966_SECTION_I", "PI966_SECTION_II", "PI967_SECTION_I", "PI967_SECTION_II", "PI968_SECTION_IA", "PI968_SECTION_IB", "PI969_SECTION_I", "PI969_SECTION_II", "PI970_SECTION_I", "PI970_SECTION_II" ], "x-docgen-enum-table-extension": [ { "value": "PI965_SECTION_IA", "description": "Ion PI965 Section IA (LiBa)." }, { "value": "PI965_SECTION_IB", "description": "Ion PI965 Section IB (LiBa)." }, { "value": "PI965_SECTION_II", "description": "Ion PI965 Section II (LiBa)." }, { "value": "PI966_SECTION_I", "description": "Ion PI966 Section I (LiBa with equipment)." }, { "value": "PI966_SECTION_II", "description": "Ion PI966 Section II (LiBa with equipment)." }, { "value": "PI967_SECTION_I", "description": "Ion PI967 Section I (LiBa in equipment)." }, { "value": "PI967_SECTION_II", "description": "Ion PI967 Section II (LiBa in equipment)." }, { "value": "PI968_SECTION_IA", "description": "Metal PI968 Section IA (LiBa)." }, { "value": "PI968_SECTION_IB", "description": "Metal PI968 Section IB (LiBa)." }, { "value": "PI969_SECTION_I", "description": "Metal PI969 Section I (LiBa with equipment)." }, { "value": "PI969_SECTION_II", "description": "Metal PI969 Section II (LiBa with equipment)." }, { "value": "PI970_SECTION_I", "description": "Metal PI970 Section I (LiBa in equipment)." }, { "value": "PI970_SECTION_II", "description": "Metal PI970 Section II (LiBa in equipment)." } ] } } }, "AdjustmentItemList": { "type": "array", "description": "List of adjustments.", "items": { "$ref": "#/components/schemas/RateItem" } }, "RateItem": { "type": "object", "required": [ "RateItemID" ], "properties": { "RateItemID": { "$ref": "#/components/schemas/RateItemID" }, "RateItemType": { "$ref": "#/components/schemas/RateItemType" }, "RateItemCharge": { "$ref": "#/components/schemas/CurrencyAmount" }, "RateItemNameLocalization": { "description": "Localized name for the RateItem.", "type": "string" } }, "description": "Rate item for shipping costs and adjustments." }, "RateItemID": { "type": "string", "description": "Unique identifier for the RateItem.", "enum": [ "FBM_SHIP_PLUS_CREDIT" ], "x-docgen-enum-table-extension": [ { "value": "FBM_SHIP_PLUS_CREDIT", "description": "Charge adjustment for FBM Ship+." } ] }, "RateItemType": { "type": "string", "description": "Type for the RateItem.", "enum": [ "INCLUDED" ], "x-docgen-enum-table-extension": [ { "value": "INCLUDED", "description": "The rate item is included but not guaranteed for the shipping service." } ] } } } } ```