# Get promotions by phone number

Returns a list of all available promotions for a member by using the mobile phone number

Endpoint: GET /promotions/mobilePhone
Version: 4.3.0
Security: api_key

## Query parameters:

  - `mobilePhone` (string, required)
    Customers mobile phone number

The type of id parameter is configurable where the most common types are id, mobile phone or an external id.

## Response 200 fields (application/json):

  - `id` (string)
    Generated unique promotion id
    Example: "2457B03E-9925-45E9-B551-25F10D7BD4F2"

  - `type` (string)
    Type of promotion
    Example: "Promotion"

  - `name` (string)
    Name of promotion
    Example: "Welcome coupon"

  - `available` (boolean)
    Boolean that shows the promotions availabilty status
    Example: true

  - `description` (string)
    Example: "This is a coupon that gives the customer 10% discount on any product"

  - `terms` (string)
    Terms and conditions of the promotion
    Example: "This promotion is valid for all products in the store"

  - `urlLink` (string)
    Example: "Link to the promotion"

  - `urlImage` (string)
    Link to promotion image
    Example: "https://cdn.oculos.no/img01.png"

  - `validFrom` (string)
    Example: "2024-04-03T07:38:32.495Z"

  - `validTo` (string)
    Example: "2024-04-03T07:38:32.495Z"

  - `validTimeFrom` (string)
    Time of day the promotion becomes valid. Note: This is only a description field that can be used to display information, the actual validity is determined by validFrom and validTo. Default value is 00:00:00
    Example: "08:00:00"

  - `validTimeTo` (string)
    Time of day the promotion becomes invalid. Note: This is only a description field that can be used to display information, the actual validity is determined by validFrom and validTo. Default value is 00:00:00
    Example: "20:00:00"

  - `unlimitedRedemption` (boolean)
    Can the promotion be redeemed unlimited times

  - `redemptionLimit` (integer)
    How many times can the promotion be redeemed?
    Example: 5

  - `redemptionCount` (integer)
    How many times has the promotion been redeem until now
    Example: 1

  - `sortOrder` (integer)
    Sort order of the promotion. The sort order is defined in the Trigg application
    Example: 1

  - `productsIncluded` (array)

  - `productsIncluded.id` (string)
    Id of product
    Example: 123

  - `productsIncluded.type` (string)
    Example: "description"

  - `productsExcluded` (array)

  - `storesIncluded` (array)

  - `affiliate` (object)
    Affiliate information

  - `affiliate.id` (string)
    Id of affiliate
    Example: "154831A5-7E2E-44D8-8F2B-FB0D33CAD941"

  - `affiliate.name` (string)
    Name of affiliate
    Example: "Sample Affiliate"

  - `redemptionChannels` (array)

  - `redemptionChannels.type` (string)
    Channel identifier. Can be ECOM, POS or ALL
    Example: "POS"

  - `redemptionChannels.valueType` (string)
    PERCENT, AMOUNT or CODE
    Example: "PERCENT"

  - `redemptionChannels.value` (string)
    The value of the promotion
    Example: 10

  - `redemptionChannels.message` (string)
    Can contain a small message/instruction for coupon usage
    Example: "Only applies to members"

  - `redemptionHistory` (array)

  - `redemptionHistory.storeId` (string)
    Id of product
    Example: "S-1001"

  - `redemptionHistory.receiptId` (string)
    Unique receiptId
    Example: "120C4CF0-1923-4737-8096-A6E8A89F9574"

  - `redemptionHistory.redeemDateTime` (string)
    Example: "2024-04-03T07:38:32.495Z"


## Response 400 fields

## Response 403 fields

## Response 404 fields