Skip to main content
POST
/
api
/
v1
/
shopping
/
sessions
Create Shopping Session
curl --request POST \
  --url https://api.example.com/api/v1/shopping/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget_limit_cents": 500050
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "merchant_type": "<string>",
  "merchant_domain": "<string>",
  "cart_items": [],
  "budget_limit_cents": 123,
  "total_cents": 123,
  "currency": "USD",
  "affiliate_links": [],
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
budget_limit_cents
integer | null

Max spend in cents USD. Defaults to server config.

Required range: 100 <= x <= 1000000

Response

Successful Response

​
id
string<uuid>
required
​
user_id
string<uuid>
required
​
status
string
required
​
created_at
string<date-time>
required
​
merchant_type
string | null
​
merchant_domain
string | null
​
cart_items
Cart Items · object[]
​
budget_limit_cents
integer | null
​
total_cents
integer | null
​
currency
string
default:USD
​
affiliate_links
Affiliate Links · object[]
​
completed_at
string<date-time> | null