Data Warehouse API Guide

Getting Started

This guide outlines various methods within the system's API for retrieving data about user accounts, product data, campaign details, and more, and will assist you in leveraging the full capabilities of data warehouse API.

The endpoints described in this guide are specifically designed to support users in configuring their own custom scenarios. These APIs can be utilized in the following ways:

1. Reporting Purposes

• Extract real-time data on user accounts, product and order details, or campaign performance directly from the system. Create custom reports or dashboards to track key performance indicators (KPIs), analyze trends, and support decision-making processes.

2. Integration with Search Engines

• Retrieve essential data such as product details, pricing, and stock levels from the system to feed into your own search engine infrastructure.

Each section of this documentation details the structure of API requests and responses, ensuring clarity and ease of use. The data retrieved through the API is always up-to-date, encompassing all records up to the exact moment the request is executed. This ensures that users have access to the most current information for their reporting needs.

Important Note

All methods described in this documentation should be executed using the GET method. It is also essential to include an authorization key in the header for each request, formatted as Token <token>.

Filtering Parameters

All endpoints in this API support the following filtering options to customize and refine your queries. Each filter option is designed to provide flexibility and control over the data retrieval process.

1. ID

The id filter allows you to query records based on their unique identifier. The following lookups are available for this filter:

• gt: Greater than
• gte: Greater than or equal to
• lt: Less than
• lte: Less than or equal to
• exact: Matches the exact ID

Example Usage:

• Retrieve records with IDs greater than 100:
  ?id__gt=100
• Retrieve records with IDs less than or equal to 50:
  ?id__lte=50
• Retrieve records with the exact ID of 123:
  ?id=123

2. Modified Date

The modified_date filter allows you to query records based on the timestamp of their last modification. The following lookups are supported:

• gt: Modified after the specified date and time
• gte: Modified on or after the specified date and time
• lt: Modified before the specified date and time
• lte: Modified on or before the specified date and time

Example Usage:

• Retrieve records modified after January 10, 2025:
  ?modified_date__gt=2025-01-10
• Retrieve records modified on or before January 9, 2025:
  ?modified_date__lte=2025-01-09

Note: Dates and times must be provided in ISO 8601 format: YYYY-MM-DD.

3. Sort

The sort parameter is used to order the results of a query based on one or more fields. By default, sorting is in ascending order. Use a hyphen (-) before a field to sort in descending order.

Example Usage:

• Sort records by id in ascending order:
  ?sort=id
• Sort records by modified_date in descending order:
  ?sort=-modified_date

4. Page

The page parameter is used for pagination to retrieve a specific subset of records.

Example Usage:

• Retrieve the second page of results: ?page=2

Example Query Combining Filters

Retrieve records with the following criteria:

• IDs greater than 100
• Modified on or after January 10, 2025
• Sorted by modified_date in descending order
• Display the first page of results

Example:

?id__gt=100&modified_date__gte=2025-01-10&sort=-modified_date&page=1

1. Email Addresses

This method is used to retrieve information about the email addresses associated with user accounts. Each email address entry provides essential details about the email address, such as its verification status, whether it is the primary email for the user, and the associated user ID.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/account/email-addresses

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/account/email-addresses/?page=2",
    "previous": null,
    "results": [
        {
            "id": 3998,
            "email": "xxx@akinon.com",
            "verified": false,
            "primary": true,
            "user": 3996
        },
        {
            "id": 3569,
            "email": "yyy@akinon.com",
            "verified": false,
            "primary": true,
            "user": 3567
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
email	String	This field defines the email address.
verified	Boolean	This field defines whether the email address has been verified.
primary	Boolean	This field defines whether the email address is the primary one among the user's email addresses.
user	Integer	This field defines the user ID.

2. Addresses

This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/addresses

Example Response

{
    "count": 1,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/addresses/?page=2",
    "previous": null,
    "results": [
        {
            "id": 35,
            "address_type": "customer",
            "created_date": "2021-12-15T11:00:16.884318Z",
            "modified_date": "2021-12-15T11:00:16.884337Z",
            "email": "example@akinon.com",
            "phone_number": "05XXXXXXXXX",
            "first_name": "John",
            "last_name": "Doe",
            "line": "Lorem Mah. Ipsum Sk. Apt. Aki N10",
            "is_active": true,
            "postcode": "",
            "notes": null,
            "company_name": "",
            "tax_office": "",
            "tax_no": "",
            "e_bill_taxpayer": false,
            "hash_data": "e3d841472c1463dfd9396d1ac38d1f88",
            "remote_id": null,
            "identity_number": null,
            "title": "",
            "primary": false,
            "extra_field": null,
            "country": 1,
            "city": 43,
            "township": 490,
            "district": 35235,
            "retail_store": null,
            "user": 2083
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
address_type	String	This field defines the address type. Possible values are: customer, retail_store, pickup_location, checkout_provider
email	String	This field defines the email address associated with the address.
phone_number	String	This field defines the phone number associated with the address.
first_name	String	This field defines the name of the address owner.
last_name	String	This field defines the surname of the address owner.
line	String	This field defines the full address associated with the location.
is_active	Boolean	This field defines whether the address is active.
postcode	String	This field defines the postal code.
notes	String	This field defines the note associated with the address.
tax_office	String	This field defines the tax office associated with the address.
tax_no	String	This field defines the tax number associated with the address.
e_bill_taxpayer	Boolean	This field defines whether the person is an e-bill taxpayer.
hash_data	String	This field defines the hash value generated using specific fields associated with the address.
remote_id	String	This field defines the ID corresponding to the address from any 3rd party address service.
identity_number	String	This field defines the identification number.
title	String	This field defines the address title.
primary	String	This field defines whether the address is the default among the user's addresses.
extra_field	Dictionary	This field defines the extra fields associated with the address.
country	Integer	This field defines the country ID associated with the address.
city	Integer	This field defines the city ID associated with the address.
township	Integer	This field defines the township ID associated with the address.
district	Integer	This field defines the district ID associated with the address.
retail_store	Integer	This field defines the retail_store ID associated with the address.
user	Integer	This field defines the user ID.

3. Districts

This method retrieves district data, including name, status of activity, and related geographical identifiers like city and township.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/districts

Example Response

{
    "count":2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/districts/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "translations": null,
            "created_date": "2021-12-14T09:49:56.542156Z",
            "modified_date": "2021-12-14T14:54:15.659708Z",
            "is_active": true,
            "name": "Test District 1",
            "postcode": null,
            "city": 3,
            "township": 2
        },
        {
            "id": 2,
            "translations": null,
            "created_date": "2021-12-14T09:49:56.591533Z",
            "modified_date": "2021-12-14T14:54:15.752098Z",
            "is_active": true,
            "name": "Test District 2",
            "postcode": null,
            "city": 3,
            "township": 1
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
translations	Dictionary	This field defines the translations of the district name.
is_active	Boolean	This field defines whether the district is active.
name	String	This field defines the name of the district.
postcode	String	This field defines the postcode of the district.
city	Integer	This field defines the city ID associated with the district.
township	Integer	This field defines the township ID associated with the district.

4. Countries

This method provides a list of countries available in the system, detailing the ID, name, and code of each country.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/countries

Example Response

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 67,
            "translations": null,
            "created_date": "2022-03-09T11:24:14.749694Z",
            "modified_date": "2022-07-25T14:52:21.731299Z",
            "is_active": false,
            "name": "England",
            "code": "en"
        },
        {
            "id": 1,
            "translations": null,
            "created_date": "2021-12-14T09:31:24.513867Z",
            "modified_date": "2021-12-14T14:43:25.201098Z",
            "is_active": true,
            "name": "Türkiye",
            "code": "tr"
        },
        {
            "id": 100,
            "translations": null,
            "created_date": "2024-03-28T11:03:58.645805Z",
            "modified_date": "2024-03-28T11:09:20.480423Z",
            "is_active": true,
            "name": "romania",
            "code": "RO"
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
translations	Dictionary	This field defines the translations of the country name.
is_active	Boolean	This field defines whether the country is active.
name	String	This field defines the name of the country.
code	String	This field defines the country code.

5. Cities

Retrieves data about cities, including their names, creation and modification dates, country code, and whether they are active or not.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cities

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/cities/?page=2",
    "previous": null,
    "results": [
        {
            "id": 9,
            "translations": null,
            "created_date": "2021-12-14T15:05:07.736025Z",
            "modified_date": "2021-12-14T15:05:07.736043Z",
            "is_active": true,
            "name": "AMASYA",
            "priority": null,
            "postcode": null,
            "country": 1
        },
        {
            "id": 10,
            "translations": null,
            "created_date": "2021-12-14T15:05:07.780098Z",
            "modified_date": "2021-12-14T15:05:07.780117Z",
            "is_active": true,
            "name": "ANKARA",
            "priority": null,
            "postcode": null,
            "country": 1
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
translations	Dictionary	This field defines the translations of the city name.
is_active	Boolean	This field defines whether the city is active.
name	String	This field defines the name of the city.
priority	Integer	This field defines the priority of the city.
postcode	String	This field defines the postcode of the city.
country	Integer	This field defines the country ID associated with the city.

6. Townships

Similar to districts, this retrieves information about townships, linked to cities in the system.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/townships

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/townships/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "translations": null,
            "created_date": "2021-12-14T09:39:31.257263Z",
            "modified_date": "2021-12-14T14:43:24.849496Z",
            "is_active": true,
            "name": "Test Township 2",
            "postcode": null,
            "city": 3
        },
        {
            "id": 2,
            "translations": null,
            "created_date": "2021-12-14T09:39:31.312401Z",
            "modified_date": "2021-12-14T14:43:24.905228Z",
            "is_active": true,
            "name": "Test Township 1",
            "postcode": null,
            "city": 3
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
translations	Dictionary	This field defines the translations of the township name.
is_active	Boolean	This field defines whether the township is active.
name	String	This field defines the name of the township.
postcode	String	This field defines the postcode of the township.
city	Integer	This field defines the city ID associated with the township.

7. Users

This method gets user profile details including username, email and various status or preferences indicators such as if the user is active, staff, superuser, or verified.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/users

Example Response

{
    "count": 1,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/users/?page=2",
    "previous": null,
    "results": [
        {
            "id": 2214,
            "gender": "male",
            "user_type": "registered",
            "last_login": "2022-02-15T13:06:30.944355Z",
            "is_superuser": false,
            "username": "5fc16680f424b2b0309fbd8fc1eb37f0@akinon.com",
            "first_name": "John",
            "last_name": "Doe",
            "email": "5fc16680f424b2b0309fbd8fc1eb37f0@akinon.com",
            "is_staff": false,
            "is_active": false,
            "date_joined": "2021-12-27T11:12:17.584260Z",
            "attributes": {
                "anonimization_time": "2023-01-10T15:02:57.294554",
                "logged_ip": "212.252.140.69",
                "register_client_type": "default",
                "verified_user": true,
                "tom_pay_allowed": true,
                "anonymized_by_user": false,
                "anonimizing_user_id": 2214
            },
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "email_allowed": true,
            "sms_allowed": true,
            "call_allowed": null,
            "avatar": null,
            "is_anonymized": true,
            "phone": "e2042aa1f736e2b77c50cc17201d2742",
            "date_of_birth": null,
            "modified_date": "2023-01-10T15:02:57.295313Z",
            "language_code": "tr-tr",
            "groups": [
                68,
                34,
                1
            ],
            "user_permissions": []
        },

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
date_joined	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
gender	String	This field defines the user's gender. Possible values are: male, female
user_type	String	This field defines the user type. Possible values are: guest, registered
last_login	String	This field defines the date of the user's last login.
is_superuser	Boolean	This field defines whether the user is a super user.
username	String	This field defines the username.
first_name	String	This field defines the user's first name.
last_name	String	This field defines the user's last name.
email	String	This field defines the user's email.
is_staff	Boolean	This field defines whether the user is a staff.
is_active	Boolean	This field defines whether the user is active.
attributes	Dictionary	This field defines a dictionary containing the user's attributes.
attributes_kwargs	Dictionary	This field defines a dictionary containing the user's attributes.
localized_attributes	Dictionary	This field defines a dictionary containing translations of the user's attributes based on the language.
localized_attributes_kwargs	Dictionary	This field defines a dictionary containing translations of the user's attributes based on the language.
email_allowed	Boolean	This field defines the user's email communication consent.
sms_allowed	Boolean	This field defines the user's SMS communication consent.
call_allowed	Boolean	This field defines the user's call communication consent.
avatar	String	This field defines the user's photo.
is_anonymized	Boolean	This field defines whether the user has been anonymized.
phone	String	This field defines the user's phone number.
date_of_birth	String	This field defines the user's birthday.
language_code	String	This field defines the user's local language.
groups	List	This field defines the permission groups to which the user is added.
user_permissions	List	This field defines the user’s permissions.

8. Favourite Products

Retrieves favorite products, containing the ID of the product and user, along with timestamps of creation and last modification. It indicates which user has marked which product as a favorite.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/favourite-products

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/favourite-products/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "created_date": "2022-03-21T09:01:37.920584Z",
            "modified_date": "2022-03-21T09:01:37.920605Z",
            "user": 2247,
            "product": 17
        },
        {
            "id": 2,
            "created_date": "2022-03-21T12:12:33.884157Z",
            "modified_date": "2022-03-21T12:12:33.884180Z",
            "user": 2247,
            "product": 20
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
user	Integer	This field defines the ID of the user who has added the favorite product.
product	Integer	This field defines the ID of the product that is marked as a favorite.

9. Product Alerts

This method provides alerts related to changes, such as when a product is back in stock or its price changes, including the user's language preference and the specific product it relates to.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/product-alerts

Example Response

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 2,
            "created_date": "2023-03-23T12:22:24.779014Z",
            "modified_date": "2023-03-23T12:22:24.779035Z",
            "language": "tr-tr",
            "is_active": true,
            "user": 4326,
            "product": 199
        },
        {
            "id": 3,
            "created_date": "2023-03-23T12:30:16.672857Z",
            "modified_date": "2023-03-23T12:30:16.672874Z",
            "language": "tr-tr",
            "is_active": true,
            "user": 4327,
            "product": 199
        },
        {
            "id": 1,
            "created_date": "2023-03-23T12:11:46.179792Z",
            "modified_date": "2023-09-19T12:00:00.888343Z",
            "language": "tr-tr",
            "is_active": false,
            "user": 4295,
            "product": 265
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
user	Integer	This field defines the ID of the user who has added the product alert.
product	Integer	This field defines the ID of the product for which the product alert has been added.
language	String	This field defines the local language.
is_active	Boolean	This field defines whether the product alert is active.

10. Orders

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

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/orders/orders

Example Response

{
    "count": 1,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/orders/orders/?page=2",
    "previous": null,
    "results": [
        {
            "id": 5974,
            "status": "300",
            "currency": "try",
            "client_type": "default",
            "shipping_company": null,
            "created_date": "2024-10-14T14:57:33.510137Z",
            "modified_date": "2024-10-14T14:57:44.718746Z",
            "number": "2736958430012460",
            "amount": "179.50",
            "discount_amount": "10.50",
            "shipping_amount": "90.00",
            "shipping_tax_rate": null,
            "refund_amount": "0.00",
            "discount_refund_amount": "0.00",
            "shipping_refund_amount": "0.00",
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "tracking_number": null,
            "defined_tracking_url": null,
            "remote_addr": "159.XXX.102.XXX",
            "has_gift_box": false,
            "gift_box_note": null,
            "language_code": "en-us",
            "notes": null,
            "delivery_range": null,
            "extra_field": {
                "funds_transfer": {
                    "reference_code": "200243242264335"
                }
            },
            "user_email": "comm2607@test.com",
            "shipping_option_slug": "cdek-cargo",
            "payment_option_slug": "test-havale",
            "bin_number": null,
            "installment_count": 1,
            "installment_interest_amount": "0.00",
            "shipping_tracking_url": null,
            "user": 6603,
            "basket": 10172,
            "shipping_option": 67,
            "payment_option": 199,
            "card": null,
            "installment": null,
            "segment": null,
            "shipping_address": 5248,
            "billing_address": 5248,
            "checkout_provider": null
        }
    ]
}

NOTE

For Order Status codes, refer to: Order Status Codes documentation.

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
status	String	This field defines the order status.
currency	String	This field defines the currency used for the payment.
client_type	String	This field defines the platform on which the order was placed. Possible values are: default, android, ios, instore, b2b
shipping_company	String	This field defines the shipping company responsible for delivering the order.
number	String	This field defines the unique order number.
amount	String	This field defines the order amount.
discount_amount	String	This field defines the discount amount.
shipping_amount	String	This field defines the shipping fee.
shipping_tax_rate	String	This field defines the tax rate on the shipping fee.
refund_amount	String	This field defines the amount that has been returned.
discount_refund_amount	String	This field defines the total amount of discounts that have been canceled.
shipping_refund_amount	String	This field defines the refunded shipping fee.
invoice_number	String	This field defines the invoice number.
invoice_date	String	This field defines the invoice date.
e_archive_url	String	This field defines the e-invoice URL.
tracking_number	String	This field defines the shipping tracking number.
defined_tracking_url	String	This field defines the customized tracking URL.
remote_addr	String	This field defines the IP address from which the order was placed.
has_gift_box	Boolean	This field defines whether the order will be placed in a gift box.
gift_box_note	String	This field defines the note for the gift box.
language_code	String	This field defines the language associated with the order.
notes	String	This field defines the note related to the order.
delivery_range	String	This field defines the estimated delivery time range for the order.
extra_field	Dictionary	This field defines an additional field required for the order if necessary.
user_email	String	This field defines the email address of the user who placed the order.
shipping_option_slug	String	This field defines the slug information for the selected shipping option.
payment_option_slug	String	This field defines the slug information for the selected payment option.
bin_number	String	This field defines the BIN (Bank Identification Number) of the credit card if payment was made by credit card.
installment_count	Integer	This field defines the number of installments selected during payment.
installment_interest_amount	String	This field defines the total interest applied for installment payments.
shipping_tracking_url	String	This field defines the shipping tracking URL.
user	Integer	This field defines the user ID of the person who placed the order.
basket	Integer	This field defines the basket ID associated with the order.
shipping_option	Integer	This field defines the ID of the selected shipping option.
payment_option	Integer	This field defines the ID of the selected payment option.
card	Integer	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.
installment	Integer	This field defines the Installment database ID associated with the card.
segment	Integer	This field defines the segment ID information to which the user is associated, if applicable.
shipping_address	Integer	This field defines the address ID where the order will be delivered.
billing_address	Integer	This field defines the billing address ID associated with the order.
checkout_provider	Integer	This field defines the provider ID if the order was placed through a checkout provider.

11. Order Items

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

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/orders/order-items

Example Response

{
    "count": 1,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/orders/order-items/?page=2",
    "previous": null,
    "results": [
        {
            "id": 530,
            "status": "100",
            "price_currency": "try",
            "shipping_company": null,
            "created_date": "2022-08-01T16:31:20.889371Z",
            "modified_date": "2022-08-18T20:33:01.224584Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "price": "799.99",
            "tax_rate": "8.00",
            "invoice_number": null,
            "invoice_date": null,
            "e_archive_url": null,
            "tracking_number": null,
            "defined_tracking_url": null,
            "retail_price": "1000.00",
            "image": null,
            "extra_field": {
                "price_extra_field": {},
                "stock_extra_field": {}
            },
            "estimated_delivery_date": null,
            "shipping_tracking_url": null,
            "order": 562,
            "product": 20,
            "parent": null,
            "extra_product_price": null,
            "extra_product_stock": null,
            "datasource": null,
            "shipping_option_group": null

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
status	String	This field defines the order item status.
shipping_company	String	The field defines the shipping company for the order item.
attributes	Dictionary	The field defines the attributes of the order item.
price_currency	String	The field defines the price currency for the order item.
attributes_kwargs	Dictionary	The field defines the attribute kwargs for the order item.
localized_attributes	Dictionary	The field defines the localized attributes for the order item.
localized_attributes_kwargs	Dictionary	The field defines the localized attribute kwargs for the order item.
price	String	The field defines the price of the order item.
tax_rate	String	The field defines the tax rate for the order item.
invoice_number	String	The field defines the invoice number for the order item.
invoice_date	String	The field defines the invoice date for the order item.
e_archive_url	String	The field defines the e-archive URL for the order item.
tracking_number	String	The field defines the tracking number for the order item.
defined_tracking_url	String	The field defines the custom tracking URL for the order item.
retail_price	String	The field defines the retail price for the order item.
image	String	The field defines the image of the order item.
extra_field	Dictionary	The field defines the extra field for the order item.
estimated_delivery_date	String	The field defines the estimated delivery date for the order item.
shipping_tracking_url	String	The field defines the shipping tracking URL for the order item.
order	Integer	The field defines the order ID associated with the order item.
product	Integer	The field defines the product ID associated with the order item.
parent	Integer	The field defines the parent ID associated with the order item.
extra_product_price	Integer	The field defines the ID of the extra product price associated with the product. If not specified, the default price applies.
extra_product_stock	Integer	The field defines the ID of the extra product stock associated with the product. If not specified, the default stock applies.
datasource	Integer	The field defines the seller from whom the order item was purchased.
shipping_option_group	Integer	The field defines the shipping option group to which the order item belongs.

12. Order 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.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/orders/transactions

Example Response

{
    "count": 2,
    "next": "https://xx.akinoncloud.com/api/v1/data-warehouse/orders/transactions/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1288,
            "transaction_type": "purchase",
            "currency": "try",
            "created_date": "2022-10-17T14:52:31.625212Z",
            "modified_date": "2022-10-17T14:52:31.625238Z",
            "user_email": "test@akinon.com",
            "remote_addr": "95.XXX.XXX.XXX",
            "transaction_id": null,
            "raw_request": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<posnetRequest><mid>6706598320</mid><tid>67360944</tid><sale><amount>10070</amount><ccno>450*********8942</ccno><currencyCode>YT</currencyCode><cvc>***</cvc><expDate>****</expDate><orderID>00000034002107963285412477</orderID></sale></posnetRequest>",
            "raw_response": "<?xml version='1.0' encoding='iso-8859-9'?><posnetResponse><approved>0</approved><respCode>0148</respCode><respText>INVALID MID TID IP. Hatalı IP:XXX.59.XXX.56</respText></posnetResponse>",
            "is_succeeded": false,
            "amount": "100.70",
            "three_d_used": false,
            "auth_code": null,
            "pos": 133,
            "order": null,
            "main_pos": null,
            "user": null
        },
        {
            "id": 983,
            "transaction_type": "redirect",
            "currency": "eur",
            "created_date": "2022-07-21T06:50:50.981786Z",
            "modified_date": "2022-07-21T06:50:50.981817Z",
            "user_email": "test@akinon.com",
            "remote_addr": "XXX.XXX.137.XX",
            "transaction_id": "REDIRECT_3D_20316422469911414_MDK",
            "raw_request": "",
            "raw_response": "",
            "is_succeeded": true,
            "amount": "205.10",
            "three_d_used": true,
            "auth_code": null,
            "pos": 1,
            "order": null,
            "main_pos": null,
            "user": 3106
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
user_email	String	The field defines the user email of the order transactions.
transaction_type	String	The field defines the type of the order transactions.
remote_addr	String	The field defines the remote address of the order transactions.
currency	String	The field defines the currency of the order transactions.
transaction_id	String	The field defines the transaction ID of the order transactions.
raw_request	Dictionary	The field defines the raw request of the order transactions.
raw_response	Dictionary	The field defines the raw response of the order transactions.
is_succeeded	Boolean	The field defines the success status of the order transactions.
amount	String	The field defines the amount of the order transactions.
three_d_used	Boolean	The field defines the 3D usage status of the order transactions.
auth_code	String	The field defines the authorization code of the order transactions.
pos	Integer	The field defines the pos of the order transactions.
order	Integer	The field defines the order of the order transactions.
main_pos	Integer	The field defines the main pos of the order transactions.
user	Integer	The field defines the user of the order transactions.

13. Order Discount Items

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

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/orders/discount-items

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/orders/discount-items/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "created_date": "2021-12-15T07:47:03.455566Z",
            "modified_date": "2021-12-15T07:47:03.459586Z",
            "name": "Winter items with 20% discount!",
            "amount": "320.00",
            "cancel_amount": "0.00",
            "data_source_discount_sharing_rate": null,
            "data": null,
            "order": 1,
            "conditional_offer": 1,
            "session_offer": null
        },
        {
            "id": 34,
            "created_date": "2022-01-17T10:17:04.598483Z",
            "modified_date": "2022-01-17T10:17:04.642435Z",
            "name": "test coupon 1",
            "amount": "50.00",
            "cancel_amount": "0.00",
            "data_source_discount_sharing_rate": null,
            "data": null,
            "order": 167,
            "conditional_offer": 68,
            "session_offer": null
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
name	String	The field defines the label of the applied discount.
amount	String	The field defines the total discount amount.
cancel_amount	String	The field defines the refunded amount of the discount.
data_source_discount_sharing_rate	String	The field defines the percentage of the discount covered by the seller.
data	Dictionary	The field defines the data related to the discount item.
order	Integer	The field defines the associated order ID.
conditional_offer	Integer	The field defines the associated condition offer ID.
session_offer	Integer	The field defines the associated condition offer ID.

14. Order 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.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/orders/benefit-applicants

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/orders/benefit-applicants/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "created_date": "2021-12-15T07:47:03.462115Z",
            "modified_date": "2021-12-15T07:47:03.462129Z",
            "discount_item": 1,
            "order_item": 1
        },
        {
            "id": 2,
            "created_date": "2021-12-15T07:47:03.470688Z",
            "modified_date": "2021-12-15T07:47:03.470702Z",
            "discount_item": 1,
            "order_item": 2
        },
        {
            "id": 3,
            "created_date": "2021-12-15T11:35:48.816719Z",
            "modified_date": "2021-12-15T11:35:48.816733Z",
            "discount_item": 2,
            "order_item": 3
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
discount_item	Integer	The field defines the associated discount item id.
order_item	Integer	The field defines the associated order item id.

15. Pretty URLs

The Pretty URLs method retrieves a list of user-friendly and SEO-optimized URL formats, referred to as Pretty URLs. Each Pretty URL entry provides a mapping from the original, non-optimized URL (old_path) to the optimized, user-friendly URL (new_path).

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/pretty-urls

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/pretty-urls/?page=2",
    "previous": null,
    "results": [
        {
            "id": 57,
            "created_date": "2021-10-25T17:57:15.696000Z",
            "modified_date": "2021-11-12T11:21:51.111000Z",
            "new_path": "/terms",
            "old_path": "/flat-page/34/",
            "func_module": "omnishop.cms.resources.views",
            "func_name": "flat_page",
            "func_initkwargs": {},
            "viewname": "flat-page",
            "args": [],
            "kwargs": {
                "flat_page_id": "34"
            },
            "query_params": {},
            "language": "tr-tr",
            "parent": null
        },
        {
            "id": 58,
            "created_date": "2021-10-25T17:57:15.702000Z",
            "modified_date": "2021-11-12T11:21:51.132000Z",
            "new_path": "/privacy",
            "old_path": "/flat-page/1/",
            "func_module": "omnishop.cms.resources.views",
            "func_name": "flat_page",
            "func_initkwargs": {},
            "viewname": "flat-page",
            "args": [],
            "kwargs": {
                "flat_page_id": "1"
            },
            "query_params": {},
            "language": "tr-tr",
            "parent": null
        }
    ]
}

Parameter	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
old_path	String	The original URL contains query strings.
new_path	String	The new SEO-optimized URL.
func_name	String	The view function used to serve the URL (e.g., ProductDetailPageApiView).
func_module	String	The file name where func_name is defined.
func_initkwargs	Dictionary	Keyword arguments passed to the view function.
viewname	String	The URL name associated with old_path (e.g., product).
args	List	The positional arguments parsed from the URL and passed to the view.
kwargs	Dictionary	The keyword arguments parsed from the URL and passed to the view.
query_params	Dictionary	The query parameters extracted from old_path.
parent	Integer	The generated Pretty URL for the default language in multi-language setups.
language	String	The language used to slugify values of UrlGeneratorConfig placeholders to generate new_path.
old_path	String	The original URL contains query strings.

16. Products

This method retrieves detailed information about the available products, including attributes, product types, and various configurations.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/products/products

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/products/products/?page=2",
    "previous": null,
    "results": [
        {
            "id": 335,
            "product_type": "0",
            "created_date": "2023-03-10T13:46:04.258931Z",
            "modified_date": "2024-06-13T07:47:16.178157Z",
            "attributes": {
                "integration_color": "SIYAH",
                "has_dynamic_price": true,
                "Age": "5-10",
                "min_miktar": "5",
                "max_miktar": "50",
                "urun_artis_degeri": "5",
                "description": "34"
            },
            "attributes_kwargs": {
                "Age": {
                    "_translations": {
                        "en-us": {
                            "label": "5-10"
                        }
                    },
                    "data_type": "dropdown",
                    "value": "5-10",
                    "label": "Genç"
                },
                "integration_color": {
                    "_translations": {
                        "en-us": {
                            "label": "Black"
                        }
                    },
                    "data_type": "dropdown",
                    "value": "SIYAH",
                    "label": "SIYAH"
                }
            },
            "localized_attributes": {
                "tr-tr": {
                    "description": "34"
                }
            },
            "localized_attributes_kwargs": {
                "tr-tr": {}
            },
            "name": "Test product",
            "base_code": "TUP-001",
            "sku": "TUP-001-XS",
            "uuid": "c4cd34ad-8270-4355-8715-62862c74cad1",
            "is_active": false,
            "extra_attributes": {},
            "listing_code": null,
            "is_seller_product": false,
            "is_listable": false,
            "is_form_required": true,
            "parent": 8,
            "attribute_set": 3,
            "custom_attribute_set": null,
            "pretty_url": 1977,
            "listable_product": null,
            "data_source": null,
            "group_products": []
        },
        {
            "id": 10,
            "product_type": "2",
            "created_date": "2021-12-14T09:31:39.145820Z",
            "modified_date": "2024-09-19T07:03:55.313919Z",
            "attributes": {
                "integration_color": "WHITE"
            },
            "attributes_kwargs": {
                "integration_color": {
                    "_translations": {
                        "en-us": {
                            "label": "WHITE"
                        }
                    },
                    "value": "WHITE",
                    "label": "2021"
                }
            },
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "bundle test",
            "base_code": "bundle test",
            "sku": "1234568686",
            "uuid": "6fa16734-0678-4a86-8827-d0e596fe49ef",
            "is_active": true,
            "extra_attributes": {},
            "listing_code": null,
            "is_seller_product": false,
            "is_listable": false,
            "is_form_required": true,
            "parent": null,
            "attribute_set": 3,
            "custom_attribute_set": null,
            "pretty_url": null,
            "listable_product": null,
            "data_source": null,
            "group_products": []
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
product_type	String	The field defines the type of the product.
attributes	Dictionary	The field defines the product's attributes.
attributes_kwargs	Dictionary	The field defines the details of the attributes.
localized_attributes	Dictionary	The field defines the product attributes that have been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the product attributes.
name	String	The field defines the name of the product.
base_code	String	The field defines the base code for the product.
sku	String	The field defines the SKU (Stock Keeping Unit) for the product.
uuid	String	The field defines a unique identifier in UUID format for the product.
is_active	Boolean	The field defines whether the product is active or not.
extra_attributes	Dictionary	The field defines additional custom attributes for the product.
listing_code	String	The field defines the listing code for the product (if applicable).
is_seller_product	Boolean	The field defines whether the product is a seller's product.
is_listable	Boolean	The field defines whether the product can be listed or not.
is_form_required	Boolean	The field defines whether the product requires a form to be filled in the checkout process.
parent	Integer	The field defines the ID of the parent product (if this product is a child product).
attribute_set	Integer	The field defines the attribute set ID that the product belongs to.
custom_attribute_set	Integer	The field defines the custom attribute set (if any) associated with the product.
pretty_url	Integer	The field defines the pretty URL ID for the product.
listable_product	Integer	The field defines whether the product is part of a listable set (if applicable).
data_source	Integer	The field defines the data source associated with the product (if applicable).
group_products	List	The field defines the grouped products (if any) associated with the main product.

17. Product Images

This method retrieves image data for products, including image links and associated metadata such as the image dimensions, status, and the product to which the image belongs.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/products/product-images

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/products/product-images/?page=2",
    "previous": null,
    "results": [
        {
            "id": 26,
            "status": "active",
            "created_date": "2021-12-14T09:31:47.452161Z",
            "modified_date": "2021-12-14T09:31:47.452182Z",
            "image": "https://a7c0d7.cdn.akinoncloud.com/products/2021/05/21/134/d1920ecc-21ac-4310-b752-cb680331113a.jpg",
            "height": 80,
            "width": 101,
            "order": 0,
            "product": 9
        },
        {
            "id": 2919,
            "status": "active",
            "created_date": "2022-06-08T14:30:56.146659Z",
            "modified_date": "2024-09-10T13:51:04.853786Z",
            "image": "https://a7c0d7.cdn.akinoncloud.com/products/2022/06/08/563/c9a1c9ce-db3c-46a9-8aa0-ae28cde75312.jpg",
            "height": 1500,
            "width": 1000,
            "order": 0,
            "product": 67
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
status	String	The field defines the current status of the image. disabled or active
image	String	The field defines the URL of the image file associated with the product.
height	Integer	The field defines the height of the image in pixels.
width	Integer	The field defines the width of the image in pixels.
order	Integer	The field defines the viewing order in which the image file will be displayed.
product	Integer	The field defines the ID of the product associated with the image.

18. Campaign Conditions

This method retrieves the specific conditions for campaigns, detailing the eligibility requirements that need to be met for a customer to benefit from a campaign. This information helps in understanding how conditions are defined for various campaigns, such as minimum purchase amounts, product quantities, or user-specific requirements.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/conditions

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/conditions/?page=2",
    "previous": null,
    "results": [
        {
            "id": 431,
            "condition_type": "amount",
            "translations": null,
            "created_date": "2022-06-20T07:35:14.467162Z",
            "modified_date": "2022-09-26T12:20:48.037487Z",
            "upsell_message": "Sepetinize {remaining} değerinde daha ürün ekleyin, kargo bedava olsun.",
            "kwargs": {
                "price_type": "unit_price",
                "query": [],
                "consume_type": "globally",
                "value": 100,
                "sub_conditions": []
            },
            "product_collection": null
        },
        {
            "id": 68,
            "condition_type": "amount",
            "translations": null,
            "created_date": "2022-01-17T10:08:26.767434Z",
            "modified_date": "2022-08-02T21:37:14.517944Z",
            "upsell_message": "Sepetinize {remaining} değerinde daha ürün ekleyin.",
            "kwargs": {
                "price_type": "unit_price",
                "overlimit": 9999,
                "value": 100,
                "sub_conditions": [
                    [
                        "basket__get_total_product_amount__gte",
                        0
                    ]
                ],
                "query": [
                    [
                        "basket__get_total_product_amount__gte",
                        0
                    ]
                ],
                "consume_type": "locally"
            },
            "product_collection": null
        },
        {
            "id": 366,
            "condition_type": "quantity",
            "translations": null,
            "created_date": "2022-06-01T09:18:56.276638Z",
            "modified_date": "2022-10-05T15:01:15.787787Z",
            "upsell_message": "",
            "kwargs": {
                "price_type": "unit_price",
                "value": 3,
                "consume_type": "locally",
                "query": [
                    [
                        "email_in",
                        [
                            "xxx@akinon.com",
                            "yyy@akinon.com",
                            "zzz@akinon.com"
                        ]
                    ]
                ],
                "distinct_by": "sku",
                "sub_conditions": [
                    [
                        "email_in",
                        [
                            "xxx@akinon.com",
                            "yyy@akinon.com",
                            "zzz@akinon.com"
                        ]
                    ]
                ]
            },
            "product_collection": 1
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
condition_type	String	The field defines the type of condition. distinct, quantity, amount, query
translations	Dictionary	This field defines the translations of the condition.
upsell_message	String	This field defines the message prompting users to add more products to their cart to qualify for free shipping.
kwargs	Dictionary	This field defines various conditions and configurations for pricing and consumption.
kwargs[price_type]	String	The field defines which price type the discount will be applied to. unit_price, discount_unit_price, retail_price
product_collection	Integer	This field defines the product collection id associated with this condition.

19. Campaign Benefits

This method retrieves the benefits associated with specific campaigns that are applied when the corresponding campaign conditions are met. These benefits can include discounts, free products, or shipping offers, among others. Each benefit is linked to certain pricing conditions and may be applied globally or locally to qualifying items in the campaign.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/benefits

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/benefits/?page=2",
    "previous": null,
    "results": [
        {
            "id": 728,
            "benefit_type": "fixed",
            "created_date": "2022-09-14T10:42:46.111952Z",
            "modified_date": "2022-09-14T10:42:46.111965Z",
            "kwargs": {
                "price_type": "discount_unit_price",
                "amount": 1234,
                "consume_type": "locally"
            },
            "product_collection": null
        },
        {
            "id": 68,
            "benefit_type": "sample_product",
            "created_date": "2022-01-17T10:08:26.794324Z",
            "modified_date": "2022-08-02T21:37:14.524954Z",
            "kwargs": {
                "price_type": "unit_price",
                "allowed_quantity": 100,
                "amount": 50,
                "share_benefit_on_conditions": true,
                "consume_type": "locally"
            },
            "product_collection": null
        },
        {
            "id": 300,
            "benefit_type": "shipping_free",
            "created_date": "2022-05-10T12:35:50.027063Z",
            "modified_date": "2022-08-19T10:25:09.840640Z",
            "kwargs": {
                "price_type": "unit_price",
                "consume_type": "globally"
            },
            "product_collection": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
benefit_type	String	The field defines the type of benefit. multibuy, percentage, fixed, shipping_free, point, coupon, voucher, sample_product, loyalty_point
kwargs	Dictionary	This field defines various conditions and configurations for pricing and consumption.
kwargs[price_type]	String	The field defines which price type the discount will be applied to. unit_price, discount_unit_price, retail_price
product_collection	Integer	This field defines the product collection id associated with this benefit.

20. Campaign Basket Offers

This method returns details about a specific offer, including its ID, status (e.g., 'used'), type (e.g., 'coupon'), and applicable currencies. It includes timestamps for creation and modification, visibility settings, start and end dates, and usage limits. The response also provides references to the related promotion, condition, and benefit, along with the user ID associated with the offer.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/basket-offers

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/basket-offers/?page=2",
    "previous": null,
    "results": [
        {
            "id": 68,
            "status": "used",
            "offer_type": "coupon",
            "currencies": [
                "eur"
            ],
            "translations": null,
            "created_date": "2022-01-17T10:08:26.807946Z",
            "modified_date": "2022-08-02T21:37:14.529445Z",
            "label": "test coupon 1",
            "voucher_code": null,
            "is_visible": true,
            "is_visible_on_list": false,
            "start_datetime": "2022-01-17T10:04:29.208000Z",
            "end_datetime": "2023-03-30T10:04:33.353000Z",
            "priority": 1,
            "allowed_quantity_per_basket": 1,
            "is_mergable": true,
            "max_usage_per_user": 0,
            "kwargs": {},
            "is_available_for_data_sources": false,
            "max_stock_limit": 0,
            "promotion": 68,
            "condition": 68,
            "benefit": 68,
            "user": 2247
        },
        {
            "id": 728,
            "status": "active",
            "offer_type": "bulk_voucher_code",
            "currencies": [
                "try"
            ],
            "translations": null,
            "created_date": "2022-09-14T10:42:46.119532Z",
            "modified_date": "2022-09-14T10:42:46.119545Z",
            "label": null,
            "voucher_code": null,
            "is_visible": true,
            "is_visible_on_list": false,
            "start_datetime": null,
            "end_datetime": null,
            "priority": 0,
            "allowed_quantity_per_basket": 1,
            "is_mergable": true,
            "max_usage_per_user": 0,
            "kwargs": {},
            "is_available_for_data_sources": false,
            "max_stock_limit": 0,
            "promotion": 728,
            "condition": 728,
            "benefit": 728,
            "user": null
        },
        {
            "id": 2153,
            "status": "passive",
            "offer_type": "sitewide",
            "currencies": [
                "try"
            ],
            "translations": null,
            "created_date": "2024-04-25T14:15:29.718279Z",
            "modified_date": "2024-05-13T11:29:09.312415Z",
            "label": "umut testi",
            "voucher_code": null,
            "is_visible": true,
            "is_visible_on_list": true,
            "start_datetime": "2024-04-24T14:13:25.547000Z",
            "end_datetime": null,
            "priority": 0,
            "allowed_quantity_per_basket": 1,
            "is_mergable": true,
            "max_usage_per_user": 2,
            "kwargs": {
                "show_benefit_products": true
            },
            "is_available_for_data_sources": false,
            "max_stock_limit": 0,
            "promotion": 2153,
            "condition": 2153,
            "benefit": 2153,
            "user": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
offer_type	String	This field defines the type of offer. sitewide, coupon, coupon_code, voucher_code, bulk_voucher_code, bulk_coupon
translations	Dictionary	This field defines any translations for the coupon, if available.
status	String	This field defines the current status of the coupon. active, passive, used
currencies	List	This field defines the list of currencies in which the coupon is valid (e.g., "EUR").
label	String	This field defines the label or name of the coupon (e.g., "test coupon 1").
voucher_code	String	The field defines the code to be used for the discount.
is_visible	Boolean	This field defines whether the coupon is visible to users
is_visible_on_list	Boolean	This field defines whether the coupon is visible in the list (true or false).
start_datetime	String	This field defines the start date and time when the coupon becomes valid.
end_datetime	String	This field defines the end date and time when the coupon expires.
priority	Integer	This field defines the priority of the coupon (e.g., 1 being the highest priority).
allowed_quantity_per_basket	Integer	This field defines the maximum quantity of the coupon allowed per basket (e.g., 1).
is_mergable	Boolean	This field defines whether the coupon can be merged with other coupons (true or false).
max_usage_per_user	Integer	This field defines the maximum number of times the coupon can be used by a single user (0 means no limit).
kwargs	Dictionary	This field defines additional conditions or configurations for the coupon (currently empty).
is_available_for_data_sources	Boolean	This field defines whether the coupon is available for use in data sources (false in this case).
max_stock_limit	Integer	This field defines the maximum stock limit for the coupon (0 means no limit).
promotion	Integer	This field defines the ID of the promotion associated with the coupon.
condition	Integer	This field defines the ID of the condition associated with the coupon.
benefit	Integer	This field defines the ID of the benefit associated with the coupon.
user	Integer	The field defines the user ID of the person who can use the created coupon.

21. Campaign Promotions

This method retrieves details about a specific promotion, including its ID, name, slug, creation and modification timestamps, and translations (if available). It is linked to an offer, and stores the offer’s slug along with the promotion names as seen by the user.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/promotions

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/promotions/?page=2",
    "previous": null,
    "results": [
        {
            "id": 68,
            "translations": null,
            "created_date": "2022-01-17T10:08:26.743007Z",
            "modified_date": "2022-08-02T21:37:14.507136Z",
            "name": "test coupon 1",
            "slug": "test-coupon-1"
        },
        {
            "id": 596,
            "translations": null,
            "created_date": "2022-08-26T11:55:49.274970Z",
            "modified_date": "2022-08-26T11:55:49.275000Z",
            "name": "Doğum Günü Eylül 2022",
            "slug": "dogum-gunu-eylul"
        },
        {
            "id": 134,
            "translations": null,
            "created_date": "2022-02-01T11:19:34.417436Z",
            "modified_date": "2022-06-27T14:24:25.521267Z",
            "name": "indirim kodu",
            "slug": "indirim-kodu"
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
translations	Dictionary	This field defines any translations for the promotions, if available.
name	String	The field defines the name of the promotion.
slug	String	The field defines the slug associated with the promotion.

22. Bulk Voucher Codes

This method returns a list of voucher codes generated for a specific campaign. It provides details such as the voucher code, its status (active or inactive), and the associated campaign.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/bulk-voucher-codes

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/bulk-voucher-codes/?page=2",
    "previous": null,
    "results": [
        {
            "id": 34,
            "status": "active",
            "created_date": "2022-04-15T13:15:22.614196Z",
            "modified_date": "2022-04-15T13:15:22.614221Z",
            "code": "EA1C07BB3C",
            "basket_offer": 167,
            "order": null,
            "discount_item": null,
            "user": null
        },
        {
            "id": 35,
            "status": "active",
            "created_date": "2022-04-15T13:15:22.632334Z",
            "modified_date": "2022-04-15T13:15:22.632366Z",
            "code": "EA6539A787",
            "basket_offer": 167,
            "order": null,
            "discount_item": null,
            "user": null
        },
        {
            "id": 1,
            "status": "active",
            "created_date": "2022-03-21T08:02:59.115717Z",
            "modified_date": "2022-03-21T08:14:10.393467Z",
            "code": "04F3C8ED",
            "basket_offer": 167,
            "order": null,
            "discount_item": null,
            "user": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
translations	Dictionary	This field defines any translations for the promotions, if available.
code	String	The field defines the code to be used for the discount.
basket_offer	Integer	The field defines the ID of the associated basket offer.
order	Integer	The field defines the order to which the discount code has been applied.
discount_item	Integer	The field defines the discount item to which the discount code has been applied.
user	Integer	The field defines the user ID of the person who can use the created voucher code.

23. Session Offers

This method returns details about specific session-based offers, including the offer's ID, status, type (e.g., 'b2b'), creation and modification timestamps, the offer code, and additional response data if available.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/session-offers

Example Response

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "status": "used",
            "type": "b2b",
            "created_date": "2023-08-23T17:22:06.619526Z",
            "modified_date": "2023-08-23T17:22:06.619549Z",
            "code": "b2b-promotion",
            "response": {}
        },
        {
            "id": 2,
            "status": "used",
            "type": "b2b",
            "created_date": "2023-08-23T19:07:09.053046Z",
            "modified_date": "2023-08-23T19:07:09.053062Z",
            "code": "b2b-promotion",
            "response": {}
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
status	String	This field defines the current status of the coupon. active, passive, used
type	String	The field defines the type of the session offer. b2b, extension, …
code	String	The field defines the code to be used for the discount.
response	Dictionary	The field defines the response of the 3rd party promotion request.

24. Loyalty Cards

This method returns details about a specific loyalty card, including its ID, account number, creation and modification timestamps, and the associated user ID.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/loyalty-cards

Example Response

{
  "count": 2,
  "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/loyalty-cards/",
  "previous": null,
  "results": [
    {
    "id": 1,
    "created_date": "2023-04-14T02:45:56.689592Z",
    "modified_date": "2023-04-14T02:45:56.689614Z",
    "attributes": {
        "account_number": "00011111"
    },
    "attributes_kwargs": {},
    "localized_attributes": {},
    "localized_attributes_kwargs": {},
    "number": "00011111",
    "user": 2
    },
    {
    "id": 2,
    "created_date": "2023-04-14T02:49:53.706928Z",
    "modified_date": "2023-04-14T02:49:53.706950Z",
    "attributes": {
        "account_number": "0000000"
    },
    "attributes_kwargs": {},
    "localized_attributes": {},
    "localized_attributes_kwargs": {},
    "number": "0000000",
    "user": 1
    }
  ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
attributes	Dictionary	The field defines the attributes of the loyalty card.
attributes_kwargs	Dictionary	The field defines the details of the loyalty card, including points, tier, and expiration.
localized_attributes	Dictionary	The field defines the loyalty card that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the loyalty card attributes.
number	String	The field defines the loyalty card number associated with the user.
user	Integer	The field defines the ID of the user who owns the loyalty card.

25. Product Collection Items

This method returns details about a specific product collection, including its ID, UUID, creation and modification timestamps, the associated product ID, and the related collection ID.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/product-collection-items

Example Response

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 2707,
            "created_date": "2023-05-29T13:00:00.846251Z",
            "modified_date": "2023-05-29T13:00:00.846272Z",
            "uuid": "cd17669e-9174-45a3-8bab-b49da718145a9",
            "product": 532,
            "collection": 668
        },
        {
            "id": 2708,
            "created_date": "2023-05-29T13:00:38.849032Z",
            "modified_date": "2023-05-29T13:00:38.849055Z",
            "uuid": "284b3a0a-d358-4480-9525-0564d3caf1a3e",
            "product": 598,
            "collection": 667
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
uuid	String	The field defines the unique UUID associated with the collection item.
product	Integer	The field defines the ID of the product associated with the collection item.
collection	Integer	The field defines the ID of the collection that the collection item is associated with.

26. Product Collections

This method returns details about a specific product collection, including its ID, name, collection type (e.g., 'static'), creation and modification timestamps, UUID, slug, sort option, and active status. It may also include an expiration date if applicable..

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/campaigns/product-collections

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/campaigns/product-collections/?page=2",
    "previous": null,
    "results": [
        {
            "id": 172,
            "collection_type": "static",
            "created_date": "2022-03-10T08:10:39.786674Z",
            "modified_date": "2024-09-30T08:09:29.573528Z",
            "name": "GRUPLU ÜRÜN COLLECTION",
            "is_active": true,
            "expiration_date": null,
            "uuid": "6e4b5598-6a4b-45cb-8443-5c71fc330f86",
            "slug": "gruplu-urun-collection",
            "sort_option": 298
        },
        {
            "id": 469,
            "collection_type": "dynamic",
            "created_date": "2022-11-16T12:11:13.650801Z",
            "modified_date": "2023-05-16T12:15:05.172252Z",
            "name": "yeni dinamik koleksiyon",
            "is_active": false,
            "expiration_date": null,
            "uuid": "57443afe-645c-4cab-889c-913e0cdfd9e9",
            "slug": "yeni-dinamik-koleksiyon",
            "sort_option": 894
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
uuid	String	The field defines the unique UUID associated with the collection..
collection_type	String	The field defines the type of the collection. dynamic or static
name	String	The field defines the name of the collection.
is_active	Boolean	The field defines whether the collection is active or not.
expiration_date	String	The field defines the validity date for the dynamic collection.
slug	String	The field defines the unique slug for the collection.
sort_option	Integer	The field defines the ID of the option that will be used for sorting within the collection.

27. SEO

This method returns details about a specific SEO entry, including its ID, creation and modification timestamps, URL, title, description, and keywords. It also includes any associated attributes, such as CSS class, along with localized attributes if available.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/seo

Example Response

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 6,
            "created_date": "2022-02-17T12:54:17.627406Z",
            "modified_date": "2023-04-27T14:39:00.371107Z",
            "attributes": {
                "css_class": "1"
            },
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "url": "/test/abc",
            "title": "deneme1234",
            "description": "altınsay için deneme/122423535",
            "keywords": "KİŞİSELLEŞTİRİLMİŞ BİLEKLİK"
        },
        {
            "id": 67,
            "created_date": "2022-09-26T10:49:39.892644Z",
            "modified_date": "2023-01-23T12:57:31.518628Z",
            "attributes": {
                "google": {
                    "image": "add_helper_image.jpg",
                    "name": "add-helper-ios",
                    "description": "An app that helps customers to grow their business in various fields"
                }
            },
            "attributes_kwargs": {
                "google": {
                    "_translations": null,
                    "data_type": "nested",
                    "value": {}
                }
            },
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "url": "/servis-sunum-urunleri/kek-fanus/",
            "title": "Kek Fanus Modelleri & Uygun Fiyatları",
            "description": "kek ve fanus fiyatlari",
            "keywords": "#fanus"
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
attributes	Dictionary	The field defines the attributes of the SEO.
attributes_kwargs	Dictionary	The field defines the details of the SEO.
localized_attributes	Dictionary	The field defines the SEO that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the SEO attributes.
url	String	The field defines the URL that will be used for SEO purposes.
title	String	The field defines the title used for SEO purposes.
description	String	The field defines the description used for SEO purposes.
keywords	String	The field defines the keywords used for SEO purposes.

28. Special Pages

This method returns details about a specific special page, including its ID, name, URL, template, and extraction strategy. It also includes information on banners, video embedded code, associated product collection, and pretty URL. The response may also include the page’s active status, creation and modification timestamps, and any localized or additional attributes.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/special-pages

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/cms/special-pages/?page=2",
    "previous": null,
    "results": [
        {
            "id": 37,
            "extraction_strategy": "omnishop.search.strategies.DefaultProductExtractionStrategy",
            "created_date": "2022-02-09T12:55:31.590364Z",
            "modified_date": "2022-09-07T12:03:30.870002Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "a",
            "url": "/tr/b/",
            "template": "d",
            "banner": null,
            "banner_mobile": null,
            "banner_url": "f",
            "banner_description": "<p>g</p>",
            "is_active": false,
            "video_embedded_code": "e",
            "product_collection": 73,
            "pretty_url": 359
        },
        {
            "id": 44,
            "extraction_strategy": "omnishop.search.strategies.DefaultProductExtractionStrategy",
            "created_date": "2022-02-11T13:33:10.396142Z",
            "modified_date": "2022-09-08T13:13:42.943832Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "eee",
            "url": "eeeeee",
            "template": null,
            "banner": "https://a7c0d7.cdn.akinoncloud.com/special_pages/2022/09/08/106222f1-6c6a-4bf3-8aea-41582640e6ef.jpg",
            "banner_mobile": null,
            "banner_url": null,
            "banner_description": null,
            "is_active": true,
            "video_embedded_code": "it should work",
            "product_collection": 7,
            "pretty_url": 371
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
extraction_strategy	String	The field defines the strategy selected for displaying products on the page.
attributes	Dictionary	The field defines the attributes of the special page.
attributes_kwargs	Dictionary	The field defines the details of the special page.
localized_attributes	Dictionary	The field defines the special page that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the special page attributes.
name	String	The field defines the name of the special page.
url	String	The field defines the URL through which the defined special page can be accessed.
template	String	The field defines the name of the template to be rendered.
banner	String	The field defines the URL of the banner image.
banner_mobile	String	The field defines the URL of the mobile banner image.
banner_url	String	The field defines the URL of the page banner.
banner_description	String	The field defines the description area of the banner.
is_active	Boolean	The field defines whether the special page is active or not.
video_embedded_code	String	The field defines the embedded video code added to the special page.
product_collection	Integer	The field defines the collection that will be displayed on the page.
pretty_url	Integer	The field defines the pretty URL associated with the page.

29. Widget Types

This method returns details about a specific widget type, including its ID, name, and schema. The schema contains information about the widget’s attributes, such as the title, its localizability, required status, data type, and label

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/widget-types

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/cms/widget-types/?page=2",
    "previous": null,
    "results": [
        {
            "id": 70,
            "name": "Footer Menu",
            "schema": {
                "second_column_title": {
                    "is_localizable": true,
                    "data_type": "text",
                    "key": "second_column_title",
                    "label": "Second Column Title"
                },
                "second_column_items": {
                    "multi": true,
                    "schema": {
                        "is_target_blank": {
                            "choices": [
                                {
                                    "value": true,
                                    "label": "Yes"
                                },
                                {
                                    "value": false,
                                    "label": "No"
                                }
                            ],
                            "data_type": "dropdown",
                            "key": "is_target_blank",
                            "label": "Is Open at New Window?"
                        },
                        "name": {
                            "data_type": "text",
                            "key": "name",
                            "label": "Name"
                        },
                        "redirect_url": {
                            "is_localizable": true,
                            "data_type": "text",
                            "key": "redirect_url",
                            "label": "Redirect Url"
                        }
                    },
                    "data_type": "nested",
                    "key": "second_column_items",
                    "label": "Second Column Items"
                },
                "first_column_items": {
                    "multi": true,
                    "schema": {
                        "is_side_column_item": {
                            "choices": [
                                {
                                    "value": false,
                                    "label": "No"
                                },
                                {
                                    "value": true,
                                    "label": "Yes"
                                }
                            ],
                            "data_type": "dropdown",
                            "key": "is_side_column_item",
                            "label": "Is Place at Side Column?"
                        },
                        "is_target_blank": {
                            "choices": [
                                {
                                    "value": true,
                                    "label": "Yes"
                                },
                                {
                                    "value": false,
                                    "label": "No"
                                }
                            ],
                            "data_type": "dropdown",
                            "key": "is_target_blank",
                            "label": "Is Open at New Window?"
                        },
                        "name": {
                            "data_type": "text",
                            "key": "name",
                            "label": "Name"
                        },
                        "redirect_url": {
                            "is_localizable": true,
                            "data_type": "text",
                            "key": "redirect_url",
                            "label": "Redirect Url"
                        }
                    },
                    "data_type": "nested",
                    "key": "first_column_items",
                    "label": "First Column Items"
                },
                "third_column_title": {
                    "is_localizable": true,
                    "data_type": "text",
                    "key": "third_column_title",
                    "label": "Third Column Title"
                },
                "first_column_title": {
                    "is_localizable": true,
                    "data_type": "text",
                    "key": "first_column_title",
                    "label": "First Column Title"
                },
                "third_column_items": {
                    "multi": true,
                    "schema": {
                        "is_target_blank": {
                            "choices": [
                                {
                                    "value": true,
                                    "label": "Yes"
                                },
                                {
                                    "value": false,
                                    "label": "No"
                                }
                            ],
                            "data_type": "dropdown",
                            "key": "is_target_blank",
                            "label": "Is Open at New Window?"
                        },
                        "name": {
                            "data_type": "text",
                            "key": "name",
                            "label": "Name"
                        },
                        "redirect_url": {
                            "is_localizable": true,
                            "data_type": "text",
                            "key": "redirect_url",
                            "label": "Redirect Url"
                        }
                    },
                    "data_type": "nested",
                    "key": "third_column_items",
                    "label": "Third Column Items"
                }
            }
        },
        {
            "id": 100,
            "name": "Product Recommendation",
            "schema": {
                "title": {
                    "is_localizable": true,
                    "required": false,
                    "data_type": "text",
                    "key": "title",
                    "label": "Title"
                }
            }
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
name	String	The field defines the name of the widget type.
schema	Dictionary	The field defines the schema of the widget type, which includes the structure, attributes, and relationships required to render and configure the widget.

30. Widgets

This method returns details about a specific widget, including its ID, name, slug, template, creation and modification timestamps, and content type. It also includes information about the associated widget type and any attributes, both localized and non-localized.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/widgets

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/cms/widgets/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1619,
            "created_date": "2023-10-18T10:47:02.114059Z",
            "modified_date": "2023-10-18T10:47:02.114105Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "Test",
            "slug": "test",
            "template": "test",
            "content_type": 107,
            "widget_type": 893
        },
        {
            "id": 927,
            "created_date": "2022-08-15T11:24:36.003731Z",
            "modified_date": "2023-09-12T07:16:03.053789Z",
            "attributes": {
                "basket_banners": [
                    {
                        "image_link": "https://akinon.omnitron.akinon.net/tr/tr-tr/channel/1/content-management/widget-schema/form/926",
                        "image": "cms/2022/08/15/549f817c-40d4-4892-b347-8d824ef5229b.png"
                    },
                    {
                        "image_link": "asdasdasd"
                    }
                ]
            },
            "attributes_kwargs": {
                "basket_banners": [
                    {
                        "_translations": null,
                        "data_type": "nested",
                        "value": {
                            "image": {
                                "_translations": null,
                                "data_type": "image",
                                "value": "cms/2022/08/15/549f817c-40d4-4892-b347-8d824ef5229b.png"
                            }
                        }
                    },
                    {
                        "_translations": null,
                        "data_type": "nested",
                        "value": {}
                    }
                ]
            },
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "atasys",
            "slug": "atays-aa",
            "template": "atas",
            "content_type": 3,
            "widget_type": 926
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
attributes	Dictionary	The field defines the attributes of the widget
attributes_kwargs	Dictionary	The field defines the details of the widget.
localized_attributes	Dictionary	The field defines the widget that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the widget attributes.
name	String	The field defines the widget's name.
slug	String	The field defines the widget's slug.
template	String	The field defines the template used for the widget.
content_type	Integer	The field defines the widget's content type.
widget_type	Integer	The field defines the ID of the widget type that the widget is associated with.

31. Special Page Pretty URLs

This method returns details about a specific special page’s pretty URL, including its ID, creation and modification timestamps, associated special page ID, URL, and the language in which it is defined.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/special-page-pretty-urls

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/cms/special-page-pretty-urls/?page=2",
    "previous": null,
    "results": [
        {
            "id": 4804,
            "created_date": "2024-03-20T13:33:10.711319Z",
            "modified_date": "2024-03-20T13:33:10.711351Z",
            "special_page": 1,
            "url": "",
            "language": "tr-tr"
        },
        {
            "id": 4804,
            "created_date": "2024-03-20T13:33:10.711319Z",
            "modified_date": "2024-03-20T13:33:10.711351Z",
            "special_page": 2,
            "url": "",
            "language": "tr-tr"
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
special_page	Integer	The field defines the ID of the special page that it is associated with.
url	String	The field defines the pretty URL.
language	String	The field defines the language code.

32. Landing Page Types

This method returns details about a specific landing page type, including its ID, name, slug, creation and modification timestamps, and associated function module and name. It also includes the schema for the landing page, such as attributes like product badges, with their data types, requirements, and labels.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/landing-page-types

Example Response

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "created_date": "2022-08-02T08:54:56.700630Z",
            "modified_date": "2022-11-01T06:53:43.012243Z",
            "name": "Brand",
            "slug": "brand",
            "func_module": "omnishop.cms.resources.views",
            "func_name": "LandingPageView",
            "schema": {
                "product_badge_furry": {
                    "schema": {
                        "image": {
                            "required": true,
                            "data_type": "image",
                            "key": "image",
                            "label": "Görsel"
                        }
                    },
                    "data_type": "nested",
                    "key": "product_badge_furry",
                    "label": "Product Badge Furry"
                }
            }
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
name	Integer	The field defines the name of the landing page type.
slug	String	The field defines the slug of the landing page type.
func_module	String	The field defines the file name where the func_name is defined.
func_name	String	The field defines the view function used to serve the URL (e.g., ProductDetailPageApiView).
schema	Dictionary	The field defines the structure and rules for the landing page.

33. Landing Pages

This method returns details about a specific landing page, including its ID, name, URL, template, and associated landing page type. It also provides information about its active status, content type, pretty URL, and related attributes, including any localized attributes and values.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/cms/landing-pages

Example Response

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 102,
            "created_date": "2022-08-24T20:43:35.320679Z",
            "modified_date": "2023-10-20T08:18:41.101642Z",
            "attributes": {
                "product_badge_furry": {
                    "image": "cms/2022/11/01/7d4ab718-1ded-4367-aed8-3b0e7103282a.png"
                }
            },
            "attributes_kwargs": {
                "product_badge_furry": {
                    "_translations": null,
                    "data_type": "nested",
                    "value": {
                        "image": {
                            "_translations": null,
                            "data_type": "image",
                            "value": "cms/2022/11/01/7d4ab718-1ded-4367-aed8-3b0e7103282a.png"
                        }
                    }
                }
            },
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "beraa",
            "url": "dd",
            "template": "gg",
            "is_active": false,
            "content_type": 5,
            "pretty_url": 1481,
            "landing_page_type": 1,
            "attribute_value": 70
        },
        {
            "id": 1,
            "created_date": "2022-08-03T09:04:31.659420Z",
            "modified_date": "2022-09-13T13:00:44.068390Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "name": "a",
            "url": "q",
            "template": "brand/index.html",
            "is_active": false,
            "content_type": 5,
            "pretty_url": 1280,
            "landing_page_type": 1,
            "attribute_value": 75
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
attributes	Dictionary	The field defines the attributes of the landing page.
attributes_kwargs	Dictionary	The field defines the details of the landing page.
localized_attributes	Dictionary	The field defines the landing page that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the landing page attributes.
name	String	The field defines the name of the landing page.
url	String	The field defines the URL of the landing page.
template	String	The field defines the template used for the landing page.
is_active	Boolean	The field defines whether the special page is active or not.
content_type	Integer	The field defines the landing page’s content type.
pretty_url	Integer	The field defines the pretty URL associated with the page.
landing_page_type	Integer	The field defines the ID of the landing page type associated with the landing page.
attribute_value	Integer	The field defines the ID of the attribute value associated with it.

34. Loyalty Accounts

This method returns details about a specific loyalty account, including its ID, currency, balance, and whether debit is allowed. It also includes the account number, UUID, creation and modification timestamps, and the associated user email if available.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/loyalty/accounts

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/loyalty/accounts/?page=2",
    "previous": null,
    "results": [
        {
            "id": 298,
            "currency": "try",
            "created_date": "2024-01-26T14:22:58.329253Z",
            "modified_date": "2024-09-17T10:46:46.149033Z",
            "uuid": "7fce0caf-710c-43e3-acd1-65631f73343b",
            "number": "Refund Account-try",
            "user_email": null,
            "balance": "-1468.29",
            "debit_allowed": true,
            "user": null
        },
        {
            "id": 136,
            "currency": "try",
            "created_date": "2023-10-26T14:40:31.381771Z",
            "modified_date": "2023-10-26T14:40:31.381797Z",
            "uuid": "9aa5a08b-29fd-44db-9844-f8114af60c53",
            "number": "9494",
            "user_email": "test@akinon.com",
            "balance": "22000.00",
            "debit_allowed": false,
            "user": 2214
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
uuid	String	The field defines the unique UUID of the loyalty account.
number	String	The field defines the loyalty account number.
user_email	String	The field defines the email address of the user who owns the loyalty account.
balance	String	The field defines the balance available in the loyalty account.
debit_allowed	Boolean	The field defines whether debit transactions are allowed on the loyalty account.
user	Integer	The field defines the ID of the user to whom the loyalty account is associated.

35. Loyalty Transfers

This method returns details about a specific loyalty transfer, including its ID, currency, amount, and reference number. It also includes the associated loyalty account ID, transaction ID, and timestamps for creation and modification.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/loyalty/transfers

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/loyalty/transfers/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "currency": "try",
            "created_date": "2023-10-26T14:31:13.226966Z",
            "modified_date": "2023-10-26T14:31:13.226981Z",
            "uuid": "92fee5b7-98ff-4a92-9450-7a616d6d7901",
            "amount": "-300.70",
            "reference": "2431086506011755",
            "account": 134,
            "transaction": 1
        },
        {
            "id": 2,
            "currency": "try",
            "created_date": "2023-10-26T14:31:13.229323Z",
            "modified_date": "2023-10-26T14:31:13.229339Z",
            "uuid": "74fb0dc3-642e-41c0-9584-6d85b117aa27",
            "amount": "300.70",
            "reference": "2431086506011755",
            "account": 135,
            "transaction": 1
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
currency	String	The field defines the currency of the loyalty transfer.
uuid	String	The field defines the unique UUID of the loyalty transfer.
amount	String	The field defines the total amount of the loyalty transfer.
reference	String	The field defines the reference field for the loyalty transfer, which is the order number if the transfer was made for an order.
transaction	String	The field defines the transaction ID created for the loyalty transfer.

36. Loyalty Transactions

This method returns details about a specific loyalty transaction, including its ID, currency, amount, and reference number. It also includes the associated user email, order ID, user ID, remote address, and timestamps for creation and modification.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/loyalty/transactions

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/loyalty/transactions/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "currency": "try",
            "created_date": "2023-10-26T14:31:13.215606Z",
            "modified_date": "2023-10-26T14:31:13.215622Z",
            "remote_addr": "188.57.105.94",
            "uuid": "70c53926-1b0a-4fae-9d67-c9dc1ea95305",
            "amount": "300.70",
            "user_email": "test@akinon.com",
            "reference": "2431086506011755",
            "order": 3007,
            "user": 3633
        },
        {
            "id": 2,
            "currency": "try",
            "created_date": "2023-10-26T14:31:56.074843Z",
            "modified_date": "2023-10-26T14:31:56.074858Z",
            "remote_addr": "188.57.105.94",
            "uuid": "2b11e82e-0c73-40ba-aa2f-f7f134ec1211",
            "amount": "150.70",
            "user_email": "test@akinon.com",
            "reference": "2431086934712174",
            "order": 3008,
            "user": 3633
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
currency	String	The field defines the currency of the loyalty transaction.
uuid	String	The field defines the unique UUID of the loyalty transaction.
amount	String	The field defines the total amount of the loyalty transaction.
reference	String	The field defines the reference field for the loyalty transaction, which is the order number if the transfer was made for an order.
user_email	String	The field defines the email address of the user who owns the loyalty account.
order	Integer	The field defines the order associated with the transaction.
user	Integer	The field defines the ID of the user to whom the loyalty account is associated.

37. Social Accounts

This method returns details about a specific social account, including its ID, provider (e.g., 'facebook'), UID, last login date, date joined, and any additional data. It also includes the associated user ID.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/social-account/accounts

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/social-account/accounts/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "provider": "facebook",
            "uid": "1384644591011311",
            "last_login": "2022-01-17T11:38:16.728103Z",
            "date_joined": "2022-01-17T11:38:16.728121Z",
            "extra_data": "{}",
            "user": 2346
        },
        {
            "id": 166,
            "provider": "akifast",
            "uid": "6252B00AA0FB496FA5066CDBE44747D5",
            "last_login": "2023-06-12T09:47:14.690930Z",
            "date_joined": "2023-06-12T09:47:14.690946Z",
            "extra_data": "{u'phone_number': u'+905555555554', u'status': u'ACTIVE', u'akinon_user_id': u'6252B00AA0FB496FA5066CDBE44747D5', u'surname': u'bravo', u'name': u'john', u'verification_status': u'EMAIL', u'gender': None, u'identity_number': None, u'phone': {u'national_phone_number': u'5555555554', u'country_phone_code': u'+90'}, u'email_verified': None, u'birth_date': None, u'verification_date': u'2023-06-12T09:47:09.81+00:00', u'email': u'peuddeuffehaufeu-6669@yopmail.com'}",
            "user": 4590
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
provider	String	The field defines the social account provider. e.g. akifast, facebook, apple, …
uid	String	The field defines the unique UID of the social account.
last_login	String	The field defines the last login date of the user.
date_joined	String	The field defines the date when the user registered using a social account.
extra_data	Dictionary	The field defines the extra data related to the social account provider.

38. Content Types

This method returns details about a specific content type, including its ID, app label, and model. The content type is used to link to a specific model in the application, allowing for flexible object referencing.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/content-types

Example Response

{
    "count": 10,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/content-types/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "app_label": "products",
            "model": "product"
        },
        {
            "id": 2,
            "app_label": "menus",
            "model": "menuitemmodel"
        },
        {
            "id": 3,
            "app_label": "cms",
            "model": "widget"
        },
        {
            "id": 4,
            "app_label": "cms",
            "model": "seo"
        },
        {
            "id": 5,
            "app_label": "cms",
            "model": "landingpage"
        },
        {
            "id": 6,
            "app_label": "users",
            "model": "user"
        },
        {
            "id": 7,
            "app_label": "promotions",
            "model": "loyaltycard"
        },
        {
            "id": 8,
            "app_label": "admin",
            "model": "logentry"
        },
        {
            "id": 9,
            "app_label": "auth",
            "model": "group"
        },
        {
            "id": 10,
            "app_label": "auth",
            "model": "permission"
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
app_label	String	The field defines the name of the app associated with the content type.
model	String	The field defines the model name associated with the content type.

39. Redirects

This method returns details about a specific redirect URLs, including its ID, the old URL path, the new redirected path, and the associated site ID.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/redirects

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/redirects/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1519,
            "old_path": "/1691-lorem-ipsum-urun/",
            "new_path": "/1691-dolor-sit-amet/",
            "site": 1
        },
        {
            "id": 1717,
            "old_path": "/accessories/",
            "new_path": "/aksesuarlar/",
            "site": 1
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
old_path	String	The field defines the URL at which the redirection will occur.
new_path	String	The field defines the URL to which the redirection will be made.
site	String	The field defines the site ID required for the redirection.

40. POS

This method returns details about a specific POS option, including its ID, name, slug, associated payment gateway, and resource URL. It may also include a URL for 3D secure processing, if applicable

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/payments/pos

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/payments/pos/?page=2",
    "previous": null,
    "results": [
        {
            "id": 2,
            "name": "Hediye Çeki ile Öde",
            "slug": "posas_giftcard",
            "gateway": "omnicore.libs.payment_gateways.posas_giftcard.PosAsGiftCardGateway",
            "resource_url": "https://hecpoqa.a101.com.tr/",
            "three_d_resource_url": null
        },
        {
            "id": 67,
            "name": "MultiSafepay - Mastercard",
            "slug": "multisafepay-mastercard",
            "gateway": "omnicore.libs.payment_gateways.multisafepay.MultiSafepayGateway",
            "resource_url": "https://testapi.multisafepay.com/v1/json",
            "three_d_resource_url": null
        },
        {
            "id": 232,
            "name": "YKB Credit",
            "slug": "ykb-credit",
            "gateway": "omnicore.libs.payment_gateways.ykb_credit.YKBCreditGateway",
            "resource_url": "https://dpextuat.yapikredi.com.tr",
            "three_d_resource_url": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
name	String	The field defines the name of the POS.
slug	String	The field defines the unique slug or identifier used for the POS
gateway	String	The field defines which payment gateway the POS will use.
resource_url	String	The field defines the URL of the resources associated with the POS.
three_d_resource_url	String	The field defines the URL for the 3D secure resources of the POS.

41. Shipping Options

This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/shippings/shipping-options

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/shippings/shipping-options/?page=2",
    "previous": null,
    "results": [
        {
            "id": 133,
            "delivery_type": "standard",
            "translations": {
                "en-us": {
                    "name": "Test Cargo Weight Calc",
                    "description": "False"
                }
            },
            "created_date": "2022-06-01T11:28:05.631055Z",
            "modified_date": "2024-09-30T20:31:48.686564Z",
            "name": "Test Cargo Weight Calc",
            "slug": "test-cargo-weight-calc",
            "logo": null,
            "is_active": true,
            "sort_order": 0,
            "calculator": {
                "weight_field": "desi",
                "weight_ranges": [
                    {
                        "prices_per_currency": {
                            "try": {
                                "price": 0.7
                            }
                        },
                        "price": 13,
                        "upper_limit": 49,
                        "lower_limit": 0
                    },
                    {
                        "prices_per_currency": {
                            "try": {
                                "price": 2
                            }
                        },
                        "price": 21,
                        "upper_limit": 199,
                        "lower_limit": 50
                    },
                    {
                        "prices_per_currency": {
                            "try": {
                                "price": 3
                            }
                        },
                        "price": 66,
                        "upper_limit": null,
                        "lower_limit": 200
                    }
                ],
                "name": "Weight Based Calculator",
                "slug": "weight-based-calculator"
            },
            "rule": {
                "exclude": false,
                "cities": [
                    77,
                    43
                ],
                "name": "City Rule",
                "slug": "city-rule"
            },
            "kwargs": {},
            "description": "False"
        },
        {
            "id": 232,
            "delivery_type": "same_day",
            "translations": null,
            "created_date": "2023-10-31T14:11:23.404864Z",
            "modified_date": "2024-09-17T13:09:24.630956Z",
            "name": "test-option",
            "slug": "TEST-123",
            "logo": null,
            "is_active": true,
            "sort_order": 1,
            "calculator": {},
            "rule": {
                "name": "Any Rule",
                "slug": "any-rule"
            },
            "kwargs": {},
            "description": "{}"
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
delivery_type	String	The field defines the type of delivery for the shipping option same_day, next_day, standard, in_store
translations	Dictionary	This field defines the translations of the district name.
name	String	The field defines the name of the shipping option.
slug	String	The field defines the slug of the shipping option.
logo	String	The field defines the logo associated with the shipping option.
is_active	Boolean	The field defines whether the shipping option is active,
sort_order	Integer	The field defines the sort order of the shipping option.
calculator	Dictionary	The field defines the rule used to calculate the price of the shipping option.
rule	Dictionary	The field defines the rule that determines under which conditions the shipping option can be selected.
kwargs	Dictionary	The field defines any additional parameters for the shipping option.
description	String	The field defines the description of the shipping option.

42. Baskets

This method returns details about a specific shopping basket, including its ID, status, creation and modification timestamps, version, and associated voucher code. It also provides information about the user and any namespaces linked to the basket, if applicable.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/baskets/baskets

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/baskets/baskets/?page=2",
    "previous": null,
    "results": [
        {
            "id": 397,
            "status": "active",
            "created_date": "2022-01-17T06:39:41.093938Z",
            "modified_date": "2022-01-17T06:39:41.093962Z",
            "version": 1642400634409187,
            "voucher_code": null,
            "namespace": null,
            "user": null
        },
        {
            "id": 202,
            "status": "submitted",
            "created_date": "2021-12-23T13:22:15.297769Z",
            "modified_date": "2021-12-23T13:27:48.174865Z",
            "version": 1640265121490109,
            "voucher_code": null,
            "namespace": null,
            "user": 2116
        },
        {
            "id": 2,
            "status": "merged",
            "created_date": "2021-12-14T10:32:43.621526Z",
            "modified_date": "2021-12-14T11:23:50.876846Z",
            "version": 1639480084192093,
            "voucher_code": null,
            "namespace": null,
            "user": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
status	Boolean	The field defines the current status of the basket. active, inactive, expired, merged, frozen, submitted
version	String	The field defines the version of the basket, useful for tracking changes.
voucher_code	String	The field defines the code of the voucher applied to the basket.
namespace	String	The field defines the identifier used to distinguish multiple baskets for a user.
user	Integer	The field defines the user id associated with the basket.

43. Basket Items

This method returns details about a specific item in a shopping basket, including its ID, quantity, product reference, and version. It also includes information such as the associated basket ID, product ID, and any additional attributes (like tax rate, unit price, image, and extra product details), if available.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/baskets/basket-items

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/baskets/basket-items/?page=2",
    "previous": null,
    "results": [
        {
            "id": 11705,
            "currency_type": null,
            "created_date": "2024-10-15T10:50:32.264559Z",
            "modified_date": "2024-10-15T10:50:32.264584Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "version": 1728988485579827,
            "reference": "694",
            "quantity": 1,
            "tax_rate": null,
            "unit_price": null,
            "image": null,
            "basket": 10175,
            "product": 694,
            "extra_product_price": null,
            "extra_product_stock": null,
            "parent": null,
            "datasource": null
        },
        {
            "id": 11704,
            "currency_type": null,
            "created_date": "2024-10-15T10:48:17.631098Z",
            "modified_date": "2024-10-15T10:48:17.631127Z",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "version": 1728988350946378,
            "reference": "431",
            "quantity": 1,
            "tax_rate": null,
            "unit_price": null,
            "image": null,
            "basket": 10174,
            "product": 431,
            "extra_product_price": null,
            "extra_product_stock": null,
            "parent": null,
            "datasource": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
attributes	Dictionary	The field defines the attributes of the basket item.
attributes_kwargs	Dictionary	The field defines the details of the basket item.
localized_attributes	Dictionary	The field defines the basket item that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the basket item attributes.
currency_type	String	The field defines the currency used for the basket item.
version	String	The field defines the version of the basket item, useful for tracking changes.
reference	String	This field defines a reference for the basket item.
quantity	Integer	This field defines the quantity of the product.
tax_rate	String	This field defines the tax rate applied to the basket item.
unit_price	String	This field defines the unit price of the product.
image	String	This field defines the URL or path to the product's image.
basket	Integer	This field defines the ID of the basket that contains the product.
product	Integer	The field defines the ID of the product associated with the basket item.
extra_product_price	Integer	The field defines the ID of the extra product price associated with the product. If not specified, the default price applies.
extra_product_stock	Integer	The field defines the ID of the extra product stock associated with the product. If not specified, the default stock applies.
parent	Integer	The field defines the ID of the associated basket item, if there is a related basket item.
datasource	Integer	The field defines the ID that indicates which seller the item belongs to.

44. Deleted Items

This method returns details about a specific deleted item, including its ID, object ID, deletion timestamp, and the content type associated with the item.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/deleted-items

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/deleted-items/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "object_id": "628",
            "deleted_date": "2022-12-26T14:05:06.500808Z",
            "content_type": 138
        },
        {
            "id": 2,
            "object_id": "859",
            "deleted_date": "2022-12-26T14:09:50.288407Z",
            "content_type": 138
        },
        {
            "id": 34,
            "object_id": "3302",
            "deleted_date": "2022-12-27T14:10:45.122585Z",
            "content_type": 45
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
object_id	String	The field defines the ID value of the deleted object.
deleted_date	String	The field defines the deletion date of the object.
content_type	Integer	The field defines the content type of the deleted object.

45. Category Nodes

This method returns details about a specific category node, including its ID, name, path, and depth in the category hierarchy. It also includes the number of child nodes, sorting order, associated pretty URL, and timestamps for creation and modification.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/catalogs/category-nodes

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/catalogs/category-nodes/?page=2",
    "previous": null,
    "results": [
        {
            "id": 9,
            "created_date": "2021-12-14T09:31:21.317126Z",
            "modified_date": "2024-07-26T07:26:41.610456Z",
            "uuid": "1d362f9e-6f50-4235-bf36-1bd134194f50",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "path": "0001000100010005",
            "depth": 4,
            "numchild": 1,
            "order": 1,
            "name": "Swimwear",
            "pretty_url": 67,
            "sort_option": 431
        },
        {
            "id": 100,
            "created_date": "2022-07-28T07:38:21.647124Z",
            "modified_date": "2024-07-26T07:26:41.716411Z",
            "uuid": "97665973-ed41-408d-ba07-e494a7d3e478",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "path": "00010001000100050001",
            "depth": 5,
            "numchild": 1,
            "order": 1,
            "name": "puf",
            "pretty_url": 1247,
            "sort_option": 727
        },
        {
            "id": 166,
            "created_date": "2022-08-24T06:42:56.084198Z",
            "modified_date": "2024-07-26T07:26:41.820998Z",
            "uuid": "23c6903c-1e3d-472c-8fd7-565a16a9f623",
            "attributes": {},
            "attributes_kwargs": {},
            "localized_attributes": {},
            "localized_attributes_kwargs": {},
            "path": "000100010001000500010001",
            "depth": 6,
            "numchild": 0,
            "order": 1,
            "name": "Sandalet",
            "pretty_url": 1478,
            "sort_option": 826
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
attributes	Dictionary	The field defines the attributes of the category node.
attributes_kwargs	Dictionary	The field defines the details of the category node.
localized_attributes	Dictionary	The field defines the category node that has been translated into other languages.
localized_attributes_kwargs	Dictionary	The field defines the details of the translations for the category node attributes.
uuid	String	The field defines the UUID of the category node.
path	String	This field defines the path as the hierarchical route from the root to the node.
depth	Integer	This field defines the depth as the level of the node in the tree, starting from zero.
numchild	Integer	This field defines the numchild as the number of direct children the node has.
order	Integer	The field defines the order of the category node.
name	String	The field defines the name of the category.
pretty_url	String	The field defines the pretty URL of the category.
sort_option	String	The field defines the ID of the sort option applied to order the category.

46. Product Prices

This method returns details about a specific product’s price, including its ID, price type (e.g., 'default'), currency type, retail price, tax rate, and the actual price. It also provides any extra fields and the associated product ID.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/catalogs/product-prices

Example Response

{
    "count": 3,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/catalogs/product-prices/?page=2",
    "previous": null,
    "results": [
        {
            "id": 628,
            "currency_type": "try",
            "price_type": "default",
            "created_date": "2024-02-19T06:22:12.340965Z",
            "modified_date": "2024-02-19T06:22:12.340997Z",
            "retail_price": "199.00",
            "tax_rate": "8.00",
            "price": "199.00",
            "extra_field": {},
            "product": 661
        },
        {
            "id": 496,
            "currency_type": "try",
            "price_type": "default",
            "created_date": "2023-05-27T20:52:18.234301Z",
            "modified_date": "2023-05-27T20:52:18.234322Z",
            "retail_price": "111.99",
            "tax_rate": "0.18",
            "price": "109.99",
            "extra_field": {},
            "product": 530
        },
        {
            "id": 67,
            "currency_type": "try",
            "price_type": "default",
            "created_date": "2022-04-13T06:56:37.098255Z",
            "modified_date": "2024-09-19T07:03:07.485317Z",
            "retail_price": "150.00",
            "tax_rate": "10.00",
            "price": "150.00",
            "extra_field": {},
            "product": 68
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
created_date	String	This field defines the creation date.
modified_date	String	This field defines the last updated date.
currency_type	String	The field defines the currency type of the product price.
price_type	String	The field defines the type of price applied to the product.
retail_price	String	The field defines the retail price of the product.
tax_rate	String	The field defines the tax rate applied to the product.
price	String	The field defines the actual price of the product.
extra_field	Dictionary	The field defines additional fields or attributes related to the product.
product	Integer	The field defines the product ID associated with the product price.

47. Revision

This method retrieves details about specific revisions, tracking changes made to objects over time. This is useful for auditing purposes and ensures traceability of modifications. Each revision includes an ID, creation date, an optional comment explaining the change, and the user who made the revision.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/reversions/revisions

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/reversions/revisions/?page=2",
    "previous": null,
    "results": [
        {
            "id": 203,
            "date_created": "2024-05-20T08:11:05.700676Z",
            "comment": "24.XXX.93.56",
            "user": 3501
        },
        {
            "id": 100,
            "date_created": "2023-06-06T21:52:02.645500Z",
            "comment": "",
            "user": null
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
date_created	String	This field defines the timestamp when the revision was created.
comment	String	This field defines an optional description or note that explains the changes made in the revision.
user	Integer	This field defines the user who created the revision, linking the changes to a specific user.

48. Version

This method provides details about a specific version of an object, capturing the state of the object at the time of revision. When a revision is made, the object version prior to the revision is saved, allowing the system to retain the state of the object before the changes were applied.

This includes versioning information such as the ID, associated object ID, the database where the object is stored, the format (e.g., 'json'), and the serialized data representing the object. Additionally, it includes details about the revision that the object version is associated with, its content type, and its representation.

This is typically used for tracking changes to objects, enabling version control, and allowing the retrieval of specific historical states of the object for auditing, rollback, or comparison purposes.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/reversions/versions

Example Response

{
    "count": 2,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/reversions/versions/?page=2",
    "previous": null,
    "results": [
        {
            "id": 203,
            "object_id": "3501",
            "db": "default",
            "format": "json",
            "serialized_data": [
                {
                    "pk": 3501,
                    "model": "users.user",
                    "fields": {
                        "email_allowed": true,
                        "sms_allowed": false,
                        "call_allowed": null
                    }
                }
            ],
            "object_repr": "7495d69e7c2f4c2f02a987a027c6e7f5",
            "revision": 203,
            "content_type": 6
        },
        {
            "id": 100,
            "object_id": "1322",
            "db": "default",
            "format": "json",
            "serialized_data": [
                {
                    "pk": 1322,
                    "model": "flatpages.flatpage",
                    "fields": {
                        "registration_required": false,
                        "title": "KVKK Acik Riza Metni",
                        "url": "/acik-riza-metni",
                        "template_name": "flatpage/index.html",
                        "sites": [
                            1
                        ],
                        "content": "<h1>Bu metin acik riza aydinlatma metnidir..</h1>",
                        "enable_comments": false
                    }
                }
            ],
            "object_repr": "/acik-riza-metni -- KVKK Acik Riza Metni",
            "revision": 100,
            "content_type": 15
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
object_id	Integer	This field defines as the unique identifier of the versioned object in the database
db	String	This field db as the database connection where the version record is stored.
format	String	This field defines as the format in which the serialized data is stored (e.g., JSON, Pickle)
serialized_data	Dictionary	This field defines the serialized form of the object's data, representing its state at the time of the version.
object_repr	String	This field defines the string representation of the object.
revision	Integer	This field defines the revision object to which the version belongs, grouping changes together.
content_type	Integer	This field defines the model type of the versioned object.

49. Audit Events

This method returns details about an audit event, including the event's UUID, user information (email, name), timestamp, IP address, accessed URL, query parameters, post data, and request headers. Audit events are used to track user actions and system changes for security and compliance purposes.

Path: {omnitron_url}/api/v1/remote/{channel_id}/data-warehouse/audit-events

Example Response

{
    "count": 1,
    "next": "https://xxx.akinoncloud.com/api/v1/data-warehouse/audit-events/?page=2",
    "previous": null,
    "results": [
        {
            "uuid": "7176c59b-cc4e-4c44-XXXsa-a295deebe185",
            "user": {
                "pk": 2049,
                "email": "test@akinon.com",
                "first_name": "John",
                "last_name": "Doe"
            },
            "timestamp": "2024-10-15T10:49:20.209873Z",
            "remote_addr": "18.197.91.254",
            "url": "https://xxx.akinoncloud.com/api/v1/widgets/992/",
            "query_params": {},
            "post_data": {},
            "headers": {
                "X-Omnitron-Session": "1",
                "X-Omnitron-User": "test@akinon.com;test.akinon;35"
            },
            "object_id": 992,
            "content": {
                "request_method": "PATCH",
                "request_data": {
                    "widget_type": 959,
                    "attributes": {
                        "slider_items": [
                            {
                                "mobil_image": "cms/2022/10/11/d188bd54-b444-42h8b-be71-3018a4e9e3be.png",
                                "image": "cms/2024/10/15/4d7d7a49-6hecf-4925-8969-aa53275506fd.jpg",
                                "start_date": "2022-08-22T20:57:00.000Z",
                                "end_date": "2022-08-01T07:53:00.000Z"
                            }
                        ]
                    },
                    "name": "slider_anasayfa",
                    "template": "slider_anasayfa",
                    "slug": "anasayfa"
                },
                "client_type": "default",
                "request_datetime": "2024-10-15T10:49:20.207116+00:00",
                "browser_agent": "python-requests/2.32.3"
            },
            "content_type": 3
        }
    ]
}

Field Name	Data Type	Description
count	Integer	This field defines the total number of records returned.
next	String	This field defines the URL of the next page.
previous	String	This field defines the URL of the previous page.
results	List	This field returns a list of results.
id	Integer	This field defines the database ID of the record.
uuid	String	This field defines a unique identifier for the event, typically used to ensure that each event can be distinctly referenced.
user	Dictionary	This field defines the user who triggered the event.
timestamp	String	This field defines the exact date and time when the event occurred.
remote_addr	String	This field defines the IP address of the client making the request.
url	String	This field defines the URL that the client accessed during the event.
query_params	Dictionary	This field defines the query parameters included in the URL during the request.
post_data	Dictionary	This field defines the data sent by the client in the HTTP POST request.
headers	Dictionary	This field defines the HTTP headers sent along with the request, which can include metadata about the request.
object_id	Integer	This field defines the unique identifier of the object being affected by the event.
content	Dictionary	This field defines the content or details of the event, typically the data or change made.
content_type	Integer	This field defines the model type of the object being affected by the event.