サプライソースAPI v2020-07-01ユースケースガイド
Supply Sources APIを使用して出品者の供給元構成と機能を管理します。
API バージョン:2020-07-01
サプライソースAPIとは何ですか?
Supply Sources APIは、店舗や倉庫などの販売者のサプライソースに関する情報を設定および更新するために使用されます。Supply Sources APIを使用して、ロケーションレベルのフルフィルメント機能を使用し、供給元とロケーションレベルの在庫に関する情報を提供するアプリケーションを構築できます。
主な機能
このユースケースガイドでは、以下の方法に関するチュートリアルを提供しています。
- 新しい供給元を設定
- 既存の供給源のステータスを設定します
- 設定した供給元の詳細を取得
- 既存の供給源を更新
- 設定されているすべての供給元を一覧表示
- 1つのSKUでエンドツーエンドの販売者をオンボーディングする練習
- 注文処理フィードを取得する
前提条件
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.
アカウントにMLIを使用する権限が付与されると、デフォルトのロケーションと、配送設定の自動化(SSA)で許可されているテンプレートで作成したロケーションが自動的に供給元として追加されます。供給元を追加または更新する必要がある場合は、供給元APIを使用するか、セラーセントラルの配送設定の「所在地」タブに移動してください。
- サプライソースAPIまたはセラーセントラルUIを使用して、新しいサプライソースを作成するか、既存のサプライソースを更新します。
- API を介してロケーション固有のインベントリを提供します。
- Create or identify existing templates allowed by Shipping Settings Automation (SSA) that include all of your inventory locations that use these shipping settings.
- 手順3で作成または特定した配送テンプレートを、ロケーションごとに在庫を追加したSKUに割り当てます。
- セット
DEFAULT
インベントリチャネルへ0
。 - Add the Selling Partner Insights role to your developer profile.
MLIは現在、以下の出品者はご利用いただけません。
- オンラインストア受取 (BOPIS) プログラムに参加している出品者。
- FBA在庫を使用する出品者。
- セラーセントラルで在庫を管理している出品者。
チュートリアル:新しい供給源の設定
サプライソースAPIまたはセラーセントラルを使用して、新しいサプライソースを追加できます。
前提条件
このチュートリアルを完了するには、以下が必要です。
- Authorization from the seller for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
ステップ 1.サプライソース API を使用して新しいサプライソースを設定します。
POST
the Supply Sources API and pass the following parameters:
リクエストパラメータ
パラメーター | 説明 | 必須 |
---|---|---|
supplySourceCode |
出品者は固有の供給元IDを提供しました。 タイプ:文字列 |
はい |
alias |
特定の供給源。このフィールドは、購入者が直面する関連ユースケースで購入者に表示されます。形式は次のとおりでなければなりません Store Name – City Name タイプ:文字列 |
はい |
address |
供給元の特定のアドレス。 Type: Address |
はい |
住所
次の表は、の子要素を示しています address
エレメント:
要素 | 説明 |
---|---|
name |
住所に関連する名前。この名前は購入者に表示する必要があります。形式は次のとおりでなければなりません。 Store Name – City Name タイプ:文字列 |
addressLine1 |
アドレスフィールド。 タイプ:文字列 |
addressLine2 |
追加の住所フィールド。 タイプ:文字列 |
addressLine3 |
追加の住所フィールド。 タイプ:文字列 |
city |
供給元の特定のアドレス。 タイプ:文字列 |
county |
供給元の特定のアドレス。 タイプ:文字列 |
district |
供給元の特定のアドレス。 タイプ:文字列 |
stateOrRegion |
住所の特定の州または地域。 タイプ:文字列 |
postalCode |
住所の郵便番号。 タイプ:文字列 |
countryCode |
住所の国コード。 タイプ:文字列 |
phone |
供給元住所の電話番号。このフィールドは、関連する購入者向けのユースケースで購入者に表示されます。 タイプ:文字列 |
レスポンス
成功時のレスポンスには次のオブジェクトが含まれます。
名前 | 説明 |
---|---|
supplySourceId |
Amazonが用意した供給元の英数字識別子。 SupplySourceId 世界的にユニークです。タイプ:文字列 |
レスポンス例
{
"address": {
"name": "ABC Store - Milpitas",
"addressLine1": "63 Ranch Dr",
"countryCode": "US",
"stateOrRegion": "CA",
"addressLine2": "",
"addressLine3": "",
"city": "Milpitas",
"county": "Santa Clara",
"district": "",
"postalCode": "95035",
"phone": "1234567890"
},
"supplySourceCode": "TestRaghav123",
"alias": "ABC Store - Milpitas"
}
ステップ 2.セリングセントラルの配送設定から新しい供給元を設定します。
または、セラーセントラルから新しい供給元を追加することもできます。
- Log in to your Seller Central account.
- 右上隅の設定アイコンに移動し、以下を選択しますShipping Settings。
- 選択してください Locations タブ。
- 選択 Add Location 新しい供給源を作るためだ
- 既存の供給元に変更を加えるには、 Edit 右側の供給源の隣にあります。
- Saveを選択します。
チュートリアル:既存の供給元ステータスの設定
ステップ 1.ストアのステータスを設定します。
PUT
the status
and pass the following parameters:
リクエストパラメーター
パラメーター | 説明 | 必須 |
---|---|---|
status |
供給元のステータスを指定してください。有効な値は以下のとおりです。 Active そして Inactive 。タイプ:文字列 |
はい |
ストアステータスは
Inactive
デフォルトです。販売パートナーはステータスを次のように設定する必要があります
Active
ライブ配信の準備が整ったら
レスポンス例
{
"supplySourceId": "353e4e48-6301-4d50-990e-43a86e8787a3",
"supplySourceCode": "ss_ss005",
"alias": "SS Store - Milpitas"
"status": "Inactive"
"address": {
"name": "SS Store - Milpitas",
"addressLine1": "63 Ranch Dr",
"addressLine2": "",
"addressLine3": "",
"city": "Milpitas",
"county": "Santa Clara",
"district": "",
"stateOrRegion": "CA"
"postalCode": "95035",
"countryCode": "US",
},
"createdAt": "1.678741763E9",
"updatedAt": "1.678741763E9"
}
チュートリアル:設定済みの供給元の詳細の取得
ステップ 1.サプライソース ID を取得します。
GET
the supplySourceId
. No query parameters are required.
レスポンス
成功時のレスポンスには次のオブジェクトが含まれます。
名前 | 説明 |
---|---|
supplySourceId |
Amazonが用意した供給元の英数字識別子。 SupplySourceId 世界的にユニークです。タイプ:文字列 |
supplySourceCode |
出品者が提供した固有の供給元識別子。 タイプ:文字列 |
alias |
供給元の名前。このフィールドは、購入者が直面する関連ユースケースで購入者に表示されます。 タイプ:文字列 |
status |
ストアのステータス。指定できる値は以下のとおりです。 Active , Inactive 、および Archived 。タイプ:文字列 |
address |
供給元のアドレス。 Type: Address |
configuration |
供給源の構成。 |
capabilities |
供給源の機能。 Type: Capabilities |
createdAt |
供給元が作成された日付と時刻。 タイプ:文字列 |
updatedAt |
供給元が更新された日付と時刻。 タイプ:文字列 |
チュートリアル:既存の供給源の更新
ステップ 1.供給元 ID を設定します。
PUT
the supplySourceId
and pass the following parameters:
リクエストパラメータ
パラメーター | 説明 | 必須 |
---|---|---|
alias |
供給元の具体的な名前。このフィールドは、購入者が直面する関連ユースケースで購入者に表示されます。 タイプ:文字列 |
はい |
configuration |
供給源の特定の構成。 | はい |
capabilities |
供給源の特定の機能。 Type: Capabilities |
はい |
コンフィギュレーション
次の表は、の子要素を示しています Configuration
エレメント:
要素 | 説明 |
---|---|
operationalConfiguration |
供給源の運用構成。 Type: OperationalConfiguration |
timezone |
The timezone in which the supply source operates. Refer to canonical time zone ID listed in RFC 6557. タイプ:文字列 |
handlingTime |
配送のユースケースでは、出品者が商品を発送するのにかかる時間です。集荷のユースケースでは、出品者が商品の受け取り準備が整うまでにかかる時間です。 Type: Duration |
処理時間
HandlingTime
BOPIS プログラムに参加している弊社専用です。は
HandlingTime
エレメントは MLI では使用できません。
次の表は、の子要素を示しています HandlingTime
エレメント:
要素 | 説明 |
---|---|
value |
供給元の処理時間。 Type: NonNegativeInteger |
timeUnit |
出荷作業時間の測定に使用される時間単位。許容値は以下のとおりです。 Minutes , Hours そして Days 。タイプ:文字列 |
運用上の構成
次の表は、の子要素を示しています OperationalConfiguration
エレメント:
要素 | 説明 |
---|---|
contactDetails |
供給元の連絡先の詳細。 Type: ContactDetails |
operatingHoursByDay |
供給元の稼働時間。 Type: OperatingHoursByDay |
throughputConfig |
供給源のスループット構成。 Type: ThroughputConfig |
連絡先詳細
次の表は、の子要素を示しています ContactDetails
エレメント:
要素 | 説明 |
---|---|
primary |
供給元の主要連絡先の連絡先詳細。 Type: Primary |
プライマリ
次の表は、の子要素を示しています Primary
エレメント:
要素 | 説明 |
---|---|
email |
供給元の連絡先メールアドレス。このフィールドは、購入者が直面する関連ユースケースで購入者に表示されます。 タイプ:文字列 |
phone |
供給元担当者の電話番号。 タイプ:文字列 |
日ごとの営業時間
次の表は、の子要素を示しています OperatingHoursByDay
エレメント:
要素 | 説明 |
---|---|
monday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
tuesday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
wednesday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
thursday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
friday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
saturday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
sunday |
[{"開始時間」:「文字列」,「終了時間」:「文字列"}] を含むオブジェクトのリスト。 タイプ:オブジェクト |
時間フォーマット
The
startTime
andendTime
are ISO 8601 formatted timestamps without dates. The format isHH:mm
. For example,12:30
.
スループット構成
次の表は、の子要素を示しています ThroughputConfig
エレメント:
要素 | 説明 |
---|---|
throughputCap |
は throughputCap 供給源の。Type: ThroughputCap |
スループット上限
次の表は、の子要素を示しています ThroughputCap
エレメント:
要素 | 説明 |
---|---|
value |
は throughputCap バリュー。Type: NonNegativeInteger |
timeUnit |
の時間単位 throughputCap 。許容値は Minutes , Hours そして Days 。タイプ:文字列 |
機能
次の表は、の子要素を示しています Capabilities
エレメント:
要素 | 説明 |
---|---|
outbound |
供給元のアウトバウンド機能。 Type: OutboundCapability |
出荷
次の表は、の子要素を示しています Outbound
エレメント:
要素 | 説明 |
---|---|
isSupported |
TRUE の場合、供給元はアウトバウンド機能をサポートします。 タイプ:ブール値 |
operationalConfiguration |
運用構成の構造は、構成の親エンティティの下にリストされているものと同じです。このレベルの運用構成の値は、構成レベルで指定された値よりも優先されます。 Type: OperationalConfiguration |
returnLocation |
返品先住所は、供給元のアウトバウンドに関連付けられています。 Type: ReturnLocation |
deliveryChannel |
配信チャネルの運用構成。供給元が配送をサポートしている場合にのみ応答があります。 Type: DeliveryChannel |
pickupChannel |
ピックアップチャネルの動作設定。供給元がピックアップをサポートしている場合にのみ応答があります。 Type: PickupChannel |
返却場所
次の表は、の子要素を示しています ReturnLocation
エレメント:
要素 | 説明 |
---|---|
addressWithContact |
返品機能の連絡先情報。 Type: AddressWithContact |
supplySourceId |
Amazonが用意した供給元の英数字識別子。 SupplySourceId 世界的にユニークです。タイプ:文字列 |
連絡先付きの住所
次の表は、の子要素を示しています AddressWithContact
エレメント:
要素 | 説明 |
---|---|
address |
返却場所の住所。 Type: Address |
contactDetails |
返却場所の連絡先情報。 Type: ContactDetails |
配信チャネル
次の表は、の子要素を示しています DeliveryChannel
エレメント:
要素 | 説明 |
---|---|
isSupported |
TRUE の場合、売り手は供給元から配送を行うことができます。 タイプ:ブール値 |
operationalConfiguration |
運用構成の構造は、構成の親エンティティの下にリストされているものと同じです。このレベルの運用構成の値は、構成レベルで指定された値よりも優先されます。 Type: OperationalConfiguration |
ピックアップチャネル
次の表は、の子要素を示しています PickupChannel
エレメント:
要素 | 説明 |
---|---|
isSupported |
TRUE の場合、販売者は供給元からの店舗での受け取りをサポートできます。 タイプ:ブール値 |
inventoryHoldPeriod |
アイテムを受け取る準備が整った後、アイテムが供給元に保持される期間。 Type: Duration |
operationalConfiguration |
運用構成の構造は、構成の親エンティティの下にリストされているものと同じです。このレベルの運用構成の値は、構成レベルで指定された値よりも優先されます。 Type: OperationalConfiguration |
在庫保留期間
次の表は、の子要素を示しています InventoryHoldPeriod
エレメント:
要素 | 説明 |
---|---|
value |
アイテムを受け取る準備が整った後、アイテムが供給元に保持される期間。 Type: NonNegativeInteger |
timeUnit |
在庫保持時間の測定に使用される時間単位。許容値は以下のとおりです。 Minutes , Hours そして Days 。タイプ:文字列 |
チュートリアル:1つのSKUでエンドツーエンドの販売者をオンボーディングする練習
ステップ 1.供給元を作成する。
リクエスト例
POST: {{baseUrl}}/supplySources/2020-07-01/supplySources
{
"address": {
"name": "SS Store - Milpitas",
"addressLine1": "63 Ranch Dr",
"countryCode": "US",
"stateOrRegion": "CA",
"addressLine2": "",
"addressLine3": "",
"city": "Milpitas",
"county": "Santa Clara",
"district": "",
"postalCode": "95035",
"phone": "1234567890"
},
"supplySourceCode": "ss_ss005",
"alias": "SS Store - Milpitas"
}
レスポンス例
{
"supplySourceId": "353e4e48-6301-4d50-990e-43a86e8787a3",
"supplySourceCode": "ss_ss005"
}
ステップ 2.供給源を入手してください。
リクエスト例
GET: {{baseUrl}}/supplySources/2020-07-01/supplySources/353e4e48-6301-4d50-990e-43a86e8787a3
レスポンス例
{
"supplySourceId": "353e4e48-6301-4d50-990e-43a86e8787a3",
"supplySourceCode": "ss_ss005",
"alias": "SS Store - Milpitas"
"status": "Inactive"
"address": {
"name": "SS Store - Milpitas",
"addressLine1": "63 Ranch Dr",
"addressLine2": "",
"addressLine3": "",
"city": "Milpitas",
"county": "Santa Clara",
"district": "",
"stateOrRegion": "CA"
"postalCode": "95035",
"countryCode": "US",
},
"createdAt": "1.678741763E9",
"updatedAt": "1.678741763E9"
}
ステップ 3.構成ステータスを更新します。
リクエスト例
PUT: {{baseUrl}}/supplySources/2020-07-01/supplySources/353e4e48-6301-4d50-990e-43a86e8787a3
レスポンス例
{
"alias": "SS Store - Milpitas",
"configuration": {
"operationalConfiguration": {
"contactDetails": {
"countryCode": {
"primary": {
"email": "test324@gmail.com",
"phone": "4813924781"
}
},
"throughputConfig": {
"throughputCap": {
"value": 1,
"timeUnit": "Days"
},
"throughputUnit": "ORDERS"
},
"handlingTime": {
"value": 1,
"timeUnit": "Hours"
},
"operatingHoursByDay": {
"monday": {
"startTime": "00:59",
"endTime": "06:01"
},
"tuesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"wednesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"thursday": {
"startTime": "00:59",
"endTime": "06:01"
},
"friday": {
"startTime": "00:59",
"endTime": "06:01"
},
"saturday": {
"startTime": "00:00",
"endTime": "00:00"
},
"sunday": {
"startTime": "00:00",
"endTime": "00:00"
}
}
},
"timezone": "Africa/Accra"
},
"capabilities": {
"outbound": {
"isSupported": true,
"operationalConfiguration": {
"contactDetails": {
"email": "test324@gmail.com",
"phone": "4813924781"
}
},
"throughputConfig": {
"throughputCap": {
"value": 1,
"timeUnit": "Days"
},
"throughputUnit": "ORDERS"
},
"handlingTime": {
"value": 1,
"timeUnit": "Hours"
},
"operatingHoursByDay": {
"monday": {
"startTime": "00:59",
"endTime": "06:01"
},
"tuesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"wednesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"thursday": {
"startTime": "00:59",
"endTime": "06:01"
},
"friday": {
"startTime": "00:59",
"endTime": "06:01"
},
"saturday": {
"startTime": "00:00",
"endTime": "00:00"
},
"sunday": {
"startTime": "00:00",
"endTime": "00:00"
}
}
}
},
"createdAt": "1.678741763E9",
"updatedAt": "1.678741763E9"
}
}
ステップ 4.供給元ステータスを更新します。
リクエスト例
PUT: {{baseUrl}}/supplySources/2020-07-01/supplySources/353e4e48-6301-4d50-990e-43a86e8787a3/status
レスポンス
1
ステップ 5.供給元を取得
リクエスト例
GET: {{baseUrl}}/supplySources/2020-07-01/supplySources/353e4e48-6301-4d50-990e-43a86e8787a3
レスポンス例
{
"supplySourceId": "353e4e48-6301-4d50-990e-43a86e8787a3",
"supplySourceCode": "ss_ss005",
"alias": "SS Store - Milpitas",
"status": "Active",
"address": {
"name": "SS Store - Milpitas",
"addressLine1": "63 Ranch Dr",
"addressLine2": "",
"addressLine3": "",
"city": "Milpitas",
"county": "Santa Clara",
"district": "",
"stateOrRegion": "CA",
"postalCode": "95035",
"countryCode": "US"
},
"configuration": {
"operationalConfiguration": {
"contactDetails": {
"countryCode": {
"primary": {
"email": "test324@gmail.com",
"phone": "4813924781"
}
},
"throughputConfig": {
"throughputCap": {
"value": 1,
"timeUnit": "Days"
},
"throughputUnit": "ORDERS"
},
"handlingTime": {
"value": 1,
"timeUnit": "Hours"
},
"operatingHoursByDay": {
"monday": {
"startTime": "00:59",
"endTime": "06:01"
},
"tuesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"wednesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"thursday": {
"startTime": "00:59",
"endTime": "06:01"
},
"friday": {
"startTime": "00:59",
"endTime": "06:01"
},
"saturday": {
"startTime": "00:00",
"endTime": "00:00"
},
"sunday": {
"startTime": "00:00",
"endTime": "00:00"
}
}
},
"timezone": "Africa/Accra"
},
"capabilities": {
"outbound": {
"isSupported": true,
"operationalConfiguration": {
"contactDetails": {
"email": "test324@gmail.com",
"phone": "4813924781"
}
},
"throughputConfig": {
"throughputCap": {
"value": 1,
"timeUnit": "Days"
},
"throughputUnit": "ORDERS"
},
"handlingTime": {
"value": 1,
"timeUnit": "Hours"
},
"operatingHoursByDay": {
"monday": {
"startTime": "00:59",
"endTime": "06:01"
},
"tuesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"wednesday": {
"startTime": "00:59",
"endTime": "06:01"
},
"thursday": {
"startTime": "00:59",
"endTime": "06:01"
},
"friday": {
"startTime": "00:59",
"endTime": "06:01"
},
"saturday": {
"startTime": "00:00",
"endTime": "00:00"
},
"sunday": {
"startTime": "00:00",
"endTime": "00:00"
}
}
}
},
"createdAt": "1.678741763E9",
"updatedAt": "1.678741763E9"
}
}
チュートリアル:注文処理情報の取得
<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>
8日前に更新されました