List Order Products
Authentication
Path parameters
Headers
Query parameters
Response
Numeric ID of the associated order address. Value is 0 for items that are not fulfilled by a pickup method.
Alias for name_customer - The product name that is shown to customer in storefront.
User-defined product code/stock keeping unit (SKU).
The product’s base price. (Float, Float-As-String, Integer)
The product’s price excluding tax. The value can’t be negative. (Float, Float-As-String, Integer)
The product’s price including tax. The value can’t be negative. (Float, Float-As-String, Integer)
Amount of tax applied to a single product.
Price tax is calculated as:
price_tax = price_inc_tax - price_ex_tax
(Float, Float-As-String, Integer)
Total base price. (Float, Float-As-String, Integer)
Note: The base_total is affected by the tax options set up in the control panel and is altered on tax-free orders. See more details on how base_total is affected by visiting the Responsive Tax Display Settings overview. If the base_total is \$0, it’s due to the store’s tax settings. To learn more about tax settings in the control panel, check out this Tax Settings support article.
Total base price excluding tax. The value can’t be negative. (Float, Float-As-String, Integer)
Total base price including tax. The value can’t be negative. (Float, Float-As-String, Integer)
Total tax applied to products. For example, if quantity if 2, base price is 5 and tax rate is 10%. price_tax will be $.50 and total_tax will be $1.00.
If there is a manual discount applied total_tax is calculated as the following:
(price_ex_tax - discount)*tax_rate=total_tax.
(Float, Float-As-String, Integer)
The product’s cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer)
The product’s cost price including tax. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. The value can’t be negative.
The product cost price excluding tax. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. The value can’t be negative.
Weight of the product. The value can’t be negative. (Float, Float-As-String, Integer)
Tax applied to the product’s cost price. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only
Name of gift-wrapping option.
The value of the base wrapping cost. The value can’t be negative. (Float, Float-As-String, Integer)
The value of the wrapping cost, excluding tax. The value can’t be negative. (Float, Float-As-String, Integer)
The value of the wrapping cost, including tax. The value can’t be negative. (Float, Float-As-String, Integer)
Tax applied to gift-wrapping option. (Float, Float-As-String, Integer)
Message to accompany gift-wrapping option.
Name of promotional event/delivery date.
Date of the promotional event/scheduled delivery.
Fixed shipping cost for this product. (Float, Float-As-String, Integer)
(Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order.
The productʼs brand.
Available for only Catalog V2 stores.
Products variant_id. PUT or POST. This field is not available for custom products.
Represent the correct total amount of the line item after deducting all the discounts and including the tax. This number can be used for accounting purpose.
This makes it easier to have the “shopper paid” value for a line item and api user doesn’t have to do any calculation to deduct discount on the client side.
This field includes all types of discounts (automatic, coupon, manual) and therefore if you use this value, you don’t need to deduct any more discounts at line item level or order level.
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)