Orders
Session cookie for authentication
Filter orders from last 30 days only
Search by order number
Page number for pagination
Session cookie in format sessionid=<value>.
May use site-specific cookie name (e.g., osessionid).
List of orders
Authentication required
Login required (redirects to login page)
Session cookie for authentication
Order ID. Must belong to the authenticated user. For guest users, this parameter is ignored and the most recent order is returned instead.
Session cookie in format sessionid=<value>.
May use site-specific cookie name (e.g., osessionid).
Order details retrieved successfully
User order with all related data including items, discounts, addresses, and payment details.
Order ID
Order number (unique identifier)
Order total amount
Total discount applied
Amount before discounts (computed field)
Shipping cost
Tax rate for shipping
Total refund amount
Refunded discount amount
Refunded shipping amount
Whether order is fully cancelled
Whether order can be cancelled
Whether order is eligible for refund
Whether order has pending payment
Shipment tracking URL
Shipment tracking number
Invoice number
Invoice date
E-Archive document URL
Type of order. Possible values:
regular: Standard order placed by customeraddon: Additional items added to an existing orderreplacement: Replacement order for defective/incorrect items
Field can be null for legacy orders created before order_type was introduced.
Email address used for order
Whether order includes gift box
Gift box message/note
Order delivery instructions
Number of payment installments
Interest amount for installment payment
Credit card BIN number (first 6-8 digits)
Bank information (null if not credit card payment)
Additional order data (rewards, custom fields, etc.)
Authentication required
Login required (redirects to login page)
Order not found or doesn't belong to user. Guest users with no orders will also receive 404.
Session cookie for authentication
Order ID. Must belong to the authenticated user. For guest users, this parameter is ignored and the last order (by created_date) is returned instead.
Session cookie in format sessionid=<value>.
May use site-specific cookie name (e.g., osessionid).
Order cancellation details retrieved successfully
User order with all related data including items, discounts, addresses, and payment details.
Order ID
Order number (unique identifier)
Order total amount
Total discount applied
Amount before discounts (computed field)
Shipping cost
Tax rate for shipping
Total refund amount
Refunded discount amount
Refunded shipping amount
Whether order is fully cancelled
Whether order can be cancelled
Whether order is eligible for refund
Whether order has pending payment
Shipment tracking URL
Shipment tracking number
Invoice number
Invoice date
E-Archive document URL
Type of order. Possible values:
regular: Standard order placed by customeraddon: Additional items added to an existing orderreplacement: Replacement order for defective/incorrect items
Field can be null for legacy orders created before order_type was introduced.
Email address used for order
Whether order includes gift box
Gift box message/note
Order delivery instructions
Number of payment installments
Interest amount for installment payment
Credit card BIN number (first 6-8 digits)
Bank information (null if not credit card payment)
Additional order data (rewards, custom fields, etc.)
Authentication required
Login required (redirects to login page)
Order not found or doesn't belong to user. Guest users with no orders will also receive 404.
Session cookie for authentication
Filter orders by currency type
Search by order number
Field to order by.
Use - prefix for descending order.
Examples: created_date, -created_date, amount, -number
Available fields: number, user_email, status, created_date, amount,
discount_amount, currency, payment_type, bank, installment_count,
tracking_number, shipping_company, shipping_address, billing_address
-created_datePage number for pagination
Session cookie in format sessionid=<value>.
May use site-specific cookie name (e.g., osessionid).
List of old orders retrieved successfully
Authentication required
Login required (redirects to login page)
Session cookie for authentication
Old order ID. Must belong to the authenticated user. Guest users will always receive 404.
Session cookie in format sessionid=<value>.
May use site-specific cookie name (e.g., osessionid).
Old order details retrieved successfully
Archived order from legacy systems with basic order information.
Order number (unique identifier)
User email associated with order
Order status (stored as plain string from legacy system)
Order total amount
Total discount applied
Payment type from legacy system
Bank name from legacy system
Number of installments
Shipment tracking number
Shipping address (stored as plain text from legacy system)
Billing address (stored as plain text from legacy system)
Additional legacy data
Authentication required
Login required (redirects to login page)
Order not found or doesn't belong to user. Guest users always receive 404 for this endpoint.
Last updated
Was this helpful?

