Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Create order draft
Create an order draft for a given cart. During the order draft creation process, payment details are validated before generating the draft. Additionally, it triggers an event if the “ORDER_DRAFT” webhook event is subscribed.
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.
ID of the cart for which order draft will be generated
Sample request to create order draft
Order number
Order sequence details
Sequence module name
Sequence format or variant
Customer details
Customer ID
Customer type
Customer segments
Customer attributes
Payment details
Estimated tax object
Order type (WEB, CSC, MOBILE_APP, POS)
Order sub type (Android/IOS/International)
Headers
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 of the cart for which order draft will be generated
Body
Sample request to create order draft
Payment details
Payment connector name
Payment method
Payment method type
Payment token identifier
Payment amount
Currency code
Currency Conversion (For USD = 1, For Non-USD = conversion ratio to USD)
Billing address for the order
Address line 1
City name
State name
Country name
Postal code
Customer ID created for payment instruction
Receiver's email address
Address line 2
Address line 3
Address line 4
Address type
Latitude
Longitude
Payment Attributes
Estimated tax object
Order number
Order type (WEB, CSC, MOBILE_APP, POS)
Order sub type (Android/IOS/International)
Response
Order draft response
Cart ID
Total amount for the order
Total amount for the order without discounts
Total tax applied on the order
Total discount applied on the order
Currency code
Time order draft was created
Cart item ID
Item ID
Item name
Item SKU
Cart item details
Cart item ID
Item ID
Item name
Item SKU
Additional item options
Attribute ID
Attribute name
Attribute description
ITEM: Item-level attribute<br />ORDER: Cart-level attribute
Attribute type
Attribute applicability
Attribute price
Attribute level
Item creation time
Last time item was updated
total quantity of the line item
ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)
ItemSubType(For International type, provide subType as Border-free)
Item price list ID
Cart item sequence number (starts at 1)
x > 1true = Item is active<br />false = Item is not active
Individual item price
Currency type
Price before discount
Offer discount details. Empty list {} should be passed in case of no discount.
Discounted price of the item
x > 0List of discounts applied
Discounted percentage amount of the item
x > 0Price after discount
Total price for the full quantity of this item
Currency type
Price before discount
Offer discount details. Empty list {} should be passed in case of no discount.
Discounted price of the item
x > 0List of discounts applied
Discounted percentage amount of the item
x > 0Price after discount
Total price of item attributes
Extra metadata passed by caller
Sales channel
true: Item is set for pickup<br />false: Item is set for delivery
Warehouse ID
Shipping ID
Shipment details
Shipping details ID
Cart ID
Shipping details creation time
Last time shipping details were updated
Shipping method and details
Shipping address
Address recipient
Address line 1
Address line 2
Address line 3
Address line 4
City name
State name
Country name
Zip code
Receiver's email address
Address type
Recipient's name
address details for the shipping
Shipping type
Shipping tax code
true = Item is set for pickup<br />false = Item is set for delivery
Warehouse ID
Store ID
Item details for order fulfillment
Type of order fulfillment
Specifies the network of inventory for item
Specifies the channel of inventory for item
Specifies the type of inventory for item
Inventory details of the cart item
View quantity of inventory, based on pre configured value. For example, 'availableToPurchase' can be a custom attribute configured by merchants.
Inventory ID
SKU of the item
Item ID for which inventory is updated
Location number is used to identify the warehouse or location where the inventory is kept
Sales channel ID. This field is used to identify where the business operations are being held.
Vendor ID
The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse
Type of inventory
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
Inventory counter (also known as inventory position) configured by the merchant
Custom inventory attributes configured by the merchant
Inventory restock date
First ship date of inventory
Maximum restock inventory quantity
Maximum quanity of inventory for first-ship
Reserved inventory quantity at the location
Inventory quantity to mark as low stock at the location
Inventory segment
Region where inventory is managed
Total price of attributes
Item creation time
Last time item was updated
Number of items in cart
Item price list ID
Cart item sequence number (starts at 1)
x > 1true = Item is active<br />false = Item is not active
Individual item price
Currency type
Price before discount
Offer discount details. Empty list {} should be passed in case of no discount.
Discounted price of the item
x > 0Unique promotion/coupon ID
General promotion/coupon code
Promotion/coupon code discount value
Promotion/coupon code discount unit
List of discounts applied
Unique promotion/coupon ID
General promotion/coupon code
Promotion name
Quantity of this item in the cart
Total amount of discount applied
Promotion value
Promotion group ID
Promotion type
Promotion priority
true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions
Item SKU to which promotion is applied
ID of item to which promotion is applied
Key of item to which promotion is applied
Coupon code description
Discount unit
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.
The prorated discount amount.
Discounted percentage amount of the item
x > 0Price after discount
Total price for the full quantity of this item
Currency type
Price before discount
Offer discount details. Empty list {} should be passed in case of no discount.
Discounted price of the item
x > 0Unique promotion/coupon ID
General promotion/coupon code
Promotion/coupon code discount value
Promotion/coupon code discount unit
List of discounts applied
Unique promotion/coupon ID
General promotion/coupon code
Promotion name
Quantity of this item in the cart
Total amount of discount applied
Promotion value
Promotion group ID
Promotion type
Promotion priority
true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions
Item SKU to which promotion is applied
ID of item to which promotion is applied
Key of item to which promotion is applied
Coupon code description
Discount unit
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.
The prorated discount amount.
Discounted percentage amount of the item
x > 0Price after discount
Additional item options
Attribute ID
Attribute name
Attribute description
ITEM: Item-level attribute<br />ORDER: Cart-level attribute
Attribute type
Attribute applicability
Attribute price
Attribute level
List of price adjustments for the line item
Price adjustment ID; it identifies a single price adjustment object from the list of price adjustments.
Price adjustment reason
Amount by which the line item's total amount or the specified cart's total amount is adjusted
x > 0Placeholder for additional information
true: Item is set for pickup<br />false: Item is set for delivery
Warehouse ID
Shipment details
Shipping details ID
Cart ID
Shipping details creation time
Last time shipping details were updated
Shipping method and details
Shipping method ID
Shipment carrier
Shipment method type
Shipping address
Address recipient
Address line 1
Address line 2
Address line 3
Address line 4
City name
State name
Country name
Zip code
Receiver's email address
Address type
Shipping type
Shipping tax code
true = Item is set for pickup<br />false = Item is set for delivery
Alternative pickup person
Receiver's email address
Designated pickup person
Receiver's email address
Warehouse ID
Store ID
Sales channel
Fees associated with a specific cart or an individual line item of a cart
System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.
Attribute for which fee is applied
Fee type
Fee amount
Placeholder for additional information in key:value pairs
ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)
Item sub type. For International type, provide subType as Borderfree.
Unit Of measure
Total tax on item
Tax code for an item
Shipping details ID
Cart ID
Shipping details creation time
Last time shipping details were updated
Shipping method and details
Shipping method ID
Shipment carrier
Shipment method type
Shipping address
Address recipient
Address line 1
Address line 2
Address line 3
Address line 4
City name
State name
Country name
Zip code
Receiver's email address
Address type
Shipping type
Shipping tax code
true: Item is set for pickup<br />false: Item is set for delivery
Alternative pickup person
Receiver's email address
Designated pickup person
Receiver's email address
Warehouse ID
Store ID
Estimated date for shipping
Estimated date for delivery
Store ID
Order number
Order type (WEB, CSC, MOBILE_APP, POS)
Order sub type (Android/IOS/International)
Cart metadata
Payment connector name
Payment method
Payment method type
Payment token identifier
Payment amount
Currency code
Currency Conversion (For USD = 1, For Non-USD = conversion ratio to USD)
Billing address for the order
Address line 1
City name
State name
Country name
Postal code
Customer ID created for payment instruction
Receiver's email address
Address line 2
Address line 3
Address line 4
Address type
Latitude
Longitude
Payment Attributes
Customer account ID
Total number of items in the cart
Total number of unique line items in the cart
Cart configuration
true: Allows a cart to be a guest cart.<br />false: Allows cart only if user is logged in.
Determines how an order number is created
CART_ID, FABRIC, EXTERNAL, NONE true: Soft reserve is used for an inventory check.<br/> false: Soft reserve is not used for an inventory check.
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
Source of an order number
FABRIC, EXTERNAL, NONE Expiry time in seconds
Cart configurations used to determine behavior of cart.
BLOCK, WARN, DROP, NONE Cart configurations used to determine behavior of cart.
BLOCK, WARN, DROP, NONE Cart configurations used to determine behavior of cart.
BLOCK, WARN, DROP, NONE Cart configurations used to determine behavior of cart.
BLOCK, WARN, DROP, NONE Fees associated with a specific cart or an individual line item of a cart
System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.
Attribute for which fee is applied
Fee type
Fee amount
Placeholder for additional information in key:value pairs
Total fees applied on the order
error object
Error code
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
ID of item to which exception applies
SKU of item to which exception applies
Cart item sequence number (starts at 1)
x > 1Was this page helpful?