Skip to content

Commit

Permalink
DEVDOCS-6209: [update] add platform limits (#804)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [DEVDOCS-6209]


## What changed?

add platform limits
<!-- Provide a bulleted list in the present tense -->
* 

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-6209]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6209?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter authored Feb 10, 2025
1 parent 6303d48 commit 6b44838
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 9 deletions.
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

0 comments on commit 6b44838

Please sign in to comment.