Commerce
Activate or deactivate a discount
Deactivating ends the discount now; activating starts it now.
PlatformsShopify
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
discountId*string
Platform-native id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
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.setCommerceDiscountActive({ path: { discountId: 'discount_abc123', }, body: { accountId: 'account_abc123', active: false, },});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": {} }}Was this page helpful?
Update a discount
Changes a percentage, fixed-amount or free-shipping discount. Buy-X-get-Y and app discounts are read-only here.
Add codes to a discount
Adds up to 250 more codes to a code discount, for example one per influencer. The platform adds them in the background. Needs discounts.codes, which WooCommerce stores do not have.