Interface DiscountCodeNonApplicableError

Returned when the Cart contains a Discount Code with a DiscountCodeState other than MatchesCart.

The error is returned as a failed response to:

- [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update action on Carts.
- [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests and [Add DiscountCode](ctp:api:type:MyCartAddDiscountCodeAction) update action on My Carts.
- [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts.
- [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
- [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
- [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action on Order Edits.
- [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
interface DiscountCodeNonApplicableError {
    code: "DiscountCodeNonApplicable";
    discountCode?: string;
    discountCodeId?: string;
    message: string;
    reason?: string;
    validFrom?: string;
    validityCheckTime?: string;
    validUntil?: string;
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

code discountCode? discountCodeId? message reason? validFrom? validityCheckTime? validUntil?

Properties

Readonlycode

code: "DiscountCodeNonApplicable"

Optional ReadonlydiscountCode

discountCode?: string

Discount Code passed to the Cart.

Optional ReadonlydiscountCodeId

discountCodeId?: string

Unique identifier of the Discount Code.

Readonlymessage

message: string

"The discountCode $discountCodeId cannot be applied to the cart."

Optional Readonlyreason

reason?: string

"DoesNotExist" or "TimeRangeNonApplicable"

Optional ReadonlyvalidFrom

validFrom?: string

Date and time (UTC) from which the Discount Code is valid.

Optional ReadonlyvalidityCheckTime

validityCheckTime?: string

Date and time (UTC) the Discount Code validity check was last performed.

Optional ReadonlyvalidUntil

validUntil?: string

Date and time (UTC) until which the Discount Code is valid.

Settings

Member Visibility

On This Page

Properties