Amazon Selling Partner

The Selling Partner API for FBA inbound operations.

The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments…

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 Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability with the Send-to-Amazon user interface.

Endpoints 45

fbaInbound

  • GETlistInboundPlans/inbound/fba/2024-03-20/inboundPlans?pageSize=10&paginationToken=string&status=ACTIVE&sortBy=LAST_UPDATED_TIME&sortOrder=ASCProvides a list of inbound plans with minimal information. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • POSTcreateInboundPlan/inbound/fba/2024-03-20/inboundPlansCreates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network. Usage Plan: The…
  • GETgetInboundPlan/inbound/fba/2024-03-20/inboundPlans/:inboundPlanIdFetches the top level information about an inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • GETlistInboundPlanBoxes/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/boxes?pageSize=10&paginationToken=stringProvides a paginated list of box packages in an inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that…
  • PUTcancelInboundPlan/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/cancellationCancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for…
  • GETlistInboundPlanItems/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/items?pageSize=10&paginationToken=stringProvides a paginated list of item packages in an inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that…
  • PUTupdateInboundPlanName/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/nameUpdates the name of an existing inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to…
  • GETlistPackingGroupBoxes/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/packingGroups/:packingGroupId/boxes?pageSize=10&paginationToken=stringRetrieves a page of boxes from a given packing group. These boxes were previously provided through the setPackingInformation operation. This API is used for…
  • GETlistPackingGroupItems/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/packingGroups/:packingGroupId/items?pageSize=10&paginationToken=stringRetrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be…
  • POSTsetPackingInformation/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/packingInformationSets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for…
  • GETlistPackingOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/packingOptions?pageSize=10&paginationToken=stringRetrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.…
  • POSTgeneratePackingOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/packingOptionsGenerates available packing options for the inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • POSTconfirmPackingOption/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/packingOptions/:packingOptionId/confirmationConfirms the packing option for an inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied…
  • GETlistInboundPlanPallets/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/pallets?pageSize=10&paginationToken=stringProvides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating…
  • GETlistPlacementOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/placementOptions?pageSize=10&paginationToken=stringProvides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming…
  • POSTgeneratePlacementOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/placementOptionsGenerates placement options for the inbound plan. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied…
  • POSTconfirmPlacementOption/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/placementOptions/:placementOptionId/confirmationConfirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. Usage Plan: The x-amzn-RateLimit-Limit response…
  • GETgetShipment/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentIdProvides the full details for a specific shipment within an inbound plan. The transportationOptionId inside acceptedTransportationSelection can be used to…
  • GETlistShipmentBoxes/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/boxes?pageSize=10&paginationToken=stringProvides a paginated list of box packages in a shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • GETlistShipmentContentUpdatePreviews/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/contentUpdatePreviews?pageSize=10&paginationToken=stringRetrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment…
  • POSTgenerateShipmentContentUpdatePreviews/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/contentUpdatePreviewsGenerate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update…
  • GETgetShipmentContentUpdatePreview/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/contentUpdatePreviews/:contentUpdatePreviewIdRetrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications…
  • POSTconfirmShipmentContentUpdatePreview/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/contentUpdatePreviews/:contentUpdatePreviewId/confirmationConfirm a shipment content update preview and accept the changes in transportation cost. Usage Plan: The x-amzn-RateLimit-Limit response header returns the…
  • GETgetDeliveryChallanDocument/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/deliveryChallanDocumentProvide delivery challan document for PCP transportation in IN marketplace. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • GETlistDeliveryWindowOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/deliveryWindowOptions?pageSize=10&paginationToken=stringRetrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before…
  • POSTgenerateDeliveryWindowOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/deliveryWindowOptionsGenerates available delivery window options for a given shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits…
  • POSTconfirmDeliveryWindowOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/deliveryWindowOptions/:deliveryWindowOptionId/confirmationConfirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed,…
  • GETlistShipmentItems/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/items?pageSize=10&paginationToken=stringProvides a paginated list of item packages in a shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • PUTupdateShipmentName/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/nameUpdates the name of an existing shipment. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the…
  • GETlistShipmentPallets/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/pallets?pageSize=10&paginationToken=stringProvides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating…
  • PUTcancelSelfShipAppointment/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/selfShipAppointmentCancellationCancels a self-ship appointment slot against a shipment. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN. Usage Plan: The…
  • GETgetSelfShipAppointmentSlots/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/selfShipAppointmentSlots?pageSize=10&paginationToken=stringRetrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following marketplaces: MX, BR,…
  • POSTgenerateSelfShipAppointmentSlots/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/selfShipAppointmentSlotsInitiates the process of generating the appointment slots list. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN. Usage Plan: The…
  • POSTscheduleSelfShipAppointment/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/selfShipAppointmentSlots/:slotId/scheduleConfirms or reschedules a self-ship appointment slot against a shipment. Only available in the following marketplaces: MX, BR, EG, SA, AE, IN. Usage Plan: The…
  • PUTupdateShipmentSourceAddress/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/sourceAddressUpdates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a…
  • PUTupdateShipmentTrackingDetails/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/shipments/:shipmentId/trackingDetailsUpdates a shipment's tracking details. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the…
  • GETlistTransportationOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/transportationOptions?pageSize=10&paginationToken=string&placementOptionId=string&shipmentId=stringRetrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions operation before…
  • POSTgenerateTransportationOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/transportationOptionsGenerates available transportation options for a given placement option. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • POSTconfirmTransportationOptions/inbound/fba/2024-03-20/inboundPlans/:inboundPlanId/transportationOptions/confirmationConfirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation…
  • GETlistItemComplianceDetails/inbound/fba/2024-03-20/items/compliance?mskus=string&marketplaceId=stringList the inbound compliance details for MSKUs in a given marketplace. Note: MSKUs that contain certain characters must be encoded. For more information, refer…
  • PUTupdateItemComplianceDetails/inbound/fba/2024-03-20/items/compliance?marketplaceId=stringUpdate compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.…
  • POSTcreateMarketplaceItemLabels/inbound/fba/2024-03-20/items/labelsFor a given marketplace - creates labels for a list of MSKUs. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that…
  • GETlistPrepDetails/inbound/fba/2024-03-20/items/prepDetails?marketplaceId=string&mskus=stringGet preparation details for a list of MSKUs in a specified marketplace. Note: MSKUs that contain certain characters must be encoded. For more information,…
  • POSTsetPrepDetails/inbound/fba/2024-03-20/items/prepDetailsSet the preparation details for a list of MSKUs in a specified marketplace. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • GETgetInboundOperationStatus/inbound/fba/2024-03-20/operations/:operationIdGets the status of the processing of an asynchronous API call. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that…

API details

Base URL
https://sellingpartnerapi-na.amazon.com
Authentication
None declared in the description
Operations
45 operations on 36 pathsGET 22POST 16PUT 7
Main resources
fbaInbound 45
Response formats
application/json
Description format
Swagger 2.0, API version 2024-03-20

How to test the The Selling Partner API for FBA inbound operations. 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 FBA inbound operations. 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 “listInboundPlans” (GET /inbound/fba/2024-03-20/inboundPlans?pageSize=10&paginationToken=string&status=ACTIVE&sortBy=LAST_UPDATED_TIME&sortOrder=ASC), 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 FBA inbound operations.?

The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments… It is listed under E-commerce and has 45 endpoints.

Who publishes the The Selling Partner API for FBA inbound operations.?

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 FBA inbound operations.?

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 FBA inbound operations.?

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 FBA inbound operations. have?

45 operations on 36 paths (22 GET, 16 POST, 7 PUT). The largest groups are fbaInbound.

Is forking the The Selling Partner API for FBA inbound operations. 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.