Skip to content

Offer

Organisation Offer Operations

Operations

Get Offer Details

Request

Security
BearerAuth
Path
idinteger
Example:1
POST
/v3/offers/get/{id}
curl -i -X POST \
  https://propello-cloud.redocly.app/_mock/openapi/v3/offers/get/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
statusinteger
Example:200
timestampstring
Example:"1970-01-30T00:00:00.000000Z"
dataobject
Response
{
  "status": 200,
  "timestamp": "1970-01-30T00:00:00.000000Z",
  "data": {
    "id": 1,
    "partner_id": 1,
    "title": "Offer example - get amount off.",
    "overview": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "terms": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "faq": "<p>FAQ: Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "how_to_redeem": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "offer": "Save amount",
    "redemption_in_store": false,
    "redemption_online": true,
    "redemption_selected_stores": true,
    "image": "https://example.yourperx.com/storage/perx/15/151521222306.jpg",
    "offer_link": "https://example.yourperx.com/perk/1",
    "collections": [ … ]
  }
}
Copyright © Propello Cloud Ltd. 2024