Orders

get

/orders/benefit-applicants/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

discount_itemintegerOptional

Query parameter discount_item used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

order_itemintegerOptional

Query parameter order_item used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/orders/benefit-applicants/

GET /api/v1/remote/1/data-warehouse/orders/benefit-applicants/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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": "2026-03-06T21:56:49.310Z",
      "discount_item": 1,
      "id": 1,
      "modified_date": "2026-03-06T21:56:49.310Z",
      "order_item": 1
    }
  ]
}

get

/orders/benefit-applicants/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this benefit applicant.

Responses

200

Successful response for status code 200.

application/json

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

discount_itemintegerOptional

Numerical value representing quantity or total amount.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

order_itemintegerOptional

The field defines the associated order item id.

404

Object not found.

application/json

get

/orders/benefit-applicants/{id}/

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": "2026-03-06T21:56:49.310Z",
  "discount_item": 1,
  "id": 1,
  "modified_date": "2026-03-06T21:56:49.310Z",
  "order_item": 1
}

get

/orders/discount-items/

This method retrieves data about discounts applied to orders, including details such as discount amounts, related offers, and conditions.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

amountnumberOptional

Query parameter amount used to filter results based on specific conditions.

cancel_amountnumberOptional

Query parameter cancel_amount used to filter results based on specific conditions.

conditional_offerintegerOptional

Query parameter conditional_offer used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

dataany · nullableOptional

Query parameter data used to filter results based on specific conditions.

data_source_discount_sharing_ratenumberOptional

Query parameter data_source_discount_sharing_rate used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

orderintegerOptional

Query parameter order used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

session_offerintegerOptional

Query parameter session_offer used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/orders/discount-items/

GET /api/v1/remote/1/data-warehouse/orders/discount-items/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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": "2026-03-06T21:56:49.310Z",
      "data": null,
      "data_source_discount_sharing_rate": "text",
      "id": 1,
      "modified_date": "2026-03-06T21:56:49.310Z",
      "name": "text",
      "order": 1,
      "session_offer": 1
    }
  ]
}

get

/orders/discount-items/{id}/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this discount item.

Responses

200

Successful response for status code 200.

application/json

amountstring · decimalOptional

The field defines the total amount of the loyalty transaction.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

cancel_amountstring · decimalOptional

The field defines the refunded amount of the discount.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

conditional_offerinteger · nullableOptional

The field defines the associated condition offer ID.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

dataany · nullableOptional

The field defines the data related to the discount item.

data_source_discount_sharing_ratestring · decimal · nullableOptional

Numerical value representing quantity or total amount.

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

namestring · max: 1024Optional

The full name or label associated with the record.

orderintegerOptional

The field defines the order of the category node.

session_offerinteger · nullableOptional

The field defines the associated condition offer ID.

404

Object not found.

application/json

get

/orders/discount-items/{id}/

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": "2026-03-06T21:56:49.310Z",
  "data": null,
  "data_source_discount_sharing_rate": "text",
  "id": 1,
  "modified_date": "2026-03-06T21:56:49.310Z",
  "name": "text",
  "order": 1,
  "session_offer": 1
}

get

/orders/order-items/

Retrieves information about items included in orders, showing product identifiers, pricing, and status details.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

attributesany · nullableOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsany · nullableOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

datasourceintegerOptional

Query parameter datasource used to filter results based on specific conditions.

defined_shipping_companystringOptional

Query parameter defined_shipping_company used to filter results based on specific conditions.

defined_tracking_urlstringOptional

Query parameter defined_tracking_url used to filter results based on specific conditions.

delivered_datestring · date-timeOptional

Query parameter delivered_date used to filter results based on specific conditions.

e_archive_urlstringOptional

Query parameter e_archive_url used to filter results based on specific conditions.

estimated_delivery_datestring · dateOptional

Query parameter estimated_delivery_date used to filter results based on specific conditions.

extra_fieldany · nullableOptional

Query parameter extra_field used to filter results based on specific conditions.

extra_product_priceintegerOptional

Query parameter extra_product_price used to filter results based on specific conditions.

extra_product_stockintegerOptional

Query parameter extra_product_stock used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

imagestringOptional

Query parameter image used to filter results based on specific conditions.

invoice_datestring · date-timeOptional

Query parameter invoice_date used to filter results based on specific conditions.

invoice_numberstringOptional

Query parameter invoice_number used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesany · nullableOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsany · nullableOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

orderintegerOptional

Query parameter order used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

parentintegerOptional

Query parameter parent used to filter results based on specific conditions.

pricenumberOptional

Query parameter price used to filter results based on specific conditions.

price_currencystringOptional

Query parameter price_currency used to filter results based on specific conditions.

productintegerOptional

Query parameter product used to filter results based on specific conditions.

retail_pricenumberOptional

Query parameter retail_price used to filter results based on specific conditions.

shipped_datestring · date-timeOptional

Query parameter shipped_date used to filter results based on specific conditions.

shipping_companystringOptional

Query parameter shipping_company used to filter results based on specific conditions.

shipping_option_groupintegerOptional

Query parameter shipping_option_group used to filter results based on specific conditions.

shipping_tracking_urlstringOptional

Query parameter shipping_tracking_url used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

statusstringOptional

Query parameter status used to filter results based on specific conditions.

tax_ratenumberOptional

Query parameter tax_rate used to filter results based on specific conditions.

tracking_numberstringOptional

Query parameter tracking_number used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/orders/order-items/

GET /api/v1/remote/1/data-warehouse/orders/order-items/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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": "2026-03-06T21:56:49.310Z",
      "datasource": 1,
      "defined_shipping_company": "text",
      "defined_tracking_url": "https://example.com",
      "delivered_date": "2026-03-06T21:56:49.310Z",
      "e_archive_url": "https://example.com",
      "estimated_delivery_date": "2026-03-06",
      "extra_field": null,
      "extra_product_price": 1,
      "extra_product_stock": 1,
      "id": 1,
      "image": "https://example.com",
      "invoice_date": "2026-03-06T21:56:49.310Z",
      "invoice_number": "text",
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2026-03-06T21:56:49.310Z",
      "order": 1,
      "parent": 1,
      "price": "text",
      "price_currency": "try",
      "product": 1,
      "retail_price": "text",
      "shipped_date": "2026-03-06T21:56:49.310Z",
      "shipping_company": "aras",
      "shipping_option_group": 1,
      "shipping_tracking_url": "https://example.com",
      "status": "50",
      "tax_rate": "text",
      "tracking_number": "text"
    }
  ]
}

get

/orders/order-items/{id}/

Retrieves information about items included in orders, showing product identifiers, pricing, and status details. This endpoint retrieves a specific record by its unique identifier.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this order item.

Responses

200

Successful response for status code 200.

application/json

attributesany · nullableOptional

The field defines the attributes of the category node.

attributes_kwargsany · nullableOptional

The field defines the details of the category node.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

datasourceinteger · nullableOptional

The field defines the ID that indicates which seller the item belongs to.

defined_shipping_companystring · max: 32 · nullableOptional

defined_tracking_urlstring · uri · max: 512 · nullableOptional

The field defines the custom tracking URL for the order item.

delivered_datestring · date-time · nullableOptional

e_archive_urlstring · uri · max: 1024 · nullableOptional

The field defines the e-archive URL for the order item.

estimated_delivery_datestring · date · nullableOptional

The field defines the estimated delivery date for the order item.

extra_fieldany · nullableOptional

The field defines additional fields or attributes related to the product.

extra_product_priceinteger · nullableOptional

The field defines the ID of the extra product price associated with the product. If not specified, the default price applies.

extra_product_stockinteger · nullableOptional

The field defines the ID of the extra product stock associated with the product. If not specified, the default stock applies.

idintegerOptional

Unique identifier for the record.

imagestring · uri · nullableOptional

This field defines the URL or path to the product's image.

invoice_datestring · date-time · nullableOptional

The field defines the invoice date for the order item.

invoice_numberstring · max: 32 · nullableOptional

The field defines the invoice number for the order item.

localized_attributesany · nullableOptional

The field defines the category node that has been translated into other languages.

localized_attributes_kwargsany · nullableOptional

The field defines the details of the translations for the category node attributes.

modified_datestring · date-timeOptional

This field defines the last updated date.

orderintegerOptional

The field defines the order of the category node.

parentinteger · nullableOptional

The field defines the ID of the associated basket item, if there is a related basket item.

pricestring · decimalOptional

The field defines the actual price of the product.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

price_currencystring · enumOptional

The field defines the price currency for the order item.

Possible values:

productintegerOptional

The field defines the product ID associated with the product price.

retail_pricestring · decimal · nullableOptional

The field defines the retail price of the product.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

shipped_datestring · date-time · nullableOptional

shipping_companystring · enumOptional

The field defines the shipping company for the order item.

Possible values:

shipping_option_groupinteger · nullableOptional

The field defines the shipping option group to which the order item belongs.

shipping_tracking_urlstring · uri · max: 500 · nullableOptional

The field defines the shipping tracking URL for the order item.

statusstring · enumOptional

Current status of the record (e.g., active, inactive).

Possible values:

tax_ratestring · decimalOptional

The field defines the tax rate applied to the product.

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

tracking_numberstring · max: 256 · nullableOptional

The field defines the tracking number for the order item.

404

Object not found.

application/json

get

/orders/order-items/{id}/

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": "2026-03-06T21:56:49.310Z",
  "datasource": 1,
  "defined_shipping_company": "text",
  "defined_tracking_url": "https://example.com",
  "delivered_date": "2026-03-06T21:56:49.310Z",
  "e_archive_url": "https://example.com",
  "estimated_delivery_date": "2026-03-06",
  "extra_field": null,
  "extra_product_price": 1,
  "extra_product_stock": 1,
  "id": 1,
  "image": "https://example.com",
  "invoice_date": "2026-03-06T21:56:49.310Z",
  "invoice_number": "text",
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2026-03-06T21:56:49.310Z",
  "order": 1,
  "parent": 1,
  "price": "text",
  "price_currency": "try",
  "product": 1,
  "retail_price": "text",
  "shipped_date": "2026-03-06T21:56:49.310Z",
  "shipping_company": "aras",
  "shipping_option_group": 1,
  "shipping_tracking_url": "https://example.com",
  "status": "50",
  "tax_rate": "text",
  "tracking_number": "text"
}

get

/orders/orders/

Fetches order-related data, detailing financial amounts, order statuses, customer information, and various logistical details surrounding order handling.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

amountnumberOptional

Query parameter amount used to filter results based on specific conditions.

basketintegerOptional

Query parameter basket used to filter results based on specific conditions.

billing_addressintegerOptional

Query parameter billing_address used to filter results based on specific conditions.

bin_numberstringOptional

Query parameter bin_number used to filter results based on specific conditions.

cardintegerOptional

Query parameter card used to filter results based on specific conditions.

checkout_providerintegerOptional

Query parameter checkout_provider used to filter results based on specific conditions.

client_typestringOptional

Query parameter client_type used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

currencystringOptional

Query parameter currency used to filter results based on specific conditions.

defined_tracking_urlstringOptional

Query parameter defined_tracking_url used to filter results based on specific conditions.

discount_amountnumberOptional

Query parameter discount_amount used to filter results based on specific conditions.

discount_refund_amountnumberOptional

Query parameter discount_refund_amount used to filter results based on specific conditions.

e_archive_urlstringOptional

Query parameter e_archive_url used to filter results based on specific conditions.

extra_fieldany · nullableOptional

Query parameter extra_field used to filter results based on specific conditions.

gift_box_notestringOptional

Query parameter gift_box_note used to filter results based on specific conditions.

has_gift_boxbooleanOptional

Query parameter has_gift_box used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

installmentintegerOptional

Query parameter installment used to filter results based on specific conditions.

installment_countintegerOptional

Query parameter installment_count used to filter results based on specific conditions.

installment_interest_amountnumberOptional

Query parameter installment_interest_amount used to filter results based on specific conditions.

invoice_datestring · date-timeOptional

Query parameter invoice_date used to filter results based on specific conditions.

invoice_numberstringOptional

Query parameter invoice_number used to filter results based on specific conditions.

language_codestringOptional

Query parameter language_code used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

notesstringOptional

Query parameter notes used to filter results based on specific conditions.

numberstringOptional

Query parameter number used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

payment_optionintegerOptional

Query parameter payment_option used to filter results based on specific conditions.

payment_option_slugstringOptional

Query parameter payment_option_slug used to filter results based on specific conditions.

refund_amountnumberOptional

Query parameter refund_amount used to filter results based on specific conditions.

remote_addrstringOptional

Query parameter remote_addr used to filter results based on specific conditions.

segmentintegerOptional

Query parameter segment used to filter results based on specific conditions.

shipping_addressintegerOptional

Query parameter shipping_address used to filter results based on specific conditions.

shipping_amountnumberOptional

Query parameter shipping_amount used to filter results based on specific conditions.

shipping_companystringOptional

Query parameter shipping_company used to filter results based on specific conditions.

shipping_optionintegerOptional

Query parameter shipping_option used to filter results based on specific conditions.

shipping_option_slugstringOptional

Query parameter shipping_option_slug used to filter results based on specific conditions.

shipping_refund_amountnumberOptional

Query parameter shipping_refund_amount used to filter results based on specific conditions.

shipping_tax_ratenumberOptional

Query parameter shipping_tax_rate used to filter results based on specific conditions.

shipping_tracking_urlstringOptional

Query parameter shipping_tracking_url used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

statusstringOptional

Query parameter status used to filter results based on specific conditions.

tracking_numberstringOptional

Query parameter tracking_number used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

user_emailstringOptional

Query parameter user_email used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/orders/orders/

GET /api/v1/remote/1/data-warehouse/orders/orders/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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": "2026-03-06T21:56:49.310Z",
      "currency": "try",
      "defined_tracking_url": "https://example.com",
      "delivery_range": {
        "ANY_ADDITIONAL_PROPERTY": "2026-03-06T21:56:49.310Z"
      },
      "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": "2026-03-06T21:56:49.310Z",
      "invoice_number": "text",
      "language_code": "text",
      "modified_date": "2026-03-06T21:56:49.310Z",
      "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]"
    }
  ]
}

get

/orders/orders/{id}/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this order.

Responses

200

Successful response for status code 200.

application/json

amountstring · decimalOptional

This field defines the order amount.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

basketinteger · nullableOptional

This field defines the basket ID associated with the order.

billing_addressinteger · nullableOptional

Physical or electronic address details.

bin_numberstring · max: 8 · nullableOptional

This field defines the BIN (Bank Identification Number) of the credit card if payment was made by credit card.

cardinteger · nullableOptional

This field defines the Card ID stored in the database, associated with the BIN number and POS, if the payment was made by credit card.

checkout_providerinteger · nullableOptional

This field defines the provider ID if the order was placed through a checkout provider.

client_typestring · enumOptional

The classification or type related to this field.

Possible values:

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

currencystring · enumOptional

This field defines the currency used for the payment.

Possible values:

defined_tracking_urlstring · uri · max: 512 · nullableOptional

This field defines the customized tracking URL.

discount_amountstring · decimalOptional

Numerical value representing quantity or total amount.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

discount_refund_amountstring · decimalOptional

Numerical value representing quantity or total amount.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

e_archive_urlstring · uri · max: 1024 · nullableOptional

This field defines the e-invoice URL.

extra_fieldany · nullableOptional

This field defines an additional field required for the order if necessary.

gift_box_notestring · max: 160 · nullableOptional

This field defines the note for the gift box.

has_gift_boxboolean · nullableOptional

Boolean flag indicating whether the condition is met.

idintegerOptional

Unique identifier for the record.

installmentinteger · nullableOptional

This field defines the Installment database ID associated with the card.

installment_countinteger · max: 2147483647Optional

Numerical value representing quantity or total amount.

installment_interest_amountstring · decimalOptional

This field defines the total interest applied for installment payments.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

invoice_datestring · date-time · nullableOptional

This field defines the invoice date.

invoice_numberstring · max: 32 · nullableOptional

This field defines the invoice number.

language_codestring · max: 256 · nullableOptional

This field defines the language associated with the order.

modified_datestring · date-timeOptional

This field defines the last updated date.

notesstring · max: 320 · nullableOptional

This field defines the note related to the order.

numberstring · max: 128Optional

This field defines the unique order number.

payment_optionintegerOptional

This field defines the ID of the selected payment option.

payment_option_slugstring · max: 128Optional

This field defines the slug information for the selected payment option.

Pattern: ^[-a-zA-Z0-9_]+$

refund_amountstring · decimalOptional

This field defines the amount that has been returned.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

remote_addrstring · nullableOptional

This field defines the IP address from which the order was placed.

segmentinteger · nullableOptional

This field defines the segment ID information to which the user is associated, if applicable.

shipping_addressinteger · nullableOptional

Physical or electronic address details.

shipping_amountstring · decimalOptional

This field defines the shipping fee.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

shipping_companystring · enumOptional

This field defines the shipping company responsible for delivering the order.

Possible values:

shipping_optionintegerOptional

This field defines the ID of the selected shipping option.

shipping_option_slugstring · max: 128Optional

This field defines the slug information for the selected shipping option.

Pattern: ^[-a-zA-Z0-9_]+$

shipping_refund_amountstring · decimalOptional

This field defines the refunded shipping fee.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

shipping_tax_ratestring · decimal · nullableOptional

This field defines the tax rate on the shipping fee.

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

shipping_tracking_urlstring · uri · max: 500 · nullableOptional

This field defines the shipping tracking URL.

statusstring · enumOptional

Current status of the record (e.g., active, inactive).

Possible values:

tracking_numberstring · max: 256 · nullableOptional

This field defines the shipping tracking number.

userinteger · nullableOptional

This field defines the user ID of the person who placed the order.

user_emailstring · email · max: 254Optional

Email address of the user or entity.

404

Object not found.

application/json

get

/orders/orders/{id}/

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": "2026-03-06T21:56:49.310Z",
  "currency": "try",
  "defined_tracking_url": "https://example.com",
  "delivery_range": {
    "ANY_ADDITIONAL_PROPERTY": "2026-03-06T21:56:49.310Z"
  },
  "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": "2026-03-06T21:56:49.310Z",
  "invoice_number": "text",
  "language_code": "text",
  "modified_date": "2026-03-06T21:56:49.310Z",
  "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]"
}

get

/orders/transactions/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

amountnumberOptional

Query parameter amount used to filter results based on specific conditions.

auth_codestringOptional

Query parameter auth_code used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

currencystringOptional

Query parameter currency used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_succeededbooleanOptional

Query parameter is_succeeded used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

main_posintegerOptional

Query parameter main_pos used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

orderintegerOptional

Query parameter order used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

posintegerOptional

Query parameter pos used to filter results based on specific conditions.

raw_requeststringOptional

Query parameter raw_request used to filter results based on specific conditions.

raw_responsestringOptional

Query parameter raw_response used to filter results based on specific conditions.

remote_addrstringOptional

Query parameter remote_addr used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

three_d_usedbooleanOptional

Query parameter three_d_used used to filter results based on specific conditions.

transaction_idstringOptional

Query parameter transaction_id used to filter results based on specific conditions.

transaction_typestringOptional

Query parameter transaction_type used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

user_emailstringOptional

Query parameter user_email used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get

/orders/transactions/

GET /api/v1/remote/1/data-warehouse/orders/transactions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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": "2026-03-06T21:56:49.310Z",
      "currency": "try",
      "id": 1,
      "is_succeeded": true,
      "main_pos": 1,
      "modified_date": "2026-03-06T21:56:49.310Z",
      "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]"
    }
  ]
}

get

/orders/transactions/{id}/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this transaction.

Responses

200

Successful response for status code 200.

application/json

amountstring · decimalOptional

The field defines the total amount of the loyalty transaction.

Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$

auth_codestring · max: 255 · nullableOptional

The field defines the authorization code of the order transactions.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

currencystring · enumOptional

The field defines the currency of the loyalty transaction.

Possible values:

idintegerOptional

Unique identifier for the record.

is_succeededbooleanOptional

Boolean flag indicating whether the condition is met.

main_posinteger · nullableOptional

The field defines the main pos of the order transactions.

modified_datestring · date-timeOptional

This field defines the last updated date.

orderinteger · nullableOptional

The field defines the order of the category node.

posintegerOptional

The field defines the pos of the order transactions.

raw_requeststringOptional

The field defines the raw request of the order transactions.

raw_responsestring · nullableOptional

The field defines the raw response of the order transactions.

remote_addrstring · nullableOptional

This field defines the IP address of the client making the request.

three_d_usedbooleanOptional

The field defines the 3D usage status of the order transactions.

transaction_idstring · max: 512 · nullableOptional

The field defines the transaction ID of the order transactions.

transaction_typestring · enumOptional

The classification or type related to this field.

Possible values:

userinteger · nullableOptional

This field defines the user who triggered the event.

user_emailstring · email · max: 254Optional

Email address of the user or entity.

404

Object not found.

application/json

get

/orders/transactions/{id}/

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": "2026-03-06T21:56:49.310Z",
  "currency": "try",
  "id": 1,
  "is_succeeded": true,
  "main_pos": 1,
  "modified_date": "2026-03-06T21:56:49.310Z",
  "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]"
}

PreviousLoyalty NextPayments

Last updated 8 months ago

Was this helpful?