Getting Started
Authentication v3
- Concepts
- System Apps
- User Apps
- Authentication Endpoints
Product Catalog
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Orders
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory
- Inventory (3.0.0)
- Inventory FAQ
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Price Lists
- Prices
- Price Types
- Price Controls
- Price Methods
- Priced Products
- Add-ons
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Product Exclusion Lists
- Segments
- Imports
- Exports
- Attributes
- Webhook Events
Carts
- Overview
- Developer Guides
- Carts
- Order Draft
- Items
- Addresses
- Payments
- Fulfillment
- Customer
- Coupons
- Validations
- Cart Orchestrator
Customers
- Customer Profile
- Customer Address
- Customer Self
Create an order draft
Create an order using the cart ID of the cart that contains the order.
Authorizations
This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID for tracking.
x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
Body
Order Draft Request
The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint. This ID is used to reference the cart in subsequent API requests.
Order information request object
Custom attributes provided to the context, such as order status.
Custom attributes provided to the context, such as order status.
An array containing items with associated custom data.
The unique identifier of the item that was linked from making Create item endpoint
Order number
The Customer ID that was added to the customer attribute when using the Update customer endpoint.
Response
Order Draft
A map of addresses added to the corresponding cart.
Address
Address line 1
Address line 2
Address line 3
Address line 4
City
Country
The date and time the address was created.
The Address ID generated when an address was created using the Create address endpoint.
Postal code or zip code
State, Province or Area
The date and time the address was last updated.
A collection of adjustments made to the corresponding cart.
An array containing adjustments in the collection.
Custom attributes used for price adjustments.
Custom attributes used for price adjustments.
The date and time when the adjustment was created.
The Adjustment ID generated when an adjustment was created using the Create adjustment endpoint.
Price details
Total fees amount
x >= 0The reason for the adjustment.
The date and time when the adjustment was last updated.
Adjustments total in a collection.
Custom attributes provided to the context, such as a wishlist, to provide additional information about the entity.
Custom attributes provided to the context, such as a wishlist, to provide additional information about the entity.
The unique identifier of the cart, which is generated when the cart is created using the Create an empty cart endpoint.
Channel ID
Cart configurations determine the behavior within the cart.
Configuration settings related to inventory management and checks.
Behaviors related to inventory actions, such as adding the item or removing the item.
The behavior that is executed based on the selected configuration.
The default setting is REJECT.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE Duration in seconds until inventory validation data expires.
This setting is used to determine how you check inventory. The options are SKU or LINE_ITEM.
SKU, LINE_ITEM Maximum quantity configurations to set when the cart reaches its limit.
Max quantity behaviors
The behavior that is executed based on the selected configuration.
The default setting is REJECT.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The maximum quantity allowed across all items in the cart.
Configuration settings related to order validation and processing.
Order validate determines the blocking behavior when creating an order draft.
The behavior that is executed based on the selected configuration.
The default behavior is BLOCK.
BLOCK, NONE The behavior that is executed based on the selected configuration.
The default behavior is BLOCK.
BLOCK, NONE The behavior that is executed based on the selected configuration.
The default behavior is BLOCK.
BLOCK, NONE The behavior that is executed based on the selected configuration.
The default behavior is BLOCK.
BLOCK, NONE Configuration settings related to product behavior and cache expiry.
Behaviors related to inventory actions, such as adding the item or removing the item.
The behavior that is executed based on the selected configuration.
The default setting is REJECT.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE Duration in seconds until product validation data expires.
Item max quantity configurations
Max quantity behaviors
The behavior that is executed based on the selected configuration.
The default setting is REJECT.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, DROP, REJECT, NONE Maximum quantity for an individual line item
Configuration settings related to promotions and their cache expiry.
Promotion behaviors
The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, NONE Duration in seconds until promotion data expires.
Configuration settings for tax calculations and behaviors.
tax behaviors
The behavior that is executed based on the selected configuration.
The default behavior is WARN.
WARN, NONE Duration in seconds until the tax data expires.
The date and time when the cart was created.
The currency that the cart will use when an order is created.
Customer context object containing customer information.
Customer attributes such as email.
Customer attributes such as email.
The Customer ID that was added to the customer attribute when using the Update customer endpoint.
Session ID of the customer.
A collection of fees associated with the corresponding cart.
An array containing all fees and their details in a collection.
Custom attributes that provide more context for the fee, such as the source of the fee.
Custom attributes that provide more context for the fee, such as the source of the fee.
The date and time when the fee was created.
The unique identifier of the fee associated with the corresponding cart that was generated when making Create fee endpoint.
Name of the fee
Price details
Total fees amount
x >= 0A collection of taxes.
Tax total in the collection.
A boolean value that determines whether a fee is taxable.
The date and time when the fee was last updated.
The total fees amount in the collection.
A map of fulfillments added to the corresponding cart.
A fulfillment object containing important fulfillment information.
A collection of adjustments made to the corresponding cart.
An array containing adjustments in the collection.
Custom attributes used for price adjustments.
The date and time when the adjustment was created.
The Adjustment ID generated when an adjustment was created using the Create adjustment endpoint.
Price details
The reason for the adjustment.
The date and time when the adjustment was last updated.
Adjustments total in a collection.
Custom attributes to provide more context to the fulfillment, such as where it was made.
Custom attributes to provide more context to the fulfillment, such as where it was made.
The identifier of the address where the item is being shipped.
A collection of fees associated with the corresponding cart.
An array containing all fees and their details in a collection.
Custom attributes that provide more context for the fee, such as the source of the fee.
The date and time when the fee was created.
The unique identifier of the fee associated with the corresponding cart that was generated when making Create fee endpoint.
Name of the fee
Price details
A collection of taxes.
A boolean value that determines whether a fee is taxable.
Tax details used to determine tax for a cart fee.
The date and time when the fee was last updated.
The total fees amount in the collection.
The Fulfillment ID generated when a fulfillment was created using the Create fulfillment endpoint.
Unique identifier of the store.
The identifier of the address where the item is being fulfilled.
Pickup person details
Name of the pickup person.
Name of the recipient of the order.
Email of the pickup person.
Phone
An array containing secondary people for pickup.
Name of the recipient of the order.
Email of the pickup person.
Phone
Price details
Total fees amount
x >= 0A collection of promotions applied to the fulfillment.
The total discount applied within a collection.
An alternative identifier for fulfillments, used for additional tracking or referencing.
A collection of taxes.
Tax total in the collection.
Determines the type of fulfillment.
SHIP_TO, BOPIS, ROPIS A collection of items in the cart.
An array containing items in the collection.
A collection of adjustments made to the corresponding cart.
An array containing adjustments in the collection.
Custom attributes used for price adjustments.
The date and time when the adjustment was created.
The Adjustment ID generated when an adjustment was created using the Create adjustment endpoint.
Price details
The reason for the adjustment.
The date and time when the adjustment was last updated.
Adjustments total in a collection.
Custom attributes
Custom attributes
The date and time a Item was created
A collection of fees associated with the corresponding cart.
An array containing all fees and their details in a collection.
Custom attributes that provide more context for the fee, such as the source of the fee.
The date and time when the fee was created.
The unique identifier of the fee associated with the corresponding cart that was generated when making Create fee endpoint.
Name of the fee
Price details
A collection of taxes.
A boolean value that determines whether a fee is taxable.
Tax details used to determine tax for a cart fee.
The date and time when the fee was last updated.
The total fees amount in the collection.
Item Fulfillment
The identifier of the fulfillment linked to the item.
Price details
Total fees amount
x >= 0The unique identifier of the item that was linked from making Create item endpoint
Position of the item in the cart..
The unique identifier for a price list, used to reference and manage pricing information.
Collection of item promotions.
An array containing promotions in the collection.
The discount amount applied to the item, excluding quantity.
The unique identifier of the promotion.
Prorations
The quantity of the item for which the discount is applicable.
Discount total in the collection.
Quantity of item
An alternative identifier associated with the item, used for additional tracking or referencing.
The Stock Keeping Unit (SKU) associated with the item, used for inventory tracking and management.
A collection of taxes.
Tax total in the collection.
The code used to identify and apply tax rates for transactions.
The date and time the Item was last updated
Item total in a collection.
An object that contains order information, such as the order ID, order number, and items included in the order.
Custom attributes, such as order status.
Custom attributes, such as order status.
Unique identifier of the order draft.
An array containing items with associated custom data.
The unique identifier of the item that was linked from making Create item endpoint
Unique order number of the order draft.
An object containing a collection of payments added to the corresponding cart.
The payments that have been authorized within the collection.
An array containing payments within the collection.
Custom attributes associated with the transaction, such as the name of the gift card used.
Custom attributes associated with the transaction, such as the name of the gift card used.
Payment authorization
The amount for which the payment has been authorized.
x > 0The date when the payment authorization expires.
The Address ID that was generated when an address was created using the Create address endpoint.
Information about the card used for payment, such as gift card details.
Information about the card used for payment, such as gift card details.
The Payment ID that was generated when a payment was created using the Create payment endpoint.
Payment method, such as Apple Pay, used for processing transactions.
Payment method type, such as a credit card.
The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.
The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.
Payment state indicates whether the payment has been successfully processed.
PENDING, AUTHORIZED, CAPTURED, FAILED The sum of the total amount of the cart.
The adjustments total amount.
The discounts total amount.
The fees total amount.
The fulfillments total amount.
The subtotal of all items amount.
The tax total amount.
The grand total, inclusive of all charges and discounts.
A collection of promotions applied to the corresponding cart.
An array containing promotions in the collection.
Custom attributes provide more context for the promotion.
Custom attributes provide more context for the promotion.
Coupon code
The unique identifier of the promotion.
Promotion title
The type of promotion, such as percentage or fixed value.
The value of the promotion, indicating the amount of the discount applied. This can be a fixed amount or a percentage.
The total value of all applied promotions.
An array containing details about the current state of the cart.
A detailed description of the resource's current state, such as the absence of payment details.
The key used to map the state of the resource.
The type of resource indicating its current state, such as a cart.
ITEM, CART, FULFILLMENT, PAYMENT, FEE, VALIDATION The ID used to reference the resource's state, such as a cart.
Indicates the status of the cart, which can be either ACTIVE or SOFT_DELETE.
ACTIVE, SOFT_DELETE The date and time in UTC when the cart was last updated.
Inventory validation details
The inventory channels associated with the item.
The inventory channels associated with the item.
The inventory counters available for the item.
The inventory counters available for the item.
The latest date when inventory was added to the corresponding cart.
The SKU of the item.
Product validation data
An array containing product validation data.
The maximum quantity allowed for a SKU.
The SKU that exists within a Product Information Management (PIM) service.
The latest date when product data was added to the corresponding cart.
An object that contains promotion validation data.
An array containing coupons that have been added to the corresponding cart.
A boolean value that determines whether promotions require a refresh.
The latest date when promotions data was added to the corresponding cart.
Was this page helpful?