Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The Etsy order (receipt) ID. An order outside the workspace is 404.

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

"3456789012"

Query Parameters

fields
string

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

expand
string

Comma-separated related objects to include: payment, shipping_address, message_from_buyer, message_from_seller, gift_message. Free.

Response

OK

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

The Etsy receipt ID.

shop_id
string
required

The connected shop the order belongs to.

status
string | null
required

Etsy's receipt status, snake_case: paid, completed, open, payment_processing, canceled, fully_refunded, partially_refunded. New values may be added.

paid
boolean | null
required
shipped
boolean | null
required
delivered
boolean | null
required
created_at
string | null
required

ISO 8601, UTC.

buyer
object
required

Who placed the order.

item_count
integer | null
required

Units ordered (the sum of the items' quantities); null when Alura has not stored the items.

grand_total
object | null
required

What the buyer paid in total (totals.grand_total).

as_of
string | null
required

When the shop's orders were last synced from Etsy; null when never.

updated_at
string | null
required

ISO 8601, UTC.

fetched_at
string | null
required

When Alura last fetched this order from Etsy (order webhooks refresh one order at a time); null while Alura records no per-order time (today always).

is_gift
boolean | null
required
payment_method
string | null
required

Etsy's payment method code, for example cc or pp.

totals
object
required

Etsy's receipt totals; a total of 0 (no tax, no discount) is a real 0.

items
object[]
required
shipments
object[]
required
refunds
object[]
required
items_omitted
integer
required

How many of the order's items items leaves out: 0 over REST (every item); over MCP, the items past the first 25 (GET /v1/workspace/orders/{id} has them all).

Required range: x >= 0
shipping_address
object | null

Null with shipping_address_error when there is none. Always present over REST; over MCP only with expand=shipping_address.

shipping_address_error
enum<string> | null

Why shipping_address is null: etsy_restricted (Etsy withholds the address in Preferred Partner regions), no_physical_items (only digital items), not_fetched (Alura has not stored the items); null with an address. Always present over REST; over MCP only with expand=shipping_address.

Available options:
etsy_restricted,
no_physical_items,
not_fetched
gift_message
string | null

The buyer's gift note. Always present over REST; over MCP only with expand=gift_message.

message_from_buyer
string | null

The buyer's note to the seller. Always present over REST; over MCP only with expand=message_from_buyer.

message_from_seller
string | null

The seller's note to the buyer. Always present over REST; over MCP only with expand=message_from_seller.

payment
object | null

With expand=payment: Etsy's payment for the order. null with payment_error when Alura has not stored it or cannot tell its currency, never zeros.

payment_error
enum<string> | null

With expand=payment, why payment is null: not_fetched (Alura has not stored the payment), currency_unknown (the payment's or the order's currency is not stored), currency_unverified (the payment's currency differs from the order's, so its amounts' currency is not certain), amount_unreadable (no amount of it can be read). null when payment is present.

Available options:
not_fetched,
currency_unknown,
currency_unverified,
amount_unreadable