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
- Carts
- Line Items
- Cart Payments
Customers
- Customer Profile
- Customer Address
- Customer Self
Create an order draft
Creates an order from the current cart.
The Cart ID from the Create cart endpoint is used in the path parameter.
Authorizations
Include the Bearer<token> header where the <token> is the authentication token generated from the Getting Started with fabric APIs process.
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 where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Path Parameters
The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.
Body
Order number based on the order sequence.
Response
A map of addresses added to the 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 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 resource amount
x >= 0The reason for the adjustment.
The date and time when the adjustment was last updated.
Adjustments total in a collection.
Custom attributes used to describe the cart, such as a wishlist cart.
The unique identifier of the cart that was passed in the parameter.
The date and time when a cart was 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 cart.
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 cart that was generated when making Create fee endpoint.
Name of the fee
Price details
Total resource amount
x >= 0A collection of taxes.
An array containing taxes in a collection.
Tax amount
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.
A map of fulfillments added to the cart.
A fulfillment object containing important fulfillment information.
A collection of adjustments made to the 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 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 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
An array containing secondary people for pickup.
Price details
Total resource 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 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 for the item.
Custom attributes to provide more context for the item.
The date and time in UTC when the cart was last updated.
A collection of fees associated with the 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 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 resource amount
x >= 0The unique identifier of the item.
Position of item in a 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 An integer that displays the total quantity of the item. for which the discount is applicable.
Discount total in the collection.
An integer that displays the total quantity of the 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 in UTC when the cart was last updated.
Item total in a collection.
Order information
Custom attributes, such as order status.
Custom attributes, such as order status.
Identifier of an order draft to create an order.
An array containing items with associated custom data.
Order number
An object containing a collection of payments added to the 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 total adjustments amount.
The total discounts amount.
The total fees amount.
The total fulfillments amount.
The subtotal of all items.
The total tax calculated amount.
The grand total, inclusive of all charges and discounts.
A collection of promotions applied to the cart.
An array containing promotions in the collection.
Custom attributes provide more context for the promotion.
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.
The resource state is stored in an array that holds information about the current status 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.
The cart status indicates whether the cart is active or deleted.
ACTIVE, SOFT_DELETE The date and time in UTC when the cart was last updated.
Was this page helpful?