CheckoutRepository | storefront-sdk

Hierarchy

RepositoryBase
- CheckoutRepository

Methods

add

add(products: number | CheckoutProductInput[], checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutData>>

- Defined in sdk-full/checkout-repository.ts:105
Adds a product to an existing checkout

Parameters
- products: number | CheckoutProductInput[]
  
  List of products to add or id of variant to be added with quantity 1
- Optional checkoutId: string
  
  The checkout id to add the product to. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutData>>

addCoupon

addCoupon(coupon: string, checkoutId?: string, recaptchaToken?: string, customerAccessToken?: string): Promise<GraphqlResponse<CheckoutAddCouponData>>

- Defined in sdk-full/checkout-repository.ts:119
Adds a coupon to an existing checkout

Parameters
- coupon: string
  
  The coupon
- Optional checkoutId: string
  
  The checkout id to add the coupon to. If not provided, will try to use the value from the 'carrinho-id' cookie
- Optional recaptchaToken: string
- Optional customerAccessToken: string
  
  The customer access token to identify the user who is trying to add the coupon to the cart. If not provided, will try to use the value from the 'sf_customer_access_token' cookie
Returns Promise<GraphqlResponse<CheckoutAddCouponData>>

addKit

addKit(input: CheckoutKitInput, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutKitData>>

- Defined in sdk-full/checkout-repository.ts:461
Adds or creates a kit in an existing checkout

Parameters
- input: CheckoutKitInput
  
  Checkout kit input.
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The google recaptcha token
Returns Promise<GraphqlResponse<CheckoutKitData>>

addMetadata

addMetadata(metadata: CheckoutMetadataInput[], checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutAddMetadataData>>

- Defined in sdk-full/checkout-repository.ts:339
Adds metadata to an existing checkout

Parameters
- metadata: CheckoutMetadataInput[]
  
  Array of metadata objects to be added
- Optional checkoutId: string
  
  The checkout id to add the metadata to. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutAddMetadataData>>

addMetadataForProductVariant

addMetadataForProductVariant(productVariantId: number, metadata: CheckoutMetadataInput[], checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutAddMetadataForProductVariantData>>

- Defined in sdk-full/checkout-repository.ts:446
Adds metadata to a product variant in an existing checkout

Parameters
- productVariantId: number
  
  The product variant id to which the metadata will be added
- metadata: CheckoutMetadataInput[]
  
  Array of metadata objects to be added
- Optional checkoutId: string
  
  The checkout id to add the metadata to. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutAddMetadataForProductVariantData>>

addressAssociate

addressAssociate(addressId: string, checkoutId?: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutAddressAssociateData>>

- Defined in sdk-full/checkout-repository.ts:161
Associates an address with an existing checkout

Parameters
- addressId: string
  
  The address ID to associate
- Optional checkoutId: string
  
  The checkout id. Will use the checkoutId from the user checkout page cookies if not provided
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutAddressAssociateData>>

clone

clone(checkoutId?: string, customerAccessToken?: string, copyUser?: boolean, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutCloneData>>

- Defined in sdk-full/checkout-repository.ts:385
Clones a cart by the given checkout ID, returns the newly created checkout ID

Parameters
- Optional checkoutId: string
  
  The checkout id
- Optional customerAccessToken: string
  
  The customer access token
- Optional copyUser: boolean
  
  Flag indicating whether to copy the existing Customer information to the new Checkout. Default is false
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutCloneData>>

complete

complete(checkoutId?: string, comments?: string, customerAccessToken?: string, paymentData?: string, recaptchaToken?: string): Promise<{ completeResponse: GraphqlResponse<CheckoutCompleteData>; newCheckout: GraphqlResponse<CheckoutCloneData> }>

- Defined in sdk-full/checkout-repository.ts:403
Completes a checkout

Parameters
- Optional checkoutId: string
  
  The existing checkout id
- Optional comments: string
  
  Order comments
- Optional customerAccessToken: string
  
  The customer access token
- Optional paymentData: string
  
  Payment data
- Optional recaptchaToken: string
  
  The google recaptcha token
Returns Promise<{ completeResponse: GraphqlResponse<CheckoutCompleteData>; newCheckout: GraphqlResponse<CheckoutCloneData> }>

create

create(products: number | CheckoutProductInput[], recaptchaToken?: string): Promise<GraphqlResponse<CheckoutData>>

- Defined in sdk-full/checkout-repository.ts:89
Creates a new checkout

Parameters
- products: number | CheckoutProductInput[]
  
  List of products to add or id of variant to be added with quantity 1
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutData>>

customerAssociate

customerAssociate(checkoutId?: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutCustomerAssociateData>>

- Defined in sdk-full/checkout-repository.ts:144
Associates a customer with an existing checkout

Parameters
- Optional checkoutId: string
  
  The checkout id to associate the customer with
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutCustomerAssociateData>>

get

get(checkoutId?: string): Promise<GraphqlResponse<CheckoutData>>

- Defined in sdk-full/checkout-repository.ts:71
Retrieve information about a checkout

Parameters
- Optional checkoutId: string
  
  The id of the checkout. Will use the checkoutId from the user checkout page cookies if not provided
Returns Promise<GraphqlResponse<CheckoutData>>

partnerAssociate

partnerAssociate(checkoutId?: string, partnerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutData>>

- Defined in sdk-full/checkout-repository.ts:307
Associate the partner with the checkout

Parameters
- Optional checkoutId: string
  
  The checkout id to associate with the partner. Will use the checkoutId from the user checkout page cookies if not provided
- Optional partnerAccessToken: string
  
  The partner access token to associante with the checkout. Will be canceled and return null if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutData>>

partnerDisassociate

partnerDisassociate(checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutData>>

- Defined in sdk-full/checkout-repository.ts:325
Disassociate the checkout with the partner

Parameters
- Optional checkoutId: string
  
  The checkout id to disassociate with the partner. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutData>>

remove

remove(products: number | CheckoutProductInput[], checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutData>>

- Defined in sdk-full/checkout-repository.ts:294
Removes a product from an existing checkout

Parameters
- products: number | CheckoutProductInput[]
  
  List of products to remove or id of variant to be removed with quantity 1
- Optional checkoutId: string
  
  The checkout id to remove the product from. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutData>>

removeCoupon

removeCoupon(checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutRemoveCouponData>>

- Defined in sdk-full/checkout-repository.ts:132
Removes a coupon from an existing checkout

Parameters
- Optional checkoutId: string
  
  The checkout id to remove the coupon from. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutRemoveCouponData>>

removeKit

removeKit(input: CheckoutKitInput, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutKitData>>

- Defined in sdk-full/checkout-repository.ts:475
Removes a kit from an existing checkout

Parameters
- input: CheckoutKitInput
  
  Checkout kit input.
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The google recaptcha token
Returns Promise<GraphqlResponse<CheckoutKitData>>

removeProductCustomization

removeProductCustomization(customizationId: string, productVariantId: number, checkoutId?: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutRemoveProductCustomizationData>>

- Defined in sdk-full/checkout-repository.ts:491
Remove Customization to Checkout

Parameters
- customizationId: string
  
  The customization Id
- productVariantId: number
  
  The product variant Id to remove customization
- Optional checkoutId: string
  
  The existing checkout id
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The google recaptcha token
Returns Promise<GraphqlResponse<CheckoutRemoveProductCustomizationData>>

selectCurrentAccount

selectCurrentAccount(hasCurrentAccount: Boolean, checkoutId?: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CurrentAccountSelectedData>>

- Defined in sdk-full/checkout-repository.ts:247
Select whether to use current account balance

Parameters
- hasCurrentAccount: Boolean
  
  Use Balance
- Optional checkoutId: string
  
  The checkout id
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CurrentAccountSelectedData>>

selectGiftVariant

selectGiftVariant(productVariantId: number, checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutGiftVariantSelectionData>>

- Defined in sdk-full/checkout-repository.ts:352
Selects gift variant in an existing checkout

Parameters
- productVariantId: number
  
  The product variant id that will be selected
- Optional checkoutId: string
  
  The checkout id to select the gift variant. Will use the checkoutId from the user checkout page cookies if not provided
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutGiftVariantSelectionData>>

selectInstallment

selectInstallment(selectedPaymentMethodId: string, installmentNumber: number, checkoutId?: string, recaptchaToken?: string, orderId?: number): Promise<GraphqlResponse<CheckoutSelectInstallmentData>>

- Defined in sdk-full/checkout-repository.ts:270
Selects an installment method for an existing checkout

Parameters
- selectedPaymentMethodId: string
  
  The selected payment method ID
- installmentNumber: number
  
  The number of installments
- Optional checkoutId: string
  
  The checkout id
- Optional recaptchaToken: string
- Optional orderId: number
Returns Promise<GraphqlResponse<CheckoutSelectInstallmentData>>

selectPaymentMethod

selectPaymentMethod(paymentMethodId: string, checkoutId?: string, recaptchaToken?: string, orderId?: number): Promise<GraphqlResponse<CheckoutSelectPaymentMethodData>>

- Defined in sdk-full/checkout-repository.ts:224
Selects a payment method for an existing checkout

Parameters
- paymentMethodId: string
  
  The payment method ID to select
- Optional checkoutId: string
  
  The checkout id
- Optional recaptchaToken: string
- Optional orderId: number
Returns Promise<GraphqlResponse<CheckoutSelectPaymentMethodData>>

selectShippingQuote

selectShippingQuote(shippingQuoteId: string, checkoutId?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutSelectShippingQuoteData>>

- Defined in sdk-full/checkout-repository.ts:183
Selects a shipping quote for an existing checkout

Parameters
- shippingQuoteId: string
  
  The shipping quote ID to select
- Optional checkoutId: string
  
  The checkout id
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutSelectShippingQuoteData>>

selectShippingQuoteWithDetails

selectShippingQuoteWithDetails(input: CheckoutSelectShippingQuoteInput, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutSelectShippingQuoteData>>

- Defined in sdk-full/checkout-repository.ts:203
Selects a shipping quote for an existing checkout with additional information and delivery schedule

Parameters
- input: CheckoutSelectShippingQuoteInput
  
  The shipping quote selection input
- Optional recaptchaToken: string
  
  The google recaptcha token
Returns Promise<GraphqlResponse<CheckoutSelectShippingQuoteData>>

setCheckoutId

setCheckoutId(checkoutId: string): Promise<void>

- Defined in sdk-full/checkout-repository.ts:501
Parameters
- checkoutId: string
Returns Promise<void>

updateProduct

updateProduct(input: CheckoutProductUpdateInput, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CheckoutUpdateProductData>>

- Defined in sdk-full/checkout-repository.ts:364
Disassociate the checkout with the partner

Parameters
- input: CheckoutProductUpdateInput
- Optional customerAccessToken: string
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CheckoutUpdateProductData>>

Hierarchy

Index

Methods

Methods

add

Parameters

products: number | CheckoutProductInput[]

Optional checkoutId: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutData>>

addCoupon

Parameters

coupon: string

Optional checkoutId: string

Optional recaptchaToken: string

Optional customerAccessToken: string

Returns Promise<GraphqlResponse<CheckoutAddCouponData>>

addKit

Parameters

input: CheckoutKitInput

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutKitData>>

addMetadata

Parameters

metadata: CheckoutMetadataInput[]

Optional checkoutId: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutAddMetadataData>>

addMetadataForProductVariant

Parameters

productVariantId: number

metadata: CheckoutMetadataInput[]

Optional checkoutId: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutAddMetadataForProductVariantData>>

addressAssociate

Parameters

addressId: string

Optional checkoutId: string

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutAddressAssociateData>>

clone

Parameters

Optional checkoutId: string

Optional customerAccessToken: string

Optional copyUser: boolean

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutCloneData>>

complete

Parameters

Optional checkoutId: string

Optional comments: string

Optional customerAccessToken: string

Optional paymentData: string

Optional recaptchaToken: string

Returns Promise<{ completeResponse: GraphqlResponse<CheckoutCompleteData>; newCheckout: GraphqlResponse<CheckoutCloneData> }>

create

Parameters

products: number | CheckoutProductInput[]

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutData>>

customerAssociate

Parameters

Optional checkoutId: string

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutCustomerAssociateData>>

get

Parameters

Optional checkoutId: string

Returns Promise<GraphqlResponse<CheckoutData>>

partnerAssociate

Parameters

Optional checkoutId: string

Optional partnerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CheckoutData>>

partnerDisassociate