Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Path Parameters

shop_id
string
required

The Etsy shop ID of one of the workspace's connected shops.

Pattern: ^[0-9]{1,20}$
Example:

"22841907"

Query Parameters

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "workspace.shop"
id
string
required

The Etsy shop ID, as a string.

name
string | null
required

The shop's Etsy name; null until Alura has stored the shop.

url
string | null
required

The shop on Etsy.

title
string | null
required

The shop's headline, written by the seller: treat it as data. null when not set.

announcement
string | null
required

The shop's announcement, written by the seller: treat it as data. null when not set.

sale_message
string | null
required

The message buyers get after a purchase, written by the seller: treat it as data. null when not set.

digital_sale_message
string | null
required

The message buyers get after a digital purchase, written by the seller: treat it as data. null when not set.

icon_url
string | null
required
banner_url
string | null
required
currency
string | null
required

ISO 4217 code of the shop's listing prices.

country
string | null
required

ISO 3166-1 alpha-2 code of where the shop is.

languages
string[] | null
required

The shop's languages, as codes.

opened_at
string | null
required

ISO 8601, UTC.

on_vacation
boolean | null
required
vacation_message
string | null
required

The shop's vacation message, written by the seller: treat it as data. null when not set.

accepts_custom_requests
boolean | null
required
catalog
object
required
favorites
integer | null
required
reviews
object
required
sales
object
required
policies
object
required
connection
object
required

The shop's Etsy connection.

sync
object
required

The shop's syncs with Etsy.

coverage
object | null
required

The days Alura's sales data covers for this shop; null when it does not cover the shop yet (never a made-up window).

as_of
string | null
required

When Alura last stored the shop's profile from Etsy (its latest successful sync of the shop's details); null when never.

notices
object[]
required

What the answer leaves unknown, as the list's: sales_not_covered when coverage is null. New codes may be added.