Get Wishlist Item

get https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/wishlists/{wishlistId}/items/{wishlistItemId}

Retrieves an individual wishlist item from a wishlist.

Response

Response body

object

string | null

Unique identifier of the wishlist line item. System-supplied and read-only.

comments

string | null

Comments for the wishlist item that are entered by the wishlist owner

priorityType

string | null

Wishlist item priority that is a hint to how much this item is needed or desired

purchasableStatusType

string | null

Is the item purchasable?

priceMode

string | null

Determines if the item is using external or internal(catalog) pricing

localeCode

string | null

Locale code for language that appears in text and descriptions on the site, for example, en_US.
This is not the currency code. Currently only en_US is supported.

purchaseLocation

string | null

The location where the product is being purchased.. default is null. Products can have different prices
by purchaseLocation via custom priceListResolution...

lineId

int32 | null

The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or
in CommerceRuntime when a cart is converted to an order.

product

object

The product as it appears on the order item.

mfgPartNumber

string | null

Manufacturing Part Number of the product.

upc

string | null

Universal Product Code of the product.

sku

string | null

Product Identifier specific to the store

fulfillmentTypesSupported

array of strings | null

Types of fulfillment that are supported for this product.

fulfillmentTypesSupported

imageAlternateText

string | null

Descriptive text of the image associated with the product in the language specified by LocaleCode.

imageUrl

string | null

URL of the image that appears next to the product on the order item. Optional.

variationProductCode

string | null

For configurable products, the unique identifier of the product variation that has been selected.

options

array of objects | null

If the product contains configurable or stand-alone options, the list of product options that the shopper selected for this product.

options

object

name

string | null

Name of the product option that appears with the order item in the language specified by LocaleCode.

value

string

Value of the product option.

shopperEnteredValue

string

The value entered by the shopper if this is an option that requires shopper input, for example, a monogram.

attributeFQN

string | null

Value of the product option.

dataType

string | null

Value of the product option.

stringValue

string | null

Value of the product option.

properties

array of objects | null

If the product contains properties, the list of properties that the shopper selected for this product.

properties

object

attributeFQN

string | null

name

string | null

dataType

string | null

isMultiValue

boolean

values

array of objects | null

values

object

stringValue

string | null

value

string

categories

object

int32 | null

Unique identifier of the category. System-supplied and read-only.

parent

object

Has additional fields

price

object

Price of the product with any sale and discounts applied.

discountsRestricted

boolean | null

Is the product discount restricted

discountsRestrictedStartDate

date-time | null

Product discount restriction start date

discountsRestrictedEndDate

date-time | null

Product discount restriction end date

isRecurring

boolean | null

If true, the product is purchased or fulfilled at regular intervals, for example, a monthly billing or a subscription.

isTaxable

boolean | null

If true, the product is eligible for tax.

productType

string | null

Type of product, which can be a product with configurable options, a product with stand-alone options, or a simple product with no options.

productUsage

string | null

Usage of the product, primarily used to indicate a bundle in this context

serialNumber

string | null

Serial Number

condition

string | null

Condition

bundledProducts

array of objects | null

Products bundled with this product (if the current product is a bundle)

bundledProducts

object

quantity

int32

Quantity of the product included in the bundle.

optionAttributeFQN

string | null

Fully Qualified Name of the selected option's attribute

optionValue

string

Value of the selected option

creditValue

double | null

Credit value. Only populated if the bundled product is a gift card or digital credit

deltaPrice

double | null

Only populated for extras

imageUrl

string | null

ImageUrl of product

productCode

string | null

Merchant-created code that uniquely identifies the product.

name

string | null

Name of the product, this is the current value of the product's name in the language specified by LocaleCode.

description

string | null

Short description of the product in the language specified by LocaleCode.

goodsType

string | null

Goods Type

isPackagedStandAlone

boolean

Indicates that this product ships by itself.

stock

object

productReservationId

int32 | null

Reservation ID associated with this product in the bundle.

allocationId

int32 | null

Allocation ID associated with this product on this order.

allocationExpiration

date-time | null

Allocation ID associated with this product on this order.

measurements

object

Physical dimensions of the package required to ship the product and its weight.

fulfillmentStatus

string | null

Fulfillment status of the product.

fulfillmentFields

array of objects | null

List of unique product identifiers for an item on shipment

fulfillmentFields

object

name

string | null

userEnteredValue

string

required

boolean

productCode

string | null

Merchant-created code that uniquely identifies the product.

name

string | null

Name of the product, this is the current value of the product's name in the language specified by LocaleCode.

description

string | null

Short description of the product in the language specified by LocaleCode.

goodsType

string | null

Goods Type

isPackagedStandAlone

boolean

Indicates that this product ships by itself.

stock

object

productReservationId

int32 | null

Reservation ID associated with this product in the bundle.

allocationId

int32 | null

Allocation ID associated with this product on this order.

allocationExpiration

date-time | null

Allocation ID associated with this product on this order.

measurements

object

Physical dimensions of the package required to ship the product and its weight.

fulfillmentStatus

string | null

Fulfillment status of the product.

quantity

int32

Number of products ordered.

isRecurring

boolean | null

If true, the cart item lists a product that can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

isTaxable

boolean | null

Not implemented. If true, the cart item is eligible for tax.

subtotal

double | null

Line item subtotal (quantity multiplied by price) before discounts.

extendedTotal

double | null

Line item extended total (quantity multiplied by unit extended price) before discounts.

taxableTotal

double | null

Line item subtotal (quantity multiplied by price) before discounts.

discountTotal

double | null

How much the shopper saves with the applied discount or sale price. This is a negative number.

discountedTotal

double | null

Subtotal minus any discounts.

itemTaxTotal

double | null

Total price of taxes that apply to products in this item.

shippingTaxTotal

double | null

Total price of taxes that apply to the shipping of this item.

shippingTotal

double | null

Total price of shipping that apply to this item.

handlingAmount

double | null

Handling Amount for this item

feeTotal

double | null

Not implemented. Total cost of fees that apply to this item.

total

double | null

Total price of this cart item taking into account any discounts.

unitPrice

object

Pricing details for the product listed on a cart item, including the original price, discount amount, and final price.

extendedAmount

double | null

Extended amount, this is in order of precedence: OverrideAmount, SaleAmount, ListAmount

listAmount

double | null

Product list amount.

saleAmount

double | null

Sale amount indicated on the product.

overrideAmount

double | null

Amount as manually overridden by the Merchant

productDiscount

object

Discount applied to the order, which is a negative number to be subtracted from the original price to get the final price.
If multiple discounts for the order exist, this is the value most advantageous to the shopper.

appliesToSalePrice

boolean | null

Determines if the discount applies to the sale price of the order

discountQuantity

int32

The number of the line item that can be used for this particular discount.

productQuantity

int32 | null

deprecated

Quantity of products priced. This is always one unless calculating pricing on the order or cart.

impactPerUnit

double | null

deprecated

Impact for a quantity of one product; that is, the value of the discount for one product.

impact

double | null

Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.

discount

object

Discounts that apply to the order, if any. For example, when the
subtotal of the order exceeds a certain amount, or for free shipping.

couponCode

string | null

Code of the coupon associated with the discount if a coupon code is required to get the discount.

excluded

boolean | null

Determines whether or not this discount is set up to be ignored by the pricing runtime.

data

object | null

Stores any custom data sent from external discounts.

Has additional fields

productDiscounts

array of objects | null

A list of discounts applied to the product

productDiscounts

object

appliesToSalePrice

boolean | null

Determines if the discount applies to the sale price of the order

discountQuantity

int32

The number of the line item that can be used for this particular discount.

productQuantity

int32 | null

deprecated

Quantity of products priced. This is always one unless calculating pricing on the order or cart.

impactPerUnit

double | null

deprecated

Impact for a quantity of one product; that is, the value of the discount for one product.

impact

double | null

Value of the discount applied. This is a negative number to be subtracted from the original price to get the final price.

discount

object

Discounts that apply to the order, if any. For example, when the
subtotal of the order exceeds a certain amount, or for free shipping.

couponCode

string | null

Code of the coupon associated with the discount if a coupon code is required to get the discount.

excluded

boolean | null

Determines whether or not this discount is set up to be ignored by the pricing runtime.

data

object | null

Stores any custom data sent from external discounts.

Has additional fields

shippingDiscounts

array of objects | null

A discount applied to the shipping

shippingDiscounts

object

methodCode

string | null

Unique identifier of the shipping method discount.

discount

object

discountQuantity

int32

The number of the line item that can be used for this particular discount.

impactPerUnit

double

The impact of this discount pur discount quantity.

data

object | null

Custom data for a given vendor set within the commerce process.

Has additional fields

taxData

object | null

Storage for any additional/custom tax data.

Has additional fields

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

shippingAmountBeforeDiscountsAndAdjustments

double | null

Shipping amount before Discounts and adjustments

weightedOrderAdjustment

double | null

Order Level Manual Adjustment applied to this Item

weightedOrderDiscount

double | null

Order Level Discount applied to this Item

adjustedLineItemSubtotal

double | null

Order Level taxable sub total

totalWithoutWeightedShippingAndHandling

double | null

Taxable Subtotal including Weighted Order amounts

weightedOrderTax

double | null

Order Level tax applied to this Item

weightedOrderShipping

double | null

Order Level Shipping applied to this Item

weightedOrderShippingDiscount

double | null

Order Level Shipping discount applied to this Item

weightedOrderShippingManualAdjustment

double | null

Order Level Shipping Manual Adjustment applied to this Item

weightedOrderShippingTax

double | null

Order Level Shipping Tax applied to this Item

weightedOrderHandlingFee

double | null

Order Level handling fee applied to this item

weightedOrderHandlingFeeTax

double | null

Order Level handling fee tax applied to this item

weightedOrderHandlingFeeDiscount

double | null

Order Level handling fee discount applied to this item

weightedOrderDuty

double | null

Order Level Duty applied to this Item

totalWithWeightedShippingAndHandling

double | null

Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs

weightedOrderHandlingAdjustment

double | null

Order level handling adjusment that applies to this item.

autoAddDiscountId

int32 | null

Track the discoutid from which the item was auto added

isAssemblyRequired

boolean

Assembly Required for this order item

childItemIds

array of strings | null

List of Child Item Ids for this order item

childItemIds

parentItemId

string | null

Indicates Parent Item Id for this order item

inventoryTags

array of objects | null

inventoryTags

object

name

string | null

value

string | null

lineItemAdjustment

double | null

dutyAmount

double | null

Indicate Duty Amount for this item.

substituteInfo

object

optIn

string | null

Determines if and when substitution is allowed. Allowed values are None, Yes, No, or OnlyAtFulfillment. Default is None.

substituteProductCode

string | null

Allows user to provide a specific product that should be substituted if substitution occurs.

substituteVariantCode

string | null

Allows user to provide a specific variant that should be substituted if substitution occurs.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/wishlists/wishlistId/items/wishlistItemId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success