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
Get orders by query
Retrieves orders based on query model passed in the request body.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
Query object to retrieve matched orders
Numbers of records to be returned
Number of records to skipped
Item property on which data needed to be sorted on
Direction of sorting- ascending or descending
JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
Body
Query object to retrieve matched orders
JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc
JSON to filter records. JSON structure should be similar to target entity structure i.e order, shipment etc.
Numbers of records to be returned
Number of records to skipped
Item property on which data needed to be sorted on
Direction of sorting- ascending or descending
asc, desc Response
Response object based on query model
Total number of order records
Number of records returned on a single page
Number of records skipped before selecting matched records
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.
Auto generated ID once the order created successfully
Unique order number
Actual order creation date
Order cancellation date if any
Order allocation date after order is created
Sales channel ID
ID of the cart where order is placed
Platfrom using which order is created
WEB, CSC, MOBILE_APP, POS Operating system of the platfom as mentioned in the type field. If you want to configure any custom valuefor this field, contact fabric.
IOS, Android, International Order process name
Employee ID used when an employee places an order on behave of the customer.
Order retail object for reatil transactions. For non-retail transactions, only location number is provided.
Store number of line item's fulfillment origin.
Cashier ID in case of retail transaction.
Registered user ID of the cashier who helps in creating the order. It is applicable for retail transactions.
Transaction ID incase of retail transaction.
Order value after calculating discounts and any applicable fees
Original order total value
Final discount value on order amount
Original discount on order value
Total fees, if any, applicable on order amount
Original fees appliable on shipping of items
Total tax amount appliable on shipping of items
Appeasement amount, if any, processed on the order
Original tax amount on order during fist time order creation
Return amount incase of order return
Cancel amount incase of order cancellation
Invoice value on order
Total order amount after calculating fees, discounts, retrurn and cancellation if any
Order amount during first time order creation after calculating all fees, taxes, and discounts
Array of appeasements, if any
Counter number where appeasement is processed. It is used for retail transactions
Appeasement amount
Appeasement invoice value; should be equal to appeasement value
Order customer model
It is shopper's ID who visits company website to purchase products.
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.
ID of the employee (sales person) who creates an order for shopper.
OrderPaymentIdentifier Model
Last 4 digits from cart number
Card expiration year
Card expiration month
Order billing or shipping address
Latitude of the address
Longitude of the address
Identify order type whether it's pickup item, or web ship, or international order
Identify whether this item has been ordered as backorder
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.
Counter number where appeasement is processed. It is used for retail transactions
Appeasement amount
Appeasement invoice value; should be equal to appeasement value
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.
Code for the tax applied for shiping of items to the adress
Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store
Primary, Alternate Order billing or shipping address
Latitude of the address
Longitude of the address
Amount applicable for shipping the item to the address
Discount amount applied for shipping the item to the address
Total tax applicable to ship the item to the address
Additional user instructions
Order dispatched date and time
Date and time when the original order is modified for the first time, for example for return, cancellation or replacement
Date and time when the exisiting order is updated
Was this page helpful?