Docs
Management API
Orders
Order Products

Order Products

List Order Products

GET /orders/{order_id}/products

Request

Lists 50 order products on an order using order_id. By default, items are sorted from lowest to highest according to a newly created ID, separate from the order_id and the product_id.

Note: The response id is required when you create order shipments.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • order_id in path - integer
    required
    ID of the order.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • page in query with default of 1 - number
    The page to return in the response.
  • limit in query with default of 50 - number
    Number of results to return.

example

Response

Body

array | application/json

  • id    integer

    Numeric ID of this product within this order.
    Example: 25

  • order_id    integer

    Numeric ID of the associated order.
    Example: 120

  • product_id    integer

    Numeric ID of the product.
    Example: 20

  • order_pickup_method_id    integer

    ID of the pickup fulfillment method for this item. Default value is 0 when the item is not fulfilled by pickup method.

  • order_address_id    integer

    Numeric ID of the associated order address. Value is 0 for items that are not fulfilled by a pickup method.
    Example: 20

  • name    string

    Alias for name_customer - The product name that is shown to customer in storefront.
    >= 1 characters
    Example: Fog Linen Chambray Towel - Beige Stripe

  • sku    string

    User-defined product code/stock keeping unit (SKU).
    Example: S-GREE

  • type    string

    Type of product.

    Allowed: physical | digital | giftcertificate

    Example: physical

  • base_price    string

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

  • price_ex_tax    string

    The product’s price excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

  • price_inc_tax    string

    The product’s price including tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

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

    Example: 0.0000

  • base_total    string

    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.

    Example: 54.0000

  • total_ex_tax    string

    Total base price excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

  • total_inc_tax    string

    Total base price including tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

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

    Example: 0.5200

  • quantity    integer

    Quantity of the product ordered.
    Example: 1

  • base_cost_price    string

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

  • 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. The value can't be negative.

    Example: 50.0000

  • cost_price_ex_tax    string

    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.

    Example: 50.0000

  • weight

    Weight of the product. The value can't be negative. (Float, Float-As-String, Integer)
    One of:
    Type: number
    Example: 1

  • width    string

    Product width. The value can't be negative.
    Example: 1.0000

  • height    string

    Product height. The value can't be negative.
    Example: 1.0000

  • depth    string

    Product depth. The value can't be negative.
    Example: 1.0000

  • 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

    Example: 54.0000

  • is_refunded    boolean

    Whether the product has been refunded.

  • quantity_refunded    number

    The total quantity of product refunded from this transaction.

  • refund_amount    string
    deprecated

    The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
    Example: 0.0000

  • return_id    number

    Numeric ID for the refund.

  • wrapping_id    integer

    ID of the gift wrapping option.

  • wrapping_name    string or null

    Name of gift-wrapping option.

  • base_wrapping_cost

    The value of the base wrapping cost. The value can't be negative. (Float, Float-As-String, Integer)
    One of:
    Type: string
    Example: 0.0000

  • wrapping_cost_ex_tax    string

    The value of the wrapping cost, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 0.0000

  • wrapping_cost_inc_tax    string

    The value of the wrapping cost, including tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 0.0000

  • wrapping_cost_tax    string

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

  • wrapping_message    string

    Message to accompany gift-wrapping option.

  • quantity_shipped    number

    Quantity of this item shipped.

  • event_name    string or null

    Name of promotional event/delivery date.

  • event_date    string or null

    Date of the promotional event/scheduled delivery.

  • fixed_shipping_cost    string

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

  • 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 or null

    Numeric ID of the option set applied to the product.
    Example: 5

  • parent_order_product_id    integer or null

    ID of a parent product.

  • is_bundled_product    boolean

    Whether this product is bundled with other products.

  • bin_picking_number    string

    Bin picking number for the physical product.

  • external_id    string or null
    read-only

    (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order.

  • brand    string

    The productʼs brand.

  • applied_discounts    array[object]

    Array of objects containing discounts applied to the product.

  • product_options    array[object]

    Array of product option objects.

  • configurable_fields    array[object]

    Available for only Catalog V2 stores.

  • upc    string

    Universal Product Code. Can be written to for custom products and catalog products.
    <= 255 characters

  • variant_id    integer

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

  • name_customer    string

    The product name that is shown to customer in storefront.
    Example: Fog Linen Chambray Towel - Beige Stripe

  • name_merchant    string

    The product name that is shown to merchant in Control Panel.
    Example: Towel Type 1

  • gift_certificate_id    integer or null

    ID of the associated gift certificate.
    Example: 52

  • discounted_total_inc_tax    string

    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.

    Example: 0.0000

response

Get an Order Product

GET /orders/{order_id}/products/{product_id}

Request

Gets a product line item associated with the order.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • order_id in path - integer
    required
    ID of the order.
  • product_id in path - integer
    required
    ID of the product.

example

Response

Body

object | application/json

  • id    integer

    Numeric ID of this product within this order.
    Example: 25

  • order_id    integer

    Numeric ID of the associated order.
    Example: 120

  • product_id    integer

    Numeric ID of the product.
    Example: 20

  • order_pickup_method_id    integer

    ID of the pickup fulfillment method for this item. Default value is 0 when the item is not fulfilled by pickup method.

  • order_address_id    integer

    Numeric ID of the associated order address. Value is 0 for items that are not fulfilled by a pickup method.
    Example: 20

  • name    string

    Alias for name_customer - The product name that is shown to customer in storefront.
    >= 1 characters
    Example: Fog Linen Chambray Towel - Beige Stripe

  • sku    string

    User-defined product code/stock keeping unit (SKU).
    Example: S-GREE

  • type    string

    Type of product.

    Allowed: physical | digital | giftcertificate

    Example: physical

  • base_price    string

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

  • price_ex_tax    string

    The product’s price excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

  • price_inc_tax    string

    The product’s price including tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

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

    Example: 0.0000

  • base_total    string

    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.

    Example: 54.0000

  • total_ex_tax    string

    Total base price excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

  • total_inc_tax    string

    Total base price including tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 54.0000

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

    Example: 0.5200

  • quantity    integer

    Quantity of the product ordered.
    Example: 1

  • base_cost_price    string

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

  • 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. The value can't be negative.

    Example: 50.0000

  • cost_price_ex_tax    string

    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.

    Example: 50.0000

  • weight

    Weight of the product. The value can't be negative. (Float, Float-As-String, Integer)
    One of:
    Type: number
    Example: 1

  • width    string

    Product width. The value can't be negative.
    Example: 1.0000

  • height    string

    Product height. The value can't be negative.
    Example: 1.0000

  • depth    string

    Product depth. The value can't be negative.
    Example: 1.0000

  • 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

    Example: 54.0000

  • is_refunded    boolean

    Whether the product has been refunded.

  • quantity_refunded    number

    The total quantity of product refunded from this transaction.

  • refund_amount    string
    deprecated

    The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
    Example: 0.0000

  • return_id    number

    Numeric ID for the refund.

  • wrapping_id    integer

    ID of the gift wrapping option.

  • wrapping_name    string or null

    Name of gift-wrapping option.

  • base_wrapping_cost

    The value of the base wrapping cost. The value can't be negative. (Float, Float-As-String, Integer)
    One of:
    Type: string
    Example: 0.0000

  • wrapping_cost_ex_tax    string

    The value of the wrapping cost, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 0.0000

  • wrapping_cost_inc_tax    string

    The value of the wrapping cost, including tax. The value can't be negative. (Float, Float-As-String, Integer)
    Example: 0.0000

  • wrapping_cost_tax    string

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

  • wrapping_message    string

    Message to accompany gift-wrapping option.

  • quantity_shipped    number

    Quantity of this item shipped.

  • event_name    string or null

    Name of promotional event/delivery date.

  • event_date    string or null

    Date of the promotional event/scheduled delivery.

  • fixed_shipping_cost    string

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

  • 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 or null

    Numeric ID of the option set applied to the product.
    Example: 5

  • parent_order_product_id    integer or null

    ID of a parent product.

  • is_bundled_product    boolean

    Whether this product is bundled with other products.

  • bin_picking_number    string

    Bin picking number for the physical product.

  • external_id    string or null
    read-only

    (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order.

  • brand    string

    The productʼs brand.

  • applied_discounts    array[object]

    Array of objects containing discounts applied to the product.

  • product_options    array[object]

    Array of product option objects.

  • configurable_fields    array[object]

    Available for only Catalog V2 stores.

  • upc    string

    Universal Product Code. Can be written to for custom products and catalog products.
    <= 255 characters

  • variant_id    integer

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

  • name_customer    string

    The product name that is shown to customer in storefront.
    Example: Fog Linen Chambray Towel - Beige Stripe

  • name_merchant    string

    The product name that is shown to merchant in Control Panel.
    Example: Towel Type 1

  • gift_certificate_id    integer or null

    ID of the associated gift certificate.
    Example: 52

  • discounted_total_inc_tax    string

    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.

    Example: 0.0000

Product

Product with file upload

Custom Product

Product with Variants

Did you find what you were looking for?
Get Order MessagesList Order Products