--- ## Promotions --- ### Get all promotions of a customer --- This method retrieves all available promotions that are defined for a customer.

The API key must have the `PROMOTIONS_DETAILS_FOR_CLIENT_READ` permission from the **Client** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Related To:** [PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse) **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> getAllPromotions(
      {required void Function(PromotionResponse promotionResponse) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **onSuccess** | Function([PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse) promotionResponse) | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.getAllPromotions(onSuccess: (PromotionResponse promotionResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<PromotionResponse> getAllPromotions() async

**Return Value:** [PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse) **Example:**

await Synerise.promotions.getAllPromotions().catchError((error) {
      //onError handling
    });

### Get promotions with query parameters --- This method retrieves promotions that match the parameters defined in an API query.

The API key must have the `PROMOTIONS_DETAILS_FOR_CLIENT_READ` permission from the **Client** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Related To:** [PromotionsApiQuery](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionsapiquery) [PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse) **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> getPromotions(PromotionsApiQuery apiQuery,
      {required void Function(PromotionResponse promotionResponse) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **apiQuery** | [PromotionsApiQuery](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionsapiquery) | yes | - | Object that stores all query parameters | | **onSuccess** | Function([PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse) promotionResponse) | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.getPromotions(promotionsApiQuery, onSuccess: (PromotionResponse promotionResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<PromotionResponse> getPromotions(PromotionsApiQuery apiQuery) async

await Synerise.promotions.getPromotions(promotionsApiQuery).catchError((error) {
      //onError handling
    });

### Get promotion by UUID --- This method retrieves the promotion with the specified UUID.

The API key must have the `PROMOTIONS_DETAILS_FOR_CLIENT_READ` permission from the **Client** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> getPromotionByUUID(String uuid,
      {required void Function(Promotion promotion) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **uuid** | String | yes | - | UUID of the promotion | | **onSuccess** | Function([Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion) promotion) | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.getPromotionByUUID(uuid, onSuccess: (Promotion promotion) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<Promotion> getPromotionByUUID(String uuid) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **uuid** | String | yes | - | UUID of the promotion | **Return Value:** [Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion) **Example:**

await Synerise.promotions.getPromotionByUUID(uuid).catchError((error) {
      //onError handling
    });

### Get promotion by code --- This method retrieves the promotion with the specified code.

The API key must have the `PROMOTIONS_DETAILS_FOR_CLIENT_READ` permission from the **Client** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Related To:** [Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion) **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> getPromotionByCode(String code,
      {required void Function(Promotion promotion) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **code** | String | yes | - | Code of the promotion | | **onSuccess** | Function([Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion) promotion) | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.getPromotionByCode(code, onSuccess: (Promotion promotion) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<Promotion> getPromotionByCode(String code) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **code** | String | yes | - | Code of the promotion | **Return Value:** [Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion) **Example:**

await Synerise.promotions.getPromotionByCode(code).catchError((error) {
      //onError handling
    });

### Activate promotion by UUID --- This method activates the promotion with the specified UUID.

The API key must have the `PROMOTIONS_ACTIVATE_PROMOTIONS_UPDATE` permission from the **Promotions** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> activatePromotionByUUID(String uuid,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **uuid** | String | yes | - | UUID of the promotion | | **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.activatePromotionByUUID(uuid, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<void> activatePromotionByUUID(String uuid) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **uuid** | String | yes | - | UUID of the promotion | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.activatePromotionByUUID(uuid).catchError((error) {
      //onError handling
    });

### Activate promotion by code --- This method activates the promotion with the specified code.

The API key must have the `PROMOTIONS_ACTIVATE_PROMOTIONS_UPDATE` permission from the **Promotions** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> activatePromotionByCode(String code,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **code** | String | yes | - | Code of the promotion | | **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.activatePromotionByCode(code, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<void> activatePromotionByCode(String code) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **code** | String | yes | - | Code of the promotion | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.activatePromotionByCode(code).catchError((error) {
      //onError handling
    });

### Activate promotions in a batch --- This method activates promotions with a code or with UUID in a batch.

The API key must have the `PROMOTIONS_ACTIVATE_PROMOTIONS_UPDATE` permission from the **Promotions** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Related To:** [PromotionIdentifier](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionidentifier) **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> activatePromotionsBatch(List<PromotionIdentifier> promotionsToActivate,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **promotionsToActivate** | List<[PromotionIdentifier](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionidentifier)> | yes | - | List of promotion identifiers | | **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.activatePromotionsBatch(promotionIdentifierList, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<void> activatePromotionsBatch(List<PromotionIdentifier> promotionsToActivate) async

await Synerise.promotions.activatePromotionsBatch(promotionIdentifierList).catchError((error) {
      //onError handling
    });

### Deactivate promotion by UUID --- This method deactivates the promotion with the specified UUID.

The API key must have the `PROMOTIONS_DEACTIVATE_PROMOTIONS_UPDATE` permission from the **Promotions** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> deactivatePromotionByUUID(String uuid,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

await Synerise.promotions.deactivatePromotionByUUID(uuid, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<void> deactivatePromotionByUUID(String uuid) async

await Synerise.promotions.deactivatePromotionByUUID(uuid).catchError((error) {
      //onError handling
    });

### Deactivate promotion by code --- This method deactivates the promotion with the specified code.

The API key must have the `PROMOTIONS_DEACTIVATE_PROMOTIONS_UPDATE` permission from the **Promotions** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> deactivatePromotionByCode(String code,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

await Synerise.promotions.deactivatePromotionByCode(code, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<void> deactivatePromotionByCode(String code) async

await Synerise.promotions.deactivatePromotionByCode(code).catchError((error) {
      //onError handling
    });

### Deactivate promotions in a batch --- This method deactivates promotions with a code or with UUID in a batch.

The API key must have the `PROMOTIONS_DEACTIVATE_PROMOTIONS_UPDATE` permission from the **Promotions** group.

**Declaration:**

Future<void> deactivatePromotionsBatch(List<PromotionIdentifier> promotionsToDeactivate,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **promotionsIdentifiers** | List<[PromotionIdentifier](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionidentifier)> | yes | - | List of promotion identifiers | | **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.deactivatePromotionsBatch(promotionIdentifierList, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<void> deactivatePromotionsBatch(List<PromotionIdentifier> promotionsToDeactivate) async

await Synerise.promotions.deactivatePromotionsBatch(promotionIdentifierList).catchError((error) {
      //onError handling
    });

## Vouchers --- ### Get or assign voucher from pool --- This method retrieves an assigned voucher code or assigns a voucher from a pool identified by UUID to the customer. Once a voucher is assigned using this method, **the same** voucher is returned for the profile every time the method is called. When the voucher is assigned for the first time, a [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

The API key must have the `VOUCHERS_ITEM_ASSIGN_CREATE` and `VOUCHERS_ITEM_ASSIGN_READ` permission from the **Assign** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Related To:** [AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse) **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> getOrAssignVoucher(String poolUuid,
      {required void Function(AssignVoucherResponse assignVoucherResponse) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **poolUuid** | String | yes | - | Unique identifier of a code pool | | **onSuccess** | Function([AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse) assignVoucherResponse) | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.getOrAssignVoucher(poolUuid, onSuccess: (AssignVoucherResponse assignVoucherResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<AssignVoucherResponse> getOrAssignVoucher(String poolUuid) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **poolUuid** | String | yes | - | Unique identifier of a code pool | **Return Value:** [AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse) **Example:**

await Synerise.promotions.getOrAssignVoucher(poolUuid).catchError((error) {
      //onError handling
    });

### Assign voucher code from pool --- This method assigns a voucher from a pool identified by UUID to the profile. Every request returns a **different code** until the pool is empty. A [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

Returns the HTTP 416 status code when the pool is empty.

The API key must have the `VOUCHERS_ITEM_ASSIGN_CREATE` and `VOUCHERS_ITEM_ASSIGN_READ` permission from the **Assign** group.

**Declaration:**

Future<void> assignVoucherCode(String poolUuid,
      {required void Function(AssignVoucherResponse response) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **poolUuid** | String | yes | - | Unique identifier of a code pool | | **onSuccess** | Function([AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse) assignVoucherResponse) | yes | - | Function to be executed when the operation is completed successfully, returning the [AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse) | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.assignVoucherCode(poolUuid, onSuccess: (AssignVoucherResponse assignVoucherResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<AssignVoucherResponse> assignVoucherCode(String poolUuid) async

await Synerise.promotions.assignVoucherCode(poolUuid).catchError((error) {
      //onError handling
    });

### Get voucher codes assigned to customer --- This method retrieves voucher codes for a customer.

The API key must have the `VOUCHERS_ITEM_ASSIGN_READ` permission from the **Assign** group.

**Declared In:** lib/modules/promotions/promotions_impl.dart **Related To:** [VoucherCodesResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodesresponse) **Class:** [PromotionsImpl](/developers/mobile-sdk/class-reference/flutter/modules#promotions)

**Declaration:**

Future<void> getAssignedVoucherCodes(
      {required void Function(VoucherCodesResponse voucherCodesResponse) onSuccess,
      required void Function(SyneriseError error) onError}) async

**Parameters:** | Parameter | Type | Mandatory | Default | Description | | --- | --- | --- | --- | --- | | **onSuccess** | Function([VoucherCodesResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodesresponse) voucherCodesResponse) | yes | - | Function to be executed when the operation is completed successfully | | **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error | **Return Value:** No value is returned. **Example:**

await Synerise.promotions.getAssignedVoucherCodes(onSuccess: (VoucherCodesResponse voucherCodesResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });

**Declaration:**

Future<VoucherCodesResponse> getAssignedVoucherCodes() async

**Return Value:** [VoucherCodesResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodesresponse) **Example:**

await Synerise.promotions.getAssignedVoucherCodes().catchError((error) {
      //onError handling
    });