Return a list of Promotion Rules - Spree Commerce documentation

Community

Github

API basics

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
- GET
  Return a list of Promotion Rules
- POST
  Create a Promotion Rule
- GET
  Return a Promotion Rule
- DEL
  Delete a Promotion Rule
- PATCH
  Update a Promotion Rule
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

GET

api

platform

promotion_rules

curl --request GET \
  --url http://{defaultHost}/api/v2/platform/promotion_rules \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "1",
      "type": "promotion_rule",
      "attributes": {
        "type": null,
        "created_at": "2022-11-08T19:35:00.589Z",
        "updated_at": "2022-11-08T19:35:00.589Z",
        "code": null,
        "preferences": {}
      },
      "relationships": {
        "promotion": {
          "data": {
            "id": "14",
            "type": "promotion"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "promotion_rule",
      "attributes": {
        "type": null,
        "created_at": "2022-11-08T19:35:00.591Z",
        "updated_at": "2022-11-08T19:35:00.591Z",
        "code": null,
        "preferences": {}
      },
      "relationships": {
        "promotion": {
          "data": {
            "id": "14",
            "type": "promotion"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/promotion_rules?page=1&per_page=&include=&filter[type_eq]=",
    "next": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

per_page

integer

include

string

Select which associated resources you would like to fetch, see:

https://jsonapi.org/format/#fetching-includes

filter[type_eq]

string

Response

200

application/vnd.api+json

Records returned

data

object[]

required

meta

object

required

links

object

required

Was this page helpful?

Suggest edits Raise issue

Update a Promotion Category Create a Promotion Rule

curl --request GET \
  --url http://{defaultHost}/api/v2/platform/promotion_rules \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "1",
      "type": "promotion_rule",
      "attributes": {
        "type": null,
        "created_at": "2022-11-08T19:35:00.589Z",
        "updated_at": "2022-11-08T19:35:00.589Z",
        "code": null,
        "preferences": {}
      },
      "relationships": {
        "promotion": {
          "data": {
            "id": "14",
            "type": "promotion"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "promotion_rule",
      "attributes": {
        "type": null,
        "created_at": "2022-11-08T19:35:00.591Z",
        "updated_at": "2022-11-08T19:35:00.591Z",
        "code": null,
        "preferences": {}
      },
      "relationships": {
        "promotion": {
          "data": {
            "id": "14",
            "type": "promotion"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/promotion_rules?page=1&per_page=&include=&filter[type_eq]=",
    "next": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/promotion_rules?filter%5Btype_eq%5D=&include=&page=1&per_page="
  }
}