Create an order

Creates an order. After an order is created, Notification APIs of fabric OMS send order notification to customers.

Authorizations

Authorization

string

header

required

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

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\"}"

Body

application/json

Order object

orderNumber

string

required

Unique order number to be provided by merchant

Example:

"309019176"

channelId

string

required

Sales channel ID

Example:

"12"

statusCode

string

required

Order status code

Example:

"ORDER_CREATED"

items

object[]

required

Array of items for which order is processed

Details of ordered items

Show child attributes

items.lineItemId

string

required

Cart item ID, generated automatically

Example:

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

items.lineItemNumber

integer

required

Cart item sequence number (starts at 1)

Example:

1

items.itemId

string

required

Item ID

Example:

"1234"

items.sku

string

required

Itme SKU

Example:

"P1234"

items.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

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

items.channelId

string

Sales channel ID of the item

Example:

"WHBM"

items.segment

string

Segement the item belongs to. This is used to identify if any promotional offer is applicable to the item, for example if the item is a free gift.

Example:

"P1234"

items.vendorId

string

ID of vendor who sells the item

Example:

"P1234"

items.title

string

Title of the item

Example:

"Item"

items.type

string

Identify order type whether it's pickup item, or web ship, or international order

Example:

"WEB_SHIP"

items.subType

string

Provides additional information in relation to type

Example:

"Borderfree"

items.backorder

boolean

Backorder refers to re-stock of the item.<br />true if the item is ordered as backorder<br />false if the item is not ordered as backorder

Example:

true

items.orderedQuantity

integer

Quantity of items ordered

Example:

60

items.uom

string

Unit of measurement

Example:

"EA"

items.itemUnitPrice

number

Price set for each unit of item

Example:

10

items.itemSubTotal

number

Sub-total for all quantities of the item. Calculated by multiplying unit price with ordered quantity.

Example:

600

items.itemFeeTotal

number

Total fees applicable on purchase of items. It is calculated based on the values passed in the fees array under OrderItemDTO. It includes shipping fee or any other fee.

Example:

5

items.itemDiscountsTotal

number

Total discount applicable on purchase of items. It is calculated based on the values passed in the discounts array under OrderItemDTO.

Example:

55

items.itemTaxTotal

number

Total tax amount applicable on purchase of items. It is calculated based on the values passed in the taxDetail array under OrderItemDTO.

Example:

5

items.itemTotal

number

Final amount charged on all items (based on quantity), after calculating discount and tax.

Example:

555

items.currency

string

Currency used for order of items

Example:

"USD"

items.employeeId

string

In case of POS, ID of the employee who helps in creating order for the item.

Example:

"5345HJH"

items.associateId

string

Example:

"5345HJH"

items.fees

object[]

Shipping fee or any other fee applicable on purchase of the item

Show child attributes

items.fees.type

string

Example:

"tax"

items.fees.value

number

Example:

34.56

items.taxCode

string

Tax code applied, for the item, if any

Example:

"FR01"

items.taxDetail

object[]

Show child attributes

items.taxDetail.type

string

Example:

"tax"

items.taxDetail.value

number

Example:

34.56

items.discounts

object[]

Order discount model

Show child attributes

items.discounts.quantity

integer

Minimum quantity to be purchased for the discount to be applied

Example:

2

items.discounts.amount

number

Example:

2.4

items.discounts.unit

string

Unit of discount; represents whether the discount is in percentage or by a certain amount

Example:

"AMOUNT_OFF"

items.discounts.value

integer

Discount value

Example:

2

items.discounts.promoId

string

System generated unique ID for the promotion

Example:

"HNY2022"

items.discounts.promoCode

string

Coupon code to be applied to get the desired discount

Example:

"HNY2022"

items.discounts.promoTitle

string

Promotion title

Example:

"Happy New Year"

items.discounts.type

string

Type of promotion

Example:

"promotion"

items.attributes

object

Show child attributes

items.attributes.{key}

object

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

items.notes

object[]

Notes section to be used for CSR only

Show child attributes

items.notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

items.notes.user

string

Example:

"62272e917b12209e68751d94"

items.notes.notes

string

Example:

"Extra information to be provided"

shipInfo

object[]

required

Order shipping info

Show child attributes

shipInfo.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"5349b4ddd2781d08c09890f4"

shipInfo.taxCode

string

Code for the tax applied for shiping of items to the adress

Example:

"FR01"

shipInfo.locationNum

string

Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store

Example:

"123"

shipInfo.pickup

object[]

Details of the person who picks up the order

Show child attributes

shipInfo.pickup.name

object

Name for order details

Show child attributes

shipInfo.pickup.name.first

string

Example:

"John"

shipInfo.pickup.name.middle

string

Example:

"Middle"

shipInfo.pickup.name.last

string

Example:

"Doe"

shipInfo.pickup.email

string

Example:

"[e-mail]"

shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.pickup.phone.number

string

Example:

"55555555555"

shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

Example:

"Primary"

shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

shipInfo.shipToAddress.address1

string

required

Example:

"First line of address"

shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

shipInfo.shipToAddress.name.first

string

Example:

"John"

shipInfo.shipToAddress.name.middle

string

Example:

"Middle"

shipInfo.shipToAddress.name.last

string

Example:

"Doe"

shipInfo.shipToAddress.email

string

Example:

"[e-mail]"

shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.shipToAddress.phone.number

string

Example:

"55555555555"

shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.shipToAddress.address2

string

Example:

"123 Parking Lot"

shipInfo.shipToAddress.address3

string

Example:

"Third line of address"

shipInfo.shipToAddress.address4

string

Example:

"Fourth line of address"

shipInfo.shipToAddress.city

string

Example:

"Beaumont"

shipInfo.shipToAddress.state

string

Example:

"TX"

shipInfo.shipToAddress.country

string

Example:

"USA"

shipInfo.shipToAddress.postalCode

string

Example:

"77705"

shipInfo.shipToAddress.type

string

Example:

"residence"

shipInfo.shipToAddress.latitude

number

Latitude of the address

Example:

35.294952

shipInfo.shipToAddress.longitude

number

Longitude of the address

Example:

32.294952

shipInfo.taxDetail

object[]

Show child attributes

shipInfo.taxDetail.type

string

Example:

"tax"

shipInfo.taxDetail.value

number

Example:

34.56

shipInfo.shipMethod

string

Example:

"Express Delivery"

shipInfo.shipToType

string

Example:

"SHIP_TO_ADDRESS"

shipInfo.estimatedShipDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.estimatedDeliveryDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

Example:

20

shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

Example:

12.6

shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

Example:

12.6

shipInfo.shipmentInstructions

string

Additional user instructions

Example:

"User instructions"

shipInfo.attributes

object

Show child attributes

shipInfo.attributes.{key}

object

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

orderDate

string

Actual order creation date when the order was created for the first time.

Example:

"2022-05-12T09:30:31.198Z"

cartId

string

ID of the cart for which order is created

Example:

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

type

enum<string>

Platform of order creation, for example, website, mobile application, point of sale, and so on.

Available options:

WEB,

CSC,

MOBILE_APP,

POS

Example:

"WEB"

subType

enum<string>

Operating system of the platform mentioned in the type field.

Available options:

IOS,

Android,

International

Example:

"International"

employeeId

string

ID of the employee who created the order or who helped creating the order.

Example:

"43278"

retail

object

Order retail object for reatil transactions. For non-retail transactions, only location number is provided.

Show child attributes

retail.locationNum

integer

Store number of line item's fulfillment origin.

Example:

123

retail.cashierId

string

Cashier ID in case of retail transaction.

Example:

"C-123"

retail.registerId

string

Registered user ID of the cashier who helps in creating the order. It is applicable for retail transactions.

Example:

"113"

retail.transactionId

string

Transaction ID incase of retail transaction.

Example:

"R123-431-1133-2129"

orderSubTotal

number

Base price of the ordered items before discounts. It does not include tax amount.

Example:

123.45

orderDiscount

number

Discounted amount

Example:

1.23

feeTotal

number

Order value after discount. Discount value is subtracted from order sub total.

Example:

12.34

taxTotal

number

Total tax amount applicable on the order subtotal value.

Example:

12.34

orderTotal

number

Total order value after calculating discount and tax values.

Example:

146.9

currency

string

Currecy code used for order amount

Example:

"USD"

statusDescription

string

Order status description

Example:

"Order created"

attributes

object

Show child attributes

attributes.{key}

object

Example:

{
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approver": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "KKMH0R12TQ46",
  "fraudScore": "31"
}

fees

object[]

Order fee detail model

Show child attributes

fees.type

string

Example:

"shipping"

fees.value

number

Example:

34.56

fees.invoiceValue

number

Example:

34.56

discounts

object[]

Array of discount objects

Order discount model

Show child attributes

discounts.quantity

integer

Minimum quantity to be purchased for the discount to be applied

Example:

2

discounts.amount

number

Example:

2.4

discounts.unit

string

Unit of discount; represents whether the discount is in percentage or by a certain amount

Example:

"AMOUNT_OFF"

discounts.value

integer

Discount value

Example:

2

discounts.promoId

string

System generated unique ID for the promotion

Example:

"HNY2022"

discounts.promoCode

string

Coupon code to be applied to get the desired discount

Example:

"HNY2022"

discounts.promoTitle

string

Promotion title

Example:

"Happy New Year"

discounts.type

string

Type of promotion

Example:

"promotion"

customer

object

Order customer model

Show child attributes

customer.name

object

Name for order details

Show child attributes

customer.name.first

string

Example:

"John"

customer.name.middle

string

Example:

"Middle"

customer.name.last

string

Example:

"Doe"

customer.email

string

Example:

"[e-mail]"

customer.phone

object

Contact details of customer for the order

Show child attributes

customer.phone.number

string

Example:

"55555555555"

customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

customer.userId

string

It is shopper's ID who visits company website to purchase products.

Example:

"62272e917b12209e68751d94"

customer.accountId

string

Account ID such as loyalty account ID or memebr account ID. Refers to any external system or fabric's loyalty service that the user has account with.

Example:

"62272e917b12209e68751d94"

customer.employeeId

string

ID of the employee (sales person) who creates an order for shopper.

Example:

"62272e917b12209e68751d94"

customer.company

string

Example:

"fabric"

payments

object[]

Order payment object

Show child attributes

payments.paymentCounter

integer

Counter number, for retail transaction, where payment is processed. Is this empty for web transaction?

Example:

1

payments.paymentDate

string

Example:

"2022-01-27T16:15:58-05:00"

payments.billToId

string

Billing ID

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier

object

Order payment identifier model

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits of card number

Example:

"3456"

payments.paymentIdentifier.expirationYear

string

Card expiration year

Example:

"2029"

payments.paymentIdentifier.expirationMonth

string

Card expiration month

Example:

"02"

payments.paymentIdentifier.paymentId

string

Payment ID

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier.fabricPaymentReference

string

Example:

"fab3456"

payments.paymentProvider

string

Payment processing platform

Example:

"stripe"

payments.paymentToken

object

Payment token details

Show child attributes

payments.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

payments.paymentMethod

string

Example:

"CREDIT_CARD"

payments.authAmount

number

Authorized amount to be charged for the order

Example:

123.45

payments.chargedAmount

number

Amount charged on the payment method

Example:

60

payments.currency

string

Currency code for order amount

Example:

"USD"

payments.conversion

number

Currency cenversion

Example:

1

payments.paymentStatus

string

Shows if value mentioned in payment method is authorized for the payment to proceed

Example:

"AUTHORIZED"

payments.authExpirationDate

string

Payment authorization expiration date and time

Example:

"2022-01-27T16:15:58-05:00"

payments.billToAddress

object

Order billing or shipping address

Show child attributes

payments.billToAddress.address1

string

required

Example:

"First line of address"

payments.billToAddress.name

object

Name for order details

Show child attributes

payments.billToAddress.name.first

string

Example:

"John"

payments.billToAddress.name.middle

string

Example:

"Middle"

payments.billToAddress.name.last

string

Example:

"Doe"

payments.billToAddress.email

string

Example:

"[e-mail]"

payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

payments.billToAddress.phone.number

string

Example:

"55555555555"

payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

payments.billToAddress.address2

string

Example:

"123 Parking Lot"

payments.billToAddress.address3

string

Example:

"Third line of address"

payments.billToAddress.address4

string

Example:

"Fourth line of address"

payments.billToAddress.city

string

Example:

"Beaumont"

payments.billToAddress.state

string

Example:

"TX"

payments.billToAddress.country

string

Example:

"USA"

payments.billToAddress.postalCode

string

Example:

"77705"

payments.billToAddress.type

string

Example:

"residence"

payments.billToAddress.latitude

number

Latitude of the address

Example:

35.294952

payments.billToAddress.longitude

number

Longitude of the address

Example:

32.294952

payments.attributes

object

Additional information related to payment method, counter, and any other payment related process.

Show child attributes

payments.attributes.{key}

object

Example:

{ "expirationMonth": 12 }

Example:

{ "expirationMonth": 12 }

notes

object[]

Notes section to be used for CSR only

Show child attributes

notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

notes.user

string

Example:

"62272e917b12209e68751d94"

notes.notes

string

Example:

"Extra information to be provided"

Response

200

application/json

Order Created

Order response body

orderNumber

string

required

Unique order number

Example:

"309019176"

channelId

string

required

Sales channel ID

Example:

"12"

statusCode

string

required

Example:

"ORDER_CREATED"

items

object[]

required

OrderItem Model

Show child attributes

items.lineItemId

string

required

Example:

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

items.lineItemNumber

integer

required

Example:

1

items.itemId

string

required

Example:

"1234"

items.sku

string

required

Example:

"P1234"

items.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

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

items.channelId

string

Example:

"WHBM"

items.segment

string

Example:

"P1234"

items.vendorId

string

Example:

"P1234"

items.title

string

Example:

"Item"

items.type

string

Identify order type whether it's pickup item, or web ship, or international order

Example:

"WEB_SHIP"

items.subType

string

Example:

"Borderfree"

items.backorder

boolean

Identify whether this item has been ordered as backorder

Example:

true

items.orderedQuantity

integer

Example:

60

items.backOrderedQuantity

integer

Example:

10

items.pendingShippedQuantity

integer

Example:

10

items.pendingShippedBackOrderQuantity

integer

Example:

10

items.shippedQuantity

integer

Example:

10

items.deliveredQuantity

integer

Example:

10

items.invoiceQuantity

integer

Example:

10

items.cancelledQuantity

integer

Example:

10

items.pendingReturnQuantity

integer

Example:

10

items.processingReturnQuantity

integer

Example:

10

items.rejectedReturnQuantity

integer

Example:

10

items.returnedQuantity

integer

Example:

10

items.reshippedQuantity

integer

Example:

10

items.uom

string

Example:

"EA"

items.itemUnitPrice

number

Example:

10

items.itemSubTotal

number

Example:

600

items.originalItemSubTotal

number

Example:

600

items.itemFeeTotal

number

Example:

5

items.originalFeeTotal

number

Example:

5

items.itemShippingTotal

number

Example:

5

items.originalShippingTotal

number

Example:

5

items.appeasementTotal

number

Example:

5.5

items.itemDiscountsTotal

number

Example:

55

items.originalDiscounts

number

Example:

55

items.itemTaxTotal

number

Example:

5

items.originalTaxTotal

number

Example:

555

items.itemTotal

number

Example:

555

items.originalItemTotal

number

Example:

555

items.outstandingItemTotal

number

Example:

555

items.originalOutstandingItemTotal

number

Example:

555

items.invoiceTotal

number

Example:

555

items.currency

string

Example:

"USD"

items.employeeId

string

Example:

"5345HJH"

items.associateId

string

Example:

"5345HJH"

items.fees

object[]

OrderInvoiceDetail Model

Show child attributes

items.fees.type

string

Example:

"tax"

items.fees.value

number

Example:

34.56

items.fees.invoiceQuantity

integer

Example:

34

items.fees.refundAmount

number

Example:

10.4

items.fees.quantity

integer

Example:

12

items.appeasements

object[]

Order appeasement detail object

Show child attributes

items.appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

Example:

1

items.appeasements.reasonCode

string

Example:

"Incorrect item"

items.appeasements.subReasonCode

string

Example:

"Late shipping"

items.appeasements.value

number

Appeasement amount

Example:

34.56

items.appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

Example:

34.56

items.appeasements.payments

object[]

Array of appeasement payments

Order appeasement payment information object

Show child attributes

items.appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

Example:

1

items.appeasements.payments.refundAmount

number

Example:

40

items.returns

object[]

OrderReturns Model

Show child attributes

items.returns.shipmentId

string

Example:

"12353543"

items.returns.shipmentLineItemId

string

Example:

"2412341"

items.returns.shipmentQuantity

integer

Example:

1

items.returns.refundAmount

number

Example:

11.29

items.returns.invoicedAmount

number

Example:

11.29

items.returns.returnsCreatedAt

string

Example:

"2022-09-14T14:07:36.861Z"

items.taxCode

string

Example:

"FR01"

items.taxDetail

object[]

Show child attributes

items.taxDetail.type

string

Example:

"tax"

items.taxDetail.value

number

Example:

34.56

items.discounts

object[]

Order discount object

Show child attributes

items.discounts.quantity

integer

Example:

2

items.discounts.amount

number

Example:

2.4

items.discounts.unit

string

Example:

"AMOUNT_OFF"

items.discounts.value

integer

Example:

2

items.discounts.promoId

string

Example:

"HNY2022"

items.discounts.promoCode

string

Example:

"HNY2022"

items.discounts.promoTitle

string

Example:

"Happy New Year"

items.discounts.type

string

Example:

"promotion"

items.discounts.invoiceQuantity

integer

Example:

2

items.discounts.returnQuantity

integer

Example:

2

items.discounts.cancelQuantity

integer

Example:

2

items.attributes

object

Show child attributes

items.attributes.{key}

object

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

items.exchangeItem

boolean

Example:

true

items.parentLineItemNumber

integer

Example:

12

items.pendingExchangeQuantity

integer

Example:

12

items.exchangeQuantity

integer

Example:

13

items.refundAmount

number

Example:

12.4

items.lineOrderStatus

string

Example:

"VALID"

items.infiniteConsent

boolean

Example:

true

items.notes

object[]

Notes section to be used for CSR only

Show child attributes

items.notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

items.notes.user

string

Example:

"62272e917b12209e68751d94"

items.notes.notes

string

Example:

"Extra information to be provided"

items.gifting

boolean

Example:

true

shipInfo

object[]

required

Order shipping info

Show child attributes

shipInfo.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"5349b4ddd2781d08c09890f4"

shipInfo.taxCode

string

Code for the tax applied for shiping of items to the adress

Example:

"FR01"

shipInfo.locationNum

string

Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store

Example:

"123"

shipInfo.pickup

object[]

Details of the person who picks up the order

Show child attributes

shipInfo.pickup.name

object

Name for order details

Show child attributes

shipInfo.pickup.name.first

string

Example:

"John"

shipInfo.pickup.name.middle

string

Example:

"Middle"

shipInfo.pickup.name.last

string

Example:

"Doe"

shipInfo.pickup.email

string

Example:

"[e-mail]"

shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.pickup.phone.number

string

Example:

"55555555555"

shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

Example:

"Primary"

shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

shipInfo.shipToAddress.address1

string

required

Example:

"First line of address"

shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

shipInfo.shipToAddress.name.first

string

Example:

"John"

shipInfo.shipToAddress.name.middle

string

Example:

"Middle"

shipInfo.shipToAddress.name.last

string

Example:

"Doe"

shipInfo.shipToAddress.email

string

Example:

"[e-mail]"

shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.shipToAddress.phone.number

string

Example:

"55555555555"

shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.shipToAddress.address2

string

Example:

"123 Parking Lot"

shipInfo.shipToAddress.address3

string

Example:

"Third line of address"

shipInfo.shipToAddress.address4

string

Example:

"Fourth line of address"

shipInfo.shipToAddress.city

string

Example:

"Beaumont"

shipInfo.shipToAddress.state

string

Example:

"TX"

shipInfo.shipToAddress.country

string

Example:

"USA"

shipInfo.shipToAddress.postalCode

string

Example:

"77705"

shipInfo.shipToAddress.type

string

Example:

"residence"

shipInfo.shipToAddress.latitude

number

Latitude of the address

Example:

35.294952

shipInfo.shipToAddress.longitude

number

Longitude of the address

Example:

32.294952

shipInfo.taxDetail

object[]

Show child attributes

shipInfo.taxDetail.type

string

Example:

"tax"

shipInfo.taxDetail.value

number

Example:

34.56

shipInfo.shipMethod

string

Example:

"Express Delivery"

shipInfo.shipToType

string

Example:

"SHIP_TO_ADDRESS"

shipInfo.estimatedShipDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.estimatedDeliveryDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

Example:

20

shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

Example:

12.6

shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

Example:

12.6

shipInfo.shipmentInstructions

string

Additional user instructions

Example:

"User instructions"

shipInfo.attributes

object

Show child attributes

shipInfo.attributes.{key}

object

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

version

integer

Number of updates happened to the order. Order-update refers to replacement, appeasement added, address change or any other order related update to the particular order.

orderId

string

Auto generated ID once the order created successfully

Example:

"5349b4ddd2781d08c09890f4"

orderDate

string

Actual order creation date

Example:

"2022-05-12T09:30:31.198Z"

cancellationDate

string

Order cancellation date if any

Example:

"2022-05-12T09:30:31.198Z"

allocationDate

string

Order allocation date after order is created

Example:

"2022-05-12T09:30:31.198Z"

cartId

string

ID of the cart where order is placed

Example:

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

type

enum<string>

Platfrom using which order is created

Available options:

WEB,

CSC,

MOBILE_APP,

POS

Example:

"WEB"

subType

enum<string>

Operating system of the platfom as mentioned in the type field. If you want to configure any custom valuefor this field, contact fabric.

Available options:

IOS,

Android,

International

Example:

"International"

processName

string

Order process name

Example:

"CANCEL"

employeeId

string

Employee ID used when an employee places an order on behave of the customer.

Example:

"43278"

retail

object

Order retail object for reatil transactions. For non-retail transactions, only location number is provided.

Show child attributes

retail.locationNum

integer

Store number of line item's fulfillment origin.

Example:

123

retail.cashierId

string

Cashier ID in case of retail transaction.

Example:

"C-123"

retail.registerId

string

Registered user ID of the cashier who helps in creating the order. It is applicable for retail transactions.

Example:

"113"

retail.transactionId

string

Transaction ID incase of retail transaction.

Example:

"R123-431-1133-2129"

orderSubTotal

number

Order value after calculating discounts and any applicable fees

Example:

123.45

originalSubTotal

number

Original order total value

Example:

113.45

orderDiscount

number

Final discount value on order amount

Example:

1.23

originalDiscounts

number

Original discount on order value

Example:

1.45

feeTotal

number

Total fees, if any, applicable on order amount

Example:

12.34

originalFeeTotal

number

Original fees appliable on shipping of items

Example:

12.34

taxTotal

number

Total tax amount appliable on shipping of items

Example:

12.34

appeasementTotal

number

Appeasement amount, if any, processed on the order

Example:

12.34

originalTaxTotal

number

Original tax amount on order during fist time order creation

Example:

12.34

returnTotal

number

Return amount incase of order return

Example:

12.34

cancelTotal

number

Cancel amount incase of order cancellation

Example:

12.34

invoiceTotal

number

Invoice value on order

Example:

12.34

orderTotal

number

Total order amount after calculating fees, discounts, retrurn and cancellation if any

Example:

146.9

originalOrderTotal

number

Order amount during first time order creation after calculating all fees, taxes, and discounts

Example:

146.9

currency

string

Example:

"USD"

statusDescription

string

Example:

"Order Created"

attributes

object

Show child attributes

attributes.{key}

object

Example:

{
  "type": "String/Number/JSON",
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approve": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "0R12TQ46",
  "fraudScore": "31"
}

Example:

{
  "type": "String/Number/JSON",
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approve": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "0R12TQ46",
  "fraudScore": "31"
}

fees

object[]

Order fee detail model

Show child attributes

fees.type

string

Example:

"shipping"

fees.value

number

Example:

34.56

fees.invoiceValue

number

Example:

34.56

appeasements

object[]

Array of appeasements, if any

Order appeasement detail object

Show child attributes

appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

Example:

1

appeasements.reasonCode

string

Example:

"Incorrect item"

appeasements.subReasonCode

string

Example:

"Late shipping"

appeasements.value

number

Appeasement amount

Example:

34.56

appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

Example:

34.56

appeasements.payments

object[]

Array of appeasement payments

Order appeasement payment information object

Show child attributes

appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

Example:

1

appeasements.payments.refundAmount

number

Example:

40

discounts

object[]

Order discount object

Show child attributes

discounts.quantity

integer

Example:

2

discounts.amount

number

Example:

2.4

discounts.unit

string

Example:

"AMOUNT_OFF"

discounts.value

integer

Example:

2

discounts.promoId

string

Example:

"HNY2022"

discounts.promoCode

string

Example:

"HNY2022"

discounts.promoTitle

string

Example:

"Happy New Year"

discounts.type

string

Example:

"promotion"

discounts.invoiceQuantity

integer

Example:

2

discounts.returnQuantity

integer

Example:

2

discounts.cancelQuantity

integer

Example:

2

customer

object

Order customer model

Show child attributes

customer.name

object

Name for order details

Show child attributes

customer.name.first

string

Example:

"John"

customer.name.middle

string

Example:

"Middle"

customer.name.last

string

Example:

"Doe"

customer.email

string

Example:

"[e-mail]"

customer.phone

object

Contact details of customer for the order

Show child attributes

customer.phone.number

string

Example:

"55555555555"

customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

customer.userId

string

It is shopper's ID who visits company website to purchase products.

Example:

"62272e917b12209e68751d94"

customer.accountId

string

Account ID such as loyalty account ID or memebr account ID. Refers to any external system or fabric's loyalty service that the user has account with.

Example:

"62272e917b12209e68751d94"

customer.employeeId

string

ID of the employee (sales person) who creates an order for shopper.

Example:

"62272e917b12209e68751d94"

customer.company

string

Example:

"fabric"

payments

object[]

OrderPayment Model

Show child attributes

payments.paymentCounter

integer

Example:

1

payments.paymentDate

string

Example:

"2022-01-27T16:15:58-05:00"

payments.billToId

string

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier

object

OrderPaymentIdentifier Model

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits from cart number

Example:

"3456"

payments.paymentIdentifier.expirationYear

string

Card expiration year

Example:

"2029"

payments.paymentIdentifier.expirationMonth

string

Card expiration month

Example:

"2029"

payments.paymentIdentifier.paymentId

string

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier.fabricPaymentReference

string

Example:

"test"

payments.paymentProvider

string

Example:

"stripe"

payments.paymentToken

object

Payment token details

Show child attributes

payments.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

payments.paymentMethod

string

Example:

"CREDIT_CARD"

payments.authAmount

number

Example:

123.2

payments.chargedAmount

number

Example:

60

payments.refundAmount

number

Example:

40

payments.currency

string

Example:

"USD"

payments.conversion

number

Example:

1

payments.paymentStatus

string

Example:

"OK"

payments.partialCapture

string

Example:

"false"

payments.finalCapture

string

Example:

"false"

payments.paymentLog

object[]

PaymentResponse Model

Show child attributes

payments.paymentLog.paymentId

string

payments.paymentLog.status

string

payments.paymentLog.data

object

PaymentDetails Model

Show child attributes

payments.paymentLog.data.status

string

payments.paymentLog.data.body

object

PaymentDetailsResponseBody Model

Show child attributes

payments.paymentLog.data.body.transactionId

string

payments.paymentLog.data.body.transactionTimestamp

string

payments.paymentLog.data.body.responseCode

string

payments.paymentLog.data.body.status

string

payments.paymentLog.data.body.attributes

object

Show child attributes

payments.paymentLog.data.body.errors

object[]

Show child attributes

Example:

"payment response list"

payments.billToAddress

object

Order billing or shipping address

Show child attributes

payments.billToAddress.address1

string

required

Example:

"First line of address"

payments.billToAddress.name

object

Name for order details

Show child attributes

payments.billToAddress.name.first

string

Example:

"John"

payments.billToAddress.name.middle

string

Example:

"Middle"

payments.billToAddress.name.last

string

Example:

"Doe"

payments.billToAddress.email

string

Example:

"[e-mail]"

payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

payments.billToAddress.phone.number

string

Example:

"55555555555"

payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

payments.billToAddress.address2

string

Example:

"123 Parking Lot"

payments.billToAddress.address3

string

Example:

"Third line of address"

payments.billToAddress.address4

string

Example:

"Fourth line of address"

payments.billToAddress.city

string

Example:

"Beaumont"

payments.billToAddress.state

string

Example:

"TX"

payments.billToAddress.country

string

Example:

"USA"

payments.billToAddress.postalCode

string

Example:

"77705"

payments.billToAddress.type

string

Example:

"residence"

payments.billToAddress.latitude

number

Latitude of the address

Example:

35.294952

payments.billToAddress.longitude

number

Longitude of the address

Example:

32.294952

payments.attributes

object

Show child attributes

payments.attributes.{key}

object

Example:

{ "expirationMonth": 12 }

Example:

{ "expirationMonth": 12 }

auditLogs

object[]

OrderAuditLog Model

Show child attributes

auditLogs.auditId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditType

string

auditLogs.employeeId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditTimestamp

string

Example:

"2022-05-12T09:24:54.804Z"

auditLogs.source

string

Example:

"POS"

auditLogs.reasonCode

string

Example:

"POS"

auditLogs.subReasonCode

string

Example:

"POS"

auditLogs.policyCode

string

Example:

"POS"

auditLogs.note

string

Example:

"Note"

auditLogs.lineItemId

string

Example:

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

auditLogs.lineItemNumber

integer

Example:

1

auditLogs.sku

string

Example:

"F5F"

auditLogs.quantity

integer

Example:

1

auditLogs.amount

number

Example:

2.4

auditLogs.paymentToken

object

Payment token details

Show child attributes

auditLogs.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

auditLogs.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

auditLogs.success

boolean

Example:

true

auditLogs.paymentResponse

object

auditLogs.updatedFields

object[]

OrderAuditLogUpdatedField Model

Show child attributes

auditLogs.updatedFields.fieldName

string

Example:

"UOM"

auditLogs.updatedFields.fieldOriginalValue

string

Example:

"PK"

auditLogs.attributes

object

Show child attributes

auditLogs.attributes.{key}

object

notes

object[]

Show child attributes

notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

notes.user

string

Example:

"62272e917b12209e68751d94"

notes.notes

string

Example:

"Extra information to be provided"

orderReleaseTimestamp

string

Order dispatched date and time

createdAt

string

Date and time when the original order is modified for the first time, for example for return, cancellation or replacement

updatedAt

string

Date and time when the exisiting order is updated