Skip to main content
GET
/
commerce
/
orders
/
{orderId}
/
items
/
{orderItemId}
Error
A valid request URL is required to generate request examples
{
  "localeCode": "<string>",
  "purchaseLocation": "<string>",
  "lineId": 123,
  "product": {
    "productCode": "<string>",
    "name": "<string>",
    "description": "<string>",
    "goodsType": "<string>",
    "isPackagedStandAlone": true,
    "stock": {
      "manageStock": true,
      "isOnBackOrder": true,
      "availableDate": "2023-11-07T05:31:56Z",
      "stockAvailable": 123,
      "aggregateInventory": 123,
      "futureInventories": [
        {
          "futureInventoryID": 123,
          "onhand": 123,
          "available": 123,
          "allocated": 123,
          "pending": 123,
          "deliveryDate": "2023-11-07T05:31:56Z",
          "createDate": "2023-11-07T05:31:56Z"
        }
      ],
      "availableFutureInventories": 123,
      "totalAvailableStock": 123,
      "isSubstitutable": true
    },
    "productReservationId": 123,
    "allocationId": 123,
    "allocationExpiration": "2023-11-07T05:31:56Z",
    "measurements": {
      "height": {
        "unit": "<string>",
        "value": 123
      },
      "width": {
        "unit": "<string>",
        "value": 123
      },
      "length": {
        "unit": "<string>",
        "value": 123
      },
      "weight": {
        "unit": "<string>",
        "value": 123
      }
    },
    "fulfillmentStatus": "<string>",
    "mfgPartNumber": "<string>",
    "upc": "<string>",
    "sku": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "imageAlternateText": "<string>",
    "imageUrl": "<string>",
    "variationProductCode": "<string>",
    "options": [
      {
        "name": "<string>",
        "value": "<unknown>",
        "shopperEnteredValue": "<unknown>",
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "stringValue": "<string>"
      }
    ],
    "properties": [
      {
        "attributeFQN": "<string>",
        "name": "<string>",
        "dataType": "<string>",
        "isMultiValue": true,
        "values": [
          {
            "stringValue": "<string>",
            "value": "<unknown>"
          }
        ]
      }
    ],
    "categories": [
      {
        "id": 123,
        "parent": {}
      }
    ],
    "price": {
      "price": 123,
      "salePrice": 123,
      "tenantOverridePrice": 123,
      "msrp": 123,
      "creditValue": 123,
      "priceListCode": "<string>",
      "priceListEntryMode": "<string>",
      "isOverRidePriceSalePrice": true
    },
    "discountsRestricted": true,
    "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
    "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
    "isRecurring": true,
    "isTaxable": true,
    "productType": "<string>",
    "productUsage": "<string>",
    "serialNumber": "<string>",
    "condition": "<string>",
    "bundledProducts": [
      {
        "productCode": "<string>",
        "name": "<string>",
        "description": "<string>",
        "goodsType": "<string>",
        "isPackagedStandAlone": true,
        "stock": {
          "manageStock": true,
          "isOnBackOrder": true,
          "availableDate": "2023-11-07T05:31:56Z",
          "stockAvailable": 123,
          "aggregateInventory": 123,
          "futureInventories": [
            {
              "futureInventoryID": 123,
              "onhand": 123,
              "available": 123,
              "allocated": 123,
              "pending": 123,
              "deliveryDate": "2023-11-07T05:31:56Z",
              "createDate": "2023-11-07T05:31:56Z"
            }
          ],
          "availableFutureInventories": 123,
          "totalAvailableStock": 123,
          "isSubstitutable": true
        },
        "productReservationId": 123,
        "allocationId": 123,
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          }
        },
        "fulfillmentStatus": "<string>",
        "quantity": 123,
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "creditValue": 123,
        "deltaPrice": 123,
        "imageUrl": "<string>"
      }
    ],
    "fulfillmentFields": [
      {
        "name": "<string>",
        "userEnteredValue": "<unknown>",
        "required": true
      }
    ]
  },
  "quantity": 123,
  "isRecurring": true,
  "isTaxable": true,
  "subtotal": 123,
  "extendedTotal": 123,
  "taxableTotal": 123,
  "discountTotal": 123,
  "discountedTotal": 123,
  "itemTaxTotal": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "handlingAmount": 123,
  "feeTotal": 123,
  "total": 123,
  "unitPrice": {
    "extendedAmount": 123,
    "listAmount": 123,
    "saleAmount": 123,
    "overrideAmount": 123
  },
  "productDiscount": {
    "groupId": "<string>",
    "impact": 123,
    "discount": {
      "id": 123,
      "name": "<string>",
      "itemIds": [
        "<string>"
      ],
      "expirationDate": "2023-11-07T05:31:56Z",
      "hasMultipleTargetProducts": true
    },
    "couponCode": "<string>",
    "excluded": true,
    "data": {},
    "productQuantity": 123,
    "impactPerUnit": 123,
    "appliesToSalePrice": true,
    "discountQuantity": 123
  },
  "productDiscounts": [
    {
      "groupId": "<string>",
      "impact": 123,
      "discount": {
        "id": 123,
        "name": "<string>",
        "itemIds": [
          "<string>"
        ],
        "expirationDate": "2023-11-07T05:31:56Z",
        "hasMultipleTargetProducts": true
      },
      "couponCode": "<string>",
      "excluded": true,
      "data": {},
      "productQuantity": 123,
      "impactPerUnit": 123,
      "appliesToSalePrice": true,
      "discountQuantity": 123
    }
  ],
  "shippingDiscounts": [
    {
      "methodCode": "<string>",
      "discount": {
        "groupId": "<string>",
        "impact": 123,
        "discount": {
          "id": 123,
          "name": "<string>",
          "itemIds": [
            "<string>"
          ],
          "expirationDate": "2023-11-07T05:31:56Z",
          "hasMultipleTargetProducts": true
        },
        "couponCode": "<string>",
        "excluded": true,
        "data": {}
      },
      "discountQuantity": 123,
      "impactPerUnit": 123
    }
  ],
  "data": {},
  "taxData": {},
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "shippingAmountBeforeDiscountsAndAdjustments": 123,
  "weightedOrderAdjustment": 123,
  "weightedOrderDiscount": 123,
  "adjustedLineItemSubtotal": 123,
  "totalWithoutWeightedShippingAndHandling": 123,
  "weightedOrderTax": 123,
  "weightedOrderShipping": 123,
  "weightedOrderShippingDiscount": 123,
  "weightedOrderShippingManualAdjustment": 123,
  "weightedOrderShippingTax": 123,
  "weightedOrderHandlingFee": 123,
  "weightedOrderHandlingFeeTax": 123,
  "weightedOrderHandlingFeeDiscount": 123,
  "weightedOrderDuty": 123,
  "totalWithWeightedShippingAndHandling": 123,
  "weightedOrderHandlingAdjustment": 123,
  "autoAddDiscountId": 123,
  "isAssemblyRequired": true,
  "childItemIds": [
    "<string>"
  ],
  "parentItemId": "<string>",
  "inventoryTags": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "lineItemAdjustment": 123,
  "dutyAmount": 123,
  "substituteInfo": {
    "optIn": "<string>",
    "substituteProductCode": "<string>",
    "substituteVariantCode": "<string>"
  },
  "id": "<string>",
  "destinationId": "<string>",
  "originalCartItemId": "<string>",
  "fulfillmentLocationCode": "<string>",
  "fulfillmentMethod": "<string>",
  "expectedDeliveryDate": "2023-11-07T05:31:56Z",
  "subscription": {
    "required": true,
    "frequency": {
      "unit": "<string>",
      "value": 123
    },
    "trial": {
      "enabled": true,
      "duration": 123,
      "substituteProductCode": "<string>",
      "substituteProductQuantity": 123,
      "substituteVariationProductCode": "<string>",
      "substituteProductOptions": [
        {
          "name": "<string>",
          "value": "<unknown>",
          "shopperEnteredValue": "<unknown>",
          "attributeFQN": "<string>",
          "dataType": "<string>",
          "stringValue": "<string>"
        }
      ]
    }
  },
  "isReservationEnabled": true,
  "giftInfo": {
    "isGiftItem": true,
    "giftMessage": "<string>"
  },
  "priceMode": "<string>",
  "returnRuleInfo": {
    "isReturnable": true,
    "maxQty": 123,
    "maxDays": 123,
    "ruleCode": "<string>"
  },
  "shippingMethodCode": "<string>",
  "shippingMethodName": "<string>",
  "deliveryWindow": {
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z"
  },
  "suggestions": [
    {
      "locationCode": "<string>",
      "suggestionType": "<string>",
      "quantity": 123,
      "productCode": "<string>",
      "futureDate": "2023-11-07T05:31:56Z",
      "transferToLocationCode": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
orderId
string
required

Unique identifier of the order whose item you want to get.

​
orderItemId
string
required

Unique identifier of the order item whose details you want to get.

Query Parameters

​
draft
boolean

Gets a draft copy of the order if one is available

​
responseFields
string

limits which fields are returned in the response body

Response

Success

A single line item of an order.

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

​
purchaseLocation
string | null

The location where the product is being purchased.. default is null. Products can have different prices by purchaseLocation via custom priceListResolution...

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

​
product
object

The product as it appears on the order item.

​
quantity
integer<int32>

Number of products ordered.

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

​
subtotal
number<double> | null

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

​
extendedTotal
number<double> | null

Line item extended total (quantity multiplied by unit extended price) before discounts.

​
taxableTotal
number<double> | null

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

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

​
itemTaxTotal
number<double> | null

Total price of taxes that apply to products in this item.

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

​
handlingAmount
number<double> | null

Handling Amount for this item

​
feeTotal
number<double> | null

Not implemented. Total cost of fees that apply to this item.

​
total
number<double> | null

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

​
unitPrice
object

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

​
productDiscount
object

Details of the discount applied to a product.

​
productDiscounts
object[] | null

A list of discounts applied to the product

​
shippingDiscounts
object[] | null

A discount applied to the shipping

​
data
object

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

​
taxData
object

Storage for any additional/custom tax data.

​
auditInfo
object
​
shippingAmountBeforeDiscountsAndAdjustments
number<double> | null

Shipping amount before Discounts and adjustments

​
weightedOrderAdjustment
number<double> | null

Order Level Manual Adjustment applied to this Item

​
weightedOrderDiscount
number<double> | null

Order Level Discount applied to this Item

​
adjustedLineItemSubtotal
number<double> | null

Order Level taxable sub total

​
totalWithoutWeightedShippingAndHandling
number<double> | null

Taxable Subtotal including Weighted Order amounts

​
weightedOrderTax
number<double> | null

Order Level 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

​
weightedOrderHandlingFee
number<double> | null

Order Level handling fee applied to this item

​
weightedOrderHandlingFeeTax
number<double> | null

Order Level handling fee tax applied to this item

​
weightedOrderHandlingFeeDiscount
number<double> | null

Order Level handling fee discount applied to this item

​
weightedOrderDuty
number<double> | null

Order Level Duty applied to this Item

​
totalWithWeightedShippingAndHandling
number<double> | null

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

​
weightedOrderHandlingAdjustment
number<double> | null

Order level handling adjusment that applies to this item.

​
autoAddDiscountId
integer<int32> | null

Track the discountId from which the item was auto added

​
isAssemblyRequired
boolean

Assembly Required for this order item

​
childItemIds
string[] | null

List of Child Item Ids for this order item

​
parentItemId
string | null

Indicates Parent Item Id for this order item

​
inventoryTags
object[] | null
​
lineItemAdjustment
number<double> | null
​
dutyAmount
number<double> | null

Duty or Tariff for this item

​
substituteInfo
object
​
id
string | null

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

​
destinationId
string | null

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

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

​
fulfillmentLocationCode
string | null

Location code from which to obtain this item

​
fulfillmentMethod
string | null

Fulfillment method used to fulfill this item

​
expectedDeliveryDate
string<date-time> | null

Expected Delivery Date of shipment

​
subscription
object
​
isReservationEnabled
boolean

Flag to indicate reserve inventory in cart

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

​
deliveryWindow
object
​
suggestions
object[] | null

Routing suggestions