Add Item To Wishlist

POST

commerce

wishlists

{wishlistId}

items

Error

A valid request URL is required to generate request examples

{
  "adjustedLineItemSubtotal": 123,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "autoAddDiscountId": 123,
  "childItemIds": [
    "<string>"
  ],
  "comments": "<string>",
  "data": {},
  "discountTotal": 123,
  "discountedTotal": 123,
  "dutyAmount": 123,
  "extendedTotal": 123,
  "feeTotal": 123,
  "handlingAmount": 123,
  "id": "<string>",
  "inventoryTags": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "isAssemblyRequired": true,
  "isRecurring": true,
  "isTaxable": true,
  "itemTaxTotal": 123,
  "lineId": 123,
  "lineItemAdjustment": 123,
  "localeCode": "<string>",
  "parentItemId": "<string>",
  "priceMode": "<string>",
  "priorityType": "<string>",
  "product": {
    "allocationExpiration": "2023-11-07T05:31:56Z",
    "allocationId": 123,
    "bundledProducts": [
      {
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "allocationId": 123,
        "creditValue": 123,
        "deltaPrice": 123,
        "description": "<string>",
        "fulfillmentStatus": "<string>",
        "goodsType": "<string>",
        "imageUrl": "<string>",
        "isPackagedStandAlone": true,
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          }
        },
        "name": "<string>",
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "productCode": "<string>",
        "productReservationId": 123,
        "quantity": 123,
        "stock": {
          "aggregateInventory": 123,
          "availableDate": "2023-11-07T05:31:56Z",
          "availableFutureInventories": 123,
          "futureInventories": [
            {
              "allocated": 123,
              "available": 123,
              "createDate": "2023-11-07T05:31:56Z",
              "deliveryDate": "2023-11-07T05:31:56Z",
              "futureInventoryID": 123,
              "onhand": 123,
              "pending": 123
            }
          ],
          "isOnBackOrder": true,
          "isSubstitutable": true,
          "manageStock": true,
          "stockAvailable": 123,
          "totalAvailableStock": 123
        }
      }
    ],
    "categories": [
      {
        "id": 123,
        "parent": "<unknown>"
      }
    ],
    "condition": "<string>",
    "description": "<string>",
    "discountsRestricted": true,
    "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
    "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
    "fulfillmentFields": [
      {
        "name": "<string>",
        "required": true,
        "userEnteredValue": null
      }
    ],
    "fulfillmentStatus": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "goodsType": "<string>",
    "imageAlternateText": "<string>",
    "imageUrl": "<string>",
    "isPackagedStandAlone": true,
    "isRecurring": true,
    "isTaxable": true,
    "measurements": {
      "height": {
        "unit": "<string>",
        "value": 123
      },
      "length": {
        "unit": "<string>",
        "value": 123
      },
      "weight": {
        "unit": "<string>",
        "value": 123
      },
      "width": {
        "unit": "<string>",
        "value": 123
      }
    },
    "mfgPartNumber": "<string>",
    "name": "<string>",
    "options": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "name": "<string>",
        "shopperEnteredValue": "<unknown>",
        "stringValue": "<string>",
        "value": "<unknown>"
      }
    ],
    "price": {
      "creditValue": 123,
      "isOverRidePriceSalePrice": true,
      "msrp": 123,
      "price": 123,
      "priceListCode": "<string>",
      "priceListEntryMode": "<string>",
      "salePrice": 123,
      "tenantOverridePrice": 123
    },
    "productCode": "<string>",
    "productReservationId": 123,
    "productType": "<string>",
    "productUsage": "<string>",
    "properties": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "isMultiValue": true,
        "name": "<string>",
        "values": [
          {
            "stringValue": "<string>",
            "value": null
          }
        ]
      }
    ],
    "serialNumber": "<string>",
    "sku": "<string>",
    "stock": {
      "aggregateInventory": 123,
      "availableDate": "2023-11-07T05:31:56Z",
      "availableFutureInventories": 123,
      "futureInventories": [
        {
          "allocated": 123,
          "available": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "deliveryDate": "2023-11-07T05:31:56Z",
          "futureInventoryID": 123,
          "onhand": 123,
          "pending": 123
        }
      ],
      "isOnBackOrder": true,
      "isSubstitutable": true,
      "manageStock": true,
      "stockAvailable": 123,
      "totalAvailableStock": 123
    },
    "upc": "<string>",
    "variationProductCode": "<string>"
  },
  "productDiscount": {
    "appliesToSalePrice": true,
    "discountQuantity": 123
  },
  "productDiscounts": [
    {
      "appliesToSalePrice": true,
      "discountQuantity": 123
    }
  ],
  "purchasableStatusType": "<string>",
  "purchaseLocation": "<string>",
  "quantity": 123,
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "shippingDiscounts": [
    {
      "discount": {
        "couponCode": "<string>",
        "data": {},
        "discount": {
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true,
          "id": 123,
          "itemIds": [
            "<string>"
          ],
          "name": "<string>"
        },
        "excluded": true,
        "groupId": "<string>",
        "impact": 123
      },
      "discountQuantity": 123,
      "impactPerUnit": 123,
      "methodCode": "<string>"
    }
  ],
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "substituteInfo": {
    "optIn": "<string>",
    "substituteProductCode": "<string>",
    "substituteVariantCode": "<string>"
  },
  "subtotal": 123,
  "taxData": {},
  "taxableTotal": 123,
  "total": 123,
  "totalWithWeightedShippingAndHandling": 123,
  "totalWithoutWeightedShippingAndHandling": 123,
  "unitPrice": {
    "extendedAmount": 123,
    "listAmount": 123,
    "overrideAmount": 123,
    "saleAmount": 123
  },
  "weightedOrderAdjustment": 123,
  "weightedOrderDiscount": 123,
  "weightedOrderDuty": 123,
  "weightedOrderHandlingAdjustment": 123,
  "weightedOrderHandlingFee": 123,
  "weightedOrderHandlingFeeDiscount": 123,
  "weightedOrderHandlingFeeTax": 123,
  "weightedOrderShipping": 123,
  "weightedOrderShippingDiscount": 123,
  "weightedOrderShippingManualAdjustment": 123,
  "weightedOrderShippingTax": 123,
  "weightedOrderTax": 123
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

wishlistId

string

required

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

A single line item of an order.

adjustedLineItemSubtotal

number<double> | null

Order Level taxable sub total

auditInfo

object

Show child attributes

autoAddDiscountId

integer<int32> | null

Track the discoutid from which the item was auto added

childItemIds

string[] | null

List of Child Item Ids for this order item

comments

string | null

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

data

object | null

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

discountTotal

number<double> | null

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

discountedTotal

number<double> | null

Subtotal minus any discounts.

dutyAmount

number<double> | null

Indicate Duty Amount for this item.

extendedTotal

number<double> | null

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

feeTotal

number<double> | null

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

handlingAmount

number<double> | null

Product-level handling fee for this item (e.g. special packaging, hazmat fees). This does NOT include order-level handling fees — those are in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.WeightedOrderHandlingFee. Total handling on the shipment = HandlingAmount + WeightedOrderHandlingFee.

string | null

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

inventoryTags

object[] | null

Show child attributes

isAssemblyRequired

boolean

Assembly Required for this order item

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.

itemTaxTotal

number<double> | null

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

lineId

integer<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.

lineItemAdjustment

number<double> | null

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.

parentItemId

string | null

Indicates Parent Item Id for this order item

priceMode

string | null

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

priorityType

string | null

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

product

object

The product as it appears on the order item.

Show child attributes

productDiscount

object

Show child attributes

productDiscounts

object[] | null

A list of discounts applied to the product

Show child attributes

purchasableStatusType

string | null

Is the item purchasable?

purchaseLocation

string | null

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

quantity

integer<int32>

Number of products ordered.

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping amount before Discounts and adjustments

shippingDiscounts

object[] | null

A discount applied to the shipping

Show child attributes

shippingTaxTotal

number<double> | null

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

shippingTotal

number<double> | null

Total price of shipping that apply to this item.

substituteInfo

object

Show child attributes

subtotal

number<double> | null

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

taxData

object | null

Storage for any additional/custom tax data.

taxableTotal

number<double> | null

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

total

number<double> | null

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

totalWithWeightedShippingAndHandling

number<double> | null

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

totalWithoutWeightedShippingAndHandling

number<double> | null

Taxable Subtotal including Weighted Order amounts

unitPrice

object

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

Show child attributes

weightedOrderAdjustment

number<double> | null

Order Level Manual Adjustment applied to this Item

weightedOrderDiscount

number<double> | null

Order Level Discount applied to this Item

weightedOrderDuty

number<double> | null

Order Level Duty applied to this Item

weightedOrderHandlingAdjustment

number<double> | null

Order-level handling manual adjustment allocated to this item.

weightedOrderHandlingFee

number<double> | null

Order-level handling fee allocated to this item (e.g. flat handling fee spread across all items). This is separate from product-level handling in Mozu.CommerceRuntime.Contracts.Commerce.CommerceItem.HandlingAmount. Total handling on the shipment = HandlingAmount + WeightedOrderHandlingFee.

weightedOrderHandlingFeeDiscount

number<double> | null

Order-level handling fee discount allocated to this item.

weightedOrderHandlingFeeTax

number<double> | null

Total handling tax for this item (covers both product-level and order-level handling tax combined). On the shipment item, this is split into: HandlingTax (total) and WeightedOrderHandlingFeeTax (order-level portion only).

weightedOrderShipping

number<double> | null

Order Level Shipping applied to this Item

weightedOrderShippingDiscount

number<double> | null

Order Level Shipping discount applied to this Item

weightedOrderShippingManualAdjustment

number<double> | null

Order Level Shipping Manual Adjustment applied to this Item

weightedOrderShippingTax

number<double> | null

Order Level Shipping Tax applied to this Item

weightedOrderTax

number<double> | null

Order Level tax applied to this Item

Response

A single line item of an order.

adjustedLineItemSubtotal

number<double> | null

Order Level taxable sub total

auditInfo

object

Show child attributes

autoAddDiscountId

integer<int32> | null

Track the discoutid from which the item was auto added

childItemIds

string[] | null

List of Child Item Ids for this order item

comments

string | null

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

data

object | null

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

discountTotal

number<double> | null

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

discountedTotal

number<double> | null

Subtotal minus any discounts.

dutyAmount

number<double> | null

Indicate Duty Amount for this item.

extendedTotal

number<double> | null

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

feeTotal

number<double> | null

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

handlingAmount

number<double> | null

string | null

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

inventoryTags

object[] | null

Show child attributes

isAssemblyRequired

boolean

Assembly Required for this order item

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.

itemTaxTotal

number<double> | null

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

lineId

integer<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.

lineItemAdjustment

number<double> | null

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.

parentItemId

string | null

Indicates Parent Item Id for this order item

priceMode

string | null

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

priorityType

string | null

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

product

object

The product as it appears on the order item.

Show child attributes

productDiscount

object

Show child attributes

productDiscounts

object[] | null

A list of discounts applied to the product

Show child attributes

purchasableStatusType

string | null

Is the item purchasable?

purchaseLocation

string | null

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

quantity

integer<int32>

Number of products ordered.

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping amount before Discounts and adjustments

shippingDiscounts

object[] | null

A discount applied to the shipping

Show child attributes

shippingTaxTotal

number<double> | null

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

shippingTotal

number<double> | null

Total price of shipping that apply to this item.

substituteInfo

object

Show child attributes

subtotal

number<double> | null

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

taxData

object | null

Storage for any additional/custom tax data.

taxableTotal

number<double> | null

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

total

number<double> | null

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

totalWithWeightedShippingAndHandling

number<double> | null

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

totalWithoutWeightedShippingAndHandling

number<double> | null

Taxable Subtotal including Weighted Order amounts

unitPrice

object

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

Show child attributes

weightedOrderAdjustment

number<double> | null

Order Level Manual Adjustment applied to this Item

weightedOrderDiscount

number<double> | null

Order Level Discount applied to this Item

weightedOrderDuty

number<double> | null

Order Level Duty applied to this Item

weightedOrderHandlingAdjustment

number<double> | null

Order-level handling manual adjustment allocated to this item.

weightedOrderHandlingFee

number<double> | null

weightedOrderHandlingFeeDiscount

number<double> | null

Order-level handling fee discount allocated to this item.

weightedOrderHandlingFeeTax

number<double> | null

weightedOrderShipping

number<double> | null

Order Level Shipping applied to this Item

weightedOrderShippingDiscount

number<double> | null

Order Level Shipping discount applied to this Item

weightedOrderShippingManualAdjustment

number<double> | null

Order Level Shipping Manual Adjustment applied to this Item

weightedOrderShippingTax

number<double> | null

Order Level Shipping Tax applied to this Item

weightedOrderTax

number<double> | null

Order Level tax applied to this Item

Error

A valid request URL is required to generate request examples

{
  "adjustedLineItemSubtotal": 123,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "autoAddDiscountId": 123,
  "childItemIds": [
    "<string>"
  ],
  "comments": "<string>",
  "data": {},
  "discountTotal": 123,
  "discountedTotal": 123,
  "dutyAmount": 123,
  "extendedTotal": 123,
  "feeTotal": 123,
  "handlingAmount": 123,
  "id": "<string>",
  "inventoryTags": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "isAssemblyRequired": true,
  "isRecurring": true,
  "isTaxable": true,
  "itemTaxTotal": 123,
  "lineId": 123,
  "lineItemAdjustment": 123,
  "localeCode": "<string>",
  "parentItemId": "<string>",
  "priceMode": "<string>",
  "priorityType": "<string>",
  "product": {
    "allocationExpiration": "2023-11-07T05:31:56Z",
    "allocationId": 123,
    "bundledProducts": [
      {
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "allocationId": 123,
        "creditValue": 123,
        "deltaPrice": 123,
        "description": "<string>",
        "fulfillmentStatus": "<string>",
        "goodsType": "<string>",
        "imageUrl": "<string>",
        "isPackagedStandAlone": true,
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          }
        },
        "name": "<string>",
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "productCode": "<string>",
        "productReservationId": 123,
        "quantity": 123,
        "stock": {
          "aggregateInventory": 123,
          "availableDate": "2023-11-07T05:31:56Z",
          "availableFutureInventories": 123,
          "futureInventories": [
            {
              "allocated": 123,
              "available": 123,
              "createDate": "2023-11-07T05:31:56Z",
              "deliveryDate": "2023-11-07T05:31:56Z",
              "futureInventoryID": 123,
              "onhand": 123,
              "pending": 123
            }
          ],
          "isOnBackOrder": true,
          "isSubstitutable": true,
          "manageStock": true,
          "stockAvailable": 123,
          "totalAvailableStock": 123
        }
      }
    ],
    "categories": [
      {
        "id": 123,
        "parent": "<unknown>"
      }
    ],
    "condition": "<string>",
    "description": "<string>",
    "discountsRestricted": true,
    "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
    "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
    "fulfillmentFields": [
      {
        "name": "<string>",
        "required": true,
        "userEnteredValue": null
      }
    ],
    "fulfillmentStatus": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "goodsType": "<string>",
    "imageAlternateText": "<string>",
    "imageUrl": "<string>",
    "isPackagedStandAlone": true,
    "isRecurring": true,
    "isTaxable": true,
    "measurements": {
      "height": {
        "unit": "<string>",
        "value": 123
      },
      "length": {
        "unit": "<string>",
        "value": 123
      },
      "weight": {
        "unit": "<string>",
        "value": 123
      },
      "width": {
        "unit": "<string>",
        "value": 123
      }
    },
    "mfgPartNumber": "<string>",
    "name": "<string>",
    "options": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "name": "<string>",
        "shopperEnteredValue": "<unknown>",
        "stringValue": "<string>",
        "value": "<unknown>"
      }
    ],
    "price": {
      "creditValue": 123,
      "isOverRidePriceSalePrice": true,
      "msrp": 123,
      "price": 123,
      "priceListCode": "<string>",
      "priceListEntryMode": "<string>",
      "salePrice": 123,
      "tenantOverridePrice": 123
    },
    "productCode": "<string>",
    "productReservationId": 123,
    "productType": "<string>",
    "productUsage": "<string>",
    "properties": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "isMultiValue": true,
        "name": "<string>",
        "values": [
          {
            "stringValue": "<string>",
            "value": null
          }
        ]
      }
    ],
    "serialNumber": "<string>",
    "sku": "<string>",
    "stock": {
      "aggregateInventory": 123,
      "availableDate": "2023-11-07T05:31:56Z",
      "availableFutureInventories": 123,
      "futureInventories": [
        {
          "allocated": 123,
          "available": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "deliveryDate": "2023-11-07T05:31:56Z",
          "futureInventoryID": 123,
          "onhand": 123,
          "pending": 123
        }
      ],
      "isOnBackOrder": true,
      "isSubstitutable": true,
      "manageStock": true,
      "stockAvailable": 123,
      "totalAvailableStock": 123
    },
    "upc": "<string>",
    "variationProductCode": "<string>"
  },
  "productDiscount": {
    "appliesToSalePrice": true,
    "discountQuantity": 123
  },
  "productDiscounts": [
    {
      "appliesToSalePrice": true,
      "discountQuantity": 123
    }
  ],
  "purchasableStatusType": "<string>",
  "purchaseLocation": "<string>",
  "quantity": 123,
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "shippingDiscounts": [
    {
      "discount": {
        "couponCode": "<string>",
        "data": {},
        "discount": {
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true,
          "id": 123,
          "itemIds": [
            "<string>"
          ],
          "name": "<string>"
        },
        "excluded": true,
        "groupId": "<string>",
        "impact": 123
      },
      "discountQuantity": 123,
      "impactPerUnit": 123,
      "methodCode": "<string>"
    }
  ],
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "substituteInfo": {
    "optIn": "<string>",
    "substituteProductCode": "<string>",
    "substituteVariantCode": "<string>"
  },
  "subtotal": 123,
  "taxData": {},
  "taxableTotal": 123,
  "total": 123,
  "totalWithWeightedShippingAndHandling": 123,
  "totalWithoutWeightedShippingAndHandling": 123,
  "unitPrice": {
    "extendedAmount": 123,
    "listAmount": 123,
    "overrideAmount": 123,
    "saleAmount": 123
  },
  "weightedOrderAdjustment": 123,
  "weightedOrderDiscount": 123,
  "weightedOrderDuty": 123,
  "weightedOrderHandlingAdjustment": 123,
  "weightedOrderHandlingFee": 123,
  "weightedOrderHandlingFeeDiscount": 123,
  "weightedOrderHandlingFeeTax": 123,
  "weightedOrderShipping": 123,
  "weightedOrderShippingDiscount": 123,
  "weightedOrderShippingManualAdjustment": 123,
  "weightedOrderShippingTax": 123,
  "weightedOrderTax": 123
}

Developers

API reference

AI Tools

Authorizations

Path Parameters

Query Parameters

Body

Response