Get inventories - Fabric

Get inventories

cURL

curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/inventory \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://prod01.oms.fabric.inc/api/v2/inventory"

headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-site-context': '<x-site-context>', Authorization: 'Bearer <token>'}
};

fetch('https://prod01.oms.fabric.inc/api/v2/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://prod01.oms.fabric.inc/api/v2/inventory",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>",\
    "x-site-context: <x-site-context>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://prod01.oms.fabric.inc/api/v2/inventory"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-site-context", "<x-site-context>")
    req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://prod01.oms.fabric.inc/api/v2/inventory")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/inventory")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

JSON Responses

Success Response (200)

{
  "pagination": {
    "total": 100,
    "limit": 10,
    "offset": 0
  },
  "inventory": [
    {
      "virtualCounters": {
        "availableToPurchase": 10
      },
      "id": "62272e917b12209e68751d94",
      "sku": "SKU00025",
      "itemId": 4225678911,
      "locationNum": 473746,
      "channelId": 12,
      "vendorId": "vendor123",
      "leadTime": 1234,
      "inventoryType": "Safety stock",
      "infiniteInventory": true,
      "counters": {
        "on-hand": 10
      },
      "attributes": {
        "buy online, pick up in-store (bopis)": true
      }
    }
  ]
}

Error Responses

Invalid Request (400)

{
  "message": "Invalid request payload or parameter"
}

Internal Error (500)

{
  "message": "An internal error occurred. If the issue persists please contact support@fabric.inc."
}

Authorizations

Authorization Header

• Type: string
• Location: header
• Description: Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

x-site-context Header

• Type: string
• Location: header
• Description: x-site-context is a JSON object containing source information. Key attributes include:
  • account: 24 character identifier from Copilot.
  • channel: Sales channel ID.
  • stage: Environment name.
  • date: Optional attribute.

Example: {"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

Query Parameters

• inventorySearchModel: object for filtering criteria based on which inventories are searched.
• inventoryNetworkSearchModel: object for filtering inventory by network.
• paginationQueryModel: object for describing paginated data.