Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@jevoniuk
jevoniuk committed Nov 6, 2024
1 parent 5d48eff commit d899053
Show file tree
Hide file tree
Showing 11 changed files with 1,142 additions and 941 deletions.
28 changes: 14 additions & 14 deletions models/vendor-direct-fulfillment-inventory-api-model/vendorDirectFulfillmentInventoryV1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"tags": [
"updateInventory"
],
"description": "Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the 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, refer to [Usage Plans and Rate Limits in the *SP-API*](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description": "Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "submitInventoryUpdate",
"parameters": [
{
Expand All @@ -39,7 +39,7 @@
"schema": {
"$ref": "#/definitions/SubmitInventoryUpdateRequest"
},
"description": "The request body that contains the inventory update data to submit."
"description": "The request body containing the inventory update data to submit."
},
{
"name": "warehouseId",
Expand Down Expand Up @@ -272,10 +272,10 @@
"$ref": "#/definitions/InventoryUpdate"
}
},
"description": "The request body for the `submitInventoryUpdate` operation."
"description": "The request body for the submitInventoryUpdate operation."
},
"InventoryUpdate": {
"description": "Inventory details required to update some or all items for the requested warehouse.",
"description": "Inventory details required to update some or all items for the requested warehouse.",
"type": "object",
"required": [
"isFullUpdate",
Expand All @@ -284,12 +284,12 @@
],
"properties": {
"sellingParty": {
"description": "The ID for the selling party or vendor.",
"description": "ID of the selling party or vendor.",
"$ref": "#/definitions/PartyIdentification"
},
"isFullUpdate": {
"type": "boolean",
"description": "When `true`, this request contains a full feed. When `false`, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an inventory update. The status of other items will remain unchanged."
"description": "When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged."
},
"items": {
"type": "array",
Expand All @@ -308,25 +308,25 @@
"properties": {
"buyerProductIdentifier": {
"type": "string",
"description": "The buyer-selected product identification for the item. Either `buyerProductIdentifier` or `vendorProductIdentifier` must be submitted."
"description": "The buyer selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted."
},
"vendorProductIdentifier": {
"type": "string",
"description": "The vendor selected product identification for the item. Either `buyerProductIdentifier` or `vendorProductIdentifier` must be submitted."
"description": "The vendor selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted."
},
"availableQuantity": {
"description": "Total item quantity available in the warehouse.",
"$ref": "#/definitions/ItemQuantity"
},
"isObsolete": {
"type": "boolean",
"description": "When `true`, the item is permanently unavailable."
"description": "When true, the item is permanently unavailable."
}
},
"description": "Updated inventory details for an item."
},
"PartyIdentification": {
"description": "Name, address and tax details for a group.",
"description": "Name, address and tax details of a party.",
"type": "object",
"required": [
"partyId"
Expand All @@ -353,20 +353,20 @@
"description": "Unit of measure for the available quantity."
}
},
"description": "Details about item quantity."
"description": "Details of item quantity."
},
"SubmitInventoryUpdateResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The response payload for the `submitInventoryUpdate` operation.",
"description": "The response payload for the submitInventoryUpdate operation.",
"$ref": "#/definitions/TransactionReference"
},
"errors": {
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the `submitInventoryUpdate` operation."
"description": "The response schema for the submitInventoryUpdate operation."
},
"TransactionReference": {
"type": "object",
Expand All @@ -376,7 +376,7 @@
"description": "GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
},
"description": "A response that contains the transaction ID."
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "array",
Expand Down
34 changes: 17 additions & 17 deletions models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1589,7 +1589,7 @@
"schema": {
"$ref": "#/definitions/SubmitAcknowledgementRequest"
},
"description": "The request body that contains the order acknowledgement."
"description": "The request body containing the acknowledgement to an order."
}
],
"responses": {
Expand Down Expand Up @@ -1837,17 +1837,17 @@
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination",
"description": "The pagination elements required to retrieve the remaining data."
"description": "The pagination elements required to retrieve the remaining data."
},
"orders": {
"type": "array",
"items": {
"$ref": "#/definitions/Order"
},
"description": "Represents a purchase order within the `OrderList`."
"description": "Represents a purchase order within the OrderList."
}
},
"description": "A purchase orders list returned as a response."
"description": "A list of purchase orders returned as response."
},
"Pagination": {
"type": "object",
Expand All @@ -1857,10 +1857,10 @@
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return."
}
},
"description": "The pagination elements required to retrieve the remaining data."
"description": "The pagination elements required to retrieve the remaining data."
},
"Order": {
"description": "Represents a purchase order.",
"description": "Represents a purchase order.",
"type": "object",
"required": [
"purchaseOrderNumber"
Expand Down Expand Up @@ -1931,7 +1931,7 @@
},
"taxTotal": {
"type": "object",
"description": "The total tax object within the shipment that relates to the order.",
"description": "The total Tax object within shipment that relates to the order.",
"properties": {
"taxLineItem": {
"description": "Tax details.",
Expand Down Expand Up @@ -1966,7 +1966,7 @@
"description": "Details of an order."
},
"PartyIdentification": {
"description": "Name, address, and tax details of a party.",
"description": "Name, address and tax details of a party.",
"type": "object",
"required": [
"partyId"
Expand Down Expand Up @@ -2036,7 +2036,7 @@
"properties": {
"name": {
"type": "string",
"description": "The name of the person, business, or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"attention": {
"type": "string",
Expand All @@ -2056,15 +2056,15 @@
},
"city": {
"type": "string",
"description": "The city where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"county": {
"type": "string",
"description": "The county where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"district": {
"type": "string",
"description": "The district where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
},
"stateOrRegion": {
"type": "string",
Expand All @@ -2080,7 +2080,7 @@
},
"phone": {
"type": "string",
"description": "The phone number of the person, business, or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
"description": "The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`."
}
},
"description": "Address of the party."
Expand Down Expand Up @@ -2140,7 +2140,7 @@
"$ref": "#/definitions/Money"
}
},
"description": "An order item."
"description": "An item within an order"
},
"Money": {
"type": "object",
Expand Down Expand Up @@ -2180,7 +2180,7 @@
"description": "GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
}
},
"description": "Response that contains the transaction ID."
"description": "Response containing the transaction ID."
},
"ErrorList": {
"type": "array",
Expand Down Expand Up @@ -2273,7 +2273,7 @@
"$ref": "#/definitions/ItemQuantity"
}
},
"description": "Individual item details within the acknowledged order."
"description": "Details of an individual item within the order being acknowledged."
},
"ItemQuantity": {
"type": "object",
Expand Down Expand Up @@ -2364,7 +2364,7 @@
]
}
},
"description": "The order's tax details."
"description": "The tax details related to the order."
},
"AcknowledgementStatus": {
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion .../vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrders_2021-12-28.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@
"type": "array",
"items": {
"$ref": "#/definitions/Error"
},
},
"description": "An array of Error objects representing individual errors encountered during the request."
}
}
Expand Down
Loading

0 comments on commit d899053

Please sign in to comment.