POST
/
inventories
/
actions
/
find-and-adjust-inventory-counters

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string
required

A single sales channel ID.

x-fabric-request-id
string

Unique request ID

Body

application/json

Sample request to adjust counter

counters
object
required

Inventory counter (also known as inventory position) configured by the merchant

inventoryId
string

The fabric system-generated inventory ID. This ID is generated during inventory creation.

isNoStock
boolean

An attribute used to indicate that a SKU is out of stock.

itemId
integer

Merchant-defined item ID whose inventory is updated. If omitted, fabric Inventory service generates the itemId. If you choose to use the itemId in your environment, you must include it in all inventory Write requests.

locationNumber
integer
required

Represents the warehouse or store location where the inventory is stored. The locationNumber is crucial for inventory management. When creating or updating inventory, you need to include the locationNumber to specify which location the inventory belongs to.

sku
string
required

Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.

status
enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:
IN_STOCK,
LOW_STOCK,
OUT_OF_STOCK,
BACKORDER_STOCK,
PREORDER_STOCK
virtualCountersStatus
object

Virtual counters are calculated at run time from counters

Response

200 - application/json

Inventory response sample

backorderLimit
integer

Maximum restock inventory quantity

backorderShipmentAt
string

Time when backorder is shipped

channelId
string

Sales channel ID; identifies business operations location.

counters
object

Merchant-defined inventory counter (also known as inventory position)

createdAt
string

Time of inventory creation

customAttributes
object

Placeholder for additional info

hasInfiniteInventory
boolean
default: false

Infinite inventory flag. true: Inventory can be used any number of times and does not have any consumption limit. false: Inventory cannot be used infinitely, and has a consumption limit.

inventoryId
string

The fabric system-generated inventory ID. This ID is generated during inventory creation.

isNoStock
boolean

An attribute used to indicate that a SKU is out of stock.

itemId
integer

Merchant-defined item ID whose inventory is created or updated. If omitted, fabric Inventory service generates the itemId. If you choose to use the itemId in your environment, you must include it in all inventory Write requests.

leadTime
string

The time between when an order is placed to replenish inventory and when the order is received at warehouse.

locationNumber
integer

Represents the warehouse or store location where the inventory is stored. The locationNumber is crucial for inventory management. When creating or updating inventory, you need to include the locationNumber to specify which location the inventory belongs to.

lowStock
integer

The lowStock parameter is used to alert low stock at a location when inventory is below a set number.

networkCode
string

Code of the network to which the inventory belongs

networkCounters
object

Indicates inventory positions at network

preorderLimit
integer

Maximum first-shipping inventory quantity

preorderShipmentAt
string

Time when preorder is shipped

region
string

Region where inventory is managed

safetyStock
integer

Reserved inventory quantity at the location

sku
string

Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.

status
enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:
IN_STOCK,
LOW_STOCK,
OUT_OF_STOCK,
BACKORDER_STOCK,
PREORDER_STOCK
type
string

Inventory type - a classifier attribute that provides flexibility to define inventory types

updatedAt
string

Time when inventory was last updated

vendorId
string

ID of the vendor who will replenish the inventory for the retailer

virtualCounters
object

Virtual counters are calculated at run time from counters

virtualCountersStatus
object

Virtual counters are calculated at run time from counters