Supply Sources API

You use the Supply Sources API to manage the configurations and capabilities of seller supply sources.

Release notes

• November 8, 2023

To learn more about the terms that are used in this guide, refer to Terminology.

Prior to using the Supply Sources API, your seller account must have permission to use Multi-Location Inventory (MLI). If your account does not have MLI permissions, you can request access through the Multi-Location Inventory Sign-up Form. You will receive confirmation that your account is ready within 15 business days.

After your account has permissions to use MLI, your default location and any locations you created on templates allowed by Shipping Settings Automation (SSA) will be automatically added as supply sources. If you need to add or update supply sources, you can use the Supply Sources API or navigate to the Locations tab in Seller Central Shipping Settings.

1. Create new or update existing supply sources via the Supply Sources API or Seller Central UI.
2. Provide location-specific inventory via the API.
3. Create or identify existing templates allowed by Shipping Settings Automation (SSA) that include all of your inventory locations that use these shipping settings.
4. Assign the shipping template created or identified in Step 3 to the SKUs you added inventory per location.
5. Set DEFAULT inventory channel to 0.
6. Add the Selling Partner Insights role to your developer profile.

🚧

Caution

MLI is currently not available for the following sellers:

• Sellers who are a part of the Buy Online Pickup in Store (BOPIS) program
• Sellers who use FBA inventory
• Sellers who manage their inventory via Seller Central

Use cases

The following use case examples are available for the Supply Sources API:

• Configure a new supply source: Add a new supply source with the Supply Sources API or through Seller Central.
• Configure the status of an existing supply source: Set the status of your store.
• Retrieve the details of a configured supply source: Get the supply source.
• Update an existing supply source: Update a supply source.
• Practice onboarding an end-to-end seller with one SKU: Use the Supply Sources API to onboard an end-to-end seller with one SKU.

📘

Note

To retrieve an order fulfillment feed, you can use the feed type value POST_ORDER_FULFILLMENT_DATA with the Feeds API. For more information, refer to Feeds API.

Roles

archiveSupplySource

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Selling Partner Insights

createSupplySource

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Selling Partner Insights

getSupplySource

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Selling Partner Insights

getSupplySources

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Selling Partner Insights

updateSupplySource

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Selling Partner Insights

updateSupplySourceStatus

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Selling Partner Insights