Order Products | BigCommerce Dev Center

List Order Products

GET https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}/products

Request

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

Authentication

X-Auth-Token in header - required

Parameters

store_hash in path - string
Content-Type in header with default of application/json - string - required
The MIME type of the request body.
page in query - number
The page to return in the response.
limit in query - number
Number of results to return.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/orders/[order_id]/products' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

array | application/json

idinteger
Numeric ID of this product within this order.
Example: 25
order_idinteger
Numeric ID of the associated order.
Example: 120
product_idinteger
Numeric ID of the product.
Example: 20
order_pickup_method_idinteger
ID of the pickup fulfillment method for this item. Default value is 0 when the item is not fulfilled by pickup method.
Example: 0
order_address_idinteger
Numeric ID of the associated order address. Value is 0 for items that are not fulfilled by a pickup method.
Example: 20
namestring
Alias for name_customer - The product name that is shown to customer in storefront.
>= 1 characters
Example: Fog Linen Chambray Towel - Beige Stripe
skustring
User-defined product code/stock keeping unit (SKU).
Example: S-GREE
typestring
Type of product.
Allowed: physical | digital
Example: physical
base_pricestring
The product’s base price. (Float, Float-As-String, Integer)
Example: 54.0000
price_ex_taxstring
The product’s price excluding tax. (Float, Float-As-String, Integer)
Example: 54.0000
price_inc_taxstring
The product’s price including tax. (Float, Float-As-String, Integer)
Example: 54.0000
price_taxstring
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_totalstring
Total base price. (Float, Float-As-String, Integer)
Example: 54.0000
total_ex_taxstring
Total base price excluding tax. (Float, Float-As-String, Integer)
Example: 54.0000
total_inc_taxstring
Total base price including tax. (Float, Float-As-String, Integer)
Example: 54.0000
total_taxstring
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
quantitynumber
Quantity of the product ordered.
Example: 1
base_cost_pricestring
The product’s cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only
Example: 0.0000
cost_price_inc_taxstring
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
Example: 0.0000
cost_price_ex_taxstring
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
Example: 0.0000
weight
Weight of the product. (Float, Float-As-String, Integer)
One of:
Type: number
Example: 1
cost_price_taxstring
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_refundedboolean
Whether the product has been refunded.
Example: false
refunded_amountstringdeprecated
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
return_idnumber
Numeric ID for the refund.
Example: 0
wrapping_namestring
Name of gift-wrapping option.
Example: null
base_wrapping_cost
The value of the base wrapping cost. (Float, Float-As-String, Integer)
One of:
Type: string
Example: 0.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_taxstring
Tax applied to gift-wrapping option. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_messagestring
Message to accompany gift-wrapping option.
quantity_shippednumber
Quantity of this item shipped.
Example: 0
event_namestring
Name of promotional event/delivery date.
Example: null
event_datestring
Date of the promotional event/scheduled delivery.
fixed_shipping_coststring
Fixed shipping cost for this product. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_item_idstring
Item ID for this product on eBay.
ebay_transaction_idstring
Transaction ID for this product on eBay.
option_set_idinteger
Numeric ID of the option set applied to the product.
Example: 5
parent_order_product_idinteger
ID of a parent product.
is_bundled_productboolean
Whether this product is bundled with other products.
Example: false
bin_picking_numberstring
Bin picking number for the physical product.
applied_discountsarray[object]
Array of objects containing discounts applied to the product.
product_optionsarray[object]
Array of product option objects.
external_idstring
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 cannot be overwritten once set.
upcstring
Universal Product Code. Can be written to for custom products and catalog products.
<= 255 characters
variant_idinteger
Products variant_id. PUT or POST. This field is not available for custom products.
name_customerstring
The product name that is shown to customer in storefront.
Example: Fog Linen Chambray Towel - Beige Stripe
name_merchantstring
The product name that is shown to merchant in Control Panel.
Example: Towel Type 1
gift_certificate_idinteger
ID of the associated gift certificate.
Example: 52

response

[
  {
    "id": 65,
    "order_id": 149,
    "product_id": 77,
    "order_address_id": 51,
    "name": "Fog Linen Chambray Towel - Beige Stripe",
    "name_customer": "Fog Linen Chambray Towel - Beige Stripe",
    "name_merchant": "Fog Linen Chambray Towel - Beige Stripe",
    "sku": "S-ORAN",
    "upc": "1234567891112",
    "type": "physical",
    "base_price": "55.9900",
    "price_ex_tax": "55.9900",
    "price_inc_tax": "65.2300",
    "price_tax": "9.2400",
    "base_total": "55.9900",
    "total_ex_tax": "55.9900",
    "total_inc_tax": "65.2300",
    "total_tax": "9.2400",
    "weight": "1.0000",
    "quantity": 1,
    "base_cost_price": "0.0000",
    "cost_price_inc_tax": "0.0000",
    "cost_price_ex_tax": "0.0000",
    "cost_price_tax": "0.0000",
    "is_refunded": false,
    "quantity_refunded": 0,
    "refund_amount": "0.0000",
    "return_id": 0,
    "wrapping_name": "",
    "base_wrapping_cost": "0.0000",
    "wrapping_cost_ex_tax": "0.0000",
    "wrapping_cost_inc_tax": "0.0000",
    "wrapping_cost_tax": "0.0000",
    "wrapping_message": "",
    "quantity_shipped": 0,
    "fixed_shipping_cost": "5.0000",
    "ebay_item_id": "",
    "ebay_transaction_id": "",
    "option_set_id": 19,
    "parent_order_product_id": null,
    "is_bundled_product": false,
    "bin_picking_number": "",
    "external_id": null,
    "fulfillment_source": "",
    "brand": "BigCommerce",
    "applied_discounts": [
      {
        "id": "manual-discount",
        "amount": "1.5900",
        "name": "Manual Discount",
        "code": null,
        "target": "order"
      }
    ],
    "product_options": [
      {
        "id": 45,
        "option_id": 18,
        "order_product_id": 65,
        "product_option_id": 120,
        "display_name": "Size",
        "display_name_customer": "Size",
        "display_name_merchant": "Size",
        "display_value": "S",
        "display_value_customer": "S",
        "display_value_merchant": "S",
        "value": "69",
        "type": "Multiple choice",
        "name": "Apparel sizes",
        "display_style": "Rectangle"
      },
      {
        "id": 46,
        "option_id": 3,
        "order_product_id": 65,
        "product_option_id": 121,
        "display_name": "Color",
        "display_value": "Orange",
        "display_value_customer": "S",
        "display_value_merchant": "S",
        "value": "112",
        "type": "Swatch",
        "name": "Colors",
        "display_style": ""
      },
      {
        "id": 47,
        "option_id": 37,
        "order_product_id": 65,
        "product_option_id": 122,
        "display_name": "Add Letters",
        "display_value": "Text Field",
        "value": "Text Field",
        "type": "Text field",
        "name": "Add Letters",
        "display_style": ""
      },
      {
        "id": 48,
        "option_id": 38,
        "order_product_id": 65,
        "product_option_id": 123,
        "display_name": "Is this a gift?",
        "display_value": "Yes",
        "value": "104",
        "type": "Checkbox",
        "name": "Gift Wrapping $5",
        "display_style": ""
      },
      {
        "id": 49,
        "option_id": 39,
        "order_product_id": 65,
        "product_option_id": 124,
        "display_name": "PickList",
        "display_value": "Able Brewing System",
        "value": "106",
        "type": "Product Pick List",
        "name": "PickList",
        "display_style": "Pick list"
      }
    ],
    "configurable_fields": [],
    "gift_certificate_id": null
  },
  {
    "id": 66,
    "order_id": 149,
    "product_id": 86,
    "order_address_id": 51,
    "name": "Able Brewing System",
    "sku": "ABS",
    "type": "physical",
    "base_price": "0.0000",
    "price_ex_tax": "0.0000",
    "price_inc_tax": "0.0000",
    "price_tax": "0.0000",
    "base_total": "0.0000",
    "total_ex_tax": "0.0000",
    "total_inc_tax": "0.0000",
    "total_tax": "0.0000",
    "weight": "0.0000",
    "quantity": 1,
    "base_cost_price": "0.0000",
    "cost_price_inc_tax": "0.0000",
    "cost_price_ex_tax": "0.0000",
    "cost_price_tax": "0.0000",
    "is_refunded": false,
    "quantity_refunded": 0,
    "refund_amount": "0.0000",
    "return_id": 0,
    "wrapping_name": "",
    "base_wrapping_cost": "0.0000",
    "wrapping_cost_ex_tax": "0.0000",
    "wrapping_cost_inc_tax": "0.0000",
    "wrapping_cost_tax": "0.0000",
    "wrapping_message": "",
    "quantity_shipped": 0,
    "event_name": null,
    "event_date": null,
    "fixed_shipping_cost": "0.0000",
    "ebay_item_id": "",
    "ebay_transaction_id": "",
    "option_set_id": null,
    "parent_order_product_id": 65,
    "is_bundled_product": true,
    "bin_picking_number": "BIN",
    "external_id": null,
    "fulfillment_source": "",
    "brand": "BigCommerce",
    "applied_discounts": [],
    "product_options": [],
    "configurable_fields": [],
    "gift_certificate_id": null
  }
]

Get an Order Product

GET https://api.bigcommerce.com/stores/{store_hash}/v2/orders/{order_id}/products/{product_id}

Request

Gets a product line item associated with the order.

Authentication

X-Auth-Token in header - required

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

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/orders/[order_id]/products/[product_id]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

idinteger
Numeric ID of this product within this order.
Example: 25
order_idinteger
Numeric ID of the associated order.
Example: 120
product_idinteger
Numeric ID of the product.
Example: 20
order_pickup_method_idinteger
ID of the pickup fulfillment method for this item. Default value is 0 when the item is not fulfilled by pickup method.
Example: 0
order_address_idinteger
Numeric ID of the associated order address. Value is 0 for items that are not fulfilled by a pickup method.
Example: 20
namestring
Alias for name_customer - The product name that is shown to customer in storefront.
>= 1 characters
Example: Fog Linen Chambray Towel - Beige Stripe
skustring
User-defined product code/stock keeping unit (SKU).
Example: S-GREE
typestring
Type of product.
Allowed: physical | digital
Example: physical
base_pricestring
The product’s base price. (Float, Float-As-String, Integer)
Example: 54.0000
price_ex_taxstring
The product’s price excluding tax. (Float, Float-As-String, Integer)
Example: 54.0000
price_inc_taxstring
The product’s price including tax. (Float, Float-As-String, Integer)
Example: 54.0000
price_taxstring
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_totalstring
Total base price. (Float, Float-As-String, Integer)
Example: 54.0000
total_ex_taxstring
Total base price excluding tax. (Float, Float-As-String, Integer)
Example: 54.0000
total_inc_taxstring
Total base price including tax. (Float, Float-As-String, Integer)
Example: 54.0000
total_taxstring
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
quantitynumber
Quantity of the product ordered.
Example: 1
base_cost_pricestring
The product’s cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only
Example: 0.0000
cost_price_inc_taxstring
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
Example: 0.0000
cost_price_ex_taxstring
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
Example: 0.0000
weight
Weight of the product. (Float, Float-As-String, Integer)
One of:
Type: number
Example: 1
cost_price_taxstring
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_refundedboolean
Whether the product has been refunded.
Example: false
refunded_amountstringdeprecated
The amount refunded from this transaction; always returns 0. (Float, Float-As-String, Integer)
Example: 0.0000
return_idnumber
Numeric ID for the refund.
Example: 0
wrapping_namestring
Name of gift-wrapping option.
Example: null
base_wrapping_cost
The value of the base wrapping cost. (Float, Float-As-String, Integer)
One of:
Type: string
Example: 0.0000
wrapping_cost_ex_taxstring
The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_inc_taxstring
The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_cost_taxstring
Tax applied to gift-wrapping option. (Float, Float-As-String, Integer)
Example: 0.0000
wrapping_messagestring
Message to accompany gift-wrapping option.
quantity_shippednumber
Quantity of this item shipped.
Example: 0
event_namestring
Name of promotional event/delivery date.
Example: null
event_datestring
Date of the promotional event/scheduled delivery.
fixed_shipping_coststring
Fixed shipping cost for this product. (Float, Float-As-String, Integer)
Example: 0.0000
ebay_item_idstring
Item ID for this product on eBay.
ebay_transaction_idstring
Transaction ID for this product on eBay.
option_set_idinteger
Numeric ID of the option set applied to the product.
Example: 5
parent_order_product_idinteger
ID of a parent product.
is_bundled_productboolean
Whether this product is bundled with other products.
Example: false
bin_picking_numberstring
Bin picking number for the physical product.
applied_discountsarray[object]
Array of objects containing discounts applied to the product.
product_optionsarray[object]
Array of product option objects.
external_idstring
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 cannot be overwritten once set.
upcstring
Universal Product Code. Can be written to for custom products and catalog products.
<= 255 characters
variant_idinteger
Products variant_id. PUT or POST. This field is not available for custom products.
name_customerstring
The product name that is shown to customer in storefront.
Example: Fog Linen Chambray Towel - Beige Stripe
name_merchantstring
The product name that is shown to merchant in Control Panel.
Example: Towel Type 1
gift_certificate_idinteger
ID of the associated gift certificate.
Example: 52

Product

{
  "id": 116,
  "order_id": 181,
  "product_id": 188,
  "order_address_id": 81,
  "name": "Dustpan & Brush",
  "name_customer": "Dustpan & Brush",
  "name_merchant": "Dustpan & Brush",
  "sku": "DUST1",
  "upc": "1234567891112",
  "type": "physical",
  "base_price": "31.9500",
  "price_ex_tax": "31.9500",
  "price_inc_tax": "37.2300",
  "price_tax": "5.2800",
  "base_total": "31.9500",
  "total_ex_tax": "31.9500",
  "total_inc_tax": "37.2300",
  "total_tax": "5.2800",
  "weight": "2.0000",
  "quantity": 1,
  "base_cost_price": "0.0000",
  "cost_price_inc_tax": "0.0000",
  "cost_price_ex_tax": "0.0000",
  "cost_price_tax": "0.0000",
  "is_refunded": false,
  "quantity_refunded": 0,
  "refund_amount": "0.0000",
  "return_id": 0,
  "wrapping_name": "",
  "base_wrapping_cost": "0.0000",
  "wrapping_cost_ex_tax": "0.0000",
  "wrapping_cost_inc_tax": "0.0000",
  "wrapping_cost_tax": "0.0000",
  "wrapping_message": "",
  "quantity_shipped": 0,
  "event_name": null,
  "event_date": null,
  "fixed_shipping_cost": "0.0000",
  "ebay_item_id": "",
  "ebay_transaction_id": "",
  "option_set_id": null,
  "parent_order_product_id": null,
  "is_bundled_product": false,
  "bin_picking_number": "",
  "external_id": null,
  "fulfillment_source": "",
  "brand": "BigCommerce",
  "applied_discounts": [],
  "product_options": []
}

Product with file upload

[
  {
    "id": 35,
    "order_id": 125,
    "product_id": 127,
    "variant_id": 99,
    "order_address_id": 18,
    "name": "Journal",
    "name_customer": "Journal",
    "name_merchant": "Journal",
    "sku": "Jour-BLK",
    "upc": "",
    "type": "physical",
    "base_price": "45.0000",
    "price_ex_tax": "41.5700",
    "price_inc_tax": "45.0000",
    "price_tax": "3.4300",
    "base_total": "45.0000",
    "total_ex_tax": "41.5700",
    "total_inc_tax": "45.0000",
    "total_tax": "3.4300",
    "weight": "0.0000",
    "width": "0.0000",
    "height": "0.0000",
    "depth": "0.0000",
    "quantity": 1,
    "base_cost_price": "0.0000",
    "cost_price_inc_tax": "0.0000",
    "cost_price_ex_tax": "0.0000",
    "cost_price_tax": "0.0000",
    "is_refunded": false,
    "quantity_refunded": 0,
    "refund_amount": "0.0000",
    "return_id": 0,
    "wrapping_name": "",
    "base_wrapping_cost": "0.0000",
    "wrapping_cost_ex_tax": "0.0000",
    "wrapping_cost_inc_tax": "0.0000",
    "wrapping_cost_tax": "0.0000",
    "wrapping_message": "",
    "quantity_shipped": 0,
    "event_name": null,
    "event_date": "",
    "fixed_shipping_cost": "0.0000",
    "ebay_item_id": "",
    "ebay_transaction_id": "",
    "option_set_id": null,
    "parent_order_product_id": null,
    "is_bundled_product": false,
    "bin_picking_number": "",
    "external_id": null,
    "fulfillment_source": "",
    "brand": "BigCommerce",
    "applied_discounts": [],
    "product_options": [
      {
        "id": 18,
        "option id": 38,
        "order_product_id": 35,
        "product_option_id": 121,
        "display_name": "Custom Logo Engraving",
        "display_name_customer": "Custom Logo Engraving",
        "display_name_merchant": "Custom Logo Engraving",
        "display_value": "BigCommerceLogo.jpeg",
        "display_value_customer": "BigCommerceLogo.jpeg",
        "display_value_merchant": "BigCommerceLogo.jpeg",
        "value": {
          "\\\"originalName\\\":\\\"BigCommerceLogo.jpeg\\\"": null,
          "\\\"temporaryPath\\\":\\\"121_fbfb71dfc5a5d911f62d8e35dedd6e45.jpeg\\\"": null,
          "\\\"path\\\":\\\"f606efcae7e179970b19c3658142c5d0.jpeg\\\"": null
        },
        "type": "File upload field",
        "name": "Custom Logo Engraving",
        "display_style": ""
      }
    ],
    "configurable_fields": [],
    "gift_certificate_id": null
  }
]

Custom Product

{
  "id": 238,
  "order_id": 247,
  "product_id": 0,
  "variant_id": 0,
  "order_address_id": 151,
  "name": "Journal",
  "name_customer": "Journal",
  "name_merchant": "Journal",
  "sku": "Jour-BLK",
  "upc": "",
  "type": "physical",
  "base_price": "45.0000",
  "price_ex_tax": "41.5700",
  "price_inc_tax": "45.0000",
  "price_tax": "3.4300",
  "base_total": "45.0000",
  "total_ex_tax": "41.5700",
  "total_inc_tax": "45.0000",
  "total_tax": "3.4300",
  "weight": "0.0000",
  "width": "0.0000",
  "height": "0.0000",
  "depth": "0.0000",
  "quantity": 1,
  "base_cost_price": "0.0000",
  "cost_price_inc_tax": "0.0000",
  "cost_price_ex_tax": "0.0000",
  "cost_price_tax": "0.0000",
  "is_refunded": false,
  "quantity_refunded": 0,
  "refund_amount": "0.0000",
  "return_id": 0,
  "wrapping_name": "",
  "base_wrapping_cost": "0.0000",
  "wrapping_cost_ex_tax": "0.0000",
  "wrapping_cost_inc_tax": "0.0000",
  "wrapping_cost_tax": "0.0000",
  "wrapping_message": "",
  "quantity_shipped": 0,
  "event_name": null,
  "event_date": "",
  "fixed_shipping_cost": "0.0000",
  "ebay_item_id": "",
  "ebay_transaction_id": "",
  "option_set_id": null,
  "parent_order_product_id": null,
  "is_bundled_product": false,
  "bin_picking_number": "",
  "external_id": null,
  "fulfillment_source": "",
  "brand": "BigCommerce",
  "applied_discounts": [],
  "product_options": [],
  "configurable_fields": [],
  "gift_certificate_id": null
}

Product with Variants

{
  "id": 240,
  "order_id": 247,
  "product_id": 201,
  "variant_id": 477,
  "order_address_id": 151,
  "name": "BigCommerce T-Shirt",
  "name_customer": "BigCommerce T-Shirt",
  "name_merchant": "BigCommerce T-Shirt",
  "sku": "SKU-201-Red-Small T-Shirt-Able Brewing System",
  "upc": "",
  "type": "physical",
  "base_price": "235.0000",
  "price_ex_tax": "217.0900",
  "price_inc_tax": "235.0000",
  "price_tax": "17.9100",
  "base_total": "940.0000",
  "total_ex_tax": "868.3600",
  "total_inc_tax": "940.0000",
  "total_tax": "71.6400",
  "weight": "3.0000",
  "width": "3.0000",
  "height": "3.0000",
  "depth": "3.0000",
  "quantity": 4,
  "base_cost_price": "0.0000",
  "cost_price_inc_tax": "0.0000",
  "cost_price_ex_tax": "0.0000",
  "cost_price_tax": "0.0000",
  "is_refunded": false,
  "quantity_refunded": 0,
  "refund_amount": "0.0000",
  "return_id": 0,
  "wrapping_name": "",
  "base_wrapping_cost": "0.0000",
  "wrapping_cost_ex_tax": "0.0000",
  "wrapping_cost_inc_tax": "0.0000",
  "wrapping_cost_tax": "0.0000",
  "wrapping_message": "",
  "quantity_shipped": 0,
  "event_name": {},
  "event_date": "",
  "fixed_shipping_cost": "0.0000",
  "ebay_item_id": "",
  "ebay_transaction_id": "",
  "option_set_id": 68,
  "parent_order_product_id": {},
  "is_bundled_product": false,
  "bin_picking_number": "",
  "external_id": {},
  "fulfillment_source": "",
  "brand": "BigCommerce",
  "applied_discounts": []
}

Product with custom message

[
  {
    "id": 143,
    "option_id": 96,
    "order_product_id": 240,
    "product_option_id": 242,
    "display_name": "Color",
    "display_name_customer": "Color",
    "display_name_merchant": "Color",
    "display_value": "Red",
    "display_value_customer": "Red",
    "display_value_merchant": "Red",
    "value": "211",
    "type": "Swatch",
    "name": "Color1549572910-201",
    "display_style": ""
  },
  {
    "id": 144,
    "option_id": 114,
    "order_product_id": 240,
    "product_option_id": 263,
    "display_name": "PickList PriceList",
    "display_name_customer": "PickList PriceList",
    "display_name_merchant": "PickList PriceList",
    "display_value": "Able Brewing System",
    "display_value_customer": "Able Brewing System",
    "display_value_merchant": "Able Brewing System",
    "value": "237",
    "type": "Product Pick List",
    "name": "PickList-PriceList1549572910-201",
    "display_style": "Pick list with photos"
  },
  {
    "id": 145,
    "option_id": 97,
    "order_product_id": 240,
    "product_option_id": 243,
    "display_name": "T-Shirt Size",
    "display_name_customer": "T-Shirt Size",
    "display_name_merchant": "T-Shirt Size",
    "display_value": "Small T-Shirt",
    "display_value_customer": "Small T-Shirt",
    "display_value_merchant": "Small T-Shirt",
    "value": "214",
    "type": "Multiple choice",
    "name": "T-Shirt-Size1545071633-201",
    "display_style": "Rectangle"
  },
  {
    "id": 146,
    "option_id": 105,
    "order_product_id": 240,
    "product_option_id": 254,
    "display_name": "Custom Message",
    "display_name_customer": "Custom Message",
    "display_name_merchant": "Custom Message",
    "display_value": "BigCommerce",
    "display_value_customer": "BigCommerce",
    "display_value_merchant": "BigCommerce",
    "value": "BigCommerce",
    "type": "Text field",
    "name": "Custom-Message1549572912-201",
    "display_style": "",
    "configurable_fields": null
  }
]

product_options

[
  {
    "id": 143,
    "option_id": 96,
    "order_product_id": 240,
    "product_option_id": 242,
    "display_name": "Color",
    "display_name_customer": "Color",
    "display_name_merchant": "Color",
    "display_value": "Red",
    "display_value_customer": "Red",
    "display_value_merchant": "Red",
    "value": "211",
    "type": "Swatch",
    "name": "Color1549572910-201",
    "display_style": ""
  },
  {
    "id": 144,
    "option_id": 114,
    "order_product_id": 240,
    "product_option_id": 263,
    "display_name": "PickList PriceList",
    "display_name_customer": "PickList PriceList",
    "display_name_merchant": "PickList PriceList",
    "display_value": "Able Brewing System",
    "display_value_customer": "Able Brewing System",
    "display_value_merchant": "Able Brewing System",
    "value": "237",
    "type": "Product Pick List",
    "name": "PickList-PriceList1549572910-201",
    "display_style": "Pick list with photos"
  },
  {
    "id": 145,
    "option_id": 97,
    "order_product_id": 240,
    "product_option_id": 243,
    "display_name": "T-Shirt Size",
    "display_name_customer": "T-Shirt Size",
    "display_name_merchant": "T-Shirt Size",
    "display_value": "Small T-Shirt",
    "display_value_customer": "Small T-Shirt",
    "display_value_merchant": "Small T-Shirt",
    "value": "214",
    "type": "Multiple choice",
    "name": "T-Shirt-Size1545071633-201",
    "display_style": "Rectangle"
  },
  {
    "id": 146,
    "option_id": 105,
    "order_product_id": 240,
    "product_option_id": 254,
    "display_name": "Custom Message",
    "display_name_customer": "Custom Message",
    "display_name_merchant": "Custom Message",
    "display_value": "BigCommerce",
    "display_value_customer": "BigCommerce",
    "display_value_merchant": "BigCommerce",
    "value": "BigCommerce",
    "type": "Text field",
    "name": "Custom-Message1549572912-201",
    "display_style": "",
    "configurable_fields": []
  }
]

List Order Products

Request

Authentication

Parameters

example

Response

Body

idinteger

order_idinteger

product_idinteger

order_pickup_method_idinteger

order_address_idinteger

namestring

skustring

typestring

base_pricestring

price_ex_taxstring

price_inc_taxstring

price_taxstring

base_totalstring

total_ex_taxstring

total_inc_taxstring

total_taxstring

quantitynumber

base_cost_pricestring

cost_price_inc_taxstring

cost_price_ex_taxstring

weight

cost_price_taxstring

is_refundedboolean

refunded_amountstringdeprecated

return_idnumber

wrapping_namestring

base_wrapping_cost

wrapping_cost_ex_taxstring

wrapping_cost_inc_taxstring

wrapping_cost_taxstring

wrapping_messagestring

quantity_shippednumber

event_namestring

event_datestring

fixed_shipping_coststring

ebay_item_idstring

ebay_transaction_idstring

option_set_idinteger

parent_order_product_idinteger

is_bundled_productboolean

bin_picking_numberstring

applied_discountsarray[object]

product_optionsarray[object]

external_idstring

upcstring

variant_idinteger

name_customerstring

name_merchantstring

gift_certificate_idinteger

response

Get an Order Product

Request

Authentication

Parameters

example

Response

Body

idinteger

order_idinteger

product_idinteger

order_pickup_method_idinteger

order_address_idinteger

namestring

skustring

typestring

base_pricestring

price_ex_taxstring

price_inc_taxstring

price_taxstring

base_totalstring

total_ex_taxstring

total_inc_taxstring

total_taxstring