List Orders

Lists the host's orders as the compact dashboard projection, filtered and paginated. Refunded/non-refunded and box-office are the same list with a filter: pass refunded=true|false or isBoxOffice=true. Sorted by created date descending.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Query Parameters

pageinteger

Page number (0-based, default 0)

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Items per page (default 20, max 500)

Default: 20Minimum: 1Maximum: 500

eventIdstring

Filter to one event

productSetIdstring

Filter to one product set

timeslotIdstring

Filter to one timeslot

contactIdstring

Filter to one contact

purchaserIdstring

Filter to one purchaser

orderNumberstring

Exact order number

orderStatusstring

Filter by lifecycle status

typestring

Filter by order type

Value in: "booking" | "ticket" | "product"

statusstring

true = paid/completed orders only

refundedstring

true = refunded only; false = non-refunded only

isBoxOfficestring

true = box-office orders only

sortDirectionstring

Sort by created date (default: desc)

Value in: "asc" | "desc"

GET/v1/orders/

curl -X GET "https://api.3common.com/v1/orders/?eventId=string&productSetId=string&timeslotId=string&contactId=string&purchaserId=string&orderNumber=string&orderStatus=pending&type=booking&status=string&refunded=string&isBoxOffice=string&sortDirection=asc" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "id": "string",
      "customerName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "date": "2019-08-24T14:15:22Z",
      "type": "booking",
      "amount": 0,
      "quantity": 0,
      "status": true,
      "orderStatus": "pending",
      "paymentMethod": "string",
      "currency": "string",
      "discount": 0,
      "fees": 0,
      "promos": [
        "string"
      ],
      "refundedAmount": 0,
      "refLabel": "string",
      "walletLink": "string",
      "eventId": "string",
      "refunded": true,
      "cancelled": true,
      "isBoxOffice": true,
      "manuallyAdded": true,
      "comped": true,
      "latestCharge": "string",
      "disputeStatus": "string",
      "accessCodes": [
        {
          "code": "string",
          "benefitType": "string"
        }
      ],
      "product_set_id": "string",
      "property1": null,
      "property2": null
    }
  ],
  "hasMore": true
}

TypeScript

export interface Response {
  data: {
    id: string;
    customerName: string;
    firstName: string;
    lastName: string;
    email: string;
    /**
     * Order placed date (ISO 8601)
     */
    date?: string;
    /**
     * Order line type.
     */
    type?: "booking" | "ticket" | "product";
    /**
     * Gross (total paid) in cents.
     */
    amount: number;
    quantity: number;
    /**
     * True for completed (paid) orders.
     */
    status: boolean;
    /**
     * Order lifecycle status.
     */
    orderStatus?: "pending" | "paid" | "processing" | "completed" | "cancelled" | "refunded";
    paymentMethod?: string;
    currency?: string;
    discount: number;
    fees: number;
    promos?: string[];
    refundedAmount?: number;
    refLabel?: string;
    walletLink?: string;
    eventId: string;
    refunded?: boolean;
    cancelled?: boolean;
    isBoxOffice?: boolean;
    manuallyAdded?: boolean;
    comped?: boolean;
    latestCharge?: string;
    disputeStatus?: string;
    accessCodes?: {
      code: string;
      benefitType?: string;
    }[];
    product_set_id?: string;
    [k: string]: unknown;
  }[];
  hasMore: boolean;
}