Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
External Orders

Get external order by external source and ID

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns details of a specific external order using the marketplace's source and order ID. This is the preferred method for external marketplace integrations.

get/open-api/v1.0/external-orders/{externalSource}/{externalOrderId}

Path parameters

externalSourcestring required

The marketplace source (e.g., etsy, amazon, ebay)

externalOrderIdstring required

The marketplace's order ID

Response

OK

orderIdstring uuid required
externalOrderIdstring required
externalSourcestring required
friendlyIdstring required
statusstring required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "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"
    }
  }
}