curl "https://api.alura.io/v1/workspace/orders/3456789012" \
-H "Authorization: Bearer $ALURA_API_KEY"const res = await fetch('https://api.alura.io/v1/workspace/orders/3456789012', {
headers: {
Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
},
});
console.log(await res.json());import json
import os
import urllib.request
request = urllib.request.Request(
"https://api.alura.io/v1/workspace/orders/3456789012",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "workspace.order",
"id": "3456789012",
"shop_id": "22841907",
"status": "completed",
"paid": true,
"shipped": true,
"delivered": true,
"created_at": "2026-10-02T14:20:00.000Z",
"buyer": {
"id": "12345",
"name": "Jane Doe"
},
"item_count": 2,
"grand_total": {
"amount": "44.46",
"currency": "USD",
"usd": "44.46"
},
"as_of": "2026-10-08T06:00:00.000Z",
"updated_at": "2026-10-06T09:00:00.000Z",
"fetched_at": null,
"shipping_address": {
"name": "Jane Doe",
"line1": "1 Example Street",
"line2": null,
"city": "Springfield",
"state": "IL",
"zip": "62701",
"country": "US",
"formatted": "Jane Doe\n1 Example Street\nSpringfield, IL 62701\nUnited States"
},
"shipping_address_error": null,
"is_gift": true,
"gift_message": "Happy birthday, Sam!",
"message_from_buyer": "Please write \"Sam\" on the mug.",
"message_from_seller": null,
"payment_method": "cc",
"totals": {
"subtotal": {
"amount": "37.00",
"currency": "USD",
"usd": "37.00"
},
"shipping": {
"amount": "4.50",
"currency": "USD",
"usd": "4.50"
},
"tax": {
"amount": "2.96",
"currency": "USD",
"usd": "2.96"
},
"vat": {
"amount": "0.00",
"currency": "USD",
"usd": "0.00"
},
"discount": {
"amount": "0.00",
"currency": "USD",
"usd": "0.00"
},
"gift_wrap": {
"amount": "0.00",
"currency": "USD",
"usd": "0.00"
},
"grand_total": {
"amount": "44.46",
"currency": "USD",
"usd": "44.46"
}
},
"items": [
{
"id": "41001",
"listing_id": "1834720561",
"title": "Personalized name mug, custom coffee mug with name, 11oz ceramic gift",
"quantity": 2,
"sku": "MUG-11-WHITE",
"price": {
"amount": "18.50",
"currency": "USD",
"usd": "18.50"
},
"shipping_cost": {
"amount": "4.50",
"currency": "USD",
"usd": "4.50"
},
"variations": null,
"is_digital": false,
"image_url": "https://i.etsystatic.com/22841907/r/il/a1b2c3/5001/il_570xN.5001_mug1.jpg",
"paid_at": "2026-10-02T14:21:00.000Z",
"shipped_at": "2026-10-04T10:00:00.000Z"
}
],
"shipments": [
{
"carrier": "usps",
"tracking_code": "EZ1000000001US",
"notified_at": "2026-10-04T10:00:00.000Z"
}
],
"refunds": [],
"items_omitted": 0
}{
"type": "https://docs.alura.io/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Invalid request",
"suggestion": "Fix the request as the detail says, then send it again.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_exhausted",
"title": "API credits exhausted",
"status": 402,
"code": "credits_exhausted",
"detail": "API credits exhausted",
"suggestion": "Upgrade the plan or wait for the monthly reset.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/plan_required",
"title": "Plan required",
"status": 403,
"code": "plan_required",
"detail": "Plan required",
"suggestion": "Upgrade the workspace plan to use this operation.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Not found",
"suggestion": "Check the ID, or search for it first.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/rate_limited",
"title": "Rate limited",
"status": 429,
"code": "rate_limited",
"detail": "Rate limited",
"suggestion": "Wait for Retry-After, then retry.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/internal_error",
"title": "Internal error",
"status": 500,
"code": "internal_error",
"detail": "Internal error",
"suggestion": "Retry; if it keeps failing, report the request_id.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_unavailable",
"title": "API credits unavailable",
"status": 503,
"code": "credits_unavailable",
"detail": "API credits unavailable",
"suggestion": "Retry shortly.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}Get an order
One order (Etsy receipt) of your connected Etsy shops by its order ID: status, totals, the buyer’s name, the shipping address, the buyer’s and the seller’s messages, the gift message, every item (with the listing image), the shipments and the refunds, as Alura last stored them from Etsy. An address Etsy withholds (Preferred Partner regions) is null with shipping_address_error: etsy_restricted, and an order of only digital items has none (no_physical_items). expand=payment adds Etsy’s payment: gross, fees and net (null with payment_error: not_fetched when Alura has not stored it). The other expand= values are for MCP clients, which get messages and the address only when they ask; over REST these are always included. Holds buyer personal data, as Etsy provides it. An order outside the workspace is 404. Needs the orders:read scope and the Customer analytics workspace permission. Costs 1 API credit per call, expansions included.
Cost: 1 API credit per call.
curl "https://api.alura.io/v1/workspace/orders/3456789012" \
-H "Authorization: Bearer $ALURA_API_KEY"const res = await fetch('https://api.alura.io/v1/workspace/orders/3456789012', {
headers: {
Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
},
});
console.log(await res.json());import json
import os
import urllib.request
request = urllib.request.Request(
"https://api.alura.io/v1/workspace/orders/3456789012",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "workspace.order",
"id": "3456789012",
"shop_id": "22841907",
"status": "completed",
"paid": true,
"shipped": true,
"delivered": true,
"created_at": "2026-10-02T14:20:00.000Z",
"buyer": {
"id": "12345",
"name": "Jane Doe"
},
"item_count": 2,
"grand_total": {
"amount": "44.46",
"currency": "USD",
"usd": "44.46"
},
"as_of": "2026-10-08T06:00:00.000Z",
"updated_at": "2026-10-06T09:00:00.000Z",
"fetched_at": null,
"shipping_address": {
"name": "Jane Doe",
"line1": "1 Example Street",
"line2": null,
"city": "Springfield",
"state": "IL",
"zip": "62701",
"country": "US",
"formatted": "Jane Doe\n1 Example Street\nSpringfield, IL 62701\nUnited States"
},
"shipping_address_error": null,
"is_gift": true,
"gift_message": "Happy birthday, Sam!",
"message_from_buyer": "Please write \"Sam\" on the mug.",
"message_from_seller": null,
"payment_method": "cc",
"totals": {
"subtotal": {
"amount": "37.00",
"currency": "USD",
"usd": "37.00"
},
"shipping": {
"amount": "4.50",
"currency": "USD",
"usd": "4.50"
},
"tax": {
"amount": "2.96",
"currency": "USD",
"usd": "2.96"
},
"vat": {
"amount": "0.00",
"currency": "USD",
"usd": "0.00"
},
"discount": {
"amount": "0.00",
"currency": "USD",
"usd": "0.00"
},
"gift_wrap": {
"amount": "0.00",
"currency": "USD",
"usd": "0.00"
},
"grand_total": {
"amount": "44.46",
"currency": "USD",
"usd": "44.46"
}
},
"items": [
{
"id": "41001",
"listing_id": "1834720561",
"title": "Personalized name mug, custom coffee mug with name, 11oz ceramic gift",
"quantity": 2,
"sku": "MUG-11-WHITE",
"price": {
"amount": "18.50",
"currency": "USD",
"usd": "18.50"
},
"shipping_cost": {
"amount": "4.50",
"currency": "USD",
"usd": "4.50"
},
"variations": null,
"is_digital": false,
"image_url": "https://i.etsystatic.com/22841907/r/il/a1b2c3/5001/il_570xN.5001_mug1.jpg",
"paid_at": "2026-10-02T14:21:00.000Z",
"shipped_at": "2026-10-04T10:00:00.000Z"
}
],
"shipments": [
{
"carrier": "usps",
"tracking_code": "EZ1000000001US",
"notified_at": "2026-10-04T10:00:00.000Z"
}
],
"refunds": [],
"items_omitted": 0
}{
"type": "https://docs.alura.io/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Invalid request",
"suggestion": "Fix the request as the detail says, then send it again.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_exhausted",
"title": "API credits exhausted",
"status": 402,
"code": "credits_exhausted",
"detail": "API credits exhausted",
"suggestion": "Upgrade the plan or wait for the monthly reset.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/plan_required",
"title": "Plan required",
"status": 403,
"code": "plan_required",
"detail": "Plan required",
"suggestion": "Upgrade the workspace plan to use this operation.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Not found",
"suggestion": "Check the ID, or search for it first.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/rate_limited",
"title": "Rate limited",
"status": 429,
"code": "rate_limited",
"detail": "Rate limited",
"suggestion": "Wait for Retry-After, then retry.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/internal_error",
"title": "Internal error",
"status": 500,
"code": "internal_error",
"detail": "Internal error",
"suggestion": "Retry; if it keeps failing, report the request_id.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_unavailable",
"title": "API credits unavailable",
"status": 503,
"code": "credits_unavailable",
"detail": "API credits unavailable",
"suggestion": "Retry shortly.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}Authorizations
An API key: Authorization: Bearer alura_sk_....
Path Parameters
The Etsy order (receipt) ID. An order outside the workspace is 404.
^[0-9]{1,20}$"3456789012"
Query Parameters
Comma-separated dotted paths to return; id, object and as_of always come back.
Comma-separated related objects to include: payment, shipping_address, message_from_buyer, message_from_seller, gift_message. Free.
Response
OK
"workspace.order"The Etsy receipt ID.
The connected shop the order belongs to.
Etsy's receipt status, snake_case: paid, completed, open, payment_processing, canceled, fully_refunded, partially_refunded. New values may be added.
ISO 8601, UTC.
Who placed the order.
Show child attributes
Show child attributes
Units ordered (the sum of the items' quantities); null when Alura has not stored the items.
What the buyer paid in total (totals.grand_total).
Show child attributes
Show child attributes
When the shop's orders were last synced from Etsy; null when never.
ISO 8601, UTC.
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).
Etsy's payment method code, for example cc or pp.
Etsy's receipt totals; a total of 0 (no tax, no discount) is a real 0.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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).
x >= 0Null with shipping_address_error when there is none. Always present over REST; over MCP only with expand=shipping_address.
Show child attributes
Show child attributes
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.
etsy_restricted, no_physical_items, not_fetched The buyer's gift note. Always present over REST; over MCP only with expand=gift_message.
The buyer's note to the seller. Always present over REST; over MCP only with expand=message_from_buyer.
The seller's note to the buyer. Always present over REST; over MCP only with expand=message_from_seller.
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.
Show child attributes
Show child attributes
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.
not_fetched, currency_unknown, currency_unverified, amount_unreadable