Commerce
List discounts
The store's discounts (Shopify code and automatic discounts, WooCommerce coupons), cursor-paginated with limit, cursor and an optional query. Each discount lists its first 10 codes; codeCount has the total. Needs discounts.read.
PlatformsShopify
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Query Parameters
accountId*string
Connected store SocialAccount id.
limit?integer
Range
1 <= value <= 100Default
20cursor?string
query?string
Platform search syntax, passed through.
Length
length <= 500Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.commerce.listCommerceDiscounts({ query: { accountId: 'account_abc123', },});console.log(data);{ "discounts": [ { "id": "string", "accountId": "string", "platform": "shopify", "title": "string", "method": "code", "type": "percentage", "codes": [ "string" ], "codeCount": 0, "value": { "type": "percentage", "percentage": 0 }, "appliesTo": { "type": "all", "productIds": [ "string" ], "variantIds": [ "string" ], "collectionIds": [ "string" ] }, "minimum": { "type": "subtotal", "amount": { "amount": "string", "currency": "string" }, "quantity": 0 }, "usageLimit": 0, "oncePerCustomer": true, "usageCount": 0, "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "status": "active", "platformStatus": "string", "summary": "string", "platformData": {} } ], "nextCursor": "string"}Was this page helpful?