GET
/
backorders-preorders
/
{id}

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

Path Parameters

​
id
string
required

Backorder or preorder ID

Response

200 - application/json

Backorder-preorder response details

​
lineItemId
string
required

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

​
locationNumber
integer
required

Represents inventory location which will fulfill the order reservation

​
orderId
string
required

System-generated order ID created during order creation

​
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
​
orderedAt
string
required

System-generated order creation time

​
quantity
integer
required

Number of items reserved for backorder or preorder

​
sku
string
required

Stock Keeping Unit (SKU), unique identifier of item

​
type
enum<string>
required

Reservation type

Available options:
PREORDER,
BACKORDER
​
cartId
string

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

​
consentReceivedAt
string

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

​
createdAt
string

The date the backorder or preorder was created.

​
id
string

System-generated unique ID for backorder or preorder

​
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

​
itemId
integer

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

​
lastNotifiedAt
string

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

​
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
​
orderNumber
string

System-generated order number created during order creation

​
releasedQuantity
integer

Number of items to be released from inventory reservation

​
status
string

Backorder or preorder status

​
updatedAt
string

The date the backorder or preorder was updated.

​
vendorId
string

ID of the retailer's source of order replenishment

Was this page helpful?

Record customer agreement to delay shipmentOverview