Catalog API Documentation

Browse endpoints, parameters, and live request examples.

GET /external_users/{external_user_id}/orders

Get all orders for an external user

Retrieves all orders associated with a specific external user ID. Returns orders with pagination support.

This endpoint allows you to retrieve all orders for a specific user across all their transactions. Each order includes full details including line items, fulfillments, and current status.

Pagination:

  • Default: 25 orders per page
  • Maximum: 100 orders per page
  • Default sort: date_placed desc

Sorting: Supported sort fields:

  • date_placed
  • order_number
  • external_order_id
  • last_tracking_update

Sort format: “field direction” (e.g., “date_placed desc”, “order_number asc”)

Order

Parameters

external_user_id required path (string)

The external user ID to fetch orders for

page query (integer)

Page number for pagination

per_page query (integer)

Number of items per page (max: 100)

sort query (string)

Sort order as 'field direction' (e.g., 'date_placed desc', 'order_number asc')

Responses

200 List of orders for the user
Example Response 
{
  "orders": [
    {
      "address_1": "123 Main St",
      "address_2": null,
      "address_3": null,
      "address_4": null,
      "city": "Anytown",
      "country": "US",
      "created": "2025-01-15T10:00:00Z",
      "email": "john@example.com",
      "external_order_id": "ORDER-2024-001",
      "external_user_id": "user-456",
      "fulfillments": [],
      "given_name": "John",
      "is_test": false,
      "line_items": [],
      "order_number": "C234-56789-ABCDE-0001",
      "phone_number": "555-123-4567",
      "postal_code": "12345",
      "socket_id": 100,
      "state_or_region": "CA",
      "surname": "Doe",
      "updated": "2025-01-15T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_count": 47,
    "total_pages": 2
  },
  "success": true,
  "timestamp": "2025-01-15T14:30:00Z"
}
Response Schema
Schema Reference:

Response containing a paginated list of orders for the user

Type: object
Required fields:
success timestamp orders pagination

Properties:

orders required
pagination required
success required
timestamp required
401 Authentication failed
Example Response 
{
  "error_code": "AUTHENTICATION_FAILED",
  "message": "Invalid or expired API token",
  "success": false,
  "timestamp": "2025-01-15T14:30:00Z"
}
Response Schema
Schema Reference:

Standard error response format

Type: object
Required fields:
success message timestamp error_code

Properties:

error_code required
message required
success required
timestamp required