# Orders Object

> Source: https://truto.one/docs/api-reference/unified-e-commerce-api/orders/

Schema for the `Orders` resource in **Unified E-Commerce API**.

## Properties

- **`id`** _(string, required)_
  The unique identifier for an order
- **`order_number`** _(string)_
  The order number for an order
- **`currency`** _(string)_
  The currency associated for amount of an order
- **`exchange_rate`** _(string)_
  The exchange rate for an order's transaction when the currency is different from the store's default currency.
- **`discounts`** _(array<object>)_
  The discounts for an order
  - **`code`** _(string)_
    The code used to apply the discount
  - **`amount`** _(string)_
    The fixed amount of the discount
  - **`percentage`** _(string)_
    The percentage of discount
- **`sub_total`** _(string)_
  The sub-total amount for an order
- **`shipping_cost`** _(string)_
  The shipping cost for an order
- **`total_discount`** _(string)_
  The total discount for an order
- **`total_tax`** _(string)_
  The total tax for an order
- **`total_amount`** _(string)_
  The total amount for an order
- **`status`** _(string)_
  The status for an order. If no clear mapping exists, then raw value is returned.
  Allowed: `active`, `completed`, `cancelled`, `archived`, `pending`
- **`payment_status`** _(string)_
  The payment status for an order. If no clear mapping exists, then raw value is returned.
  Allowed: `pending`, `authorized`, `paid`, `partial`, `refunded`, `voided`, `cancelled`, `unknown`
- **`fulfillment_status`** _(string)_
  The fullfillment status for an order. If no clear mapping exists, then raw value is returned.
  Allowed: `pending`, `partial`, `delivered`, `cancelled`
- **`payment_method`** _(string)_
  The payment method used for this order
- **`customer`** _(object)_
  The customer this order is linked to
  - **`id`** _(string)_
    The unique identifier for customer
  - **`first_name`** _(string)_
    The first name of customer
  - **`last_name`** _(string)_
    The last name of customer
  - **`name`** _(string)_
    The full name of customer
  - **`company_name`** _(string)_
    The company name of customer
  - **`emails`** _(array<object>)_
    The emails of customer
    - **`email`** _(string)_
      The email of the customer
    - **`type`** _(string)_
      The type of email
    - **`is_primary`** _(boolean)_
      The status of email
  - **`phones`** _(array<object>)_
    The phone numbers of customer
    - **`number`** _(string)_
      The number of phone
    - **`type`** _(string)_
      The type of phone
- **`billing_address`** _(object)_
  The billing address for an order
  - **`street_1`** _(string)_
    The first line of billing address
  - **`street_2`** _(string)_
    The second line of billing address
  - **`company_name`** _(string)_
    The company name of customer
  - **`city`** _(string)_
    The city of the billing address
  - **`state`** _(string)_
    The state/province of the billng address
  - **`postal_code`** _(string)_
    The postal code of the billing address
  - **`country`** _(string)_
    The country of the billing address
- **`shipping_address`** _(object)_
  The shipping address for an order
  - **`street_1`** _(string)_
    The first line of shipping address
  - **`street_2`** _(string)_
    The second line of shipping address
  - **`company_name`** _(string)_
    The company name of customer
  - **`city`** _(string)_
    The city of the shipping address
  - **`state`** _(string)_
    The state/province of the shipping address
  - **`postal_code`** _(string)_
    The postal code of the shipping address
  - **`country`** _(string)_
    The country of the shipping address
- **`tracking`** _(object)_
  The tracking details for an order
  - **`provider`** _(string, required)_
    The name of carrier handling the shipment
  - **`number`** _(string, required)_
    The tracking number of shipment
  - **`url`** _(string)_
    The url of tracking page
  - **`updated_at`** _(string)_
    The date and time of last parcel update
- **`line_items`** _(array<object>)_
  The line items for an order
  - **`name`** _(string, required)_
    The name of the line item
  - **`quantity`** _(string, required)_
    The quantity of the line item
  - **`total_amount`** _(string)_
    The total amount of the line item
  - **`id`** _(string)_
    The id of the line item
  - **`product_id`** _(string)_
    The product id of the line item
  - **`variant_id`** _(string)_
    The variant id of the line item
  - **`sku`** _(string)_
    The sku of the line item
  - **`description`** _(string)_
    The description of the line item
  - **`options`** _(array<object>)_
    The options for line item
    - **`id`** _(string)_
      The unique identifier for options
    - **`name`** _(string)_
      The name for options
    - **`value`** _(string)_
      The value for options
  - **`unit_price`** _(string)_
    The unit price of the line item
  - **`tax_rate`** _(string)_
    The tax rate of the line item
  - **`tax_amount`** _(string)_
    The tax amount of the line item
  - **`discounts`** _(array<object>)_
    The discounts for line item
    - **`code`** _(string)_
      The used for discounts
    - **`amount`** _(string)_
      The fixed amount for discounts
    - **`percentage`** _(string)_
      The percentage of discounts
- **`note`** _(string)_
  The note for an order
- **`created_at`** _(string)_
  The date and time when order was created
- **`updated_at`** _(string)_
  The date and time when order was updated
- **`type`** _(string)_
  The type of the order
- **`shipping_methods`** _(object)_
  The shipping methods that are associated with the Order.
- **`submitted_date`** _(string)_
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.

## Methods

- [GET /unified/ecommerce/orders](/docs/api-reference/unified-e-commerce-api/orders/list) — List Orders
- [GET /unified/ecommerce/orders/{id}](/docs/api-reference/unified-e-commerce-api/orders/get) — Get Orders