# Ecommerce API — Orders

> Canonical URL: https://developers.apideck.com/apis/ecommerce/reference#tag/Orders

This document contains every operation on the `Orders` resource.

---

# List Orders

> **Ecommerce API** · `GET /ecommerce/orders`
> Canonical URL: https://developers.apideck.com/apis/ecommerce/reference#tag/Orders/operation/ordersAll

List Orders

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `cursor` | query | `string` | No | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. |
| `limit` | query | `integer` | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |
| `filter` | query | `object` | No | Apply filters |
| `sort` | query | `object` | No | Apply sorting |
| `pass_through` | query | `object` | No | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads |
| `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. |

### Responses

#### 200 — Orders

- `status_code` `integer` **required** — HTTP Response Status Code — example: `200`
- `status` `string` **required** — HTTP Response Status — example: `OK`
- `service` `string` **required** — Apideck ID of service provider — example: `shopify`
- `resource` `string` **required** — Unified API resource name — example: `orders`
- `operation` `string` **required** — Operation performed — example: `all`
- `data` `array of object` **required**
  - `id` `string` **required** — A unique identifier for an object. — example: `12345`
  - `order_number` `string` — Order number, if any. — example: `123456789`
  - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
  - `discounts` `array of object`
    - `code` `string` — The code used to apply the discount. — example: `SUMMER20`
    - `amount` `string` — The fixed amount of the discount. — example: `5.99`
    - `percentage` `string` — The percentage of the discount. — example: `0.1`
  - `sub_total` `string` — Sub-total amount, normally before tax. — example: `45.17`
  - `shipping_cost` `string` — Shipping cost, if any. — example: `5.17`
  - `coupon_discount` `string` — Coupon discount, if any. — example: `5.5`
  - `total_discount` `string` — Total discount, if any. — example: `5.5`
  - `total_tax` `string` — Total tax, if any. — example: `5.16`
  - `total_amount` `string` — Total amount due. — example: `50.17`
  - `refunded_amount` `string` — Refunded amount, if any. — example: `5.5`
  - `status` `string` — Current status of the order. — enum: `active`, `completed`, `cancelled`, `archived`, `unknown`, `other` — example: `active`
  - `payment_status` `string` — Current payment status of the order. — enum: `pending`, `authorized`, `paid`, `partial`, `refunded`, `voided`, `unknown`, `partially_refunded` — example: `paid`
  - `fulfillment_status` `string` — Current fulfillment status of the order. — enum: `pending`, `shipped`, `partial`, `delivered`, `cancelled`, `returned`, `unknown` — example: `shipped`
  - `payment_method` `string` — Payment method used for this order. — example: `credit_card`
  - `customer` `object` — The customer this entity is linked to.
    - `id` `string` — The ID of the customer this entity is linked to. — example: `12345`
    - `name` `string` — Full name of the customer — example: `John Doe`
    - `first_name` `string` — First name of the customer — example: `John`
    - `last_name` `string` — Last name of the customer — example: `Doe`
    - `company_name` `string` — Company name of the customer — example: `Acme Inc.`
    - `phone_numbers` `array of object`
      - `id` `string` — Unique identifier of the phone number — example: `12345`
      - `country_code` `string` — The country code of the phone number, e.g. +1 — example: `1`
      - `area_code` `string` — The area code of the phone number, e.g. 323 — example: `323`
      - `number` `string` **required** — The phone number — example: `111-111-1111`
      - `extension` `string` — The extension of the phone number — example: `105`
      - `type` `string` — The type of phone number — enum: `primary`, `secondary`, `home`, `work`, `office`, `mobile`, `assistant`, `fax`, `direct-dial-in`, `personal`, `billing`, `other` — example: `primary`
    - `emails` `array of object`
      - `id` `string` — Unique identifier for the email address — example: `123`
      - `email` `string` **required** — Email address — format: `email` — example: `elon@musk.com`
      - `type` `string` — Email type — enum: `primary`, `secondary`, `work`, `personal`, `billing`, `other` — example: `primary`
  - `billing_address` `object` — An object representing a shipping or billing address.
    - `line1` `string` — Address line 1 of the billing address. — example: `123 Main Street`
    - `line2` `string` — Address line 2 of the billing address. — example: `Apt 1`
    - `company_name` `string` — Company name of the customer — example: `Acme Inc.`
    - `city` `string` — City of the billing address. — example: `New York`
    - `state` `string` — State/province of the billing address. — example: `NY`
    - `postal_code` `string` — Postal/ZIP code of the billing address. — example: `10001`
    - `country` `string` — Country of the billing address. — example: `US`
  - `shipping_address` `object` — An object representing a shipping or billing address.
    - `line1` `string` — Address line 1 of the billing address. — example: `123 Main Street`
    - `line2` `string` — Address line 2 of the billing address. — example: `Apt 1`
    - `company_name` `string` — Company name of the customer — example: `Acme Inc.`
    - `city` `string` — City of the billing address. — example: `New York`
    - `state` `string` — State/province of the billing address. — example: `NY`
    - `postal_code` `string` — Postal/ZIP code of the billing address. — example: `10001`
    - `country` `string` — Country of the billing address. — example: `US`
  - `tracking` `array of object`
    - `provider` `string` **required** — The name or code of the carrier or shipping company that is handling the shipment. — example: `UPS`
    - `number` `string` **required** — The tracking number associated with the shipment, which can be used to track the progress of the delivery. — example: `1Z9999999999999999`
    - `url` `string` — The URL of the carrier's tracking page, which can be used to view detailed information about the shipment's progress. — example: `https://www.ups.com/track?tracknum=1Z9999999999999999`
    - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
  - `line_items` `array of object`
    - `id` `string` — A unique identifier for an object. — example: `12345`
    - `product_id` `string` — A unique identifier for the product associated with the line item. — example: `def456`
    - `variant_id` `string` — A unique identifier for the variant of the product associated with the line item, if applicable. — example: `ghi789`
    - `sku` `string` — The SKU of the product or variant associated with the line item. — example: `MBP123-16GB-SILVER-13`
    - `name` `string` — The name of the product or variant associated with the line item. — example: `Midnight 16inch MacBook Pro`
    - `description` `string` — The description of the product or variant associated with the line item. — example: `Powerful and portable, the MacBook Pro is perfect for professionals and creatives.`
    - `options` `array of any`
      - `id` `string` — A unique identifier for the option. — example: `jkl012`
      - `name` `string` — The name of the option. — example: `Color`
      - `value` `string` — The value of the option. — example: `Silver`
    - `quantity` `string` **required** — The quantity of the product or variant associated with the line item. — example: `2`
    - `unit_price` `string` — The unit price of the product or variant associated with the line item. — example: `19.99`
    - `tax_rate` `string` — The tax rate applied to the product or variant associated with the line item. — example: `0.08`
    - `tax_amount` `string` — The total tax amount applied to the product or variant associated with the line item. — example: `1.6`
    - `is_refunded` `boolean` — Whether the line item has been refunded. — example: `false`
    - `refunded_amount` `string` — The amount of the line item that has been refunded. — example: `0`
    - `refunded_quantity` `string` — The quantity of the line item that has been refunded. — example: `0`
    - `sub_total` `string` — The sub total for the product(s) or variant associated with the line item, excluding taxes and discounts. — example: `43.18`
    - `total_amount` `string` — The total amount for the product(s) or variant associated with the line item, including taxes and discounts. — example: `43.18`
    - `discounts` `array of object`
      - `code` `string` — The code used to apply the discount. — example: `SUMMER20`
      - `amount` `string` — The fixed amount of the discount. — example: `5.99`
      - `percentage` `string` — The percentage of the discount. — example: `0.1`
  - `note` `string` — Note for the order. — example: `Special instructions for delivery`
  - `refunds` `array of object`
    - `id` `string` — A unique identifier for an object. — example: `12345`
    - `amount` `string` — The amount of the refund. — example: `100`
    - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
    - `reason` `string` — The reason for the refund. — example: `Customer requested a refund`
    - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
  - `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here.
  - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
  - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `_raw` `object` — Raw response from the integration when raw=true query param is provided
- `meta` `object` — Response metadata
  - `items_on_page` `integer` — Number of items returned in the data property of the response — example: `50`
  - `cursors` `object` — Cursors to navigate to previous or next pages through the API
    - `previous` `string` — Cursor to navigate to the previous page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjE=`
    - `current` `string` — Cursor to navigate to the current page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjI=`
    - `next` `string` — Cursor to navigate to the next page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjM=`
- `links` `object` — Links to navigate to previous or next pages through the API
  - `previous` `string` — Link to navigate to the previous page through the API — example: `https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D`
  - `current` `string` — Link to navigate to the current page through the API — example: `https://unify.apideck.com/crm/companies`
  - `next` `string` — Link to navigate to the previous page through the API — example: `https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM`

#### 400 — Bad Request

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 402 — Payment Required

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 404 — The specified resource was not found

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 422 — Unprocessable

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Unexpected error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---

# Get Order

> **Ecommerce API** · `GET /ecommerce/orders/{id}`
> Canonical URL: https://developers.apideck.com/apis/ecommerce/reference#tag/Orders/operation/ordersOne

Get Order

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | `string` | Yes | ID of the record you are acting upon. |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
| `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. |

### Responses

#### 200 — Orders

- `status_code` `integer` **required** — HTTP Response Status Code — example: `200`
- `status` `string` **required** — HTTP Response Status — example: `OK`
- `service` `string` **required** — Apideck ID of service provider — example: `shopify`
- `resource` `string` **required** — Unified API resource name — example: `orders`
- `operation` `string` **required** — Operation performed — example: `one`
- `data` `object` **required**
  - `id` `string` **required** — A unique identifier for an object. — example: `12345`
  - `order_number` `string` — Order number, if any. — example: `123456789`
  - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
  - `discounts` `array of object`
    - `code` `string` — The code used to apply the discount. — example: `SUMMER20`
    - `amount` `string` — The fixed amount of the discount. — example: `5.99`
    - `percentage` `string` — The percentage of the discount. — example: `0.1`
  - `sub_total` `string` — Sub-total amount, normally before tax. — example: `45.17`
  - `shipping_cost` `string` — Shipping cost, if any. — example: `5.17`
  - `coupon_discount` `string` — Coupon discount, if any. — example: `5.5`
  - `total_discount` `string` — Total discount, if any. — example: `5.5`
  - `total_tax` `string` — Total tax, if any. — example: `5.16`
  - `total_amount` `string` — Total amount due. — example: `50.17`
  - `refunded_amount` `string` — Refunded amount, if any. — example: `5.5`
  - `status` `string` — Current status of the order. — enum: `active`, `completed`, `cancelled`, `archived`, `unknown`, `other` — example: `active`
  - `payment_status` `string` — Current payment status of the order. — enum: `pending`, `authorized`, `paid`, `partial`, `refunded`, `voided`, `unknown`, `partially_refunded` — example: `paid`
  - `fulfillment_status` `string` — Current fulfillment status of the order. — enum: `pending`, `shipped`, `partial`, `delivered`, `cancelled`, `returned`, `unknown` — example: `shipped`
  - `payment_method` `string` — Payment method used for this order. — example: `credit_card`
  - `customer` `object` — The customer this entity is linked to.
    - `id` `string` — The ID of the customer this entity is linked to. — example: `12345`
    - `name` `string` — Full name of the customer — example: `John Doe`
    - `first_name` `string` — First name of the customer — example: `John`
    - `last_name` `string` — Last name of the customer — example: `Doe`
    - `company_name` `string` — Company name of the customer — example: `Acme Inc.`
    - `phone_numbers` `array of object`
      - `id` `string` — Unique identifier of the phone number — example: `12345`
      - `country_code` `string` — The country code of the phone number, e.g. +1 — example: `1`
      - `area_code` `string` — The area code of the phone number, e.g. 323 — example: `323`
      - `number` `string` **required** — The phone number — example: `111-111-1111`
      - `extension` `string` — The extension of the phone number — example: `105`
      - `type` `string` — The type of phone number — enum: `primary`, `secondary`, `home`, `work`, `office`, `mobile`, `assistant`, `fax`, `direct-dial-in`, `personal`, `billing`, `other` — example: `primary`
    - `emails` `array of object`
      - `id` `string` — Unique identifier for the email address — example: `123`
      - `email` `string` **required** — Email address — format: `email` — example: `elon@musk.com`
      - `type` `string` — Email type — enum: `primary`, `secondary`, `work`, `personal`, `billing`, `other` — example: `primary`
  - `billing_address` `object` — An object representing a shipping or billing address.
    - `line1` `string` — Address line 1 of the billing address. — example: `123 Main Street`
    - `line2` `string` — Address line 2 of the billing address. — example: `Apt 1`
    - `company_name` `string` — Company name of the customer — example: `Acme Inc.`
    - `city` `string` — City of the billing address. — example: `New York`
    - `state` `string` — State/province of the billing address. — example: `NY`
    - `postal_code` `string` — Postal/ZIP code of the billing address. — example: `10001`
    - `country` `string` — Country of the billing address. — example: `US`
  - `shipping_address` `object` — An object representing a shipping or billing address.
    - `line1` `string` — Address line 1 of the billing address. — example: `123 Main Street`
    - `line2` `string` — Address line 2 of the billing address. — example: `Apt 1`
    - `company_name` `string` — Company name of the customer — example: `Acme Inc.`
    - `city` `string` — City of the billing address. — example: `New York`
    - `state` `string` — State/province of the billing address. — example: `NY`
    - `postal_code` `string` — Postal/ZIP code of the billing address. — example: `10001`
    - `country` `string` — Country of the billing address. — example: `US`
  - `tracking` `array of object`
    - `provider` `string` **required** — The name or code of the carrier or shipping company that is handling the shipment. — example: `UPS`
    - `number` `string` **required** — The tracking number associated with the shipment, which can be used to track the progress of the delivery. — example: `1Z9999999999999999`
    - `url` `string` — The URL of the carrier's tracking page, which can be used to view detailed information about the shipment's progress. — example: `https://www.ups.com/track?tracknum=1Z9999999999999999`
    - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
  - `line_items` `array of object`
    - `id` `string` — A unique identifier for an object. — example: `12345`
    - `product_id` `string` — A unique identifier for the product associated with the line item. — example: `def456`
    - `variant_id` `string` — A unique identifier for the variant of the product associated with the line item, if applicable. — example: `ghi789`
    - `sku` `string` — The SKU of the product or variant associated with the line item. — example: `MBP123-16GB-SILVER-13`
    - `name` `string` — The name of the product or variant associated with the line item. — example: `Midnight 16inch MacBook Pro`
    - `description` `string` — The description of the product or variant associated with the line item. — example: `Powerful and portable, the MacBook Pro is perfect for professionals and creatives.`
    - `options` `array of any`
      - `id` `string` — A unique identifier for the option. — example: `jkl012`
      - `name` `string` — The name of the option. — example: `Color`
      - `value` `string` — The value of the option. — example: `Silver`
    - `quantity` `string` **required** — The quantity of the product or variant associated with the line item. — example: `2`
    - `unit_price` `string` — The unit price of the product or variant associated with the line item. — example: `19.99`
    - `tax_rate` `string` — The tax rate applied to the product or variant associated with the line item. — example: `0.08`
    - `tax_amount` `string` — The total tax amount applied to the product or variant associated with the line item. — example: `1.6`
    - `is_refunded` `boolean` — Whether the line item has been refunded. — example: `false`
    - `refunded_amount` `string` — The amount of the line item that has been refunded. — example: `0`
    - `refunded_quantity` `string` — The quantity of the line item that has been refunded. — example: `0`
    - `sub_total` `string` — The sub total for the product(s) or variant associated with the line item, excluding taxes and discounts. — example: `43.18`
    - `total_amount` `string` — The total amount for the product(s) or variant associated with the line item, including taxes and discounts. — example: `43.18`
    - `discounts` `array of object`
      - `code` `string` — The code used to apply the discount. — example: `SUMMER20`
      - `amount` `string` — The fixed amount of the discount. — example: `5.99`
      - `percentage` `string` — The percentage of the discount. — example: `0.1`
  - `note` `string` — Note for the order. — example: `Special instructions for delivery`
  - `refunds` `array of object`
    - `id` `string` — A unique identifier for an object. — example: `12345`
    - `amount` `string` — The amount of the refund. — example: `100`
    - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
    - `reason` `string` — The reason for the refund. — example: `Customer requested a refund`
    - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
  - `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here.
  - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
  - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `_raw` `object` — Raw response from the integration when raw=true query param is provided

#### 400 — Bad Request

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 401 — Unauthorized

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 402 — Payment Required

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 404 — The specified resource was not found

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### 422 — Unprocessable

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

#### default — Unexpected error

> Standard error response — see [Error Responses](https://developers.apideck.com/errors)

---