# # OrderResp

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Read-only. The ID of the order. | [optional]
**date_modified** | **string** | A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT operation. RFC-2822 | [optional]
**date_shipped** | **string** | A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT operation. RFC-2822 | [optional]
**cart_id** | **string** | The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. | [optional]
**status** | **string** | The status will include one of the (string, optiona) - values defined under Order Statuses. This value is read-only. Do not attempt to modify or set this value in a POST or PUT operation. | [optional]
**subtotal_tax** | **string** | A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (Float, Float-As-String, Integer) | [optional]
**shipping_cost_tax** | **string** | A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (Float, Float-As-String, Integer) | [optional]
**shipping_cost_tax_class_id** | **int** | Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.) | [optional]
**handling_cost_tax** | **string** | A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (Float, Float-As-String, Integer) | [optional]
**handling_cost_tax_class_id** | **int** | A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.) | [optional]
**wrapping_cost_tax** | **string** | A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (Float, Float-As-String, Integer) | [optional]
**wrapping_cost_tax_class_id** | **int** | A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.) | [optional]
**payment_status** | **string** | A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. | [optional]
**store_credit_amount** | **string** | Represents the store credit that the shopper has redeemed on this individual order. This is a read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer) | [optional]
**gift_certificate_amount** | **string** | A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer) | [optional]
**currency_id** | **int** | The display currency ID. May be different from transactional currency. A read-only value. Do not pass in a POST or PUT. | [optional]
**currency_code** | **string** | The currency code of the display currency used to present prices on the storefront. A read-only value. Do not pass in a POST or PUT. | [optional]
**currency_exchange_rate** | **string** | The exchange rate between the store&#39;s default currency and the display currency. A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer) | [optional]
**default_currency_id** | **int** | The transactional currency ID. A read-only value. Do not pass in a POST or PUT. | [optional]
**coupon_discount** | **string** | A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer) | [optional]
**shipping_address_count** | **float** | The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT. | [optional]
**is_email_opt_in** | **bool** | Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT. | [optional]
**order_source** | **string** | Orders submitted via the store&#39;s website will include a &#x60;www&#x60; value. Orders submitted via the API will be set to &#x60;external&#x60;. A read-only value. Do not pass in a POST or PUT. | [optional]
**products** | [**\Bigcommerce\OrdersV2\Model\ProductsResource**](ProductsResource.md) |  | [optional]
**shipping_addresses** | [**\Bigcommerce\OrdersV2\Model\ShippingAddressesResource**](ShippingAddressesResource.md) |  | [optional]
**coupons** | [**\Bigcommerce\OrdersV2\Model\CouponsResource**](CouponsResource.md) |  | [optional]
**status_id** | **int** | The status ID of the order. | [optional]
**base_handling_cost** | **string** | The value of the base handling cost. (Float, Float-As-String, Integer) | [optional]
**base_shipping_cost** | **string** | The value of the base shipping cost. (Float, Float-As-String, Integer) | [optional]
**base_wrapping_cost** | **string** | The value of the base wrapping cost. (Float, Float-As-String, Integer) | [optional]
**billing_address** | [**\Bigcommerce\OrdersV2\Model\BillingAddressFull**](BillingAddressFull.md) |  | [optional]
**channel_id** | **int** | Shows where the order originated. The channel_id will default to 1. | [optional]
**customer_id** | **float** |  | [optional]
**customer_message** | **string** | Message that the customer entered (number, optional) -o the &#x60;Order Comments&#x60; box during checkout. | [optional]
**date_created** | **string** | The date this order was created. If not specified, will default to the current time. The date should be in RFC 2822 format. | [optional]
**default_currency_code** | **string** | The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled. | [optional]
**discount_amount** | **string** | Amount of discount for this transaction. (Float, Float-As-String, Integer) | [optional]
**ebay_order_id** | **string** | If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be &#x60;0&#x60;. | [optional]
**external_id** | **string** | 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 &#39;external_id&#39; cannot be written to. Please remove it from your request before trying again. It can not be overwritten once set. | [optional]
**external_source** | **string** | For orders submitted or modified via the API, using a PUT or POST operation, you can optionally pass in a value identifying the system used to generate the order. For example: &#x60;POS&#x60;. Otherwise, the value will be null. | [optional]
**geoip_country** | **string** | The full name of the country where the customer made the purchase, based on the IP. | [optional]
**geoip_country_iso2** | **string** | The country where the customer made the purchase, in ISO2 format, based on the IP. | [optional]
**handling_cost_ex_tax** | **string** | The value of the handling cost, excluding tax. (Float, Float-As-String, Integer) | [optional]
**handling_cost_inc_tax** | **string** | The value of the handling cost, including tax. (Float, Float-As-String, Integer) | [optional]
**ip_address** | **string** | IP Address of the customer, if known. | [optional]
**is_deleted** | **bool** | Indicates whether the order was deleted (archived). Set to to true, to archive an order. | [optional]
**items_shipped** | **float** | The number of items that have been shipped. | [optional]
**items_total** | **float** | The total number of items in the order. | [optional]
**order_is_digital** | **bool** | Whether this is an order for digital products. | [optional]
**payment_method** | **string** | The payment method for this order. Can be one of the following: &#x60;Manual&#x60;, &#x60;Credit Card&#x60;, &#x60;cash&#x60;, &#x60;Test Payment Gateway&#x60;, etc. | [optional]
**payment_provider_id** | **string** | The external Transaction ID/Payment ID within this order&#39;s payment provider (if a payment provider was used). | [optional]
**refunded_amount** | **string** | The amount refunded from this transaction. (Float, Float-As-String, Integer) | [optional]
**shipping_cost_ex_tax** | **string** | The value of shipping cost, excluding tax. (Float, Float-As-String, Integer) | [optional]
**shipping_cost_inc_tax** | **string** | The value of shipping cost, including tax. (Float, Float-As-String, Integer) | [optional]
**staff_notes** | **string** | Any additional notes for staff. | [optional]
**subtotal_ex_tax** | **string** | Override value for subtotal excluding tax. If specified, the field &#x60;subtotal_inc_tax&#x60; is also required. (Float, Float-As-String, Integer) | [optional]
**subtotal_inc_tax** | **string** | Override value for subtotal including tax. If specified, the field &#x60;subtotal_ex_tax&#x60; is also required. (Float, Float-As-String, Integer) | [optional]
**tax_provider_id** | **string** | BasicTaxProvider - Tax is set to manual.  AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API. Used for Avalara.  \&quot;\&quot; (blank) - When the tax provider is unknown. This includes legacy orders and orders previously created via API. This can be set when creating an order using a POST. | [optional]
**customer_locale** | **string** | The customer&#39;s locale | [optional]
**total_ex_tax** | **string** | Override value for the total, excluding tax. If specified, the field &#x60;total_inc_tax&#x60; is also required. (Float, Float-As-String, Integer) | [optional]
**total_inc_tax** | **string** | Override value for the total, including tax. If specified, the field &#x60;total_ex_tax&#x60; is also required. (Float, Float-As-String, Integer) | [optional]
**wrapping_cost_ex_tax** | **string** | The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer) | [optional]
**wrapping_cost_inc_tax** | **string** | The value of the wrapping cost, including tax. (Float, Float-As-String, Integer) | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
