Get promo code

GET

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

Get information about a specific promo code.

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

store_idstringRequired

The store id.

promo_rule_idstringRequired

The id for the promo rule of a store.

promo_code_idstringRequired

The id for the promo code of a store.

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.

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

codestringOptional

The discount code. Restricted to UTF-8 characters with max length 50.

created_at_foreigndatetimeOptional

The date and time the promotion was created in ISO 8601 format.

enabledbooleanOptional

Whether the promo code is currently enabled.

idstringOptionalRead-only

A unique identifier for the promo Code.

redemption_urlstringOptional

The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000.

updated_at_foreigndatetimeOptional

The date and time the promotion was updated in ISO 8601 format.

usage_countintegerOptional

Number of times promo code has been used.