Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckoutRepository

Hierarchy

  • RepositoryBase
    • CheckoutRepository

Index

Methods

Methods

add

  • 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

    Returns Promise<CheckoutResponse>

addCheckoutMetadata

  • 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

    Returns Promise<GraphqlResponse<CheckoutAddMetadataData>>

addKit

  • 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>>

addMetadataForProductVariant

  • 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

    Returns Promise<GraphqlResponse<CheckoutAddMetadataForProductVariantData>>

create

  • Creates a new checkout

    Parameters

    • products: number | CheckoutProductInput[]

      List of products to add or id of variant to be added with quantity 1

    Returns Promise<CheckoutResponse>

get

  • 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<CheckoutResponse>

getCheckoutId

  • getCheckoutId(): Promise<string>

  • Returns Promise<string>

partnerAssociate

  • partnerAssociate(checkoutId?: string, partnerAccessToken?: string): Promise<CheckoutResponse>

  • 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

    Returns Promise<CheckoutResponse>

partnerDisassociate

  • 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

    Returns Promise<CheckoutResponse>

remove

  • 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

    Returns Promise<CheckoutResponse>

removeKit

  • 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>>

Generated using TypeDoc