GET /v1/store/preview
GET
/v1/store/preview
const url = 'https://seu-endereco-da-api/v1/store/preview';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://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).
Authorizations
Seção intitulada “Authorizations”Responses
Seção intitulada “Responses”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
primaryColor
required
string
logoUrl
required
Signed url, valid for one hour
string
coverUrl
required
Signed url, valid for one hour
string
kind
required
string
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
averageDeliveryMinutes
required
number
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
priceCents
required
Price in centavos
number
imageUrl
required
Signed url, valid for one hour
string
categoryId
required
string
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
Example
{ "store": { "kind": "food" }}