Get promo rule

GET

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

Get information about a specific promo rule.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

store_idstringRequired

The store id.

promo_rule_idstringRequired

The id for the promo rule of a store.

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.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

amountfloatOptional

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_foreigndatetimeOptional

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

descriptionstringOptional

The description of a promotion restricted to UTF-8 characters with max length 255.

enabledbooleanOptional

Whether the promo rule is currently enabled.

ends_atstringOptionalformat: "Promo date-time"

The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format.

idstringOptionalRead-only

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_atdatetimeOptional

The date and time when the promotion is in effect in ISO 8601 format.

targetenumOptional

The target that the discount applies to.

Allowed values:

titlestringOptional

The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes.

typeenumOptional

Type of discount. For free shipping set type to fixed.

Allowed values:

updated_at_foreigndatetimeOptional

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