/shipping/v2/shipments/rates

post https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/shipments/rates

Returns the available shipping service offerings.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

shipTo

object

The address.

shipFrom

object

required

The address.

returnTo

object

The address.

shipDate

date-time

The ship date and time (the requested pickup). This defaults to the current date and time.

shipperInstruction

object

The shipper instruction.

packages

array of objects

required

A list of packages to be shipped through a shipping service offering.

packages*

valueAddedServices

object

A collection of supported value-added services.

taxDetails

array of objects

A list of tax detail information.

taxDetails

channelDetails

object

required

Shipment source channel related information.

clientReferenceDetails

array of objects

Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail

clientReferenceDetails

shipmentType

string

Shipment type.

Show Details

FORWARD	Additional information about shipment representing package journey from origin address to destination address in the transportation/shipping request.
RETURNS	Additional information about shipment representing package journey from destination address to origin/return address in the original transportation/shipping request.

destinationAccessPointDetails

object

Headers

x-amz-access-token

string

required

Amazon shipping request token

x-amzn-shipping-business-id

string

required

Amazon shipping business to assume for this request.

Show Details

AmazonShipping_US	The United States Amazon shipping business.
AmazonShipping_IN	The India Amazon shipping business.
AmazonShipping_UK	The United Kingdom Amazon shipping business.
AmazonShipping_IT	The Italy Amazon shipping business.
AmazonShipping_ES	The Spain Amazon shipping business.
AmazonShipping_FR	The France Amazon shipping business.

Responses

Response body

object

payload

object

The payload for the getRates operation.

requestToken

string

required

A unique token generated to identify a getRates operation.

rates

array of objects

required

A list of eligible shipping service offerings.

rates*

object

rateId

string

required

An identifier for the rate (shipment offering) provided by a shipping service provider.

carrierId

string

required

The carrier identifier for the offering, provided by the carrier.

carrierName

string

required

The carrier name for the offering.

serviceId

string

required

An identifier for the shipping service.

serviceName

string

required

The name of the shipping service.

billedWeight

object

The weight in the units indicated.

totalCharge

object

required

The monetary value in the currency indicated, in ISO 4217 standard format.

promise

object

required

The time windows promised for pickup and delivery events.

supportedDocumentSpecifications

array of objects

required

A list of the document specifications supported for a shipment service offering.

supportedDocumentSpecifications*

object

format

string

required

The file format of the document.

PDF PNG ZPL

Show Details

PDF	The Portable Document Format (PDF) file format. Used to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems.
PNG	Portable Network Graphics (PNG) is a raster-graphics file format that supports lossless data compression.
ZPL	Zebra Programming Language (ZPL) format is from Zebra Technologies. It's used primarily for labeling applications and can only be used with ZPL compatible printers.

size

object

required

The size dimensions of the label.

printOptions

array of objects

required

A list of the format options for a label.

printOptions*

object

supportedDPIs

array of integers

A list of the supported DPI options for a document.

supportedDPIs

supportedPageLayouts

array of strings

required

A list of the supported page layout options for a document.

supportedPageLayouts*

supportedFileJoiningOptions

array of booleans

required

A list of the supported needFileJoining boolean values for a document.

supportedFileJoiningOptions*

supportedDocumentDetails

array of objects

required

A list of the supported documented details.

supportedDocumentDetails*

object

name

string

required

The type of shipping document.

PACKSLIP LABEL RECEIPT CUSTOM_FORM

Show Details

PACKSLIP	A listing of the items packed within the shipment.
LABEL	The shipping label for the specific shipment.
RECEIPT	The receipt of the shipment.
CUSTOM_FORM	The customs documentation for a cross-border shipment.

isMandatory

boolean

required

When true, the supported document type is required.

availableValueAddedServiceGroups

array of objects

A list of value-added services available for a shipping service offering.

availableValueAddedServiceGroups

object

groupId

string

required

The type of the value-added service group.

groupDescription

string

required

The name of the value-added service group.

isRequired

boolean

required

When true, one or more of the value-added services listed must be specified.

valueAddedServices

array of objects

A list of optional value-added services available for purchase with a shipping service offering.

valueAddedServices

object

string

required

The identifier for the value-added service.

name

string

required

The name of the value-added service.

cost

object

required

The monetary value in the currency indicated, in ISO 4217 standard format.

requiresAdditionalInputs

boolean

required

When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation.

rateItemList

array of objects

A list of RateItem

rateItemList

object

rateItemID

string

Unique ID for the rateItem.

BASE_RATE TRANSACTION_FEE ADULT_SIGNATURE_CONFIRMATION SIGNATURE_CONFIRMATION NO_CONFIRMATION WAIVE_SIGNATURE IMPLIED_LIABILITY HIDDEN_POSTAGE DECLARED_VALUE SUNDAY_HOLIDAY_DELIVERY DELIVERY_CONFIRMATION IMPORT_DUTY_CHARGE VAT NO_SATURDAY_DELIVERY INSURANCE COD FUEL_SURCHARGE INSPECTION_CHARGE DELIVERY_AREA_SURCHARGE WAYBILL_CHARGE AMAZON_SPONSORED_DISCOUNT INTEGRATOR_SPONSORED_DISCOUNT OVERSIZE_SURCHARGE CONGESTION_CHARGE RESIDENTIAL_SURCHARGE ADDITIONAL_SURCHARGE SURCHARGE REBATE

Show Details

BASE_RATE	for Base Rate.
TRANSACTION_FEE	Charge for TransAction Fee.
ADULT_SIGNATURE_CONFIRMATION	Charge for Adult Signature Confirmation.
SIGNATURE_CONFIRMATION	Charge for signature confirmation.
NO_CONFIRMATION	Charge for No Confirmation.
WAIVE_SIGNATURE	Charge for Waive Signature.
IMPLIED_LIABILITY	Charge for Implied Liability.
HIDDEN_POSTAGE	Hidden Postage Charge.
DECLARED_VALUE	Declared Valure Coverage Charge.
SUNDAY_HOLIDAY_DELIVERY	Sunday Holiday Delivery Charge.
DELIVERY_CONFIRMATION	Charge for Delivery Confirmation.
IMPORT_DUTY_CHARGE	Import Duty Charge.
VAT	Vat Charge.
NO_SATURDAY_DELIVERY	Charge for No Satuarday Delivery.
INSURANCE	Insurance Charge.
COD	COD Charge.
AMAZON_SPONSORED_DISCOUNT	Amazon Sponsored Discount.
INTEGRATOR_SPONSORED_DISCOUNT	Integrator Sponsored Discount.
FUEL_SURCHARGE	Fuel Surcharge.
INSPECTION_CHARGE	Inspection Charge.
DELIVERY_AREA_SURCHARGE	Delivery Area Surcharge.
WAYBILL_CHARGE	WayBill Charge.
OVERSIZE_SURCHARGE	OverSize Surcharge.
CONGESTION_CHARGE	Congestion Charge.
RESIDENTIAL_SURCHARGE	Residential Surcharge.
ADDITIONAL_SURCHARGE	Additional Surcharge.
SURCHARGE	Surcharge.
REBATE	Rebate.

rateItemType

string

Type of the rateItem.

MANDATORY OPTIONAL INCLUDED

Show Details

MANDATORY	Rate Item is mandatory.
OPTIONAL	Rate Item is Optional.
INCLUDED	Rate Item is included.

rateItemCharge

object

The monetary value in the currency indicated, in ISO 4217 standard format.

rateItemNameLocalization

string

Used for the localization.

paymentType

string

Payment type of the purchase.

PAY_THROUGH_AMAZON PAY_DIRECT_TO_CARRIER

Show Details

PAY_THROUGH_AMAZON	Payment Through Amazon.
PAY_DIRECT_TO_CARRIER	Payment Direct to Carrier.

benefits

object

Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon.

ineligibleRates

array of objects

A list of ineligible shipping service offerings.

ineligibleRates

object

serviceId

string

required

An identifier for the shipping service.

serviceName

string

required

The name of the shipping service.

carrierName

string

required

The carrier name for the offering.

carrierId

string

required

The carrier identifier for the offering, provided by the carrier.

ineligibilityReasons

array of objects

required

A list of reasons why a shipping service offering is ineligible.

ineligibilityReasons*

object

code

string

required

Reasons that make a shipment service offering ineligible.

NO_COVERAGE PICKUP_SLOT_RESTRICTION UNSUPPORTED_VAS VAS_COMBINATION_RESTRICTION SIZE_RESTRICTIONS WEIGHT_RESTRICTIONS LATE_DELIVERY PROGRAM_CONSTRAINTS TERMS_AND_CONDITIONS_NOT_ACCEPTED UNKNOWN

Show Details

NO_COVERAGE	The shipment is ineligible because there is no coverage to that address.
PICKUP_SLOT_RESTRICTION	The shipment is ineligible because there is an issue with the pickup slot.
UNSUPPORTED_VAS	The shipment is ineligible because the value-added service is invalid for this shipment.
VAS_COMBINATION_RESTRICTION	The shipment is ineligible because an invalid combination of value-added services were chosen.
SIZE_RESTRICTIONS	The shipment is ineligible because the package dimensions are unsupported.
WEIGHT_RESTRICTIONS	The shipment is ineligible because the weight is unsupported.
LATE_DELIVERY	The shipment is ineligible because delivery is too late.
PROGRAM_CONSTRAINTS	The shipment is ineligible because of program constraints.
TERMS_AND_CONDITIONS_NOT_ACCEPTED	The shipment is ineligible because terms and conditions have not been accepted by the carrier.
UNKNOWN	The ineligibility reason is unknown.

message

string

required

The ineligibility reason.

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

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

xxxxxxxxxx
curl --request POST \
     --url https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/shipments/rates \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-amzn-shipping-business-id: AmazonShipping_US' \
     --data '
{
  "channelDetails": {
    "channelType": "AMAZON"
  }
}
'

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.