Promotions
Return a Promotion
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Promotions
Return a Promotion
Returns a Promotion
GET
/
api
/
v2
/
platform
/
promotions
/
{id}
curl --request GET \
--url http://{defaultHost}/api/v2/platform/promotions/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "44",
"type": "promotion",
"attributes": {
"description": null,
"expires_at": null,
"starts_at": null,
"name": "Promo",
"type": null,
"usage_limit": null,
"match_policy": "all",
"code": null,
"advertise": false,
"path": null,
"created_at": "2022-11-08T19:35:03.971Z",
"updated_at": "2022-11-08T19:35:03.973Z",
"public_metadata": {},
"private_metadata": {}
},
"relationships": {
"promotion_category": {
"data": {
"id": "17",
"type": "promotion_category"
}
},
"promotion_rules": {
"data": [
{
"id": "16",
"type": "promotion_rule"
}
]
},
"promotion_actions": {
"data": [
{
"id": "31",
"type": "promotion_action"
}
]
},
"stores": {
"data": [
{
"id": "387",
"type": "store"
}
]
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/promotions/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "44",
"type": "promotion",
"attributes": {
"description": null,
"expires_at": null,
"starts_at": null,
"name": "Promo",
"type": null,
"usage_limit": null,
"match_policy": "all",
"code": null,
"advertise": false,
"path": null,
"created_at": "2022-11-08T19:35:03.971Z",
"updated_at": "2022-11-08T19:35:03.973Z",
"public_metadata": {},
"private_metadata": {}
},
"relationships": {
"promotion_category": {
"data": {
"id": "17",
"type": "promotion_category"
}
},
"promotion_rules": {
"data": [
{
"id": "16",
"type": "promotion_rule"
}
]
},
"promotion_actions": {
"data": [
{
"id": "31",
"type": "promotion_action"
}
]
},
"stores": {
"data": [
{
"id": "387",
"type": "store"
}
]
}
}
}
}