INVENTORY
Use the Inventory API to retrieve the inventory levels of requested products, refresh and adjust current
stock levels at fulfillment locations, and tag segmented inventory for different channels. When using tags for inventory segmentation, inventory records are separated into categories to identify
which portions of its
total quantity are intended for different channels, customer groups, fulfillment methods, or other
needs.
This allows for setting a percentage of the quantity that would be available for each category and
setting discrete units at the location level as available for each category. For example, tags could
define how much of each
inventory record is set aside for a certain sales channel: the Kibo storefront, Walmart, or Amazon. The
percentages of the
inventory allotted for each channel would add up to 100% - the Kibo storefront could have 80% of the
inventory, Amazon 10%, and Walmart 10%. For more information, see the Inventory guides.
Use the Inventory, Inventory Allocation, and Modify Inventory resources to retrieve and update inventory levels.
Use the Inventory Job resource to retrieve information about your pending inventory update processing jobs.
Use the Inventory Tag and Tag Category resources to segment your inventory records.
title: Inventory
version: 0.0.1
servers:
- description: Kibo Base URL
url: '{baseUrl}/api'
variables:
baseUrl:
default: https://t1000000.sb.usc1.gcp.kibocommerce.com
description: Base URL
security:
- bearerAuth: []
paths:
/commerce/inventory/v5/inventory/adjust:
post:
tags:
- ModifyInventory
summary: Adjust
description: >-
Adjusts the inventory count for a product at a location. It is different
from Inventory Refresh because rather than stating the total quantity of
the product, this adjustment specifies the amount of change in the form
of increments and decrements (+/-). Increments do not require a + sign
and may be sent as a simple integer, but decrements must include the –
sign. For example, there would be a -2 quantity for an item if there
were two fewer than in the previous count, a 2 quantity if there were
two more, and a 0 quantity if there were no change.
These requests are placed into a queue of jobs that are processed one at
a time. Due to this, the best practice is to submit fewer requests with
more items per call, rather than numerous requests with a small number
of items each. However, unlike the Refresh API that accepts a maximum of
12000 items per call, this Adjust API only accepts up to 1000 items. If
you exceed that limit, a Bad Request error will be returned.
**Recommended:** Consider using the [Smart
Adjust](/api-reference/modifyinventory/smart-adjust-inventory) endpoint
instead, which automatically routes requests to sync or async processing
based on payload size.
parameters: []
requestBody:
$ref: '#/components/requestBodies/AdjustRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JobIDResponse'
description: Success
'400':
description: Bad Request
'403':
content:
application/json:
schema:
properties:
error:
type: string
message:
type: string
type: object
description: Forbidden
components:
requestBodies:
AdjustRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AdjustRequest'
description: Request to adjust inventory
required: true
schemas:
JobIDResponse:
description: Job ID Response
properties:
jobID:
description: Job ID
type: integer
title: Job ID Response
type: object
AdjustRequest:
description: Request needed for adjusting inventory
properties:
items:
description: List of items to adjust
items:
$ref: '#/components/schemas/AdjustItem'
maxItems: 1000
minItems: 1
nullable: false
type: array
locationCode:
description: Location Code
minLength: 1
nullable: false
title: location code
type: string
pageNum:
description: which page to show
type: integer
pageSize:
description: how many results to show per page
type: integer
sortBy:
description: index to sort results by
type: string
userID:
description: user id
type: integer
required:
- items
- locationCode
title: Adjust Request
type: object
AdjustItem:
description: Adjust Item
properties:
binID:
description: Bin Location Identifier
type: integer
condition:
description: Describes the state of the product
maxLength: 50
minLength: 0
type: string
date:
description: >-
Used by the retailer for storing information related to
manufacturing date or expiry date and use date to allocate for
better stock management
format: date-time
type: string
deliveryDate:
description: >-
Date at which this inventory will become available. Expected format
'2020-09-28T12:00:00-0500'
format: date-time
type: string
externalID:
description: >-
External Identifier for the given future inventory record. Will not
create a new future inventory record unless deliveryDate is
specified
type: string
granularInventoryTrackingEnabled:
readOnly: true
type: boolean
lotCode:
description: Track which lot a product is manufactured in
maxLength: 50
minLength: 0
type: string
partNumber:
description: Part/Product Number
type: string
quantity:
description: Current Quantity of Item
nullable: false
type: integer
serialNumber:
description: A serial number is unique to a specific, physical unit of inventory
maxLength: 50
minLength: 0
type: string
sku:
description: Stock Keeping Unit
type: string
tags:
$ref: '#/components/schemas/tags'
upc:
description: Universal Product Code
type: string
required:
- quantity
title: Adjust Item
type: object
tags:
additionalProperties:
type: string
description: Associative Map of