v2
latestOpenAPI 3.1.02026-07-26102336742.6 KBExternal Orders
List external orders
Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.
Returns a paginated list of external orders with optional filters for status, source, and date range.
get/open-api/v1.0/external-orders
Query parameters
pageinteger
sizeinteger
externalSourcestring
externalOrderIdstring
statusstring[]
createdAfterstring date-time
createdBeforestring date-time
Response
OK
Example response
{
"results": [
{
"orderId": "b1a5c9d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"friendlyId": "T4YTE8HA",
"status": "CONFIRMED",
"items": [
{
"quantity": 2,
"externalLineItemId": "etsy-line-item-123",
"unitCost": {
"value": 10,
"currency": "USD"
},
"totalCost": {
"value": 10,
"currency": "USD"
},
"itemFulfillmentFee": {
"value": 10,
"currency": "USD"
},
"itemShippingCost": {
"value": 10,
"currency": "USD"
},
"itemTotalCreatorCost": {
"value": 10,
"currency": "USD"
}
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"address2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"country": "US",
"phone": "+1-555-123-4567"
},
"costs": {
"fulfillmentFee": {
"value": 10,
"currency": "USD"
},
"manufacturingCost": {
"value": 10,
"currency": "USD"
},
"shippingCost": {
"value": 10,
"currency": "USD"
},
"totalCreatorCost": {
"value": 10,
"currency": "USD"
}
}
}
]
}