Get inventory by location - Fabric

Get inventory by location

cURL

curl --request GET \
  --url https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory/location/{locationId} \
  --header 'x-site-context: <x-site-context>'

Python

import requests

url = "https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory/location/{locationId}"

headers = {"x-site-context": "<x-site-context>"}

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

print(response.text)

JavaScript (Fetch)

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

fetch('https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory/location/{locationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory/location/{locationId}",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "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;
}

Go

package main

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

func main() {

url := "https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory/location/{locationId}"

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

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

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

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

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.get("https://prod01-apigw.yourcompany.fabric.zone/api-inventory/inventory/location/{locationId}")
  .header("x-site-context", "<x-site-context>")
  .asString();

Ruby

require 'uri'
require 'net/http'

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

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>'

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

Response Codes

• 200
• 400
• 403
• 404
• 500

Response Example

{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 3
  },
  "inventories": [\
    {\
      "itemdId": 1000000033,\
      "inStock": 5000,\
      "channel": [\
        {\
          "quantityReserved": 0,\
          "_id": "60f0e15f9cf5e800084a6718",\
          "channelId": 12,\
          "allocation": {\
            "mou": "ABSOLUTE",\
            "unti": 5000\
          },\
          "id": "60f0e15f9cf5e800084a6718"\
        }\
      ],\
      "location": "60a6e451d5748b0008ac85a0"\
    }\
  ]\
}

Error Responses

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

{
  "message": "Forbidden"
}

{
  "code": "LOCATION_NOT_FOUND",
  "message": "Location 123456789012345678901234 not found"
}

Headers

• x-site-context (string, required): 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\"}"

• x-api-key (string): Example: "0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

Path Parameters

• locationId (string, required): Required string length: 24 Example: "5e4b0a8cef94d00b11acc382"

Query Parameters

• Search parameters (object)