OrdersShops
Get Many Shops
Get multiple shops with pagination and filtering
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination (starting from 0)
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter shops by name or domain
Default
""type?string
Filter by shop type (comma-separated for multiple values)
Default
""domain?string
Filter by shop domain (comma-separated for multiple values)
Default
""merchant_team_id?string
Filter by merchant team ID (comma-separated for multiple values)
Default
""order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
order?string
Order direction
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/shops"{ "data": [ { "authorization_expires_at": "2019-08-24T14:15:22Z", "order_sync_start_date": "2019-08-24T14:15:22Z", "inventory_sync_enabled": true, "synced_at": "2019-08-24T14:15:22Z", "remote_slug": "string", "remote_id": "string", "uninstalled_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "slug": "string", "country": "string", "domain": "string", "currency": "string", "team_name": "string", "team_id": "string", "fulfiller_team_name": "string", "fulfiller_team_id": "string", "merchant_team_name": "string", "merchant_team_id": "string", "type": "SHOPIFY", "name": "string", "id": "string", "supported_actions": [ { "action": "DELETE_SHOP" } ] } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}