Add Item To Quote

POST

commerce

quotes

{quoteId}

items

Error

A valid request URL is required to generate request examples

{
  "adjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "auditHistory": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "changes": [
        {
          "fields": [
            {
              "name": "<string>",
              "newValue": "<string>",
              "oldValue": "<string>"
            }
          ],
          "path": "<string>",
          "type": "<string>"
        }
      ],
      "id": "<string>"
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "channelCode": "<string>",
  "comments": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "text": "<string>"
    }
  ],
  "couponCodes": [
    "<string>"
  ],
  "currencyCode": "<string>",
  "customerAccountId": 123,
  "customerInteractionType": "<string>",
  "customerTaxId": "<string>",
  "data": {},
  "dutyAmount": 123,
  "dutyTotal": 123,
  "email": "<string>",
  "expirationDate": "2023-11-07T05:31:56Z",
  "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>"
  },
  "handlingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<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,
  "hasDraft": true,
  "id": "<string>",
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123,
      "reason": "<string>",
      "reasonCode": 123
    }
  ],
  "ipAddress": "<string>",
  "isDraft": true,
  "isTaxExempt": true,
  "itemLevelHandlingDiscountTotal": 123,
  "itemLevelProductDiscountTotal": 123,
  "itemLevelShippingDiscountTotal": 123,
  "itemTaxTotal": 123,
  "itemTotal": 123,
  "items": [
    {
      "adjustedLineItemSubtotal": 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"
      },
      "autoAddDiscountId": 123,
      "callOffOrderItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "data": {},
      "deliveryWindow": {
        "endTime": "2023-11-07T05:31:56Z",
        "startTime": "2023-11-07T05:31:56Z"
      },
      "destinationId": "<string>",
      "discountTotal": 123,
      "discountedTotal": 123,
      "dutyAmount": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "extendedTotal": 123,
      "feeTotal": 123,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "giftInfo": {
        "giftMessage": "<string>",
        "isGiftItem": true
      },
      "handlingAmount": 123,
      "id": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isRecurring": true,
      "isReservationEnabled": true,
      "isTaxable": true,
      "itemTaxTotal": 123,
      "lineId": 123,
      "lineItemAdjustment": 123,
      "localeCode": "<string>",
      "originalCartItemId": "<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,
      "requestedShipDate": "2023-11-07T05:31:56Z",
      "returnRuleInfo": {
        "isReturnable": true,
        "maxDays": 123,
        "maxQty": 123,
        "ruleCode": "<string>"
      },
      "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>"
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<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,
      "suggestions": [
        {
          "futureDate": "2023-11-07T05:31:56Z",
          "locationCode": "<string>",
          "productCode": "<string>",
          "quantity": 123,
          "suggestionType": "<string>",
          "transferToLocationCode": "<string>"
        }
      ],
      "taxData": {},
      "taxableTotal": 123,
      "timeFenceDays": 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
    }
  ],
  "locationCode": "<string>",
  "name": "<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,
  "priceListCode": "<string>",
  "shippingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "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>"
    }
  ],
  "shippingSubTotal": 123,
  "shippingTax": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "siteId": 123,
  "sourceDevice": "<string>",
  "status": "<string>",
  "subTotal": 123,
  "submittedDate": "2023-11-07T05:31:56Z",
  "taxData": {},
  "tenantId": 123,
  "total": 123,
  "userId": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

quoteId

string

required

Query Parameters

updateMode

string

responseFields

string

limits which fields are returned in the response body

Body

application/json

A single line item of an order.

adjustedLineItemSubtotal

number<double> | null

Order Level taxable sub total

attributes

object[] | null

Extensible attributes for this order line.

Show child attributes

auditInfo

object

Show child attributes

autoAddDiscountId

integer<int32> | null

Track the discoutid from which the item was auto added

callOffOrderItemId

string | null

Identifier of the originating Call-Off Order line item, if this item was released from a Call-Off Order line. Null for standard order items.

childItemIds

string[] | null

List of Child Item Ids for this order item

data

object | null

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

deliveryWindow

object

Show child attributes

destinationId

string | null

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

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

expectedDeliveryDate

string<date-time> | null

Expected Delivery Date of shipment

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.

fulfillmentLocationCode

string | null

Location code from which to obtain this item

fulfillmentMethod

string | null

Fulfillment method used to fulfill this item

giftInfo

object

Show child attributes

handlingAmount

number<double> | null

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

string | null

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

inventoryTags

object[] | null

Show child attributes

isAssemblyRequired

boolean

Assembly Required for this order item

isRecurring

boolean | null

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

isReservationEnabled

boolean

Flag to indicate reserve inventory in cart

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.

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

parentItemId

string | null

Indicates Parent Item Id for this order item

priceMode

string | null

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

product

object

The product as it appears on the order item.

Show child attributes

productDiscount

object

Show child attributes

productDiscounts

object[] | null

A list of discounts applied to the product

Show child attributes

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.

requestedShipDate

string<date-time> | null

Requested ship date carried from the Call-Off Order line (spec COM-10941 follow-up).

returnRuleInfo

object

Show child attributes

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping amount before Discounts and adjustments

shippingDiscounts

object[] | null

A discount applied to the shipping

Show child attributes

shippingMethodCode

string | null

Code that uniquely identifies the shipping method.

shippingMethodName

string | null

Readable name of the shipping method.

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.

subscription

object

Show child attributes

substituteInfo

object

Show child attributes

subtotal

number<double> | null

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

suggestions

object[] | null

Routing suggestions

Show child attributes

taxData

object | null

Storage for any additional/custom tax data.

taxableTotal

number<double> | null

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

timeFenceDays

integer<int32> | null

Time-fence tolerance (days) carried from the Call-Off Order line's bound ReservationRule.

total

number<double> | null

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

totalWithWeightedShippingAndHandling

number<double> | null

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

totalWithoutWeightedShippingAndHandling

number<double> | null

Taxable Subtotal including Weighted Order amounts

unitPrice

object

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

Show child attributes

weightedOrderAdjustment

number<double> | null

Order Level Manual Adjustment applied to this Item

weightedOrderDiscount

number<double> | null

Order Level Discount applied to this Item

weightedOrderDuty

number<double> | null

Order Level Duty applied to this Item

weightedOrderHandlingAdjustment

number<double> | null

Order-level handling manual adjustment allocated to this item.

weightedOrderHandlingFee

number<double> | null

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

weightedOrderHandlingFeeDiscount

number<double> | null

Order-level handling fee discount allocated to this item.

weightedOrderHandlingFeeTax

number<double> | null

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

weightedOrderShipping

number<double> | null

Order Level Shipping applied to this Item

weightedOrderShippingDiscount

number<double> | null

Order Level Shipping discount applied to this Item

weightedOrderShippingManualAdjustment

number<double> | null

Order Level Shipping Manual Adjustment applied to this Item

weightedOrderShippingTax

number<double> | null

Order Level Shipping Tax applied to this Item

weightedOrderTax

number<double> | null

Order Level tax applied to this Item

Response

adjustment

object

Show child attributes

auditHistory

object[] | null

User modified Audit History

Show child attributes

auditInfo

object

Show child attributes

channelCode

string | null

Unique identifier of the channel for this item.

comments

object[] | null

Comments on a quote

Show child attributes

couponCodes

string[] | null

Coupon codes associated with this Quote.

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

read-only

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

data

object | null

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

dutyAmount

number<double> | null

dutyTotal

number<double>

string | null

Email address for checkout

expirationDate

string<date-time> | null

When the quote will no longer be active. That is, the quote is considered abandoned. Date in UTC Date/Time.

feeTotal

number<double>

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

handlingAdjustment

object

Show child attributes

handlingAmount

number<double> | null

handlingDiscounts

object[] | null

Show child attributes

handlingSubTotal

number<double>

handlingTax

number<double> | null

handlingTaxTotal

number<double>

handlingTotal

number<double>

hasDraft

boolean

Does this quote have a draft

string | null

Unique identifier.

invalidCoupons

object[] | null

A list of invalid coupons that were attempted on the quote

Show child attributes

ipAddress

string | null

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

isDraft

boolean

Is this quote a draft

isTaxExempt

boolean | null

read-only

Unique identifier of the customer account.

itemLevelHandlingDiscountTotal

number<double>

itemLevelProductDiscountTotal

number<double>

The total value of item-level product discounts.

itemLevelShippingDiscountTotal

number<double>

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

Show child attributes

locationCode

string | null

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

name

string | null

Name of the quote

number

integer<int32> | null

Auto generated number that is assigned to the quote when creation.

orderDiscounts

object[] | null

Show child attributes

orderLevelHandlingDiscountTotal

number<double>

orderLevelProductDiscountTotal

number<double>

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

orderLevelShippingDiscountTotal

number<double>

priceListCode

string | null

Pricelist code for the checkout

shippingAdjustment

object

Show child attributes

shippingAmount

number<double>

shippingDiscounts

object[] | null

Show child attributes

shippingSubTotal

number<double>

shippingTax

number<double> | null

shippingTaxTotal

number<double>

shippingTotal

number<double>

siteId

integer<int32>

Unique identifier of the Site.

sourceDevice

string | null

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

status

string | null

subTotal

number<double>

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

submittedDate

string<date-time> | null

When the customer placed (submitted) the Quote.

taxData

object | null

Storage for any additional/custom tax data.

tenantId

integer<int32>

Unique identifier of the Tenant.

total

number<double>

Final total

userId

string | null

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.

Error

A valid request URL is required to generate request examples

{
  "adjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "auditHistory": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "changes": [
        {
          "fields": [
            {
              "name": "<string>",
              "newValue": "<string>",
              "oldValue": "<string>"
            }
          ],
          "path": "<string>",
          "type": "<string>"
        }
      ],
      "id": "<string>"
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "channelCode": "<string>",
  "comments": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "text": "<string>"
    }
  ],
  "couponCodes": [
    "<string>"
  ],
  "currencyCode": "<string>",
  "customerAccountId": 123,
  "customerInteractionType": "<string>",
  "customerTaxId": "<string>",
  "data": {},
  "dutyAmount": 123,
  "dutyTotal": 123,
  "email": "<string>",
  "expirationDate": "2023-11-07T05:31:56Z",
  "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>"
  },
  "handlingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<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,
  "hasDraft": true,
  "id": "<string>",
  "invalidCoupons": [
    {
      "couponCode": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "discountId": 123,
      "reason": "<string>",
      "reasonCode": 123
    }
  ],
  "ipAddress": "<string>",
  "isDraft": true,
  "isTaxExempt": true,
  "itemLevelHandlingDiscountTotal": 123,
  "itemLevelProductDiscountTotal": 123,
  "itemLevelShippingDiscountTotal": 123,
  "itemTaxTotal": 123,
  "itemTotal": 123,
  "items": [
    {
      "adjustedLineItemSubtotal": 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"
      },
      "autoAddDiscountId": 123,
      "callOffOrderItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "data": {},
      "deliveryWindow": {
        "endTime": "2023-11-07T05:31:56Z",
        "startTime": "2023-11-07T05:31:56Z"
      },
      "destinationId": "<string>",
      "discountTotal": 123,
      "discountedTotal": 123,
      "dutyAmount": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "extendedTotal": 123,
      "feeTotal": 123,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "giftInfo": {
        "giftMessage": "<string>",
        "isGiftItem": true
      },
      "handlingAmount": 123,
      "id": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isRecurring": true,
      "isReservationEnabled": true,
      "isTaxable": true,
      "itemTaxTotal": 123,
      "lineId": 123,
      "lineItemAdjustment": 123,
      "localeCode": "<string>",
      "originalCartItemId": "<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,
      "requestedShipDate": "2023-11-07T05:31:56Z",
      "returnRuleInfo": {
        "isReturnable": true,
        "maxDays": 123,
        "maxQty": 123,
        "ruleCode": "<string>"
      },
      "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>"
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<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,
      "suggestions": [
        {
          "futureDate": "2023-11-07T05:31:56Z",
          "locationCode": "<string>",
          "productCode": "<string>",
          "quantity": 123,
          "suggestionType": "<string>",
          "transferToLocationCode": "<string>"
        }
      ],
      "taxData": {},
      "taxableTotal": 123,
      "timeFenceDays": 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
    }
  ],
  "locationCode": "<string>",
  "name": "<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,
  "priceListCode": "<string>",
  "shippingAdjustment": {
    "amount": 123,
    "description": "<string>",
    "internalComment": "<string>"
  },
  "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>"
    }
  ],
  "shippingSubTotal": 123,
  "shippingTax": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "siteId": 123,
  "sourceDevice": "<string>",
  "status": "<string>",
  "subTotal": 123,
  "submittedDate": "2023-11-07T05:31:56Z",
  "taxData": {},
  "tenantId": 123,
  "total": 123,
  "userId": "<string>",
  "visitId": "<string>",
  "webSessionId": "<string>"
}

Developers

API reference

AI Tools

Authorizations

Path Parameters

Query Parameters

Body

Response