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.
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.
authType: The customer's authorization type (indicates whether the customer is a guest or a registered customer).
property
birthday: The customer's birthday.
property
companyName: The customer's company name.
Max Length: 256
property
creationDate: Returns the value of attribute 'creationDate'.
property
currentPassword: The shopper's current password. This is only used when attempting to update a shopper's loginId in a PATCH call. This value is never returned in any response for security reasons, but is validated and must match shopper's existing password in order to update loginId. Otherwise, an HTTP 400 statusCode is returned and the loginId is not updated. This field and functionality is available with B2C Commerce version 24.7.
property
customerId: The customer's number (ID). Both registered and guest customers have an customer ID.
Max Length: 28
property
customerNo: The customer's number (ID). Only a registered customer has a customer number.
Max Length: 100
property
email: The customer's email address.
Max Length: 256
property
enabled: A flag indicating whether this customer is enabled and can log in.
property
fax: The customer's fax number. The length is restricted to 32 characters.
Max Length: 32
property
firstName: The customer's first name.
Max Length: 256
property
gender: The customer's gender.
property
hashedLogin: Represents the read-only hashed value for the loginId used for Einstein events. This field is available with B2C Commerce version 24.9.
property
jobTitle: The customer's job title.
Max Length: 256
property
lastLoginTime: The time when the customer last logged in.
property
lastModified: Returns the value of attribute 'lastModified'.
property
lastName: The customer's last name.
Max Length: 256
property
lastVisitTime: The time when the customer last visited.
property
login: The customer's login. In a PATCH call, this field can only be updated by providing a valid currentPassword for the shopper. The loginId update feature is available with B2C Commerce version 24.7.
Max Length: 256
property
note: The customer's note.
property
paymentInstruments: The customer's payment instruments.
property
phoneBusiness: The customer's business phone number.
Max Length: 32
property
phoneHome: The customer's home phone number.
Max Length: 32
property
phoneMobile: The customer's mobile phone number.
Max Length: 32
property
preferredLocale: The customer's preferred locale.
property
previousLoginTime: The time when the customer previously logged in.
property
previousVisitTime: The time when the customer last visited the store.
property
salutation: The salutation to use for the customer.
Max Length: 256
property
secondName: The customer's second name.
Max Length: 256
property
suffix: The customer's suffix (for example, "Jr." or "Sr.").
Max Length: 256
property
title: The customer's title (for example, "Mrs" or "Mr").
offset: The zero-based index of the first hit/data to include in the result.
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
CustomerProductListResult:{ data: Array<CustomerProductList>; limit: number; total: number } & {}
property
data: The customer product lists.
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
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.
ats: The Available To Sell (ATS) of the product. If it is infinity, the return value is 999999. The value can be overwritten by the OCAPI setting 'product.inventory.ats.max_threshold'.
property
backorderable: A flag indicating whether the product is backorderable.
property
id: The inventory ID.
Min Length: 1
Max Length: 256
property
inStockDate: A flag indicating the date when the product will be in stock.
property
orderable: A flag indicating whether at least one of the products is available to sell.
property
preorderable: A flag indicating whether the product is preorderable.
property
stockLevel: The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the OCAPI setting 'product.inventory.stock_level.max_threshold'.
orderable: A flag indicating whether at least one of the variants can be ordered.
property
price: The minimum sales price of the related variants.
property
priceMax: The maximum sales price of the related variants.
property
prices: List of sale prices.
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.
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.
adjustedMerchandizeTotalTax: The total tax on products in the order, including price adjustments, but not including service charges such as shipping. It is read only.
property
adjustedShippingTotalTax: The total tax on shipping charges in the order, including shipping price adjustments. 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
confirmationStatus: The confirmation status.
property
couponItems: The coupon items. It is read only.
property
createdBy: This value depends on how the order was created. If a shopper created the order, this value is Customer. If a job created the order, this value is System. Otherwise, this value is the name of the user who created the order. It is read only.
property
creationDate: The timestamp when the order was created. It is read only.
property
currency: The ISO 4217 mnemonic code of the currency. It is read only.
property
customerInfo: The customer information for guest or logged-in customers. It is read only.
property
customerName: The customer name. It is read only.
property
exportStatus: The export status of the order.
property
externalOrderStatus: The external status of the order.
property
giftCertificateItems: The gift certificate line items. It is read only.
property
globalPartyId: The Customer 360 Global Party ID associated with the shopper. It is read only.
property
lastModified: The timestamp when the order was last modified. It is read only.
property
merchandizeTotalTax: The total products tax in the purchase currency. Merchandise total prices represent the sum of product prices not including shipping or adjustments. It is read only.
property
orderNo: The order number.
Min Length: 1
Max Length: 50
property
orderPriceAdjustments: The order-level price adjustments. It is read only.
property
orderToken: The order token used to secure the lookup of an order on base of the plain order number. The order token contains only URL safe characters. It is read only.
property
orderTotal: The total price, including products, shipping, and tax. It is read only.
property
orderViewCode: The order view code used to secure the order lookup of an order using Order Lookup API. The order view code contains only URL safe characters. Warning : Order view code must not be exposed in the URL and must only be displayed to the shopper or sent as an email. Order view code must not be logged in the code. It is read only.
property
paymentInstruments: The payment instruments list.
property
paymentStatus: The payment status.
property
productItems: The product items. It is read only.
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 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
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. It is read only.
property
shipments: The shipments. It is read only.
property
shippingItems: The shipping items. It is read only.
property
shippingStatus: The shipping status.
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
siteId: The order's site. It is read only.
Min Length: 1
Max Length: 32
property
sourceCode: The source code assigned to the basket from which this order was created. It is read only.
property
status: The status.
property
taxTotal: The total tax amount. It is read only.
property
taxation: The taxation policy (gross or net). It is read only.
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
guest: The registration status of the customer. It is read only.
value: Locale-specific value of the Page Meta Tag, evaluated by resolving the rule set for the given Business Manager ID.
PaginatedResultBase
PaginatedResultBase:{ limit: number; offset: number; total: number } & {}
property
offset: The zero-based index of the first hit/data to include in the result.
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
driversLicenseLastDigits: The last 4 characters of the decrypted driver’s license number of the bank account associated with this payment instrument.
Max Length: 256
property
driversLicenseStateCode: The driver’s license state code.
Max Length: 256
property
holder: The holder of the bank account.
Max Length: 256
property
maskedDriversLicense: The decrypted driver’s license number of the bank account with all but the last 4 characters replaced with * characters.
Max Length: 256
property
maskedNumber: The masked bank account number.
Max Length: 256
property
numberLastDigits: The last digits of the bank account number.
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.
maxPrice: Maximum price for the given pricebook (usually for a master Product would be the price for the Variant which has the highest price out of all Variants in that pricebook)
property
minPrice: Minimum price for the given pricebook (usually for a master Product would be the price for the Variant which has the least price out of all Variants in that pricebook)
property
pricebook: The active pricebook from which the min and the max prices are calculated. The pricebook is based on the site context of the request as defined in ECOM.
bundledProducts: The array of all bundled products of this product.
property
currency:
property
ean: The European Article Number of the product.
property
fetchDate:
property
id: The id (SKU) of the product.
Min Length: 1
Max Length: 100
property
imageGroups: The array of product image groups.
property
inventories: The array of product inventories explicitly requested via the 'inventory_ids' query parameter. This property is only returned in context of the 'availability' expansion.
property
inventory: The site default inventory information. This property is only returned in context of the 'availability' expansion.
property
longDescription: The localized product's long description.
property
manufacturerName: The product's manufacturer name.
property
manufacturerSku: The product's manufacturer SKU.
property
master: The master product information, only for types: master, variation group, and variant.
property
minOrderQuantity: The minimum order quantity for this product.
property
name: The localized product name.
property
options: The array of product options, only for type option. This array can be empty.
property
pageDescription: The localized product's page description.
property
pageKeywords: The localized product's page description.
property
pageTitle: The localized product's page title.
property
pageMetaTags: Page Meta tags associated with the given product.
property
price: The sales price of the product. In case of complex products, like master or set, this is the minimum price of related child products.
property
pricePerUnit: The price per unit if defined for the product
property
pricePerUnitMax: The max price per unit typically for a master product's variant.
property
priceMax: The maximum sales of related child products in complex products like master or set.
property
priceRanges: Array of one or more price range objects representing one or more Pricebooks in context for the site.
property
prices: The prices map with pricebook IDs and their values.
property
primaryCategoryId: The ID of the products primary category.
property
productLinks: The array of source and target product links information.
property
productPromotions: An array of active customer product promotions for this product, sorted by promotion priority using SORT_BY_EXCLUSIVITY ordering (exclusivity → rank → promotion class → discount type → best discount → ID). This array can be empty. Coupon promotions are not returned in this array. See PromotionPlan.SORT_BY_EXCLUSIVITY for more details.
property
recommendations: Returns a list of recommendations.
property
setProducts: The array of set products of this product.
property
shortDescription: The localized product short description.
property
slugUrl: The complete link to this product's storefront page.
property
stepQuantity: The steps in which the order amount of the product can be increased.
property
tieredPrices: The document represents list of tiered prices if the product is a variant
property
type: The product type information. Can be one or more of the following values: item, master, variation_group, variant, bundle, and set.
property
unit: The sales unit of the product.
property
upc: The Universal Product Code (UPC).
property
validFrom: The time a product is valid from.
property
validTo: The time a product is valid to.
property
variants: The array of actual variants. Only for master, variation group, and variant types. This array can be empty.
property
variationAttributes: Sorted array of variation attributes information. Only for master, variation group, and variant types. This array can be empty.
property
variationGroups: The array of actual variation groups. Only for master, variation group, and variant types. This array can be empty.
property
variationValues: The actual variation attribute ID - value pairs. Only for variant and variation group types.
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.
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
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 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
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 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.
PublicProductListResult:{ data: Array<PublicProductListInfo>; limit: number; total: number } & {}
property
data: The array of product list link documents.
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
resetToken: Temporary token generated that will be used to reset password.
Max Length: 4096
property
expiresInMinutes: Reset token expiry (in minutes).
ResetPasswordTokenRequest
ResetPasswordTokenRequest:{ login: string } & {}
property
login: The customer's login.
Max Length: 256
ResultBase
ResultBase:{ limit: number; total: number } & {}
property
limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
property
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
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.
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
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
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.
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.
adjustedShippingTotalTax: The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
agentBasket: Is the basket created by an agent? It is read only.
basketId: The unique identifier for the basket. It is read only.
billingAddress: The billing address.
bonusDiscountLineItems: The bonus discount line items.
channelType: The sales channel. It is read only.
couponItems: The coupon items.
creationDate: The timestamp when the basket was created. It is read only.
currency:
customerInfo: The customer information, if the customer is logged in.
giftCertificateItems: The gift certificate line items.
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.
inventoryReservationExpiry: The expiration datetime of the inventory reservation. It is read only.
lastModified: The timestamp when the basket was last modified. It is read only.
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.
orderPriceAdjustments: The order-level price adjustments.
orderTotal: The total price, including products, shipping and tax. It is read only.
paymentInstruments: The payment instruments list.
productItems: The product items.
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.
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.
shipments: The shipments.
shippingItems: The shipping items.
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.
shippingTotalTax: The total tax on all shipping charges, not including shipping adjustments. It is read only.
sourceCode: The source code assigned to the basket. It is read only.
taxTotal: The total tax amount. It is read only.
taxation: The taxation policy (gross or net). It is read only.
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.
temporaryBasket: If the created basket is a temporary basket, this is set to true. Otherwise, it is set to false.