Get Checkout Details

Returns a product set's products (grouped by type) with inventory, plus every order and ticket for that set.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Product set ID

GET/v1/orders/checkout/{id}/details

curl -X GET "https://api.3common.com/v1/orders/checkout/string/details" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": {
    "products": {
      "mode": "product-set",
      "data": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "inventoryByProductId": {
        "property1": {
          "property1": null,
          "property2": null
        },
        "property2": {
          "property1": null,
          "property2": null
        }
      }
    },
    "tickets": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "orders": [
      {
        "property1": null,
        "property2": null
      }
    ]
  }
}

TypeScript

export interface Response {
  data: {
    products: {
      mode: "product-set";
      /**
       * One entry per set: { productSetId, productsByType }
       */
      data: {
        [k: string]: unknown;
      }[];
      inventoryByProductId: {
        [k: string]: {
          [k: string]: unknown;
        };
      };
    };
    /**
     * All tickets for the product set
     */
    tickets: {
      [k: string]: unknown;
    }[];
    /**
     * All orders for the product set
     */
    orders: {
      [k: string]: unknown;
    }[];
  };
}