Amazon Selling Partner

The Selling Partner API for Amazon External Fulfillment Shipments Processing

You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this…

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

You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.

Endpoints 12

shipmentRetrieval

  • GETgetShipments/externalFulfillment/2024-09-11/shipments?locationId=ABCD&marketplaceId=A21TJRUUN4KGV&channelName=FBA&status=CONFIRMED&lastUpdatedAfter=2020-06-08T17:23:58Z&lastUpdatedBefore=2020-06-08T17:23:58Z&maxResults=10&paginationToken=eyJsYXN0VXBkYXRlZFRpbWVzdGFtcCI6eyJzIjpLLGet a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the…
  • GETgetShipment/externalFulfillment/2024-09-11/shipments/:shipmentIdGet a single shipment with the ID you specify.

sandboxShipments

  • POSTcreateSandboxShipment/externalFulfillment/2024-09-11/shipmentsCreates a sandbox shipment to simulate order creation in the test environment. This operation is available only in the sandbox environment. The shipment is…
  • PATCHupdateSandboxShipment/externalFulfillment/2024-09-11/shipments/:shipmentIdUpdates a sandbox shipment on marketplace behalf. Supports status changes, invoice availability, and transport capacity updates.

shipmentProcessing

  • POSTprocessShipment/externalFulfillment/2024-09-11/shipments/:shipmentId?operation=CONFIRMConfirm or reject the specified shipment.
  • POSTcreatePackages/externalFulfillment/2024-09-11/shipments/:shipmentId/packagesProvide details about the packages in the specified shipment.
  • PUTupdatePackage/externalFulfillment/2024-09-11/shipments/:shipmentId/packages/:packageIdUpdates the details about the packages that will be used to fulfill the specified shipment.
  • PATCHupdatePackageStatus/externalFulfillment/2024-09-11/shipments/:shipmentId/packages/:packageId?status=SHIPPEDUpdates the status of the packages.
  • GETretrieveShippingOptions/externalFulfillment/2024-09-11/shipments/:shipmentId/shippingOptions?packageId=stringGet a list of shipping options for a package in a shipment given the shipment's marketplace and channel. If the marketplace and channel have a pre-determined…
  • GETretrieveInvoice/externalFulfillment/2024-09-11/shipments/:shipmentId/invoiceRetrieve invoices for the shipment you specify.
  • POSTgenerateInvoice/externalFulfillment/2024-09-11/shipments/:shipmentId/invoiceGet invoices for the shipment you specify.
  • PUTgenerateShipLabels/externalFulfillment/2024-09-11/shipments/:shipmentId/shipLabels?shippingOptionId=string&operation=GENERATEGenerate and retrieve all shipping labels for one or more packages in the shipment you specify.

API details

Base URL
https://sellingpartnerapi-na.amazon.com
Authentication
None declared in the description
Operations
12 operations on 7 pathsGET 4POST 4PUT 2PATCH 2
Main resources
shipmentProcessing 8sandboxShipments 2shipmentRetrieval 2
Response formats
application/json
Description format
Swagger 2.0, API version 2024-09-11

How to test the The Selling Partner API for Amazon External Fulfillment Shipments Processing 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 The Selling Partner API for Amazon External Fulfillment Shipments Processing 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 “getShipments” (GET /externalFulfillment/2024-09-11/shipments?locationId=ABCD&marketplaceId=A21TJRUUN4KGV&channelName=FBA&status=CONFIRMED&lastUpdatedAfter=2020-06-08T17:23:58Z&lastUpdatedBefore=2020-06-08T17:23:58Z&maxResults=10&paginationToken=eyJsYXN0VXBkYXRlZFRpbWVzdGFtcCI6eyJzIjpLL), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the The Selling Partner API for Amazon External Fulfillment Shipments Processing?

You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this… It is listed under E-commerce and has 12 endpoints.

Who publishes the The Selling Partner API for Amazon External Fulfillment Shipments Processing?

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 The Selling Partner API for Amazon External Fulfillment Shipments Processing?

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

How do I authenticate with the The Selling Partner API for Amazon External Fulfillment Shipments Processing?

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 The Selling Partner API for Amazon External Fulfillment Shipments Processing have?

12 operations on 7 paths (4 GET, 4 POST, 2 PUT, 2 PATCH). The largest groups are shipmentProcessing, sandboxShipments, shipmentRetrieval.

Is forking the The Selling Partner API for Amazon External Fulfillment Shipments Processing 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.