Skip to main content
POST
/
commerce
/
quotes
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,
      "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>",
  "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.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json
​
adjustment
object
​
auditHistory
object[] | null

User modified Audit History

​
auditInfo
object
​
channelCode
string | null

Unique identifier of the channel for this item.

​
comments
object[] | null

Comments on a quote

​
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

​
data
object

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

​
dutyAmount
number<double> | null
​
dutyTotal
number<double>
​
email
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).

​
handlingAdjustment
object
​
handlingAmount
number<double> | null
​
handlingDiscounts
object[] | null
​
handlingSubTotal
number<double>
​
handlingTax
number<double> | null
​
handlingTaxTotal
number<double>
​
handlingTotal
number<double>
​
hasDraft
boolean

Does this quote have a draft

​
id
string | null

Unique identifier.

​
invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the quote

​
ipAddress
string | null

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

​
isDraft
boolean

Is this quote a draft

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

​
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
​
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
​
shippingAmount
number<double>
​
shippingDiscounts
object[] | null
​
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

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.

Response

Success

​
adjustment
object
​
auditHistory
object[] | null

User modified Audit History

​
auditInfo
object
​
channelCode
string | null

Unique identifier of the channel for this item.

​
comments
object[] | null

Comments on a quote

​
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

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.

​
dutyAmount
number<double> | null
​
dutyTotal
number<double>
​
email
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).

​
handlingAdjustment
object
​
handlingAmount
number<double> | null
​
handlingDiscounts
object[] | null
​
handlingSubTotal
number<double>
​
handlingTax
number<double> | null
​
handlingTaxTotal
number<double>
​
handlingTotal
number<double>
​
hasDraft
boolean

Does this quote have a draft

​
id
string | null

Unique identifier.

​
invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the quote

​
ipAddress
string | null

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

​
isDraft
boolean

Is this quote a draft

​
isTaxExempt
boolean | null

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.

​
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
​
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
​
shippingAmount
number<double>
​
shippingDiscounts
object[] | null
​
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

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.