Skip to content

Partner Orders

List a service partner's orders

List the partner organization's orders as its queue pages list them, newest paid first: course map orders and medals and printing orders (the latter while they are switched on), each with its event, item, status, current proof round, what the partner is paid and whether the partner brought the order. Orders appear once paid; an unpaid or cancelled order never does. Filter by status or service and page with cursor. Requires partner-orders:read and membership in the partner organization.

Method

GET

Path

/v1/partner-orders

Required scope

partner-orders:read

Request

curl -X GET "https://api.endurancehq.app/v1/partner-orders" \
  -H "Authorization: Bearer $EHQ_API_KEY"

Query schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "minLength": 1,
      "description": "The partner organization. An organization key may only name its own."
    },
    "status": {
      "type": "string",
      "enum": [
        "paid",
        "in_progress",
        "proof_ready",
        "changes_requested",
        "in_production",
        "shipped",
        "delivered",
        "refunded"
      ],
      "description": "paid (waiting for the partner to start), in_progress, proof_ready (waiting on the director), changes_requested, in_production (goods: approved, being made), shipped (goods), delivered (finished) or refunded (declined and refunded in full)."
    },
    "service": {
      "type": "string",
      "enum": [
        "course_maps",
        "goods"
      ],
      "description": "course_maps (a course or venue map order) or goods (a medals and printing order)."
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "organizationId",
    "limit"
  ],
  "additionalProperties": false
}

Response

Success status: 200

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "service": {
            "type": "string",
            "enum": [
              "course_maps",
              "goods"
            ],
            "description": "course_maps (a course or venue map order) or goods (a medals and printing order)."
          },
          "eventTitle": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "paid",
              "in_progress",
              "proof_ready",
              "changes_requested",
              "in_production",
              "shipped",
              "delivered",
              "refunded"
            ],
            "description": "paid (waiting for the partner to start), in_progress, proof_ready (waiting on the director), changes_requested, in_production (goods: approved, being made), shipped (goods), delivered (finished) or refunded (declined and refunded in full)."
          },
          "offeringLabel": {
            "type": "string"
          },
          "partnerCents": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "currency": {
            "type": "string"
          },
          "currentRound": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "broughtBy": {
            "type": "string",
            "enum": [
              "platform",
              "partner"
            ]
          },
          "paidAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "service",
          "eventTitle",
          "status",
          "offeringLabel",
          "partnerCents",
          "currency",
          "currentRound",
          "broughtBy",
          "paidAt",
          "updatedAt"
        ],
        "additionalProperties": {}
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "nextCursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "hasMore": {
          "type": "boolean"
        }
      },
      "required": [
        "nextCursor",
        "hasMore"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "data",
    "pagination"
  ],
  "additionalProperties": false
}

Other surfaces

MCP tool: ehq_partner_orders_list