Get order draft by ID

Get order draft details by order draft ID.

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.

Path Parameters

id

string

required

Order draft ID

Response

200 - application/json

Order draft response

cartId

string

required

Cart ID

createdAt

string

required

Time order draft was created

currency

string

required

Currency code

items

object[]

required

Show child attributes

items.isPickup

boolean

required

true: Item is set for pickup<br />false: Item is set for delivery

items.itemId

string | null

required

Item ID

items.items

object[]

required

Cart item details

Show child attributes

items.items.quantity

integer

required

total quantity of the line item

items.items.sku

string

required

Item SKU

items.items.attributes

object[] | null

Additional item options

Show child attributes

items.items.attributes.attributeId

string

required

Attribute ID

items.items.attributes.name

string

required

Attribute name

items.items.attributes.price

number

required

Attribute price

items.items.attributes.type

string

required

Attribute type

items.items.attributes.description

string | null

Attribute description

items.items.attributes.items

string[] | null

items.items.attributes.level

string | null

Attribute level

items.items.attributes.mapping

string | null

ITEM: Item-level attribute<br />ORDER: Cart-level attribute

items.items.attributes.value

string | null

Attribute applicability

items.items.attributeTotalPrice

number | null

Total price of item attributes

items.items.cartItemId

string | null

Cart item ID

items.items.channel

number

Sales channel

items.items.createdAt

string | null

Item creation time

items.items.extra

object | null

Extra metadata passed by caller

items.items.fulfillment

object

Item details for order fulfillment

Show child attributes

items.items.fulfillment.channelId

string | null

Specifies the channel of inventory for item

items.items.fulfillment.inventory

object

Inventory details of the cart item

Show child attributes

items.items.fulfillment.inventory.attributes

object

Custom inventory attributes configured by the merchant

items.items.fulfillment.inventory.backOrderDate

string

Inventory restock date

items.items.fulfillment.inventory.backOrderLimit

integer

Maximum restock inventory quantity

items.items.fulfillment.inventory.channelId

string

Sales channel ID. This field is used to identify where the business operations are being held.

items.items.fulfillment.inventory.counters

object

Inventory counter (also known as inventory position) configured by the merchant

items.items.fulfillment.inventory.id

string

Inventory ID

items.items.fulfillment.inventory.infiniteInventory

boolean

Infinite inventory flag.<br /> true indicates that the inventory can be consumed any number of times as per need<br />false indicates that the inventory cannot be used infinitely, and has a limit to be consumed

items.items.fulfillment.inventory.inventoryType

string

Type of inventory

items.items.fulfillment.inventory.itemId

integer

Item ID for which inventory is updated

items.items.fulfillment.inventory.leadTime

string

The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse

items.items.fulfillment.inventory.locationNum

integer

Location number is used to identify the warehouse or location where the inventory is kept

items.items.fulfillment.inventory.lowStock

integer

Inventory quantity to mark as low stock at the location

items.items.fulfillment.inventory.preOrderDate

string

First ship date of inventory

items.items.fulfillment.inventory.preOrderLimit

integer

Maximum quanity of inventory for first-ship

items.items.fulfillment.inventory.region

string

Region where inventory is managed

items.items.fulfillment.inventory.safetyStock

integer

Reserved inventory quantity at the location

items.items.fulfillment.inventory.segment

string

Inventory segment

items.items.fulfillment.inventory.sku

string

SKU of the item

items.items.fulfillment.inventory.vendorId

string

Vendor ID

items.items.fulfillment.inventory.virtualCounters

object

View quantity of inventory, based on pre configured value. For example, 'availableToPurchase' can be a custom attribute configured by merchants.

items.items.fulfillment.inventoryType

string | null

Specifies the type of inventory for item

items.items.fulfillment.networkCode

string | null

Specifies the network of inventory for item

items.items.fulfillment.type

string | null

Type of order fulfillment

items.items.group

string[] | null

items.items.isActive

boolean

default:

true

true = Item is active<br />false = Item is not active

items.items.isPickup

boolean

true: Item is set for pickup<br />false: Item is set for delivery

items.items.itemId

string | null

Item ID

items.items.items

any

items.items.lineItemId

integer

Cart item sequence number (starts at 1)

Required range: x > 1

items.items.priceListId

string | null

Item price list ID

items.items.shipTo

object

Shipment details

Show child attributes

items.items.shipTo.address

object

Shipping address

Show child attributes

items.items.shipTo.address.attention

string | null

Address recipient

items.items.shipTo.address.city

string | null

City name

items.items.shipTo.address.country

string | null

Country name

items.items.shipTo.address.email

string | null

Receiver's email address

items.items.shipTo.address.kind

string | null

Address type

items.items.shipTo.address.name

object

Recipient's name

Show child attributes

items.items.shipTo.address.phone

object

address details for the shipping

Show child attributes

items.items.shipTo.address.state

string | null

State name

items.items.shipTo.address.street1

string | null

Address line 1

items.items.shipTo.address.street2

string | null

Address line 2

items.items.shipTo.address.street3

string | null

Address line 3

items.items.shipTo.address.street4

string | null

Address line 4

items.items.shipTo.address.zipCode

string | null

Zip code

items.items.shipTo.altPickupPerson

object

Alternative pickup person

Show child attributes

items.items.shipTo.altPickupPerson.email

string | null

Receiver's email address

items.items.shipTo.altPickupPerson.name

object

Name of pickup person

Show child attributes

items.items.shipTo.altPickupPerson.phone

object

Number of pickup person

Show child attributes

items.items.shipTo.cartId

string | null

Cart ID

items.items.shipTo.createdAt

string | null

Shipping details creation time

items.items.shipTo.isPickup

boolean

true = Item is set for pickup<br />false = Item is set for delivery

items.items.shipTo.pickupPerson

object

Designated pickup person

Show child attributes

items.items.shipTo.pickupPerson.email

string | null

Receiver's email address

items.items.shipTo.pickupPerson.name

object

Name of pickup person

Show child attributes

items.items.shipTo.pickupPerson.phone

object

Number of pickup person

Show child attributes

items.items.shipTo.shipMethod

object

Shipping method and details

Show child attributes

items.items.shipTo.shipMethod.cost

object

Shipping cost

Show child attributes

items.items.shipTo.shipMethod.shipmentCarrier

string | null

Shipment carrier

items.items.shipTo.shipMethod.shipmentMethod

string | null

Shipment method type

items.items.shipTo.shipMethod.shipMethodId

string

Shipping method ID

items.items.shipTo.shipToId

string | null

Shipping details ID

items.items.shipTo.shipToType

string | null

Shipping type

items.items.shipTo.storeId

string | null

Store ID

items.items.shipTo.taxCode

string | null

Shipping tax code

items.items.shipTo.updatedAt

string | null

Last time shipping details were updated

items.items.shipTo.warehouseId

string | null

Warehouse ID

items.items.shipToId

string | null

Shipping ID

items.items.subType

string | null

ItemSubType(For International type, provide subType as Border-free)

items.items.title

string | null

Item name

items.items.totalPrice

object

Total price for the full quantity of this item

Show child attributes

items.items.totalPrice.amount

number

required

Price before discount

items.items.totalPrice.currency

string

default:

USD

required

Currency type

items.items.totalPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.items.totalPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

items.items.totalPrice.discount.price

number

required

Discounted price of the item

Required range: x > 0

items.items.totalPrice.discount.promosApplied

object[]

required

Show child attributes

items.items.totalPrice.discount.discountAmount

number

Discounted percentage amount of the item

Required range: x > 0

items.items.totalPrice.sale

number | null

Price after discount

items.items.type

string | null

ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)

items.items.unitPrice

object

Individual item price

Show child attributes

items.items.unitPrice.amount

number

required

Price before discount

items.items.unitPrice.currency

string

default:

USD

required

Currency type

items.items.unitPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.items.unitPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

items.items.unitPrice.discount.price

number

required

Discounted price of the item

Required range: x > 0

items.items.unitPrice.discount.promosApplied

object[]

required

Show child attributes

items.items.unitPrice.discount.discountAmount

number

Discounted percentage amount of the item

Required range: x > 0

items.items.unitPrice.sale

number | null

Price after discount

items.items.updatedAt

string | null

Last time item was updated

items.items.warehouseId

string | null

Warehouse ID

items.lineItemId

integer | null

required

Cart item sequence number (starts at 1)

Required range: x > 1

items.quantity

integer

required

Number of items in cart

items.sku

string

required

Item SKU

items.attributes

object[] | null

Additional item options

Show child attributes

items.attributes.attributeId

string

required

Attribute ID

items.attributes.name

string

required

Attribute name

items.attributes.price

number

required

Attribute price

items.attributes.type

string

required

Attribute type

items.attributes.description

string | null

Attribute description

items.attributes.items

string[] | null

items.attributes.level

string | null

Attribute level

items.attributes.mapping

string | null

ITEM: Item-level attribute<br />ORDER: Cart-level attribute

items.attributes.value

string | null

Attribute applicability

items.attributeTotalPrice

number | null

Total price of attributes

items.cartItemId

string | null

Cart item ID

items.channel

number | null

Sales channel

items.createdAt

string | null

Item creation time

items.fees

object[] | null

Fees associated with a specific cart or an individual line item of a cart

Show child attributes

items.fees.amount

number

default:

0

Fee amount

items.fees.attributes

object | null

Placeholder for additional information in key:value pairs

items.fees.feeId

string

System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.

items.fees.name

string | null

Attribute for which fee is applied

items.fees.type

string | null

Fee type

items.group

string[] | null

items.isActive

boolean | null

true = Item is active<br />false = Item is not active

items.itemTaxTotal

number | null

Total tax on item

items.priceAdjustments

object[] | null

List of price adjustments for the line item

Show child attributes

items.priceAdjustments.amount

number

required

Amount by which the line item's total amount or the specified cart's total amount is adjusted

Required range: x > 0

items.priceAdjustments.id

string

required

Price adjustment ID; it identifies a single price adjustment object from the list of price adjustments.

items.priceAdjustments.reason

string

required

Price adjustment reason

items.priceAdjustments.attributes

object | null

Placeholder for additional information

items.priceListId

string | null

Item price list ID

items.shipTo

object

Shipment details

Show child attributes

items.shipTo.address

object

Shipping address

Show child attributes

items.shipTo.address.attention

string | null

Address recipient

items.shipTo.address.city

string | null

City name

items.shipTo.address.country

string | null

Country name

items.shipTo.address.email

string | null

Receiver's email address

items.shipTo.address.kind

string | null

Address type

items.shipTo.address.name

object

Recipient's name

Show child attributes

items.shipTo.address.name.first

string | null

Individual's first name

items.shipTo.address.name.last

string | null

Individual's last name

items.shipTo.address.name.middle

string | null

Individual's middle name or initial

items.shipTo.address.phone

object

address details for the shipping

Show child attributes

items.shipTo.address.phone.number

string

required

Phone number

items.shipTo.address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

items.shipTo.address.state

string | null

State name

items.shipTo.address.street1

string | null

Address line 1

items.shipTo.address.street2

string | null

Address line 2

items.shipTo.address.street3

string | null

Address line 3

items.shipTo.address.street4

string | null

Address line 4

items.shipTo.address.zipCode

string | null

Zip code

items.shipTo.altPickupPerson

object

Alternative pickup person

Show child attributes

items.shipTo.altPickupPerson.email

string | null

Receiver's email address

items.shipTo.altPickupPerson.name

object

Name of pickup person

Show child attributes

items.shipTo.altPickupPerson.name.first

string | null

Individual's first name

items.shipTo.altPickupPerson.name.last

string | null

Individual's last name

items.shipTo.altPickupPerson.name.middle

string | null

Individual's middle name or initial

items.shipTo.altPickupPerson.phone

object

Number of pickup person

Show child attributes

items.shipTo.altPickupPerson.phone.number

string

required

Phone number

items.shipTo.altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

items.shipTo.cartId

string | null

Cart ID

items.shipTo.createdAt

string | null

Shipping details creation time

items.shipTo.isPickup

boolean

true = Item is set for pickup<br />false = Item is set for delivery

items.shipTo.pickupPerson

object

Designated pickup person

Show child attributes

items.shipTo.pickupPerson.email

string | null

Receiver's email address

items.shipTo.pickupPerson.name

object

Name of pickup person

Show child attributes

items.shipTo.pickupPerson.name.first

string | null

Individual's first name

items.shipTo.pickupPerson.name.last

string | null

Individual's last name

items.shipTo.pickupPerson.name.middle

string | null

Individual's middle name or initial

items.shipTo.pickupPerson.phone

object

Number of pickup person

Show child attributes

items.shipTo.pickupPerson.phone.number

string

required

Phone number

items.shipTo.pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

items.shipTo.shipMethod

object

Shipping method and details

Show child attributes

items.shipTo.shipMethod.cost

object

Shipping cost

Show child attributes

items.shipTo.shipMethod.cost.amount

number

required

Shipping cost

items.shipTo.shipMethod.cost.currency

string | null

Currency type

items.shipTo.shipMethod.cost.discount

number | null

Shipping discount

items.shipTo.shipMethod.shipmentCarrier

string | null

Shipment carrier

items.shipTo.shipMethod.shipmentMethod

string | null

Shipment method type

items.shipTo.shipMethod.shipMethodId

string

Shipping method ID

items.shipTo.shipToId

string | null

Shipping details ID

items.shipTo.shipToType

string | null

Shipping type

items.shipTo.storeId

string | null

Store ID

items.shipTo.taxCode

string | null

Shipping tax code

items.shipTo.updatedAt

string | null

Last time shipping details were updated

items.shipTo.warehouseId

string | null

Warehouse ID

items.subType

string | null

Item sub type. For International type, provide subType as Borderfree.

items.taxCode

string | null

Tax code for an item

items.taxDetail

object

Item tax details

Show child attributes

items.taxDetail.amount

number | null

Tax amount

items.taxDetail.rate

number | null

Rate

items.taxDetail.rateType

string | null

Rate type

items.taxDetail.type

string | null

Tax type

items.title

string | null

Item name

items.totalPrice

object

Total price for the full quantity of this item

Show child attributes

items.totalPrice.amount

number

required

Price before discount

items.totalPrice.currency

string

default:

USD

required

Currency type

items.totalPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.totalPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

items.totalPrice.discount.discounts.promoId

string

required

Unique promotion/coupon ID

items.totalPrice.discount.discounts.amount

number | null

Total amount of discount applied

items.totalPrice.discount.discounts.groupId

string | null

Promotion group ID

items.totalPrice.discount.discounts.itemId

string | null

ID of item to which promotion is applied

items.totalPrice.discount.discounts.itemKey

string | null

Key of item to which promotion is applied

items.totalPrice.discount.discounts.message

string | null

Coupon code description

items.totalPrice.discount.discounts.priority

integer | null

Promotion priority

items.totalPrice.discount.discounts.promoCode

string | null

General promotion/coupon code

items.totalPrice.discount.discounts.promotionType

string | null

Promotion type

items.totalPrice.discount.discounts.promoTitle

string | null

Promotion name

items.totalPrice.discount.discounts.proratedAmount

number | null

The prorated discount amount.

items.totalPrice.discount.discounts.proratedQuantity

integer | null

The proratedQuantity is used in conjunction with proratedAmount to determine the discount portion allocated to the respective units of BuyGet promotions. This is applicable in partial return scenarios.

items.totalPrice.discount.discounts.quantity

integer | null

Quantity of this item in the cart

items.totalPrice.discount.discounts.sku

string | null

Item SKU to which promotion is applied

items.totalPrice.discount.discounts.stackable

boolean | null

true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions

items.totalPrice.discount.discounts.unit

string | null

Discount unit

items.totalPrice.discount.discounts.value

number | null

Promotion value

items.totalPrice.discount.price

number

required

Discounted price of the item

Required range: x > 0

items.totalPrice.discount.promosApplied

object[]

required

Show child attributes

items.totalPrice.discount.promosApplied.promoId

string

required

Unique promotion/coupon ID

items.totalPrice.discount.promosApplied.promoCode

string | null

General promotion/coupon code

items.totalPrice.discount.promosApplied.unit

string | null

Promotion/coupon code discount unit

items.totalPrice.discount.promosApplied.value

string | null

Promotion/coupon code discount value

items.totalPrice.discount.discountAmount

number

Discounted percentage amount of the item

Required range: x > 0

items.totalPrice.sale

number | null

Price after discount

items.type

string | null

ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)

items.unitPrice

object

Individual item price

Show child attributes

items.unitPrice.amount

number

required

Price before discount

items.unitPrice.currency

string

default:

USD

required

Currency type

items.unitPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.unitPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

items.unitPrice.discount.discounts.promoId

string

required

Unique promotion/coupon ID

items.unitPrice.discount.discounts.amount

number | null

Total amount of discount applied

items.unitPrice.discount.discounts.groupId

string | null

Promotion group ID

items.unitPrice.discount.discounts.itemId

string | null

ID of item to which promotion is applied

items.unitPrice.discount.discounts.itemKey

string | null

Key of item to which promotion is applied

items.unitPrice.discount.discounts.message

string | null

Coupon code description

items.unitPrice.discount.discounts.priority

integer | null

Promotion priority

items.unitPrice.discount.discounts.promoCode

string | null

General promotion/coupon code

items.unitPrice.discount.discounts.promotionType

string | null

Promotion type

items.unitPrice.discount.discounts.promoTitle

string | null

Promotion name

items.unitPrice.discount.discounts.proratedAmount

number | null

The prorated discount amount.

items.unitPrice.discount.discounts.proratedQuantity

integer | null

The proratedQuantity is used in conjunction with proratedAmount to determine the discount portion allocated to the respective units of BuyGet promotions. This is applicable in partial return scenarios.

items.unitPrice.discount.discounts.quantity

integer | null

Quantity of this item in the cart

items.unitPrice.discount.discounts.sku

string | null

Item SKU to which promotion is applied

items.unitPrice.discount.discounts.stackable

boolean | null

true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions

items.unitPrice.discount.discounts.unit

string | null

Discount unit

items.unitPrice.discount.discounts.value

number | null

Promotion value

items.unitPrice.discount.price

number

required

Discounted price of the item

Required range: x > 0

items.unitPrice.discount.promosApplied

object[]

required

Show child attributes

items.unitPrice.discount.promosApplied.promoId

string

required

Unique promotion/coupon ID

items.unitPrice.discount.promosApplied.promoCode

string | null

General promotion/coupon code

items.unitPrice.discount.promosApplied.unit

string | null

Promotion/coupon code discount unit

items.unitPrice.discount.promosApplied.value

string | null

Promotion/coupon code discount value

items.unitPrice.discount.discountAmount

number

Discounted percentage amount of the item

Required range: x > 0

items.unitPrice.sale

number | null

Price after discount

items.uom

string | null

Unit Of measure

items.updatedAt

string | null

Last time item was updated

items.warehouseId

string | null

Warehouse ID

orderDiscount

number

required

Total discount applied on the order

orderStatus

object

required

Show child attributes

orderStatus.paymentStatus

any

orderStatus.ready

boolean

default:

false

true: Order draft is ready to generate the final order.<br />false: Order draft is not ready.

orderSubTotal

number

required

Total amount for the order without discounts

orderTotal

number

required

Total amount for the order

shipInfo

object[]

required

Show child attributes

shipInfo.address

object

Shipping address

Show child attributes

shipInfo.address.attention

string | null

Address recipient

shipInfo.address.city

string | null

City name

shipInfo.address.country

string | null

Country name

shipInfo.address.email

string | null

Receiver's email address

shipInfo.address.kind

string | null

Address type

shipInfo.address.name

object

Recipient's name

Show child attributes

shipInfo.address.name.first

string | null

Individual's first name

shipInfo.address.name.last

string | null

Individual's last name

shipInfo.address.name.middle

string | null

Individual's middle name or initial

shipInfo.address.phone

object

address details for the shipping

Show child attributes

shipInfo.address.phone.number

string

required

Phone number

shipInfo.address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.address.state

string | null

State name

shipInfo.address.street1

string | null

Address line 1

shipInfo.address.street2

string | null

Address line 2

shipInfo.address.street3

string | null

Address line 3

shipInfo.address.street4

string | null

Address line 4

shipInfo.address.zipCode

string | null

Zip code

shipInfo.altPickupPerson

object

Alternative pickup person

Show child attributes

shipInfo.altPickupPerson.email

string | null

Receiver's email address

shipInfo.altPickupPerson.name

object

Name of pickup person

Show child attributes

shipInfo.altPickupPerson.name.first

string | null

Individual's first name

shipInfo.altPickupPerson.name.last

string | null

Individual's last name

shipInfo.altPickupPerson.name.middle

string | null

Individual's middle name or initial

shipInfo.altPickupPerson.phone

object

Number of pickup person

Show child attributes

shipInfo.altPickupPerson.phone.number

string

required

Phone number

shipInfo.altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.cartId

string | null

Cart ID

shipInfo.createdAt

string | null

Shipping details creation time

shipInfo.estimatedDeliveryDate

string | null

Estimated date for delivery

shipInfo.estimatedShipDate

string | null

Estimated date for shipping

shipInfo.isPickup

boolean

true: Item is set for pickup<br />false: Item is set for delivery

shipInfo.pickupPerson

object

Designated pickup person

Show child attributes

shipInfo.pickupPerson.email

string | null

Receiver's email address

shipInfo.pickupPerson.name

object

Name of pickup person

Show child attributes

shipInfo.pickupPerson.name.first

string | null

Individual's first name

shipInfo.pickupPerson.name.last

string | null

Individual's last name

shipInfo.pickupPerson.name.middle

string | null

Individual's middle name or initial

shipInfo.pickupPerson.phone

object

Number of pickup person

Show child attributes

shipInfo.pickupPerson.phone.number

string

required

Phone number

shipInfo.pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

shipInfo.shipmentInstructions

string | null

Store ID

shipInfo.shipMethod

object

Shipping method and details

Show child attributes

shipInfo.shipMethod.cost

object

Shipping cost

Show child attributes

shipInfo.shipMethod.cost.amount

number

required

Shipping cost

shipInfo.shipMethod.cost.currency

string | null

Currency type

shipInfo.shipMethod.cost.discount

number | null

Shipping discount

shipInfo.shipMethod.shipmentCarrier

string | null

Shipment carrier

shipInfo.shipMethod.shipmentMethod

string | null

Shipment method type

shipInfo.shipMethod.shipMethodId

string

Shipping method ID

shipInfo.shipToId

string | null

Shipping details ID

shipInfo.shipToType

string | null

Shipping type

shipInfo.storeId

string | null

Store ID

shipInfo.taxCode

string | null

Shipping tax code

shipInfo.updatedAt

string | null

Last time shipping details were updated

shipInfo.warehouseId

string | null

Warehouse ID

taxTotal

number

required

Total tax applied on the order

accountId

string | null

Customer account ID

attributes

object | null

Cart metadata

configuration

object

Cart configuration

Show child attributes

configuration.addItemBySku

boolean

default:

false

true: Item can be added to cart by SKU; itemId is not mandatory to add an item to cart <br/> false: itemId is mandatory to add item to cart

configuration.allowAnonymousUser

boolean | null

default:

true

true: Allows a cart to be a guest cart.<br />false: Allows cart only if user is logged in.

configuration.inventory

object

Show child attributes

configuration.inventory.expiredDataBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.inventory.newItemBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.inventory.source

enum<string>

Source of an order number

Available options:

FABRIC,

EXTERNAL,

NONE

configuration.inventory.ttl

integer | null

Expiry time in seconds

configuration.inventory.updateItemBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.inventory.viewItemBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.orderNumberSource

enum<string>

Determines how an order number is created

Available options:

CART_ID,

FABRIC,

EXTERNAL,

NONE

configuration.softReserve

boolean | null

default:

false

true: Soft reserve is used for an inventory check.<br/> false: Soft reserve is not used for an inventory check.

customer

object

Customer details

Show child attributes

customer.attributes

string | null

Customer attributes

customer.id

string | null

Customer ID

customer.segments

string | null

Customer segments

customer.type

string | null

Customer type

error

object

error object

Show child attributes

error.code

enum<string>

required

Error code

Available options:

UNKNOWN_ERROR,

BAD_REQUEST,

INVALID_TOKEN,

ACCOUNT_ID_NOT_CONFIGURED,

ACCOUNT_ID_ALREADY_EXISTS,

DEPLOYMENT_IN_PROGRESS,

INVALID_CART_ID,

CART_NOT_FOUND,

ITEM_NOT_FOUND,

UNABLE_TO_GET_CART,

UNABLE_TO_GET_INVENTORY,

ITEM_OUT_OF_STOCK,

UPDATE_CART_ERROR,

DELETE_CART_ATTRIBUTE_ERROR,

EMPTY_CART_ERROR,

UNABLE_TO_GET_PRICE,

UNABLE_TO_GET_PROMO,

UNABLE_TO_GET_ITEM,

PROMO_ALREADY_APPLIED_ERROR,

CART_ALREADY_SHARED_ERROR,

PROMO_NOT_FOUND_ERROR,

PROMO_NOT_APPLICABLE_ERROR,

USER_NOT_FOUND,

ATTRIBUTE_NOT_FOUND,

INCORRECT_ATTRIBUTE_LEVEL,

INCORRECT_ATTRIBUTE_VALUE,

ITEM_ATTRIBUTE_ALREADY_EXIST,

LINE_ITEM_ID_NOT_FOUND,

ITEM_ID_NOT_APPLICABLE,

CART_STATUS_NOT_FOUND,

CART_STATUS_CANNOT_BE_UPDATED,

GUEST_CART_STATUS_CANNOT_BE_UPDATED,

CART_STATUS_ALREADY_ASSIGNED,

TOKEN_INTROSPECT_ERROR,

MAX_CARTS_LIMIT_REACHED,

UNAUTHORIZED_USER_ERROR,

API_PERMISSION_UNDEFINED,

INVALID_DATE_RANGE,

INVALID_DATE_FORMAT,

INVALID_SEARCH_ATTRIBUTE,

ITEM_SERVICE_NOT_CONFIGURED,

ATTRIBUTE_SERVICE_NOT_CONFIGURED,

SHIP_ID_NOT_FOUND,

NEGATIVE_SHIPPING_COST,

REQUEST_DENIED,

BAD_CONFIGURATION,

SERVICE_NOT_ENABLED

error.detail

string

required

Error detail

error.itemId

string | null

ID of item to which exception applies

error.lineItemId

integer

Cart item sequence number (starts at 1)

Required range: x > 1

error.sku

string | null

SKU of item to which exception applies

fees

object[] | null

Fees associated with a specific cart or an individual line item of a cart

Show child attributes

fees.amount

number

default:

0

Fee amount

fees.attributes

object | null

Placeholder for additional information in key:value pairs

fees.feeId

string

System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.

fees.name

string | null

Attribute for which fee is applied

fees.type

string | null

Fee type

orderNumber

string | null

Order number

orderSubType

string | null

Order sub type (Android/IOS/International)

orderTotalFees

number | null

Total fees applied on the order

orderType

string | null

Order type (WEB, CSC, MOBILE_APP, POS)

payments

object[] | null

Show child attributes

payments.amount

number | null

required

Payment amount

payments.billToAddress

object

required

Billing address for the order

Show child attributes

payments.billToAddress.city

string

required

City name

payments.billToAddress.country

string

required

Country name

payments.billToAddress.customerId

string

required

Customer ID created for payment instruction

payments.billToAddress.postalCode

string

required

Postal code

payments.billToAddress.state

string

required

State name

payments.billToAddress.street1

string

required

Address line 1

payments.billToAddress.email

string | null

Receiver's email address

payments.billToAddress.latitude

number | null

Latitude

payments.billToAddress.longitude

number | null

Longitude

payments.billToAddress.name

object

Recipient's name

Show child attributes

payments.billToAddress.name.first

string | null

Individual's first name

payments.billToAddress.name.last

string | null

Individual's last name

payments.billToAddress.name.middle

string | null

Individual's middle name or initial

payments.billToAddress.phone

object

Recipient's phone number details

Show child attributes

payments.billToAddress.phone.number

string

required

Phone number

payments.billToAddress.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

payments.billToAddress.street2

string | null

Address line 2

payments.billToAddress.street3

string | null

Address line 3

payments.billToAddress.street4

string | null

Address line 4

payments.billToAddress.type

string | null

Address type

payments.connectorName

string

required

Payment connector name

payments.conversion

number

default:

1

required

Currency Conversion (For USD = 1, For Non-USD = conversion ratio to USD)

payments.currency

string

required

Currency code

payments.paymentToken

string

required

Payment token identifier

payments.attributes

object | null

Payment Attributes

payments.paymentMethod

string | null

Payment method

payments.paymentMethodType

string | null

Payment method type

totalItems

integer | null

Total number of items in the cart

totalUniqueItems

integer | null

Total number of unique line items in the cart