Update User Cart

PUT

commerce

carts

user

{userId}

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"
  },
  "cartMessage": {
    "message": "<string>",
    "messageType": "<string>",
    "productsRemoved": [
      {
        "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>"
      }
    ]
  },
  "cartMessages": [
    {
      "message": "<string>",
      "messageType": "<string>",
      "productsRemoved": [
        {
          "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>"
        }
      ]
    }
  ],
  "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>",
  "couponCodes": [
    "<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>"
  },
  "handlingAmount": 123,
  "handlingSubTotal": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "id": "<string>",
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123,
      "reason": "<string>",
      "reasonCode": 123
    }
  ],
  "itemTaxTotal": 123,
  "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,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "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>",
      "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
        }
      ],
      "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,
      "subscription": {
        "frequency": {
          "unit": "<string>",
          "value": 123
        },
        "required": true,
        "trial": {
          "duration": 123,
          "enabled": true,
          "substituteProductCode": "<string>",
          "substituteProductOptions": [
            {
              "attributeFQN": "<string>",
              "dataType": "<string>",
              "name": "<string>",
              "shopperEnteredValue": "<unknown>",
              "stringValue": "<string>",
              "value": "<unknown>"
            }
          ],
          "substituteProductQuantity": 123,
          "substituteVariationProductCode": "<string>"
        }
      },
      "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
    }
  ],
  "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
    }
  ],
  "priceListCode": "<string>",
  "rejectedDiscounts": [
    {
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true,
      "productCode": "<string>"
    }
  ],
  "reservationId": "<string>",
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "shippingGroups": [
    {
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "handlingAmount": 123,
      "handlingDiscounts": [
        {
          "couponCode": "<string>",
          "data": {},
          "discount": {
            "expirationDate": "2023-11-07T05:31:56Z",
            "hasMultipleTargetProducts": true,
            "id": 123,
            "itemIds": [
              "<string>"
            ],
            "name": "<string>"
          },
          "excluded": true,
          "groupId": "<string>",
          "impact": 123
        }
      ],
      "handlingTax": 123,
      "handlingTaxTotal": 123,
      "handlingTotal": 123,
      "id": "<string>",
      "orderItemIds": [
        "<string>"
      ],
      "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>"
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "shippingTaxTotal": 123,
      "shippingTotal": 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>",
  "zipCode": "<string>"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

userId

string

required

Unique identifier of the user.

Query Parameters

accountId

integer<int32>

Unique identifier of the customer account.

responseFields

string

limits which fields are returned in the response body

Body

application/json

All properties of the cart to update. Required property: Product.ProductCode.

Details of the current cart, including shopper's user ID, items listed in the cart, and any system messages. For each item, contains the list of available discounts and the actual discount applied to the cart item.

auditInfo

object

Show child attributes

cartMessage

object

Show child attributes

cartMessages

object[] | null

Show child attributes

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.

Show child attributes

channelCode

string | null

Unique identifier of the channel for this item.

couponCodes

string[] | null

Coupon codes associated with this order. Only set on order import.

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 | null

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.

Show child attributes

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.

Show child attributes

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

Show child attributes

handlingAmount

number<double> | null

Order level handling fees excluding any discounts.

handlingSubTotal

number<double> | null

Handling fees for the Order as well as CartItems (e.g. if the Cart has a $5 handling fee and an CartItem has a $2 handling fee per item quantity and the quantity of items is 2 then the value in this property would be $9)

handlingTaxTotal

number<double> | null

Total tax on handling

handlingTotal

number<double> | null

Handling fees including any discounts.

string | null

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

invalidCoupons

object[] | null

A list of invalid coupons that were attempted on the cart

Show child attributes

itemTaxTotal

number<double> | null

Not implemented. Tax does not appear on cart.

items

object[] | null

List of items in the cart.

Show child attributes

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.

Show child attributes

priceListCode

string | null

Pricelist code

rejectedDiscounts

object[] | null

Show child attributes

reservationId

string | null

Inventory Reservation id for a cart.

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping Amount before discount and adjustments

shippingGroups

object[] | null

List of groupings. The grouping is determined by the ShippingGrouper based on the items in the cart. Each grouping represents a set of items that can be fulfilled together, typically because they share the same fulfillment method, shipping method and a location.

Show child attributes

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

Show child attributes

taxData

object | null

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.

zipCode

string | null

Response

auditInfo

object

Show child attributes

cartMessage

object

Show child attributes

cartMessages

object[] | null

Show child attributes

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.

Show child attributes

channelCode

string | null

Unique identifier of the channel for this item.

couponCodes

string[] | null

Coupon codes associated with this order. Only set on order import.

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 | null

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.

Show child attributes

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

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.

Show child attributes

feeTotal

number<double> | null

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

fulfillmentInfo

object

Show child attributes

handlingAmount

number<double> | null

Order level handling fees excluding any discounts.

handlingSubTotal

number<double> | null

handlingTaxTotal

number<double> | null

Total tax on handling

handlingTotal

number<double> | null

Handling fees including any discounts.

string | null

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

invalidCoupons

object[] | null

A list of invalid coupons that were attempted on the cart

Show child attributes

itemTaxTotal

number<double> | null

Not implemented. Tax does not appear on cart.

items

object[] | null

List of items in the cart.

Show child attributes

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

Show child attributes

priceListCode

string | null

Pricelist code

rejectedDiscounts

object[] | null

Show child attributes

reservationId

string | null

Inventory Reservation id for a cart.

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping Amount before discount and adjustments

shippingGroups

object[] | null

Show child attributes

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

Show child attributes

taxData

object | null

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.

zipCode

string | null

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"
  },
  "cartMessage": {
    "message": "<string>",
    "messageType": "<string>",
    "productsRemoved": [
      {
        "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>"
      }
    ]
  },
  "cartMessages": [
    {
      "message": "<string>",
      "messageType": "<string>",
      "productsRemoved": [
        {
          "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>"
        }
      ]
    }
  ],
  "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>",
  "couponCodes": [
    "<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>"
  },
  "handlingAmount": 123,
  "handlingSubTotal": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "id": "<string>",
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123,
      "reason": "<string>",
      "reasonCode": 123
    }
  ],
  "itemTaxTotal": 123,
  "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,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "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>",
      "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
        }
      ],
      "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,
      "subscription": {
        "frequency": {
          "unit": "<string>",
          "value": 123
        },
        "required": true,
        "trial": {
          "duration": 123,
          "enabled": true,
          "substituteProductCode": "<string>",
          "substituteProductOptions": [
            {
              "attributeFQN": "<string>",
              "dataType": "<string>",
              "name": "<string>",
              "shopperEnteredValue": "<unknown>",
              "stringValue": "<string>",
              "value": "<unknown>"
            }
          ],
          "substituteProductQuantity": 123,
          "substituteVariationProductCode": "<string>"
        }
      },
      "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
    }
  ],
  "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
    }
  ],
  "priceListCode": "<string>",
  "rejectedDiscounts": [
    {
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true,
      "productCode": "<string>"
    }
  ],
  "reservationId": "<string>",
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "shippingGroups": [
    {
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "handlingAmount": 123,
      "handlingDiscounts": [
        {
          "couponCode": "<string>",
          "data": {},
          "discount": {
            "expirationDate": "2023-11-07T05:31:56Z",
            "hasMultipleTargetProducts": true,
            "id": 123,
            "itemIds": [
              "<string>"
            ],
            "name": "<string>"
          },
          "excluded": true,
          "groupId": "<string>",
          "impact": 123
        }
      ],
      "handlingTax": 123,
      "handlingTaxTotal": 123,
      "handlingTotal": 123,
      "id": "<string>",
      "orderItemIds": [
        "<string>"
      ],
      "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>"
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "shippingTaxTotal": 123,
      "shippingTotal": 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>",
  "zipCode": "<string>"
}

Developers

API reference

AI Tools

Authorizations

Path Parameters

Query Parameters

Body

Response