Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVDOCS-6209: [update] add platform limits #804

Merged
merged 8 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions reference/inventory.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,12 @@ paths:
tags:
- Adjustments
description: |
Override the existing inventory levels for an inventory item at a location. For maximum inventory levels, see [Inventory adjustments](/docs/store-operations/catalog/inventory-adjustments#inventory-adjustments). For payload limits, see [Optimizing performance](/docs/store-operations/catalog/inventory-adjustments#optimizing-performance).
Override the existing inventory levels for an inventory item at a location. Use absolute adjustments as the default method for updating inventory. This endpoint batches requests, making them more resource friendly than the [Catalog API](/docs/rest-catalog/products#update-products-batch). Absolute adjustments have lower complexity than [relative adjustments](/docs/rest-management/inventory/adjustments#relative-adjustment), which synchronize with orders.

Use absolute adjustments as the default method for updating inventory. This endpoint batches requests, making them more resource friendly than the [Catalog API](/docs/rest-catalog/products#update-products-batch). Absolute adjustments have lower complexity than [relative adjustments](/docs/rest-management/inventory/adjustments#relative-adjustment), which synchronize with orders.
**Limits**
* For maximum inventory levels, see [Inventory adjustments](/docs/store-operations/catalog/inventory-adjustments#inventory-adjustments).
* Limit of 2000 items for payload length, see [Optimizing performance](/docs/store-operations/catalog/inventory-adjustments#optimizing-performance) for more information.

parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
Expand Down Expand Up @@ -110,9 +113,11 @@ paths:
tags:
- Adjustments
description: |
Add or subtract inventory for an inventory item at a location. For maximum inventory levels, see [Inventory adjustments](/docs/store-operations/catalog/inventory-adjustments#inventory-adjustments). For payload limits, see [Optimizing performance](/docs/store-operations/catalog/inventory-adjustments#optimizing-performance).
Add or subtract inventory for an inventory item at a location. Use this endpoint only when you do not know absolute quantities. For example, making order-related inventory changes through a third-party may require relative adjustments. Otherwise, use the [Absolute adjustment](/docs/rest-management/inventory/adjustments#absolute-adjustment) endpoint for updating inventory.

Use this endpoint only when you do not know absolute quantities. For example, making order-related inventory changes through a third-party may require relative adjustments. Otherwise, use the [Absolute adjustment](/docs/rest-management/inventory/adjustments#absolute-adjustment) endpoint for updating inventory.
**Limits**
* For maximum inventory levels, see [Inventory adjustments](/docs/store-operations/catalog/inventory-adjustments#inventory-adjustments).
* Limit of 2000 items for payload length, see [Optimizing performance](/docs/store-operations/catalog/inventory-adjustments#optimizing-performance) for more information.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -177,6 +182,9 @@ paths:
- Items
description: |
Return a list of inventory and inventory settings for all items in all locations.

**Limits**
* Limit of 1000 items for payload length.
parameters:
- $ref: '#/components/parameters/SkuFilterParam'
- $ref: '#/components/parameters/VariantIdFilterParam'
Expand Down Expand Up @@ -207,7 +215,12 @@ paths:
operationId: get-location-inventory-items
tags:
- Items
description: Return a list of inventory and inventory settings for all items in a location.
description: |
Return a list of inventory and inventory settings for all items in a location.

**Limits**
* Limit of 1000 items for payload length.

parameters:
- $ref: '#/components/parameters/LocationIdParam'
- $ref: '#/components/parameters/VariantIdFilterParam'
Expand Down Expand Up @@ -240,7 +253,12 @@ paths:
operationId: put-location-inventory-items
tags:
- Items
description: Update inventory settings for items at a location.
description: |

Update inventory settings for items at a location.

**Limits**
* Limit of 2000 items for payload length.
parameters:
- $ref: '#/components/parameters/LocationIdParam'
requestBody:
Expand Down
22 changes: 19 additions & 3 deletions reference/locations.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@ paths:
operationId: createLocations
tags:
- Locations
description: Create new locations.
description: |
Create new locations.

**Limits**
* Limit of 50 concurrent requests.
* Limit of 100 active locations.
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
Expand Down Expand Up @@ -73,7 +78,12 @@ paths:
operationId: getLocations
tags:
- Locations
description: List locations. You can use optional filter parameters.
description: |
List locations. You can use optional filter parameters.

**Limits**
* Limit of 50 concurrent requests.
* Limit of 1000 items for payload length.
parameters:
- $ref: '#/components/parameters/LocationIdsParam'
- $ref: '#/components/parameters/LocationCodeFilterParam'
Expand Down Expand Up @@ -103,7 +113,13 @@ paths:
operationId: updateLocations
tags:
- Locations
description: Update existing locations.
description: |

Update existing locations.

**Limits**
* Limit of 50 concurrent requests.
* Limit of 100 active locations.
requestBody:
content:
application/json:
Expand Down