Interface CommerceProvider

Provides information for commerce related fields.

interface CommerceProvider {
    addToCart?(items: CartItem[]): Awaitable<void>;
    addToCartIntend?(items: ReferenceData[]): Awaitable<void>;
    allowAddToCart?(): Awaitable<boolean>;
    allowAddToCartBundle?(): Awaitable<boolean>;
    getCurrencyForId(id: ReferenceData): Awaitable<undefined | string>;
    getPriceForId(id: ReferenceData): Awaitable<undefined | number>;
    getStrikePriceForId(id: ReferenceData): Awaitable<undefined | number>;
}

Index

Methods

addToCart? addToCartIntend? allowAddToCart? allowAddToCartBundle? getCurrencyForId getPriceForId getStrikePriceForId

Methods

`Optional`addToCart

addToCart(items): Awaitable<void>
Adds a list of items to the shopping cart
Parameters
- items: CartItem[]
  Array of CartItem objects containing the ID, size and quantity of the products
Returns Awaitable<void>
- Defined in packages/public-types/src/commerce.ts:83

`Optional`addToCartIntend

addToCartIntend(items): Awaitable<void>
If this is implemented the function is called if the customer would like to purchase the items identified in the items parameter.

No size selection happened yet.

This callback could show a screen for the user to select garment sizes, etc.
Parameters
- items: ReferenceData[]
  Array of IDs of the garments the customer would like to purchase
Returns Awaitable<void>
- Defined in packages/public-types/src/commerce.ts:94

`Optional`allowAddToCart

allowAddToCart(): Awaitable<boolean>
Returns if it is allowed to run add to cart operations in the MDRC. If it is not set it will default to true!

Returns Awaitable<boolean>
true if it is allowed to run add to cart operations in the MDRC
- Defined in packages/public-types/src/commerce.ts:71

`Optional`allowAddToCartBundle

allowAddToCartBundle(): Awaitable<boolean>
Returns true if it is allowed to run add to cart operation for a set of garmetns. If it is not set it will default to true!

Returns Awaitable<boolean>
true if it is allowed to run add to cart operations in the MDRC
- Defined in packages/public-types/src/commerce.ts:78

getCurrencyForId

getCurrencyForId(id): Awaitable<undefined | string>
Returns the currency for a given garment.
Parameters
- id: ReferenceData
  Unique ID of the garment
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/commerce.ts:55

getPriceForId

getPriceForId(id): Awaitable<undefined | number>
Returns the price of a given garment.
Parameters
- id: ReferenceData
  Unique ID of the garment
Returns Awaitable<undefined | number>
- Defined in packages/public-types/src/commerce.ts:60

getStrikePriceForId

getStrikePriceForId(id): Awaitable<undefined | number>
Returns the strike price of a given garment, if applicable
Parameters
- id: ReferenceData
  Unique ID of the garment
Returns Awaitable<undefined | number>
- Defined in packages/public-types/src/commerce.ts:65