Get a discount
One discount with its value, targets, minimum, usage and schedule. Needs discounts.read.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
Platform-native id.
Query Parameters
Connected store SocialAccount id.
Response 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.getCommerceDiscount({ path: { discountId: 'discount_abc123', }, query: { accountId: 'account_abc123', },});console.log(data);{ "discount": { "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": {} }}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.
Create a discount
Creates a code discount (buyers enter a code) or an automatic one (applied at checkout), as a percentage, a fixed amount or free shipping. It applies to every product unless productIds or collectionIds narrow it, and to every buyer.