Class Me

Index

Methods

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

Methods

AcceptProductCollectionInvitation

AcceptProductCollectionInvitation(
    productCollectionID: string,
    invitationID: string,
    requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1098

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
Me.As().List() // lists Me using the impersonated users' token
```
- Defined in api/Me.ts:2006

CreateAddress

CreateAddress<TBuyerAddress extends BuyerAddress<any>>(
buyerAddress: BuyerAddress,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerAddress>>
Create an 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
- TBuyerAddress extends BuyerAddress<any>
Parameters
- buyerAddress: BuyerAddress
  Required fields: Street1, City, Country
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerAddress>>
- Defined in api/Me.ts:228

CreateCreditCard

CreateCreditCard<TBuyerCreditCard extends BuyerCreditCard<any>>(
buyerCreditCard: BuyerCreditCard,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerCreditCard>>
Create a 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
- TBuyerCreditCard extends BuyerCreditCard<any>
Parameters
- buyerCreditCard: BuyerCreditCard
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerCreditCard>>
- Defined in api/Me.ts:486

CreateGroupOrderInvitation

CreateGroupOrderInvitation<
    TGroupOrderInvitation extends GroupOrderInvitation<any>,
>(
    groupOrderInvitation: GroupOrderInvitation,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TGroupOrderInvitation>>
Create a group order invitation A group order invitation allows other users to contribute to an existing order. Contributors may request an access token with the invitation ID that allows them to add line items and modify those line items. Check out the docs for more info
Type Parameters
- TGroupOrderInvitation extends GroupOrderInvitation<any>
Parameters
- groupOrderInvitation: GroupOrderInvitation
  Required fields: ExpirationDate, OrderID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TGroupOrderInvitation>>
- Defined in api/Me.ts:619

CreateProductCollection

CreateProductCollection<TProductCollection extends ProductCollection<any>>(
productCollection: ProductCollection,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollection>>
Create a product collection Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollection extends ProductCollection<any>
Parameters
- productCollection: ProductCollection
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollection>>
- Defined in api/Me.ts:829

CreateProductCollectionEntry

CreateProductCollectionEntry(
    productCollectionID: string,
    productID: string,
    requestOptions?: RequestOptions,
): Promise<void>
Create 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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:937

CreateProductCollectionInvitation

CreateProductCollectionInvitation<
    TProductCollectionInvitation extends ProductCollectionInvitation<any>,
>(
    productCollectionID: string,
    productCollectionInvitation: ProductCollectionInvitation,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollectionInvitation>>
Create a product collection invitation Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollectionInvitation extends ProductCollectionInvitation<any>
Parameters
- productCollectionID: string
  ID of the product collection.
- productCollectionInvitation: ProductCollectionInvitation
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollectionInvitation>>
- Defined in api/Me.ts:1009

CreateSubscription

CreateSubscription<TSubscription extends Subscription<any>>(
subscription: Subscription,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Create a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscription: Subscription
  Required fields: Frequency, Interval, NextOrderDate
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSubscription>>
- Defined in api/Me.ts:1670

CreateSubscriptionBundleItem

CreateSubscriptionBundleItem<
    TLineItem extends LineItem<any, any, any, any, any>,
>(
    subscriptionID: string,
    bundleID: string,
    bundleItems: BundleItems,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TLineItem>>
Create a subscription bundle item Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
Parameters
- subscriptionID: string
  ID of the subscription.
- bundleID: string
  ID of the bundle.
- bundleItems: BundleItems
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/Me.ts:1918

CreateSubscriptionItem

CreateSubscriptionItem<TLineItem extends LineItem<any, any, any, any, any>>(
    subscriptionID: string,
    lineItem: LineItem,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TLineItem>>
Create a subscription item Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
Parameters
- subscriptionID: string
  ID of the subscription.
- lineItem: LineItem
  Required fields: ProductID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/Me.ts:1805

DeclineProductCollectionInvitation

DeclineProductCollectionInvitation(
    productCollectionID: string,
    invitationID: string,
    requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1120

DeleteAddress

DeleteAddress(addressID: string, requestOptions?: RequestOptions): Promise<void>
Delete an address Only available to Buyer Users. Check out the docs for more info
Parameters
- addressID: string
  ID of the address.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:292

DeleteCreditCard

DeleteCreditCard(
creditcardID: string,
requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:550

DeleteGroupOrderInvitation

DeleteGroupOrderInvitation(
invitationID: string,
requestOptions?: RequestOptions,
): Promise<void>
Delete a group order invitation Check out the docs for more info
Parameters
- invitationID: string
  ID of the invitation.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:661

DeleteProductCollection

DeleteProductCollection(
productCollectionID: string,
requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:893

DeleteProductCollectionEntry

DeleteProductCollectionEntry(
    productCollectionID: string,
    productID: string,
    requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:959

DeleteProductCollectionInvitation

DeleteProductCollectionInvitation(
    productCollectionID: string,
    invitationID: string,
    requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1053

DeleteSubscription

DeleteSubscription(
subscriptionID: string,
requestOptions?: RequestOptions,
): Promise<void>
Delete a subscription Check out the docs for more info
Parameters
- subscriptionID: string
  ID of the subscription.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1734

DeleteSubscriptionBundleItem

DeleteSubscriptionBundleItem(
    subscriptionID: string,
    bundleID: string,
    bundleItemID: string,
    requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1941

DeleteSubscriptionItem

DeleteSubscriptionItem(
    subscriptionID: string,
    subscriptionItemID: string,
    requestOptions?: RequestOptions,
): Promise<void>
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1872

Get

Get<TMeUser extends MeUser<any>>(
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TMeUser>>
Get the currently authenticated user Check out the docs for more info
Type Parameters
- TMeUser extends MeUser<any>
Parameters
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TMeUser>>
- Defined in api/Me.ts:139

GetAddress

GetAddress<TBuyerAddress extends BuyerAddress<any>>(
addressID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerAddress>>
Retrieve an address Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerAddress extends BuyerAddress<any>
Parameters
- addressID: string
  ID of the address.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerAddress>>
- Defined in api/Me.ts:249

GetCatalog

GetCatalog<TCatalog extends Catalog<any>>(
catalogID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TCatalog>>
Retrieve a catalog Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any>
Parameters
- catalogID: string
  ID of the catalog.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TCatalog>>
- Defined in api/Me.ts:362

GetCategory

GetCategory<TCategory extends Category<any>>(
    categoryID: string,
    listOptions?: { catalogID?: string },
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TCategory>>
Retrieve a category Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TCategory extends Category<any>
Parameters
- categoryID: string
  ID of the category.
- listOptions: { catalogID?: string } = {}
  - OptionalcatalogID?: string
    
    ID of the catalog.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TCategory>>
- Defined in api/Me.ts:413

GetCreditCard

GetCreditCard<TBuyerCreditCard extends BuyerCreditCard<any>>(
creditcardID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerCreditCard>>
Retrieve a credit card Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerCreditCard extends BuyerCreditCard<any>
Parameters
- creditcardID: string
  ID of the creditcard.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerCreditCard>>
- Defined in api/Me.ts:507

GetGroupOrderInvitation

GetGroupOrderInvitation<TGroupOrderInvitation extends GroupOrderInvitation<any>>(
invitationID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TGroupOrderInvitation>>
Retrieve a group order invitation Check out the docs for more info
Type Parameters
- TGroupOrderInvitation extends GroupOrderInvitation<any>
Parameters
- invitationID: string
  ID of the invitation.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TGroupOrderInvitation>>
- Defined in api/Me.ts:640

GetProduct

GetProduct<TBuyerProduct extends BuyerProduct<any, any>>(
    productID: string,
    listOptions?: { sellerID?: string },
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerProduct>>
Retrieve a product Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerProduct extends BuyerProduct<any, any>
Parameters
- productID: string
  ID of the product.
- listOptions: { sellerID?: string } = {}
  - OptionalsellerID?: string
    
    ID of the seller.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerProduct>>
- Defined in api/Me.ts:1223

GetProductCollection

GetProductCollection<TProductCollection extends ProductCollection<any>>(
productCollectionID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollection>>
Retrieve a product collection Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollection extends ProductCollection<any>
Parameters
- productCollectionID: string
  ID of the product collection.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollection>>
- Defined in api/Me.ts:850

GetProductCollectionInvitation

GetProductCollectionInvitation<
    TProductCollectionInvitation extends ProductCollectionInvitation<any>,
>(
    productCollectionID: string,
    invitationID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollectionInvitation>>
Retrieve a product collection invitation Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollectionInvitation extends ProductCollectionInvitation<any>
Parameters
- productCollectionID: string
  ID of the product collection.
- invitationID: string
  ID of the invitation.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollectionInvitation>>
- Defined in api/Me.ts:1031

GetPromotion

GetPromotion<TPromotion extends Promotion<any>>(
promotionID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TPromotion>>
Retrieve a promotion Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any>
Parameters
- promotionID: string
  ID of the promotion.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TPromotion>>
- Defined in api/Me.ts:1454

GetShipment

GetShipment<TShipment extends Shipment<any, any, any>>(
shipmentID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TShipment>>
Retrieve a shipment Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any>
Parameters
- shipmentID: string
  ID of the shipment.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Me.ts:1550

GetSpec

GetSpec<TSpec extends Spec<any, any>>(
    productID: string,
    specID: string,
    listOptions?: { catalogID?: string },
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSpec>>
Retrieve a spec Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TSpec extends Spec<any, any>
Parameters
- productID: string
  ID of the product.
- specID: string
  ID of the spec.
- listOptions: { catalogID?: string } = {}
  - OptionalcatalogID?: string
    
    ID of the catalog.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSpec>>
- Defined in api/Me.ts:1329

GetSpendingAccount

GetSpendingAccount<TSpendingAccount extends SpendingAccount<any>>(
spendingAccountID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSpendingAccount>>
Retrieve a spending account Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- spendingAccountID: string
  ID of the spending account.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSpendingAccount>>
- Defined in api/Me.ts:1623

GetSubscription

GetSubscription<TSubscription extends Subscription<any>>(
subscriptionID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Retrieve a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscriptionID: string
  ID of the subscription.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSubscription>>
- Defined in api/Me.ts:1691

GetSubscriptionItem

GetSubscriptionItem<TLineItem extends LineItem<any, any, any, any, any>>(
    subscriptionID: string,
    subscriptionItemID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TLineItem>>
Retrieve a subscription item Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscriptionItemID: string
  ID of the subscription item.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/Me.ts:1827

GetVariant

GetVariant<TVariant extends Variant<any>>(
    productID: string,
    variantID: string,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TVariant>>
Retrieve a variant Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TVariant extends Variant<any>
Parameters
- productID: string
  ID of the product.
- variantID: string
  ID of the variant.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TVariant>>
- Defined in api/Me.ts:1378

ListAddresses

ListAddresses<TBuyerAddress extends BuyerAddress<any>>(
    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"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TBuyerAddress>>>
List addresses visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerAddress extends BuyerAddress<any>
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"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: (
        | "ID"
        | "AddressName"
        | "CompanyName"
        | "City"
        | "Street1"
        | "Street2"
        | "LastName"
        | "FirstName"
        | "State"
        | "Zip"
    )[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TBuyerAddress>>>
- Defined in api/Me.ts:207

ListApprovableOrders

ListApprovableOrders<TOrder extends Order<any, any, any>>(
    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"
            | "Fees"
            | "BaseDiscount"
            | "PromotionDiscount"
            | "Total"
            | "IsSubmitted"
            | "!DateSubmitted"
            | "!FromCompanyID"
            | "!ToCompanyID"
            | "!FromUserID"
            | "!Status"
            | "!DateApproved"
            | "!DateDeclined"
            | "!DateCanceled"
            | "!DateCompleted"
            | "!LastUpdated"
            | "!Subtotal"
            | "!ShippingCost"
            | "!TaxCost"
            | "!Gratuity"
            | "!Fees"
            | "!BaseDiscount"
            | "!PromotionDiscount"
            | "!Total"
            | "!IsSubmitted"
        )[];
        to?: string;
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TOrder>>>
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>
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"
          | "Fees"
          | "BaseDiscount"
          | "PromotionDiscount"
          | "Total"
          | "IsSubmitted"
          | "!DateSubmitted"
          | "!FromCompanyID"
          | "!ToCompanyID"
          | "!FromUserID"
          | "!Status"
          | "!DateApproved"
          | "!DateDeclined"
          | "!DateCanceled"
          | "!DateCompleted"
          | "!LastUpdated"
          | "!Subtotal"
          | "!ShippingCost"
          | "!TaxCost"
          | "!Gratuity"
          | "!Fees"
          | "!BaseDiscount"
          | "!PromotionDiscount"
          | "!Total"
          | "!IsSubmitted"
      )[];
      to?: string;
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalfrom?: string
    
    Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "FromCompanyID"
        | "ToCompanyID"
        | "DateCreated"
        | "!ID"
        | "!DateCreated"
        | "DateSubmitted"
        | "FromUserID"
        | "Status"
        | "DateApproved"
        | "DateDeclined"
        | "DateCanceled"
        | "DateCompleted"
        | "LastUpdated"
        | "Subtotal"
        | "ShippingCost"
        | "TaxCost"
        | "Gratuity"
        | "Fees"
        | "BaseDiscount"
        | "PromotionDiscount"
        | "Total"
        | "IsSubmitted"
        | "!DateSubmitted"
        | "!FromCompanyID"
        | "!ToCompanyID"
        | "!FromUserID"
        | "!Status"
        | "!DateApproved"
        | "!DateDeclined"
        | "!DateCanceled"
        | "!DateCompleted"
        | "!LastUpdated"
        | "!Subtotal"
        | "!ShippingCost"
        | "!TaxCost"
        | "!Gratuity"
        | "!Fees"
        | "!BaseDiscount"
        | "!PromotionDiscount"
        | "!Total"
        | "!IsSubmitted"
    )[]
    
    Comma-delimited list of fields to sort by.
  - Optionalto?: string
    
    Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TOrder>>>
- Defined in api/Me.ts:761

ListBuyerSellers

ListBuyerSellers<TBuyerSupplier extends BuyerSupplier>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TBuyerSupplier>>>
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
- TBuyerSupplier extends BuyerSupplier
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TBuyerSupplier>>>
- Defined in api/Me.ts:1502

ListCatalogs

ListCatalogs<TCatalog extends Catalog<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sellerID?: string;
        sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TCatalog>>>
List catalogs visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TCatalog extends Catalog<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sellerID?: string;
      sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsellerID?: string
    
    ID of the seller.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name" | "OwnerID" | "!OwnerID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TCatalog>>>
- Defined in api/Me.ts:341

ListCategories<TCategory extends Category<any>>(
    listOptions?: {
        catalogID?: string;
        depth?: string;
        filters?: Filters;
        page?: number;
        pageSize?: number;
        productID?: string;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TCategory>>>
List categories visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TCategory extends Category<any>
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")[];
  } = {}
  - OptionalcatalogID?: 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.
  - Optionaldepth?: 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.
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - OptionalproductID?: string
    
    ID of the product.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TCategory>>>
- Defined in api/Me.ts:391

ListCostCenters

ListCostCenters<TCostCenter extends CostCenter<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TCostCenter>>>
List cost centers visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TCostCenter extends CostCenter<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TCostCenter>>>
- Defined in api/Me.ts:439

ListCreditCards

ListCreditCards<TBuyerCreditCard extends BuyerCreditCard<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: (
            "ID"
            | "CardholderName"
            | "CardType"
            | "ExpirationDate"
            | "Editable"
        )[];
        sortBy?: (
            | "ID"
            | "CardholderName"
            | "CardType"
            | "ExpirationDate"
            | "DateCreated"
            | "!ID"
            | "!DateCreated"
            | "!CardholderName"
            | "!CardType"
            | "!ExpirationDate"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TBuyerCreditCard>>>
List credit cards visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerCreditCard extends BuyerCreditCard<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: (
          "ID"
          | "CardholderName"
          | "CardType"
          | "ExpirationDate"
          | "Editable"
      )[];
      sortBy?: (
          | "ID"
          | "CardholderName"
          | "CardType"
          | "ExpirationDate"
          | "DateCreated"
          | "!ID"
          | "!DateCreated"
          | "!CardholderName"
          | "!CardType"
          | "!ExpirationDate"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "Editable")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "CardholderName"
        | "CardType"
        | "ExpirationDate"
        | "DateCreated"
        | "!ID"
        | "!DateCreated"
        | "!CardholderName"
        | "!CardType"
        | "!ExpirationDate"
    )[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TBuyerCreditCard>>>
- Defined in api/Me.ts:465

ListGroupOrderInvitations

ListGroupOrderInvitations<
    TGroupOrderInvitation extends GroupOrderInvitation<any>,
>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "OrderID" | "OrderStatus")[];
        sortBy?: (
            | "ID"
            | "Name"
            | "OrderID"
            | "OrderStatus"
            | "!ID"
            | "!Name"
            | "!OrderID"
            | "!OrderStatus"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TGroupOrderInvitation>>>
List group order invitations visible to this user Check out the docs for more info
Type Parameters
- TGroupOrderInvitation extends GroupOrderInvitation<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "OrderID" | "OrderStatus")[];
      sortBy?: (
          | "ID"
          | "Name"
          | "OrderID"
          | "OrderStatus"
          | "!ID"
          | "!Name"
          | "!OrderID"
          | "!OrderStatus"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "OrderID" | "OrderStatus")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "Name"
        | "OrderID"
        | "OrderStatus"
        | "!ID"
        | "!Name"
        | "!OrderID"
        | "!OrderStatus"
    )[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TGroupOrderInvitation>>>
- Defined in api/Me.ts:598

ListOrders

ListOrders<TOrder extends Order<any, any, any>>(
    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"
            | "Fees"
            | "BaseDiscount"
            | "PromotionDiscount"
            | "Total"
            | "IsSubmitted"
            | "!DateSubmitted"
            | "!FromCompanyID"
            | "!ToCompanyID"
            | "!FromUserID"
            | "!Status"
            | "!DateApproved"
            | "!DateDeclined"
            | "!DateCanceled"
            | "!DateCompleted"
            | "!LastUpdated"
            | "!Subtotal"
            | "!ShippingCost"
            | "!TaxCost"
            | "!Gratuity"
            | "!Fees"
            | "!BaseDiscount"
            | "!PromotionDiscount"
            | "!Total"
            | "!IsSubmitted"
        )[];
        to?: string;
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TOrder>>>
List 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>
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"
          | "Fees"
          | "BaseDiscount"
          | "PromotionDiscount"
          | "Total"
          | "IsSubmitted"
          | "!DateSubmitted"
          | "!FromCompanyID"
          | "!ToCompanyID"
          | "!FromUserID"
          | "!Status"
          | "!DateApproved"
          | "!DateDeclined"
          | "!DateCanceled"
          | "!DateCompleted"
          | "!LastUpdated"
          | "!Subtotal"
          | "!ShippingCost"
          | "!TaxCost"
          | "!Gratuity"
          | "!Fees"
          | "!BaseDiscount"
          | "!PromotionDiscount"
          | "!Total"
          | "!IsSubmitted"
      )[];
      to?: string;
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalfrom?: string
    
    Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsearchType?: SearchType
    
    Type of search to perform.
  - OptionalsortBy?: (
        | "ID"
        | "FromCompanyID"
        | "ToCompanyID"
        | "DateCreated"
        | "!ID"
        | "!DateCreated"
        | "DateSubmitted"
        | "FromUserID"
        | "Status"
        | "DateApproved"
        | "DateDeclined"
        | "DateCanceled"
        | "DateCompleted"
        | "LastUpdated"
        | "Subtotal"
        | "ShippingCost"
        | "TaxCost"
        | "Gratuity"
        | "Fees"
        | "BaseDiscount"
        | "PromotionDiscount"
        | "Total"
        | "IsSubmitted"
        | "!DateSubmitted"
        | "!FromCompanyID"
        | "!ToCompanyID"
        | "!FromUserID"
        | "!Status"
        | "!DateApproved"
        | "!DateDeclined"
        | "!DateCanceled"
        | "!DateCompleted"
        | "!LastUpdated"
        | "!Subtotal"
        | "!ShippingCost"
        | "!TaxCost"
        | "!Gratuity"
        | "!Fees"
        | "!BaseDiscount"
        | "!PromotionDiscount"
        | "!Total"
        | "!IsSubmitted"
    )[]
    
    Comma-delimited list of fields to sort by.
  - Optionalto?: string
    
    Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TOrder>>>
- Defined in api/Me.ts:712

ListProductCollectionEntries

ListProductCollectionEntries<
    TProductCollectionBuyerProduct extends
        ProductCollectionBuyerProduct<any, any>,
>(
    productCollectionID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: string[];
        searchType?: SearchType;
        sortBy?: string[];
    },
    requestOptions?: RequestOptions,
): Promise<
    RequiredObjectDeep<
        ListPageWithFacets<TProductCollectionBuyerProduct, any>,
    >,
>
List product collection entries visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollectionBuyerProduct extends ProductCollectionBuyerProduct<any, any>
Parameters
- productCollectionID: string
  ID of the product collection.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: string[];
      searchType?: SearchType;
      sortBy?: string[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: string[]
    
    Comma-delimited list of fields to search on.
  - OptionalsearchType?: SearchType
    
    Type of search to perform.
  - OptionalsortBy?: string[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<
    RequiredObjectDeep<
        ListPageWithFacets<TProductCollectionBuyerProduct, any>,
    >,
>
- Defined in api/Me.ts:1148

ListProductCollectionInvitations

ListProductCollectionInvitations<
    TProductCollectionInvitation extends ProductCollectionInvitation<any>,
>(
    productCollectionID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        searchType?: SearchType;
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TProductCollectionInvitation>>>
List product collection invitations visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollectionInvitation extends ProductCollectionInvitation<any>
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")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsearchType?: SearchType
    
    Type of search to perform.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TProductCollectionInvitation>>>
- Defined in api/Me.ts:987

ListProductCollections

ListProductCollections<TProductCollection extends ProductCollection<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TProductCollection>>>
List product collections visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollection extends ProductCollection<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TProductCollection>>>
- Defined in api/Me.ts:808

ListProductInventoryRecords

ListProductInventoryRecords<TInventoryRecord extends InventoryRecord<any, any>>(
    productID: string,
    listOptions?: {
        filters?: Filters;
        includeAddress?: boolean;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "AddressID")[];
        sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
List product inventory records visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any>
Parameters
- productID: string
  ID of the product.
- listOptions: {
      filters?: Filters;
      includeAddress?: boolean;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "AddressID")[];
      sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
  } = {}
  - Optionalfilters?: 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.???'
  - OptionalincludeAddress?: boolean
    
    Include address of the inventory record.
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "AddressID")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
- Defined in api/Me.ts:1251

ListProducts

ListProducts<TBuyerProduct extends BuyerProduct<any, any>>(
    listOptions?: {
        catalogID?: string;
        categoryID?: string;
        depth?: string;
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: string[];
        searchType?: SearchType;
        sellerID?: string;
        sortBy?: string[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPageWithFacets<TBuyerProduct, any>>>
List products visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerProduct extends BuyerProduct<any, any>
Parameters
- listOptions: {
      catalogID?: string;
      categoryID?: string;
      depth?: string;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: string[];
      searchType?: SearchType;
      sellerID?: string;
      sortBy?: string[];
  } = {}
  - OptionalcatalogID?: string
    
    ID of the catalog.
  - OptionalcategoryID?: string
    
    ID of the category.
  - Optionaldepth?: 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'.
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: string[]
    
    Comma-delimited list of fields to search on.
  - OptionalsearchType?: SearchType
    
    Type of search to perform.
  - OptionalsellerID?: string
    
    ID of the seller.
  - OptionalsortBy?: string[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPageWithFacets<TBuyerProduct, any>>>
- Defined in api/Me.ts:1201

ListProductSellers

ListProductSellers<TProductSeller extends ProductSeller<any>>(
    productID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TProductSeller>>>
List product sellers visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductSeller extends ProductSeller<any>
Parameters
- productID: string
  ID of the product.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TProductSeller>>>
- Defined in api/Me.ts:1278

ListPromotions

ListPromotions<TPromotion extends Promotion<any>>(
    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"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TPromotion>>>
List promotions visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any>
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"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: (
        | "ID"
        | "Name"
        | "Description"
        | "Code"
        | "FinePrint"
        | "EligibleExpression"
        | "ValueExpression"
    )[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TPromotion>>>
- Defined in api/Me.ts:1433

ListShipmentItems

ListShipmentItems<TShipmentItem extends ShipmentItem<any, any, any>>(
    shipmentID: string,
    listOptions?: {
        filters?: Filters;
        orderID?: string;
        page?: number;
        pageSize?: number;
        sortBy?: ("OrderID" | "!OrderID" | "LineItemID" | "!LineItemID")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TShipmentItem>>>
List 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>
Parameters
- shipmentID: string
  ID of the shipment.
- listOptions: {
      filters?: Filters;
      orderID?: string;
      page?: number;
      pageSize?: number;
      sortBy?: ("OrderID" | "!OrderID" | "LineItemID" | "!LineItemID")[];
  } = {}
  - Optionalfilters?: 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.???'
  - OptionalorderID?: string
    
    ID of the order.
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - OptionalsortBy?: ("OrderID" | "!OrderID" | "LineItemID" | "!LineItemID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TShipmentItem>>>
- Defined in api/Me.ts:1576

ListShipments

ListShipments<TShipment extends Shipment<any, any, any>>(
    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"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TShipment>>>
List 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>
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"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - OptionalorderID?: string
    
    ID of the order.
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: (
        | "ID"
        | "BuyerID"
        | "Shipper"
        | "DateShipped"
        | "DateDelivered"
        | "TrackingNumber"
    )[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "BuyerID"
        | "Shipper"
        | "DateShipped"
        | "DateDelivered"
        | "!ID"
        | "OwnerID"
        | "!OwnerID"
        | "!BuyerID"
        | "Cost"
        | "!DateShipped"
        | "!Shipper"
        | "!DateDelivered"
        | "!Cost"
    )[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TShipment>>>
- Defined in api/Me.ts:1529

ListSpecs

ListSpecs<TSpec extends Spec<any, any>>(
    productID: string,
    listOptions?: {
        catalogID?: string;
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSpec>>>
List specs visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TSpec extends Spec<any, any>
Parameters
- productID: string
  ID of the product.
- listOptions: {
      catalogID?: string;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[];
  } = {}
  - OptionalcatalogID?: string
    
    ID of the catalog.
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name" | "ListOrder" | "!ListOrder")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSpec>>>
- Defined in api/Me.ts:1306

ListSpendingAccounts

ListSpendingAccounts<TSpendingAccount extends SpendingAccount<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>
List spending accounts visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TSpendingAccount extends SpendingAccount<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSpendingAccount>>>
- Defined in api/Me.ts:1602

ListSubscriptionItems

ListSubscriptionItems<TLineItem extends LineItem<any, any, any, any, any>>(
    subscriptionID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "ProductID")[];
        sortBy?: (
            "ID"
            | "ProductID"
            | "!ID"
            | "DateAdded"
            | "!DateAdded"
            | "!ProductID"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TLineItem>>>
List subscription items visible to this user Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
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"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "ProductID")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "ProductID" | "!ID" | "DateAdded" | "!DateAdded" | "!ProductID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TLineItem>>>
- Defined in api/Me.ts:1783

ListSubscriptions

ListSubscriptions<TSubscription extends Subscription<any>>(
    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"
            | "!Interval"
            | "!NextOrderDate"
            | "!LastOrderDate"
            | "!EndDate"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSubscription>>>
List subscriptions visible to this user Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
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"
          | "!Interval"
          | "!NextOrderDate"
          | "!LastOrderDate"
          | "!EndDate"
      )[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "FromCompanyID"
        | "ToCompanyID"
        | "Interval"
        | "DateCreated"
        | "!ID"
        | "!DateCreated"
        | "FromUserID"
        | "!FromCompanyID"
        | "!ToCompanyID"
        | "!FromUserID"
        | "NextOrderDate"
        | "LastOrderDate"
        | "EndDate"
        | "!Interval"
        | "!NextOrderDate"
        | "!LastOrderDate"
        | "!EndDate"
    )[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSubscription>>>
- Defined in api/Me.ts:1649

ListUserGroups

ListUserGroups<TUserGroup extends UserGroup<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TUserGroup>>>
List user groups visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TUserGroup extends UserGroup<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TUserGroup>>>
- Defined in api/Me.ts:1987

ListVariantInventoryRecords

ListVariantInventoryRecords<TInventoryRecord extends InventoryRecord<any, any>>(
    productID: string,
    variantID: string,
    listOptions?: {
        filters?: Filters;
        includeAddress?: boolean;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "AddressID")[];
        sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
List variant inventory records visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any>
Parameters
- productID: string
  ID of the product.
- variantID: string
  ID of the variant.
- listOptions: {
      filters?: Filters;
      includeAddress?: boolean;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "AddressID")[];
      sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
  } = {}
  - Optionalfilters?: 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.???'
  - OptionalincludeAddress?: boolean
    
    Include address of the inventory record.
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "AddressID")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
- Defined in api/Me.ts:1407

ListVariants

ListVariants<TVariant extends Variant<any>>(
    productID: string,
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TVariant>>>
List variants visible to this user Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TVariant extends Variant<any>
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")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TVariant>>>
- Defined in api/Me.ts:1356

Patch

Patch<TMeUser extends MeUser<any>>(
meUser: PartialDeep<MeUser>,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TMeUser>>
Patch the currently authenticated user Check out the docs for more info
Type Parameters
- TMeUser extends MeUser<any>
Parameters
- meUser: PartialDeep<MeUser>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TMeUser>>
- Defined in api/Me.ts:181

PatchAddress

PatchAddress(
    addressID: string,
    buyerAddress: PartialDeep<BuyerAddress>,
    requestOptions?: RequestOptions,
): Promise<void>
Partially update an address Only available to Buyer Users. Check out the docs for more info
Parameters
- addressID: string
  ID of the address.
- buyerAddress: PartialDeep<BuyerAddress>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:314

PatchCreditCard

PatchCreditCard(
    creditcardID: string,
    buyerCreditCard: PartialDeep<BuyerCreditCard>,
    requestOptions?: RequestOptions,
): Promise<void>
Partially update a credit card Only available to Buyer Users. Check out the docs for more info
Parameters
- creditcardID: string
  ID of the creditcard.
- buyerCreditCard: PartialDeep<BuyerCreditCard>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:572

PatchGroupOrderInvitation

PatchGroupOrderInvitation<
    TGroupOrderInvitation extends GroupOrderInvitation<any>,
>(
    invitationID: string,
    groupOrderInvitation: PartialDeep<GroupOrderInvitation>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TGroupOrderInvitation>>
Partially update a group order invitation Check out the docs for more info
Type Parameters
- TGroupOrderInvitation extends GroupOrderInvitation<any>
Parameters
- invitationID: string
  ID of the invitation.
- groupOrderInvitation: PartialDeep<GroupOrderInvitation>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TGroupOrderInvitation>>
- Defined in api/Me.ts:683

PatchProductCollection

PatchProductCollection<TProductCollection extends ProductCollection<any>>(
    productCollectionID: string,
    productCollection: PartialDeep<ProductCollection>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollection>>
Partially update a product collection Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollection extends ProductCollection<any>
Parameters
- productCollectionID: string
  ID of the product collection.
- productCollection: PartialDeep<ProductCollection>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollection>>
- Defined in api/Me.ts:915

PatchProductCollectionInvitation

PatchProductCollectionInvitation<
    TProductCollectionInvitation extends ProductCollectionInvitation<any>,
>(
    productCollectionID: string,
    invitationID: string,
    productCollectionInvitation: PartialDeep<ProductCollectionInvitation>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollectionInvitation>>
Partially update a product collection invitation Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollectionInvitation extends ProductCollectionInvitation<any>
Parameters
- productCollectionID: string
  ID of the product collection.
- invitationID: string
  ID of the invitation.
- productCollectionInvitation: PartialDeep<ProductCollectionInvitation>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollectionInvitation>>
- Defined in api/Me.ts:1076

PatchSubscription

PatchSubscription<TSubscription extends Subscription<any>>(
    subscriptionID: string,
    subscription: PartialDeep<Subscription>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Partially update a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscription: PartialDeep<Subscription>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSubscription>>
- Defined in api/Me.ts:1756

PatchSubscriptionItem

PatchSubscriptionItem<TLineItem extends LineItem<any, any, any, any, any>>(
    subscriptionID: string,
    subscriptionItemID: string,
    lineItem: PartialDeep<LineItem>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TLineItem>>
Partially update a subscription item Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscriptionItemID: string
  ID of the subscription item.
- lineItem: PartialDeep<LineItem>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/Me.ts:1895

Register

Register<TAccessTokenBasic extends AccessTokenBasic>(
    meUser: MeUser,
    listOptions?: { anonUserToken?: string },
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TAccessTokenBasic>>
Register a user Check out the docs for more info
Type Parameters
- TAccessTokenBasic extends AccessTokenBasic
Parameters
- meUser: MeUser
  Required fields: Username, FirstName, LastName, Email, Active
- listOptions: { anonUserToken?: string } = {}
  - OptionalanonUserToken?: string
    
    Anon user token of the user.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TAccessTokenBasic>>
- Defined in api/Me.ts:1476

ResetPasswordByToken

ResetPasswordByToken(
tokenPasswordReset: TokenPasswordReset,
requestOptions?: RequestOptions,
): Promise<void>
Reset a password by token Check out the docs for more info
Parameters
- tokenPasswordReset: TokenPasswordReset
  Required fields: NewPassword
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:782

RevokeTokens

RevokeTokens(requestOptions?: RequestOptions): Promise<void>
Revoke tokens Revokes all tokens previously issued to the current user and forces them to reauthenticate. Check out the docs for more info
Parameters
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1961

Save

Save<TMeUser extends MeUser<any>>(
meUser: MeUser,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TMeUser>>
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>
Parameters
- meUser: MeUser
  Required fields: Username, FirstName, LastName, Email, Active
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TMeUser>>
- Defined in api/Me.ts:160

SaveAddress

SaveAddress<TBuyerAddress extends BuyerAddress<any>>(
    addressID: string,
    buyerAddress: BuyerAddress,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerAddress>>
Update an address Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerAddress extends BuyerAddress<any>
Parameters
- addressID: string
  ID of the address.
- buyerAddress: BuyerAddress
  Required fields: Street1, City, Country
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerAddress>>
- Defined in api/Me.ts:271

SaveCreditCard

SaveCreditCard<TBuyerCreditCard extends BuyerCreditCard<any>>(
    creditcardID: string,
    buyerCreditCard: BuyerCreditCard,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerCreditCard>>
Update a credit card Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TBuyerCreditCard extends BuyerCreditCard<any>
Parameters
- creditcardID: string
  ID of the creditcard.
- buyerCreditCard: BuyerCreditCard
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerCreditCard>>
- Defined in api/Me.ts:529

SaveProductCollection

SaveProductCollection<TProductCollection extends ProductCollection<any>>(
    productCollectionID: string,
    productCollection: ProductCollection,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TProductCollection>>
Create or update a product collection Only available to Buyer Users. Check out the docs for more info
Type Parameters
- TProductCollection extends ProductCollection<any>
Parameters
- productCollectionID: string
  ID of the product collection.
- productCollection: ProductCollection
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TProductCollection>>
- Defined in api/Me.ts:872

SaveProductCollectionEntry

SaveProductCollectionEntry(
    productCollectionID: string,
    productCollectionEntry: ProductCollectionEntry,
    requestOptions?: RequestOptions,
): Promise<void>
Create or update a product collection entry Only available to Buyer Users. Check out the docs for more info
Parameters
- productCollectionID: string
  ID of the product collection.
- productCollectionEntry: ProductCollectionEntry
  Required fields: ProductID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:1170

SaveSubscription

SaveSubscription<TSubscription extends Subscription<any>>(
    subscriptionID: string,
    subscription: Subscription,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Create or update a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscription: Subscription
  Required fields: Frequency, Interval, NextOrderDate
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSubscription>>
- Defined in api/Me.ts:1713

SaveSubscriptionItem

SaveSubscriptionItem<TLineItem extends LineItem<any, any, any, any, any>>(
    subscriptionID: string,
    subscriptionItemID: string,
    lineItem: LineItem,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TLineItem>>
Create or update a subscription item Check out the docs for more info
Type Parameters
- TLineItem extends LineItem<any, any, any, any, any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscriptionItemID: string
  ID of the subscription item.
- lineItem: LineItem
  Required fields: ProductID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TLineItem>>
- Defined in api/Me.ts:1850

TransferAnonUserOrder

TransferAnonUserOrder(
listOptions?: { anonUserToken?: string },
requestOptions?: RequestOptions,
): Promise<void>
Transfer an anon user 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 } = {}
  - OptionalanonUserToken?: string
    
    Anon user token of the me.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Me.ts:733

Class Me

Index

Methods

Methods

AcceptProductCollectionInvitation

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

As

Returns this

Description

Example

CreateAddress

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBuyerAddress>>

CreateCreditCard

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBuyerCreditCard>>

CreateGroupOrderInvitation

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TGroupOrderInvitation>>

CreateProductCollection

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TProductCollection>>

CreateProductCollectionEntry

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

CreateProductCollectionInvitation

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TProductCollectionInvitation>>

CreateSubscription

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSubscription>>

CreateSubscriptionBundleItem

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TLineItem>>

CreateSubscriptionItem

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TLineItem>>

DeclineProductCollectionInvitation

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string