Amazon Selling Partner

Amazon Shipping API

The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external…

E-commerce#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.

Endpoints 20

shipping

  • POSTgetRates/shipping/v2/shipments/ratesReturns the available shipping service offerings. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied…
  • POSTdirectPurchaseShipment/shipping/v2/shipments/directPurchasePurchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. Usage Plan: The…
  • POSTpurchaseShipment/shipping/v2/shipmentsPurchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by…
  • POSToneClickShipment/shipping/v2/oneClickShipmentPurchases a shipping service identifier and returns purchase-related details and documents. Usage Plan: The x-amzn-RateLimit-Limit response header returns the…
  • GETgetTracking/shipping/v2/tracking?trackingId=string&carrierId=stringReturns tracking information for a purchased shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • GETgetShipmentDocuments/shipping/v2/shipments/:shipmentId/documents?packageClientReferenceId=string&format=string&dpi=0.0Returns the shipping documents associated with a package in a shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • PUTcancelShipment/shipping/v2/shipments/:shipmentId/cancelCancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. Usage Plan: The x-amzn-RateLimit-Limit response header…
  • GETgetAdditionalInputs/shipping/v2/shipments/additionalInputs/schema?requestToken=string&rateId=stringReturns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the…
  • GETgetCarrierAccountFormInputs/shipping/v2/carrierAccountFormInputsThis API will return a list of input schema required to register a shipper account with the carrier. Usage Plan: The x-amzn-RateLimit-Limit response header…
  • PUTgetCarrierAccounts/shipping/v2/carrierAccountsThis API will return Get all carrier accounts for a merchant. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that…
  • PUTlinkCarrierAccount/shipping/v2/carrierAccounts/:carrierIdThis API associates/links the specified carrier account with the merchant. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • POSTlinkCarrierAccount/shipping/v2/carrierAccounts/:carrierIdThis API associates/links the specified carrier account with the merchant. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • PUTunlinkCarrierAccount/shipping/v2/carrierAccounts/:carrierId/unlinkThis API Unlink the specified carrier account with the merchant. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits…
  • POSTgenerateCollectionForm/shipping/v2/collectionFormsThis API Call to generate the collection form. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to…
  • PUTgetCollectionFormHistory/shipping/v2/collectionForms/historyThis API Call to get the history of the previously generated collection forms. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan…
  • PUTgetUnmanifestedShipments/shipping/v2/unmanifestedShipmentsThis API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall…
  • GETgetCollectionForm/shipping/v2/collectionForms/:collectionFormIdThis API reprint a collection form. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the…
  • GETgetAccessPoints/shipping/v2/accessPoints?accessPointTypes=HELIX&countryCode=US&postalCode=EX332JLReturns a list of access points in proximity of input postal code. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits…
  • POSTsubmitNdrFeedback/shipping/v2/ndrFeedbackThis API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage…
  • POSTcreateClaim/shipping/v2/claimsThis API will be used to create claim for single eligible shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits…

API details

Base URL
https://sellingpartnerapi-eu.amazon.com
Authentication
None declared in the description
Operations
20 operations on 19 pathsPOST 8GET 6PUT 6
Main resources
shipping 20
Response formats
application/json
Description format
Swagger 2.0, API version v2

How to test the Amazon Shipping API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Shipping API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “getRates” (POST /shipping/v2/shipments/rates), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Shipping API?

The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external… It is listed under E-commerce and has 20 endpoints.

Who publishes the Amazon Shipping API?

It is listed from Amazon Selling Partner's public API description (an OpenAPI document), not published by Amazon Selling Partner on Swastik Codes. Anyone who controls sellingpartnerapi.amazon.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Shipping API?

Requests go to https://sellingpartnerapi-eu.amazon.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Shipping API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Amazon Shipping API have?

20 operations on 19 paths (8 POST, 6 GET, 6 PUT). The largest groups are shipping.

Is forking the Amazon Shipping API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.