Documentation IndexFetch the complete documentation index at: /docs/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Required scope: read_promotions (for API-key authentication).
read_promotions
JavaScript
import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const promotion = await client.promotions.get('promo_UkLWZg9DAJ')
{ "id": "promo_UkLWZg9DAJ", "name": "Summer Sale", "description": null, "code": "summer", "starts_at": "2026-06-17T13:37:50.866Z", "expires_at": null, "usage_limit": null, "match_policy": "all", "path": null, "kind": "coupon_code", "multi_codes": false, "number_of_codes": null, "code_prefix": null, "promotion_category_id": null, "metadata": {}, "created_at": "2026-06-17T13:37:50.867Z", "updated_at": "2026-06-17T13:37:50.868Z", "action_ids": [], "rule_ids": [] }
Secret API key for admin access
JWT token for admin user authentication
promotion found
Was this page helpful?
Contact support