---
title: "List promo rules"
method: GET
path: "/3.0/ecommerce/stores/{store_id}/promo-rules"
tags: ["ecommerce"]
---

# List promo rules

`GET /3.0/ecommerce/stores/{store_id}/promo-rules`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/ecommerce/stores/{store_id}/promo-rules`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/ecommerce/stores/:store_id/promo-rules/get.ts> (a function with typed inputs; its response is checked against the schema)

Get information about a store's promo rules.

## Path parameters

- `store_id` string, required

## Query parameters

- `fields` string[]
- `exclude_fields` string[]
- `count` integer
- `offset` integer

## Response `200`

- object: A collection of the store's promo rules.
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
  - `promo_rules` object[]: An array of objects, each representing promo rules defined for a store.
    - `_links` object[]: A list of link types and descriptions for the API schema documents.
      - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
      - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
      - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
    - `amount` number, float: The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive.
    - `created_at_foreign` string, date-time: The date and time the promotion was created in ISO 8601 format.
    - `description` string: The description of a promotion restricted to UTF-8 characters with max length 255.
    - `enabled` boolean: Whether the promo rule is currently enabled.
    - `ends_at` string, Promo date-time: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format.
    - `id` string: A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50.
    - `starts_at` string, date-time: The date and time when the promotion is in effect in ISO 8601 format.
    - `target` 'per_item' | 'total' | 'shipping': The target that the discount applies to.
    - `title` string: The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes.
    - `type` 'fixed' | 'percentage': Type of discount. For free shipping set type to fixed.
    - `updated_at_foreign` string, date-time: The date and time the promotion was updated in ISO 8601 format.
  - `store_id` string: The store id.
  - `total_items` integer: The total number of items matching the query regardless of pagination.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

[API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)