List promo codes

GET

https://api.mailchimp.com/3.0/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes

GET

/3.0/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes

curl https://api.mailchimp.com/3.0/ecommerce/stores/store_id/promo-rules/promo_rule_id/promo-codes \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "promo_codes": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "code": "summersale",
      "created_at_foreign": "2024-01-15T09:30:00Z",
      "enabled": "true",
      "id": "string",
      "redemption_url": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
      "updated_at_foreign": "2024-01-15T09:30:00Z",
      "usage_count": 1
    }
  ],
  "store_id": "string",
  "total_items": 1
}

Get information about a store’s promo codes.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

promo_rule_idstringRequired

The id for the promo rule of a store.

store_idstringRequired

The store id.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

promo_codeslist of objectsOptional

An array of objects, each representing promo codes defined for a store.

store_idstringOptional

The store id.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.