list-coupons

Method: GET
Path: /carts/available-coupons

Tags: Carts

Summary

Retrieve all coupons

Description

Retrieve active coupons

Storefront SDK Usage

SDK Method: sdk.cart.getAvailableCoupons()

Example:

// Get all available coupons
const { data, error } = await sdk.cart.getAvailableCoupons();

if (error) {
  console.error("Failed to get available coupons:", error.message);
} else {
  const coupons = data.coupons || [];
  console.log("Available coupons:", coupons.length);
  coupons.forEach(coupon => {
    console.log("Coupon:", coupon.coupon_code, "Name:", coupon.name);
  });
}

// Override customer group ID for this specific request
const { data: overrideData, error: overrideError } = await sdk.cart.getAvailableCoupons({
  "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
});

TypeScript Definition

"list-coupons": {
        parameters: {
            query?: never;
            header?: {
                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
            };
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            coupons: components["schemas"]["Coupon"][];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["parameters"]["CustomerGroupId"]	CustomerGroupId
components["schemas"]["Coupon"]	Coupon
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• x-customer-group-id (header): This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned.

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Carts"
  ],
  "operationId": "list-coupons",
  "summary": "Retrieve all coupons",
  "description": "Retrieve active coupons",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-coupons",
    "description": "API reference for the list-coupons operation"
  },
  "parameters": [
    {
      "$ref": "#/components/parameters/CustomerGroupId"
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "coupons": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Coupon"
                    }
                  }
                },
                "required": [
                  "coupons"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "carts",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listCoupons"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions