Skip to main content
POST
/
commerce
/
checkouts
/
{checkoutId}
/
items
Error
A valid request URL is required to generate request examples
{
  "acceptsMarketing": true,
  "alternateContact": {
    "emailAddress": "<string>",
    "firstName": "<string>",
    "lastNameOrSurname": "<string>",
    "phoneNumber": "<string>"
  },
  "amountRemainingForPayment": 123,
  "attributes": [
    {
      "attributeDefinitionId": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "fullyQualifiedName": "<string>",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "availableActions": [
    "<string>"
  ],
  "channelCode": "<string>",
  "couponCodes": [
    "<string>"
  ],
  "currencyCode": "<string>",
  "customerAccountId": 123,
  "customerInteractionType": "<string>",
  "customerTaxId": "<string>",
  "data": {},
  "destinations": [
    {
      "data": {},
      "destinationContact": {
        "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>"
        }
      },
      "id": "<string>",
      "isDestinationCommercial": true
    }
  ],
  "discountThresholdMessages": [
    {
      "discountId": 123,
      "message": "<string>",
      "requiresCouponCode": true,
      "showInCart": true,
      "showOnCheckout": true,
      "thresholdValue": 123
    }
  ],
  "dutyTotal": 123,
  "email": "<string>",
  "feeTotal": 123,
  "groupings": [
    {
      "destinationId": "<string>",
      "dutyAmount": 123,
      "dutyTotal": 123,
      "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
        }
      ],
      "handlingSubTotal": 123,
      "handlingTax": 123,
      "handlingTaxTotal": 123,
      "handlingTotal": 123,
      "id": "<string>",
      "itemLevelHandlingDiscountTotal": 123,
      "itemLevelShippingDiscountTotal": 123,
      "orderItemIds": [
        "<string>"
      ],
      "orderLevelHandlingDiscountTotal": 123,
      "orderLevelShippingDiscountTotal": 123,
      "shippingAmount": 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>"
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "shippingSubTotal": 123,
      "shippingTax": 123,
      "shippingTaxTotal": 123,
      "shippingTotal": 123,
      "standaloneGroup": true,
      "taxData": {}
    }
  ],
  "handlingSubTotal": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "id": "<string>",
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123,
      "reason": "<string>",
      "reasonCode": 123
    }
  ],
  "ipAddress": "<string>",
  "isTaxExempt": true,
  "itemLevelHandlingDiscountTotal": 123,
  "itemLevelProductDiscountTotal": 123,
  "itemLevelShippingDiscountTotal": 123,
  "itemTaxTotal": 123,
  "itemTotal": 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,
      "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,
      "deliveryWindow": {
        "endTime": "2023-11-07T05:31:56Z",
        "startTime": "2023-11-07T05:31:56Z"
      },
      "destinationId": "<string>",
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "giftInfo": {
        "giftMessage": "<string>",
        "isGiftItem": true
      },
      "id": "<string>",
      "isReservationEnabled": true,
      "originalCartItemId": "<string>",
      "priceMode": "<string>",
      "returnRuleInfo": {
        "isReturnable": true,
        "maxDays": 123,
        "maxQty": 123,
        "ruleCode": "<string>"
      },
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "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>"
        }
      },
      "suggestions": [
        {
          "futureDate": "2023-11-07T05:31:56Z",
          "locationCode": "<string>",
          "productCode": "<string>",
          "quantity": 123,
          "suggestionType": "<string>",
          "transferToLocationCode": "<string>"
        }
      ]
    }
  ],
  "locationCode": "<string>",
  "number": 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
    }
  ],
  "orderLevelHandlingDiscountTotal": 123,
  "orderLevelProductDiscountTotal": 123,
  "orderLevelShippingDiscountTotal": 123,
  "originalCartId": "<string>",
  "payments": [
    {
      "amountCollected": 123,
      "amountCredited": 123,
      "amountRequested": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "availableActions": [
        "<string>"
      ],
      "billingInfo": {
        "auditInfo": {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z"
        },
        "billingContact": {
          "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>"
          }
        },
        "card": {
          "bin": "<string>",
          "cardNumberPartOrMask": "<string>",
          "expireMonth": 123,
          "expireYear": 123,
          "paymentOrCardType": "<string>",
          "ccLastFour": "<string>",
          "isCardInfoSaved": true,
          "isTokenized": true,
          "isUsedRecurring": true,
          "nameOnCard": "<string>",
          "paymentServiceCardId": "<string>"
        },
        "check": {
          "checkNumber": "<string>"
        },
        "customCreditType": "<string>",
        "data": {},
        "externalTransactionId": "<string>",
        "isRecurring": true,
        "isSameBillingShippingAddress": true,
        "paymentType": "<string>",
        "paymentWorkflow": "<string>",
        "purchaseOrder": {
          "customFields": [
            {
              "code": "<string>",
              "label": "<string>",
              "value": "<string>"
            }
          ],
          "paymentTerm": {
            "code": "<string>",
            "description": "<string>"
          },
          "purchaseOrderNumber": "<string>"
        },
        "recurringTransactionId": "<string>",
        "storeCreditCode": "<string>",
        "storeCreditType": "<string>",
        "token": {
          "paymentServiceTokenId": "<string>",
          "type": "<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>"
        }
      ],
      "data": {},
      "externalTransactionId": "<string>",
      "gatewayGiftCard": {
        "amount": 123,
        "cardNumber": "<string>",
        "cardPin": "<string>",
        "currencyCode": "<string>",
        "id": "<string>"
      },
      "groupId": {
        "targetId": "<string>",
        "targetNumber": 123,
        "targetType": "<string>"
      },
      "id": "<string>",
      "installmentPlanCode": "<string>",
      "interactions": [
        {
          "amount": 123,
          "auditInfo": {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z"
          },
          "capturableShipmentsSummary": [
            {
              "amountApplied": 123,
              "shipmentNumber": 123,
              "shipmentTotal": 123
            }
          ],
          "checkNumber": "<string>",
          "currencyCode": "<string>",
          "gatewayAVSCodes": "<string>",
          "gatewayAuthCode": "<string>",
          "gatewayCVV2Codes": "<string>",
          "gatewayInteractionId": 123,
          "gatewayResponseCode": "<string>",
          "gatewayResponseData": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "gatewayResponseText": "<string>",
          "gatewayTransactionId": "<string>",
          "id": "<string>",
          "interactionDate": "2023-11-07T05:31:56Z",
          "interactionType": "<string>",
          "isManual": true,
          "isPending": true,
          "isRecurring": true,
          "note": "<string>",
          "orderId": "<string>",
          "paymentEntryStatus": "<string>",
          "paymentId": "<string>",
          "paymentTransactionInteractionIdReference": 123,
          "refundId": "<string>",
          "returnId": "<string>",
          "status": "<string>",
          "target": {
            "targetId": "<string>",
            "targetNumber": 123,
            "targetType": "<string>"
          }
        }
      ],
      "isRecurring": true,
      "orderId": "<string>",
      "paymentServiceTransactionId": "<string>",
      "paymentType": "<string>",
      "paymentWorkflow": "<string>",
      "status": "<string>",
      "subPayments": [
        {
          "amountCollected": 123,
          "amountCredited": 123,
          "amountRefunded": 123,
          "amountRequested": 123,
          "status": "<string>",
          "target": {
            "targetId": "<string>",
            "targetNumber": 123,
            "targetType": "<string>"
          }
        }
      ]
    }
  ],
  "priceListCode": "<string>",
  "shippingSubTotal": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "shopperNotes": {
    "comments": "<string>",
    "deliveryInstructions": "<string>",
    "giftMessage": "<string>"
  },
  "siteId": 123,
  "sourceDevice": "<string>",
  "subTotal": 123,
  "submittedDate": "2023-11-07T05:31:56Z",
  "suggestedDiscounts": [
    {
      "autoAdd": true,
      "discountId": 123,
      "hasMultipleProducts": true,
      "hasOptions": true,
      "productCode": "<string>"
    }
  ],
  "taxData": {},
  "tenantId": 123,
  "total": 123,
  "type": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
checkoutId
string
required

ID of the checkout to add an item to.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

All properties of the new item. Required property: Product.ProductCode.

A single line item of an order.

​
adjustedLineItemSubtotal
number<double> | null

Order Level taxable sub total

​
auditInfo
object
​
autoAddDiscountId
integer<int32> | null

Track the discountId from which the item was auto added

​
childItemIds
string[] | null

List of Child Item Ids for this order item

​
data
object

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

Duty or Tariff 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

Handling Amount for this item

​
inventoryTags
object[] | null
​
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

​
product
object

The product as it appears on the order item.

​
productDiscount
object

Details of the discount applied to a product.

​
productDiscounts
object[] | null

A list of discounts applied to the product

​
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

​
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
​
subtotal
number<double> | null

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

​
taxData
object

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.

​
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 adjusment that applies to this item.

​
weightedOrderHandlingFee
number<double> | null

Order Level handling fee applied to this item

​
weightedOrderHandlingFeeDiscount
number<double> | null

Order Level handling fee discount applied to this item

​
weightedOrderHandlingFeeTax
number<double> | null

Order Level handling fee tax applied to this item

​
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

​
deliveryWindow
object
​
destinationId
string | null

The destination associated with this item when used with a multi-ship checkout.

​
expectedDeliveryDate
string<date-time> | null

Expected Delivery Date of shipment

​
fulfillmentLocationCode
string | null

Location code from which to obtain this item

​
fulfillmentMethod
string | null

Fulfillment method used to fulfill this item

​
giftInfo
object
​
id
string | null

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

​
isReservationEnabled
boolean

Flag to indicate reserve inventory in cart

​
originalCartItemId
string | null

Unique identifier of the cart item that is associated with this line item. (This is the original Cart Item ID expressed as a GUID.)

​
priceMode
string | null

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

​
returnRuleInfo
object
​
shippingMethodCode
string | null

Code that uniquely identifies the shipping method.

​
shippingMethodName
string | null

Readable name of the shipping method.

​
subscription
object
​
suggestions
object[] | null

Routing suggestions

Response

Success

​
acceptsMarketing
boolean | null

Does the customer accept marketing

​
alternateContact
object
​
amountRemainingForPayment
number<double>

A counter for how much of the total has not been claimed by payments. This is computed by Total - (sum of Payments where State is not Voided/Declined)

​
attributes
object[] | null
​
auditInfo
object
​
availableActions
string[] | null
​
channelCode
string | null

Unique identifier of the channel for this item.

​
couponCodes
string[] | null

Coupon codes associated with this order.

​
currencyCode
string | null

ISO Currency Code.

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
customerInteractionType
string | null

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

​
customerTaxId
string | null

The customers tax ID. If Customer Account ID exists in the system, will set this.

​
data
object

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

​
destinations
object[] | null
​
discountThresholdMessages
object[] | null

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

​
dutyTotal
number<double> | null

Total duty fees

​
email
string | null

Email address for checkout

​
feeTotal
number<double>

Total Fees

​
groupings
object[] | null

List of checkout grouping.

​
handlingSubTotal
number<double>

Pre-Discounted Handling Subtotal of the CommerceAggregate and its Items. Returns {null} if the calculated value is negative.

​
handlingTaxTotal
number<double>

Total tax on handling.

​
handlingTotal
number<double>

Overall handling total, accounting for line and order-level handling costs, any handling discounts, and handling tax.

​
id
string | null

Unique identifier.

​
invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the order.

​
ipAddress
string | null

IP address of the user placing the order. (User or customer?)

​
isTaxExempt
boolean | null

Unique identifier of the customer account.

​
itemLevelHandlingDiscountTotal
number<double>

The total value of item-level handling discounts.

​
itemLevelProductDiscountTotal
number<double>

The total value of item-level product discounts.

​
itemLevelShippingDiscountTotal
number<double>

The total value of item-level shipping discounts.

​
itemTaxTotal
number<double>

Total tax on products.

​
itemTotal
number<double>

The total product cost, accounting for discounts and tax.

​
items
object[] | null

List of items in the checkout.

​
locationCode
string | null

Identifies the location at which the order was placed if the order was placed externally.

​
number
integer<int32> | null

A checkout number that is only assigned after the checkout is placed.

​
orderDiscounts
object[] | null
​
orderLevelHandlingDiscountTotal
number<double>

The total value of order-level (group-level) handling discounts.

​
orderLevelProductDiscountTotal
number<double>

The total value of order-level (group-level) product discounts.

​
orderLevelShippingDiscountTotal
number<double>

The total value of order-level (group-level) shipping discounts.

​
originalCartId
string | null

Unique identifier for the cart that was converted to checkout.

​
payments
object[] | null

Payment transaction associated with this checkout. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal.

​
priceListCode
string | null

Pricelist code for the checkout

​
shippingSubTotal
number<double>

Shipping does not appear on cart.

​
shippingTaxTotal
number<double>

Total tax on shipping.

​
shippingTotal
number<double>

Overall shipping total, accounting for item and order-level shipping costs, any shipping discounts, and shipping tax.

​
shopperNotes
object

Notes that the shopper has added to this order, for example, a gift message or other comments.

​
siteId
integer<int32>

Unique identifier of the Site.

​
sourceDevice
string | null

Source device of the user placing the order. (User or customer?)

​
subTotal
number<double>

Subtotal before any coupon codes, taxes, fees, etc.

​
submittedDate
string<date-time> | null

When the customer placed (submitted) the order.

​
suggestedDiscounts
object[] | null
​
taxData
object

Storage for any additional/custom tax data.

​
tenantId
integer<int32>

Unique identifier of the Tenant.

​
total
number<double>

Final total

​
type
string | null

Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.

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