## Response Object

### Top-level object

| Field               | Type   | Description                                         |
| ------------------- | ------ | --------------------------------------------------- |
| `merchant_offers`   | list   | List of rates/offers available to the user.         |

### `merchant_offers` List

| Field               | Type   | Description                                         |
| ------------------- | ------ | --------------------------------------------------- |
| `merchant_id`      | string | Brand organization ID                               |
| `offers`           | list   | List of all Brand rates/offers available to the user. |

### `offers` List

| Field               | Type   | Description                                         |
| ------------------- | ------ | --------------------------------------------------- |
| `id`               | string | Offer ID                                           |
| `rank`             | integer| Rank of each offer                                  |
| `rate_percent`     | string | (optional) Decimal string of offer rate in percent. |
| `rate_fixed`       | string | (optional) Decimal string of offer rate in fixed amount. |
| `currency`         | string | (optional) Three-letter ISO currency code if `rate_fixed` (if available), as specified in [ISO 4217](http://www.xe.com/iso4217.php). |
| `display_params`   | map`<string>`string | (optional) A map of template parameters that can be used by the Publisher to render the rate/offer. |

### `display_params` Object

| Field               | Type   | Description                                         |
| ------------------- | ------ | --------------------------------------------------- |
| `category`         | string | (optional) A description of the offers details. Commonly includes a comma separated list of included/excluded categories or other general offer labeling information. Intended to be human readable and suitable for end user display. |
| `offer_type`       | string | (optional) Offer type classification. "Default" = A default/fallback rate, used when there aren’t more specific rates. "Category" = an offer for one or more categories of shopping. "Product" = an offer for one or more products/skus, etc. "Exclusion" = used when the offer is 0/0% and denotes as non commissionable. |
| `offer_tag`        | string | (optional) Offer tag indicating if the offer is a promotional rate (i.e. temporarily boosted/featured or marketing, etc.). Long-term increased rates are not typically promotional. |

### Example Request

```shell
curl https://pubapi.usebutton.com/v1/offers \
  -X POST \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "some-user-id",
    "device_ids": ["123"],
    "email_sha256s": ["1234567a1234567a1234567a1234567a1234567a1234567a1234567a1234567a"]
  }'
```

### Response

```json
{
  "status": "200",
  "message": "Result"
}
```