Zernio
Zernio
API Reference

Commerce

Store & Products

Get a storeGETList productsGETGet a productGETCreate a productPOSTUpdate a productPATCHDuplicate a productPOSTActivate, deactivate, archive or delete productsPOSTAdd or remove tags in bulkPOSTUpdate variant pricesPOST

Variants, Options & Images

Add variantsPOSTDelete variantsDELETEAdd optionsPOSTDelete optionsDELETEAdd imagesPOSTRemove imagesDELETEReorder imagesPOST

Inventory

List locationsGETGet a product's stockGETSet or adjust stockPOST

Collections

List collectionsGETGet a collectionGETCreate a collectionPOSTUpdate a collectionPATCHDelete a collectionDELETEAdd or remove products in a collectionPOSTReorder products in a collectionPOST

Discounts

List discountsGETGet a discountGETCreate a discountPOSTUpdate a discountPATCHActivate or deactivate a discountPOSTAdd codes to a discountPOSTDelete a discountDELETE

Sales Channels

List sales channelsGET

Markets & Price Lists

List marketsGETList price listsGETSet fixed pricesPUTRemove fixed pricesDELETE

Metafields & Metaobjects

List metaobject definitionsGETList metaobjects of a typeGETGet a metaobjectGETCreate a metaobjectPOSTUpdate a metaobjectPATCHDelete a metaobjectDELETE

Pages, Menus & Redirects

List pagesGETGet a pageGETCreate a pagePOSTUpdate a pagePATCHDelete a pageDELETEList navigation menusGETGet a navigation menuGETCreate a navigation menuPOSTReplace a navigation menuPUTDelete a navigation menuDELETEList URL redirectsGETCreate a URL redirectPOSTUpdate a URL redirectPATCHDelete a URL redirectDELETE

Marketing Activities

Record a marketing activityPUTDelete a marketing activityDELETEReport daily engagementPOST

Meta Catalog Sync

List catalog syncsGETSync a store into a Meta catalogPOSTGet a catalog syncGETRun a catalog sync nowPOSTStop a catalog syncDELETE

Other

Publish or unpublish a collectionPOSTPublish or unpublish a productPOSTDelete collection metafieldsDELETEDelete product metafieldsDELETEList collection metafieldsGETList product metafieldsGETSet collection metafieldsPUTSet product metafieldsPUT
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Commerce

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.

PlatformsShopify
POST
/v1/commerce/discounts

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

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.createCommerceDiscount({  body: {    accountId: 'account_abc123',    title: 'Example',    method: 'code',    type: 'percentage',  },});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?

Get a discount

One discount with its value, targets, minimum, usage and schedule. Needs discounts.read.

Update a discount

Changes a percentage, fixed-amount or free-shipping discount. Buy-X-get-Y and app discounts are read-only here.

accountId*string
title*string
Length1 <= length
method*string

Value in

  • "code"
  • "automatic"
type*string

Value in

  • "percentage"
  • "fixed_amount"
  • "free_shipping"
code?string

Required for method code.

percentage?number

For type percentage, e.g. 15 for 15%.

Range0 < value <= 100
amount?string

For type fixed_amount, a decimal in the store currency.

appliesOnEachItem?boolean

fixed_amount only: take the amount off each item instead of once per order.

minimumSubtotal?|

Minimum order subtotal, a decimal in the store currency.

minimumQuantity?|
Range1 <= value
usageLimit?|

Code discounts only: total uses allowed.

Range1 <= value
oncePerCustomer?boolean

Code discounts only.

startsAt?string

Defaults to now.

Formatdate-time
endsAt?|
Formatdate-time
productIds?array<string>
Itemsitems <= 100
collectionIds?array<string>
Itemsitems <= 100