Search for backorders or preorders by query

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
- Overview
- POST
  Search for backorders or preorders by query
- POST
  Record customer agreement to delay shipment
- GET
  Get backorder or preorder details by ID
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Inventory (3.0.0)
Inventory FAQ
Imports
Counters
Inventory
Locations
Networks

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

backorders-preorders

Authorizations

Authorization

string

headerrequired

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

default: 0

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

limit

integer

default: 10

Maximum number of records per page

Required range: 1 < x < 100

Body

application/json

Backorder preorder search request details

filters

object[]

required

sort

string

default: -backOrderPreOrder.type

Property by which data is sorted

Response

200 - application/json

Backorder preorder search response

data

object[]

data.cartId

string

fabric system-generated cart ID. This ID identifies the cart for which backorder and preorder is created.

The fabric system-generated time of customer consent. This field is used in combination with the isDelayConsented field.

data.createdAt

string

The date the backorder or preorder was created.

data.id

string

System-generated unique ID for backorder or preorder

data.isDelayConsented

boolean

true: Customer agrees to receive the product at a later date false: Customer wants the product immediately, and doesn't agree to receive the product at a later date. In such case, if the merchant can't fulfill the order immediately, they can cancel the product, change order status and notify the customer about order cancellation

data.itemId

integer

System-generated unique identifier of item from fabric Products (previously called PIM) service

data.lastNotifiedAt

string

System-generated time of last notification to customer about their order

data.lineItemId

string

required

Item sequence ID generated by fabric Orders (also called fabric OMS)

data.lineItemStatus

enum<string>

Line item status

Available options:

CANCELLED,

REFUNDED,

PARTIALLY_CANCELLED,

PARTIALLY_REFUNDED,

PARTIALLY_CANCELLED_REFUNDED,

VALID,

EXCHANGED,

PENDING_EXCHANGE,

RETURN,

PARTIAL_RETURN,

PENDING_RETURN,

RETURN_PROCESSING,

RETURN_REJECTED,

ORDER_LINE_INVALID_SKU,

ORDER_LINE_VALID,

SHIPPED,

PARTIALLY_SHIPPED,

ALLOCATED,

PARTIALLY_ALLOCATED,

DELIVERED,

PARTIALLY_DELIVERED,

PICKED_UP,

PARTIALLY_PICKED_UP,

READY_FOR_PICKUP,

READY_FOR_PARTIAL_PICKUP

data.locationNumber

integer

required

Represents inventory location which will fulfill the order reservation

data.orderId

string

required

System-generated order ID created during order creation

data.orderNumber

string

System-generated order number created during order creation

data.orderStatusCode

enum<string>

required

Order status

Available options:

ORDER_CREATED,

ORDER_PARTIALLY_ALLOCATED,

ORDER_ALLOCATED,

ORDER_SHIPPED,

ORDER_PARTIALLY_SHIPPED,

ORDER_PICKED_UP,

ORDER_PARTIALLY_PICKED_UP,

ORDER_READY_FOR_PICKUP,

ORDER_READY_FOR_PARTIAL_PICKUP,

ORDER_DELIVERED,

ORDER_PARTIALLY_DELIVERED,

ORDER_RETURNED,

ORDER_PARTIALLY_RETURNED,

ORDER_PENDING_RETURN,

ORDER_PENDING_PARTIAL_RETURN,

ORDER_PARTIALLY_EXCHANGED,

ORDER_EXCHANGED,

ORDER_CANCELLED,

ORDER_PARTIALLY_CANCELLED,

ORDER_HOLD,

ORDER_CONFIRMED,

ORDER_HOLD_FRAUD,

ORDER_HOLD_CSR,

ORDER_HOLD_CROSSBORDER,

ORDER_HOLD_REVALIDATION,

ORDER_ERROR,

ORDER_HOLD_AUTH_PENDING

data.orderedAt

string

required

System-generated order creation time

data.quantity

integer

required

Number of items reserved for backorder or preorder

data.releasedQuantity

integer

Number of items to be released from inventory reservation

data.sku

string

required

Stock Keeping Unit (SKU), unique identifier of item

data.status

string

Backorder or preorder status

data.type

enum<string>

required

Reservation type

Available options:

PREORDER,

BACKORDER

data.updatedAt

string

The date the backorder or preorder was updated.

data.vendorId

string

ID of the retailer's source of order replenishment

pagination

object

Pagination response

stats

string[]

A list of stats.

Was this page helpful?

Overview Record customer agreement to delay shipment