Skip to content
HeadlessWP Pro

Storefront offers

id: woocommerce-woo-store-offers-list owner: woocommerce method: GET path: /wp-json/headlesswp/v1/store/offers title: Storefront offers usedBySite: true

GET /wp-json/headlesswp/v1/store/offers

Auth + CSRF

  • Auth: public
  • Proxy nonce required: no.
  • CSRF: exempt (HWP nonce policy: never)

Request schema

Query params (all optional):

  • page (number)
  • perPage (number)
  • category (string)
  • search (string)

Note: The site proxy allowlist for this endpoint currently blocks query params, so the marketing site calls this endpoint without query parameters.

Response schema

{
  "data": {
    "offers": [
      {
        "offerId": "string",
        "productId": 123,
        "productSlug": "string",
        "name": "string",
        "description": "string",
        "url": "string",
        "price": {
          "currency": "USD",
          "amount": 0,
          "originalAmount": null,
          "isOnSale": false
        },
        "categories": ["string"],
        "tags": ["string"]
      }
    ],
    "pagination": {
      "page": 1,
      "perPage": 10,
      "total": 100,
      "totalPages": 10
    }
  },
  "meta": {}
}

Notes:

  • price.amount is a number.
  • price.originalAmount is a number or null.

Error codes

  • VALIDATION_FAILED (400)
  • DEPENDENCY_UNAVAILABLE (503)