get

/orders/{order_id}/products/{id}

Gets a product line item associated with the order.

Authorization

apiKey - X-Auth-Token

Request Parameters

3 Path Parameters
2 Headers

Responses

3 Examples
Schema
object
id
integer

Numeric ID of this product within this order.

1 validation
order_id
integer

Numeric ID of the associated order.

1 validation
product_id
integer

Numeric ID of the product.

1 validation
order_address_id
integer

Numeric ID of the associated order address.

1 validation
name
string

The product name.

1 validation
sku
string

User-defined product code/stock keeping unit (SKU).

1 validation
type
string

Type of product

2 validations
base_price
string

The product’s base price. (Float, Float-As-String, Integer)

1 validation
price_ex_tax
string

The product’s price excluding tax. (Float, Float-As-String, Integer)

1 validation
price_inc_tax
string

The product’s price including tax. (Float, Float-As-String, Integer)

1 validation
price_tax
string

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)

1 validation
base_total
string

Total base price. (Float, Float-As-String, Integer)

1 validation
total_ex_tax
string

Total base price excluding tax. (Float, Float-As-String, Integer)

1 validation
total_inc_tax
string

Total base price including tax. (Float, Float-As-String, Integer)

1 validation
total_tax
string

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 calcuted as the following: (price_ex_tax - discount)*tax_rate=total_tax. (Float, Float-As-String, Integer)

1 validation
quantity
number

Quantity of the product ordered.

1 validation
base_cost_price
string

The product’s cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only

1 validation
cost_price_inc_tax
string

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. Read Only

1 validation
cost_price_ex_tax
string

The products 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. Read Only

1 validation
weight
number

Weight of the product. (Float, Float-As-String, Integer)

1 validation
cost_price_tax
string

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

1 validation
is_refunded
boolean

Whether the product has been refunded.

1 validation
refunded_amount
string

The amount refunded from this transaction. (Float, Float-As-String, Integer)

1 validation
return_id
number

Numeric ID for the refund.

1 validation
wrapping_name
string

Name of gift-wrapping option

1 validation
base_wrapping_cost
string

The value of the base wrapping cost. (Float, Float-As-String, Integer)

1 validation
wrapping_cost_ex_tax
string

The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)

1 validation
wrapping_cost_inc_tax
string

The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)

1 validation
wrapping_cost_tax
string

Tax applied to gift-wrapping option. (Float, Float-As-String, Integer)

1 validation
wrapping_message
string

Message to accompany gift-wrapping option.

quantity_shipped
number

Quantity of this item shipped.

1 validation
event_name
string

Name of promotional event/delivery date.

1 validation
event_date
string

Date of the promotional event/scheduled delivery.

1 validation
fixed_shipping_cost
string

Fixed shipping cost for this product. (Float, Float-As-String, Integer)

1 validation
ebay_item_id
string

Item ID for this product on eBay.

ebay_transaction_id
string

Transaction ID for this product on eBay.

option_set_id
integer

Numeric ID of the option set applied to the product.

1 validation
parent_order_product_id
integer

ID of a parent product.

is_bundled_product
boolean

Whether this product is bundled with other products.

1 validation
bin_picking_number
string

Bin picking number for the physical product.

applied_discounts
array[object]

Array of objects containing discounts applied to the product.

product_options
array[object]

Array of product option objects.

external_id
integer

ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order.This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field ‘external_id’ cannot be written to. Please remove it from your request before trying again. It can not be overwritten once set.

upc
string

Universal Product Code. Can be written to for custom products and catalog products.

1 validation
variant_id
integer

Products variant_id. PUT or POST. This field is not available for custom products.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
order_id
id
$$.env
1 variable not set
store_hash
X-Auth-Token