Campaigns
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.
Token-based authentication with required prefix "Token"
Query parameter allowed_quantity_per_basket used to filter results based on specific conditions.
Query parameter benefit used to filter results based on specific conditions.
Query parameter condition used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter currencies used to filter results based on specific conditions.
Query parameter end_datetime used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter is_available_for_data_sources used to filter results based on specific conditions.
Query parameter is_mergable used to filter results based on specific conditions.
Query parameter is_visible used to filter results based on specific conditions.
Query parameter is_visible_on_list used to filter results based on specific conditions.
Query parameter kwargs used to filter results based on specific conditions.
Query parameter label used to filter results based on specific conditions.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter max_stock_limit used to filter results based on specific conditions.
Query parameter max_usage_per_user used to filter results based on specific conditions.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter offer_type used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter priority used to filter results based on specific conditions.
Query parameter promotion used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter start_datetime used to filter results based on specific conditions.
Query parameter status used to filter results based on specific conditions.
Query parameter translations used to filter results based on specific conditions.
Query parameter user used to filter results based on specific conditions.
Query parameter voucher_code used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/basket-offers/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"allowed_quantity_per_basket": 1,
"benefit": 1,
"condition": 1,
"created_date": "2026-01-01T00:00:00.000Z",
"currencies": [
"try"
],
"end_datetime": "2026-01-01T00:00:00.000Z",
"id": 1,
"is_available_for_data_sources": true,
"is_mergable": true,
"is_visible": true,
"is_visible_on_list": true,
"kwargs": null,
"label": "text",
"max_stock_limit": 1,
"max_usage_per_user": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"offer_type": "sitewide",
"priority": 1,
"promotion": 1,
"start_datetime": "2026-01-01T00:00:00.000Z",
"status": "active",
"translations": null,
"user": 1,
"voucher_code": "text"
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this basket offer.
Successful response for status code 200.
This field defines the maximum quantity of the coupon allowed per basket (e.g., 1).
This field defines the ID of the benefit associated with the coupon.
This field defines the ID of the condition associated with the coupon.
Timestamp indicating when the record was created.
This field defines the end date and time when the coupon expires.
Unique identifier for the record.
Boolean flag indicating whether the condition is met.
Boolean flag indicating whether the condition is met.
Boolean flag indicating whether the condition is met.
Boolean flag indicating whether the condition is met.
The field defines any additional parameters for the shipping option.
This field defines the label or name of the coupon (e.g., "test coupon 1").
This field defines the maximum stock limit for the coupon (0 means no limit).
This field defines the maximum number of times the coupon can be used by a single user (0 means no limit).
This field defines the last updated date.
The classification or type related to this field.
This field defines the priority of the coupon (e.g., 1 being the highest priority).
This field defines the ID of the promotion associated with the coupon.
This field defines the start date and time when the coupon becomes valid.
Current status of the record (e.g., active, inactive).
This field defines the translations of the district name.
This field defines the user who triggered the event.
The field defines the code of the voucher applied to the basket.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/basket-offers/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"allowed_quantity_per_basket": 1,
"benefit": 1,
"condition": 1,
"created_date": "2026-01-01T00:00:00.000Z",
"currencies": [
"try"
],
"end_datetime": "2026-01-01T00:00:00.000Z",
"id": 1,
"is_available_for_data_sources": true,
"is_mergable": true,
"is_visible": true,
"is_visible_on_list": true,
"kwargs": null,
"label": "text",
"max_stock_limit": 1,
"max_usage_per_user": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"offer_type": "sitewide",
"priority": 1,
"promotion": 1,
"start_datetime": "2026-01-01T00:00:00.000Z",
"status": "active",
"translations": null,
"user": 1,
"voucher_code": "text"
}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.
Token-based authentication with required prefix "Token"
Query parameter benefit_type used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter kwargs used to filter results based on specific conditions.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter page used to filter results based on specific conditions.
Query parameter product_collection used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/benefits/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"benefit_type": "multibuy",
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"kwargs": null,
"kwargs[price_type]": "text",
"modified_date": "2026-01-01T00:00:00.000Z",
"product_collection": 1
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this benefit.
Successful response for status code 200.
The classification or type related to this field.
Timestamp indicating when the record was created.
Unique identifier for the record.
The field defines any additional parameters for the shipping option.
The field defines which price type the discount will be applied to. unit_price, discount_unit_price, retail_price
This field defines the last updated date.
The field defines the collection that will be displayed on the page.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/benefits/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"benefit_type": "multibuy",
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"kwargs": null,
"kwargs[price_type]": "text",
"modified_date": "2026-01-01T00:00:00.000Z",
"product_collection": 1
}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.
Token-based authentication with required prefix "Token"
Query parameter basket_offer used to filter results based on specific conditions.
Query parameter code used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter discount_item used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter order used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter status used to filter results based on specific conditions.
Query parameter user used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/bulk-voucher-codes/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"basket_offer": 1,
"code": "text",
"created_date": "2026-01-01T00:00:00.000Z",
"discount_item": 1,
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"order": 1,
"status": "active",
"translations": "text",
"user": 1
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this bulk voucher code.
Successful response for status code 200.
The field defines the ID of the associated basket offer.
The field defines the code to be used for the discount.
Timestamp indicating when the record was created.
Numerical value representing quantity or total amount.
Unique identifier for the record.
This field defines the last updated date.
The field defines the order of the category node.
Current status of the record (e.g., active, inactive).
This field defines any translations for the promotions, if available.
This field defines the user who triggered the event.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/bulk-voucher-codes/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"basket_offer": 1,
"code": "text",
"created_date": "2026-01-01T00:00:00.000Z",
"discount_item": 1,
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"order": 1,
"status": "active",
"translations": "text",
"user": 1
}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.
Token-based authentication with required prefix "Token"
Query parameter condition_type used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter kwargs used to filter results based on specific conditions.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter page used to filter results based on specific conditions.
Query parameter product_collection used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter translations used to filter results based on specific conditions.
Query parameter upsell_message used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/conditions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"condition_type": "distinct",
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"kwargs": null,
"kwargs[price_type]": "text",
"modified_date": "2026-01-01T00:00:00.000Z",
"product_collection": 1,
"translations": null,
"upsell_message": "text"
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this condition.
Successful response for status code 200.
The classification or type related to this field.
Timestamp indicating when the record was created.
Unique identifier for the record.
The field defines any additional parameters for the shipping option.
The field defines which price type the discount will be applied to. unit_price, discount_unit_price, retail_price
This field defines the last updated date.
The field defines the collection that will be displayed on the page.
This field defines the translations of the district name.
This field defines the message prompting users to add more products to their cart to qualify for free shipping.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/conditions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"condition_type": "distinct",
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"kwargs": null,
"kwargs[price_type]": "text",
"modified_date": "2026-01-01T00:00:00.000Z",
"product_collection": 1,
"translations": null,
"upsell_message": "text"
}This method returns details about a specific loyalty card, including its ID, account number, creation and modification timestamps, and the associated user ID.
Token-based authentication with required prefix "Token"
Query parameter attributes used to filter results based on specific conditions.
Query parameter attributes_kwargs used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter localized_attributes used to filter results based on specific conditions.
Query parameter localized_attributes_kwargs used to filter results based on specific conditions.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter number used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter user used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/loyalty-cards/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"attributes": null,
"attributes_kwargs": null,
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"localized_attributes": null,
"localized_attributes_kwargs": null,
"modified_date": "2026-01-01T00:00:00.000Z",
"number": "text",
"user": 1
}
]
}This method returns details about a specific loyalty card, including its ID, account number, creation and modification timestamps, and the associated user ID. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this loyalty card.
Successful response for status code 200.
The field defines the attributes of the category node.
The field defines the details of the category node.
Timestamp indicating when the record was created.
Unique identifier for the record.
The field defines the category node that has been translated into other languages.
The field defines the details of the translations for the category node attributes.
This field defines the last updated date.
The field defines the loyalty account number.
This field defines the user who triggered the event.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/loyalty-cards/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"attributes": null,
"attributes_kwargs": null,
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"localized_attributes": null,
"localized_attributes_kwargs": null,
"modified_date": "2026-01-01T00:00:00.000Z",
"number": "text",
"user": 1
}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.
Token-based authentication with required prefix "Token"
Query parameter collection used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter page used to filter results based on specific conditions.
Query parameter product used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter uuid used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/product-collection-items/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"collection": 1,
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"product": 1,
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this product collection item.
Successful response for status code 200.
The field defines the ID of the collection that the collection item is associated with.
Timestamp indicating when the record was created.
Unique identifier for the record.
This field defines the last updated date.
The field defines the product ID associated with the product price.
Unique identifier for the record.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/product-collection-items/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"collection": 1,
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"product": 1,
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}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..
Token-based authentication with required prefix "Token"
Query parameter collection_type used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter expiration_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter is_active used to filter results based on specific conditions.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter name used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter slug used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter sort_option used to filter results based on specific conditions.
Query parameter uuid used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/product-collections/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"collection_type": "static",
"created_date": "2026-01-01T00:00:00.000Z",
"expiration_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"is_active": true,
"modified_date": "2026-01-01T00:00:00.000Z",
"name": "text",
"slug": "text",
"sort_option": 1,
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}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.. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this product collection.
Successful response for status code 200.
The classification or type related to this field.
Timestamp indicating when the record was created.
The field defines the validity date for the dynamic collection.
Unique identifier for the record.
Boolean flag indicating whether the condition is met.
This field defines the last updated date.
The full name or label associated with the record.
The field defines the slug of the shipping option.
^[-a-zA-Z0-9_]+$The field defines the ID of the sort option applied to order the category.
Unique identifier for the record.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/product-collections/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"collection_type": "static",
"created_date": "2026-01-01T00:00:00.000Z",
"expiration_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"is_active": true,
"modified_date": "2026-01-01T00:00:00.000Z",
"name": "text",
"slug": "text",
"sort_option": 1,
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}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.
Token-based authentication with required prefix "Token"
Query parameter created_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter name used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter slug used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter translations used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/promotions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"name": "text",
"slug": "text",
"translations": null
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this promotion.
Successful response for status code 200.
Timestamp indicating when the record was created.
Unique identifier for the record.
This field defines the last updated date.
The full name or label associated with the record.
The field defines the slug of the shipping option.
^[-a-zA-Z0-9_]+$This field defines the translations of the district name.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/promotions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"name": "text",
"slug": "text",
"translations": null
}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.
Token-based authentication with required prefix "Token"
Query parameter code used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter page used to filter results based on specific conditions.
Query parameter response used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter status used to filter results based on specific conditions.
Query parameter type used to filter results based on specific conditions.
Successful response for status code 200.
Numerical value representing quantity or total amount.
123This field defines the URL of the next page.
http://api.example.org/accounts/?page=4This field defines the URL of the previous page.
http://api.example.org/accounts/?page=2GET /api/v1/remote/1/data-warehouse/campaigns/session-offers/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"code": "text",
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"response": null,
"status": "active",
"type": "ayakkabidunyasi"
}
]
}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. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this session offer.
Successful response for status code 200.
The field defines the code to be used for the discount.
Timestamp indicating when the record was created.
Unique identifier for the record.
This field defines the last updated date.
The field defines the response of the 3rd party promotion request.
Current status of the record (e.g., active, inactive).
The classification or type related to this field.
Object not found.
GET /api/v1/remote/1/data-warehouse/campaigns/session-offers/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"created_date": "2026-01-01T00:00:00.000Z",
"id": 1,
"modified_date": "2026-01-01T00:00:00.000Z",
"response": null,
"status": "active",
"type": "ayakkabidunyasi"
}Last updated
Was this helpful?