Skip to main content
GET
/
api
/
v3
/
admin
/
promotions
/
{id}
Show a promotion
const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/admin/promotions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "promo_UkLWZg9DAJ",
  "name": "Summer Sale",
  "description": null,
  "code": "summer",
  "starts_at": "2026-05-24T17:37:43.209Z",
  "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-05-24T17:37:43.209Z",
  "updated_at": "2026-05-24T17:37:43.211Z",
  "store_ids": [
    "store_UkLWZg9DAJ"
  ],
  "action_ids": [],
  "rule_ids": []
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

id
string
required

Response

200 - application/json

promotion found