Skip to main content
GET
/
catalog
/
offers
/
{id}
cURL
curl --request GET \
  --url http://sandbox.mintlify.com/catalog/offers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "872981cb-d498-44de-967e-e7a170e0b416",
  "name": "Landing Page",
  "description": "Premium mobile plan",
  "salesChannel": {
    "id": "872981cb-d498-44de-967e-e7a170e0b416",
    "name": "Landing Page",
    "metadata": {},
    "createdAt": "2024-05-19T13:58:03.418Z",
    "updatedAt": "2024-05-20T10:12:45.123Z",
    "externalCode": "700031450"
  },
  "product": {
    "id": "872981cb-d498-44de-967e-e7a170e0b416",
    "name": "Premium",
    "description": "Premium mobile plan",
    "metadata": {},
    "createdAt": "2024-05-19T13:58:03.418Z",
    "updatedAt": "2024-05-20T10:12:45.123Z",
    "externalCode": "700031450"
  },
  "ctaLink": "https://shop.foo.bar/purchase",
  "bannerUrl": "https://cdn.foo.bar/banner",
  "features": [
    "Unlimited voice",
    "10GB"
  ],
  "pricing": {
    "model": "STANDARD",
    "properties": {
      "price": "100",
      "currency": "$",
      "recurrence": "MONTHLY"
    }
  },
  "metadata": {},
  "createdAt": "2024-05-19T13:58:03.418Z",
  "updatedAt": "2024-05-20T10:12:45.123Z",
  "externalCode": "700031450"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Id of offer - Unique identifier for the object

Response

Offer response

​
id
string<uuid>
Example:

"872981cb-d498-44de-967e-e7a170e0b416"

​
name
string
Example:

"Landing Page"

​
description
string
Example:

"Premium mobile plan"

​
salesChannel
object
​
product
object
​
ctaLink
string | null
Example:

"https://shop.foo.bar/purchase"

​
bannerUrl
string | null
Example:

"https://cdn.foo.bar/banner"

​
features
string[]
Example:
["Unlimited voice", "10GB"]
​
pricing
object
Example:
{
  "model": "STANDARD",
  "properties": {
    "price": "100",
    "currency": "$",
    "recurrence": "MONTHLY"
  }
}
​
metadata
object
Example:
{}
​
createdAt
string<date-time>
Example:

"2024-05-19T13:58:03.418Z"

​
updatedAt
string<date-time>
Example:

"2024-05-20T10:12:45.123Z"

​
externalCode
string | null
Example:

"700031450"