Skip to main content
POST
/
inventory-networks
/
actions
/
soft-release
Release soft reservation
curl --request POST \
  --url https://api.fabric.inc/v3/inventory-networks/actions/soft-release \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data @- <<EOF
{
  "items": [
    {
      "channelId": "3",
      "lineItemId": "2",
      "quantity": 5,
      "sku": "OMSTESTSKU1",
      "backorderQuantity": 5,
      "errorMessage": "<string>",
      "itemId": "451008962041",
      "locationNumber": 999,
      "networkCode": "ShipToHome",
      "preorderQuantity": 5,
      "reservedNetworkCodes": [
        "<string>"
      ],
      "status": "<string>",
      "type": "['STANDARD','PREORDER','BACKORDER']"
    }
  ],
  "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  "createdAt": "2022-08-01T18:03:28.483971941Z",
  "expiresAt": "2022-08-01T18:03:28.483971941Z",
  "id": "\"Infinity\"",
  "networkCode": "DCOnly",
  "orderId": "62ab7af89ed14510827fe074",
  "orderNumber": "order_20220729_883",
  "orderType": "['STANDARD','CSR']",
  "updatedAt": "2022-08-01T18:03:28.483971941Z",
  "vendorId": "test_vendor"
}
EOF
import requests

url = "https://api.fabric.inc/v3/inventory-networks/actions/soft-release"

payload = {
    "items": [
        {
            "channelId": "3",
            "lineItemId": "2",
            "quantity": 5,
            "sku": "OMSTESTSKU1",
            "backorderQuantity": 5,
            "errorMessage": "<string>",
            "itemId": "451008962041",
            "locationNumber": 999,
            "networkCode": "ShipToHome",
            "preorderQuantity": 5,
            "reservedNetworkCodes": ["<string>"],
            "status": "<string>",
            "type": "['STANDARD','PREORDER','BACKORDER']"
        }
    ],
    "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
    "createdAt": "2022-08-01T18:03:28.483971941Z",
    "expiresAt": "2022-08-01T18:03:28.483971941Z",
    "id": "\"Infinity\"",
    "networkCode": "DCOnly",
    "orderId": "62ab7af89ed14510827fe074",
    "orderNumber": "order_20220729_883",
    "orderType": "['STANDARD','CSR']",
    "updatedAt": "2022-08-01T18:03:28.483971941Z",
    "vendorId": "test_vendor"
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "x-fabric-channel-id": "<x-fabric-channel-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    'x-fabric-channel-id': '<x-fabric-channel-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    items: [
      {
        channelId: '3',
        lineItemId: '2',
        quantity: 5,
        sku: 'OMSTESTSKU1',
        backorderQuantity: 5,
        errorMessage: '<string>',
        itemId: '451008962041',
        locationNumber: 999,
        networkCode: 'ShipToHome',
        preorderQuantity: 5,
        reservedNetworkCodes: ['<string>'],
        status: '<string>',
        type: '[\'STANDARD\',\'PREORDER\',\'BACKORDER\']'
      }
    ],
    cartId: 'b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569',
    createdAt: '2022-08-01T18:03:28.483971941Z',
    expiresAt: '2022-08-01T18:03:28.483971941Z',
    id: '"Infinity"',
    networkCode: 'DCOnly',
    orderId: '62ab7af89ed14510827fe074',
    orderNumber: 'order_20220729_883',
    orderType: '[\'STANDARD\',\'CSR\']',
    updatedAt: '2022-08-01T18:03:28.483971941Z',
    vendorId: 'test_vendor'
  })
};

fetch('https://api.fabric.inc/v3/inventory-networks/actions/soft-release', 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://api.fabric.inc/v3/inventory-networks/actions/soft-release",
  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' => [
        [
                'channelId' => '3',
                'lineItemId' => '2',
                'quantity' => 5,
                'sku' => 'OMSTESTSKU1',
                'backorderQuantity' => 5,
                'errorMessage' => '<string>',
                'itemId' => '451008962041',
                'locationNumber' => 999,
                'networkCode' => 'ShipToHome',
                'preorderQuantity' => 5,
                'reservedNetworkCodes' => [
                                '<string>'
                ],
                'status' => '<string>',
                'type' => '[\'STANDARD\',\'PREORDER\',\'BACKORDER\']'
        ]
    ],
    'cartId' => 'b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569',
    'createdAt' => '2022-08-01T18:03:28.483971941Z',
    'expiresAt' => '2022-08-01T18:03:28.483971941Z',
    'id' => '"Infinity"',
    'networkCode' => 'DCOnly',
    'orderId' => '62ab7af89ed14510827fe074',
    'orderNumber' => 'order_20220729_883',
    'orderType' => '[\'STANDARD\',\'CSR\']',
    'updatedAt' => '2022-08-01T18:03:28.483971941Z',
    'vendorId' => 'test_vendor'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-channel-id: <x-fabric-channel-id>",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

$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://api.fabric.inc/v3/inventory-networks/actions/soft-release"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"channelId\": \"3\",\n      \"lineItemId\": \"2\",\n      \"quantity\": 5,\n      \"sku\": \"OMSTESTSKU1\",\n      \"backorderQuantity\": 5,\n      \"errorMessage\": \"<string>\",\n      \"itemId\": \"451008962041\",\n      \"locationNumber\": 999,\n      \"networkCode\": \"ShipToHome\",\n      \"preorderQuantity\": 5,\n      \"reservedNetworkCodes\": [\n        \"<string>\"\n      ],\n      \"status\": \"<string>\",\n      \"type\": \"['STANDARD','PREORDER','BACKORDER']\"\n    }\n  ],\n  \"cartId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\",\n  \"createdAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"expiresAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"id\": \"\\\"Infinity\\\"\",\n  \"networkCode\": \"DCOnly\",\n  \"orderId\": \"62ab7af89ed14510827fe074\",\n  \"orderNumber\": \"order_20220729_883\",\n  \"orderType\": \"['STANDARD','CSR']\",\n  \"updatedAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"vendorId\": \"test_vendor\"\n}")

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

	req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
	req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://api.fabric.inc/v3/inventory-networks/actions/soft-release")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("x-fabric-channel-id", "<x-fabric-channel-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"channelId\": \"3\",\n      \"lineItemId\": \"2\",\n      \"quantity\": 5,\n      \"sku\": \"OMSTESTSKU1\",\n      \"backorderQuantity\": 5,\n      \"errorMessage\": \"<string>\",\n      \"itemId\": \"451008962041\",\n      \"locationNumber\": 999,\n      \"networkCode\": \"ShipToHome\",\n      \"preorderQuantity\": 5,\n      \"reservedNetworkCodes\": [\n        \"<string>\"\n      ],\n      \"status\": \"<string>\",\n      \"type\": \"['STANDARD','PREORDER','BACKORDER']\"\n    }\n  ],\n  \"cartId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\",\n  \"createdAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"expiresAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"id\": \"\\\"Infinity\\\"\",\n  \"networkCode\": \"DCOnly\",\n  \"orderId\": \"62ab7af89ed14510827fe074\",\n  \"orderNumber\": \"order_20220729_883\",\n  \"orderType\": \"['STANDARD','CSR']\",\n  \"updatedAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"vendorId\": \"test_vendor\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/inventory-networks/actions/soft-release")

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

request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"channelId\": \"3\",\n      \"lineItemId\": \"2\",\n      \"quantity\": 5,\n      \"sku\": \"OMSTESTSKU1\",\n      \"backorderQuantity\": 5,\n      \"errorMessage\": \"<string>\",\n      \"itemId\": \"451008962041\",\n      \"locationNumber\": 999,\n      \"networkCode\": \"ShipToHome\",\n      \"preorderQuantity\": 5,\n      \"reservedNetworkCodes\": [\n        \"<string>\"\n      ],\n      \"status\": \"<string>\",\n      \"type\": \"['STANDARD','PREORDER','BACKORDER']\"\n    }\n  ],\n  \"cartId\": \"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569\",\n  \"createdAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"expiresAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"id\": \"\\\"Infinity\\\"\",\n  \"networkCode\": \"DCOnly\",\n  \"orderId\": \"62ab7af89ed14510827fe074\",\n  \"orderNumber\": \"order_20220729_883\",\n  \"orderType\": \"['STANDARD','CSR']\",\n  \"updatedAt\": \"2022-08-01T18:03:28.483971941Z\",\n  \"vendorId\": \"test_vendor\"\n}"

response = http.request(request)
puts response.read_body
{
  "aggregatedNetworks": [
    {
      "backorderLimit": 50,
      "backorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "channelId": "channel_xyz",
      "counters": {
        "allocated": 10,
        "onHand": 100,
        "shipped": 20
      },
      "createdAt": "2022-08-01T18:03:28.483Z",
      "customAttributes": {
        "isBopis": true
      },
      "hasInfiniteInventory": false,
      "inventoryId": "723910d81723",
      "isNoStock": false,
      "itemId": 12345,
      "leadTime": "5 days",
      "locationNumber": 12345,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "networkCounters": {
        "softReserve": 10
      },
      "preorderLimit": 40,
      "preorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "region": "North America",
      "safetyStock": 10,
      "segment": "Sample Segment",
      "sku": "SKU1",
      "status": " IN_STOCK",
      "type": "primary",
      "updatedAt": "2022-08-01T20:03:28.483Z",
      "vendorId": "vendor1",
      "virtualCounters": {
        "availableBackorder": "<string>",
        "availablePreorder": "<string>",
        "availableToPurchase": "<string>"
      },
      "virtualCountersStatus": {
        "availableBackorder": "<string>",
        "availablePreorder": "<string>",
        "availableToPurchase": "<string>"
      }
    }
  ]
}
{
  "errors": [
    {
      "message": "Invalid request",
      "type": "CLIENT_ERROR"
    }
  ],
  "message": "Bad request",
  "type": "CLIENT_ERROR"
}
{
  "message": "Unauthorized request",
  "type": "CLIENT_ERROR"
}
{
  "message": "Internal server error",
  "type": "SERVER_ERROR"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

​
x-fabric-request-id
string

Unique request ID

Body

application/json

SoftReserveRequest model

​
items
object[]
required

Items which needs to be reserved. Required parameter

​
cartId
string

CartId for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

​
createdAt
string<date-time>

Date when soft reservation was created

Example:

"2022-08-01T18:03:28.483971941Z"

​
expiresAt
string<date-time>

Date when soft reservation will expire

Example:

"2022-08-01T18:03:28.483971941Z"

​
id
string

ID

Example:

"\"Infinity\""

​
networkCode
string

Network for which items needs to be reserved. Optional parameter

Example:

"DCOnly"

​
orderId
string

Order ID for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required

Example:

"62ab7af89ed14510827fe074"

​
orderNumber
string
deprecated

OrderNumber for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required

Example:

"order_20220729_883"

​
orderType
string

Order type, default value is STANDARD. Optional parameter

Example:

"['STANDARD','CSR']"

​
updatedAt
string<date-time>

Date when soft reservation was updated

Example:

"2022-08-01T18:03:28.483971941Z"

​
vendorId
string

VendorId for which soft reserve requested. Optional parameter

Example:

"test_vendor"

Response

OK

AggregatedNetworksResponse model

​
aggregatedNetworks
object[]

Aggregated networks