Create inventory

Create inventory based on the combination of location number, channel ID, and item ID or SKU.

Authorizations

Authorization

string

header

required

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

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Body

application/json

Create inventory request sample. Either sku or itemId is mandatory.

counters

object

required

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

Show child attributes

counters.{key}

object

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

Example:

{
  "allocated": 10,
  "onHand": 100,
  "shipped": 20
}

Example:

{
  "allocated": 10,
  "onHand": 100,
  "shipped": 20
}

locationNumber

integer

required

Represents the warehouse or store location where the inventory is stored. It is recommended to link locationNumber to the corresponding value in the fabric Locations service.

Example:

12345

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.

Example:

"SKU1"

backorderLimit

integer

Maximum restock inventory quantity

Example:

50

backorderShipmentAt

string

Time when backorder is shipped

Example:

"2022-08-01T20:03:28.483Z"

customAttributes

object

Custom attributes to store additional information

Show child attributes

customAttributes.{key}

string

Custom attributes to store additional information

Example:

"{\"isBopis\":true}"

Example:

{ "isBopis": true }

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 can't be used infinitely, and has a consumption limit.

Example:

false

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.

Example:

12345

leadTime

string

Time between when an order is placed to replenish inventory and when the order is received at warehouse

Example:

"5 days"

lowStock

integer

Inventory quantity below which consumer service wants to be alerted as low stock at the location

Example:

10

networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

preorderLimit

integer

Maximum first-shipping inventory quantity

Example:

40

preorderShipmentAt

string

Time when preorder is shipped

Example:

"2022-08-01T20:03:28.483Z"

region

string

Region where inventory is managed

Example:

"North America"

safetyStock

integer

Reserved inventory quantity at the location

Example:

10

status

enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:

IN_STOCK,

LOW_STOCK,

OUT_OF_STOCK,

BACKORDER_STOCK,

PREORDER_STOCK

Example:

" IN_STOCK"

type

string

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

Example:

"primary"

vendorId

string

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

Example:

"vendor1"

virtualCountersStatus

object

Virtual counters are calculated at run time from counters

Show child attributes

virtualCountersStatus.availableBackorder

string

virtualCountersStatus.availablePreorder

string

virtualCountersStatus.availableToPurchase

string

Response

201

application/json

Created

Inventory response sample

backorderLimit

integer

Maximum restock inventory quantity

Example:

50

backorderShipmentAt

string

Time when backorder is shipped

Example:

"2022-08-01T20:03:28.483Z"

channelId

string

Sales channel ID; identifies business operations location.

Example:

"channel_xyz"

counters

object

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

Show child attributes

counters.{key}

integer

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

Example:

{
  "allocated": 10,
  "onHand": 100,
  "shipped": 20
}

createdAt

string

Time of inventory creation

Example:

"2022-08-01T18:03:28.483Z"

customAttributes

object

Placeholder for additional info

Show child attributes

customAttributes.{key}

string

Placeholder for additional info

Example:

"{\"isBopis\":true}"

Example:

{ "isBopis": true }

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 can't be used infinitely, and has a consumption limit.

Example:

false

inventoryId

string

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

Example:

"723910d81723"

isNoStock

boolean

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

Example:

false

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.

Example:

12345

leadTime

string

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

Example:

"5 days"

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.

Example:

12345

lowStock

integer

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

Example:

10

networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

networkCounters

object

Indicates inventory positions at network

Show child attributes

networkCounters.{key}

integer

Indicates inventory positions at network

Example:

{ "softReserve": 10 }

preorderLimit

integer

Maximum first-shipping inventory quantity

Example:

40

preorderShipmentAt

string

Time when preorder is shipped

Example:

"2022-08-01T20:03:28.483Z"

region

string

Region where inventory is managed

Example:

"North America"

safetyStock

integer

Reserved inventory quantity at the location

Example:

10

sku

string

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

Example:

"SKU1"

status

enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:

IN_STOCK,

LOW_STOCK,

OUT_OF_STOCK,

BACKORDER_STOCK,

PREORDER_STOCK

Example:

" IN_STOCK"

type

string

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

Example:

"primary"

updatedAt

string

Time when inventory was last updated

Example:

"2022-08-01T20:03:28.483Z"

vendorId

string

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

Example:

"vendor1"

virtualCounters

object

Virtual counters are calculated at run time from counters

Show child attributes

virtualCounters.availableBackorder

string

virtualCounters.availablePreorder

string

virtualCounters.availableToPurchase

string

virtualCountersStatus

object

Virtual counters are calculated at run time from counters

Show child attributes

virtualCountersStatus.availableBackorder

string

virtualCountersStatus.availablePreorder

string

virtualCountersStatus.availableToPurchase

string