Orders
This method indicates the relationship between order items and discounts, showing which discount is applied to each order item by returning the IDs of the order items and their associated discount records.
Query parameter created_date used to filter results based on specific conditions.
Query parameter discount_item used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of results returned in the response.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter order_item used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
GET /api/v1/remote/1/data-warehouse/orders/benefit-applicants/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"created_date": "2025-06-27T08:07:15.814Z",
"discount_item": 1,
"id": 1,
"modified_date": "2025-06-27T08:07:15.814Z",
"order_item": 1
}
]
}This method indicates the relationship between order items and discounts, showing which discount is applied to each order item by returning the IDs of the order items and their associated discount records. This endpoint retrieves a specific record by its unique identifier.
A unique integer value identifying this benefit applicant.
GET /api/v1/remote/1/data-warehouse/orders/benefit-applicants/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"created_date": "2025-06-27T08:07:15.814Z",
"discount_item": 1,
"id": 1,
"modified_date": "2025-06-27T08:07:15.814Z",
"order_item": 1
}This method retrieves data about discounts applied to orders, including details such as discount amounts, related offers, and conditions.
Query parameter amount used to filter results based on specific conditions.
Query parameter cancel_amount used to filter results based on specific conditions.
Query parameter conditional_offer used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter data used to filter results based on specific conditions.
Query parameter data_source_discount_sharing_rate used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of results returned in the response.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter name used to filter results based on specific conditions.
Query parameter order used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter session_offer used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
GET /api/v1/remote/1/data-warehouse/orders/discount-items/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"amount": "text",
"cancel_amount": "text",
"conditional_offer": 1,
"created_date": "2025-06-27T08:07:15.814Z",
"data": null,
"data_source_discount_sharing_rate": "text",
"id": 1,
"modified_date": "2025-06-27T08:07:15.814Z",
"name": "text",
"order": 1,
"session_offer": 1
}
]
}This method retrieves data about discounts applied to orders, including details such as discount amounts, related offers, and conditions. This endpoint retrieves a specific record by its unique identifier.
A unique integer value identifying this discount item.
GET /api/v1/remote/1/data-warehouse/orders/discount-items/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"amount": "text",
"cancel_amount": "text",
"conditional_offer": 1,
"created_date": "2025-06-27T08:07:15.814Z",
"data": null,
"data_source_discount_sharing_rate": "text",
"id": 1,
"modified_date": "2025-06-27T08:07:15.814Z",
"name": "text",
"order": 1,
"session_offer": 1
}Retrieves information about items included in orders, showing product identifiers, pricing, and status details.
Query parameter attributes used to filter results based on specific conditions.
Query parameter attributes_kwargs used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter datasource used to filter results based on specific conditions.
Query parameter defined_shipping_company used to filter results based on specific conditions.
Query parameter defined_tracking_url used to filter results based on specific conditions.
Query parameter delivered_date used to filter results based on specific conditions.
Query parameter e_archive_url used to filter results based on specific conditions.
Query parameter estimated_delivery_date used to filter results based on specific conditions.
Query parameter extra_field used to filter results based on specific conditions.
Query parameter extra_product_price used to filter results based on specific conditions.
Query parameter extra_product_stock used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter image used to filter results based on specific conditions.
Query parameter invoice_date used to filter results based on specific conditions.
Query parameter invoice_number used to filter results based on specific conditions.
Limits the number of results returned in the response.
Query parameter localized_attributes used to filter results based on specific conditions.
Query parameter localized_attributes_kwargs used to filter results based on specific conditions.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter order used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter parent used to filter results based on specific conditions.
Query parameter price used to filter results based on specific conditions.
Query parameter price_currency used to filter results based on specific conditions.
Query parameter product used to filter results based on specific conditions.
Query parameter retail_price used to filter results based on specific conditions.
Query parameter shipped_date used to filter results based on specific conditions.
Query parameter shipping_company used to filter results based on specific conditions.
Query parameter shipping_option_group used to filter results based on specific conditions.
Query parameter shipping_tracking_url used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter status used to filter results based on specific conditions.
Query parameter tax_rate used to filter results based on specific conditions.
Query parameter tracking_number used to filter results based on specific conditions.
GET /api/v1/remote/1/data-warehouse/orders/order-items/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"attributes": null,
"attributes_kwargs": null,
"created_date": "2025-06-27T08:07:15.814Z",
"datasource": 1,
"defined_shipping_company": "text",
"defined_tracking_url": "https://example.com",
"delivered_date": "2025-06-27T08:07:15.814Z",
"e_archive_url": "https://example.com",
"estimated_delivery_date": "2025-06-27",
"extra_field": null,
"extra_product_price": 1,
"extra_product_stock": 1,
"id": 1,
"image": "https://example.com",
"invoice_date": "2025-06-27T08:07:15.814Z",
"invoice_number": "text",
"localized_attributes": null,
"localized_attributes_kwargs": null,
"modified_date": "2025-06-27T08:07:15.814Z",
"order": 1,
"parent": 1,
"price": "text",
"price_currency": "try",
"product": 1,
"retail_price": "text",
"shipped_date": "2025-06-27T08:07:15.814Z",
"shipping_company": "aras",
"shipping_option_group": 1,
"shipping_tracking_url": "https://example.com",
"status": "50",
"tax_rate": "text",
"tracking_number": "text"
}
]
}Retrieves information about items included in orders, showing product identifiers, pricing, and status details. This endpoint retrieves a specific record by its unique identifier.
A unique integer value identifying this order item.
GET /api/v1/remote/1/data-warehouse/orders/order-items/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"attributes": null,
"attributes_kwargs": null,
"created_date": "2025-06-27T08:07:15.814Z",
"datasource": 1,
"defined_shipping_company": "text",
"defined_tracking_url": "https://example.com",
"delivered_date": "2025-06-27T08:07:15.814Z",
"e_archive_url": "https://example.com",
"estimated_delivery_date": "2025-06-27",
"extra_field": null,
"extra_product_price": 1,
"extra_product_stock": 1,
"id": 1,
"image": "https://example.com",
"invoice_date": "2025-06-27T08:07:15.814Z",
"invoice_number": "text",
"localized_attributes": null,
"localized_attributes_kwargs": null,
"modified_date": "2025-06-27T08:07:15.814Z",
"order": 1,
"parent": 1,
"price": "text",
"price_currency": "try",
"product": 1,
"retail_price": "text",
"shipped_date": "2025-06-27T08:07:15.814Z",
"shipping_company": "aras",
"shipping_option_group": 1,
"shipping_tracking_url": "https://example.com",
"status": "50",
"tax_rate": "text",
"tracking_number": "text"
}Fetches order-related data, detailing financial amounts, order statuses, customer information, and various logistical details surrounding order handling.
Query parameter amount used to filter results based on specific conditions.
Query parameter basket used to filter results based on specific conditions.
Query parameter billing_address used to filter results based on specific conditions.
Query parameter bin_number used to filter results based on specific conditions.
Query parameter card used to filter results based on specific conditions.
Query parameter checkout_provider used to filter results based on specific conditions.
Query parameter client_type used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter currency used to filter results based on specific conditions.
Query parameter defined_tracking_url used to filter results based on specific conditions.
Query parameter discount_amount used to filter results based on specific conditions.
Query parameter discount_refund_amount used to filter results based on specific conditions.
Query parameter e_archive_url used to filter results based on specific conditions.
Query parameter extra_field used to filter results based on specific conditions.
Query parameter gift_box_note used to filter results based on specific conditions.
Query parameter has_gift_box used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter installment used to filter results based on specific conditions.
Query parameter installment_count used to filter results based on specific conditions.
Query parameter installment_interest_amount used to filter results based on specific conditions.
Query parameter invoice_date used to filter results based on specific conditions.
Query parameter invoice_number used to filter results based on specific conditions.
Query parameter language_code used to filter results based on specific conditions.
Limits the number of results returned in the response.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter notes used to filter results based on specific conditions.
Query parameter number used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter payment_option used to filter results based on specific conditions.
Query parameter payment_option_slug used to filter results based on specific conditions.
Query parameter refund_amount used to filter results based on specific conditions.
Query parameter remote_addr used to filter results based on specific conditions.
Query parameter segment used to filter results based on specific conditions.
Query parameter shipping_address used to filter results based on specific conditions.
Query parameter shipping_amount used to filter results based on specific conditions.
Query parameter shipping_company used to filter results based on specific conditions.
Query parameter shipping_option used to filter results based on specific conditions.
Query parameter shipping_option_slug used to filter results based on specific conditions.
Query parameter shipping_refund_amount used to filter results based on specific conditions.
Query parameter shipping_tax_rate used to filter results based on specific conditions.
Query parameter shipping_tracking_url used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter status used to filter results based on specific conditions.
Query parameter tracking_number used to filter results based on specific conditions.
Query parameter user used to filter results based on specific conditions.
Query parameter user_email used to filter results based on specific conditions.
GET /api/v1/remote/1/data-warehouse/orders/orders/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"amount": "text",
"basket": 1,
"billing_address": 1,
"bin_number": "text",
"card": 1,
"checkout_provider": 1,
"client_type": "default",
"created_date": "2025-06-27T08:07:15.814Z",
"currency": "try",
"defined_tracking_url": "https://example.com",
"delivery_range": {
"ANY_ADDITIONAL_PROPERTY": "2025-06-27T08:07:15.814Z"
},
"discount_amount": "text",
"discount_refund_amount": "text",
"e_archive_url": "https://example.com",
"extra_field": null,
"gift_box_note": "text",
"has_gift_box": true,
"id": 1,
"installment": 1,
"installment_count": 1,
"installment_interest_amount": "text",
"invoice_date": "2025-06-27T08:07:15.814Z",
"invoice_number": "text",
"language_code": "text",
"modified_date": "2025-06-27T08:07:15.814Z",
"notes": "text",
"number": "text",
"payment_option": 1,
"payment_option_slug": "text",
"refund_amount": "text",
"remote_addr": "text",
"segment": 1,
"shipping_address": 1,
"shipping_amount": "text",
"shipping_company": "aras",
"shipping_option": 1,
"shipping_option_slug": "text",
"shipping_refund_amount": "text",
"shipping_tax_rate": "text",
"shipping_tracking_url": "https://example.com",
"status": "50",
"tracking_number": "text",
"user": 1,
"user_email": "[email protected]"
}
]
}Fetches order-related data, detailing financial amounts, order statuses, customer information, and various logistical details surrounding order handling. This endpoint retrieves a specific record by its unique identifier.
A unique integer value identifying this order.
GET /api/v1/remote/1/data-warehouse/orders/orders/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"amount": "text",
"basket": 1,
"billing_address": 1,
"bin_number": "text",
"card": 1,
"checkout_provider": 1,
"client_type": "default",
"created_date": "2025-06-27T08:07:15.814Z",
"currency": "try",
"defined_tracking_url": "https://example.com",
"delivery_range": {
"ANY_ADDITIONAL_PROPERTY": "2025-06-27T08:07:15.814Z"
},
"discount_amount": "text",
"discount_refund_amount": "text",
"e_archive_url": "https://example.com",
"extra_field": null,
"gift_box_note": "text",
"has_gift_box": true,
"id": 1,
"installment": 1,
"installment_count": 1,
"installment_interest_amount": "text",
"invoice_date": "2025-06-27T08:07:15.814Z",
"invoice_number": "text",
"language_code": "text",
"modified_date": "2025-06-27T08:07:15.814Z",
"notes": "text",
"number": "text",
"payment_option": 1,
"payment_option_slug": "text",
"refund_amount": "text",
"remote_addr": "text",
"segment": 1,
"shipping_address": 1,
"shipping_amount": "text",
"shipping_company": "aras",
"shipping_option": 1,
"shipping_option_slug": "text",
"shipping_refund_amount": "text",
"shipping_tax_rate": "text",
"shipping_tracking_url": "https://example.com",
"status": "50",
"tracking_number": "text",
"user": 1,
"user_email": "[email protected]"
}This method retrieves financial transaction data related to orders, including transaction types, currencies, amounts, and additional relational details such as user information and order connections.
Query parameter amount used to filter results based on specific conditions.
Query parameter auth_code used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter currency used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter is_succeeded used to filter results based on specific conditions.
Limits the number of results returned in the response.
Query parameter main_pos used to filter results based on specific conditions.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter order used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter pos used to filter results based on specific conditions.
Query parameter raw_request used to filter results based on specific conditions.
Query parameter raw_response used to filter results based on specific conditions.
Query parameter remote_addr used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter three_d_used used to filter results based on specific conditions.
Query parameter transaction_id used to filter results based on specific conditions.
Query parameter transaction_type used to filter results based on specific conditions.
Query parameter user used to filter results based on specific conditions.
Query parameter user_email used to filter results based on specific conditions.
GET /api/v1/remote/1/data-warehouse/orders/transactions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"amount": "text",
"auth_code": "text",
"created_date": "2025-06-27T08:07:15.814Z",
"currency": "try",
"id": 1,
"is_succeeded": true,
"main_pos": 1,
"modified_date": "2025-06-27T08:07:15.814Z",
"order": 1,
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"remote_addr": "text",
"three_d_used": true,
"transaction_id": "text",
"transaction_type": "authorize",
"user": 1,
"user_email": "[email protected]"
}
]
}This method retrieves financial transaction data related to orders, including transaction types, currencies, amounts, and additional relational details such as user information and order connections. This endpoint retrieves a specific record by its unique identifier.
A unique integer value identifying this transaction.
GET /api/v1/remote/1/data-warehouse/orders/transactions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"amount": "text",
"auth_code": "text",
"created_date": "2025-06-27T08:07:15.814Z",
"currency": "try",
"id": 1,
"is_succeeded": true,
"main_pos": 1,
"modified_date": "2025-06-27T08:07:15.814Z",
"order": 1,
"pos": 1,
"raw_request": "text",
"raw_response": "text",
"remote_addr": "text",
"three_d_used": true,
"transaction_id": "text",
"transaction_type": "authorize",
"user": 1,
"user_email": "[email protected]"
}Was this helpful?