Pular para o conteúdo

GET /v1/store/preview

GET
/v1/store/preview
curl --request GET \
--url https://seu-endereco-da-api/v1/store/preview \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler a Central de apps (integrations:read).

Media typeapplication/json
object
live
required

Whether the public page would answer right now

boolean
store
required
object
slug
required
string
name
required
string
description
required
string
nullable
primaryColor
required
string
logoUrl
required

Signed url, valid for one hour

string
nullable
coverUrl
required

Signed url, valid for one hour

string
nullable
kind
required
string
Allowed values: food fashion beauty general
labels
required
object
catalog
required
string
prep
required
string
pickup
required
string
status
required

Customer-facing name of each order status

object
key
additional properties
string
alwaysOpen
required

True when the store has no opening hours and takes orders at any time

boolean
acceptedPayments
required
Array<string>
minOrderCents
required
number
averagePrepMinutes
required
number
nullable
averageDeliveryMinutes
required
number
nullable
acceptsPickup
required
boolean
acceptsDelivery
required
boolean
timezone
required
string
hours
required
Array<object>
object
weekday
required

0 is Sunday

number
opensAt
required
string
closesAt
required

Earlier than opensAt means the next day

string
zones
required
Array<object>
object
id
required
string
name
required
string
feeCents
required

Delivery fee in centavos

number
categories
required
Array<object>
object
id
required
string
name
required
string
products
required
Array<object>
object
id
required
string
name
required
string
description
required
string
nullable
priceCents
required

Price in centavos

number
imageUrl
required

Signed url, valid for one hour

string
nullable
categoryId
required
string
nullable
soldOut
required
boolean
optionNames
required

Names of the option groups; empty without variants

Array<string>
variants
required
Array<object>
object
id
required
string
options
required
Array<string>
priceCents
required

Price in centavos

number
available
required
boolean
remaining
required

Units left when only a few remain, otherwise null

number
nullable

Example

{
"store": {
"kind": "food"
}
}