> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a reward supplier > Creates a new reward supplier configuration. Returns the persisted supplier with its server-assigned id. ## OpenAPI ````yaml /api-reference/management.json post /v6/reward-suppliers openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v6/reward-suppliers: post: tags: - Reward Suppliers summary: Create a reward supplier description: >- Creates a new reward supplier configuration. Returns the persisted supplier with its server-assigned id. operationId: createRewardSupplier requestBody: content: application/json: example: auto_fulfillment_enabled: true cash_back_max: 1 cash_back_min: 1 cash_back_percentage: 1 component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description display_name: display_name display_type: display_type enabled: true face_value: 1 face_value_algorithm_type: CASH_BACK face_value_type: AUD limit_per_day: 1 limit_per_hour: 1 missing_fulfillment_alert_delay_ms: 1 missing_fulfillment_alert_enabled: true missing_fulfillment_auto_fail_delay_ms: 1 missing_fulfillment_auto_fail_enabled: true name: name partner_reward_key_type: COUPON partner_reward_supplier_id: partner_reward_supplier_id reward_email_auto_send_enabled: true reward_expires_at: '2025-10-24T02:00:00-07:00' reward_supplier_type: CUSTOM_REWARD state_transitions: state_transitions_key: - CANCELED tags: - tag type: ACCOUNT_CREDIT schema: $ref: '#/components/schemas/RewardSupplierCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RewardSupplierResponse' description: Successful response '400': content: application/json: examples: account_not_found: $ref: '#/components/examples/account_not_found' balance_refill_amount_missing: $ref: '#/components/examples/balance_refill_amount_missing' binding_error: $ref: '#/components/examples/binding_error' campaign_component_absolute_name_missing: $ref: >- #/components/examples/campaign_component_absolute_name_missing campaign_component_description_out_of_range: $ref: >- #/components/examples/campaign_component_description_out_of_range campaign_component_display_name_contains_illegal_character: $ref: >- #/components/examples/campaign_component_display_name_contains_illegal_character campaign_component_display_name_out_of_range: $ref: >- #/components/examples/campaign_component_display_name_out_of_range campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: >- #/components/examples/campaign_component_name_contains_illegal_character campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_type_validation_failed: $ref: >- #/components/examples/campaign_component_type_validation_failed cash_back_limits_out_of_bounds: $ref: '#/components/examples/cash_back_limits_out_of_bounds' catalog_item_not_found: $ref: '#/components/examples/catalog_item_not_found' circular_component_reference: $ref: '#/components/examples/circular_component_reference' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' coupon_count_warn_limit_invalid: $ref: '#/components/examples/coupon_count_warn_limit_invalid' coupon_pool_id_already_in_use: $ref: '#/components/examples/coupon_pool_id_already_in_use' coupon_pool_id_missing: $ref: '#/components/examples/coupon_pool_id_missing' custom_reward_type_missing: $ref: '#/components/examples/custom_reward_type_missing' description_too_long: $ref: '#/components/examples/description_too_long' display_name_too_long: $ref: '#/components/examples/display_name_too_long' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' external_element_is_referenced_by_active_configuration: $ref: >- #/components/examples/external_element_is_referenced_by_active_configuration external_elements_cannot_have_multiple_references: $ref: >- #/components/examples/external_elements_cannot_have_multiple_references face_value: $ref: '#/components/examples/face_value' face_value_out_of_range: $ref: '#/components/examples/face_value_out_of_range' illegal_character_in_description: $ref: '#/components/examples/illegal_character_in_description' illegal_character_in_name: $ref: '#/components/examples/illegal_character_in_name' illegal_value_of_minimum_coupon_lifetime: $ref: >- #/components/examples/illegal_value_of_minimum_coupon_lifetime inexisting_coupon_pool_id: $ref: '#/components/examples/inexisting_coupon_pool_id' invalid_auto_fail_state_transition: $ref: '#/components/examples/invalid_auto_fail_state_transition' invalid_balance_refill_amount: $ref: '#/components/examples/invalid_balance_refill_amount' invalid_cash_back_limits: $ref: '#/components/examples/invalid_cash_back_limits' invalid_component_installed_into_socket: $ref: >- #/components/examples/invalid_component_installed_into_socket invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: >- #/components/examples/invalid_component_reference_socket_name invalid_coupon_pool_id: $ref: '#/components/examples/invalid_coupon_pool_id' invalid_expiration_date: $ref: '#/components/examples/invalid_expiration_date' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_initial_offset: $ref: '#/components/examples/invalid_initial_offset' invalid_json: $ref: '#/components/examples/invalid_json' invalid_limits: $ref: '#/components/examples/invalid_limits' invalid_missing_fulfillment_auto_fail_delay_ms: $ref: >- #/components/examples/invalid_missing_fulfillment_auto_fail_delay_ms invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_tag: $ref: '#/components/examples/invalid_tag' limit_out_of_range: $ref: '#/components/examples/limit_out_of_range' missing_request_body: $ref: '#/components/examples/missing_request_body' name_too_long: $ref: '#/components/examples/name_too_long' negative_cash_back_percentage: $ref: '#/components/examples/negative_cash_back_percentage' negative_max_cash_back: $ref: '#/components/examples/negative_max_cash_back' negative_min_cash_back: $ref: '#/components/examples/negative_min_cash_back' negative_missing_fulfillment_alert_delay_ms: $ref: >- #/components/examples/negative_missing_fulfillment_alert_delay_ms negative_missing_fulfillment_auto_fail_delay_ms: $ref: >- #/components/examples/negative_missing_fulfillment_auto_fail_delay_ms orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' partner_reward_supplier_id_invalid: $ref: '#/components/examples/partner_reward_supplier_id_invalid' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' reward_supplier_build_failed: $ref: '#/components/examples/reward_supplier_build_failed' reward_supplier_duplicated_name: $ref: '#/components/examples/reward_supplier_duplicated_name' reward_supplier_validation_failed: $ref: '#/components/examples/reward_supplier_validation_failed' salesforce_authentication_error: $ref: '#/components/examples/salesforce_authentication_error' salesforce_authorization_error: $ref: '#/components/examples/salesforce_authorization_error' salesforce_service_unavailable: $ref: '#/components/examples/salesforce_service_unavailable' salesforce_settings_disabled: $ref: '#/components/examples/salesforce_settings_disabled' salesforce_settings_not_defined: $ref: '#/components/examples/salesforce_settings_not_defined' salesforce_settings_used_by_reward_suppliers: $ref: >- #/components/examples/salesforce_settings_used_by_reward_suppliers self_component_reference: $ref: '#/components/examples/self_component_reference' settings_id_missing: $ref: '#/components/examples/settings_id_missing' unsupported_decimal_face_value_type: $ref: '#/components/examples/unsupported_decimal_face_value_type' unsupported_face_value_algorithm_type: $ref: '#/components/examples/unsupported_face_value_algorithm_type' unsupported_face_value_type: $ref: '#/components/examples/unsupported_face_value_type' zero_face_value: $ref: '#/components/examples/zero_face_value' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' account_id_missing: $ref: '#/components/examples/account_id_missing' face_value_missing: $ref: '#/components/examples/face_value_missing' face_value_type_missing: $ref: '#/components/examples/face_value_type_missing' merchant_token_missing: $ref: '#/components/examples/merchant_token_missing' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' missing_coupon_count_warn_limit: $ref: '#/components/examples/missing_coupon_count_warn_limit' name_missing: $ref: '#/components/examples/name_missing' required_merchant_token: $ref: '#/components/examples/required_merchant_token' reward_supplier_not_found: $ref: '#/components/examples/reward_supplier_not_found' utid_missing: $ref: '#/components/examples/utid_missing' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests '503': content: application/json: examples: tango_service_unavailable: $ref: '#/components/examples/tango_service_unavailable' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Service Unavailable components: schemas: RewardSupplierCreateRequest: description: Body of a `POST /v6/reward-suppliers` request. discriminator: mapping: CUSTOM_REWARD: $ref: '#/components/schemas/CustomRewardSupplierCreateRequest' MANUAL_COUPON: $ref: '#/components/schemas/ManualCouponRewardSupplierCreateRequest' PAYPAL_PAYOUTS: $ref: '#/components/schemas/PayPalPayoutsRewardSupplierCreateRequest' SALESFORCE_COUPON: $ref: '#/components/schemas/SalesforceCouponRewardSupplierCreateRequest' TANGO_V2: $ref: '#/components/schemas/TangoRewardSupplierCreateRequest' propertyName: reward_supplier_type oneOf: - title: CUSTOM_REWARD allOf: - $ref: '#/components/schemas/CustomRewardSupplierCreateRequest' - title: MANUAL_COUPON allOf: - $ref: '#/components/schemas/ManualCouponRewardSupplierCreateRequest' - title: PAYPAL_PAYOUTS allOf: - $ref: '#/components/schemas/PayPalPayoutsRewardSupplierCreateRequest' - title: SALESFORCE_COUPON allOf: - $ref: '#/components/schemas/SalesforceCouponRewardSupplierCreateRequest' - title: TANGO_V2 allOf: - $ref: '#/components/schemas/TangoRewardSupplierCreateRequest' required: - face_value_type - reward_supplier_type RewardSupplierResponse: discriminator: mapping: CUSTOM_REWARD: $ref: '#/components/schemas/CustomRewardSupplierResponse' MANUAL_COUPON: $ref: '#/components/schemas/ManualCouponRewardSupplierResponse' PAYPAL_PAYOUTS: $ref: '#/components/schemas/PayPalPayoutsRewardSupplierResponse' SALESFORCE_COUPON: $ref: '#/components/schemas/SalesforceCouponRewardSupplierResponse' TANGO_V2: $ref: '#/components/schemas/TangoRewardSupplierResponse' propertyName: reward_supplier_type oneOf: - title: CUSTOM_REWARD allOf: - $ref: '#/components/schemas/CustomRewardSupplierResponse' - title: MANUAL_COUPON allOf: - $ref: '#/components/schemas/ManualCouponRewardSupplierResponse' - title: PAYPAL_PAYOUTS allOf: - $ref: '#/components/schemas/PayPalPayoutsRewardSupplierResponse' - title: SALESFORCE_COUPON allOf: - $ref: '#/components/schemas/SalesforceCouponRewardSupplierResponse' - title: TANGO_V2 allOf: - $ref: '#/components/schemas/TangoRewardSupplierResponse' required: - cash_back_max - cash_back_min - cash_back_percentage - component_ids - component_references - created_date - data - display_name - display_type - enabled - face_value - face_value_algorithm_type - face_value_type - id - limit_per_day - limit_per_hour - name - partner_reward_key_type - partner_reward_supplier_id - reward_expires_at - reward_supplier_type - state_transitions - tags - updated_date RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object CustomRewardSupplierCreateRequest: allOf: - $ref: '#/components/schemas/RewardSupplierCreateRequestBase' - properties: auto_fulfillment_enabled: type: boolean description: $ref: >- #/components/schemas/DescriptionInCustomRewardSupplierCreateRequest display_name: $ref: >- #/components/schemas/DisplayNameInCustomRewardSupplierCreateRequest limit_per_day: $ref: >- #/components/schemas/LimitPerDayInCustomRewardSupplierCreateRequest limit_per_hour: $ref: >- #/components/schemas/LimitPerHourInCustomRewardSupplierCreateRequest missing_fulfillment_alert_delay_ms: format: int64 type: integer missing_fulfillment_alert_enabled: type: boolean missing_fulfillment_auto_fail_delay_ms: format: int64 type: integer missing_fulfillment_auto_fail_enabled: type: boolean reward_email_auto_send_enabled: type: boolean reward_expires_at: $ref: >- #/components/schemas/RewardExpiresAtInCustomRewardSupplierCreateRequest reward_supplier_type: enum: - CUSTOM_REWARD type: string state_transitions: additionalProperties: items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED - SENT type: string type: array type: object type: enum: - ACCOUNT_CREDIT - LOYALTY_POINTS type: string type: object required: - face_value_type - reward_supplier_type - type type: object title: CUSTOM_REWARD ManualCouponRewardSupplierCreateRequest: allOf: - $ref: '#/components/schemas/RewardSupplierCreateRequestBase' - properties: coupon_count_warn_limit: format: int32 type: integer default_coupon_expiry_date: $ref: '#/components/schemas/ZonedDateTime' description: $ref: >- #/components/schemas/DescriptionInManualCouponRewardSupplierCreateRequest display_name: $ref: >- #/components/schemas/DisplayNameInManualCouponRewardSupplierCreateRequest limit_per_day: $ref: >- #/components/schemas/LimitPerDayInManualCouponRewardSupplierCreateRequest limit_per_hour: $ref: >- #/components/schemas/LimitPerHourInManualCouponRewardSupplierCreateRequest minimum_coupon_lifetime: format: int64 type: integer reward_expires_at: $ref: >- #/components/schemas/RewardExpiresAtInManualCouponRewardSupplierCreateRequest reward_supplier_type: enum: - MANUAL_COUPON type: string type: object required: - coupon_count_warn_limit - face_value_type - reward_supplier_type type: object title: MANUAL_COUPON PayPalPayoutsRewardSupplierCreateRequest: allOf: - $ref: '#/components/schemas/RewardSupplierCreateRequestBase' - properties: description: $ref: >- #/components/schemas/DescriptionInPayPalPayoutsRewardSupplierCreateRequest display_name: $ref: >- #/components/schemas/DisplayNameInPayPalPayoutsRewardSupplierCreateRequest limit_per_day: $ref: >- #/components/schemas/LimitPerDayInPayPalPayoutsRewardSupplierCreateRequest limit_per_hour: $ref: >- #/components/schemas/LimitPerHourInPayPalPayoutsRewardSupplierCreateRequest merchant_token: type: string reward_expires_at: $ref: >- #/components/schemas/RewardExpiresAtInPayPalPayoutsRewardSupplierCreateRequest reward_supplier_type: enum: - PAYPAL_PAYOUTS type: string type: object required: - face_value_type - merchant_token - reward_supplier_type type: object title: PAYPAL_PAYOUTS SalesforceCouponRewardSupplierCreateRequest: allOf: - $ref: '#/components/schemas/RewardSupplierCreateRequestBase' - properties: balance_refill_amount: format: int32 type: integer coupon_pool_id: $ref: >- #/components/schemas/CouponPoolIdInSalesforceCouponRewardSupplierCreateRequest description: $ref: >- #/components/schemas/DescriptionInSalesforceCouponRewardSupplierCreateRequest display_name: $ref: >- #/components/schemas/DisplayNameInSalesforceCouponRewardSupplierCreateRequest initial_offset: format: int32 type: integer limit_per_day: $ref: >- #/components/schemas/LimitPerDayInSalesforceCouponRewardSupplierCreateRequest limit_per_hour: $ref: >- #/components/schemas/LimitPerHourInSalesforceCouponRewardSupplierCreateRequest reward_expires_at: $ref: >- #/components/schemas/RewardExpiresAtInSalesforceCouponRewardSupplierCreateRequest reward_supplier_type: enum: - SALESFORCE_COUPON type: string settings_id: type: string type: object required: - face_value_type - reward_supplier_type type: object title: SALESFORCE_COUPON TangoRewardSupplierCreateRequest: allOf: - $ref: '#/components/schemas/RewardSupplierCreateRequestBase' - properties: account_id: type: string description: $ref: >- #/components/schemas/DescriptionInTangoRewardSupplierCreateRequest display_name: $ref: >- #/components/schemas/DisplayNameInTangoRewardSupplierCreateRequest limit_per_day: $ref: >- #/components/schemas/LimitPerDayInTangoRewardSupplierCreateRequest limit_per_hour: $ref: >- #/components/schemas/LimitPerHourInTangoRewardSupplierCreateRequest reward_expires_at: $ref: >- #/components/schemas/RewardExpiresAtInTangoRewardSupplierCreateRequest reward_supplier_type: enum: - TANGO_V2 type: string utid: type: string type: object required: - account_id - face_value_type - reward_supplier_type - utid type: object title: TANGO_V2 CustomRewardSupplierResponse: allOf: - $ref: '#/components/schemas/RewardSupplierResponseBase' - properties: auto_fulfillment_enabled: type: boolean id: readOnly: true type: string missing_fulfillment_alert_delay_ms: format: int64 type: integer missing_fulfillment_alert_enabled: type: boolean missing_fulfillment_auto_fail_delay_ms: format: int64 type: integer missing_fulfillment_auto_fail_enabled: type: boolean reward_email_auto_send_enabled: type: boolean reward_supplier_type: enum: - CUSTOM_REWARD type: string type: enum: - ACCOUNT_CREDIT - LOYALTY_POINTS type: string type: object description: >- Stored custom reward supplier definition. Fields `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `display_type`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. required: - auto_fulfillment_enabled - cash_back_max - cash_back_min - cash_back_percentage - component_ids - component_references - created_date - data - display_name - display_type - enabled - face_value - face_value_algorithm_type - face_value_type - id - limit_per_day - limit_per_hour - missing_fulfillment_alert_delay_ms - missing_fulfillment_alert_enabled - missing_fulfillment_auto_fail_delay_ms - missing_fulfillment_auto_fail_enabled - name - partner_reward_key_type - partner_reward_supplier_id - reward_email_auto_send_enabled - reward_expires_at - reward_supplier_type - state_transitions - tags - type - updated_date type: object title: CUSTOM_REWARD ManualCouponRewardSupplierResponse: allOf: - $ref: '#/components/schemas/RewardSupplierResponseBase' - properties: coupon_count_warn_limit: format: int32 type: integer default_coupon_expiry_date: $ref: '#/components/schemas/ZonedDateTime' id: readOnly: true type: string minimum_coupon_lifetime: format: int64 type: integer reward_supplier_type: enum: - MANUAL_COUPON type: string type: object description: >- Stored manual coupon reward supplier definition. Fields `display_type`, `face_value_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `name`, `display_name`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. required: - cash_back_max - cash_back_min - cash_back_percentage - component_ids - component_references - coupon_count_warn_limit - created_date - data - default_coupon_expiry_date - display_name - display_type - enabled - face_value - face_value_algorithm_type - face_value_type - id - limit_per_day - limit_per_hour - minimum_coupon_lifetime - name - partner_reward_key_type - partner_reward_supplier_id - reward_expires_at - reward_supplier_type - state_transitions - tags - updated_date type: object title: MANUAL_COUPON PayPalPayoutsRewardSupplierResponse: allOf: - $ref: '#/components/schemas/RewardSupplierResponseBase' - properties: description: $ref: >- #/components/schemas/DescriptionInPayPalPayoutsRewardSupplierResponse id: readOnly: true type: string merchant_token: type: string reward_supplier_type: enum: - PAYPAL_PAYOUTS type: string type: object description: >- Stored pay pal payouts reward supplier definition. Fields `display_type`, `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `description`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. required: - cash_back_max - cash_back_min - cash_back_percentage - component_ids - component_references - created_date - data - description - display_name - display_type - enabled - face_value - face_value_algorithm_type - face_value_type - id - limit_per_day - limit_per_hour - merchant_token - name - partner_reward_key_type - partner_reward_supplier_id - reward_expires_at - reward_supplier_type - state_transitions - tags - updated_date type: object title: PAYPAL_PAYOUTS SalesforceCouponRewardSupplierResponse: allOf: - $ref: '#/components/schemas/RewardSupplierResponseBase' - properties: balance_refill_amount: format: int32 type: integer coupon_pool_id: $ref: >- #/components/schemas/CouponPoolIdInSalesforceCouponRewardSupplierResponse id: readOnly: true type: string initial_offset: format: int32 type: integer reward_supplier_type: enum: - SALESFORCE_COUPON type: string settings_id: type: string type: object description: >- Stored salesforce coupon reward supplier definition. Fields `display_type`, `face_value_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `name`, `display_name`, `coupon_pool_id`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. required: - balance_refill_amount - cash_back_max - cash_back_min - cash_back_percentage - component_ids - component_references - coupon_pool_id - created_date - data - display_name - display_type - enabled - face_value - face_value_algorithm_type - face_value_type - id - initial_offset - limit_per_day - limit_per_hour - name - partner_reward_key_type - partner_reward_supplier_id - reward_expires_at - reward_supplier_type - settings_id - state_transitions - tags - updated_date type: object title: SALESFORCE_COUPON TangoRewardSupplierResponse: allOf: - $ref: '#/components/schemas/RewardSupplierResponseBase' - properties: account_id: type: string brand_description: type: string brand_disclaimer: type: string brand_image_url: type: string brand_name: type: string description: $ref: '#/components/schemas/DescriptionInTangoRewardSupplierResponse' id: readOnly: true type: string reward_supplier_type: enum: - TANGO_V2 type: string utid: type: string type: object description: >- Stored tango reward supplier definition. Fields `display_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `name`, `display_name`, `description`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. required: - account_id - brand_description - brand_disclaimer - brand_image_url - brand_name - cash_back_max - cash_back_min - cash_back_percentage - component_ids - component_references - created_date - data - description - display_name - display_type - enabled - face_value - face_value_algorithm_type - face_value_type - id - limit_per_day - limit_per_hour - name - partner_reward_key_type - partner_reward_supplier_id - reward_expires_at - reward_supplier_type - state_transitions - tags - updated_date - utid type: object title: TANGO_V2 RewardSupplierCreateRequestBase: properties: cash_back_max: $ref: '#/components/schemas/CashBackMaxInRewardSupplierCreateRequestBase' cash_back_min: $ref: '#/components/schemas/CashBackMinInRewardSupplierCreateRequestBase' cash_back_percentage: $ref: >- #/components/schemas/CashBackPercentageInRewardSupplierCreateRequestBase component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInRewardSupplierCreateRequestBase' display_name: $ref: '#/components/schemas/DisplayNameInRewardSupplierCreateRequestBase' display_type: $ref: '#/components/schemas/DisplayTypeInRewardSupplierCreateRequestBase' enabled: $ref: '#/components/schemas/EnabledInRewardSupplierCreateRequestBase' face_value: $ref: '#/components/schemas/FaceValueInRewardSupplierCreateRequestBase' face_value_algorithm_type: $ref: >- #/components/schemas/FaceValueAlgorithmTypeInRewardSupplierCreateRequestBase face_value_type: $ref: '#/components/schemas/FaceValueTypeInRewardSupplierCreateRequestBase' limit_per_day: $ref: '#/components/schemas/LimitPerDayInRewardSupplierCreateRequestBase' limit_per_hour: $ref: '#/components/schemas/LimitPerHourInRewardSupplierCreateRequestBase' name: $ref: '#/components/schemas/NameInRewardSupplierCreateRequestBase' partner_reward_key_type: enum: - COUPON - ID - LINK type: string partner_reward_supplier_id: type: string reward_expires_at: $ref: >- #/components/schemas/RewardExpiresAtInRewardSupplierCreateRequestBase reward_supplier_type: enum: - CUSTOM_REWARD - MANUAL_COUPON - PAYPAL_PAYOUTS - SALESFORCE_COUPON - TANGO_V2 type: string tags: items: type: string type: array uniqueItems: true type: object DescriptionInCustomRewardSupplierCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInCustomRewardSupplierCreateRequest: description: Choose between static or dynamic display name oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInCustomRewardSupplierCreateRequest: description: Choose between static or dynamic limit per day oneOf: - description: Static limit per day format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInCustomRewardSupplierCreateRequest: description: Choose between static or dynamic limit per hour oneOf: - description: Static limit per hour format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInCustomRewardSupplierCreateRequest: description: Choose between static or dynamic reward expires at oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ZonedDateTime: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. example: '2025-10-24T02:00:00-07:00' pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string DescriptionInManualCouponRewardSupplierCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInManualCouponRewardSupplierCreateRequest: description: Choose between static or dynamic display name oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInManualCouponRewardSupplierCreateRequest: description: Choose between static or dynamic limit per day oneOf: - description: Static limit per day format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInManualCouponRewardSupplierCreateRequest: description: Choose between static or dynamic limit per hour oneOf: - description: Static limit per hour format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInManualCouponRewardSupplierCreateRequest: description: Choose between static or dynamic reward expires at oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DescriptionInPayPalPayoutsRewardSupplierCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInPayPalPayoutsRewardSupplierCreateRequest: description: Choose between static or dynamic display name oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInPayPalPayoutsRewardSupplierCreateRequest: description: Choose between static or dynamic limit per day oneOf: - description: Static limit per day format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInPayPalPayoutsRewardSupplierCreateRequest: description: Choose between static or dynamic limit per hour oneOf: - description: Static limit per hour format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInPayPalPayoutsRewardSupplierCreateRequest: description: Choose between static or dynamic reward expires at oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CouponPoolIdInSalesforceCouponRewardSupplierCreateRequest: description: Choose between static or dynamic coupon pool id oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static coupon pool id title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{couponPoolId}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('couponPoolId');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInSalesforceCouponRewardSupplierCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInSalesforceCouponRewardSupplierCreateRequest: description: Choose between static or dynamic display name oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInSalesforceCouponRewardSupplierCreateRequest: description: Choose between static or dynamic limit per day oneOf: - description: Static limit per day format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInSalesforceCouponRewardSupplierCreateRequest: description: Choose between static or dynamic limit per hour oneOf: - description: Static limit per hour format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInSalesforceCouponRewardSupplierCreateRequest: description: Choose between static or dynamic reward expires at oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DescriptionInTangoRewardSupplierCreateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInTangoRewardSupplierCreateRequest: description: Choose between static or dynamic display name oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInTangoRewardSupplierCreateRequest: description: Choose between static or dynamic limit per day oneOf: - description: Static limit per day format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInTangoRewardSupplierCreateRequest: description: Choose between static or dynamic limit per hour oneOf: - description: Static limit per hour format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInTangoRewardSupplierCreateRequest: description: Choose between static or dynamic reward expires at oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardSupplierResponseBase: properties: cash_back_max: $ref: '#/components/schemas/CashBackMaxInRewardSupplierResponseBase' cash_back_min: $ref: '#/components/schemas/CashBackMinInRewardSupplierResponseBase' cash_back_percentage: $ref: '#/components/schemas/CashBackPercentageInRewardSupplierResponseBase' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' display_name: $ref: '#/components/schemas/DisplayNameInRewardSupplierResponseBase' display_type: $ref: '#/components/schemas/DisplayTypeInRewardSupplierResponseBase' enabled: $ref: '#/components/schemas/EnabledInRewardSupplierResponseBase' face_value: $ref: '#/components/schemas/FaceValueInRewardSupplierResponseBase' face_value_algorithm_type: $ref: >- #/components/schemas/FaceValueAlgorithmTypeInRewardSupplierResponseBase face_value_type: $ref: '#/components/schemas/FaceValueTypeInRewardSupplierResponseBase' id: readOnly: true type: string limit_per_day: $ref: '#/components/schemas/LimitPerDayInRewardSupplierResponseBase' limit_per_hour: $ref: '#/components/schemas/LimitPerHourInRewardSupplierResponseBase' name: $ref: '#/components/schemas/NameInRewardSupplierResponseBase' partner_reward_key_type: enum: - COUPON - ID - LINK type: string partner_reward_supplier_id: type: string reward_expires_at: $ref: '#/components/schemas/RewardExpiresAtInRewardSupplierResponseBase' reward_supplier_type: enum: - CUSTOM_REWARD - MANUAL_COUPON - PAYPAL_PAYOUTS - SALESFORCE_COUPON - TANGO_V2 type: string state_transitions: additionalProperties: items: enum: - CANCELED - EARNED - FAILED - FULFILLED - REDEEMED - REVOKED - SENT type: string type: array type: object tags: items: type: string type: array uniqueItems: true updated_date: $ref: '#/components/schemas/ZonedDateTime' type: object DescriptionInPayPalPayoutsRewardSupplierResponse: description: >- The description as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal description title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CouponPoolIdInSalesforceCouponRewardSupplierResponse: description: >- The coupon pool id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal coupon pool id title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{couponPoolId}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('couponPoolId');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInTangoRewardSupplierResponse: description: >- The description as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal description title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CashBackMaxInRewardSupplierCreateRequestBase: description: Choose between static or dynamic cash back max oneOf: - description: Static cash back max title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{cashBackMax}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('cashBackMax');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CashBackMinInRewardSupplierCreateRequestBase: description: Choose between static or dynamic cash back min oneOf: - description: Static cash back min title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{cashBackMin}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('cashBackMin');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CashBackPercentageInRewardSupplierCreateRequestBase: description: Choose between static or dynamic cash back percentage oneOf: - description: Static cash back percentage title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{cashBackPercentage}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('cashBackPercentage');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object DescriptionInRewardSupplierCreateRequestBase: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInRewardSupplierCreateRequestBase: description: Choose between static or dynamic display name oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayTypeInRewardSupplierCreateRequestBase: description: Choose between static or dynamic display type oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static display type title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayType}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayType');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInRewardSupplierCreateRequestBase: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FaceValueInRewardSupplierCreateRequestBase: description: Choose between static or dynamic face value oneOf: - description: Static face value title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{faceValue}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('faceValue');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FaceValueAlgorithmTypeInRewardSupplierCreateRequestBase: description: Choose between static or dynamic face value algorithm type oneOf: - description: Static face value algorithm type enum: - CASH_BACK - FIXED title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{faceValueAlgorithmType}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('faceValueAlgorithmType');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FaceValueTypeInRewardSupplierCreateRequestBase: description: Choose between static or dynamic face value type oneOf: - description: Static face value type enum: - AUD - BRL - CAD - CNY - EUR - GBP - HKD - INR - JPY - KRW - MONTH - MXN - NZD - PERCENT_OFF - POINTS - TRY - TWD - USD title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{faceValueType}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('faceValueType');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInRewardSupplierCreateRequestBase: description: Choose between static or dynamic limit per day oneOf: - description: Static limit per day format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInRewardSupplierCreateRequestBase: description: Choose between static or dynamic limit per hour oneOf: - description: Static limit per hour format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInRewardSupplierCreateRequestBase: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static name title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInRewardSupplierCreateRequestBase: description: Choose between static or dynamic reward expires at oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Static reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string CashBackMaxInRewardSupplierResponseBase: description: >- The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal cash back max title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{cashBackMax}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('cashBackMax');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CashBackMinInRewardSupplierResponseBase: description: >- The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal cash back min title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{cashBackMin}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('cashBackMin');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string CashBackPercentageInRewardSupplierResponseBase: description: >- The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal cash back percentage title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{cashBackPercentage}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('cashBackPercentage');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object DisplayNameInRewardSupplierResponseBase: description: >- The display name as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal display name title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayTypeInRewardSupplierResponseBase: description: >- The display type as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal display type title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayType}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayType');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInRewardSupplierResponseBase: description: >- The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal enabled title: Static Value type: boolean - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FaceValueInRewardSupplierResponseBase: description: >- The face value as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal face value title: Static Value type: number - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{faceValue}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('faceValue');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FaceValueAlgorithmTypeInRewardSupplierResponseBase: description: >- The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal face value algorithm type enum: - CASH_BACK - FIXED title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{faceValueAlgorithmType}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('faceValueAlgorithmType');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string FaceValueTypeInRewardSupplierResponseBase: description: >- The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal face value type enum: - AUD - BRL - CAD - CNY - EUR - GBP - HKD - INR - JPY - KRW - MONTH - MXN - NZD - PERCENT_OFF - POINTS - TRY - TWD - USD title: Static Value type: string - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{faceValueType}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('faceValueType');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerDayInRewardSupplierResponseBase: description: >- The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal limit per day format: int32 title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerDay}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerDay');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string LimitPerHourInRewardSupplierResponseBase: description: >- The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal limit per hour format: int32 title: Static Value type: integer - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{limitPerHour}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('limitPerHour');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInRewardSupplierResponseBase: description: >- The name as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RewardExpiresAtInRewardSupplierResponseBase: description: >- The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - $ref: '#/components/schemas/ZonedDateTime' description: Literal reward expires at title: Static Value - description: >- Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: handlebars@buildtime:{{rewardExpiresAt}} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('rewardExpiresAt');} externalDocs: description: RewardSupplierBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: handlebars@runtime:{{rewardExpiresAt}} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). example: >- javascript@runtime:function() { return context.get('rewardExpiresAt');} externalDocs: description: RewardFulfillmentEvaluationContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string examples: account_not_found: summary: account_not_found value: code: account_not_found http_status_code: 400 message: unable to find account parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 balance_refill_amount_missing: summary: balance_refill_amount_missing value: code: balance_refill_amount_missing http_status_code: 400 message: Balance refill amount is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_absolute_name_missing: summary: campaign_component_absolute_name_missing value: code: campaign_component_absolute_name_missing http_status_code: 400 message: Campaign component absolute name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_description_out_of_range: summary: campaign_component_description_out_of_range value: code: campaign_component_description_out_of_range http_status_code: 400 message: Campaign component description length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_contains_illegal_character: summary: campaign_component_display_name_contains_illegal_character value: code: campaign_component_display_name_contains_illegal_character http_status_code: 400 message: >- Campaign component display name can only contain alphanumeric, dash, underscore, whitespace, asterisk, hash, dollar characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_out_of_range: summary: campaign_component_display_name_out_of_range value: code: campaign_component_display_name_out_of_range http_status_code: 400 message: Campaign component display name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_id_missing: summary: campaign_component_id_missing value: code: campaign_component_id_missing http_status_code: 400 message: Campaign component id is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_already_in_use: summary: campaign_component_name_already_in_use value: code: campaign_component_name_already_in_use http_status_code: 400 message: Campaign component name is already used by another component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_contains_illegal_character: summary: campaign_component_name_contains_illegal_character value: code: campaign_component_name_contains_illegal_character http_status_code: 400 message: >- Campaign component name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_out_of_range: summary: campaign_component_name_out_of_range value: code: campaign_component_name_out_of_range http_status_code: 400 message: Campaign component name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_type_validation_failed: summary: campaign_component_type_validation_failed value: code: campaign_component_type_validation_failed http_status_code: 400 message: Campaign component type validation failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 cash_back_limits_out_of_bounds: summary: cash_back_limits_out_of_bounds value: code: cash_back_limits_out_of_bounds http_status_code: 400 message: Cash back min/max limits should be within brand limits parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 catalog_item_not_found: summary: catalog_item_not_found value: code: catalog_item_not_found http_status_code: 400 message: unable to find catalog item parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 circular_component_reference: summary: circular_component_reference value: code: circular_component_reference http_status_code: 400 message: Circular campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_facets_not_found: summary: component_facets_not_found value: code: component_facets_not_found http_status_code: 400 message: Component facets not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 coupon_count_warn_limit_invalid: summary: coupon_count_warn_limit_invalid value: code: coupon_count_warn_limit_invalid http_status_code: 400 message: Coupon count warn limit must be a non-negative integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 coupon_pool_id_already_in_use: summary: coupon_pool_id_already_in_use value: code: coupon_pool_id_already_in_use http_status_code: 400 message: Salesforce Commerce Cloud Coupon Set is already used parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 coupon_pool_id_missing: summary: coupon_pool_id_missing value: code: coupon_pool_id_missing http_status_code: 400 message: Coupon pool id is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 custom_reward_type_missing: summary: custom_reward_type_missing value: code: custom_reward_type_missing http_status_code: 400 message: Custom reward type id missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 description_too_long: summary: description_too_long value: code: description_too_long http_status_code: 400 message: Description should not exceed the specified length limit parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 display_name_too_long: summary: display_name_too_long value: code: display_name_too_long http_status_code: 400 message: Display name should not exceed the specified length limit parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 excessive_component_reference: summary: excessive_component_reference value: code: excessive_component_reference http_status_code: 400 message: Root campaign component may have at most one reference parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_is_referenced_by_active_configuration: summary: external_element_is_referenced_by_active_configuration value: code: external_element_is_referenced_by_active_configuration http_status_code: 400 message: External element is referenced by active configuration parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_elements_cannot_have_multiple_references: summary: external_elements_cannot_have_multiple_references value: code: external_elements_cannot_have_multiple_references http_status_code: 400 message: External elements cannot have multiple references parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 face_value: summary: face_value value: code: face_value http_status_code: 400 message: Face value should be within brand limits parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 face_value_out_of_range: summary: face_value_out_of_range value: code: face_value_out_of_range http_status_code: 400 message: Face value is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 illegal_character_in_description: summary: illegal_character_in_description value: code: illegal_character_in_description http_status_code: 400 message: Description can only contain alphanumeric characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 illegal_character_in_name: summary: illegal_character_in_name value: code: illegal_character_in_name http_status_code: 400 message: Name can only contain alphanumeric characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 illegal_value_of_minimum_coupon_lifetime: summary: illegal_value_of_minimum_coupon_lifetime value: code: illegal_value_of_minimum_coupon_lifetime http_status_code: 400 message: Minimum coupon lifetime should be greater than 0 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 inexisting_coupon_pool_id: summary: inexisting_coupon_pool_id value: code: inexisting_coupon_pool_id http_status_code: 400 message: Coupon pool id not found in Salesforce parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_auto_fail_state_transition: summary: invalid_auto_fail_state_transition value: code: invalid_auto_fail_state_transition http_status_code: 400 message: >- Missing fulfillment auto fail is enabled but state transitions do not allow EARNED -> FAILED parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_balance_refill_amount: summary: invalid_balance_refill_amount value: code: invalid_balance_refill_amount http_status_code: 400 message: Balance refill amount must be a positive integer, greater than zero parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_cash_back_limits: summary: invalid_cash_back_limits value: code: invalid_cash_back_limits http_status_code: 400 message: Max cash back limit should greater or equal to min cash back limit parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_installed_into_socket: summary: invalid_component_installed_into_socket value: code: invalid_component_installed_into_socket http_status_code: 400 message: Invalid component installed into socket parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference: summary: invalid_component_reference value: code: invalid_component_reference http_status_code: 400 message: Unknown referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference_socket_name: summary: invalid_component_reference_socket_name value: code: invalid_component_reference_socket_name http_status_code: 400 message: Invalid component reference socket name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_coupon_pool_id: summary: invalid_coupon_pool_id value: code: invalid_coupon_pool_id http_status_code: 400 message: Salesforce coupon pool id must be a valid URL path segment parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_expiration_date: summary: invalid_expiration_date value: code: invalid_expiration_date http_status_code: 400 message: Expiration date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_external_component_reference: summary: invalid_external_component_reference value: code: invalid_external_component_reference http_status_code: 400 message: Unknown external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_initial_offset: summary: invalid_initial_offset value: code: invalid_initial_offset http_status_code: 400 message: Initial offset must be a positive integer or zero parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_limits: summary: invalid_limits value: code: invalid_limits http_status_code: 400 message: Limit per day should be greater or equal to limit per hour parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_missing_fulfillment_auto_fail_delay_ms: summary: invalid_missing_fulfillment_auto_fail_delay_ms value: code: invalid_missing_fulfillment_auto_fail_delay_ms http_status_code: 400 message: >- Missing fulfillment auto fail delay should not be lower than alert delay parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_tag: summary: invalid_tag value: code: invalid_tag http_status_code: 400 message: Invalid tag parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 limit_out_of_range: summary: limit_out_of_range value: code: limit_out_of_range http_status_code: 400 message: Limit is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 name_too_long: summary: name_too_long value: code: name_too_long http_status_code: 400 message: Name should not exceed the specified length limit parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 negative_cash_back_percentage: summary: negative_cash_back_percentage value: code: negative_cash_back_percentage http_status_code: 400 message: Cash back percentage should be a non negative number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 negative_max_cash_back: summary: negative_max_cash_back value: code: negative_max_cash_back http_status_code: 400 message: Max cash back limit should be a non negative number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 negative_min_cash_back: summary: negative_min_cash_back value: code: negative_min_cash_back http_status_code: 400 message: Min cash back limit should be a non negative number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 negative_missing_fulfillment_alert_delay_ms: summary: negative_missing_fulfillment_alert_delay_ms value: code: negative_missing_fulfillment_alert_delay_ms http_status_code: 400 message: Missing fulfillment alert delay should be a positive number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 negative_missing_fulfillment_auto_fail_delay_ms: summary: negative_missing_fulfillment_auto_fail_delay_ms value: code: negative_missing_fulfillment_auto_fail_delay_ms http_status_code: 400 message: Missing fulfillment auto fail delay should be a positive number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 orphan_external_component_reference: summary: orphan_external_component_reference value: code: orphan_external_component_reference http_status_code: 400 message: Orphan external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 partner_reward_supplier_id_invalid: summary: partner_reward_supplier_id_invalid value: code: partner_reward_supplier_id_invalid http_status_code: 400 message: Partner reward supplier id is too long, max length is 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 redundant_component_reference: summary: redundant_component_reference value: code: redundant_component_reference http_status_code: 400 message: Same reference defined multiple times parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_build_failed: summary: reward_supplier_build_failed value: code: reward_supplier_build_failed http_status_code: 400 message: Reward supplier build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_duplicated_name: summary: reward_supplier_duplicated_name value: code: reward_supplier_duplicated_name http_status_code: 400 message: Reward supplier with such name already exists parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_validation_failed: summary: reward_supplier_validation_failed value: code: reward_supplier_validation_failed http_status_code: 400 message: Reward supplier validation failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 salesforce_authentication_error: summary: salesforce_authentication_error value: code: salesforce_authentication_error http_status_code: 400 message: >- Authentication error occurred while trying to obtain an access token from Salesforce via oAuth service parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 salesforce_authorization_error: summary: salesforce_authorization_error value: code: salesforce_authorization_error http_status_code: 400 message: >- Salesforce authorization error - client access token rejected by the Data API parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 salesforce_service_unavailable: summary: salesforce_service_unavailable value: code: salesforce_service_unavailable http_status_code: 400 message: Salesforce service unavailable parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 salesforce_settings_disabled: summary: salesforce_settings_disabled value: code: salesforce_settings_disabled http_status_code: 400 message: Salesforce settings disabled parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 salesforce_settings_not_defined: summary: salesforce_settings_not_defined value: code: salesforce_settings_not_defined http_status_code: 400 message: Salesforce settings not defined for this client parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 salesforce_settings_used_by_reward_suppliers: summary: salesforce_settings_used_by_reward_suppliers value: code: salesforce_settings_used_by_reward_suppliers http_status_code: 400 message: >- You can't delete this account, since it is associated with SFCC coupon reward suppliers. Please delete your SFCC reward suppliers first. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 self_component_reference: summary: self_component_reference value: code: self_component_reference http_status_code: 400 message: Self campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 settings_id_missing: summary: settings_id_missing value: code: settings_id_missing http_status_code: 400 message: Settings id missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_decimal_face_value_type: summary: unsupported_decimal_face_value_type value: code: unsupported_decimal_face_value_type http_status_code: 400 message: Specified PayPal face value type does not support decimals parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_face_value_algorithm_type: summary: unsupported_face_value_algorithm_type value: code: unsupported_face_value_algorithm_type http_status_code: 400 message: Face value algorithm type is not supported for this reward supplier parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_face_value_type: summary: unsupported_face_value_type value: code: unsupported_face_value_type http_status_code: 400 message: Specified PayPal face value type is not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 zero_face_value: summary: zero_face_value value: code: zero_face_value http_status_code: 400 message: Face Value should be a positive non zero number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 account_id_missing: summary: account_id_missing value: code: account_id_missing http_status_code: 403 message: account_id is a required attribute parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 face_value_missing: summary: face_value_missing value: code: face_value_missing http_status_code: 403 message: Face value must be a non-null value upon creation parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 face_value_type_missing: summary: face_value_type_missing value: code: face_value_type_missing http_status_code: 403 message: Face value type must be a non-null value upon creation parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 merchant_token_missing: summary: merchant_token_missing value: code: merchant_token_missing http_status_code: 403 message: Non blank Merchant token should be specified upon creation parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_coupon_count_warn_limit: summary: missing_coupon_count_warn_limit value: code: missing_coupon_count_warn_limit http_status_code: 403 message: Coupon count warn limit must be defined parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 name_missing: summary: name_missing value: code: name_missing http_status_code: 403 message: Name must be a non-null value upon creation parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 required_merchant_token: summary: required_merchant_token value: code: required_merchant_token http_status_code: 403 message: Merchant token required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_not_found: summary: reward_supplier_not_found value: code: reward_supplier_not_found http_status_code: 403 message: Reward supplier not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 utid_missing: summary: utid_missing value: code: utid_missing http_status_code: 403 message: utid is a required attribute parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 tango_service_unavailable: summary: tango_service_unavailable value: code: tango_service_unavailable http_status_code: 503 message: Tango service unavailable parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````