Get Promotion

Retrieve a single promotion by ID

Authorization · string · required

Bearer token with marketing:read scope

id · string · required

The promotion ID

Response

Returns the full promotion object.

Request

curl -X GET "https://api.voyantcloud.com/v1/promotions/promo_abc123" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "id": "promo_abc123",
    "workspaceId": "ws_xyz",
    "name": "Summer Sale 2024",
    "description": "20% off all summer departures",
    "type": "percentage",
    "scope": "all_products",
    "value": "20",
    "status": "active",
    "currency": "EUR",
    "validFrom": "2024-06-01T00:00:00Z",
    "validTo": "2024-08-31T23:59:59Z",
    "minOrderValueMinor": null,
    "maxDiscountValueMinor": 50000,
    "maxTotalUses": 1000,
    "currentTotalUses": 150,
    "applicableProductIds": null,
    "applicableCategoryIds": null,
    "applicableCollectionIds": null,
    "excludedProductIds": null,
    "excludedCategoryIds": null,
    "stackable": false,
    "priority": 0,
    "rules": null,
    "metadata": null,
    "createdAt": "2024-05-15T10:30:00Z",
    "updatedAt": "2024-07-20T14:15:00Z"
  }
}

Errors

Status	Error	Description
404	Promotion not found	No promotion exists with the given ID