shopperBasketsv2

Basket: { adjustedMerchandizeTotalTax?: undefined | number; adjustedShippingTotalTax?: undefined | number; agentBasket?: undefined | false | true; basketId?: undefined | string; billingAddress?: OrderAddress; bonusDiscountLineItems?: Array<BonusDiscountLineItem>; channelType?: BasketChannelTypeEnum; couponItems?: Array<CouponItem>; creationDate?: undefined | string; currency?: CurrencyCode; customerInfo?: CustomerInfo; giftCertificateItems?: Array<GiftCertificateItem>; groupedTaxItems?: Array<GroupedTaxItem>; inventoryReservationExpiry?: undefined | string; lastModified?: undefined | string; merchandizeTotalTax?: undefined | number; orderPriceAdjustments?: Array<PriceAdjustment>; orderTotal?: undefined | number; paymentInstruments?: Array<OrderPaymentInstrument>; productItems?: Array<ProductItem>; productSubTotal?: undefined | number; productTotal?: undefined | number; shipments?: Array<Shipment>; shippingItems?: Array<ShippingItem>; shippingTotal?: undefined | number; shippingTotalTax?: undefined | number; sourceCode?: undefined | string; taxRoundedAtGroup?: undefined | false | true; taxTotal?: undefined | number; taxation?: BasketTaxationEnum; temporaryBasket?: undefined | false | true } & {}

property: adjustedMerchandizeTotalTax: The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
property: adjustedShippingTotalTax: The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
property: agentBasket: Is the basket created by an agent? It is read only.
property: basketId: The unique identifier for the basket. It is read only.
property: billingAddress: The billing address.
property: bonusDiscountLineItems: The bonus discount line items.
property: channelType: The sales channel. It is read only.
property: couponItems: The coupon items.
property: creationDate: The timestamp when the basket was created. It is read only.
property: currency:
property: customerInfo: The customer information, if the customer is logged in.
property: giftCertificateItems: The gift certificate line items.
property: groupedTaxItems: Tax values that are grouped and summed based on the tax rate. The tax totals of the line items with the same tax rate are grouped together and summed up. This does not affect the calculation in any way. It is read only.
property: inventoryReservationExpiry: The expiration datetime of the inventory reservation. It is read only.
property: lastModified: The timestamp when the basket was last modified. It is read only.
property: merchandizeTotalTax: The total products tax in the purchase currency. Merchandise total price represents the sum of the product prices before services (such as shipping) or adjustments from promotions have been added. It is read only.
property: orderPriceAdjustments: The order-level price adjustments.
property: orderTotal: The total price, including products, shipping and tax. It is read only.
property: paymentInstruments: The payment instruments list.
property: productItems: The product items.
property: productSubTotal: The total price of all products including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
property: productTotal: The total price of all products including adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
property: shipments: The shipments.
property: shippingItems: The shipping items.
property: shippingTotal: The total price of all shipping charges, including shipping adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
property: shippingTotalTax: The total tax on all shipping charges, not including shipping adjustments. It is read only.
property: sourceCode: The source code assigned to the basket. It is read only.
property: taxTotal: The total tax amount. It is read only.
property: taxation: The taxation policy (gross or net). It is read only.
property: taxRoundedAtGroup: If the tax is rounded at the group level, this is set to true. If the tax is rounded at the item or unit level, it is set to false.
property: temporaryBasket: If the created basket is a temporary basket, this is set to true. Otherwise, it is set to false.

BasketChannelTypeEnum

BasketPaymentInstrumentRequest

BasketPaymentInstrumentRequest: { amount?: undefined | number; bankRoutingNumber?: undefined | string; giftCertificateCode?: undefined | string; paymentCard?: OrderPaymentCardRequest; paymentMethodId?: undefined | string } & {}

property

amount: The payment transaction amount.

property

bankRoutingNumber: The bank routing number.

Max Length: 256

property

giftCertificateCode: The gift certificate code.

Max Length: 256

property

paymentCard: The payment card.

property

paymentMethodId: The payment method ID.

Max Length: 256

BasketTaxationEnum

BasketTaxationEnum: "gross" | "net"

BonusDiscountLineItem

BonusDiscountLineItem: { bonusProducts?: Array<ProductDetailsLink>; couponCode?: undefined | string; id?: undefined | string; maxBonusItems?: undefined | number; promotionId?: undefined | string } & {}

property: bonusProducts: The bonus products the customer can choose from.
property: couponCode: The coupon code that triggered the promotion, if applicable.
property: id: The ID of the line item. It is read only.
property: maxBonusItems: The maximum number of bonus items the user can select for this promotion.
property: promotionId: The ID of the promotion that triggered the creation of the line item.

CouponItem

CouponItem: { code: string; couponItemId?: undefined | string; statusCode?: CouponItemStatusCodeEnum; valid?: undefined | false | true } & {}

property

code: The coupon code.

Max Length: 256

property

couponItemId: The coupon item ID. It is read only.

Min Length: 1

property

statusCode: The status of the coupon item. It is read only.

property

valid: A flag indicating whether the coupon item is valid. A coupon line item is valid if the status code is "applied" or "no_applicable_promotion". It is read only.

CouponItemStatusCodeEnum

CreateBasketTaxModeEnum

CreateBasketTaxModeEnum: "internal" | "external"

CurrencyCode

CurrencyCode: NoValue | string

CustomerInfo

CustomerInfo: { customerId?: undefined | string; customerName?: undefined | string; customerNo?: undefined | string; email: string } & {}

property

customerId: The customer ID. It is read only.

Max Length: 100

property

customerName: The customer name.

property

customerNo: The customer number.

Max Length: 100

property

email: The customer's email address.

DefaultFallback

DefaultFallback: "default"

A specialized value indicating the system default values for locales.

Discount

Discount: { amount?: undefined | number; percentage?: undefined | number; priceBookId?: undefined | string; type: DiscountTypeEnum } & {}

property: amount: The discount amount for discount types that define specific discount amounts. It is read only.
property: percentage: The discount percent for discount types that define percentage discounts. It is read only.
property: priceBookId: The price book ID that is used with some types. It is read only.
property: type: The type of discount. It is read only.

DiscountRequest

DiscountRequest: { type: DiscountRequestTypeEnum; value: number } & {}

property: type: The type of discount. - amount describes a (unit) price discount, and its corresponding value (positive) defines the amount each unit is to be reduced by. Example: For a $10 discount, set type to amount and value to 10.00. - percentage describes a percentage discount, and its corresponding value (positive) defines the percentage reduction. Example: For a 5% discount, set type to percentage and value to 5.00. - fixed_price describes a fixed price discount, and its corresponding value (positive) defines the resulting fixed price for the item. Only one fixed_price discount can be set for each item. Example: To set a fixed price of $15, set type to fixed_price and value to 15.00. Important: Setting type to fixed_price is not supported when level is set to order.
property: value: The amount of the discount.

DiscountRequestTypeEnum

DiscountRequestTypeEnum: "percentage" | "fixed_price" | "amount"

DiscountTypeEnum

ErrorResponse

ErrorResponse: { detail: string; instance?: undefined | string; title: string; type: string } & {}

property

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

Max Length: 256

property

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

Max Length: 2048

property

detail: A human-readable explanation specific to this occurrence of the problem.

property

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

Max Length: 2048

GiftCertificateItem

GiftCertificateItem: { amount: number; giftCertificateItemId?: undefined | string; message?: undefined | string; recipientEmail: string; recipientName?: undefined | string; senderName?: undefined | string; shipmentId?: undefined | string } & {}

property

amount: The gift certificate item amount.

property

giftCertificateItemId: The item ID. It is read only.

Min Length: 1

property

message: The gift certificate message.

Max Length: 4000

property

recipientEmail: The recipient email.

Min Length: 1

property

recipientName: The recipient's name.

property

senderName: The sender's name.

property

shipmentId: The ID of the shipment this item belongs to.

GroupedTaxItem

GroupedTaxItem: { taxRate?: undefined | number; taxValue?: undefined | number } & {}

property: taxRate: The tax rate. It is read only.
property: taxValue: The summed up tax total for the tax rate. It is read only.

LocaleCode

LocaleCode: DefaultFallback | string

MergeBasketProductItemMergeModeEnum

MergeBasketProductItemMergeModeEnum: "higher_quantity" | "sum_quantities" | "saved_quantity" | "separate_item"

NoValue

NoValue: "N/A"

A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.

OptionItem

OptionItem: { adjustedTax?: undefined | number; basePrice?: undefined | number; bonusDiscountLineItemId?: undefined | string; bonusProductLineItem?: undefined | false | true; bundledProductItems?: Array<ProductItem>; gift?: undefined | false | true; giftMessage?: undefined | string; inventoryId?: undefined | string; itemId?: undefined | string; itemText?: undefined | string; optionId: string; optionItems?: Array<OptionItem>; optionValueId: string; price?: undefined | number; priceAdjustments?: Array<PriceAdjustment>; priceAfterItemDiscount?: undefined | number; priceAfterOrderDiscount?: undefined | number; productId?: undefined | string; productListItem?: ProductListItemReference; productName?: undefined | string; quantity?: undefined | number; shipmentId?: undefined | string; shippingItemId?: undefined | string; tax?: undefined | number; taxBasis?: undefined | number; taxClassId?: undefined | string; taxRate?: undefined | number } & {}

property

adjustedTax: The tax on the line item, including any adjustments. It is read only.

property

basePrice: The base price of the line item, which is the unit price not including adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

bonusDiscountLineItemId: The ID of the bonus discount line item this bonus product relates to. It is read only.

property

bonusProductLineItem: A flag indicating whether the product item is a bonus. It is read only.

property

bundledProductItems: The bundled product items.

property

gift: Returns true if the item is a gift. It is read only.

property

giftMessage: The gift message.

property

inventoryId: The inventory list ID associated with this item. It is read only.

Max Length: 256

property

itemId: The product item ID. Use it to identify this item when updating its quantity or creating a custom price adjustment for it. It is read only.

property

itemText: The text describing the item.

property

optionId: The ID of the option. It is read only.

Max Length: 256

property

optionItems: The option items.

property

optionValueId: The ID of the option value. It is read only.

Max Length: 256

property

price: The price of the line item before applying any adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

priceAdjustments: The price adjustments.

property

priceAfterItemDiscount: The price of the product line item including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

priceAfterOrderDiscount: The price of the product line item including item-level adjustments and prorated order-level adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

productId: The id (SKU) of the product.

Min Length: 1
Max Length: 100

property

productListItem: If this product line item was added from a product list, this value is a reference to the corresponding product list item.

property

productName: The name of the product.

property

quantity: The ordered quantity of the products represented by this item.

property

shipmentId: The ID of the shipment this item belongs to.

property

shippingItemId: If the product line item has a related shipping item, this value is its ID. A related shipping item represents a surcharge applied to individual products using a particular shipping method. It is read only.

property

tax: The tax on the line item before applying any adjustments. It is read only.

property

taxBasis: The amount used to calculate the tax for this item. It is read only.

property

taxClassId: The tax class ID for the product item, or null if no tax class ID is associated with the product item. It is read only.

property

taxRate: The tax rate, which is the decimal tax rate to be applied to the product represented by this item. It is read only.

OrderAddress

OrderAddress: { address1?: undefined | string; address2?: undefined | string; city?: undefined | string; companyName?: undefined | string; countryCode?: undefined | string; firstName?: undefined | string; fullName?: undefined | string; id?: undefined | string; jobTitle?: undefined | string; lastName?: undefined | string; phone?: undefined | string; postBox?: undefined | string; postalCode?: undefined | string; salutation?: undefined | string; secondName?: undefined | string; stateCode?: undefined | string; suffix?: undefined | string; suite?: undefined | string; title?: undefined | string } & {}

property

address1: The first address line.

property

address2: The second address line.

property

city: The city.

property

companyName: The company name.

property

countryCode: A two letter uppercase country code conforming to the ISO 3166-1 alpha-2 standard.

Pattern: /^[A-Z][A-Z]$/

property

firstName: The first name.

property

fullName: The full name.

property

id: The ID of the address.

property

jobTitle: The job title.

property

lastName: The last name.

property

phone: The phone number.

property

postBox: The post office box.

property

postalCode: The postal code.

property

salutation: The salutation.

property

secondName: The second name.

property

stateCode: The state code.

property

suffix: The suffix.

property

suite: The suite.

property

title: The title.

OrderPaymentCardRequest

OrderPaymentCardRequest: { cardType?: undefined | string; creditCardToken?: undefined | string; expirationMonth?: undefined | number; expirationYear?: undefined | number; holder?: undefined | string; issueNumber?: undefined | string; maskedNumber?: undefined | string; validFromMonth?: undefined | number; validFromYear?: undefined | number } & {}

property

cardType: The payment card type (for example: Visa).

Max Length: 256

property

creditCardToken: A credit card token. If a credit card is tokenized, the token can be used to look up the credit card data in the token store.

property

expirationMonth: The month when the payment card expires.

property

expirationYear: The year when the payment card expires.

property

holder: The payment card holder.

Max Length: 256

property

issueNumber: The payment card issue number.

Max Length: 256

property

maskedNumber: The masked payment card number.

Pattern: /^[0-9 -]{0,7}\D{6,15}\d{0,4}$/
Max Length: 25

property

validFromMonth: The month the payment card is valid from.

property

validFromYear: The year the payment card is valid from.

OrderPaymentInstrument

OrderPaymentInstrument: { amount?: undefined | number; authorizationStatus?: Status; bankRoutingNumber?: undefined | string; maskedGiftCertificateCode?: undefined | string; paymentCard?: PaymentCard; paymentInstrumentId?: undefined | string; paymentMethodId?: undefined | string } & {}

property

amount: The payment transaction amount.

property

authorizationStatus: The authorization status of the payment transaction. It is read only.

property

bankRoutingNumber: The bank routing number.

Max Length: 256

property

maskedGiftCertificateCode: The gift certificate code with the last 4 characters not masked.

property

paymentCard: The payment card.

property

paymentInstrumentId: The payment instrument ID. It is read only.

property

paymentMethodId: The payment method ID. It is read only.

Max Length: 256

PaymentCard

PaymentCard: { cardType?: undefined | string; creditCardExpired?: undefined | false | true; creditCardToken?: undefined | string; expirationMonth?: undefined | number; expirationYear?: undefined | number; holder?: undefined | string; issueNumber?: undefined | string; maskedNumber?: undefined | string; numberLastDigits?: undefined | string; validFromMonth?: undefined | number; validFromYear?: undefined | number } & {}

property

cardType: The payment card type.

Max Length: 256

property

creditCardExpired: A flag indicating if the credit card is expired. It is read only.

property

creditCardToken: A credit card token. If a credit card is tokenized, the token can be used to look up the credit card data in the token store.

property

expirationMonth: The month when the payment card expires.

property

expirationYear: The year when the payment card expires.

property

holder: The payment card holder.

Max Length: 256

property

issueNumber: The payment card issue number.

Max Length: 256

property

maskedNumber: The masked payment card number.

Max Length: 4000

property

numberLastDigits: The last digits of the payment card number. It is read only.

Max Length: 4000

property

validFromMonth: The month the payment card is valid from.

property

validFromYear: The year the payment card is valid from.

PaymentCardSpec

PaymentCardSpec: { cardType?: undefined | string; checksumVerificationEnabled?: undefined | false | true; description?: undefined | string; image?: undefined | string; name?: undefined | string; numberLengths?: Array<string>; numberPrefixes?: Array<string>; securityCodeLength?: undefined | number } & {}

property: cardType: The payment card type. It is read only.
property: checksumVerificationEnabled: A flag indicating whether the card number is verified using the Luhn checksum algorithm. It is read only.
property: description: The localized description of the payment card. It is read only.
property: image: The URL to the image that represents the payment card. It is read only.
property: name: The localized name of the payment card. It is read only.
property: numberLengths: The sorted list of number lengths (individual lengths as well as length ranges). It is read only.
property: numberPrefixes: The sorted list of number prefixes (individual prefixes as well as prefix ranges). It is read only.
property: securityCodeLength: The length of the security code for this card. It is read only.

PaymentMethod

PaymentMethod: { cards?: Array<PaymentCardSpec>; description?: undefined | string; id: string; image?: undefined | string; name?: undefined | string; paymentProcessorId?: undefined | string } & {}

property

cards: The sorted array of payment cards (included only when the system payment method is CREDIT_CARD). It is read only.

property

description: The localized description of the payment method or card. It is read only.

property

id: The ID of the payment method or card. It is read only.

Max Length: 256

property

image: The URL to the image that represents the payment method or card. It is read only.

property

name: The localized name of the payment method or card. It is read only.

property

paymentProcessorId: The payment processor ID. It is read only. It is read only.

PaymentMethodResult

PaymentMethodResult: { applicablePaymentMethods?: Array<PaymentMethod> } & {}

property: applicablePaymentMethods: The applicable payment methods. It is read only.

PriceAdjustment

PriceAdjustment: { appliedDiscount?: Discount; couponCode?: undefined | string; createdBy?: undefined | string; creationDate?: undefined | string; custom?: undefined | false | true; itemText?: undefined | string; lastModified?: undefined | string; manual?: undefined | false | true; price?: undefined | number; priceAdjustmentId?: undefined | string; promotionId?: undefined | string; reasonCode?: undefined | string } & {}

property: appliedDiscount: Details describing the discount this price adjustment is based on. For adjustments not based on a discount, this value is null.
property: couponCode: The coupon code of the coupon this price adjustment is based on. For adjustments not based on a coupon, this value is null. It is read only.
property: createdBy: The user who created the price adjustment. It is read only.
property: creationDate: The timestamp when the price adjustment was created. It is read only.
property: custom: A flag indicating whether this price adjustment was created by custom logic. This flag is set to true unless the price adjustment was created by the promotion engine.
property: itemText: The text describing the item.
property: lastModified: The timestamp when the price adjustment was last modified. It is read only.
property: manual: A flag indicating whether this price adjustment was created by a manual process. If the price adjustment was created by the promotion engine, this value is always false.
property: price: The adjustment price. It is read only.
property: priceAdjustmentId: The price adjustment ID. It is read only.
property: promotionId: The ID of the related promotion. Custom price adjustments can be assigned any promotion ID so long it is not used by a price adjustment belonging to the same item, and is not used by a promotion defined in the promotion engine. If not specified, a promotion ID is generated.
property: reasonCode: The reason for the price adjustment.

PriceAdjustmentRequest

PriceAdjustmentRequest: { discount?: DiscountRequest; itemId?: undefined | string; itemText?: undefined | string; level: PriceAdjustmentRequestLevelEnum; promotionId?: undefined | string; reasonCode?: undefined | string } & {}

property: discount: A discount that can be specified instead of a price.
property: itemId: The item to which the price adjustment should be added, depending on the specified level. If the level is ´order´, item id is not needed. If shipping, specify the UUID of the shipping item. If product, specify the UUID of the product item.
property: itemText: The text describing the item in more detail.
property: level: The level at which the adjustment is applied. - order indicates that the price adjustment should be added directly to basket. - product indicates that the price adjustment should be added to the product item. - shipping indicates that the price adjustment is added to the shipping item.
property: promotionId: The ID of the related promotion. Custom price adjustments can be assigned any promotion ID as long as it's not used by a price adjustment belonging to the same item and isn't used by a promotion defined in the promotion engine. If not specified, a promotion ID is generated.
property: reasonCode: The reason for the price adjustment.

PriceAdjustmentRequestLevelEnum

PriceAdjustmentRequestLevelEnum: "product" | "shipping" | "order"

ProductDetailsLink

ProductDetailsLink: { productDescription?: undefined | string; productId: string; productName?: undefined | string; title?: undefined | string } & {}

property

productDescription: The description of the product.

property

productId: The id (SKU) of the product.

Min Length: 1
Max Length: 100

property

productName: The name of the product.

property

title: The link title.

ProductItem

ProductItem: { adjustedTax?: undefined | number; basePrice?: undefined | number; bonusDiscountLineItemId?: undefined | string; bonusProductLineItem?: undefined | false | true; bundledProductItems?: Array<ProductItem>; gift?: undefined | false | true; giftMessage?: undefined | string; inventoryId?: undefined | string; itemId?: undefined | string; itemText?: undefined | string; optionItems?: Array<OptionItem>; price?: undefined | number; priceAdjustments?: Array<PriceAdjustment>; priceAfterItemDiscount?: undefined | number; priceAfterOrderDiscount?: undefined | number; productId?: undefined | string; productListItem?: ProductListItemReference; productName?: undefined | string; qualifyingProductItemId?: undefined | string; quantity?: undefined | number; shipmentId?: undefined | string; shippingItemId?: undefined | string; tax?: undefined | number; taxBasis?: undefined | number; taxClassId?: undefined | string; taxRate?: undefined | number } & {}

property

adjustedTax: The tax on the line item, including any adjustments. It is read only.

property

bonusDiscountLineItemId: The ID of the bonus discount line item this bonus product relates to. It is read only.

property

bonusProductLineItem: A flag indicating whether the product item is a bonus.

property

bundledProductItems: The bundled product items.

property

gift: Returns true if the item is a gift. It is read only.

property

giftMessage: The gift message.

property

inventoryId: The inventory list ID associated with this item.

Max Length: 256

property

itemId: The product item ID. Use it to identify this item when updating its quantity or creating a custom price adjustment for it. It is read only.

property

itemText: The text describing the item.

property

optionItems: The option items.

property

price: The price of the line item before applying any adjustments. If the line item is based on net pricing then the net price is returned. If the line item is based on gross pricing then the gross price is returned. It is read only.

property

priceAdjustments: The price adjustments.

property

productId: The ID of the product.

Max Length: 100

property

productListItem: If this product line item was added from a product list, this value is a reference to the corresponding product list item.

property

productName: The name of the product.

property

qualifyingProductItemId: Returns the id of the ProductLineItem that qualified the basket for this bonus product. This method is only applicable if the product line item is a bonus product line item, and if the promotion is a product promotion with number of qualifying products granting a bonus-product discount. If these conditions aren't met, the method returns null. If there are multiple product line items that triggered this bonus product, this method returns the last one by position within the order.

Max Length: 28

property

quantity: The quantity of the products represented by this item.

property

shipmentId: The ID of the shipment this item belongs to.

property

tax: The tax for the product item, not including price adjustments. It is read only.

property

taxBasis: The price used to calculate the tax for this product item. It is read only.

property

taxClassId: The tax class ID for the product item, or null if no tax class ID is associated with the product item. It is read only.

property

taxRate: The tax rate, which is the decimal tax rate to be applied to the product represented by this item. It is read only.

ProductListItemReference

ProductListItemReference: { id: string; priority?: undefined | number; productDetailsLink?: ProductDetailsLink; productList?: ProductListLink; public?: undefined | false | true; purchasedQuantity?: undefined | number; quantity?: undefined | number; type?: ProductListItemReferenceTypeEnum } & {}

property: id: The ID of the product list item. It is read only.
property: priority: The priority of the product list item.
property: productDetailsLink:
property: productList: A reference to the associated product list. It is read only.
property: public:
property: purchasedQuantity: The total quantity of this item purchased from the product list.
property: quantity: The number of products or gift certificates that get shipped when purchasing this product list item.
property: type: Specifies whether the item is a product or a gift certificate.

ProductListItemReferenceTypeEnum

ProductListItemReferenceTypeEnum: "product" | "gift_certificate"

ProductListLink

ProductListLink: { description?: undefined | string; name?: undefined | string; public?: undefined | false | true; title?: undefined | string; type?: ProductListLinkTypeEnum } & {}

property: description: The description of this product list.
property: name: The name of this product list.
property: public: A flag indicating whether the owner made this product list available for access by other customers. It is read only.
property: title: The link title.
property: type: The type of the product list.

ProductListLinkTypeEnum

Shipment

Shipment: { adjustedMerchandizeTotalTax?: undefined | number; adjustedShippingTotalTax?: undefined | number; gift?: undefined | false | true; giftMessage?: undefined | string; merchandizeTotalTax?: undefined | number; productSubTotal?: undefined | number; productTotal?: undefined | number; shipmentId?: undefined | string; shipmentNo?: undefined | string; shipmentTotal?: undefined | number; shippingAddress?: OrderAddress; shippingMethod?: ShippingMethod; shippingStatus?: ShipmentShippingStatusEnum; shippingTotal?: undefined | number; shippingTotalTax?: undefined | number; taxTotal?: undefined | number; trackingNumber?: undefined | string } & {}

property

adjustedMerchandizeTotalTax: The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.

property

adjustedShippingTotalTax: The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.

property

gift: A flag indicating whether the shipment is a gift. It is read only.

property

giftMessage: The gift message.

property

merchandizeTotalTax: The total tax on products in the shipment, not including price adjustments or service charges such as shipping. It is read only.

property

productSubTotal: The total price of all products in the shipment, including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

productTotal: The total price of all products in the shipment including item-level adjustments and prorated order-level adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

shipmentId: The order-specific ID of the shipment. The default value is 'me'.

Min Length: 1

property

shipmentNo: The shipment number of this shipment. This number is automatically generated. It is read only.

property

shipmentTotal: The total price of all products in the shipment including item-level adjustments, shipping charges, and tax. It is read only.

property

shippingAddress: The shipping address.

property

shippingMethod:

property

shippingStatus: The shipping status of the shipment.

property

shippingTotal: The total price of all shipping charges in the shipment, including shipping adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

shippingTotalTax: The total tax on shipping charges in the shipment, not including shipping price adjustments. It is read only.

property

taxTotal: The total tax on the shipment, including item-level price adjustments and service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.

property

trackingNumber: The tracking number of the shipment.

ShipmentShippingStatusEnum

ShipmentShippingStatusEnum: "not_shipped" | "shipped"

ShippingItem

ShippingItem: { adjustedTax?: undefined | number; basePrice?: undefined | number; itemId?: undefined | string; itemText?: undefined | string; price?: undefined | number; priceAdjustments?: Array<PriceAdjustment>; priceAfterItemDiscount?: undefined | number; shipmentId?: undefined | string; tax?: undefined | number; taxBasis?: undefined | number; taxClassId?: undefined | string; taxRate?: undefined | number } & {}

property

adjustedTax: The tax for the shipping item, including price adjustments. It is read only.

property

basePrice: The base price of the shipping item, which is the unit price not including adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

itemId: The shipping item ID. Use it to identify this shipping item when updating its quantity or creating a custom price adjustment for it. It is read only.

property

itemText: The text describing the shipping item.

property

priceAdjustments: The price adjustments.

property

priceAfterItemDiscount: The price of the shipping item including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

property

shipmentId: The identifier of the shipment to which this item belongs.

Min Length: 1

property

tax: The tax on the product item, not including adjustments. It is read only.

property

taxBasis: The price used to calculate the tax for this shipping item. It is read only.

property

taxClassId: The tax class ID for the product item, or null if no tax class ID is associated with the product item. It is read only.

property

taxRate: The tax rate applicable to this product line item. For a 10% tax rate, the value is 0.1. It is read only.

ShippingMethod

ShippingMethod: { description?: undefined | string; externalShippingMethod?: undefined | string; id: string; name?: undefined | string; price?: undefined | number; shippingPromotions?: Array<ShippingPromotion> } & {}

property

description: The localized description of the shipping method.

property

externalShippingMethod: The external shipping method.

property

id: The shipping method ID.

Max Length: 256

property

name: The localized name of the shipping method.

property

price: The shipping cost total, including shipment level costs, product level fix, and surcharge costs. It is read only.

property

shippingPromotions: The array of active customer shipping promotions for this shipping method. This array can be empty.

ShippingMethodResult

ShippingMethodResult: { applicableShippingMethods?: Array<ShippingMethod>; defaultShippingMethodId?: undefined | string } & {}

property: applicableShippingMethods: The applicable shipping method documents. It is read only.
property: defaultShippingMethodId: The default shipping method. It is read only.

ShippingPromotion

ShippingPromotion: { calloutMsg?: undefined | string; promotionId?: undefined | string; promotionName?: undefined | string } & {}

property: calloutMsg: The localized callout message of the promotion.
property: promotionId: The unique ID of the promotion.
property: promotionName: The localized promotion name.

ShopperBasketsParameters

ShopperBasketsParameters: ShopperBasketsPathParameters & BaseUriParameters & ShopperBasketsQueryParameters

All parameters that are used by ShopperBaskets.

ShopperBasketsPathParameters

All path parameters that are used by at least one ShopperBaskets method.

ShopperBasketsQueryParameters

All query parameters that are used by at least one ShopperBaskets method.

Status

Status: { code?: undefined | string; message?: undefined | string; status?: undefined | number } & {}

property: code: The status code.
property: message: The status message.
property: status: The status. For more information on the status values see Status.OK and Status.ERROR.

TaxItem

TaxItem: { id: string; rate: number; value?: undefined | number } & {}

property: id: The taxation identifier.
property: rate: The taxation rate.
property: value: The tax amount. Will be computed if not set.

TaxItems

TaxItems: { taxItems?: Array<TaxItem> } & {}

property: taxItems: The list of tax items. It is read only.

Taxes

Taxes: { taxes: {} } & {}

property: taxes: Map containing the TaxItems for the line item ids: Map<LineItemId, TaxItems []>

addCouponToBasketPathParameters

addCouponToBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addCouponToBasketQueryParameters

addCouponToBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

addGiftCertificateItemToBasketPathParameters

addGiftCertificateItemToBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addGiftCertificateItemToBasketQueryParameters

addGiftCertificateItemToBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

addItemToBasketPathParameters

addItemToBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addItemToBasketQueryParameters

addItemToBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

addPaymentInstrumentToBasketPathParameters

addPaymentInstrumentToBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addPaymentInstrumentToBasketQueryParameters

addPaymentInstrumentToBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

addPriceAdjustmentToBasketPathParameters

addPriceAdjustmentToBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addPriceAdjustmentToBasketQueryParameters

addPriceAdjustmentToBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

addPriceBooksToBasketPathParameters

addPriceBooksToBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addPriceBooksToBasketQueryParameters

addPriceBooksToBasketQueryParameters: { siteId: string }

Type declaration

siteId: string

addTaxesForBasketItemPathParameters

addTaxesForBasketItemPathParameters: { basketId: string; itemId: string; organizationId: string }

Type declaration

basketId: string
itemId: string
organizationId: string

addTaxesForBasketItemQueryParameters

addTaxesForBasketItemQueryParameters: { siteId: string }

Type declaration

siteId: string

addTaxesForBasketPathParameters

addTaxesForBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

addTaxesForBasketQueryParameters

addTaxesForBasketQueryParameters: { siteId: string }

Type declaration

siteId: string

createBasketPathParameters

createBasketPathParameters: { organizationId: string }

Type declaration

organizationId: string

createBasketQueryParameters

createBasketQueryParameters: { locale?: LocaleCode; siteId: string; taxMode?: "internal" | "external"; temporary?: undefined | false | true }

Type declaration

Optional locale?: LocaleCode
siteId: string
Optional taxMode?: "internal" | "external"
Optional temporary?: undefined | false | true

createShipmentForBasketPathParameters

createShipmentForBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

createShipmentForBasketQueryParameters

createShipmentForBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

deleteBasketPathParameters

deleteBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

deleteBasketQueryParameters

deleteBasketQueryParameters: { siteId: string }

Type declaration

siteId: string

getBasketPathParameters

getBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

getBasketQueryParameters

getBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

getPaymentMethodsForBasketPathParameters

getPaymentMethodsForBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

getPaymentMethodsForBasketQueryParameters

getPaymentMethodsForBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

getPriceBooksForBasketPathParameters

getPriceBooksForBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

getPriceBooksForBasketQueryParameters

getPriceBooksForBasketQueryParameters: { siteId: string }

Type declaration

siteId: string

getShippingMethodsForShipmentPathParameters

getShippingMethodsForShipmentPathParameters: { basketId: string; organizationId: string; shipmentId: string }

Type declaration

basketId: string
organizationId: string
shipmentId: string

getShippingMethodsForShipmentQueryParameters

getShippingMethodsForShipmentQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

getTaxesFromBasketPathParameters

getTaxesFromBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

getTaxesFromBasketQueryParameters

getTaxesFromBasketQueryParameters: { siteId: string }

Type declaration

siteId: string

mergeBasketPathParameters

mergeBasketPathParameters: { organizationId: string }

Type declaration

organizationId: string

mergeBasketQueryParameters

mergeBasketQueryParameters: { createDestinationBasket?: undefined | false | true; locale?: LocaleCode; productItemMergeMode?: "higher_quantity" | "sum_quantities" | "saved_quantity" | "separate_item"; siteId: string }

Type declaration

Optional createDestinationBasket?: undefined | false | true
Optional locale?: LocaleCode
Optional productItemMergeMode?: "higher_quantity" | "sum_quantities" | "saved_quantity" | "separate_item"
siteId: string

removeCouponFromBasketPathParameters

removeCouponFromBasketPathParameters: { basketId: string; couponItemId: string; organizationId: string }

Type declaration

basketId: string
couponItemId: string
organizationId: string

removeCouponFromBasketQueryParameters

removeCouponFromBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

removeGiftCertificateItemFromBasketPathParameters

removeGiftCertificateItemFromBasketPathParameters: { basketId: string; giftCertificateItemId: string; organizationId: string }

Type declaration

basketId: string
giftCertificateItemId: string
organizationId: string

removeGiftCertificateItemFromBasketQueryParameters

removeGiftCertificateItemFromBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

removeItemFromBasketPathParameters

removeItemFromBasketPathParameters: { basketId: string; itemId: string; organizationId: string }

Type declaration

basketId: string
itemId: string
organizationId: string

removeItemFromBasketQueryParameters

removeItemFromBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

removePaymentInstrumentFromBasketPathParameters

removePaymentInstrumentFromBasketPathParameters: { basketId: string; organizationId: string; paymentInstrumentId: string }

Type declaration

basketId: string
organizationId: string
paymentInstrumentId: string

removePaymentInstrumentFromBasketQueryParameters

removePaymentInstrumentFromBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

removePriceAdjustmentFromBasketPathParameters

removePriceAdjustmentFromBasketPathParameters: { basketId: string; organizationId: string; priceAdjustmentId: string }

Type declaration

basketId: string
organizationId: string
priceAdjustmentId: string

removePriceAdjustmentFromBasketQueryParameters

removePriceAdjustmentFromBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

removeShipmentFromBasketPathParameters

removeShipmentFromBasketPathParameters: { basketId: string; organizationId: string; shipmentId: string }

Type declaration

basketId: string
organizationId: string
shipmentId: string

removeShipmentFromBasketQueryParameters

removeShipmentFromBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

transferBasketPathParameters

transferBasketPathParameters: { organizationId: string }

Type declaration

organizationId: string

transferBasketQueryParameters

transferBasketQueryParameters: { locale?: LocaleCode; overrideExisting?: undefined | false | true; siteId: string }

Type declaration

Optional locale?: LocaleCode
Optional overrideExisting?: undefined | false | true
siteId: string

updateAsAgentBasketPathParameters

updateAsAgentBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

updateAsAgentBasketQueryParameters

updateAsAgentBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

updateAsStorefrontBasketPathParameters

updateAsStorefrontBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

updateAsStorefrontBasketQueryParameters

updateAsStorefrontBasketQueryParameters: { exchange?: undefined | false | true; locale?: LocaleCode; siteId: string }

Type declaration

Optional exchange?: undefined | false | true
Optional locale?: LocaleCode
siteId: string

updateBasketPathParameters

updateBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

updateBasketQueryParameters

updateBasketQueryParameters: { locale?: LocaleCode; removeExternalTax?: undefined | false | true; siteId: string }

Type declaration

Optional locale?: LocaleCode
Optional removeExternalTax?: undefined | false | true
siteId: string

updateBillingAddressForBasketPathParameters

updateBillingAddressForBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

updateBillingAddressForBasketQueryParameters

updateBillingAddressForBasketQueryParameters: { locale?: LocaleCode; removeExternalTax?: undefined | false | true; siteId: string; useAsShipping?: undefined | false | true }

Type declaration

Optional locale?: LocaleCode
Optional removeExternalTax?: undefined | false | true
siteId: string
Optional useAsShipping?: undefined | false | true

updateCustomerForBasketPathParameters

updateCustomerForBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

updateCustomerForBasketQueryParameters

updateCustomerForBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

updateGiftCertificateItemInBasketPathParameters

updateGiftCertificateItemInBasketPathParameters: { basketId: string; giftCertificateItemId: string; organizationId: string }

Type declaration

basketId: string
giftCertificateItemId: string
organizationId: string

updateGiftCertificateItemInBasketQueryParameters

updateGiftCertificateItemInBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

updateItemInBasketPathParameters

updateItemInBasketPathParameters: { basketId: string; itemId: string; organizationId: string }

Type declaration

basketId: string
itemId: string
organizationId: string

updateItemInBasketQueryParameters

updateItemInBasketQueryParameters: { locale?: LocaleCode; removeExternalTax?: undefined | false | true; siteId: string }

Type declaration

Optional locale?: LocaleCode
Optional removeExternalTax?: undefined | false | true
siteId: string

updateItemsInBasketPathParameters

updateItemsInBasketPathParameters: { basketId: string; organizationId: string }

Type declaration

basketId: string
organizationId: string

updateItemsInBasketQueryParameters

updateItemsInBasketQueryParameters: { locale?: LocaleCode; removeExternalTax?: undefined | false | true; siteId: string }

Type declaration

Optional locale?: LocaleCode
Optional removeExternalTax?: undefined | false | true
siteId: string

updatePaymentInstrumentInBasketPathParameters

updatePaymentInstrumentInBasketPathParameters: { basketId: string; organizationId: string; paymentInstrumentId: string }

Type declaration

basketId: string
organizationId: string
paymentInstrumentId: string

updatePaymentInstrumentInBasketQueryParameters

updatePaymentInstrumentInBasketQueryParameters: { locale?: LocaleCode; removeExternalTax?: undefined | false | true; siteId: string }

Type declaration

Optional locale?: LocaleCode
Optional removeExternalTax?: undefined | false | true
siteId: string

updatePriceAdjustmentInBasketPathParameters

updatePriceAdjustmentInBasketPathParameters: { basketId: string; organizationId: string; priceAdjustmentId: string }

Type declaration

basketId: string
organizationId: string
priceAdjustmentId: string

updatePriceAdjustmentInBasketQueryParameters

updatePriceAdjustmentInBasketQueryParameters: { siteId: string }

Type declaration

siteId: string

updateShipmentForBasketPathParameters

updateShipmentForBasketPathParameters: { basketId: string; organizationId: string; shipmentId: string }

Type declaration

basketId: string
organizationId: string
shipmentId: string

updateShipmentForBasketQueryParameters

updateShipmentForBasketQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

updateShippingAddressForShipmentPathParameters

updateShippingAddressForShipmentPathParameters: { basketId: string; organizationId: string; shipmentId: string }

Type declaration

basketId: string
organizationId: string
shipmentId: string

updateShippingAddressForShipmentQueryParameters

updateShippingAddressForShipmentQueryParameters: { locale?: LocaleCode; removeExternalTax?: undefined | false | true; siteId: string; useAsBilling?: undefined | false | true }

Type declaration

Optional locale?: LocaleCode
Optional removeExternalTax?: undefined | false | true
siteId: string
Optional useAsBilling?: undefined | false | true

updateShippingMethodForShipmentPathParameters

updateShippingMethodForShipmentPathParameters: { basketId: string; organizationId: string; shipmentId: string }

Type declaration

basketId: string
organizationId: string
shipmentId: string

updateShippingMethodForShipmentQueryParameters

updateShippingMethodForShipmentQueryParameters: { locale?: LocaleCode; siteId: string }

Type declaration

Optional locale?: LocaleCode
siteId: string

Variables

Const defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/v2" = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/v2"