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/v1/bin/searchInventory:
post:
tags:
- InventoryBin
summary: Search Bins
description: Search bins for a inventory by bin name or any product identifier
parameters: []
requestBody:
$ref: '#/components/requestBodies/BinSearchRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BinSearchResponse'
description: Success
'400':
description: Bad Request
components:
requestBodies:
BinSearchRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/BinSearchRequest'
description: Request to allocate inventory
required: true
schemas:
BinSearchResponse:
description: Bin Search Response Object
properties:
binQuantities:
description: >-
List of BinProductQuantities - bins with associated products and
quantities
items:
$ref: '#/components/schemas/BinProductResponseQuantities'
type: array
messages:
description: List of messages
items:
type: string
type: array
numResults:
description: Number of results
type: integer
success:
description: Flag for success
type: boolean
title: Bin Search Response
type: object
BinSearchRequest:
description: Request needed for searching for bins
properties:
binName:
description: Partial match of bin name
type: string
locationCode:
description: Location Code
title: location code
type: string
pageNum:
description: which page to show
type: integer
pageSize:
description: how many results to show per page
type: integer
product:
$ref: '#/components/schemas/InventoryProduct'
showNegativeInventory:
description: Flag for showing negative inventory
type: boolean
sortAscending:
description: Flag for sorting ascending
type: boolean
sortBy:
description: index to sort results by
type: string
tags:
$ref: '#/components/schemas/tags'
userID:
description: user id
type: integer
title: Bin Search Request
type: object
BinProductResponseQuantities:
description: A response object for a bin and its associated products and quantities
properties:
binName:
description: Name of the bin
type: string
products:
description: List of ProductQuantities - Products with their associated quantity
items:
$ref: '#/components/schemas/ProductQuantityResponse'
type: array
title: Bin Product Response Quantities
type: object
InventoryProduct:
description: Product within a bin
properties:
partNumber:
description: Part Number
type: string
sku:
description: SKU
type: string
upc:
description: UPC
type: string
title: Product
type: object
tags:
additionalProperties:
type: string
description: Associative Map of