Update FBA Inventory and Fulfillment Outbound models

This commit is contained in:
lisa-delaney 2024-06-19 14:59:00 -07:00
parent ebf79082d7
commit c744c40b10
4 changed files with 996 additions and 423 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

BIN
models/.DS_Store vendored Normal file

Binary file not shown.

View File

@ -25,11 +25,14 @@
],
"paths": {
"/fba/inventory/v1/summaries": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"get": {
"tags": [
"fbaInventory"
],
"description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters:\n\n- All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted.\n- When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified.\n- When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored.\n- When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.\n\nUsage Plan:\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.",
"operationId": "getInventorySummaries",
"produces": [
"application/json"
@ -124,160 +127,8 @@
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"details": {
"value": true
},
"granularityType": {
"value": "Marketplace"
},
"granularityId": {
"value": "ATVPDKIKX0DER"
},
"marketplaceIds": {
"value": [
"ATVPDKIKX0DER"
]
}
}
},
"response": {
"pagination": {
"nextToken": "seed"
},
"payload": {
"granularity": {
"granularityType": "Marketplace",
"granularityId": "ATVPDKIKX0DER"
},
"inventorySummaries": [
{
"asin": "B0020MLK00",
"fnSku": "B0020MLK00",
"sellerSku": "EMTEC 1 GB",
"condition": "NewItem",
"inventoryDetails": {
"fulfillableQuantity": 0,
"inboundWorkingQuantity": 0,
"inboundShippedQuantity": 0,
"inboundReceivingQuantity": 0,
"reservedQuantity": {
"totalReservedQuantity": 0,
"pendingCustomerOrderQuantity": 0,
"pendingTransshipmentQuantity": 0,
"fcProcessingQuantity": 0
},
"researchingQuantity": {
"totalResearchingQuantity": 0,
"researchingQuantityBreakdown": []
},
"unfulfillableQuantity": {
"totalUnfulfillableQuantity": 0,
"customerDamagedQuantity": 0,
"warehouseDamagedQuantity": 0,
"distributorDamagedQuantity": 0,
"carrierDamagedQuantity": 0,
"defectiveQuantity": 0,
"expiredQuantity": 0
}
},
"lastUpdatedTime": "",
"productName": "EMTEC 1 GB 60x SD Flash Memory Card with USB 2.0 Card Reader",
"totalQuantity": 0
},
{
"asin": "B0020MLK00",
"fnSku": "B0020MLK00",
"sellerSku": "EMTEC-SdCard-reader",
"condition": "NewItem",
"inventoryDetails": {
"fulfillableQuantity": 0,
"inboundWorkingQuantity": 0,
"inboundShippedQuantity": 0,
"inboundReceivingQuantity": 0,
"reservedQuantity": {
"totalReservedQuantity": 0,
"pendingCustomerOrderQuantity": 0,
"pendingTransshipmentQuantity": 0,
"fcProcessingQuantity": 0
},
"researchingQuantity": {
"totalResearchingQuantity": 0,
"researchingQuantityBreakdown": []
},
"unfulfillableQuantity": {
"totalUnfulfillableQuantity": 0,
"customerDamagedQuantity": 0,
"warehouseDamagedQuantity": 0,
"distributorDamagedQuantity": 0,
"carrierDamagedQuantity": 0,
"defectiveQuantity": 0,
"expiredQuantity": 0
}
},
"lastUpdatedTime": "",
"productName": "EMTEC 1 GB 60x SD Flash Memory Card with USB 2.0 Card Reader",
"totalQuantity": 0
},
{
"asin": "B00T9QONN6",
"fnSku": "B00T9QONN6",
"sellerSku": "Silicon Power 32GB",
"condition": "NewItem",
"inventoryDetails": {
"fulfillableQuantity": 66,
"inboundWorkingQuantity": 21,
"inboundShippedQuantity": 0,
"inboundReceivingQuantity": 0,
"reservedQuantity": {
"totalReservedQuantity": 0,
"pendingCustomerOrderQuantity": 0,
"pendingTransshipmentQuantity": 0,
"fcProcessingQuantity": 0
},
"researchingQuantity": {
"totalResearchingQuantity": 0,
"researchingQuantityBreakdown": [
{
"name": "researchingQuantityInShortTerm",
"quantity": 0
},
{
"name": "researchingQuantityInMidTerm",
"quantity": 0
},
{
"name": "researchingQuantityInLongTerm",
"quantity": 0
}
]
},
"unfulfillableQuantity": {
"totalUnfulfillableQuantity": 0,
"customerDamagedQuantity": 0,
"warehouseDamagedQuantity": 0,
"distributorDamagedQuantity": 0,
"carrierDamagedQuantity": 0,
"defectiveQuantity": 0,
"expiredQuantity": 0
}
},
"lastUpdatedTime": "2018-03-31T23:40:39Z",
"productName": "Silicon Power 32GB up to 85MB/s MicroSDHC UHS-1 Class10, Elite Flash Memory Card with Adaptor (SP032GBSTHBU1V20SP)",
"totalQuantity": 87
}
]
}
}
}
]
}
},
"400": {
@ -292,7 +143,7 @@
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
}
},
@ -304,7 +155,7 @@
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
}
},
@ -320,7 +171,7 @@
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
}
},
@ -330,13 +181,9 @@
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
}
},
@ -346,37 +193,10 @@
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"marketplaceIds": {
"value": [
"1"
]
}
}
},
"response": {
"errors": [
{
"message": "We encountered an internal error. Please try again.",
"code": "InternalFailure"
}
]
}
}
]
}
},
"503": {
@ -385,13 +205,360 @@
"$ref": "#/definitions/GetInventorySummariesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference ID."
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inventory/v1/items": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true,
"post": {
"tags": [
"fbaInventory"
],
"description": "Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "createInventoryItem",
"produces": [
"application/json"
],
"parameters": [
{
"name": "createInventoryItemRequestBody",
"in": "body",
"description": "CreateInventoryItem Request Body Parameter.",
"required": true,
"schema": {
"$ref": "#/definitions/CreateInventoryItemRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CreateInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inventory/v1/items/{sellerSku}": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true,
"delete": {
"tags": [
"fbaInventory"
],
"description": "Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "deleteInventoryItem",
"produces": [
"application/json"
],
"parameters": [
{
"name": "sellerSku",
"in": "path",
"description": "A single seller SKU used for querying the specified seller SKU inventory summaries.",
"required": true,
"type": "string"
},
{
"name": "marketplaceId",
"in": "query",
"description": "The marketplace ID for the marketplace for which the sellerSku is to be deleted.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/DeleteInventoryItemResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/fba/inventory/v1/items/inventory": {
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true,
"post": {
"tags": [
"fbaInventory"
],
"description": "Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.",
"operationId": "addInventory",
"produces": [
"application/json"
],
"parameters": [
{
"name": "x-amzn-idempotency-token",
"in": "header",
"description": "A unique token/requestId provided with each call to ensure idempotency.",
"required": true,
"type": "string"
},
{
"name": "addInventoryRequestBody",
"in": "body",
"description": "List of items to add to Sandbox inventory.",
"required": true,
"schema": {
"$ref": "#/definitions/AddInventoryRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource does not exist.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/AddInventoryResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
@ -400,6 +567,90 @@
}
},
"definitions": {
"CreateInventoryItemRequest": {
"description": "An item to be created in the inventory.",
"type": "object",
"properties": {
"sellerSku" : {
"description": "The seller SKU of the item.",
"type": "string"
},
"marketplaceId" : {
"description": "The marketplaceId.",
"type": "string"
},
"productName": {
"description": "The name of the item.",
"type": "string"
}
},
"required": ["sellerSku", "marketplaceId", "productName"]
},
"AddInventoryRequest": {
"description": "The object with the list of Inventory to be added",
"type": "object",
"properties": {
"inventoryItems": {
"$ref": "#/definitions/InventoryItems"
}
}
},
"InventoryItems": {
"description": "List of Inventory to be added",
"type": "array",
"items": {
"$ref": "#/definitions/InventoryItem"
}
},
"InventoryItem": {
"description": "An item in the list of inventory to be added.",
"type": "object",
"properties": {
"sellerSku" : {
"description": "The seller SKU of the item.",
"type": "string"
},
"marketplaceId" : {
"description": "The marketplaceId.",
"type": "string"
},
"quantity": {
"description": "The quantity of item to add.",
"type": "integer"
}
},
"required": ["sellerSku", "marketplaceId", "quantity"]
},
"CreateInventoryItemResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the CreateInventoryItem operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the CreateInventoryItem operation."
},
"DeleteInventoryItemResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the DeleteInventoryItem operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the DeleteInventoryItem operation."
},
"AddInventoryResponse": {
"type": "object",
"properties": {
"errors": {
"description": "One or more unexpected errors occurred during the AddInventory operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the AddInventory operation."
},
"Granularity": {
"type": "object",
"properties": {
@ -678,4 +929,4 @@
}
}
}
}
}