Returns contents of the cart. See api docs.
Required token: Bearer token or Order token
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.show({
bearer_token: '7381273269536713689562374856'
})
// or guest user
const response = await client.cart.show({
order_token: '7381273269536713689562374856'
})
Adds a Product Variant to the Cart. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
variant_id: string
quantity: number
options?: {
[key: string]: string
}
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.addItem({
bearer_token: '7381273269536713689562374856',
variant_id: '1',
quantity: 1
})
// or guest user
const response = await client.cart.addItem({
order_token: '7381273269536713689562374856',
variant_id: '1',
quantity: 1
})
Sets the quantity of a given line item. It has to be a positive integer greater than 0. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
line_item_id: string
quantity: number
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.setQuantity({
bearer_token: '7381273269536713689562374856',
line_item_id: '9',
quantity: 100
})
// or guest user
const response = await client.cart.setQuantity({
order_token: '7381273269536713689562374856',
line_item_id: '9',
quantity: 100
})
Removes Line Item from Cart. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
id: string
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.removeItem({
bearer_token: '7381273269536713689562374856',
id: '1'
})
// or guest user
const response = await client.cart.removeItem({
order_token: '7381273269536713689562374856',
id: '1'
})
Empties the Cart. See api docs.
Required token: Bearer token or Order token
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.emptyCart({
bearer_token: '7381273269536713689562374856'
})
// or guest user
const response = await client.cart.emptyCart({
order_token: '7381273269536713689562374856'
})
Removes the Cart. See api docs.
Required token: Bearer token or Order token
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.remove({
bearer_token: '7381273269536713689562374856'
})
// or guest user
const response = await client.cart.remove({
order_token: '7381273269536713689562374856'
})
Applies a coupon code to the Cart. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
coupon_code: string
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.applyCouponCode({
bearer_token: '7381273269536713689562374856',
coupon_code: 'promo_test'
})
// or guest user
const response = await client.cart.applyCouponCode({
order_token: '7381273269536713689562374856',
coupon_code: 'promo_test'
})
Removes a coupon code from the Cart. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
code?: string
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.removeCouponCode({
bearer_token: '7381273269536713689562374856',
code: 'promo_test'
})
// or guest user
const response = await client.cart.removeCouponCode({
order_token: '7381273269536713689562374856',
code: 'promo_test'
})
Removes all coupon codes from the Cart. See api docs.
Required token: Bearer token or Order token
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.removeAllCoupons({
bearer_token: '7381273269536713689562374856'
})
// or guest user
const response = await client.cart.removeAllCoupons({
order_token: '7381273269536713689562374856'
})
Returns a list of Estimated Shipping Rates for Cart. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
country_iso: string
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.estimateShippingRates({
bearer_token: '7381273269536713689562374856',
country_iso: 'USA'
})
// or guest user
const response = await client.cart.estimateShippingRates({
order_token: '7381273269536713689562374856',
country_iso: 'USA'
})
Associates a guest cart with the currently signed in user. See api docs.
Required token: Bearer token
Options schema:
interface options {
guest_order_token: string
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.associateGuestCart({
bearer_token: '7381273269536713689562374856',
guest_order_token: 'aebe2886d7dbba6f769e20043e40cfa3447e23ad9d8e82c632f60ed63a2f0df1'
})
Changes the Cart's currency. See api docs.
Required token: Bearer token or Order token
Options schema:
interface options {
new_currency: string
}
Success response schema: Success schema
Failure response schema: Error schema
Example:
// Logged in user
const response = await client.cart.changeCurrency({
bearer_token: '7381273269536713689562374856',
new_currency: 'CAD'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Creates a new Cart and returns its attributes. See api docs.
Required token: Bearer token - if logged in user
Success response schema: Success schema
Failure response schema: Error schema
Example: