Bulk insert to inventory

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
[
  {
    "sku": "1597422",
    "itemId": 1597422,
    "totalQuantity": 25,
    "reservedQuantity": 0,
    "locationId": 175,
    "type": "Stock",
    "channelId": 12,
    "transitRef": "wo-2002",
    "transitOrderDate": "2019-12-14",
    "transitStockDate": "2019-12-14"
  }
]
'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert"

payload = [
    {
        "sku": "1597422",
        "itemId": 1597422,
        "totalQuantity": 25,
        "reservedQuantity": 0,
        "locationId": 175,
        "type": "Stock",
        "channelId": 12,
        "transitRef": "wo-2002",
        "transitOrderDate": "2019-12-14",
        "transitStockDate": "2019-12-14"
    }
]
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([
    {
      sku: '1597422',
      itemId: 1597422,
      totalQuantity: 25,
      reservedQuantity: 0,
      locationId: 175,
      type: 'Stock',
      channelId: 12,
      transitRef: 'wo-2002',
      transitOrderDate: '2019-12-14',
      transitStockDate: '2019-12-14'
    }
  ])
};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert', 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.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert",
  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([
    [
        'sku' => '1597422',
        'itemId' => 1597422,
        'totalQuantity' => 25,
        'reservedQuantity' => 0,
        'locationId' => 175,
        'type' => 'Stock',
        'channelId' => 12,
        'transitRef' => 'wo-2002',
        'transitOrderDate' => '2019-12-14',
        'transitStockDate' => '2019-12-14'
    ]
  ]),
  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.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert"

	payload := strings.NewReader("[\n  {\n    \"sku\": \"1597422\",\n    \"itemId\": 1597422,\n    \"totalQuantity\": 25,\n    \"reservedQuantity\": 0,\n    \"locationId\": 175,\n    \"type\": \"Stock\",\n    \"channelId\": 12,\n    \"transitRef\": \"wo-2002\",\n    \"transitOrderDate\": \"2019-12-14\",\n    \"transitStockDate\": \"2019-12-14\"\n  }\n]")

	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.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"sku\": \"1597422\",\n    \"itemId\": 1597422,\n    \"totalQuantity\": 25,\n    \"reservedQuantity\": 0,\n    \"locationId\": 175,\n    \"type\": \"Stock\",\n    \"channelId\": 12,\n    \"transitRef\": \"wo-2002\",\n    \"transitOrderDate\": \"2019-12-14\",\n    \"transitStockDate\": \"2019-12-14\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert")

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  {\n    \"sku\": \"1597422\",\n    \"itemId\": 1597422,\n    \"totalQuantity\": 25,\n    \"reservedQuantity\": 0,\n    \"locationId\": 175,\n    \"type\": \"Stock\",\n    \"channelId\": 12,\n    \"transitRef\": \"wo-2002\",\n    \"transitOrderDate\": \"2019-12-14\",\n    \"transitStockDate\": \"2019-12-14\"\n  }\n]"

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

{
  "messages": [
    "Import Inventory job started: Mon Nov 02 2020 22:26:10 GMT+0000 (Coordinated Universal Time)"
  ],
  "keyId": "api-1604355970096",
  "type": "api",
  "status": "FINISHED",
  "totalItems": 1,
  "totalItemsUploaded": 1,
  "totalRows": 2,
  "totalRowsErrors": 2,
  "__v": 0,
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

{
  "code": "INVENTORY_INSERT_FAILED",
  "message": "Inventory insert failed: Row 1: Cannot find \"Location Id\" 999."
}

{
  "message": "Forbidden"
}

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

POST

api-inventory

inventory

bulk-insert

Bulk insert to inventory

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
[
  {
    "sku": "1597422",
    "itemId": 1597422,
    "totalQuantity": 25,
    "reservedQuantity": 0,
    "locationId": 175,
    "type": "Stock",
    "channelId": 12,
    "transitRef": "wo-2002",
    "transitOrderDate": "2019-12-14",
    "transitStockDate": "2019-12-14"
  }
]
'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert"

payload = [
    {
        "sku": "1597422",
        "itemId": 1597422,
        "totalQuantity": 25,
        "reservedQuantity": 0,
        "locationId": 175,
        "type": "Stock",
        "channelId": 12,
        "transitRef": "wo-2002",
        "transitOrderDate": "2019-12-14",
        "transitStockDate": "2019-12-14"
    }
]
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([
    {
      sku: '1597422',
      itemId: 1597422,
      totalQuantity: 25,
      reservedQuantity: 0,
      locationId: 175,
      type: 'Stock',
      channelId: 12,
      transitRef: 'wo-2002',
      transitOrderDate: '2019-12-14',
      transitStockDate: '2019-12-14'
    }
  ])
};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert', 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.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert",
  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([
    [
        'sku' => '1597422',
        'itemId' => 1597422,
        'totalQuantity' => 25,
        'reservedQuantity' => 0,
        'locationId' => 175,
        'type' => 'Stock',
        'channelId' => 12,
        'transitRef' => 'wo-2002',
        'transitOrderDate' => '2019-12-14',
        'transitStockDate' => '2019-12-14'
    ]
  ]),
  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.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert"

	payload := strings.NewReader("[\n  {\n    \"sku\": \"1597422\",\n    \"itemId\": 1597422,\n    \"totalQuantity\": 25,\n    \"reservedQuantity\": 0,\n    \"locationId\": 175,\n    \"type\": \"Stock\",\n    \"channelId\": 12,\n    \"transitRef\": \"wo-2002\",\n    \"transitOrderDate\": \"2019-12-14\",\n    \"transitStockDate\": \"2019-12-14\"\n  }\n]")

	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.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"sku\": \"1597422\",\n    \"itemId\": 1597422,\n    \"totalQuantity\": 25,\n    \"reservedQuantity\": 0,\n    \"locationId\": 175,\n    \"type\": \"Stock\",\n    \"channelId\": 12,\n    \"transitRef\": \"wo-2002\",\n    \"transitOrderDate\": \"2019-12-14\",\n    \"transitStockDate\": \"2019-12-14\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/bulk-insert")

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  {\n    \"sku\": \"1597422\",\n    \"itemId\": 1597422,\n    \"totalQuantity\": 25,\n    \"reservedQuantity\": 0,\n    \"locationId\": 175,\n    \"type\": \"Stock\",\n    \"channelId\": 12,\n    \"transitRef\": \"wo-2002\",\n    \"transitOrderDate\": \"2019-12-14\",\n    \"transitStockDate\": \"2019-12-14\"\n  }\n]"

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

{
  "messages": [
    "Import Inventory job started: Mon Nov 02 2020 22:26:10 GMT+0000 (Coordinated Universal Time)"
  ],
  "keyId": "api-1604355970096",
  "type": "api",
  "status": "FINISHED",
  "totalItems": 1,
  "totalItemsUploaded": 1,
  "totalRows": 2,
  "totalRowsErrors": 2,
  "__v": 0,
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

{
  "code": "INVENTORY_INSERT_FAILED",
  "message": "Inventory insert failed: Row 1: Cannot find \"Location Id\" 999."
}

{
  "message": "Forbidden"
}

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

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"

Body

application/json

Minimum array length: 1

Option 1
Option 2

sku

string

required

Minimum string length: 1

Example:

"1597422"

totalQuantity

number

required

Required range: x >= 0

Example:

25

reservedQuantity

number

required

Required range: x >= 0

Example:

0

locationId

number

required

Required range: x >= 0

Example:

175

type

enum<string>

required

Available options:

Stock,

Transit

Example:

"Stock"

itemId

number

Required range: x >= 1

Example:

1597422

channelId

enum<number>

Available options:

12,

13

Example:

12

transitRef

string

Example:

"wo-2002"

transitOrderDate

string

Example:

"2019-12-14"

transitStockDate

string

Example:

"2019-12-14"

Response

Inventory bulk insert

messages

string[]

keyId

string

Example:

"api-1604355970096"

type

string

Example:

"api"

status

string

Example:

"FINISHED"

totalItems

integer

Example:

1

totalItemsUploaded

integer

Example:

1

totalRows

integer

Example:

2

totalRowsErrors

integer

Example:

2

__v

number

Example:

0

_id

string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt

string

Example:

"2020-12-31T02:09:53.914Z"

updatedAt

string

Example:

"2020-12-31T02:09:53.914Z"

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Bulk insert to inventory

Headers

Body

Response