Search for backorders or preorders by query

curl --request POST \
  --url https://api.fabric.inc/v3/backorders-preorders/search \
  --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 '
{
  "filters": [
    {
      "condition": "EQ",
      "field": "backOrderPreOrder.cartId",
      "value": "64391c190d3ce53e2ccc72b2"
    },
    {
      "condition": "IN",
      "field": "backOrderPreOrder.itemId",
      "values": [
        "1122345",
        "5544321"
      ]
    }
  ],
  "sort": "-backOrderPreOrder.type"
}
'

import requests

url = "https://api.fabric.inc/v3/backorders-preorders/search"

payload = {
    "filters": [
        {
            "condition": "EQ",
            "field": "backOrderPreOrder.cartId",
            "value": "64391c190d3ce53e2ccc72b2"
        },
        {
            "condition": "IN",
            "field": "backOrderPreOrder.itemId",
            "values": ["1122345", "5544321"]
        }
    ],
    "sort": "-backOrderPreOrder.type"
}
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({
    filters: [
      {
        condition: 'EQ',
        field: 'backOrderPreOrder.cartId',
        value: '64391c190d3ce53e2ccc72b2'
      },
      {
        condition: 'IN',
        field: 'backOrderPreOrder.itemId',
        values: ['1122345', '5544321']
      }
    ],
    sort: '-backOrderPreOrder.type'
  })
};

fetch('https://api.fabric.inc/v3/backorders-preorders/search', 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/backorders-preorders/search",
  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([
    'filters' => [
        [
                'condition' => 'EQ',
                'field' => 'backOrderPreOrder.cartId',
                'value' => '64391c190d3ce53e2ccc72b2'
        ],
        [
                'condition' => 'IN',
                'field' => 'backOrderPreOrder.itemId',
                'values' => [
                                '1122345',
                                '5544321'
                ]
        ]
    ],
    'sort' => '-backOrderPreOrder.type'
  ]),
  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/backorders-preorders/search"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"backOrderPreOrder.cartId\",\n      \"value\": \"64391c190d3ce53e2ccc72b2\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"backOrderPreOrder.itemId\",\n      \"values\": [\n        \"1122345\",\n        \"5544321\"\n      ]\n    }\n  ],\n  \"sort\": \"-backOrderPreOrder.type\"\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/backorders-preorders/search")
  .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  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"backOrderPreOrder.cartId\",\n      \"value\": \"64391c190d3ce53e2ccc72b2\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"backOrderPreOrder.itemId\",\n      \"values\": [\n        \"1122345\",\n        \"5544321\"\n      ]\n    }\n  ],\n  \"sort\": \"-backOrderPreOrder.type\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/backorders-preorders/search")

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  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"backOrderPreOrder.cartId\",\n      \"value\": \"64391c190d3ce53e2ccc72b2\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"backOrderPreOrder.itemId\",\n      \"values\": [\n        \"1122345\",\n        \"5544321\"\n      ]\n    }\n  ],\n  \"sort\": \"-backOrderPreOrder.type\"\n}"

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

{
  "data": [
    {
      "lineItemId": "0",
      "locationNumber": "WH334",
      "orderId": "5fec576ddaa2544b2dd94684",
      "orderStatusCode": "ORDER_CREATED",
      "orderedAt": "2022-04-12T09:30:31.198Z",
      "quantity": 5,
      "sku": "sku_123",
      "type": "BACKORDER",
      "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "consentReceivedAt": "2022-07-12T09:30:31.198Z",
      "createdAt": "2022-07-11T15:03:14.642Z",
      "id": "63ec576ddaa2544b2dd94684",
      "isDelayConsented": true,
      "itemId": 123,
      "lastNotifiedAt": "2022-06-12T09:30:31.198Z",
      "lineItemStatus": "CANCELLED",
      "orderNumber": "order_123",
      "releasedQuantity": 1,
      "status": "PARTIAL_BACK_PREORDER_RELEASE",
      "updatedAt": "2022-07-11T15:03:14.642Z",
      "vendorId": "vendor_123"
    }
  ],
  "pagination": {
    "count": 1000,
    "limit": 10,
    "offset": 1
  },
  "stats": [
    "<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"
}

POST

backorders-preorders

Search for backorders or preorders by query

curl --request POST \
  --url https://api.fabric.inc/v3/backorders-preorders/search \
  --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 '
{
  "filters": [
    {
      "condition": "EQ",
      "field": "backOrderPreOrder.cartId",
      "value": "64391c190d3ce53e2ccc72b2"
    },
    {
      "condition": "IN",
      "field": "backOrderPreOrder.itemId",
      "values": [
        "1122345",
        "5544321"
      ]
    }
  ],
  "sort": "-backOrderPreOrder.type"
}
'

import requests

url = "https://api.fabric.inc/v3/backorders-preorders/search"

payload = {
    "filters": [
        {
            "condition": "EQ",
            "field": "backOrderPreOrder.cartId",
            "value": "64391c190d3ce53e2ccc72b2"
        },
        {
            "condition": "IN",
            "field": "backOrderPreOrder.itemId",
            "values": ["1122345", "5544321"]
        }
    ],
    "sort": "-backOrderPreOrder.type"
}
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({
    filters: [
      {
        condition: 'EQ',
        field: 'backOrderPreOrder.cartId',
        value: '64391c190d3ce53e2ccc72b2'
      },
      {
        condition: 'IN',
        field: 'backOrderPreOrder.itemId',
        values: ['1122345', '5544321']
      }
    ],
    sort: '-backOrderPreOrder.type'
  })
};

fetch('https://api.fabric.inc/v3/backorders-preorders/search', 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/backorders-preorders/search",
  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([
    'filters' => [
        [
                'condition' => 'EQ',
                'field' => 'backOrderPreOrder.cartId',
                'value' => '64391c190d3ce53e2ccc72b2'
        ],
        [
                'condition' => 'IN',
                'field' => 'backOrderPreOrder.itemId',
                'values' => [
                                '1122345',
                                '5544321'
                ]
        ]
    ],
    'sort' => '-backOrderPreOrder.type'
  ]),
  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/backorders-preorders/search"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"backOrderPreOrder.cartId\",\n      \"value\": \"64391c190d3ce53e2ccc72b2\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"backOrderPreOrder.itemId\",\n      \"values\": [\n        \"1122345\",\n        \"5544321\"\n      ]\n    }\n  ],\n  \"sort\": \"-backOrderPreOrder.type\"\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/backorders-preorders/search")
  .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  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"backOrderPreOrder.cartId\",\n      \"value\": \"64391c190d3ce53e2ccc72b2\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"backOrderPreOrder.itemId\",\n      \"values\": [\n        \"1122345\",\n        \"5544321\"\n      ]\n    }\n  ],\n  \"sort\": \"-backOrderPreOrder.type\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/backorders-preorders/search")

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  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"backOrderPreOrder.cartId\",\n      \"value\": \"64391c190d3ce53e2ccc72b2\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"backOrderPreOrder.itemId\",\n      \"values\": [\n        \"1122345\",\n        \"5544321\"\n      ]\n    }\n  ],\n  \"sort\": \"-backOrderPreOrder.type\"\n}"

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

{
  "data": [
    {
      "lineItemId": "0",
      "locationNumber": "WH334",
      "orderId": "5fec576ddaa2544b2dd94684",
      "orderStatusCode": "ORDER_CREATED",
      "orderedAt": "2022-04-12T09:30:31.198Z",
      "quantity": 5,
      "sku": "sku_123",
      "type": "BACKORDER",
      "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "consentReceivedAt": "2022-07-12T09:30:31.198Z",
      "createdAt": "2022-07-11T15:03:14.642Z",
      "id": "63ec576ddaa2544b2dd94684",
      "isDelayConsented": true,
      "itemId": 123,
      "lastNotifiedAt": "2022-06-12T09:30:31.198Z",
      "lineItemStatus": "CANCELLED",
      "orderNumber": "order_123",
      "releasedQuantity": 1,
      "status": "PARTIAL_BACK_PREORDER_RELEASE",
      "updatedAt": "2022-07-11T15:03:14.642Z",
      "vendorId": "vendor_123"
    }
  ],
  "pagination": {
    "count": 1000,
    "limit": 10,
    "offset": 1
  },
  "stats": [
    "<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

Query Parameters

offset

integer<int32>

default:0

Number of records to be skipped before returning all records. Default is 0 when no value is specified.

Example:

0

limit

integer<int32>

default:10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

Body

application/json

Backorder preorder search request details

filters

object[]

required

Maximum array length: 50

Criteria to find backorder-preorder using a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

Show child attributes

sort

string

default:-backOrderPreOrder.type

Property by which data is sorted

Pattern: (^[+-]backOrderPreOrder\.[a-zA-Z.\-_]*)(,([+-]backOrderPreOrder\.[a-zA-Z.\-_]*)){0,}

Example:

"+backOrderPreOrder.invoicedAt"

Response

Backorder preorder search response

data

object[]

Show child attributes

pagination

object

Pagination response

Show child attributes

stats

string[]

A list of stats.

The stats details.

Overview Record customer agreement to delay shipment

⌘I

Orders & Inventory

Order User Guides

Inventory User Guides

Error Codes

Orders API Endpoints

Inventory API Endpoints

Search for backorders or preorders by query

Authorizations

Headers

Query Parameters

Body

Response