Find inventory of specific items in a specific region

curl --request POST \
  --url https://api.fabric.inc/v3/inventories/actions/find-by-geography \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "skus": [
    "sku1"
  ],
  "locationTypes": [
    "DC"
  ],
  "origin": {
    "postalCode": "94008",
    "longitude": -108.7256871,
    "latitude": 21.2629852,
    "city": "San Francisco",
    "region": "New York",
    "countryCode": "US",
    "minDistance": 10,
    "maxDistance": 100,
    "distanceUnit": "MILE"
  }
}'

{
  "locations": [
    {
      "distance": 12.34,
      "locationType": "DC",
      "locationNumber": 12345
    }
  ],
  "inventories": [
    {
      "inventoryId": "723910d81723",
      "sku": "SKU1",
      "itemId": 12345,
      "locationNumber": 12345,
      "region": "North America",
      "channelId": "channel_xyz",
      "vendorId": "vendor1",
      "createdAt": "2022-08-01T18:03:28.483Z",
      "updatedAt": "2022-08-01T20:03:28.483Z",
      "leadTime": "5 days",
      "type": "primary",
      "hasInfiniteInventory": true,
      "backorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "preorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "backorderLimit": 50,
      "preorderLimit": 40,
      "safetyStock": 10,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "counters": {
        "onHand": 100,
        "allocated": 10,
        "shipped": 20
      },
      "customAttributes": {
        "isBopis": true
      },
      "networkCounters": {
        "softReserve": 10
      },
      "virtualCounters": {
        "availableToPurchase": 60
      }
    }
  ]
}

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-request-id

string

Unique request ID

x-fabric-channel-id

string

Sales channel ID

x-fabric-channel-ids

string

Sales channel IDs.<br />Note: Use xFabricChannelIds for multiple channels, and xFabricChannelId for single channel

Body

application/json

skus

string[]

List of SKUs for which the inventories are to be searched within the specified region

locationTypes

string[]

List of location types

origin

object

required

Geo search origin. Must include postalCode OR (city and region).

Response

200 - application/json

locations

object[]

List Locations sorted by nearest first where Inventory present in queried region.

inventories

object[]

Inventories present in queried region.

inventories.inventoryId

string

System-generated inventory ID. This ID is generated during inventory creation.

inventories.sku

string

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

inventories.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.

inventories.locationNumber

integer

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.

inventories.region

string

Region where inventory is managed

inventories.channelId

string

Sales channel ID; identifies business operations location.

inventories.vendorId

string

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

inventories.createdAt

string

Time of inventory creation

inventories.updatedAt

string

Time when inventory was last updated

inventories.leadTime

string

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

inventories.type

string

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

inventories.hasInfiniteInventory

boolean

default: false

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

inventories.backorderShipmentAt

string

Time when backorder is shipped

inventories.preorderShipmentAt

string

Time when preorder is shipped

inventories.backorderLimit

integer

Maximum restock inventory quantity

inventories.preorderLimit

integer

Maximum first-shipping inventory quantity

inventories.safetyStock

integer

Reserved inventory quantity at the location

inventories.lowStock

integer

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

inventories.networkCode

string

Code of the network to which the inventory belongs

inventories.counters

object

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

inventories.customAttributes

object

Placeholder for additional info

inventories.networkCounters

object

Indicates inventory positions at network

inventories.virtualCounters

object

Virtual counters are calculated at run time from counters

Was this page helpful?

Create inventory Overview

curl --request POST \
  --url https://api.fabric.inc/v3/inventories/actions/find-by-geography \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "skus": [
    "sku1"
  ],
  "locationTypes": [
    "DC"
  ],
  "origin": {
    "postalCode": "94008",
    "longitude": -108.7256871,
    "latitude": 21.2629852,
    "city": "San Francisco",
    "region": "New York",
    "countryCode": "US",
    "minDistance": 10,
    "maxDistance": 100,
    "distanceUnit": "MILE"
  }
}'

{
  "locations": [
    {
      "distance": 12.34,
      "locationType": "DC",
      "locationNumber": 12345
    }
  ],
  "inventories": [
    {
      "inventoryId": "723910d81723",
      "sku": "SKU1",
      "itemId": 12345,
      "locationNumber": 12345,
      "region": "North America",
      "channelId": "channel_xyz",
      "vendorId": "vendor1",
      "createdAt": "2022-08-01T18:03:28.483Z",
      "updatedAt": "2022-08-01T20:03:28.483Z",
      "leadTime": "5 days",
      "type": "primary",
      "hasInfiniteInventory": true,
      "backorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "preorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "backorderLimit": 50,
      "preorderLimit": 40,
      "safetyStock": 10,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "counters": {
        "onHand": 100,
        "allocated": 10,
        "shipped": 20
      },
      "customAttributes": {
        "isBopis": true
      },
      "networkCounters": {
        "softReserve": 10
      },
      "virtualCounters": {
        "availableToPurchase": 60
      }
    }
  ]
}