Skip to main content
POST
/
commerce
/
wishlists
Error
A valid request URL is required to generate request examples
{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "changeMessages": [
    {
      "amount": 123,
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "attributes": {},
      "correlationId": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "identifier": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "subject": "<string>",
      "subjectType": "<string>",
      "success": true,
      "userFirstName": "<string>",
      "userId": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "verb": "<string>"
    }
  ],
  "channelCode": "<string>",
  "currencyCode": "<string>",
  "customerInteractionType": "<string>",
  "data": {},
  "discountThresholdMessages": [
    {
      "discountId": 123,
      "message": "<string>",
      "requiresCouponCode": true,
      "showInCart": true,
      "showOnCheckout": true,
      "thresholdValue": 123
    }
  ],
  "discountTotal": 123,
  "discountedSubtotal": 123,
  "discountedTotal": 123,
  "expirationDate": "2023-11-07T05:31:56Z",
  "extendedProperties": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "feeTotal": 123,
  "fulfillmentInfo": {
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "data": {},
    "fulfillmentContact": {
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "addressType": "<string>",
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "id": 123,
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      }
    },
    "isDestinationCommercial": true,
    "shippingMethodCode": "<string>",
    "shippingMethodName": "<string>"
  },
  "handlingTaxTotal": 123,
  "id": "<string>",
  "itemTaxTotal": 123,
  "lastValidationDate": "2023-11-07T05:31:56Z",
  "lineItemSubtotalWithOrderAdjustments": 123,
  "orderDiscounts": [
    {
      "couponCode": "<string>",
      "data": {},
      "discount": {
        "expirationDate": "2023-11-07T05:31:56Z",
        "hasMultipleTargetProducts": true,
        "id": 123,
        "itemIds": [
          "<string>"
        ],
        "name": "<string>"
      },
      "excluded": true,
      "groupId": "<string>",
      "impact": 123
    }
  ],
  "rejectedDiscounts": [
    {
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true,
      "productCode": "<string>"
    }
  ],
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "shippingSubTotal": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "siteId": 123,
  "subtotal": 123,
  "suggestedDiscounts": [
    {
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true,
      "productCode": "<string>"
    }
  ],
  "taxData": {},
  "taxTotal": 123,
  "tenantId": 123,
  "total": 123,
  "userId": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>",
  "customerAccountId": 123,
  "externalId": "<string>",
  "importDate": "2023-11-07T05:31:56Z",
  "isImport": true,
  "items": [
    {
      "adjustedLineItemSubtotal": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "autoAddDiscountId": 123,
      "childItemIds": [
        "<string>"
      ],
      "data": {},
      "discountTotal": 123,
      "discountedTotal": 123,
      "dutyAmount": 123,
      "extendedTotal": 123,
      "feeTotal": 123,
      "handlingAmount": 123,
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isRecurring": true,
      "isTaxable": true,
      "itemTaxTotal": 123,
      "lineId": 123,
      "lineItemAdjustment": 123,
      "localeCode": "<string>",
      "parentItemId": "<string>",
      "product": {
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "allocationId": 123,
        "description": "<string>",
        "fulfillmentStatus": "<string>",
        "goodsType": "<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>",
        "productCode": "<string>",
        "productReservationId": 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
        },
        "bundledProducts": [
          {
            "allocationExpiration": "2023-11-07T05:31:56Z",
            "allocationId": 123,
            "description": "<string>",
            "fulfillmentStatus": "<string>",
            "goodsType": "<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>",
            "productCode": "<string>",
            "productReservationId": 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
            },
            "creditValue": 123,
            "deltaPrice": 123,
            "imageUrl": "<string>",
            "optionAttributeFQN": "<string>",
            "optionValue": "<unknown>",
            "quantity": 123
          }
        ],
        "categories": [
          {
            "id": 123,
            "parent": {}
          }
        ],
        "condition": "<string>",
        "discountsRestricted": true,
        "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
        "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
        "fulfillmentFields": [
          {
            "name": "<string>",
            "required": true,
            "userEnteredValue": null
          }
        ],
        "fulfillmentTypesSupported": [
          "<string>"
        ],
        "imageAlternateText": "<string>",
        "imageUrl": "<string>",
        "isRecurring": true,
        "isTaxable": true,
        "mfgPartNumber": "<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
        },
        "productType": "<string>",
        "productUsage": "<string>",
        "properties": [
          {
            "attributeFQN": "<string>",
            "dataType": "<string>",
            "isMultiValue": true,
            "name": "<string>",
            "values": [
              {
                "stringValue": "<string>",
                "value": null
              }
            ]
          }
        ],
        "serialNumber": "<string>",
        "sku": "<string>",
        "upc": "<string>",
        "variationProductCode": "<string>"
      },
      "productDiscount": {
        "couponCode": "<string>",
        "data": {},
        "discount": {
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true,
          "id": 123,
          "itemIds": [
            "<string>"
          ],
          "name": "<string>"
        },
        "excluded": true,
        "groupId": "<string>",
        "impact": 123,
        "appliesToSalePrice": true,
        "impactPerUnit": 123,
        "productQuantity": 123,
        "discountQuantity": 123
      },
      "productDiscounts": [
        {
          "couponCode": "<string>",
          "data": {},
          "discount": {
            "expirationDate": "2023-11-07T05:31:56Z",
            "hasMultipleTargetProducts": true,
            "id": 123,
            "itemIds": [
              "<string>"
            ],
            "name": "<string>"
          },
          "excluded": true,
          "groupId": "<string>",
          "impact": 123,
          "appliesToSalePrice": true,
          "impactPerUnit": 123,
          "productQuantity": 123,
          "discountQuantity": 123
        }
      ],
      "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
          },
          "methodCode": "<string>",
          "discountQuantity": 123,
          "impactPerUnit": 123
        }
      ],
      "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,
      "comments": "<string>",
      "id": "<string>",
      "priceMode": "<string>",
      "priorityType": "<string>",
      "purchasableStatusType": "<string>"
    }
  ],
  "name": "<string>",
  "privacyType": "<string>",
  "sortOrder": 123,
  "typeTag": "<string>",
  "version": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Details of the wishlist, items listed in the wishlist, and any system messages.

​
auditInfo
object
​
changeMessages
object[] | null

List of messages displayed by the system based on the last cart action, for example, when a product price has changed or is out-of-stock. System-supplied and read-only.

​
channelCode
string | null

Unique identifier of the channel for this item.

​
currencyCode
string | null

ISO Currency Code. Currently, only USD is supported.

​
customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

​
data
object

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

​
discountThresholdMessages
object[] | null

List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.

​
discountTotal
number<double> | null

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

​
discountedSubtotal
number<double> | null

Combined price for all cart items, including all selected options as well as any discounts.

​
discountedTotal
number<double> | null

Subtotal minus the discounted total

​
expirationDate
string<date-time> | null

When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged into their account. Date in UTC Date/Time.

​
extendedProperties
object[] | null

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

​
feeTotal
number<double> | null

Not implemented. Total cost of fees for all items in the cart.

​
fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

​
handlingTaxTotal
number<double> | null

Total tax on handling

​
id
string | null

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

​
itemTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

​
lastValidationDate
string<date-time> | null

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

​
lineItemSubtotalWithOrderAdjustments
number<double> | null

Line Item Subtotals with Order Adjustments

​
orderDiscounts
object[] | null

The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative number.

​
rejectedDiscounts
object[] | null
​
shippingAmountBeforeDiscountsAndAdjustments
number<double> | null

Shipping Amount before discount and adjustments

​
shippingSubTotal
number<double> | null

Shipping total without discounts applied.

​
shippingTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

​
shippingTotal
number<double> | null

Shipping does not appear on cart.

​
siteId
integer<int32> | null

Unique identifier of the Site.

​
subtotal
number<double> | null

Combined price for all cart items, including all selected options but excluding any discounts.

​
suggestedDiscounts
object[] | null
​
taxData
object

Storage for any additional/custom tax data.

​
taxTotal
number<double> | null

Tax does not appear on cart.

​
tenantId
integer<int32> | null

Unique identifier of the Tenant.

​
total
number<double> | null

Final total amount of the order including all discounts, shipping, and tax.

​
userId
string | null

Unique identifier of the shopper who created the cart.

​
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

​
webSessionId
string | null

Identifies the web session used to place the order or last update the cart.

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
externalId
string | null

Id in an external system this item may have been imported from

​
importDate
string<date-time> | null

Date this item was imported

​
isImport
boolean | null

Was this object imported from an external system?

​
items
object[] | null

List of items in the wishlist.

​
name
string | null

Name of the list that is display or potentially shared (e.g. friends and family may view this description if the list is public and the list owner may see this description when viewing the list)

​
privacyType
string | null

Is the wishlist public, viewable only through a shared link, or private (only the owner of the list may view the wishlist)?

​
sortOrder
integer<int32> | null

The wishlist sort order. Useful for scenarios where there is a default wishlist and other wishlists or arbitrary ordering

​
typeTag
string | null

Open-ended Wishlist type, e.g. giftlist, gift, wish, wishlist, wedding, baby. If the merchant does not need this level of granularity this is always null.

​
version
string | null

Version for concurrency purposes

Response

Success

Details of the wishlist, items listed in the wishlist, and any system messages.

​
auditInfo
object
​
changeMessages
object[] | null

List of messages displayed by the system based on the last cart action, for example, when a product price has changed or is out-of-stock. System-supplied and read-only.

​
channelCode
string | null

Unique identifier of the channel for this item.

​
currencyCode
string | null

ISO Currency Code. Currently, only USD is supported.

​
customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

​
data
object

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

​
discountThresholdMessages
object[] | null

List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.

​
discountTotal
number<double> | null

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

​
discountedSubtotal
number<double> | null

Combined price for all cart items, including all selected options as well as any discounts.

​
discountedTotal
number<double> | null

Subtotal minus the discounted total

​
expirationDate
string<date-time> | null

When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged into their account. Date in UTC Date/Time.

​
extendedProperties
object[] | null

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

​
feeTotal
number<double> | null

Not implemented. Total cost of fees for all items in the cart.

​
fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

​
handlingTaxTotal
number<double> | null

Total tax on handling

​
id
string | null

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

​
itemTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

​
lastValidationDate
string<date-time> | null

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

​
lineItemSubtotalWithOrderAdjustments
number<double> | null

Line Item Subtotals with Order Adjustments

​
orderDiscounts
object[] | null

The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative number.

​
rejectedDiscounts
object[] | null
​
shippingAmountBeforeDiscountsAndAdjustments
number<double> | null

Shipping Amount before discount and adjustments

​
shippingSubTotal
number<double> | null

Shipping total without discounts applied.

​
shippingTaxTotal
number<double> | null

Not implemented. Tax does not appear on cart.

​
shippingTotal
number<double> | null

Shipping does not appear on cart.

​
siteId
integer<int32> | null

Unique identifier of the Site.

​
subtotal
number<double> | null

Combined price for all cart items, including all selected options but excluding any discounts.

​
suggestedDiscounts
object[] | null
​
taxData
object

Storage for any additional/custom tax data.

​
taxTotal
number<double> | null

Tax does not appear on cart.

​
tenantId
integer<int32> | null

Unique identifier of the Tenant.

​
total
number<double> | null

Final total amount of the order including all discounts, shipping, and tax.

​
userId
string | null

Unique identifier of the shopper who created the cart.

​
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

​
webSessionId
string | null

Identifies the web session used to place the order or last update the cart.

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
externalId
string | null

Id in an external system this item may have been imported from

​
importDate
string<date-time> | null

Date this item was imported

​
isImport
boolean | null

Was this object imported from an external system?

​
items
object[] | null

List of items in the wishlist.

​
name
string | null

Name of the list that is display or potentially shared (e.g. friends and family may view this description if the list is public and the list owner may see this description when viewing the list)

​
privacyType
string | null

Is the wishlist public, viewable only through a shared link, or private (only the owner of the list may view the wishlist)?

​
sortOrder
integer<int32> | null

The wishlist sort order. Useful for scenarios where there is a default wishlist and other wishlists or arbitrary ordering

​
typeTag
string | null

Open-ended Wishlist type, e.g. giftlist, gift, wish, wishlist, wedding, baby. If the merchant does not need this level of granularity this is always null.

​
version
string | null

Version for concurrency purposes