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.

Body

application/json

Order object

channelId

string

required

Sales channel ID

items

object[]

required

Array of items for which order is processed

Show child attributes

items.itemId

string

required

Item ID

items.lineItemId

string

required

Cart item ID, generated automatically

items.lineItemNumber

integer

required

Cart item sequence number (starts at 1)

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.

items.sku

string

required

Itme SKU

items.associateId

string

items.attributes

object

Show child attributes

items.attributes.{key}

object

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

items.channelId

string

Sales channel ID of the item

items.currency

string

Currency used for order of items

items.discounts

object[]

Show child attributes

items.discounts.amount

number

items.discounts.promoCode

string

Coupon code to be applied to get the desired discount

items.discounts.promoId

string

System generated unique ID for the promotion

items.discounts.promoTitle

string

Promotion title

items.discounts.quantity

integer

Minimum quantity to be purchased for the discount to be applied

items.discounts.type

string

Type of promotion

items.discounts.unit

string

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

items.discounts.value

integer

Discount value

items.employeeId

string

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

items.fees

object[]

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

Show child attributes

items.fees.type

string

items.fees.value

number

items.itemDiscountsTotal

number

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

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.

items.itemSubTotal

number

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

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.

items.itemTotal

number

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

items.itemUnitPrice

number

Price set for each unit of item

items.notes

object[]

Notes section to be used for CSR only

Show child attributes

items.notes.notes

string

items.notes.timestamp

string

items.notes.user

string

items.orderedQuantity

integer

Quantity of items ordered

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.

items.subType

string

Provides additional information in relation to type

items.taxCode

string

Tax code applied, for the item, if any

items.taxDetail

object[]

Show child attributes

items.taxDetail.type

string

items.taxDetail.value

number

items.title

string

Title of the item

items.type

string

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

items.uom

string

Unit of measurement

items.vendorId

string

ID of vendor who sells the item

orderNumber

string

required

Unique order number to be provided by merchant

shipInfo

object[]

required

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.

shipInfo.attributes

object

Show child attributes

shipInfo.attributes.{key}

object

shipInfo.estimatedDeliveryDate

string

shipInfo.estimatedShipDate

string

shipInfo.locationNum

string

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

shipInfo.pickup

object[]

Show child attributes

shipInfo.pickup.email

string

shipInfo.pickup.name

object

Name for order details

Show child attributes

shipInfo.pickup.name.first

string

shipInfo.pickup.name.last

string

shipInfo.pickup.name.middle

string

shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.pickup.phone.number

string

shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

shipInfo.shipmentInstructions

string

Additional user instructions

shipInfo.shipMethod

string

shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

shipInfo.shipToAddress.address1

string

required

shipInfo.shipToAddress.address2

string

shipInfo.shipToAddress.address3

string

shipInfo.shipToAddress.address4

string

shipInfo.shipToAddress.city

string

shipInfo.shipToAddress.country

string

shipInfo.shipToAddress.email

string

shipInfo.shipToAddress.latitude

number

Latitude of the address

shipInfo.shipToAddress.longitude

number

Longitude of the address

shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

shipInfo.shipToAddress.name.first

string

shipInfo.shipToAddress.name.last

string

shipInfo.shipToAddress.name.middle

string

shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.shipToAddress.phone.number

string

shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.shipToAddress.postalCode

string

shipInfo.shipToAddress.state

string

shipInfo.shipToAddress.type

string

shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

shipInfo.shipToType

string

shipInfo.taxCode

string

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

shipInfo.taxDetail

object[]

Show child attributes

shipInfo.taxDetail.type

string

shipInfo.taxDetail.value

number

statusCode

string

required

Order status code

attributes

object

Show child attributes

attributes.{key}

object

cartId

string

ID of the cart for which order is created

currency

string

Currecy code used for order amount

customer

object

Order customer model

Show child attributes

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.

customer.company

string

customer.email

string

customer.employeeId

string

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

customer.name

object

Name for order details

Show child attributes

customer.name.first

string

customer.name.last

string

customer.name.middle

string

customer.phone

object

Contact details of customer for the order

Show child attributes

customer.phone.number

string

customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

customer.userId

string

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

discounts

object[]

Array of discount objects

Show child attributes

discounts.amount

number

discounts.promoCode

string

Coupon code to be applied to get the desired discount

discounts.promoId

string

System generated unique ID for the promotion

discounts.promoTitle

string

Promotion title

discounts.quantity

integer

Minimum quantity to be purchased for the discount to be applied

discounts.type

string

Type of promotion

discounts.unit

string

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

discounts.value

integer

Discount value

employeeId

string

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

fees

object[]

Show child attributes

fees.invoiceValue

number

fees.type

string

fees.value

number

feeTotal

number

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

notes

object[]

Notes section to be used for CSR only

Show child attributes

notes.notes

string

notes.timestamp

string

notes.user

string

orderDate

string

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

orderDiscount

number

Discounted amount

orderSubTotal

number

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

orderTotal

number

Total order value after calculating discount and tax values.

payments

object[]

Show child attributes

payments.attributes

object

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

Show child attributes

payments.attributes.{key}

object

payments.authAmount

number

Authorized amount to be charged for the order

payments.authExpirationDate

string

Payment authorization expiration date and time

payments.billToAddress

object

Order billing or shipping address

Show child attributes

payments.billToAddress.address1

string

required

payments.billToAddress.address2

string

payments.billToAddress.address3

string

payments.billToAddress.address4

string

payments.billToAddress.city

string

payments.billToAddress.country

string

payments.billToAddress.email

string

payments.billToAddress.latitude

number

Latitude of the address

payments.billToAddress.longitude

number

Longitude of the address

payments.billToAddress.name

object

Name for order details

Show child attributes

payments.billToAddress.name.first

string

payments.billToAddress.name.last

string

payments.billToAddress.name.middle

string

payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

payments.billToAddress.phone.number

string

payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

payments.billToAddress.postalCode

string

payments.billToAddress.state

string

payments.billToAddress.type

string

payments.billToId

string

Billing ID

payments.chargedAmount

number

Amount charged on the payment method

payments.conversion

number

Currency cenversion

payments.currency

string

Currency code for order amount

payments.paymentCounter

integer

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

payments.paymentDate

string

payments.paymentIdentifier

object

Order payment identifier model

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits of card number

payments.paymentIdentifier.expirationMonth

string

Card expiration month

payments.paymentIdentifier.expirationYear

string

Card expiration year

payments.paymentIdentifier.fabricPaymentReference

string

payments.paymentIdentifier.paymentId

string

Payment ID

payments.paymentMethod

string

payments.paymentProvider

string

Payment processing platform

payments.paymentStatus

string

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

payments.paymentToken

object

Payment token details

Show child attributes

payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

payments.paymentToken.token

string

Payment token generated by checkout service

retail

object

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

Show child attributes

retail.cashierId

string

Cashier ID in case of retail transaction.

retail.locationNum

integer

Store number of line item's fulfillment origin.

retail.registerId

string

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

retail.transactionId

string

Transaction ID incase of retail transaction.

statusDescription

string

Order status description

subType

enum<string>

Operating system of the platform mentioned in the type field.

Available options:

IOS,

Android,

International

taxTotal

number

Total tax amount applicable on the order subtotal value.

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

Response

200 - application/json

Order response body

channelId

string

required

Sales channel ID

items

object[]

required

Show child attributes

items.itemId

string

required

items.lineItemId

string

required

items.lineItemNumber

integer

required

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.

items.sku

string

required

items.appeasements

object[]

Show child attributes

items.appeasements.appeasementCounter

integer

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

items.appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

items.appeasements.payments

object[]

Array of appeasement payments

Show child attributes

items.appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

items.appeasements.payments.refundAmount

number

items.appeasements.reasonCode

string

items.appeasements.subReasonCode

string

items.appeasements.value

number

Appeasement amount

items.appeasementTotal

number

items.associateId

string

items.attributes

object

Show child attributes

items.attributes.{key}

object

items.backorder

boolean

Identify whether this item has been ordered as backorder

items.backOrderedQuantity

integer

items.cancelledQuantity

integer

items.channelId

string

items.currency

string

items.deliveredQuantity

integer

items.discounts

object[]

Show child attributes

items.discounts.amount

number

items.discounts.cancelQuantity

integer

items.discounts.invoiceQuantity

integer

items.discounts.promoCode

string

items.discounts.promoId

string

items.discounts.promoTitle

string

items.discounts.quantity

integer

items.discounts.returnQuantity

integer

items.discounts.type

string

items.discounts.unit

string

items.discounts.value

integer

items.employeeId

string

items.exchangeItem

boolean

items.exchangeQuantity

integer

items.fees

object[]

Show child attributes

items.fees.invoiceQuantity

integer

items.fees.quantity

integer

items.fees.refundAmount

number

items.fees.type

string

items.fees.value

number

items.gifting

boolean

items.infiniteConsent

boolean

items.invoiceQuantity

integer

items.invoiceTotal

number

items.itemDiscountsTotal

number

items.itemFeeTotal

number

items.itemShippingTotal

number

items.itemSubTotal

number

items.itemTaxTotal

number

items.itemTotal

number

items.itemUnitPrice

number

items.lineOrderStatus

string

items.notes

object[]

Notes section to be used for CSR only

Show child attributes

items.notes.notes

string

items.notes.timestamp

string

items.notes.user

string

items.orderedQuantity

integer

items.originalDiscounts

number

items.originalFeeTotal

number

items.originalItemSubTotal

number

items.originalItemTotal

number

items.originalOutstandingItemTotal

number

items.originalShippingTotal

number

items.originalTaxTotal

number

items.outstandingItemTotal

number

items.parentLineItemNumber

integer

items.pendingExchangeQuantity

integer

items.pendingReturnQuantity

integer

items.pendingShippedBackOrderQuantity

integer

items.pendingShippedQuantity

integer

items.processingReturnQuantity

integer

items.refundAmount

number

items.rejectedReturnQuantity

integer

items.reshippedQuantity

integer

items.returnedQuantity

integer

items.returns

object[]

Show child attributes

items.returns.invoicedAmount

number

items.returns.refundAmount

number

items.returns.returnsCreatedAt

string

items.returns.shipmentId

string

items.returns.shipmentLineItemId

string

items.returns.shipmentQuantity

integer

items.segment

string

items.shippedQuantity

integer

items.subType

string

items.taxCode

string

items.taxDetail

object[]

Show child attributes

items.taxDetail.type

string

items.taxDetail.value

number

items.title

string

items.type

string

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

items.uom

string

items.vendorId

string

orderNumber

string

required

Unique order number

shipInfo

object[]

required

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.

shipInfo.attributes

object

Show child attributes

shipInfo.attributes.{key}

object

shipInfo.estimatedDeliveryDate

string

shipInfo.estimatedShipDate

string

shipInfo.locationNum

string

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

shipInfo.pickup

object[]

Show child attributes

shipInfo.pickup.email

string

shipInfo.pickup.name

object

Name for order details

Show child attributes

shipInfo.pickup.name.first

string

shipInfo.pickup.name.last

string

shipInfo.pickup.name.middle

string

shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.pickup.phone.number

string

shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

shipInfo.shipmentInstructions

string

Additional user instructions

shipInfo.shipMethod

string

shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

shipInfo.shipToAddress.address1

string

required

shipInfo.shipToAddress.address2

string

shipInfo.shipToAddress.address3

string

shipInfo.shipToAddress.address4

string

shipInfo.shipToAddress.city

string

shipInfo.shipToAddress.country

string

shipInfo.shipToAddress.email

string

shipInfo.shipToAddress.latitude

number

Latitude of the address

shipInfo.shipToAddress.longitude

number

Longitude of the address

shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

shipInfo.shipToAddress.name.first

string

shipInfo.shipToAddress.name.last

string

shipInfo.shipToAddress.name.middle

string

shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.shipToAddress.phone.number

string

shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.shipToAddress.postalCode

string

shipInfo.shipToAddress.state

string

shipInfo.shipToAddress.type

string

shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

shipInfo.shipToType

string

shipInfo.taxCode

string

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

shipInfo.taxDetail

object[]

Show child attributes

shipInfo.taxDetail.type

string

shipInfo.taxDetail.value

number

statusCode

string

required

allocationDate

string

Order allocation date after order is created

appeasements

object[]

Array of appeasements, if any

Show child attributes

appeasements.appeasementCounter

integer

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

appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

appeasements.payments

object[]

Array of appeasement payments

Show child attributes

appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

appeasements.payments.refundAmount

number

appeasements.reasonCode

string

appeasements.subReasonCode

string

appeasements.value

number

Appeasement amount

appeasementTotal

number

Appeasement amount, if any, processed on the order

attributes

object

Show child attributes

attributes.{key}

object

auditLogs

object[]

Show child attributes

auditLogs.amount

number

auditLogs.attributes

object

Show child attributes

auditLogs.attributes.{key}

object

auditLogs.auditId

string

auditLogs.auditTimestamp

string

auditLogs.auditType

string

auditLogs.employeeId

string

auditLogs.lineItemId

string

auditLogs.lineItemNumber

integer

auditLogs.note

string

auditLogs.paymentResponse

object

auditLogs.paymentToken

object

Payment token details

Show child attributes

auditLogs.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

auditLogs.paymentToken.token

string

Payment token generated by checkout service

auditLogs.policyCode

string

auditLogs.quantity

integer

auditLogs.reasonCode

string

auditLogs.sku

string

auditLogs.source

string

auditLogs.subReasonCode

string

auditLogs.success

boolean

auditLogs.updatedFields

object[]

Show child attributes

auditLogs.updatedFields.fieldName

string

auditLogs.updatedFields.fieldOriginalValue

string

cancellationDate

string

Order cancellation date if any

cancelTotal

number

Cancel amount incase of order cancellation

cartId

string

ID of the cart where order is placed

createdAt

string

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

currency

string

customer

object

Order customer model

Show child attributes

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.

customer.company

string

customer.email

string

customer.employeeId

string

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

customer.name

object

Name for order details

Show child attributes

customer.name.first

string

customer.name.last

string

customer.name.middle

string

customer.phone

object

Contact details of customer for the order

Show child attributes

customer.phone.number

string

customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

customer.userId

string

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

discounts

object[]

Show child attributes

discounts.amount

number

discounts.cancelQuantity

integer

discounts.invoiceQuantity

integer

discounts.promoCode

string

discounts.promoId

string

discounts.promoTitle

string

discounts.quantity

integer

discounts.returnQuantity

integer

discounts.type

string

discounts.unit

string

discounts.value

integer

employeeId

string

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

fees

object[]

Show child attributes

fees.invoiceValue

number

fees.type

string

fees.value

number

feeTotal

number

Total fees, if any, applicable on order amount

invoiceTotal

number

Invoice value on order

notes

object[]

Show child attributes

notes.notes

string

notes.timestamp

string

notes.user

string

orderDate

string

Actual order creation date

orderDiscount

number

Final discount value on order amount

orderId

string

Auto generated ID once the order created successfully

orderReleaseTimestamp

string

Order dispatched date and time

orderSubTotal

number

Order value after calculating discounts and any applicable fees

orderTotal

number

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

originalDiscounts

number

Original discount on order value

originalFeeTotal

number

Original fees appliable on shipping of items

originalOrderTotal

number

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

originalSubTotal

number

Original order total value

originalTaxTotal

number

Original tax amount on order during fist time order creation

payments

object[]

Show child attributes

payments.attributes

object

Show child attributes

payments.attributes.{key}

object

payments.authAmount

number

payments.billToAddress

object

Order billing or shipping address

Show child attributes

payments.billToAddress.address1

string

required

payments.billToAddress.address2

string

payments.billToAddress.address3

string

payments.billToAddress.address4

string

payments.billToAddress.city

string

payments.billToAddress.country

string

payments.billToAddress.email

string

payments.billToAddress.latitude

number

Latitude of the address

payments.billToAddress.longitude

number

Longitude of the address

payments.billToAddress.name

object

Name for order details

Show child attributes

payments.billToAddress.name.first

string

payments.billToAddress.name.last

string

payments.billToAddress.name.middle

string

payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

payments.billToAddress.phone.number

string

payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

payments.billToAddress.postalCode

string

payments.billToAddress.state

string

payments.billToAddress.type

string

payments.billToId

string

payments.chargedAmount

number

payments.conversion

number

payments.currency

string

payments.finalCapture

string

payments.partialCapture

string

payments.paymentCounter

integer

payments.paymentDate

string

payments.paymentIdentifier

object

OrderPaymentIdentifier Model

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits from cart number

payments.paymentIdentifier.expirationMonth

string

Card expiration month

payments.paymentIdentifier.expirationYear

string

Card expiration year

payments.paymentIdentifier.fabricPaymentReference

string

payments.paymentIdentifier.paymentId

string

payments.paymentLog

object[]

Show child attributes

payments.paymentLog.data

object

PaymentDetails Model

Show child attributes

payments.paymentLog.data.body

object

PaymentDetailsResponseBody Model

Show child attributes

payments.paymentLog.data.body.attributes

object

Show child attributes

payments.paymentLog.data.body.errors

object[]

Show child attributes

payments.paymentLog.data.body.responseCode

string

payments.paymentLog.data.body.status

string

payments.paymentLog.data.body.transactionId

string

payments.paymentLog.data.body.transactionTimestamp

string

payments.paymentLog.data.status

string

payments.paymentLog.paymentId

string

payments.paymentLog.status

string

payments.paymentMethod

string

payments.paymentProvider

string

payments.paymentStatus

string

payments.paymentToken

object

Payment token details

Show child attributes

payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

payments.paymentToken.token

string

Payment token generated by checkout service

payments.refundAmount

number

processName

string

Order process name

retail

object

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

Show child attributes

retail.cashierId

string

Cashier ID in case of retail transaction.

retail.locationNum

integer

Store number of line item's fulfillment origin.

retail.registerId

string

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

retail.transactionId

string

Transaction ID incase of retail transaction.

returnTotal

number

Return amount incase of order return

statusDescription

string

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

taxTotal

number

Total tax amount appliable on shipping of items

type

enum<string>

Platfrom using which order is created

Available options:

WEB,

CSC,

MOBILE_APP,

POS

updatedAt

string

Date and time when the exisiting order is updated

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.