Class Me

Hierarchy

  • Me

Properties

impersonating

Methods

AcceptProductCollectionInvitation As CreateAddress CreateCreditCard CreateProductCollection CreateProductCollectionEntry CreateProductCollectionInvitation CreateSubscription CreateSubscriptionBundleItem CreateSubscriptionItem DeclineProductCollectionInvitation DeleteAddress DeleteCreditCard DeleteProductCollection DeleteProductCollectionEntry DeleteProductCollectionInvitation DeleteSubscription DeleteSubscriptionBundleItem DeleteSubscriptionItem Get GetAddress GetCatalog GetCategory GetCreditCard GetProduct GetProductCollection GetProductCollectionInvitation GetPromotion GetShipment GetSpec GetSpendingAccount GetSubscription GetSubscriptionItem GetVariant ListAddresses ListApprovableOrders ListBuyerSellers ListCatalogs ListCategories ListCostCenters ListCreditCards ListOrders ListProductCollectionEntries ListProductCollectionInvitations ListProductCollections ListProductInventoryRecords ListProductSellers ListProducts ListPromotions ListShipmentItems ListShipments ListSpecs ListSpendingAccounts ListSubscriptionItems ListSubscriptions ListUserGroups ListVariantInventoryRecords ListVariants Patch PatchAddress PatchCreditCard PatchProductCollection PatchProductCollectionInvitation PatchSubscription PatchSubscriptionItem Register ResetPasswordByToken RevokeTokens Save SaveAddress SaveCreditCard SaveProductCollection SaveSubscription SaveSubscriptionItem TransferAnonUserOrder

Properties

Private impersonating

impersonating: boolean = false

Methods

AcceptProductCollectionInvitation

  • Accept a product collection invitation. Check out the docs for more info

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • invitationID: string

      ID of the invitation.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

As

  • Description

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

    Example

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

    Returns Me

CreateAddress

  • Create a new address. Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them. Check out the docs for more info

    Type Parameters

    Parameters

    Returns Promise<RequiredDeep<TBuyerAddress>>

CreateCreditCard

  • Create a new credit card. Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them. Check out the docs for more info

    Type Parameters

    Parameters

    Returns Promise<RequiredDeep<TBuyerCreditCard>>

CreateProductCollection

CreateProductCollectionEntry

  • Create a new product collection entry. Only available to Buyer Users. Check out the docs for more info

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • productID: string

      ID of the product.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

CreateProductCollectionInvitation

CreateSubscription

CreateSubscriptionBundleItem

  • Create a new subscription bundle item. Check out the docs for more info

    Type Parameters

    • TLineItem extends LineItem<any, any, any, any, any, TLineItem>

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • bundleID: string

      ID of the bundle.

    • bundleItems: BundleItems<any, any, any, any, any>
    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TLineItem>>

CreateSubscriptionItem

  • Create a new subscription item. Check out the docs for more info

    Type Parameters

    • TLineItem extends LineItem<any, any, any, any, any, TLineItem>

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • lineItem: LineItem<any, any, any, any, any>

      Required fields: ProductID

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TLineItem>>

DeclineProductCollectionInvitation

  • Decline a product collection invitation. Check out the docs for more info

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • invitationID: string

      ID of the invitation.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteAddress

  • Delete an address. Only available to Buyer Users. Check out the docs for more info

    Parameters

    • addressID: string

      ID of the address.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteCreditCard

  • Delete a credit card. Only available to Buyer Users. Check out the docs for more info

    Parameters

    • creditcardID: string

      ID of the creditcard.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteProductCollection

  • Delete a product collection. Only available to Buyer Users. Check out the docs for more info

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteProductCollectionEntry

  • Delete a product collection entry. Only available to Buyer Users. Check out the docs for more info

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • productID: string

      ID of the product.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteProductCollectionInvitation

  • Delete a product collection invitation. Only available to Buyer Users. Check out the docs for more info

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • invitationID: string

      ID of the invitation.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteSubscription

  • Delete a subscription. Check out the docs for more info

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteSubscriptionBundleItem

  • Delete a subscription bundle item. Check out the docs for more info

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • bundleID: string

      ID of the bundle.

    • bundleItemID: string

      ID of the bundle item.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

DeleteSubscriptionItem

  • Delete a subscription item. Check out the docs for more info

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • subscriptionItemID: string

      ID of the subscription item.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

Get

GetAddress

  • Get a single address. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • addressID: string

      ID of the address.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TBuyerAddress>>

GetCatalog

  • Get a single catalog. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TCatalog extends Catalog<any, TCatalog>

    Parameters

    • catalogID: string

      ID of the catalog.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TCatalog>>

GetCategory

  • Get a single category. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TCategory extends Category<any, TCategory>

    Parameters

    • categoryID: string

      ID of the category.

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

        ID of the catalog.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TCategory>>

GetCreditCard

  • Get a single credit card. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • creditcardID: string

      ID of the creditcard.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TBuyerCreditCard>>

GetProduct

  • Get a single product. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TBuyerProduct extends BuyerProduct<any, any, TBuyerProduct>

    Parameters

    • productID: string

      ID of the product.

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

        ID of the seller.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TBuyerProduct>>

GetProductCollection

  • Get a single product collection. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TProductCollection>>

GetProductCollectionInvitation

  • Get a single product collection invitation. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • invitationID: string

      ID of the invitation.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TProductCollectionInvitation>>

GetPromotion

  • Get a single promotion. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TPromotion extends Promotion<any, TPromotion>

    Parameters

    • promotionID: string

      ID of the promotion.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TPromotion>>

GetShipment

  • Get a single shipment. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TShipment extends Shipment<any, any, any, TShipment>

    Parameters

    • shipmentID: string

      ID of the shipment.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TShipment>>

GetSpec

  • Get a single spec. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TSpec extends Spec<any, any, TSpec>

    Parameters

    • productID: string

      ID of the product.

    • specID: string

      ID of the spec.

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

        ID of the catalog.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TSpec>>

GetSpendingAccount

  • Get a single spending account. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • spendingAccountID: string

      ID of the spending account.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TSpendingAccount>>

GetSubscription

  • Get a single subscription. Check out the docs for more info

    Type Parameters

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TSubscription>>

GetSubscriptionItem

  • Get a single subscription item. Check out the docs for more info

    Type Parameters

    • TLineItem extends LineItem<any, any, any, any, any, TLineItem>

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • subscriptionItemID: string

      ID of the subscription item.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TLineItem>>

GetVariant

  • Get a single variant. Only available to Buyer Users. 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>>

ListAddresses

  • Get a list of addresses visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[];
          sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TBuyerAddress>>>

ListApprovableOrders

  • Get a list of orders that this user can approve. Check out the docs for more info

    Type Parameters

    • TOrder extends Order<any, any, any, TOrder>

    Parameters

    • listOptions: {
          filters?: Filters;
          from?: string;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[];
          sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "Gratuity" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!Gratuity" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[];
          to?: string;
      } = {}
      • 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 from?: string

        Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

      • Optional page?: number

        Page of results to return. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "Gratuity" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!Gratuity" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[]

        Comma-delimited list of fields to sort by.

      • Optional to?: string

        Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TOrder>>>

ListBuyerSellers

  • Get a list of sellers this user can purchase from. Organizations you can place orders directly to. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          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. Default: 1. 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. Default: 20, max: 100.

      • 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")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TBuyerSupplier>>>

ListCatalogs

  • Get a list of catalogs visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TCatalog extends Catalog<any, TCatalog>

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name" | "Description")[];
          sellerID?: string;
          sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

      • Optional sellerID?: string

        ID of the seller.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TCatalog>>>

ListCategories

  • Get a list of categories visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TCategory extends Category<any, TCategory>

    Parameters

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

        The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported.

      • Optional depth?: string

        Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1.

      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional productID?: string

        ID of the product.

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

ListCostCenters

  • Get a list of cost centers visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • 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. Default: 1. 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. Default: 20, max: 100.

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

ListCreditCards

  • Get a list of credit cards visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate")[];
          sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TBuyerCreditCard>>>

ListOrders

  • Get a list of orders visible to this user. List orders created by this user. Check out the docs for more info

    Type Parameters

    • TOrder extends Order<any, any, any, TOrder>

    Parameters

    • listOptions: {
          filters?: Filters;
          from?: string;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[];
          searchType?: SearchType;
          sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "Gratuity" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!Gratuity" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[];
          to?: string;
      } = {}
      • 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 from?: string

        Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

      • Optional page?: number

        Page of results to return. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[]

        Comma-delimited list of fields to search on.

      • Optional searchType?: SearchType

        Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.

      • Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "Gratuity" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!Gratuity" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[]

        Comma-delimited list of fields to sort by.

      • Optional to?: string

        Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TOrder>>>

ListProductCollectionEntries

  • Get a list of product collection entries visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TBuyerProduct extends BuyerProduct<any, any, TBuyerProduct>

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: string[];
          searchType?: SearchType;
          sortBy?: string[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • 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. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.

      • Optional sortBy?: string[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

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

ListProductCollectionInvitations

  • Get a list of product collection invitations visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          searchType?: SearchType;
          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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

      • Optional searchType?: SearchType

        Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TProductCollectionInvitation>>>

ListProductCollections

  • Get a list of product collections visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          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. Default: 1. 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. Default: 20, max: 100.

      • 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")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TProductCollection>>>

ListProductInventoryRecords

  • Get a list of product inventory records visible to this user. Only available to Buyer Users. 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" | "AddressID")[];
          sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>

ListProductSellers

  • Get a list of product sellers visible to this user. Only available to Buyer Users. 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" | "Description" | "ParentID")[];
          sortBy?: ("ID" | "Name" | "ParentID" | "!ID" | "!Name" | "OwnerID" | "!OwnerID" | "!ParentID")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TProductSeller>>>

ListProducts

  • Get a list of products visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TBuyerProduct extends BuyerProduct<any, any, TBuyerProduct>

    Parameters

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

        ID of the catalog.

      • Optional categoryID?: string

        ID of the category.

      • Optional depth?: string

        Indicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'.

      • 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. Default: 1. 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. Default: 20, max: 100.

      • 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. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.

      • Optional sellerID?: string

        ID of the seller.

      • Optional sortBy?: string[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

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

ListPromotions

  • Get a list of promotions visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TPromotion extends Promotion<any, TPromotion>

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
          sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TPromotion>>>

ListShipmentItems

  • Get a list of shipment items visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TShipmentItem extends ShipmentItem<any, any, any, TShipmentItem>

    Parameters

    • shipmentID: string

      ID of the shipment.

    • listOptions: {
          filters?: Filters;
          orderID?: string;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[];
          sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[];
      } = {}
      • 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 orderID?: string

        ID of the order.

      • Optional page?: number

        Page of results to return. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TShipmentItem>>>

ListShipments

  • Get a list of shipments visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TShipment extends Shipment<any, any, any, TShipment>

    Parameters

    • listOptions: {
          filters?: Filters;
          orderID?: string;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[];
          sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[];
      } = {}
      • 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 orderID?: string

        ID of the order.

      • Optional page?: number

        Page of results to return. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TShipment>>>

ListSpecs

  • Get a list of specs visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TSpec extends Spec<any, any, TSpec>

    Parameters

    • productID: string

      ID of the product.

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

        ID of the catalog.

      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TSpec>>>

ListSpendingAccounts

  • Get a list of spending accounts visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "Name")[];
          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. Default: 1. 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. Default: 20, max: 100.

      • 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")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>

ListSubscriptionItems

  • Get a list of subscription items visible to this user. Check out the docs for more info

    Type Parameters

    • TLineItem extends LineItem<any, any, any, any, any, TLineItem>

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "ProductID")[];
          sortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TLineItem>>>

ListSubscriptions

  • Get a list of subscriptions visible to this user. Check out the docs for more info

    Type Parameters

    Parameters

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
          sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

      • Optional searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[]

        Comma-delimited list of fields to search on.

      • Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[]

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TSubscription>>>

ListUserGroups

  • Get a list of user groups visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    • TUserGroup extends UserGroup<any, TUserGroup>

    Parameters

    • 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. Default: 1. 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. Default: 20, max: 100.

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

ListVariantInventoryRecords

  • Get a list of variant inventory records visible to this user. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • productID: string

      ID of the product.

    • variantID: string

      ID of the variant.

    • listOptions: {
          filters?: Filters;
          page?: number;
          pageSize?: number;
          search?: string;
          searchOn?: ("ID" | "AddressID")[];
          sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>

ListVariants

  • Get a list of variants visible to this user. Only available to Buyer Users. 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" | "ParentID")[];
          sortBy?: ("ID" | "Name" | "ParentID" | "!ID" | "!Name" | "OwnerID" | "!OwnerID" | "!ParentID")[];
      } = {}
      • 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. Default: 1. 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. Default: 20, max: 100.

      • Optional search?: string

        Word or phrase to search for.

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

        Comma-delimited list of fields to search on.

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

        Comma-delimited list of fields to sort by.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredObjectDeep<ListPage<TVariant>>>

Patch

PatchAddress

PatchCreditCard

PatchProductCollection

PatchProductCollectionInvitation

PatchSubscription

PatchSubscriptionItem

  • Partially update a subscription item. Check out the docs for more info

    Type Parameters

    • TLineItem extends LineItem<any, any, any, any, any, TLineItem>

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • subscriptionItemID: string

      ID of the subscription item.

    • lineItem: PartialObjectDeep<LineItem<any, any, any, any, any>>
    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TLineItem>>

Register

  • Register a User. Check out the docs for more info

    Type Parameters

    Parameters

    • meUser: MeUser<any>

      Required fields: Username, FirstName, LastName, Email, Active

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

        Anon user token of the user.

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TAccessTokenBasic>>

ResetPasswordByToken

RevokeTokens

  • Revokes all tokens previously issued to the current user and forces them to reauthenticate. Check out the docs for more info

    Parameters

    Returns Promise<void>

Save

  • Update the Currently Authenticated User If an object with the same ID already exists, it will be overwritten. Check out the docs for more info

    Type Parameters

    • TMeUser extends MeUser<any, TMeUser>

    Parameters

    • meUser: MeUser<any>

      Required fields: Username, FirstName, LastName, Email, Active

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TMeUser>>

SaveAddress

  • Update an address. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • addressID: string

      ID of the address.

    • buyerAddress: BuyerAddress<any>

      Required fields: Street1, City, State, Zip, Country

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TBuyerAddress>>

SaveCreditCard

SaveProductCollection

  • Create or update a product collection. Only available to Buyer Users. Check out the docs for more info

    Type Parameters

    Parameters

    • productCollectionID: string

      ID of the product collection.

    • productCollection: ProductCollection<any>

      Required fields: Name

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TProductCollection>>

SaveSubscription

  • Create or update a subscription. Check out the docs for more info

    Type Parameters

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • subscription: Subscription<any>

      Required fields: Frequency, Interval, NextOrderDate

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TSubscription>>

SaveSubscriptionItem

  • Create or update a subscription item. Check out the docs for more info

    Type Parameters

    • TLineItem extends LineItem<any, any, any, any, any, TLineItem>

    Parameters

    • subscriptionID: string

      ID of the subscription.

    • subscriptionItemID: string

      ID of the subscription item.

    • lineItem: LineItem<any, any, any, any, any>

      Required fields: ProductID

    • requestOptions: RequestOptions = {}

    Returns Promise<RequiredDeep<TLineItem>>

TransferAnonUserOrder

  • Transfer an order. If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them. Check out the docs for more info

    Parameters

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

        Anon user token of the me.

    • requestOptions: RequestOptions = {}

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc