# 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedBasketOfferList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/BasketOffer"},"type":"array"}},"type":"object"},"BasketOffer":{"properties":{"allowed_quantity_per_basket":{"description":"This field defines the maximum quantity of the coupon allowed per basket (e.g., 1).","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"benefit":{"description":"This field defines the ID of the benefit associated with the coupon.","type":"integer"},"condition":{"description":"This field defines the ID of the condition associated with the coupon.","type":"integer"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currencies":{"description":"This field defines the list of currencies in which the coupon is valid (e.g., \"EUR\").","items":{"$ref":"#/components/schemas/CurrenciesEnum"},"type":"array"},"end_datetime":{"description":"This field defines the end date and time when the coupon expires.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_available_for_data_sources":{"description":"Boolean flag indicating whether the condition is met.","nullable":true,"type":"boolean"},"is_mergable":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_visible":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_visible_on_list":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"kwargs":{"description":"The field defines any additional parameters for the shipping option.","nullable":true},"label":{"description":"This field defines the label or name of the coupon (e.g., \"test coupon 1\").","maxLength":512,"nullable":true,"type":"string"},"max_stock_limit":{"description":"This field defines the maximum stock limit for the coupon (0 means no limit).","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"},"max_usage_per_user":{"description":"This field defines the maximum number of times the coupon can be used by a single user (0 means no limit).","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"offer_type":{"$ref":"#/components/schemas/OfferTypeEnum","description":"The classification or type related to this field."},"priority":{"description":"This field defines the priority of the coupon (e.g., 1 being the highest priority).","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"promotion":{"description":"This field defines the ID of the promotion associated with the coupon.","type":"integer"},"start_datetime":{"description":"This field defines the start date and time when the coupon becomes valid.","format":"date-time","nullable":true,"type":"string"},"status":{"$ref":"#/components/schemas/StatusBbdEnum","description":"Current status of the record (e.g., active, inactive)."},"translations":{"description":"This field defines the translations of the district name.","nullable":true},"user":{"description":"This field defines the user who triggered the event.","nullable":true,"type":"integer"},"voucher_code":{"description":"The field defines the code of the voucher applied to the basket.","maxLength":128,"nullable":true,"type":"string"}},"type":"object"},"CurrenciesEnum":{"description":"* `try` - TL\n* `eur` - EUR\n* `usd` - USD\n* `egp` - EGP\n* `gbp` - GBP\n* `mad` - MAD\n* `pln` - PLN\n* `sar` - SAR\n* `ron` - RON\n* `uah` - UAH\n* `czk` - CZK\n* `huf` - HUF\n* `rub` - RUB\n* `bgn` - BGN\n* `iqd` - IQD\n* `kwd` - KWD\n* `bhd` - BHD\n* `omr` - OMR\n* `qar` - QAR\n* `aed` - AED\n* `ngn` - NGN\n* `inr` - INR\n* `lei` - LEI\n* `kzt` - KZT\n* `jod` - JOD\n* `rsd` - RSD","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"type":"string"},"OfferTypeEnum":{"description":"* `sitewide` - Sitewide\n* `coupon` - Coupon\n* `coupon_code` - Coupon Code\n* `voucher_code` - Voucher Code\n* `bulk_voucher_code` - Bulk Voucher Code\n* `bulk_coupon` - Bulk Coupon","enum":["sitewide","coupon","coupon_code","voucher_code","bulk_voucher_code","bulk_coupon"],"type":"string"},"StatusBbdEnum":{"description":"* `active` - Active\n* `passive` - Passive\n* `used` - Used\n* `revoked` - Revoked","enum":["active","passive","used","revoked"],"type":"string"}}},"paths":{"/campaigns/basket-offers/":{"get":{"description":"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.","operationId":"campaigns_basket_offers_list","parameters":[{"description":"Query parameter `allowed_quantity_per_basket` used to filter results based on specific conditions.","in":"query","name":"allowed_quantity_per_basket","schema":{"type":"integer"}},{"description":"Query parameter `benefit` used to filter results based on specific conditions.","in":"query","name":"benefit","schema":{"type":"integer"}},{"description":"Query parameter `condition` used to filter results based on specific conditions.","in":"query","name":"condition","schema":{"type":"integer"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `currencies` used to filter results based on specific conditions.","in":"query","name":"currencies","schema":{"type":"string"}},{"description":"Query parameter `end_datetime` used to filter results based on specific conditions.","in":"query","name":"end_datetime","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `is_available_for_data_sources` used to filter results based on specific conditions.","in":"query","name":"is_available_for_data_sources","schema":{"type":"boolean"}},{"description":"Query parameter `is_mergable` used to filter results based on specific conditions.","in":"query","name":"is_mergable","schema":{"type":"boolean"}},{"description":"Query parameter `is_visible` used to filter results based on specific conditions.","in":"query","name":"is_visible","schema":{"type":"boolean"}},{"description":"Query parameter `is_visible_on_list` used to filter results based on specific conditions.","in":"query","name":"is_visible_on_list","schema":{"type":"boolean"}},{"description":"Query parameter `kwargs` used to filter results based on specific conditions.","in":"query","name":"kwargs","schema":{"nullable":true}},{"description":"Query parameter `label` used to filter results based on specific conditions.","in":"query","name":"label","schema":{"type":"string"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `max_stock_limit` used to filter results based on specific conditions.","in":"query","name":"max_stock_limit","schema":{"type":"integer"}},{"description":"Query parameter `max_usage_per_user` used to filter results based on specific conditions.","in":"query","name":"max_usage_per_user","schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `offer_type` used to filter results based on specific conditions.","in":"query","name":"offer_type","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `priority` used to filter results based on specific conditions.","in":"query","name":"priority","schema":{"type":"integer"}},{"description":"Query parameter `promotion` used to filter results based on specific conditions.","in":"query","name":"promotion","schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `start_datetime` used to filter results based on specific conditions.","in":"query","name":"start_datetime","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `status` used to filter results based on specific conditions.","in":"query","name":"status","schema":{"type":"string"}},{"description":"Query parameter `translations` used to filter results based on specific conditions.","in":"query","name":"translations","schema":{"nullable":true}},{"description":"Query parameter `user` used to filter results based on specific conditions.","in":"query","name":"user","schema":{"type":"integer"}},{"description":"Query parameter `voucher_code` used to filter results based on specific conditions.","in":"query","name":"voucher_code","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBasketOfferList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## GET /campaigns/basket-offers/{id}/

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

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"BasketOffer":{"properties":{"allowed_quantity_per_basket":{"description":"This field defines the maximum quantity of the coupon allowed per basket (e.g., 1).","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"benefit":{"description":"This field defines the ID of the benefit associated with the coupon.","type":"integer"},"condition":{"description":"This field defines the ID of the condition associated with the coupon.","type":"integer"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currencies":{"description":"This field defines the list of currencies in which the coupon is valid (e.g., \"EUR\").","items":{"$ref":"#/components/schemas/CurrenciesEnum"},"type":"array"},"end_datetime":{"description":"This field defines the end date and time when the coupon expires.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_available_for_data_sources":{"description":"Boolean flag indicating whether the condition is met.","nullable":true,"type":"boolean"},"is_mergable":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_visible":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"is_visible_on_list":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"kwargs":{"description":"The field defines any additional parameters for the shipping option.","nullable":true},"label":{"description":"This field defines the label or name of the coupon (e.g., \"test coupon 1\").","maxLength":512,"nullable":true,"type":"string"},"max_stock_limit":{"description":"This field defines the maximum stock limit for the coupon (0 means no limit).","maximum":2147483647,"minimum":0,"nullable":true,"type":"integer"},"max_usage_per_user":{"description":"This field defines the maximum number of times the coupon can be used by a single user (0 means no limit).","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"offer_type":{"$ref":"#/components/schemas/OfferTypeEnum","description":"The classification or type related to this field."},"priority":{"description":"This field defines the priority of the coupon (e.g., 1 being the highest priority).","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"promotion":{"description":"This field defines the ID of the promotion associated with the coupon.","type":"integer"},"start_datetime":{"description":"This field defines the start date and time when the coupon becomes valid.","format":"date-time","nullable":true,"type":"string"},"status":{"$ref":"#/components/schemas/StatusBbdEnum","description":"Current status of the record (e.g., active, inactive)."},"translations":{"description":"This field defines the translations of the district name.","nullable":true},"user":{"description":"This field defines the user who triggered the event.","nullable":true,"type":"integer"},"voucher_code":{"description":"The field defines the code of the voucher applied to the basket.","maxLength":128,"nullable":true,"type":"string"}},"type":"object"},"CurrenciesEnum":{"description":"* `try` - TL\n* `eur` - EUR\n* `usd` - USD\n* `egp` - EGP\n* `gbp` - GBP\n* `mad` - MAD\n* `pln` - PLN\n* `sar` - SAR\n* `ron` - RON\n* `uah` - UAH\n* `czk` - CZK\n* `huf` - HUF\n* `rub` - RUB\n* `bgn` - BGN\n* `iqd` - IQD\n* `kwd` - KWD\n* `bhd` - BHD\n* `omr` - OMR\n* `qar` - QAR\n* `aed` - AED\n* `ngn` - NGN\n* `inr` - INR\n* `lei` - LEI\n* `kzt` - KZT\n* `jod` - JOD\n* `rsd` - RSD","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"type":"string"},"OfferTypeEnum":{"description":"* `sitewide` - Sitewide\n* `coupon` - Coupon\n* `coupon_code` - Coupon Code\n* `voucher_code` - Voucher Code\n* `bulk_voucher_code` - Bulk Voucher Code\n* `bulk_coupon` - Bulk Coupon","enum":["sitewide","coupon","coupon_code","voucher_code","bulk_voucher_code","bulk_coupon"],"type":"string"},"StatusBbdEnum":{"description":"* `active` - Active\n* `passive` - Passive\n* `used` - Used\n* `revoked` - Revoked","enum":["active","passive","used","revoked"],"type":"string"}}},"paths":{"/campaigns/basket-offers/{id}/":{"get":{"description":"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.","operationId":"campaigns_basket_offers_retrieve","parameters":[{"description":"A unique integer value identifying this basket offer.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketOffer"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedBenefitList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/Benefit"},"type":"array"}},"type":"object"},"Benefit":{"properties":{"benefit_type":{"$ref":"#/components/schemas/BenefitTypeEnum","description":"The classification or type related to this field."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"kwargs":{"description":"The field defines any additional parameters for the shipping option."},"kwargs[price_type]":{"description":"The field defines which price type the discount will be applied to. **unit\\_price, discount\\_unit\\_price, retail\\_price**","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"product_collection":{"description":"The field defines the collection that will be displayed on the page.","nullable":true,"type":"integer"}},"type":"object"},"BenefitTypeEnum":{"description":"* `multibuy` - Multibuy\n* `percentage` - Percentage\n* `fixed` - Fixed\n* `shipping_free` - Shipping Free\n* `point` - Point\n* `coupon` - Coupon\n* `voucher` - Voucher\n* `sample_product` - Sample Product\n* `loyalty_point` - Loyalty Point","enum":["multibuy","percentage","fixed","shipping_free","point","coupon","voucher","sample_product","loyalty_point"],"type":"string"}}},"paths":{"/campaigns/benefits/":{"get":{"description":"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.","operationId":"campaigns_benefits_list","parameters":[{"description":"Query parameter `benefit_type` used to filter results based on specific conditions.","in":"query","name":"benefit_type","schema":{"type":"string"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `kwargs` used to filter results based on specific conditions.","in":"query","name":"kwargs","schema":{}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `product_collection` used to filter results based on specific conditions.","in":"query","name":"product_collection","schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBenefitList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## GET /campaigns/benefits/{id}/

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

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"Benefit":{"properties":{"benefit_type":{"$ref":"#/components/schemas/BenefitTypeEnum","description":"The classification or type related to this field."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"kwargs":{"description":"The field defines any additional parameters for the shipping option."},"kwargs[price_type]":{"description":"The field defines which price type the discount will be applied to. **unit\\_price, discount\\_unit\\_price, retail\\_price**","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"product_collection":{"description":"The field defines the collection that will be displayed on the page.","nullable":true,"type":"integer"}},"type":"object"},"BenefitTypeEnum":{"description":"* `multibuy` - Multibuy\n* `percentage` - Percentage\n* `fixed` - Fixed\n* `shipping_free` - Shipping Free\n* `point` - Point\n* `coupon` - Coupon\n* `voucher` - Voucher\n* `sample_product` - Sample Product\n* `loyalty_point` - Loyalty Point","enum":["multibuy","percentage","fixed","shipping_free","point","coupon","voucher","sample_product","loyalty_point"],"type":"string"}}},"paths":{"/campaigns/benefits/{id}/":{"get":{"description":"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.","operationId":"campaigns_benefits_retrieve","parameters":[{"description":"A unique integer value identifying this benefit.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Benefit"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedBulkVoucherCodeList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/BulkVoucherCode"},"type":"array"}},"type":"object"},"BulkVoucherCode":{"properties":{"basket_offer":{"description":"The field defines the ID of the associated basket offer.","type":"integer"},"code":{"description":"The field defines the code to be used for the discount.","maxLength":32,"type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"discount_item":{"description":"Numerical value representing quantity or total amount.","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"order":{"description":"The field defines the order of the category node.","nullable":true,"type":"integer"},"status":{"$ref":"#/components/schemas/StatusBbdEnum","description":"Current status of the record (e.g., active, inactive)."},"translations":{"description":"This field defines any translations for the promotions, if available.","type":"string"},"user":{"description":"This field defines the user who triggered the event.","nullable":true,"type":"integer"}},"type":"object"},"StatusBbdEnum":{"description":"* `active` - Active\n* `passive` - Passive\n* `used` - Used\n* `revoked` - Revoked","enum":["active","passive","used","revoked"],"type":"string"}}},"paths":{"/campaigns/bulk-voucher-codes/":{"get":{"description":"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.","operationId":"campaigns_bulk_voucher_codes_list","parameters":[{"description":"Query parameter `basket_offer` used to filter results based on specific conditions.","in":"query","name":"basket_offer","schema":{"type":"integer"}},{"description":"Query parameter `code` used to filter results based on specific conditions.","in":"query","name":"code","schema":{"type":"string"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `discount_item` used to filter results based on specific conditions.","in":"query","name":"discount_item","schema":{"type":"integer"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `order` used to filter results based on specific conditions.","in":"query","name":"order","schema":{"type":"integer"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `status` used to filter results based on specific conditions.","in":"query","name":"status","schema":{"type":"string"}},{"description":"Query parameter `user` used to filter results based on specific conditions.","in":"query","name":"user","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBulkVoucherCodeList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"BulkVoucherCode":{"properties":{"basket_offer":{"description":"The field defines the ID of the associated basket offer.","type":"integer"},"code":{"description":"The field defines the code to be used for the discount.","maxLength":32,"type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"discount_item":{"description":"Numerical value representing quantity or total amount.","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"order":{"description":"The field defines the order of the category node.","nullable":true,"type":"integer"},"status":{"$ref":"#/components/schemas/StatusBbdEnum","description":"Current status of the record (e.g., active, inactive)."},"translations":{"description":"This field defines any translations for the promotions, if available.","type":"string"},"user":{"description":"This field defines the user who triggered the event.","nullable":true,"type":"integer"}},"type":"object"},"StatusBbdEnum":{"description":"* `active` - Active\n* `passive` - Passive\n* `used` - Used\n* `revoked` - Revoked","enum":["active","passive","used","revoked"],"type":"string"}}},"paths":{"/campaigns/bulk-voucher-codes/{id}/":{"get":{"description":"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.","operationId":"campaigns_bulk_voucher_codes_retrieve","parameters":[{"description":"A unique integer value identifying this bulk voucher code.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkVoucherCode"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedConditionList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/Condition"},"type":"array"}},"type":"object"},"Condition":{"properties":{"condition_type":{"$ref":"#/components/schemas/ConditionTypeEnum","description":"The classification or type related to this field."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"kwargs":{"description":"The field defines any additional parameters for the shipping option."},"kwargs[price_type]":{"description":"The field defines which price type the discount will be applied to. **unit\\_price, discount\\_unit\\_price, retail\\_price**","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"product_collection":{"description":"The field defines the collection that will be displayed on the page.","nullable":true,"type":"integer"},"translations":{"description":"This field defines the translations of the district name.","nullable":true},"upsell_message":{"description":"This field defines the message prompting users to add more products to their cart to qualify for free shipping.","maxLength":512,"type":"string"}},"type":"object"},"ConditionTypeEnum":{"description":"* `distinct` - Distinct\n* `quantity` - Quantity\n* `amount` - Amount\n* `query` - Query","enum":["distinct","quantity","amount","query"],"type":"string"}}},"paths":{"/campaigns/conditions/":{"get":{"description":"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.","operationId":"campaigns_conditions_list","parameters":[{"description":"Query parameter `condition_type` used to filter results based on specific conditions.","in":"query","name":"condition_type","schema":{"type":"string"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `kwargs` used to filter results based on specific conditions.","in":"query","name":"kwargs","schema":{}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `product_collection` used to filter results based on specific conditions.","in":"query","name":"product_collection","schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `translations` used to filter results based on specific conditions.","in":"query","name":"translations","schema":{"nullable":true}},{"description":"Query parameter `upsell_message` used to filter results based on specific conditions.","in":"query","name":"upsell_message","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedConditionList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## GET /campaigns/conditions/{id}/

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

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"Condition":{"properties":{"condition_type":{"$ref":"#/components/schemas/ConditionTypeEnum","description":"The classification or type related to this field."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"kwargs":{"description":"The field defines any additional parameters for the shipping option."},"kwargs[price_type]":{"description":"The field defines which price type the discount will be applied to. **unit\\_price, discount\\_unit\\_price, retail\\_price**","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"product_collection":{"description":"The field defines the collection that will be displayed on the page.","nullable":true,"type":"integer"},"translations":{"description":"This field defines the translations of the district name.","nullable":true},"upsell_message":{"description":"This field defines the message prompting users to add more products to their cart to qualify for free shipping.","maxLength":512,"type":"string"}},"type":"object"},"ConditionTypeEnum":{"description":"* `distinct` - Distinct\n* `quantity` - Quantity\n* `amount` - Amount\n* `query` - Query","enum":["distinct","quantity","amount","query"],"type":"string"}}},"paths":{"/campaigns/conditions/{id}/":{"get":{"description":"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.","operationId":"campaigns_conditions_retrieve","parameters":[{"description":"A unique integer value identifying this condition.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Condition"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedLoyaltyCardList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/LoyaltyCard"},"type":"array"}},"type":"object"},"LoyaltyCard":{"properties":{"attributes":{"description":"The field defines the attributes of the category node."},"attributes_kwargs":{"description":"The field defines the details of the category node."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"localized_attributes":{"description":"The field defines the category node that has been translated into other languages."},"localized_attributes_kwargs":{"description":"The field defines the details of the translations for the category node attributes."},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"number":{"description":"The field defines the loyalty account number.","maxLength":64,"title":"Card Number","type":"string"},"user":{"description":"This field defines the user who triggered the event.","type":"integer"}},"type":"object"}}},"paths":{"/campaigns/loyalty-cards/":{"get":{"description":"This method returns details about a specific loyalty card, including its ID, account number, creation and modification timestamps, and the associated user ID.","operationId":"campaigns_loyalty_cards_list","parameters":[{"description":"Query parameter `attributes` used to filter results based on specific conditions.","in":"query","name":"attributes","schema":{}},{"description":"Query parameter `attributes_kwargs` used to filter results based on specific conditions.","in":"query","name":"attributes_kwargs","schema":{}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `localized_attributes` used to filter results based on specific conditions.","in":"query","name":"localized_attributes","schema":{}},{"description":"Query parameter `localized_attributes_kwargs` used to filter results based on specific conditions.","in":"query","name":"localized_attributes_kwargs","schema":{}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `number` used to filter results based on specific conditions.","in":"query","name":"number","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `user` used to filter results based on specific conditions.","in":"query","name":"user","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLoyaltyCardList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"LoyaltyCard":{"properties":{"attributes":{"description":"The field defines the attributes of the category node."},"attributes_kwargs":{"description":"The field defines the details of the category node."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"localized_attributes":{"description":"The field defines the category node that has been translated into other languages."},"localized_attributes_kwargs":{"description":"The field defines the details of the translations for the category node attributes."},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"number":{"description":"The field defines the loyalty account number.","maxLength":64,"title":"Card Number","type":"string"},"user":{"description":"This field defines the user who triggered the event.","type":"integer"}},"type":"object"}}},"paths":{"/campaigns/loyalty-cards/{id}/":{"get":{"description":"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.","operationId":"campaigns_loyalty_cards_retrieve","parameters":[{"description":"A unique integer value identifying this loyalty card.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyCard"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedProductCollectionItemList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/ProductCollectionItem"},"type":"array"}},"type":"object"},"ProductCollectionItem":{"properties":{"collection":{"description":"The field defines the ID of the collection that the collection item is associated with.","type":"integer"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"product":{"description":"The field defines the product ID associated with the product price.","type":"integer"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"}}},"paths":{"/campaigns/product-collection-items/":{"get":{"description":"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.","operationId":"campaigns_product_collection_items_list","parameters":[{"description":"Query parameter `collection` used to filter results based on specific conditions.","in":"query","name":"collection","schema":{"type":"integer"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `product` used to filter results based on specific conditions.","in":"query","name":"product","schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `uuid` used to filter results based on specific conditions.","in":"query","name":"uuid","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProductCollectionItemList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"ProductCollectionItem":{"properties":{"collection":{"description":"The field defines the ID of the collection that the collection item is associated with.","type":"integer"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"product":{"description":"The field defines the product ID associated with the product price.","type":"integer"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"}}},"paths":{"/campaigns/product-collection-items/{id}/":{"get":{"description":"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.","operationId":"campaigns_product_collection_items_retrieve","parameters":[{"description":"A unique integer value identifying this product collection item.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollectionItem"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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..

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedProductCollectionList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/ProductCollection"},"type":"array"}},"type":"object"},"ProductCollection":{"properties":{"collection_type":{"$ref":"#/components/schemas/CollectionTypeEnum","description":"The classification or type related to this field."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"expiration_date":{"description":"The field defines the validity date for the dynamic collection.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"slug":{"description":"The field defines the slug of the shipping option.","maxLength":255,"pattern":"^[-a-zA-Z0-9_]+$","type":"string"},"sort_option":{"description":"The field defines the ID of the sort option applied to order the category.","nullable":true,"type":"integer"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CollectionTypeEnum":{"description":"* `static` - Static\n* `dynamic` - Dynamic","enum":["static","dynamic"],"type":"string"}}},"paths":{"/campaigns/product-collections/":{"get":{"description":"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..","operationId":"campaigns_product_collections_list","parameters":[{"description":"Query parameter `collection_type` used to filter results based on specific conditions.","in":"query","name":"collection_type","schema":{"type":"string"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `expiration_date` used to filter results based on specific conditions.","in":"query","name":"expiration_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `is_active` used to filter results based on specific conditions.","in":"query","name":"is_active","schema":{"type":"boolean"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `name` used to filter results based on specific conditions.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `slug` used to filter results based on specific conditions.","in":"query","name":"slug","schema":{"type":"string"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `sort_option` used to filter results based on specific conditions.","in":"query","name":"sort_option","schema":{"type":"integer"}},{"description":"Query parameter `uuid` used to filter results based on specific conditions.","in":"query","name":"uuid","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProductCollectionList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## GET /campaigns/product-collections/{id}/

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

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"ProductCollection":{"properties":{"collection_type":{"$ref":"#/components/schemas/CollectionTypeEnum","description":"The classification or type related to this field."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"expiration_date":{"description":"The field defines the validity date for the dynamic collection.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"slug":{"description":"The field defines the slug of the shipping option.","maxLength":255,"pattern":"^[-a-zA-Z0-9_]+$","type":"string"},"sort_option":{"description":"The field defines the ID of the sort option applied to order the category.","nullable":true,"type":"integer"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CollectionTypeEnum":{"description":"* `static` - Static\n* `dynamic` - Dynamic","enum":["static","dynamic"],"type":"string"}}},"paths":{"/campaigns/product-collections/{id}/":{"get":{"description":"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.","operationId":"campaigns_product_collections_retrieve","parameters":[{"description":"A unique integer value identifying this product collection.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedPromotionList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/Promotion"},"type":"array"}},"type":"object"},"Promotion":{"properties":{"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"slug":{"description":"The field defines the slug of the shipping option.","maxLength":255,"pattern":"^[-a-zA-Z0-9_]+$","type":"string"},"translations":{"description":"This field defines the translations of the district name.","nullable":true}},"type":"object"}}},"paths":{"/campaigns/promotions/":{"get":{"description":"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.","operationId":"campaigns_promotions_list","parameters":[{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `name` used to filter results based on specific conditions.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `slug` used to filter results based on specific conditions.","in":"query","name":"slug","schema":{"type":"string"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `translations` used to filter results based on specific conditions.","in":"query","name":"translations","schema":{"nullable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedPromotionList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## GET /campaigns/promotions/{id}/

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

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"Promotion":{"properties":{"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"slug":{"description":"The field defines the slug of the shipping option.","maxLength":255,"pattern":"^[-a-zA-Z0-9_]+$","type":"string"},"translations":{"description":"This field defines the translations of the district name.","nullable":true}},"type":"object"}}},"paths":{"/campaigns/promotions/{id}/":{"get":{"description":"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.","operationId":"campaigns_promotions_retrieve","parameters":[{"description":"A unique integer value identifying this promotion.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedSessionOfferList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/SessionOffer"},"type":"array"}},"type":"object"},"SessionOffer":{"properties":{"code":{"description":"The field defines the code to be used for the discount.","maxLength":128,"type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"response":{"description":"The field defines the response of the 3rd party promotion request."},"status":{"$ref":"#/components/schemas/StatusBbdEnum","description":"Current status of the record (e.g., active, inactive)."},"type":{"$ref":"#/components/schemas/TypeEnum","description":"The classification or type related to this field."}},"type":"object"},"StatusBbdEnum":{"description":"* `active` - Active\n* `passive` - Passive\n* `used` - Used\n* `revoked` - Revoked","enum":["active","passive","used","revoked"],"type":"string"},"TypeEnum":{"description":"* `ayakkabidunyasi` - Ayakkabidunyasi\n* `sephora` - Sephora\n* `zubizu` - Zubizu\n* `loccitane` - Loccitane\n* `adunyasi_loyalty_card` - Adunyasi Loyalty Card\n* `giz_eticaret_promotion` - Giz Eticaret Promotion\n* `giz_eticaret_promotion_v2` - Giz Eticaret Promotion V2\n* `default_loyalty_card` - Default Loyalty Card\n* `obase` - Obase\n* `obase_promotion_gateway` - Obase Promotion Gateway\n* `como` - Como\n* `tefal` - Tefal\n* `softtouch` - Softtouch\n* `rapid_promo` - Rapid Promo\n* `nebim_v2` - Nebim V2\n* `diva_gateway` - Diva Gateway\n* `hitit` - Hitit\n* `b2b` - B2B\n* `erencard` - Erencard\n* `extension` - Extension\n* `lazy_extension` - Lazy Extension","enum":["ayakkabidunyasi","sephora","zubizu","loccitane","adunyasi_loyalty_card","giz_eticaret_promotion","giz_eticaret_promotion_v2","default_loyalty_card","obase","obase_promotion_gateway","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension","lazy_extension"],"type":"string"}}},"paths":{"/campaigns/session-offers/":{"get":{"description":"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.","operationId":"campaigns_session_offers_list","parameters":[{"description":"Query parameter `code` used to filter results based on specific conditions.","in":"query","name":"code","schema":{"type":"string"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `response` used to filter results based on specific conditions.","in":"query","name":"response","schema":{}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `status` used to filter results based on specific conditions.","in":"query","name":"status","schema":{"type":"string"}},{"description":"Query parameter `type` used to filter results based on specific conditions.","in":"query","name":"type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSessionOfferList"}}},"description":"Successful response for status code 200."}},"tags":["campaigns"]}}}}
```

## GET /campaigns/session-offers/{id}/

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

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"SessionOffer":{"properties":{"code":{"description":"The field defines the code to be used for the discount.","maxLength":128,"type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"response":{"description":"The field defines the response of the 3rd party promotion request."},"status":{"$ref":"#/components/schemas/StatusBbdEnum","description":"Current status of the record (e.g., active, inactive)."},"type":{"$ref":"#/components/schemas/TypeEnum","description":"The classification or type related to this field."}},"type":"object"},"StatusBbdEnum":{"description":"* `active` - Active\n* `passive` - Passive\n* `used` - Used\n* `revoked` - Revoked","enum":["active","passive","used","revoked"],"type":"string"},"TypeEnum":{"description":"* `ayakkabidunyasi` - Ayakkabidunyasi\n* `sephora` - Sephora\n* `zubizu` - Zubizu\n* `loccitane` - Loccitane\n* `adunyasi_loyalty_card` - Adunyasi Loyalty Card\n* `giz_eticaret_promotion` - Giz Eticaret Promotion\n* `giz_eticaret_promotion_v2` - Giz Eticaret Promotion V2\n* `default_loyalty_card` - Default Loyalty Card\n* `obase` - Obase\n* `obase_promotion_gateway` - Obase Promotion Gateway\n* `como` - Como\n* `tefal` - Tefal\n* `softtouch` - Softtouch\n* `rapid_promo` - Rapid Promo\n* `nebim_v2` - Nebim V2\n* `diva_gateway` - Diva Gateway\n* `hitit` - Hitit\n* `b2b` - B2B\n* `erencard` - Erencard\n* `extension` - Extension\n* `lazy_extension` - Lazy Extension","enum":["ayakkabidunyasi","sephora","zubizu","loccitane","adunyasi_loyalty_card","giz_eticaret_promotion","giz_eticaret_promotion_v2","default_loyalty_card","obase","obase_promotion_gateway","como","tefal","softtouch","rapid_promo","nebim_v2","diva_gateway","hitit","b2b","erencard","extension","lazy_extension"],"type":"string"}}},"paths":{"/campaigns/session-offers/{id}/":{"get":{"description":"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.","operationId":"campaigns_session_offers_retrieve","parameters":[{"description":"A unique integer value identifying this session offer.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionOffer"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["campaigns"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/data-warehouse/campaigns.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.