This endpoint returns all connected order sources using the ShipEngine API.
GET /v-beta/order_sources
GET /v-beta/order_sources HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__{
"order_sources": [
{
"order_source_id": "__YOUR_ORDER_SOURCE_ID_HERE__",
"order_source_nickname": "My Shopify account",
"order_source_code": "shopify",
"order_source_friendly_name": "Shopify",
"refresh_info": {
"status": "preparing_update",
"last_refresh_attempt": null,
"refresh_date": "2018-02-10T20:55:46.673Z"
},
"active": true
}
]
}The response contains an array of order sources with the following properties:
| Field | Type | Description |
|---|---|---|
| order_source_id | string | Unique identifier for the order source |
| order_source_nickname | string | Custom name for the order source |
| order_source_code | string | Platform code (e.g., "shopify") |
| order_source_friendly_name | string | Display name of the platform |
| refresh_info | object | Sync status information |
| active | boolean | Whether the connection is active |
| Field | Type | Description |
|---|---|---|
| status | string | Current refresh status |
| last_refresh_attempt | date string | Timestamp of last sync attempt |
| refresh_date | date string | Next scheduled refresh date |