List Checkouts

Workspace-scoped paginated list of standalone checkouts. Supports search over name and description, status / event / timeslot filters, and sorting incl. the computed product count and the owning event or form (by display name).

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Query Parameters

pageNumberinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 50Minimum: 1Maximum: 200

searchstring

statusstring

Value in: "open" | "closed"

eventIdstring

timeslotIdstring

sortFieldstring

Value in:

"name" | "description" | "createdAt" | "updatedAt" | "status" | "visibility" | "productsCount" | "_id" | "event" | "form"

sortDirectionstring

Value in: "asc" | "desc"

filtersstring

GET/v1/checkouts/

curl -X GET "https://api.3common.com/v1/checkouts/?search=string&status=open&eventId=string&timeslotId=string&sortField=name&sortDirection=asc&filters=string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "id": "string",
      "ownerId": "string",
      "name": "string",
      "description": "string",
      "status": "open",
      "visibility": "private",
      "products": [
        {
          "productId": "string",
          "quantity": -9007199254740991,
          "visibility": "visible",
          "dependents": []
        }
      ],
      "maxTicketsPerSet": 0,
      "maxTicketsPerOrder": 0,
      "eventId": "string",
      "timeslotId": "string",
      "orderFormId": "string",
      "redirectUrl": "string",
      "payByInvoice": {
        "enabled": true,
        "memo": "string",
        "taxIds": [
          {
            "type": "string",
            "value": "string"
          }
        ],
        "dueInDays": -9007199254740991
      },
      "paymentMethods": [
        "card"
      ],
      "payButtonLabel": "string",
      "disableConfirmationEmail": true,
      "availableFrom": "2019-08-24T14:15:22Z",
      "availableTo": "2019-08-24T14:15:22Z",
      "availabilityTimezone": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "productsCount": 0,
      "eventName": "string",
      "eventImage": "string",
      "isEventSet": true,
      "formName": "string"
    }
  ],
  "hasMore": true,
  "pageNumber": 0,
  "pageSize": 0
}

TypeScript

export interface Response {
  data: {
    id: string;
    ownerId: string;
    name: string;
    description?: string;
    status: "open" | "closed";
    visibility: "private" | "public";
    products: {
      productId: string;
      quantity?: number;
      visibility: "visible" | "conditional" | "hidden";
      dependents: {
        productId: string;
        minPerOrder?: number;
        maxPerOrder?: number;
        priceMode?: "free" | "paid" | "pwyc";
        price?: number;
        pwycMin?: number;
        customFees?: {
          id?: string;
          name: string;
          rate: number;
          isCustomFee?: boolean;
          isFixedValue?: boolean;
          includeInServiceFee?: boolean;
          defaultServiceFee?: boolean;
          isOrgDefault?: boolean;
        }[];
        includeOrgTaxes?: boolean;
      }[];
    }[];
    maxTicketsPerSet?: number;
    maxTicketsPerOrder?: number;
    eventId?: string;
    timeslotId?: string;
    orderFormId?: string;
    redirectUrl?: string;
    payByInvoice?: {
      enabled: boolean;
      memo?: string;
      taxIds?: {
        type: string;
        value: string;
      }[];
      dueInDays?: number;
    };
    paymentMethods?: ("card" | "pay_by_invoice" | "pay_later")[];
    payButtonLabel?: string;
    disableConfirmationEmail?: boolean;
    availableFrom?: string;
    availableTo?: string;
    availabilityTimezone?: string;
    createdAt: string;
    updatedAt: string;
    productsCount: number;
    eventName?: string;
    eventImage?: string;
    isEventSet: boolean;
    formName?: string;
  }[];
  hasMore: boolean;
  pageNumber: number;
  pageSize: number;
}