# Loyalty

## GET /loyalty/accounts/

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

```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":{"PaginatedLoyaltyAccountList":{"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/LoyaltyAccount"},"type":"array"}},"type":"object"},"LoyaltyAccount":{"properties":{"balance":{"description":"The field defines the balance available in the loyalty account.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The field defines the currency of the loyalty transaction."},"debit_allowed":{"description":"The field defines whether debit transactions are allowed on the loyalty account.","type":"boolean"},"id":{"description":"Unique identifier for the record.","type":"integer"},"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":128,"nullable":true,"type":"string"},"user":{"description":"This field defines the user who triggered the event.","nullable":true,"type":"integer"},"user_email":{"description":"Email address of the user or entity.","maxLength":128,"nullable":true,"type":"string"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CurrencyEnum":{"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"}}},"paths":{"/loyalty/accounts/":{"get":{"description":"This method returns details about a specific loyalty account, including its ID, currency, balance, and whether debit is allowed. It also includes the account number, UUID, creation and modification timestamps, and the associated user email if available.","operationId":"loyalty_accounts_list","parameters":[{"description":"Query parameter `balance` used to filter results based on specific conditions.","in":"query","name":"balance","schema":{"type":"number"}},{"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 `currency` used to filter results based on specific conditions.","in":"query","name":"currency","schema":{"enum":["aed","bgn","bhd","czk","egp","eur","gbp","huf","inr","iqd","jod","kwd","kzt","lei","mad","ngn","omr","pln","qar","ron","rsd","rub","sar","try","uah","usd"],"type":"string"}},{"description":"Query parameter `debit_allowed` used to filter results based on specific conditions.","in":"query","name":"debit_allowed","schema":{"type":"boolean"}},{"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 `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"}},{"description":"Query parameter `user_email` used to filter results based on specific conditions.","in":"query","name":"user_email","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/PaginatedLoyaltyAccountList"}}},"description":"Successful response for status code 200."}},"tags":["loyalty"]}}}}
```

## GET /loyalty/accounts/{id}/

> This method returns details about a specific loyalty account, including its ID, currency, balance, and whether debit is allowed. It also includes the account number, UUID, creation and modification timestamps, and the associated user email if available. 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":{"LoyaltyAccount":{"properties":{"balance":{"description":"The field defines the balance available in the loyalty account.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The field defines the currency of the loyalty transaction."},"debit_allowed":{"description":"The field defines whether debit transactions are allowed on the loyalty account.","type":"boolean"},"id":{"description":"Unique identifier for the record.","type":"integer"},"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":128,"nullable":true,"type":"string"},"user":{"description":"This field defines the user who triggered the event.","nullable":true,"type":"integer"},"user_email":{"description":"Email address of the user or entity.","maxLength":128,"nullable":true,"type":"string"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CurrencyEnum":{"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"}}},"paths":{"/loyalty/accounts/{id}/":{"get":{"description":"This method returns details about a specific loyalty account, including its ID, currency, balance, and whether debit is allowed. It also includes the account number, UUID, creation and modification timestamps, and the associated user email if available. This endpoint retrieves a specific record by its unique identifier.","operationId":"loyalty_accounts_retrieve","parameters":[{"description":"A unique integer value identifying this loyalty account.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyAccount"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["loyalty"]}}}}
```

## GET /loyalty/transactions/

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

```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":{"PaginatedLoyaltyTransactionList":{"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/LoyaltyTransaction"},"type":"array"}},"type":"object"},"LoyaltyTransaction":{"properties":{"amount":{"description":"The field defines the total amount of the loyalty transaction.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The field defines the currency of the loyalty transaction."},"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.","type":"integer"},"reference":{"description":"This field defines a reference for the basket item.","maxLength":128,"nullable":true,"type":"string"},"remote_addr":{"description":"This field defines the IP address of the client making the request.","nullable":true,"type":"string"},"user":{"description":"This field defines the user who triggered the event.","type":"integer"},"user_email":{"description":"Email address of the user or entity.","maxLength":256,"type":"string"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CurrencyEnum":{"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"}}},"paths":{"/loyalty/transactions/":{"get":{"description":"This method returns details about a specific loyalty transaction, including its ID, currency, amount, and reference number. It also includes the associated user email, order ID, user ID, remote address, and timestamps for creation and modification.","operationId":"loyalty_transactions_list","parameters":[{"description":"Query parameter `amount` used to filter results based on specific conditions.","in":"query","name":"amount","schema":{"type":"number"}},{"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 `currency` used to filter results based on specific conditions.","in":"query","name":"currency","schema":{"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 `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 `reference` used to filter results based on specific conditions.","in":"query","name":"reference","schema":{"type":"string"}},{"description":"Query parameter `remote_addr` used to filter results based on specific conditions.","in":"query","name":"remote_addr","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 `user` used to filter results based on specific conditions.","in":"query","name":"user","schema":{"type":"integer"}},{"description":"Query parameter `user_email` used to filter results based on specific conditions.","in":"query","name":"user_email","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/PaginatedLoyaltyTransactionList"}}},"description":"Successful response for status code 200."}},"tags":["loyalty"]}}}}
```

## GET /loyalty/transactions/{id}/

> This method returns details about a specific loyalty transaction, including its ID, currency, amount, and reference number. It also includes the associated user email, order ID, user ID, remote address, and timestamps for creation and modification. 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":{"LoyaltyTransaction":{"properties":{"amount":{"description":"The field defines the total amount of the loyalty transaction.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The field defines the currency of the loyalty transaction."},"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.","type":"integer"},"reference":{"description":"This field defines a reference for the basket item.","maxLength":128,"nullable":true,"type":"string"},"remote_addr":{"description":"This field defines the IP address of the client making the request.","nullable":true,"type":"string"},"user":{"description":"This field defines the user who triggered the event.","type":"integer"},"user_email":{"description":"Email address of the user or entity.","maxLength":256,"type":"string"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CurrencyEnum":{"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"}}},"paths":{"/loyalty/transactions/{id}/":{"get":{"description":"This method returns details about a specific loyalty transaction, including its ID, currency, amount, and reference number. It also includes the associated user email, order ID, user ID, remote address, and timestamps for creation and modification. This endpoint retrieves a specific record by its unique identifier.","operationId":"loyalty_transactions_retrieve","parameters":[{"description":"A unique integer value identifying this loyalty transaction.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyTransaction"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["loyalty"]}}}}
```

## GET /loyalty/transfers/

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

```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":{"PaginatedLoyaltyTransferList":{"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/LoyaltyTransfer"},"type":"array"}},"type":"object"},"LoyaltyTransfer":{"properties":{"account":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"amount":{"description":"The field defines the total amount of the loyalty transaction.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The field defines the currency of the loyalty transaction."},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"reference":{"description":"This field defines a reference for the basket item.","maxLength":128,"nullable":true,"type":"string"},"transaction":{"description":"The field defines the transaction ID created for the loyalty transfer.","type":"integer"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CurrencyEnum":{"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"}}},"paths":{"/loyalty/transfers/":{"get":{"description":"This method returns details about a specific loyalty transfer, including its ID, currency, amount, and reference number. It also includes the associated loyalty account ID, transaction ID, and timestamps for creation and modification.","operationId":"loyalty_transfers_list","parameters":[{"description":"Query parameter `account` used to filter results based on specific conditions.","in":"query","name":"account","schema":{"type":"integer"}},{"description":"Query parameter `amount` used to filter results based on specific conditions.","in":"query","name":"amount","schema":{"type":"number"}},{"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 `currency` used to filter results based on specific conditions.","in":"query","name":"currency","schema":{"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 `reference` used to filter results based on specific conditions.","in":"query","name":"reference","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 `transaction` used to filter results based on specific conditions.","in":"query","name":"transaction","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/PaginatedLoyaltyTransferList"}}},"description":"Successful response for status code 200."}},"tags":["loyalty"]}}}}
```

## GET /loyalty/transfers/{id}/

> This method returns details about a specific loyalty transfer, including its ID, currency, amount, and reference number. It also includes the associated loyalty account ID, transaction ID, and timestamps for creation and modification. 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":{"LoyaltyTransfer":{"properties":{"account":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"amount":{"description":"The field defines the total amount of the loyalty transaction.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The field defines the currency of the loyalty transaction."},"id":{"description":"Unique identifier for the record.","type":"integer"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"reference":{"description":"This field defines a reference for the basket item.","maxLength":128,"nullable":true,"type":"string"},"transaction":{"description":"The field defines the transaction ID created for the loyalty transfer.","type":"integer"},"uuid":{"description":"Unique identifier for the record.","format":"uuid","type":"string"}},"type":"object"},"CurrencyEnum":{"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"}}},"paths":{"/loyalty/transfers/{id}/":{"get":{"description":"This method returns details about a specific loyalty transfer, including its ID, currency, amount, and reference number. It also includes the associated loyalty account ID, transaction ID, and timestamps for creation and modification. This endpoint retrieves a specific record by its unique identifier.","operationId":"loyalty_transfers_retrieve","parameters":[{"description":"A unique integer value identifying this loyalty transfer.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyTransfer"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["loyalty"]}}}}
```


---

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