Class Products

Hierarchy

  • Products

Properties

impersonating

Methods

As Create Delete DeleteAssignment GenerateVariants Get GetVariant List ListAssignments ListSpecs ListSuppliers ListVariants Patch PatchVariant RemoveSupplier Save SaveAssignment SaveSupplier SaveVariant

Properties

Private impersonating

impersonating: boolean = false

Methods

As

  • Description

    enables impersonation by calling the subsequent method with the stored impersonation token

    Example

    Products.As().List() // lists Products using the impersonated users' token

    Returns Products

Create

Delete

  • Delete a product Check out the docs for more info

    Parameters

    • productID: string

      ID of the product.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteAssignment

  • Delete a product assignment Check out the docs for more info

    Parameters

    • productID: string

      ID of the product.

    • buyerID: string

      ID of the buyer.

    • listOptions: {
          sellerID?: string;
          userGroupID?: string;
          userID?: string;
      } = {}
      • Optional sellerID?: string

        ID of the seller.

      • Optional userGroupID?: string

        ID of the user group.

      • Optional userID?: string

        ID of the user.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

GenerateVariants

  • Generate variants Check out the docs for more info

    Type Parameters

    • TProduct extends Product<any, TProduct>

    Parameters

    • productID: string

      ID of the product.

    • variantOverrides: VariantOverrides
    • listOptions: {
          overwriteExisting?: boolean;
      } = {}
      • Optional overwriteExisting?: boolean

        Overwrite existing of the product.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TProduct>>

Get

GetVariant

  • Retrieve a product variant Check out the docs for more info

    Type Parameters

    • TVariant extends Variant<any, TVariant>

    Parameters

    • productID: string

      ID of the product.

    • variantID: string

      ID of the variant.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TVariant>>

List

  • List products Check out the docs for more info

    Type Parameters

    • TProduct extends Product<any, TProduct>

    Parameters

    • listOptions: {
          catalogID?: string;
          categoryID?: string;
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: string[];
          searchType?: SearchType;
          sortBy?: string[];
          supplierID?: string;
      } = {}
      • Optional catalogID?: string

        ID of the catalog.

      • Optional categoryID?: string

        ID of the category.

      • Optional filters?: Filters

        An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

      • Optional page?: number

        Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

      • Optional pageSize?: number

        Number of results to return per page.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: string[]

        Comma-delimited list of fields to search on.

      • Optional searchType?: SearchType

        Type of search to perform.

      • Optional sortBy?: string[]

        Comma-delimited list of fields to sort by.

      • Optional supplierID?: string

        ID of the supplier.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPageWithFacets<TProduct, any>>>

ListAssignments

  • List product assignments Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          buyerID?: string;
          level?: "Group" | "Company";
          page?: number;
          pageSize?: number;
          priceScheduleID?: string;
          productID?: string;
          userGroupID?: string;
      } = {}
      • Optional buyerID?: string

        ID of the buyer.

      • Optional level?: "Group" | "Company"

        Level of the product assignment. Possible values: Group, Company.

      • Optional page?: number

        Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

      • Optional pageSize?: number

        Number of results to return per page.

      • Optional priceScheduleID?: string

        ID of the price schedule.

      • Optional productID?: string

        ID of the product.

      • Optional userGroupID?: string

        ID of the user group.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TProductAssignment>>>

ListSpecs

  • List product specs Check out the docs for more info

    Type Parameters

    • TSpec extends Spec<any, any, TSpec>

    Parameters

    • productID: string

      ID of the product.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[];
      } = {}
      • Optional filters?: Filters

        An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

      • Optional page?: number

        Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

      • Optional pageSize?: number

        Number of results to return per page.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "Name")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TSpec>>>

ListSuppliers

  • List product suppliers Check out the docs for more info

    Type Parameters

    Parameters

    • productID: string

      ID of the product.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[];
      } = {}
      • Optional filters?: Filters

        An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

      • Optional page?: number

        Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

      • Optional pageSize?: number

        Number of results to return per page.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "Name")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TProductSupplier>>>

ListVariants

  • List product variants Check out the docs for more info

    Type Parameters

    • TVariant extends Variant<any, TVariant>

    Parameters

    • productID: string

      ID of the product.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name" | "Description")[];
          sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
      } = {}
      • Optional filters?: Filters

        An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

      • Optional page?: number

        Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

      • Optional pageSize?: number

        Number of results to return per page.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "Name" | "Description")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TVariant>>>

Patch

PatchVariant

RemoveSupplier

  • Remove a product supplier Check out the docs for more info

    Parameters

    • productID: string

      ID of the product.

    • supplierID: string

      ID of the supplier.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

Save

  • Create or update a product If an object with the same ID already exists, it will be overwritten. Check out the docs for more info

    Type Parameters

    • TProduct extends Product<any, TProduct>

    Parameters

    • productID: string

      ID of the product.

    • product: Product<any>

      Required fields: Name

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TProduct>>

SaveAssignment

SaveSupplier

  • Create or update a product supplier Check out the docs for more info

    Parameters

    • productID: string

      ID of the product.

    • supplierID: string

      ID of the supplier.

    • listOptions: {
          defaultPriceScheduleID?: string;
      } = {}
      • Optional defaultPriceScheduleID?: string

        ID of the default price schedule.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

SaveVariant

  • Update a product variant Update a product variant. Check out the docs for more info

    Type Parameters

    • TVariant extends Variant<any, TVariant>

    Parameters

    • productID: string

      ID of the product.

    • variantID: string

      ID of the variant.

    • variant: Variant<any>
    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TVariant>>

Settings

Member Visibility

Theme

Generated using TypeDoc