Commerce · Commerce

Get a discount

Fetches a discount. Works with Shopify and WooCommerce accounts.

GEThttps://api.pozy.ai/v1/commerce/discounts/{discountId}

Shopify and WooCommercegetCommerceDiscount

Guides: Commerce & blogs, Products and catalog

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the commerce resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`discountId`required	string

Query parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/commerce/discounts/6ebbd22404a5ebbadf66d175?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/commerce/discounts/6ebbd22404a5ebbadf66d175?accountId=696e0b682d0a31188e7a2ba9", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/commerce/discounts/6ebbd22404a5ebbadf66d175",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

discountobject
20 child fields
- idstring
- accountIdstring
- platformstring
  One of shopify.
- titlestring
- methodstring
  One of code, automatic.
- typestring
  One of percentage, fixed_amount, free_shipping, buy_x_get_y, app.
- codesarray of string
- codeCountinteger
  Can be null.
- valueobject
  One of:
  Option 1 (2 fields)
  typestring
  One of percentage.
  percentagenumber
  Option 2 (3 fields)
  typestring
  One of fixed_amount.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
  appliesOnEachItemboolean
- appliesToobject
  Can be null.
  4 child fields
  typestring
  One of all, products, collections.
  productIdsarray of string
  variantIdsarray of string
  collectionIdsarray of string
- minimumobject
  Can be null.
  3 child fields
  typestring
  One of subtotal, quantity.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
  quantityinteger
- usageLimitinteger
  Can be null.
- oncePerCustomerboolean
- usageCountinteger
- startsAtstring (date-time)
- endsAtstring (date-time)
  Can be null.
- statusstring
  One of active, scheduled, expired.
- platformStatusstring
- summarystring
- platformDataobject
  Can be null.

200 response

{
  "discount": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "title": "Launch day",
    "method": "code",
    "type": "percentage",
    "codes": [
      "string"
    ],
    "codeCount": 42,
    "value": {
      "type": "percentage",
      "percentage": 12.5
    },
    "appliesTo": {
      "type": "all",
      "productIds": [
        "string"
      ],
      "variantIds": [
        "string"
      ],
      "collectionIds": [
        "string"
      ]
    },
    "minimum": {
      "type": "subtotal",
      "amount": {
        "amount": "string",
        "currency": "USD"
      },
      "quantity": 1
    },
    "usageLimit": 1,
    "oncePerCustomer": true,
    "usageCount": 42,
    "startsAt": "2026-10-02T09:00:00.000Z",
    "endsAt": "2026-10-02T09:00:00.000Z",
    "status": "active",
    "platformStatus": "instagram",
    "summary": "string",
    "platformData": {}
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Commerce

GETGet a store GETList orders GETGet an order GETList products POSTCreate a product POSTActivate, deactivate, archive or delete products GETGet a product PATCHUpdate a product POSTUpdate variant prices GETList collections POSTCreate a collection GETGet a collection PATCHUpdate a collection DELDelete a collection POSTAdd or remove products in a collection POSTAdd variants DELDelete variants POSTAdd options DELDelete options POSTAdd images DELRemove images POSTReorder images POSTDuplicate a product GETList product metafields PUTSet product metafields DELDelete product metafields POSTPublish or unpublish a product GETList collection metafields PUTSet collection metafields DELDelete collection metafields POSTPublish or unpublish a collection POSTAdd or remove tags in bulk POSTReorder products in a collection GETList pages POSTCreate a page GETGet a page PATCHUpdate a page DELDelete a page GETList locations GETGet a product's stock POSTSet or adjust stock GETList sales channels GETList discounts POSTCreate a discount PATCHUpdate a discount DELDelete a discount POSTActivate or deactivate a discount POSTAdd codes to a discount GETList URL redirects POSTCreate a URL redirect PATCHUpdate a URL redirect DELDelete a URL redirect GETList navigation menus POSTCreate a navigation menu GETGet a navigation menu PUTReplace a navigation menu DELDelete a navigation menu GETList metaobject definitions GETList metaobjects of a type POSTCreate a metaobject GETGet a metaobject PATCHUpdate a metaobject DELDelete a metaobject GETList markets GETList price lists PUTSet fixed prices DELRemove fixed prices PUTRecord a marketing activity DELDelete a marketing activity POSTReport daily engagement GETList catalog syncs POSTSync a store into a Meta catalog GETGet a catalog sync DELStop a catalog sync POSTRun a catalog sync now