MAmailchimp
ecommerce

List promo rules

Get information about a store's promo rules.

get/3.0/ecommerce/stores/{store_id}/promo-rules

Request

Path parameters

store_idstring required

The store id.

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

countinteger

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

offsetinteger

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

Response

store_idstring

The store id.

total_itemsinteger

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

Example response

{
  "promo_rules": [
    {
      "amount": 0.5,
      "description": "Save BIG during our summer sale!",
      "title": "50% off Total Order"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.