Orders

User order retrieval and cancellation

List authenticated user's orders

get

Retrieves paginated list of orders for the authenticated user. Includes order items, discounts, addresses, and payment details.

For guest users, returns only the most recent order.

Supports filtering and search by order number.

Authorizations
sessionidstringRequired

Session cookie for authentication

Query parameters
last_monthbooleanOptional

Filter orders from last 30 days only

searchstringOptional

Search by order number

pageintegerOptional

Page number for pagination

Header parameters
CookiestringOptional

Session cookie in format sessionid=<value>. May use site-specific cookie name (e.g., osessionid).

Responses
chevron-right
200

List of orders

application/json
countintegerOptional
nextstring · nullableOptional
previousstring · nullableOptional
get
/users/orders/

Retrieve specific order details

get

Retrieves detailed information for a specific order. User can only access their own orders.

Guest User Behavior: For guest users, this endpoint ignores the pk parameter and always returns their most recent order (ordered by -pk, first result). This is because guest users are restricted to viewing only their latest order.

Access Control: Users cannot access orders belonging to other users. Attempting to access another user's order returns 404 Not Found.

Response Format:

  • JSON requests: Returns order data directly

  • HTML requests: Wraps response in {"data": {...}} format

Authorizations
sessionidstringRequired

Session cookie for authentication

Path parameters
pkintegerRequired

Order ID. Must belong to the authenticated user. For guest users, this parameter is ignored and the most recent order is returned instead.

Header parameters
CookiestringOptional

Session cookie in format sessionid=<value>. May use site-specific cookie name (e.g., osessionid).

Responses
chevron-right
200

Order details retrieved successfully

application/json

User order with all related data including items, discounts, addresses, and payment details.

pkintegerOptional

Order ID

numberstringOptional

Order number (unique identifier)

amountstringOptional

Order total amount

discount_amountstringOptional

Total discount applied

amount_without_discountstringOptional

Amount before discounts (computed field)

shipping_amountstringOptional

Shipping cost

shipping_tax_ratestring · nullableOptional

Tax rate for shipping

refund_amountstringOptional

Total refund amount

discount_refund_amountstringOptional

Refunded discount amount

shipping_refund_amountstringOptional

Refunded shipping amount

is_cancelledbooleanOptional

Whether order is fully cancelled

is_cancellablebooleanOptional

Whether order can be cancelled

is_refundablebooleanOptional

Whether order is eligible for refund

is_payablebooleanOptional

Whether order has pending payment

tracking_urlstring · nullableOptional

Shipment tracking URL

tracking_numberstring · nullableOptional

Shipment tracking number

invoice_numberstring · nullableOptional

Invoice number

invoice_datestring · nullableOptional

Invoice date

e_archive_urlstring · nullableOptional

E-Archive document URL

order_typeone ofOptional

Type of order. Possible values:

  • regular: Standard order placed by customer
  • addon: Additional items added to an existing order
  • replacement: Replacement order for defective/incorrect items

Field can be null for legacy orders created before order_type was introduced.

or
nullOptional
user_emailstring · emailOptional

Email address used for order

has_gift_boxboolean · nullableOptional

Whether order includes gift box

gift_box_notestring · nullableOptional

Gift box message/note

notesstring · nullableOptional

Order delivery instructions

installment_countintegerOptional

Number of payment installments

installment_interest_amountstringOptional

Interest amount for installment payment

bin_numberstring · nullableOptional

Credit card BIN number (first 6-8 digits)

created_datestring · date-timeOptional
modified_datestring · date-timeOptional
shipping_companyone ofOptional
or
nullOptional
bankone ofOptional

Bank information (null if not credit card payment)

or
nullOptional
extra_fieldobject · nullableOptional

Additional order data (rewards, custom fields, etc.)

get
/users/orders/{pk}/

Retrieve order cancellation information

get

Retrieves order information relevant for cancellation. Typically used to display cancellation page/form.

Guest User Behavior: For guest users, this endpoint ignores the pk parameter and always returns their last order (ordered by -created_date, last result). This is because guest users are restricted to viewing only their most recent order for cancellation.

Access Control: Users can only access their own orders. Attempting to access another user's order returns 404 Not Found.

Response Format:

  • JSON requests: Returns order data directly

  • HTML requests: Wraps response in {"data": {...}} format

Authorizations
sessionidstringRequired

Session cookie for authentication

Path parameters
pkintegerRequired

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.

Header parameters
CookiestringOptional

Session cookie in format sessionid=<value>. May use site-specific cookie name (e.g., osessionid).

Responses
chevron-right
200

Order cancellation details retrieved successfully

application/json

User order with all related data including items, discounts, addresses, and payment details.

pkintegerOptional

Order ID

numberstringOptional

Order number (unique identifier)

amountstringOptional

Order total amount

discount_amountstringOptional

Total discount applied

amount_without_discountstringOptional

Amount before discounts (computed field)

shipping_amountstringOptional

Shipping cost

shipping_tax_ratestring · nullableOptional

Tax rate for shipping

refund_amountstringOptional

Total refund amount

discount_refund_amountstringOptional

Refunded discount amount

shipping_refund_amountstringOptional

Refunded shipping amount

is_cancelledbooleanOptional

Whether order is fully cancelled

is_cancellablebooleanOptional

Whether order can be cancelled

is_refundablebooleanOptional

Whether order is eligible for refund

is_payablebooleanOptional

Whether order has pending payment

tracking_urlstring · nullableOptional

Shipment tracking URL

tracking_numberstring · nullableOptional

Shipment tracking number

invoice_numberstring · nullableOptional

Invoice number

invoice_datestring · nullableOptional

Invoice date

e_archive_urlstring · nullableOptional

E-Archive document URL

order_typeone ofOptional

Type of order. Possible values:

  • regular: Standard order placed by customer
  • addon: Additional items added to an existing order
  • replacement: Replacement order for defective/incorrect items

Field can be null for legacy orders created before order_type was introduced.

or
nullOptional
user_emailstring · emailOptional

Email address used for order

has_gift_boxboolean · nullableOptional

Whether order includes gift box

gift_box_notestring · nullableOptional

Gift box message/note

notesstring · nullableOptional

Order delivery instructions

installment_countintegerOptional

Number of payment installments

installment_interest_amountstringOptional

Interest amount for installment payment

bin_numberstring · nullableOptional

Credit card BIN number (first 6-8 digits)

created_datestring · date-timeOptional
modified_datestring · date-timeOptional
shipping_companyone ofOptional
or
nullOptional
bankone ofOptional

Bank information (null if not credit card payment)

or
nullOptional
extra_fieldobject · nullableOptional

Additional order data (rewards, custom fields, etc.)

get
/users/orders/{pk}/cancellation/

List archived/old orders

get

Retrieves paginated list of archived orders. These are typically migrated historical orders from legacy systems.

Guest User Access: Not available for guest users (returns empty list).

Filtering & Search:

  • Currency filter: Filter by currency type (e.g., ?currency=try or ?currency=usd)

  • Number search: Search by order number using search parameter

  • Custom ordering: Order by any field using sort parameter

Authorizations
sessionidstringRequired

Session cookie for authentication

Query parameters
currencystring · enumOptional

Filter orders by currency type

Possible values:
searchstringOptional

Search by order number

sortstringOptional

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

Example: -created_date
pageintegerOptional

Page number for pagination

Header parameters
CookiestringOptional

Session cookie in format sessionid=<value>. May use site-specific cookie name (e.g., osessionid).

Responses
chevron-right
200

List of old orders retrieved successfully

application/json
countintegerOptional
nextstring · nullableOptional
previousstring · nullableOptional
get
/users/old-orders/

Retrieve specific old order details

get

Retrieves detailed information for a specific archived order. User can only access their own orders.

Guest User Access: Not available for guest users, returns 404 Not Found for any pk value.

Access Control: Users cannot access orders belonging to other users. Attempting to access another user's order returns 404 Not Found.

Response Format:

  • JSON requests: Returns order data directly

  • HTML requests: Wraps response in {"data": {...}} format

Authorizations
sessionidstringRequired

Session cookie for authentication

Path parameters
pkintegerRequired

Old order ID. Must belong to the authenticated user. Guest users will always receive 404.

Header parameters
CookiestringOptional

Session cookie in format sessionid=<value>. May use site-specific cookie name (e.g., osessionid).

Responses
chevron-right
200

Old order details retrieved successfully

application/json

Archived order from legacy systems with basic order information.

pkintegerOptional
numberstringOptional

Order number (unique identifier)

user_emailstring · emailOptional

User email associated with order

statusstringOptional

Order status (stored as plain string from legacy system)

created_datestring · date-timeOptional
amountstringOptional

Order total amount

discount_amountstringOptional

Total discount applied

payment_typestring · nullableOptional

Payment type from legacy system

bankstring · nullableOptional

Bank name from legacy system

installment_countintegerOptional

Number of installments

tracking_numberstring · nullableOptional

Shipment tracking number

shipping_companyone ofOptional
or
nullOptional
shipping_addressstring · nullableOptional

Shipping address (stored as plain text from legacy system)

billing_addressstring · nullableOptional

Billing address (stored as plain text from legacy system)

extra_fieldobjectOptional

Additional legacy data

get
/users/old-orders/{pk}/

Last updated

Was this helpful?