List fulfillment orders

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://developer.pattern.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Hub API MCP server": {
    "url": "https://developer.pattern.com/mcp"
  }
}

Close
GET /v1/orders

Paginated list of all fulfillment orders for the authenticated organization, including pending, backordered, errored, cancelled, and shipped orders. Date filters apply to order placed date, not ship date. Each row includes order value so volume, on-time rate, error rate, and revenue can be derived. Tracking-only shipped orders remain on GET /orders/tracking.

Query parameters

  • page integer

    Page number for pagination

  • per_page integer

    Number of orders per page (default: 50)

  • start_date string

    Filter orders placed on or after this date

  • end_date string

    Filter orders placed on or before this date

  • market_order_id string

    Filter to a specific marketplace order ID

  • status string

    Filter to orders with a shipment in this status (e.g. backordered, canceled, shipped)

Responses

  • 200 application/json

    Orders listed successfully

    Hide response attributes Show response attributes object
    • market_order_id string

      Marketplace order ID

    • order_status string

      Rolled-up order status

      Values are pending, processing, complete, partially shipped, backordered, error, or cancelled.

    • order_value number(float) | null

      Order merchandise value

    • currency_code string | null

      Order currency

    • order_placed_at string(date-time) | null

      When the order was placed

    • latest_ship_by_date string(date) | null

      Latest ship-by date

    • item_count integer | null

      Number of line items

    • unit_count integer | null

      Total unit quantity

    • shipments array[object]
      Hide shipments attributes Show shipments attributes object
      • status string

        Shipment status

      • warehouse_name string | null

        Fulfilling warehouse

      • carrier_name string | null

        Carrier name

      • tracking_number string | null

        Tracking number

      • shipped_at string(date-time) | null

        Shipment ship date

      • delivered_at string(date-time) | null

        Shipment delivery date

      • expected_delivery_date string(date) | null

        Expected delivery date

  • 422 application/json

    Invalid date filter

    Hide response attribute Show response attribute object
    • errors array[string]
GET /v1/orders
curl \
 --request GET 'https://api.pattern.com/hub/v1/orders' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "market_order_id": "string",
    "order_status": "pending",
    "order_value": 42.0,
    "currency_code": "string",
    "order_placed_at": "2026-05-04T09:42:00Z",
    "latest_ship_by_date": "2026-05-04",
    "item_count": 42,
    "unit_count": 42,
    "shipments": [
      {
        "status": "string",
        "warehouse_name": "string",
        "carrier_name": "string",
        "tracking_number": "string",
        "shipped_at": "2026-05-04T09:42:00Z",
        "delivered_at": "2026-05-04T09:42:00Z",
        "expected_delivery_date": "2026-05-04"
      }
    ]
  }
]
Response examples (422)
{
  "errors": [
    "string"
  ]
}