Skip to main content
GET
Get a shop widget

Authorizations

Authorization
string
header
required

A Sorraia API key created in the dashboard (Settings → API keys). Pass it as Authorization: Bearer sor_live_....

Path Parameters

id
integer
required

The resource id.

Response

The shop widget.

id
integer
required
name
string
required
type
enum<string>
required
Available options:
one_time,
subscription,
donation
productName
string
required
currency
string
required
fulfilmentType
enum<string>
required
Available options:
digital,
service,
physical
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
priceCents
integer | null
imageUrl
string<uri> | null
domain
object | null

The registered domain a resource is bound to.

orderCount
integer

Present on list responses.

imageUrls
string<uri>[]

Present on the detail view.

interval
string | null

Subscription billing interval. Present on the detail view.

trialDays
integer | null

Present on the detail view.