Campaigns

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

allowed_quantity_per_basketintegerOptional

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

benefitintegerOptional

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

conditionintegerOptional

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

created_datestring · date-timeOptional

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

currenciesstringOptional

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

end_datetimestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

is_available_for_data_sourcesbooleanOptional

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

is_mergablebooleanOptional

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

is_visiblebooleanOptional

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

is_visible_on_listbooleanOptional

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

kwargsany · nullableOptional

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

labelstringOptional

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

limitintegerOptional

Limits the number of results returned in the response.

max_stock_limitintegerOptional

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

max_usage_per_userintegerOptional

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

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

offer_typestringOptional

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

pageintegerOptional

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

priorityintegerOptional

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

promotionintegerOptional

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

sortstringOptional

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

start_datetimestring · date-timeOptional

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

statusstringOptional

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

translationsany · nullableOptional

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

userintegerOptional

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

voucher_codestringOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/basket-offers/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "allowed_quantity_per_basket": 1,
      "benefit": 1,
      "condition": 1,
      "created_date": "2026-03-07T03:10:02.850Z",
      "currencies": [
        "try"
      ],
      "end_datetime": "2026-03-07T03:10:02.850Z",
      "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-03-07T03:10:02.850Z",
      "offer_type": "sitewide",
      "priority": 1,
      "promotion": 1,
      "start_datetime": "2026-03-07T03:10:02.850Z",
      "status": "active",
      "translations": null,
      "user": 1,
      "voucher_code": "text"
    }
  ]
}

get

/campaigns/basket-offers/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this basket offer.

Responses

200

Successful response for status code 200.

application/json

allowed_quantity_per_basketinteger · min: -2147483648 · max: 2147483647Optional

This field defines the maximum quantity of the coupon allowed per basket (e.g., 1).

benefitintegerOptional

This field defines the ID of the benefit associated with the coupon.

conditionintegerOptional

This field defines the ID of the condition associated with the coupon.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

end_datetimestring · date-time · nullableOptional

This field defines the end date and time when the coupon expires.

idintegerOptional

Unique identifier for the record.

is_available_for_data_sourcesboolean · nullableOptional

Boolean flag indicating whether the condition is met.

is_mergablebooleanOptional

Boolean flag indicating whether the condition is met.

is_visiblebooleanOptional

Boolean flag indicating whether the condition is met.

is_visible_on_listbooleanOptional

Boolean flag indicating whether the condition is met.

kwargsany · nullableOptional

The field defines any additional parameters for the shipping option.

labelstring · max: 512 · nullableOptional

This field defines the label or name of the coupon (e.g., "test coupon 1").

max_stock_limitinteger · max: 2147483647 · nullableOptional

This field defines the maximum stock limit for the coupon (0 means no limit).

max_usage_per_userinteger · min: -2147483648 · max: 2147483647Optional

This field defines the maximum number of times the coupon can be used by a single user (0 means no limit).

modified_datestring · date-timeOptional

This field defines the last updated date.

offer_typestring · enumOptional

The classification or type related to this field.

Possible values:

priorityinteger · min: -2147483648 · max: 2147483647Optional

This field defines the priority of the coupon (e.g., 1 being the highest priority).

promotionintegerOptional

This field defines the ID of the promotion associated with the coupon.

start_datetimestring · date-time · nullableOptional

This field defines the start date and time when the coupon becomes valid.

statusstring · enumOptional

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

Possible values:

translationsany · nullableOptional

This field defines the translations of the district name.

userinteger · nullableOptional

This field defines the user who triggered the event.

voucher_codestring · max: 128 · nullableOptional

The field defines the code of the voucher applied to the basket.

404

Object not found.

application/json

get

/campaigns/basket-offers/{id}/

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-03-07T03:10:02.850Z",
  "currencies": [
    "try"
  ],
  "end_datetime": "2026-03-07T03:10:02.850Z",
  "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-03-07T03:10:02.850Z",
  "offer_type": "sitewide",
  "priority": 1,
  "promotion": 1,
  "start_datetime": "2026-03-07T03:10:02.850Z",
  "status": "active",
  "translations": null,
  "user": 1,
  "voucher_code": "text"
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

benefit_typestringOptional

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

created_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

kwargsanyOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

pageintegerOptional

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

product_collectionintegerOptional

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

sortstringOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/benefits/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "benefit_type": "multibuy",
      "created_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "kwargs": null,
      "kwargs[price_type]": "text",
      "modified_date": "2026-03-07T03:10:02.850Z",
      "product_collection": 1
    }
  ]
}

get

/campaigns/benefits/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this benefit.

Responses

200

Successful response for status code 200.

application/json

benefit_typestring · enumOptional

The classification or type related to this field.

Possible values:

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

kwargsanyOptional

The field defines any additional parameters for the shipping option.

kwargs[price_type]stringOptional

The field defines which price type the discount will be applied to. unit_price, discount_unit_price, retail_price

modified_datestring · date-timeOptional

This field defines the last updated date.

product_collectioninteger · nullableOptional

The field defines the collection that will be displayed on the page.

404

Object not found.

application/json

get

/campaigns/benefits/{id}/

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-03-07T03:10:02.850Z",
  "id": 1,
  "kwargs": null,
  "kwargs[price_type]": "text",
  "modified_date": "2026-03-07T03:10:02.850Z",
  "product_collection": 1
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

basket_offerintegerOptional

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

codestringOptional

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

created_datestring · date-timeOptional

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

discount_itemintegerOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

orderintegerOptional

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

pageintegerOptional

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

sortstringOptional

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

statusstringOptional

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

userintegerOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/bulk-voucher-codes/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "basket_offer": 1,
      "code": "text",
      "created_date": "2026-03-07T03:10:02.850Z",
      "discount_item": 1,
      "id": 1,
      "modified_date": "2026-03-07T03:10:02.850Z",
      "order": 1,
      "status": "active",
      "translations": "text",
      "user": 1
    }
  ]
}

get

/campaigns/bulk-voucher-codes/{id}/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this bulk voucher code.

Responses

200

Successful response for status code 200.

application/json

basket_offerintegerOptional

The field defines the ID of the associated basket offer.

codestring · max: 32Optional

The field defines the code to be used for the discount.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

discount_iteminteger · nullableOptional

Numerical value representing quantity or total amount.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

orderinteger · nullableOptional

The field defines the order of the category node.

statusstring · enumOptional

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

Possible values:

translationsstringOptional

This field defines any translations for the promotions, if available.

userinteger · nullableOptional

This field defines the user who triggered the event.

404

Object not found.

application/json

get

/campaigns/bulk-voucher-codes/{id}/

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-03-07T03:10:02.850Z",
  "discount_item": 1,
  "id": 1,
  "modified_date": "2026-03-07T03:10:02.850Z",
  "order": 1,
  "status": "active",
  "translations": "text",
  "user": 1
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

condition_typestringOptional

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

created_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

kwargsanyOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

pageintegerOptional

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

product_collectionintegerOptional

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

sortstringOptional

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

translationsany · nullableOptional

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

upsell_messagestringOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/conditions/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "condition_type": "distinct",
      "created_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "kwargs": null,
      "kwargs[price_type]": "text",
      "modified_date": "2026-03-07T03:10:02.850Z",
      "product_collection": 1,
      "translations": null,
      "upsell_message": "text"
    }
  ]
}

get

/campaigns/conditions/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this condition.

Responses

200

Successful response for status code 200.

application/json

condition_typestring · enumOptional

The classification or type related to this field.

Possible values:

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

kwargsanyOptional

The field defines any additional parameters for the shipping option.

kwargs[price_type]stringOptional

The field defines which price type the discount will be applied to. unit_price, discount_unit_price, retail_price

modified_datestring · date-timeOptional

This field defines the last updated date.

product_collectioninteger · nullableOptional

The field defines the collection that will be displayed on the page.

translationsany · nullableOptional

This field defines the translations of the district name.

upsell_messagestring · max: 512Optional

This field defines the message prompting users to add more products to their cart to qualify for free shipping.

404

Object not found.

application/json

get

/campaigns/conditions/{id}/

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-03-07T03:10:02.850Z",
  "id": 1,
  "kwargs": null,
  "kwargs[price_type]": "text",
  "modified_date": "2026-03-07T03:10:02.850Z",
  "product_collection": 1,
  "translations": null,
  "upsell_message": "text"
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

attributesanyOptional

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

attributes_kwargsanyOptional

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

created_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesanyOptional

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

localized_attributes_kwargsanyOptional

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

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

numberstringOptional

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

pageintegerOptional

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

sortstringOptional

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

userintegerOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/loyalty-cards/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attributes": null,
      "attributes_kwargs": null,
      "created_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2026-03-07T03:10:02.850Z",
      "number": "text",
      "user": 1
    }
  ]
}

get

/campaigns/loyalty-cards/{id}/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this loyalty card.

Responses

200

Successful response for status code 200.

application/json

attributesanyOptional

The field defines the attributes of the category node.

attributes_kwargsanyOptional

The field defines the details of the category node.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

localized_attributesanyOptional

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

localized_attributes_kwargsanyOptional

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

modified_datestring · date-timeOptional

This field defines the last updated date.

numberstring · max: 64Optional

The field defines the loyalty account number.

userintegerOptional

This field defines the user who triggered the event.

404

Object not found.

application/json

get

/campaigns/loyalty-cards/{id}/

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-03-07T03:10:02.850Z",
  "id": 1,
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2026-03-07T03:10:02.850Z",
  "number": "text",
  "user": 1
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

collectionintegerOptional

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

created_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

pageintegerOptional

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

productintegerOptional

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

sortstringOptional

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

uuidstring · uuidOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/product-collection-items/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "collection": 1,
      "created_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "modified_date": "2026-03-07T03:10:02.850Z",
      "product": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

/campaigns/product-collection-items/{id}/

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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this product collection item.

Responses

200

Successful response for status code 200.

application/json

collectionintegerOptional

The field defines the ID of the collection that the collection item is associated with.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

productintegerOptional

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

uuidstring · uuidOptional

Unique identifier for the record.

404

Object not found.

application/json

get

/campaigns/product-collection-items/{id}/

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-03-07T03:10:02.850Z",
  "id": 1,
  "modified_date": "2026-03-07T03:10:02.850Z",
  "product": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

/campaigns/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..

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

collection_typestringOptional

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

created_datestring · date-timeOptional

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

expiration_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

is_activebooleanOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

namestringOptional

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

pageintegerOptional

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

slugstringOptional

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

sortstringOptional

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

sort_optionintegerOptional

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

uuidstring · uuidOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/product-collections/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "collection_type": "static",
      "created_date": "2026-03-07T03:10:02.850Z",
      "expiration_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "is_active": true,
      "modified_date": "2026-03-07T03:10:02.850Z",
      "name": "text",
      "slug": "text",
      "sort_option": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

/campaigns/product-collections/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this product collection.

Responses

200

Successful response for status code 200.

application/json

collection_typestring · enumOptional

The classification or type related to this field.

Possible values:

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

expiration_datestring · date-time · nullableOptional

The field defines the validity date for the dynamic collection.

idintegerOptional

Unique identifier for the record.

is_activebooleanOptional

Boolean flag indicating whether the condition is met.

modified_datestring · date-timeOptional

This field defines the last updated date.

namestring · max: 255Optional

The full name or label associated with the record.

slugstring · max: 255Optional

The field defines the slug of the shipping option.

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

sort_optioninteger · nullableOptional

The field defines the ID of the sort option applied to order the category.

uuidstring · uuidOptional

Unique identifier for the record.

404

Object not found.

application/json

get

/campaigns/product-collections/{id}/

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-03-07T03:10:02.850Z",
  "expiration_date": "2026-03-07T03:10:02.850Z",
  "id": 1,
  "is_active": true,
  "modified_date": "2026-03-07T03:10:02.850Z",
  "name": "text",
  "slug": "text",
  "sort_option": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

created_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

namestringOptional

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

pageintegerOptional

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

slugstringOptional

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

sortstringOptional

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

translationsany · nullableOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/promotions/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "created_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "modified_date": "2026-03-07T03:10:02.850Z",
      "name": "text",
      "slug": "text",
      "translations": null
    }
  ]
}

get

/campaigns/promotions/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this promotion.

Responses

200

Successful response for status code 200.

application/json

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

namestring · max: 255Optional

The full name or label associated with the record.

slugstring · max: 255Optional

The field defines the slug of the shipping option.

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

translationsany · nullableOptional

This field defines the translations of the district name.

404

Object not found.

application/json

get

/campaigns/promotions/{id}/

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-03-07T03:10:02.850Z",
  "id": 1,
  "modified_date": "2026-03-07T03:10:02.850Z",
  "name": "text",
  "slug": "text",
  "translations": null
}

get

/campaigns/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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

codestringOptional

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

created_datestring · date-timeOptional

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

idintegerOptional

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

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

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

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

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

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

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

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

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

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

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

pageintegerOptional

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

responseanyOptional

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

sortstringOptional

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

statusstringOptional

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

typestringOptional

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

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

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

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

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

get

/campaigns/session-offers/

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

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "code": "text",
      "created_date": "2026-03-07T03:10:02.850Z",
      "id": 1,
      "modified_date": "2026-03-07T03:10:02.850Z",
      "response": null,
      "status": "active",
      "type": "ayakkabidunyasi"
    }
  ]
}

get

/campaigns/session-offers/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this session offer.

Responses

200

Successful response for status code 200.

application/json

codestring · max: 128Optional

The field defines the code to be used for the discount.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

idintegerOptional

Unique identifier for the record.

modified_datestring · date-timeOptional

This field defines the last updated date.

responseanyOptional

The field defines the response of the 3rd party promotion request.

statusstring · enumOptional

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

Possible values:

typestring · enumOptional

The classification or type related to this field.

Possible values:

404

Object not found.

application/json

get

/campaigns/session-offers/{id}/

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-03-07T03:10:02.850Z",
  "id": 1,
  "modified_date": "2026-03-07T03:10:02.850Z",
  "response": null,
  "status": "active",
  "type": "ayakkabidunyasi"
}

PreviousBaskets NextCatalogs

Last updated 8 months ago

Was this helpful?