Get inventories - Fabric

Get inventories

cURL

curl --request POST \
  --url https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "items": [\
    {\
      "itemId": "1000000051",\
      "quantity": 529\
    }\
  ],
  "channelId": 12
}
'

import requests

url = "https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory"

payload = {
    "items": [\
        {\
            "itemId": "1000000051",\
            "quantity": 529\
        }\
    ],
    "channelId": 12
}
headers = {
    "x-site-context": "<x-site-context>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
  body: JSON.stringify({items: [{itemId: '1000000051', quantity: 529}], channelId: 12})
};

fetch('https://prod01-apigw.yourcompany.fabric.zone/api-inventory/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-apigw.yourcompany.fabric.zone/api-inventory/inventory",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_POSTFIELDS => json_encode([\
    'items' => [\
        [\
                'itemId' => '1000000051',\
                'quantity' => 529\
        ]\
    ],\
    'channelId' => 12\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Content-Type: application/json",\
    "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"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory"

payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"itemId\": \"1000000051\",\n      \"quantity\": 529\n    }\n  ],\n  \"channelId\": 12}\")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-site-context", "<x-site-context>")
    req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"itemId\": \"1000000051\",\n      \"quantity\": 529\n    }\n  ],\n  \"channelId\": 12}\")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory")

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

request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"itemId\": \"1000000051\",\n      \"quantity\": 529\n    }\n  ],\n  \"channelId\": 12}\"

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

Expected Response

200

[
  {
    "itemId": 1000000003,
    "quantityRequested": 4,
    "stockDate": "<string>",
    "inStock": true,
    "fromStockQuantity": 4,
    "fromStock": [
      {
        "locationId": "5efcc26a5ee50d00079ca2ab",
        "quantityReserved": 0,
        "quantityAllocated": 9,
        "stockRemaining": 9,
        "stockRequest": 4,
        "channelId": 12
      }
    ],
    "fromTransitQuantity": 0,
    "fromTransit": "<array>",
    "availableStockQuantity": 9,
    "availableTransitQuantity": 0,
    "availableTotal": 9
  }
]

Error Responses

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

Headers

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

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

Body

Example: 12