- Introduction
- Core
- Privacy Policy
- Community
- Loyalty Clubs
- Applications
- Branding
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- SMS Sender Identities
- Member Authentication Configuration
- Sender Identities
- Oauth2
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Oauth2
- Members Copy
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Stores
- Offers
- Introduction
- Offers
- Collections
- Image Templates
- Files
- Rewards
- Triggerer
- CMS
- Introduction
- Venue Info
- Pages
- Website
- Landing Pages
- Articles
- Events
- Job Postings
- Press Releases
- Tags
- Attachments
- Service Messages
- Mixed Content
- Redirections
- Events
- Games
- Scraper
- Files
- Receipts
- Messaging History
List Offers
Pending
GET
https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/offers
API Permit:Offers:Api:Offers:List
API Context:Loyalty Club
Authorizations:UserToken
Query Parameters#
| Parameter | Type | Default | Description |
|---|---|---|---|
| scope | enum | standard | When present, only offers from given scope will be returned |
| types | string[] | null | When present, only offers of given types will be returned |
| per_page | integer | 100 | Number of results to be returned per request (100 is the maximum) |
| page_no | integer | 1 | Number of results page |
| sort_by | string | "name" | What attribute should results be sorted by? Supported attributes are: ["name", "usable_since", "usable_until", "visible_since", "visible_until", "created_at", "updated_at", "archived_at"] |
| sort_direction | string | "asc" | Direction of sorting: "asc" or "desc" |
| collection_ids | integer[] | null | When present, only offers belonging to at least one of given collections will be returned |
| store_ids | integer[] | null | When present, only offers belonging to at at least one of given store_id will be returned |
| status | enum | null | When present, only offers with this status will be returned. See: statuses |
| campaign_id | integer | null | When present, only offers with this campaign_id will be returned |
| audience_id | integer | null | When present, only offers with this audience_id will be returned |
| search | string | null | When present, only offers that match the query string will be returned |
| extras | object | null | When present, only offers that match given values will be returned. See: below |
| ids | integer[] | null | When present, only offers having one of provided IDs will be returned |
| without_collection | boolean | false | When present, only offers without collections will be returned |
| without_audience_id | boolean | false | When present, only offers without audiences will be returned |
| without_campaign_id | boolean | false | When present, only offers without campaigns will be returned |
| without_store | boolean | false | When present, only offers without store will be returned |
| with_archived | boolean | false | When present, also archived offers will be returned |
| only_archived | boolean | false | When present, only archived offers will be returned |
| visible_since_after | datetime | null | When present, only offers with greater visible_since will be returned |
| visible_since_before | datetime | null | When present, only offers with lesser visible_since will be returned |
| visible_until_after | datetime | null | When present, only offers with greater visible_until will be returned |
| visible_until_before | datetime | null | When present, only offers with lesser visible_until will be returned |
| usable_since_after | datetime | null | When present, only offers with greater usable_since will be returned |
| usable_since_before | datetime | null | When present, only offers with lesser usable_since will be returned |
| usable_until_before | datetime | null | When present, only offers with lesser usable_until will be returned |
Filtering by extras#
extra attribute(s).?extras[<attribute>]=(!)<value>?extras[category]=Foodextras["category"].toString() = 'Food'.?extras[category_id]=!3&extras[type]=externalextras["category_id"].toString() != '3' && extras["type"].toString() == 'external'.Response Body#
| Key | Type | Optional? | Description |
|---|---|---|---|
| offers | Offer[] | no (may be empty) | See Offer model |
| pagination_info | PaginationInfo | no | See Pagination info model |
Example#
Pagination Info
{
"offers": [
{
// (...) - see Offer model
}
],
"pagination_info": {
// (...) - see Pagination info model
}
}Request
Path Params
Query Params
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.mpc.dev.placewise.com/v3/infinity-mall/offers?publication_status=published&excluded_publication_status=expired&cms_tag_ids[]=7&cms_tag_ids[]=10' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: 'Responses
🟢200Success
application/json
Body
Example
{
"offers": [
{
"type": "exclusive",
"status": "published",
"name": {
"en": "Text"
},
"description": null,
"internal_name": null,
"notes": null,
"usable_since": null,
"usable_until": null,
"visible_since": "2024-05-01T10:00:00.0Z",
"visible_until": "2024-05-31T10:00:00.0Z",
"collection_ids": [],
"images": [],
"url": "promotions/1019680",
"store_ids": [
1027509,
36
],
"store_id": 1027509,
"stores": [
"Espresso House",
"Gift shop"
],
"audience_id": 263059,
"campaign_id": null,
"external_url": null,
"maximum_uses_per_user": 1,
"maximum_grants_per_user": 1,
"periodic_usage": null,
"stock": 10,
"usage_authorization_token": null,
"usage_authorization_token_required": false,
"external_master": null,
"image_template": null,
"display_schemas": {
"list": {
"header": {
"type": "reference",
"value": "name"
},
"body": {
"type": "reference",
"value": "description"
},
"caption": {
"type": "reference",
"value": "stores"
}
},
"details": {
"header": {
"type": "reference",
"value": "name"
},
"body": {
"type": "reference",
"value": "description"
},
"caption": {
"type": "reference",
"value": "stores"
}
}
},
"read_more": null,
"activation_texts": null,
"extras": {},
"files": [
null
],
"archived_at": null,
"uses_count": 0,
"grants_count": 0,
"publication_status": "expired",
"cms_tag_ids": [],
"authorization_code_displayed": true
},
{
"type": "parking",
"status": "published",
"name": {
"en": "Text"
},
"description": null,
"internal_name": null,
"notes": null,
"usable_since": null,
"usable_until": null,
"visible_since": "2024-05-01T10:00:00.0Z",
"visible_until": "2024-05-31T10:00:00.0Z",
"collection_ids": [],
"images": [],
"url": "promotions/1019680",
"store_ids": [
1027509,
36
],
"store_id": 1027509,
"stores": [
"Espresso House",
"Gift shop"
],
"audience_id": 263059,
"campaign_id": null,
"external_url": null,
"maximum_uses_per_user": 1,
"maximum_grants_per_user": 1,
"periodic_usage": null,
"stock": 10,
"usage_authorization_token": null,
"usage_authorization_token_required": false,
"external_master": null,
"image_template": null,
"display_schemas": {
"list": {
"header": {
"type": "reference",
"value": "name"
},
"body": {
"type": "reference",
"value": "description"
},
"caption": {
"type": "reference",
"value": "stores"
}
},
"details": {
"header": {
"type": "reference",
"value": "name"
},
"body": {
"type": "reference",
"value": "description"
},
"caption": {
"type": "reference",
"value": "stores"
}
}
},
"read_more": null,
"activation_texts": null,
"extras": {},
"files": [
{
"identifier": "1",
"created_at": "2022-11-09T15:46:00.252860Z",
"image_details": {
"width": 64560054,
"height": 48057366
}
},
null
],
"archived_at": null,
"uses_count": 0,
"grants_count": 0,
"publication_status": "expired",
"cms_tag_ids": [],
"authorization_code_displayed": false
},
{
"type": "birthday",
"status": "published",
"name": {
"en": "Text"
},
"description": null,
"internal_name": null,
"notes": null,
"usable_since": null,
"usable_until": null,
"visible_since": "2024-05-01T10:00:00.0Z",
"visible_until": "2024-05-31T10:00:00.0Z",
"collection_ids": [],
"images": [],
"url": "promotions/1019680",
"store_ids": [
1027509,
36
],
"store_id": 1027509,
"stores": [
"Espresso House",
"Gift shop"
],
"audience_id": 263059,
"campaign_id": null,
"external_url": null,
"maximum_uses_per_user": 1,
"maximum_grants_per_user": 1,
"periodic_usage": null,
"stock": 10,
"usage_authorization_token": null,
"usage_authorization_token_required": false,
"external_master": null,
"image_template": null,
"display_schemas": {
"list": {
"header": {
"type": "reference",
"value": "name"
},
"body": {
"type": "reference",
"value": "description"
},
"caption": {
"type": "reference",
"value": "stores"
}
},
"details": {
"header": {
"type": "reference",
"value": "name"
},
"body": {
"type": "reference",
"value": "description"
},
"caption": {
"type": "reference",
"value": "stores"
}
}
},
"read_more": null,
"activation_texts": null,
"extras": {},
"files": [
{
"identifier": "1",
"created_at": "2022-11-09T15:46:00.252860Z",
"image_details": null
}
],
"archived_at": null,
"uses_count": 0,
"grants_count": 0,
"publication_status": "expired",
"cms_tag_ids": [],
"authorization_code_displayed": false
}
]
}