Download OpenAPI specification:Download
The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services.
Returns a list of shipping service offers that satisfy the specified shipment request details.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
required | object (ShipmentRequestDetails) Shipment information required for requesting shipping service offers or for creating a shipment. |
object (ShippingOfferingFilter) Filter for use when requesting eligible shipping services. |
{- "ShipmentRequestDetails": {
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "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"
}
}
{- "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
}
], - "RejectedShippingServiceList": [
- {
- "CarrierName": "string",
- "ShippingServiceName": "string",
- "ShippingServiceId": "string",
- "RejectionReasonCode": "string",
- "RejectionReasonMessage": "string"
}
], - "TemporarilyUnavailableCarrierList": [
- {
- "CarrierName": "string"
}
], - "TermsAndConditionsNotAcceptedCarrierList": [
- {
- "CarrierName": "string"
}
]
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Returns a list of shipping service offers that satisfy the specified shipment request details.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
5 | 10 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
required | object (ShipmentRequestDetails) Shipment information required for requesting shipping service offers or for creating a shipment. |
object (ShippingOfferingFilter) Filter for use when requesting eligible shipping services. |
{- "ShipmentRequestDetails": {
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "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"
}
}
{- "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
}
], - "RejectedShippingServiceList": [
- {
- "CarrierName": "string",
- "ShippingServiceName": "string",
- "ShippingServiceId": "string",
- "RejectionReasonCode": "string",
- "RejectionReasonMessage": "string"
}
], - "TemporarilyUnavailableCarrierList": [
- {
- "CarrierName": "string"
}
], - "TermsAndConditionsNotAcceptedCarrierList": [
- {
- "CarrierName": "string"
}
]
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Returns the shipment information for an existing shipment.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
shipmentId required | string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-... The Amazon-defined shipment identifier for the shipment. |
{- "payload": {
- "ShipmentId": "string",
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ShipToAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "Insurance": {
- "CurrencyCode": "str",
- "Amount": 0
}, - "ShippingService": {
- "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
}, - "Label": {
- "CustomTextForLabel": "string",
- "Dimensions": {
- "Length": 0,
- "Width": 0,
- "Unit": "inches"
}, - "FileContents": {
- "Contents": "string",
- "FileType": "application/pdf",
- "Checksum": "string"
}, - "LabelFormat": "PDF",
- "StandardIdForLabel": "AmazonOrderId"
}, - "Status": "Purchased",
- "TrackingId": "string",
- "CreatedDate": "2019-08-24T14:15:22Z",
- "LastUpdatedDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Cancel the shipment indicated by the specified shipment identifier.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
shipmentId required | string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-... The Amazon-defined shipment identifier for the shipment to cancel. |
{- "payload": {
- "ShipmentId": "string",
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ShipToAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "Insurance": {
- "CurrencyCode": "str",
- "Amount": 0
}, - "ShippingService": {
- "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
}, - "Label": {
- "CustomTextForLabel": "string",
- "Dimensions": {
- "Length": 0,
- "Width": 0,
- "Unit": "inches"
}, - "FileContents": {
- "Contents": "string",
- "FileType": "application/pdf",
- "Checksum": "string"
}, - "LabelFormat": "PDF",
- "StandardIdForLabel": "AmazonOrderId"
}, - "Status": "Purchased",
- "TrackingId": "string",
- "CreatedDate": "2019-08-24T14:15:22Z",
- "LastUpdatedDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Cancel the shipment indicated by the specified shipment identifer.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
shipmentId required | string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-... The Amazon-defined shipment identifier for the shipment to cancel. |
{- "payload": {
- "ShipmentId": "string",
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ShipToAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "Insurance": {
- "CurrencyCode": "str",
- "Amount": 0
}, - "ShippingService": {
- "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
}, - "Label": {
- "CustomTextForLabel": "string",
- "Dimensions": {
- "Length": 0,
- "Width": 0,
- "Unit": "inches"
}, - "FileContents": {
- "Contents": "string",
- "FileType": "application/pdf",
- "Checksum": "string"
}, - "LabelFormat": "PDF",
- "StandardIdForLabel": "AmazonOrderId"
}, - "Status": "Purchased",
- "TrackingId": "string",
- "CreatedDate": "2019-08-24T14:15:22Z",
- "LastUpdatedDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Create a shipment with the information provided.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
required | object (ShipmentRequestDetails) Shipment information required for requesting shipping service offers or for creating a shipment. |
ShippingServiceId required | string An Amazon-defined shipping service identifier. |
ShippingServiceOfferId | string Identifies a shipping service order made by a carrier. |
HazmatType | string (HazmatType) Enum: "None" "LQHazmat" Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials. |
object (LabelFormatOptionRequest) Whether to include a packing slip. | |
Array of objects (AdditionalSellerInputs) A list of additional seller input pairs required to purchase shipping. |
{- "ShipmentRequestDetails": {
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "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"
}
}, - "ShippingServiceId": "string",
- "ShippingServiceOfferId": "string",
- "HazmatType": "None",
- "LabelFormatOption": {
- "IncludePackingSlipWithLabel": true
}, - "ShipmentLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
{- "payload": {
- "ShipmentId": "string",
- "AmazonOrderId": "string",
- "SellerOrderId": "string",
- "ItemList": [
- {
- "OrderItemId": "string",
- "Quantity": 0,
- "ItemWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ItemDescription": "string",
- "TransparencyCodeList": [
- "string"
], - "ItemLevelSellerInputsList": [
- {
- "AdditionalInputFieldName": "string",
- "AdditionalSellerInput": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}
}
]
}
], - "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ShipToAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "PackageDimensions": {
- "Length": 0,
- "Width": 0,
- "Height": 0,
- "Unit": "inches",
- "PredefinedPackageDimensions": "FedEx_Box_10kg"
}, - "Weight": {
- "Value": 0,
- "Unit": "oz"
}, - "Insurance": {
- "CurrencyCode": "str",
- "Amount": 0
}, - "ShippingService": {
- "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
}, - "Label": {
- "CustomTextForLabel": "string",
- "Dimensions": {
- "Length": 0,
- "Width": 0,
- "Unit": "inches"
}, - "FileContents": {
- "Contents": "string",
- "FileType": "application/pdf",
- "Checksum": "string"
}, - "LabelFormat": "PDF",
- "StandardIdForLabel": "AmazonOrderId"
}, - "Status": "Purchased",
- "TrackingId": "string",
- "CreatedDate": "2019-08-24T14:15:22Z",
- "LastUpdatedDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Get a list of additional seller inputs required for a ship method. This is generally used for international shipping.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
ShippingServiceId required | string An Amazon-defined shipping service identifier. |
required | object (Address) The postal address information. |
OrderId required | string An Amazon-defined order identifier, in 3-7-7 format. |
{- "ShippingServiceId": "string",
- "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "OrderId": "string"
}
{- "payload": {
- "ShipmentLevelFields": [
- {
- "AdditionalInputFieldName": "string",
- "SellerInputDefinition": {
- "IsRequired": true,
- "DataType": "string",
- "Constraints": [
- {
- "ValidationRegEx": "string",
- "ValidationString": "string"
}
], - "InputDisplayText": "string",
- "InputTarget": "SHIPMENT_LEVEL",
- "StoredValue": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}, - "RestrictedSetValues": [
- "string"
]
}
}
], - "ItemLevelFieldsList": [
- {
- "Asin": "string",
- "AdditionalInputs": [
- {
- "AdditionalInputFieldName": "string",
- "SellerInputDefinition": {
- "IsRequired": true,
- "DataType": "string",
- "Constraints": [
- {
- "ValidationRegEx": "string",
- "ValidationString": "string"
}
], - "InputDisplayText": "string",
- "InputTarget": "SHIPMENT_LEVEL",
- "StoredValue": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}, - "RestrictedSetValues": [
- "string"
]
}
}
]
}
]
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}
Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 1 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
ShippingServiceId required | string An Amazon-defined shipping service identifier. |
required | object (Address) The postal address information. |
OrderId required | string An Amazon-defined order identifier, in 3-7-7 format. |
{- "ShippingServiceId": "string",
- "ShipFromAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "OrderId": "string"
}
{- "payload": {
- "ShipmentLevelFields": [
- {
- "AdditionalInputFieldName": "string",
- "SellerInputDefinition": {
- "IsRequired": true,
- "DataType": "string",
- "Constraints": [
- {
- "ValidationRegEx": "string",
- "ValidationString": "string"
}
], - "InputDisplayText": "string",
- "InputTarget": "SHIPMENT_LEVEL",
- "StoredValue": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}, - "RestrictedSetValues": [
- "string"
]
}
}
], - "ItemLevelFieldsList": [
- {
- "Asin": "string",
- "AdditionalInputs": [
- {
- "AdditionalInputFieldName": "string",
- "SellerInputDefinition": {
- "IsRequired": true,
- "DataType": "string",
- "Constraints": [
- {
- "ValidationRegEx": "string",
- "ValidationString": "string"
}
], - "InputDisplayText": "string",
- "InputTarget": "SHIPMENT_LEVEL",
- "StoredValue": {
- "DataType": "string",
- "ValueAsString": "string",
- "ValueAsBoolean": true,
- "ValueAsInteger": 0,
- "ValueAsTimestamp": "2019-08-24T14:15:22Z",
- "ValueAsAddress": {
- "Name": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "DistrictOrCounty": "string",
- "Email": "string",
- "City": "string",
- "StateOrProvinceCode": "string",
- "PostalCode": "string",
- "CountryCode": "string",
- "Phone": "string"
}, - "ValueAsWeight": {
- "Value": 0,
- "Unit": "oz"
}, - "ValueAsDimension": {
- "value": 0,
- "unit": "inches"
}, - "ValueAsCurrency": {
- "CurrencyCode": "str",
- "Amount": 0
}
}, - "RestrictedSetValues": [
- "string"
]
}
}
]
}
]
}, - "errors": [
- {
- "code": "string",
- "message": "string",
- "details": "string"
}
]
}