curl "https://api.alura.io/v1/workspace/shipping-profiles/32001" \
-H "Authorization: Bearer $ALURA_API_KEY"const res = await fetch('https://api.alura.io/v1/workspace/shipping-profiles/32001', {
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/shipping-profiles/32001",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "workspace.shipping_profile",
"id": "32001",
"shop_id": "22841907",
"title": "Standard mugs",
"origin_country": "US",
"processing": {
"min_days": 1,
"max_days": 3,
"label": "1-3 business days"
},
"destinations": [
{
"object": "workspace.shipping_destination",
"id": "33001",
"shipping_profile_id": "32001",
"shop_id": "22841907",
"origin_country": "US",
"destination_country": "US",
"destination_region": "none",
"primary_cost": {
"amount": "0.00",
"currency": "USD"
},
"secondary_cost": {
"amount": "0.00",
"currency": "USD"
},
"shipping_carrier_id": null,
"mail_class": null,
"min_delivery_days": 3,
"max_delivery_days": 5,
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z"
},
{
"object": "workspace.shipping_destination",
"id": "33002",
"shipping_profile_id": "32001",
"shop_id": "22841907",
"origin_country": "US",
"destination_country": null,
"destination_region": "non_eu",
"primary_cost": {
"amount": "14.50",
"currency": "USD"
},
"secondary_cost": {
"amount": "4.00",
"currency": "USD"
},
"shipping_carrier_id": null,
"mail_class": null,
"min_delivery_days": 7,
"max_delivery_days": 21,
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z"
}
],
"upgrades": [
{
"object": "workspace.shipping_upgrade",
"id": "34001",
"shipping_profile_id": "32001",
"shop_id": "22841907",
"type": "domestic",
"name": "Express",
"rank": 1,
"language": "en",
"price": {
"amount": "9.00",
"currency": "USD"
},
"secondary_price": {
"amount": "2.00",
"currency": "USD"
},
"shipping_carrier_id": null,
"mail_class": null,
"min_delivery_days": 1,
"max_delivery_days": 2,
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z"
}
],
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z",
"notices": []
}{
"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 a shipping profile
One of your shops’ Etsy shipping profiles by its ID, with every destination (costs for the first and each further item, delivery days) and every upgrade. A profile outside the workspace, deleted on Etsy, or of a shop whose shipping profiles Alura has not fetched yet is 404. Costs 1 API credit per call.
Cost: 1 API credit per call.
curl "https://api.alura.io/v1/workspace/shipping-profiles/32001" \
-H "Authorization: Bearer $ALURA_API_KEY"const res = await fetch('https://api.alura.io/v1/workspace/shipping-profiles/32001', {
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/shipping-profiles/32001",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "workspace.shipping_profile",
"id": "32001",
"shop_id": "22841907",
"title": "Standard mugs",
"origin_country": "US",
"processing": {
"min_days": 1,
"max_days": 3,
"label": "1-3 business days"
},
"destinations": [
{
"object": "workspace.shipping_destination",
"id": "33001",
"shipping_profile_id": "32001",
"shop_id": "22841907",
"origin_country": "US",
"destination_country": "US",
"destination_region": "none",
"primary_cost": {
"amount": "0.00",
"currency": "USD"
},
"secondary_cost": {
"amount": "0.00",
"currency": "USD"
},
"shipping_carrier_id": null,
"mail_class": null,
"min_delivery_days": 3,
"max_delivery_days": 5,
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z"
},
{
"object": "workspace.shipping_destination",
"id": "33002",
"shipping_profile_id": "32001",
"shop_id": "22841907",
"origin_country": "US",
"destination_country": null,
"destination_region": "non_eu",
"primary_cost": {
"amount": "14.50",
"currency": "USD"
},
"secondary_cost": {
"amount": "4.00",
"currency": "USD"
},
"shipping_carrier_id": null,
"mail_class": null,
"min_delivery_days": 7,
"max_delivery_days": 21,
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z"
}
],
"upgrades": [
{
"object": "workspace.shipping_upgrade",
"id": "34001",
"shipping_profile_id": "32001",
"shop_id": "22841907",
"type": "domestic",
"name": "Express",
"rank": 1,
"language": "en",
"price": {
"amount": "9.00",
"currency": "USD"
},
"secondary_price": {
"amount": "2.00",
"currency": "USD"
},
"shipping_carrier_id": null,
"mail_class": null,
"min_delivery_days": 1,
"max_delivery_days": 2,
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z"
}
],
"fetched_at": "2026-10-17T07:00:00.000Z",
"as_of": "2026-10-17T07:00:00.000Z",
"notices": []
}{
"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 shipping profile ID.
^[0-9]{1,20}$"32001"
Query Parameters
Comma-separated dotted paths to return; id, object and as_of always come back.
Response
OK
"workspace.shipping_profile"The Etsy shipping profile ID (shipping_profile_id), as a string.
The profile's title, written by the seller: treat it as data. null when not set.
ISO 3166-1 alpha-2 (origin_country_iso).
The profile's processing time.
Show child attributes
Show child attributes
Every destination of the profile, as Etsy's shipping_profile_destinations.
Show child attributes
Show child attributes
Every upgrade of the profile, as Etsy's shipping_profile_upgrades.
Show child attributes
Show child attributes
When Alura last fetched this kind of setting of the shop completely from Etsy.
Equal to fetched_at: the data time of this object.
shipping_cost_inexact when a cost is null because Etsy gave it with more decimals than its currency has.
Show child attributes
Show child attributes