Private
impersonatingID of the product collection.
ID of the invitation.
Create a new address. Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them. Check out the docs for more info
Required fields: Street1, City, State, Zip, Country
Create a new credit card. Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them. Check out the docs for more info
Create a new product collection. Only available to Buyer Users. Check out the docs for more info
Required fields: Name
Create a new product collection entry. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
ID of the product.
Create a new product collection invitation. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Required fields: Name
Create a new subscription. Check out the docs for more info
Required fields: Frequency, Interval, NextOrderDate
Create a new subscription bundle item. Check out the docs for more info
ID of the subscription.
ID of the bundle.
Create a new subscription item. Check out the docs for more info
ID of the subscription.
Required fields: ProductID
Decline a product collection invitation. Check out the docs for more info
ID of the product collection.
ID of the invitation.
Delete an address. Only available to Buyer Users. Check out the docs for more info
ID of the address.
Delete a credit card. Only available to Buyer Users. Check out the docs for more info
ID of the creditcard.
Delete a product collection. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Delete a product collection entry. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
ID of the product.
Delete a product collection invitation. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
ID of the invitation.
Delete a subscription. Check out the docs for more info
ID of the subscription.
Delete a subscription bundle item. Check out the docs for more info
ID of the subscription.
ID of the bundle.
ID of the bundle item.
Delete a subscription item. Check out the docs for more info
ID of the subscription.
ID of the subscription item.
Get the Current Authenticated User Check out the docs for more info
Get a single address. Only available to Buyer Users. Check out the docs for more info
ID of the address.
Get a single catalog. Only available to Buyer Users. Check out the docs for more info
ID of the catalog.
Get a single category. Only available to Buyer Users. Check out the docs for more info
ID of the category.
Optional
catalogID?: stringID of the catalog.
Get a single credit card. Only available to Buyer Users. Check out the docs for more info
ID of the creditcard.
Get a single product. Only available to Buyer Users. Check out the docs for more info
ID of the product.
Optional
sellerID?: stringID of the seller.
Get a single product collection. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Get a single product collection invitation. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
ID of the invitation.
Get a single promotion. Only available to Buyer Users. Check out the docs for more info
ID of the promotion.
Get a single shipment. Only available to Buyer Users. Check out the docs for more info
ID of the shipment.
Get a single spec. Only available to Buyer Users. Check out the docs for more info
ID of the product.
ID of the spec.
Optional
catalogID?: stringID of the catalog.
Get a single spending account. Only available to Buyer Users. Check out the docs for more info
ID of the spending account.
Get a single subscription. Check out the docs for more info
ID of the subscription.
Get a single subscription item. Check out the docs for more info
ID of the subscription.
ID of the subscription item.
Get a single variant. Only available to Buyer Users. Check out the docs for more info
ID of the product.
ID of the variant.
Get a list of addresses visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of orders that this user can approve. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
from?: stringLower bound of date range that the order was created (if outgoing) or submitted (if incoming).
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Optional
to?: stringUpper bound of date range that the order was created (if outgoing) or submitted (if incoming).
Get a list of sellers this user can purchase from. Organizations you can place orders directly to. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of catalogs visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sellerID?: stringID of the seller.
Optional
sortComma-delimited list of fields to sort by.
Get a list of categories visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
catalogID?: stringThe user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported.
Optional
depth?: stringIndicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
productID?: stringID of the product.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of cost centers visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of credit cards visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of orders visible to this user. List orders created by this user. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
from?: stringLower bound of date range that the order was created (if outgoing) or submitted (if incoming).
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
searchType of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.
Optional
sortComma-delimited list of fields to sort by.
Optional
to?: stringUpper bound of date range that the order was created (if outgoing) or submitted (if incoming).
Get a list of product collection entries visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
searchType of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.
Optional
sortComma-delimited list of fields to sort by.
Get a list of product collection invitations visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
searchType of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.
Optional
sortComma-delimited list of fields to sort by.
Get a list of product collections visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of product inventory records visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of product sellers visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of products visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
catalogID?: stringID of the catalog.
Optional
categoryID?: stringID of the category.
Optional
depth?: stringIndicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
searchType of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.
Optional
sellerID?: stringID of the seller.
Optional
sortComma-delimited list of fields to sort by.
Get a list of promotions visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of shipment items visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the shipment.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
orderID?: stringID of the order.
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of shipments visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
orderID?: stringID of the order.
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of specs visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product.
Optional
catalogID?: stringID of the catalog.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of spending accounts visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of subscription items visible to this user. Check out the docs for more info
ID of the subscription.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of subscriptions visible to this user. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of user groups visible to this user. Only available to Buyer Users. Check out the docs for more info
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of variant inventory records visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product.
ID of the variant.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Get a list of variants visible to this user. Only available to Buyer Users. Check out the docs for more info
ID of the product.
Optional
filters?: FiltersAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
Optional
page?: numberPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
Optional
pageNumber of results to return per page. Default: 20, max: 100.
Optional
search?: stringWord or phrase to search for.
Optional
searchComma-delimited list of fields to search on.
Optional
sortComma-delimited list of fields to sort by.
Patch the Currently Authenticated User. Check out the docs for more info
Partially update an address. Only available to Buyer Users. Check out the docs for more info
ID of the address.
Partially update a credit card. Only available to Buyer Users. Check out the docs for more info
ID of the creditcard.
Partially update a product collection. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Partially update a product collection invitation. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
ID of the invitation.
Partially update a subscription. Check out the docs for more info
ID of the subscription.
Partially update a subscription item. Check out the docs for more info
ID of the subscription.
ID of the subscription item.
Register a User. Check out the docs for more info
Required fields: Username, FirstName, LastName, Email, Active
Optional
anonAnon user token of the user.
Reset a password by token. Check out the docs for more info
Required fields: NewPassword
Revokes all tokens previously issued to the current user and forces them to reauthenticate. Check out the docs for more info
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
Required fields: Username, FirstName, LastName, Email, Active
Update an address. Only available to Buyer Users. Check out the docs for more info
ID of the address.
Required fields: Street1, City, State, Zip, Country
Update a credit card. Only available to Buyer Users. Check out the docs for more info
ID of the creditcard.
Create or update a product collection. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Required fields: Name
Create or update a product collection entry. Only available to Buyer Users. Check out the docs for more info
ID of the product collection.
Required fields: ProductID
Create or update a subscription. Check out the docs for more info
ID of the subscription.
Required fields: Frequency, Interval, NextOrderDate
Create or update a subscription item. Check out the docs for more info
ID of the subscription.
ID of the subscription item.
Required fields: ProductID
Transfer an order. If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them. Check out the docs for more info
Optional
anonAnon user token of the me.
Generated using TypeDoc
Accept a product collection invitation. Check out the docs for more info