Get the catalog

GET

/v1/conversations/{id}/catalog

const url = 'https://app.mondochat.io/v1/conversations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/catalog';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.mondochat.io/v1/conversations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/catalog \
  --header 'Authorization: Bearer <token>'

Returns the items the caller can buy in the conversation. It needs commerce.enabled and the buy policy flag toward the seller; guests cannot buy unless the policy row for their role allows buy. Items come from your catalog callout while commerce.catalog_source is webhook, and from the dashboard catalog (the seller’s items or app-wide ones) while it is dashboard. balance appears while commerce.show_balance is on and your callout returned one. Takes a session token. See https://docs.mondochat.io/guides/commerce/.

Authorizations

session

Parameters

Path Parameters

required

string format: uuid

Responses

200

Successful Response

application/json

Catalog

The items a buyer can purchase in a conversation.

object

balance

Any of:

Balance
null

Balance

The buyer’s balance with you.

object

amount_minor

required

Amount Minor

The balance in minor units.

integer

currency

required

Currency

ISO 4217 currency of the balance.

string

/^[A-Z]{3}$/

label

Any of:

string
null

string

items

required

Items

The purchasable items.

Array<object>

CatalogItem

Something a buyer can purchase from a seller.

object

currency

required

Currency

ISO 4217 currency of the price.

string

/^[A-Z]{3}$/

description

Any of:

string
null

string

<= 2000 characters

required

The item’s id on your side.

string

>= 1 characters <= 128 characters

image_url

Any of:

string
null

string

<= 2048 characters /^https://\S+$/

kind

required

Kind

The item’s kind, for example show or video.

string

>= 1 characters <= 64 characters

price_minor

required

Price Minor

The price in minor units, 1500 for 15.00.

integer

title

required

Title

The item’s name.

string

>= 1 characters <= 200 characters

Example

{
  "balance": {
    "amount_minor": 2500,
    "currency": "EUR",
    "label": "Credits"
  },
  "items": [
    {
      "currency": "EUR",
      "description": "20 minutes",
      "id": "private-show",
      "kind": "show",
      "price_minor": 1500,
      "title": "Private show"
    }
  ]
}

4XX

Problem

application/problem+json

An RFC 9457 problem: the body of every error answer.

object

code

required

The stable error code to branch on, such as policy_denied.

string

detail

What went wrong this time, when there is more to say.

string | null

errors

For validation, one entry per invalid field.

Array<object>

One invalid field.

object

loc

The path to the field.

array

msg

What is wrong with it.

string

instance

The path of the request.

string

reason

For policy_denied and limit_reached, the rule or limit that refused the request; for forbidden, a short cause such as you_blocked; for banned, temporary when the ban expires.

string

status

required

The HTTP status code.

integer

title

required

A short summary of the problem.

string

type

required

A URL that names the problem, https://app.mondochat.io/problems/<code>.

string

Example

{
  "code": "policy_denied",
  "detail": null,
  "instance": "/v1/conversations/0199d6a0-2000-7000-8000-000000000001",
  "reason": "pins",
  "status": 403,
  "title": "Policy denied",
  "type": "https://app.mondochat.io/problems/policy_denied"
}