Supply Sources API v2020-07-01 Use Case Guide

The Supply Sources API is used to configure and update information on seller supply sources, such as stores and warehouses. You can use the Supply Sources API to build applications that use location-level fulfillment capabilities and provide information about supply sources and location level inventory.

Key features

This use case guide provides tutorials on how to:

• Configure a new supply source
• Configure the status of an existing supply source
• Retrieve the details of a configured supply source
• Update an existing supply source
• Practice onboarding an end-to-end seller with one SKU
• Retrieve the Order Fulfillment Feed

Prerequisites

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

Tutorial: Configure a new supply source

You can add a new supply source either by using the Supply Sources API or through Seller Central.

Prerequisites

To complete this tutorial, you will need:

• Authorization from the seller for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.

Step 1. Configure a new supply source using the Supply Sources API

Call the createSupplySource operation.

Step 2. Configure a new supply source through Selling Central Shipping Settings

Alternatively, you can add a new supply source through Seller Central:

1. Log in to your Seller Central account.
2. Navigate to the settings icon in the top-right corner, then selectShipping Settings.
3. Select the Locations tab.
4. Choose Add Location to create a new supply source.
5. To make changes to an existing Supply Source, select Edit on the right-hand side next to the supply source.
6. Select Save.

Tutorial: Configure the status of an existing supply source

Step 1. Set the status of your store

Call the updateSupplySourceStatus operation.

📘

Note

The store status is Inactive by default. You should set the status as Active when ready to go live.

Tutorial: Retrieve the details of a configured supply source

Step 1. Retrieve the supply source ID

Call the getSupplySource operation.

Tutorial: Update an existing supply source

Step 1. Set the supply source ID

Call the updateSupplySource operation.

📘

Note

HandlingTime is for us in the BOPIS program only. The HandlingTime element cannot be used with MLI.

Tutorial: Practice onboarding an end-to-end seller with one SKU

Step 1. Create the supply source

Call the createSupplySource operation.

Step 2. Get the supply source

Call the getSupplySource operation.

Step 3. Update the configuration status

Call the updateSupplySource operation.

Step 4. Update the supply source status

Call the updateSupplySourceStatus operation.

Step 5. Get the supply source

Call the getSupplySource operation.

Tutorial: Retrieve the Order Fulfillment

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

    <xsd:include schemaLocation="amzn-base.xsd"/>

    <xsd:element name="OrderFulfillment">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:choice>
                    <xsd:element ref="AmazonOrderID"/>
                    <xsd:element ref="MerchantOrderID"/>
                </xsd:choice>
                <xsd:element name="MerchantFulfillmentID" type="IDNumber" minOccurs="0"/>
                <xsd:element name="FulfillmentDate" type="xsd:dateTime"/>
                <xsd:element name="FulfillmentData" minOccurs="0">
                    <xsd:complexType>
                        <xsd:sequence>
                            <xsd:element ref="CarrierCode" minOccurs="0"/>
                            <xsd:element name="CarrierName" type="String" minOccurs="0"/>
                            <xsd:element name="ShippingMethod" type="String" minOccurs="0"/>
                            <xsd:element name="ShipperTrackingNumber" type="String" minOccurs="0"/>
                        </xsd:sequence>
                    </xsd:complexType>
                </xsd:element>

                <xsd:element name="CODCollectionMethod" minOccurs="0">
                    <xsd:simpleType>
                        <xsd:restriction base="xsd:string">
                            <xsd:enumeration value="DirectPayment"/>
                        </xsd:restriction>
                    </xsd:simpleType>
                </xsd:element>

                <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                    <xsd:complexType>
                        <xsd:sequence>
                            <xsd:choice>
                                <xsd:element ref="AmazonOrderItemCode"/>
                                <xsd:element ref="MerchantOrderItemID"/>
                            </xsd:choice>
                            <xsd:element name="MerchantFulfillmentItemID" type="IDNumber"
                                minOccurs="0"/>
                            <xsd:element name="Quantity" type="xsd:positiveInteger" minOccurs="0"/>
                             <xsd:element name="TransparencyCode" type="xsd:string" minOccurs="0" maxOccurs="10"/>
                        </xsd:sequence>
                    </xsd:complexType>
                </xsd:element>
                <xsd:element name="ShipFromAddress" type="AddressType" minOccurs="0" />

            </xsd:sequence>
        </xsd:complexType>
    </xsd:element>

</xsd:schema>