pos-evaluate-coupons

Method: GET
Path: /pos/carts/{id}/evaluate-coupons

Tags: POS

Summary

Evaluate coupons

Description

Evaluate applicable & inapplicable coupons based on the specified cart.

Pos SDK Usage

SDK Method: pos.evaluateCoupons()

Example:

const { data, error } = await pos.evaluateCoupons({
  id: "01H9CART12345ABCDE"
});

if (error) {
  console.error("Failed to evaluate coupons:", error.message);
} else {
  const applicable = data.applicable_coupons || [];
  const inapplicable = data.inapplicable_coupons || [];

  console.log("Applicable coupons:", applicable.length);
  applicable.forEach(coupon => {
    console.log(`- ${coupon.code}: Save $${coupon.estimated_discount}`);
  });

  console.log("Inapplicable coupons:", inapplicable.length);
  inapplicable.forEach(coupon => {
    console.log(`- ${coupon.code}: ${coupon.reason}`);
  });
}

TypeScript Definition

"pos-evaluate-coupons": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Cart Id */
                id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            applicable_coupons: components["schemas"]["ApplicableCoupon"][];
                            inapplicable_coupons: components["schemas"]["InapplicableCoupon"][];
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["ApplicableCoupon"]	ApplicableCoupon
components["schemas"]["InapplicableCoupon"]	InapplicableCoupon
components["responses"]["Unauthorized"]	Unauthorized

Parameters

• id (path): Cart Id

Responses

200

OK

401

Not authorized for given operation on the Resource

OpenAPI Definition

{
  "tags": [
    "POS"
  ],
  "operationId": "pos-evaluate-coupons",
  "summary": "Evaluate coupons",
  "description": "Evaluate applicable & inapplicable coupons based on the specified cart.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Cart Id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "applicable_coupons": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ApplicableCoupon"
                    }
                  },
                  "inapplicable_coupons": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/InapplicableCoupon"
                    }
                  }
                },
                "required": [
                  "applicable_coupons",
                  "inapplicable_coupons"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listPromotions"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions