GET api/Orders

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Order

Name	Type	Additional information
id	unsigned integer	None.
parent_id	unsigned integer	None.
number	string	None.
order_key	string	None.
created_via	string	None.
version	string	None.
status	string	None.
currency	string	None.
date_created	date	None.
date_created_gmt	date	None.
date_modified	date	None.
date_modified_gmt	date	None.
discount_total	decimal number	None.
discount_tax	decimal number	None.
shipping_total	decimal number	None.
shipping_tax	decimal number	None.
cart_tax	decimal number	None.
total	decimal number	None.
total_tax	decimal number	None.
prices_include_tax	boolean	None.
customer_id	unsigned integer	None.
customer_ip_address	string	None.
customer_user_agent	string	None.
customer_note	string	None.
billing	OrderBilling	None.
shipping	Shipping	None.
payment_method	string	None.
payment_method_title	string	None.
transaction_id	string	None.
cart_hash	string	None.
meta_data	Collection of OrdersMetaData	None.
line_items	Collection of LineItem	None.
tax_lines	Collection of Object	None.
shipping_lines	Collection of Object	None.
fee_lines	Collection of Object	None.
coupon_lines	Collection of Object	None.
refunds	Collection of Object	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "parent_id": 1,
    "number": "sample string 1",
    "order_key": "sample string 2",
    "created_via": "sample string 3",
    "version": "sample string 4",
    "status": "sample string 5",
    "currency": "sample string 6",
    "date_created": "2026-03-07T19:20:18.5364439-08:00",
    "date_created_gmt": "2026-03-07T19:20:18.5364439-08:00",
    "date_modified": "2026-03-07T19:20:18.5364439-08:00",
    "date_modified_gmt": "2026-03-07T19:20:18.5364439-08:00",
    "discount_total": 1.0,
    "discount_tax": 1.0,
    "shipping_total": 1.0,
    "shipping_tax": 1.0,
    "cart_tax": 1.0,
    "total": 1.0,
    "total_tax": 1.0,
    "prices_include_tax": true,
    "customer_id": 1,
    "customer_ip_address": "sample string 7",
    "customer_user_agent": "sample string 8",
    "customer_note": "sample string 9",
    "billing": {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "company": "sample string 3",
      "address_1": "sample string 4",
      "address_2": "sample string 5",
      "city": "sample string 6",
      "state": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9",
      "email": "sample string 10",
      "phone": "sample string 11"
    },
    "shipping": {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "company": "sample string 3",
      "address_1": "sample string 4",
      "address_2": "sample string 5",
      "city": "sample string 6",
      "state": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9"
    },
    "payment_method": "sample string 10",
    "payment_method_title": "sample string 11",
    "transaction_id": "sample string 12",
    "cart_hash": "sample string 13",
    "meta_data": [
      {
        "id": 1,
        "key": "sample string 2",
        "value": "sample string 3"
      },
      {
        "id": 1,
        "key": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "line_items": [
      {
        "id": 1,
        "name": "sample string 2",
        "product_id": 3,
        "variation_id": 4,
        "quantity": 5.1,
        "tax_class": "sample string 6",
        "subtotal": "sample string 7",
        "subtotal_tax": "sample string 8",
        "total": "sample string 9",
        "total_tax": "sample string 10",
        "taxes": [
          {},
          {}
        ],
        "meta_data": [
          {},
          {}
        ],
        "sku": "sample string 11",
        "price": 12.1
      },
      {
        "id": 1,
        "name": "sample string 2",
        "product_id": 3,
        "variation_id": 4,
        "quantity": 5.1,
        "tax_class": "sample string 6",
        "subtotal": "sample string 7",
        "subtotal_tax": "sample string 8",
        "total": "sample string 9",
        "total_tax": "sample string 10",
        "taxes": [
          {},
          {}
        ],
        "meta_data": [
          {},
          {}
        ],
        "sku": "sample string 11",
        "price": 12.1
      }
    ],
    "tax_lines": [
      {},
      {}
    ],
    "shipping_lines": [
      {},
      {}
    ],
    "fee_lines": [
      {},
      {}
    ],
    "coupon_lines": [
      {},
      {}
    ],
    "refunds": [
      {},
      {}
    ]
  },
  {
    "id": 1,
    "parent_id": 1,
    "number": "sample string 1",
    "order_key": "sample string 2",
    "created_via": "sample string 3",
    "version": "sample string 4",
    "status": "sample string 5",
    "currency": "sample string 6",
    "date_created": "2026-03-07T19:20:18.5364439-08:00",
    "date_created_gmt": "2026-03-07T19:20:18.5364439-08:00",
    "date_modified": "2026-03-07T19:20:18.5364439-08:00",
    "date_modified_gmt": "2026-03-07T19:20:18.5364439-08:00",
    "discount_total": 1.0,
    "discount_tax": 1.0,
    "shipping_total": 1.0,
    "shipping_tax": 1.0,
    "cart_tax": 1.0,
    "total": 1.0,
    "total_tax": 1.0,
    "prices_include_tax": true,
    "customer_id": 1,
    "customer_ip_address": "sample string 7",
    "customer_user_agent": "sample string 8",
    "customer_note": "sample string 9",
    "billing": {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "company": "sample string 3",
      "address_1": "sample string 4",
      "address_2": "sample string 5",
      "city": "sample string 6",
      "state": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9",
      "email": "sample string 10",
      "phone": "sample string 11"
    },
    "shipping": {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "company": "sample string 3",
      "address_1": "sample string 4",
      "address_2": "sample string 5",
      "city": "sample string 6",
      "state": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9"
    },
    "payment_method": "sample string 10",
    "payment_method_title": "sample string 11",
    "transaction_id": "sample string 12",
    "cart_hash": "sample string 13",
    "meta_data": [
      {
        "id": 1,
        "key": "sample string 2",
        "value": "sample string 3"
      },
      {
        "id": 1,
        "key": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "line_items": [
      {
        "id": 1,
        "name": "sample string 2",
        "product_id": 3,
        "variation_id": 4,
        "quantity": 5.1,
        "tax_class": "sample string 6",
        "subtotal": "sample string 7",
        "subtotal_tax": "sample string 8",
        "total": "sample string 9",
        "total_tax": "sample string 10",
        "taxes": [
          {},
          {}
        ],
        "meta_data": [
          {},
          {}
        ],
        "sku": "sample string 11",
        "price": 12.1
      },
      {
        "id": 1,
        "name": "sample string 2",
        "product_id": 3,
        "variation_id": 4,
        "quantity": 5.1,
        "tax_class": "sample string 6",
        "subtotal": "sample string 7",
        "subtotal_tax": "sample string 8",
        "total": "sample string 9",
        "total_tax": "sample string 10",
        "taxes": [
          {},
          {}
        ],
        "meta_data": [
          {},
          {}
        ],
        "sku": "sample string 11",
        "price": 12.1
      }
    ],
    "tax_lines": [
      {},
      {}
    ],
    "shipping_lines": [
      {},
      {}
    ],
    "fee_lines": [
      {},
      {}
    ],
    "coupon_lines": [
      {},
      {}
    ],
    "refunds": [
      {},
      {}
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <Order>
    <billing>
      <address_1>sample string 4</address_1>
      <address_2>sample string 5</address_2>
      <city>sample string 6</city>
      <company>sample string 3</company>
      <country>sample string 9</country>
      <email>sample string 10</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <phone>sample string 11</phone>
      <postcode>sample string 8</postcode>
      <state>sample string 7</state>
    </billing>
    <cart_hash>sample string 13</cart_hash>
    <cart_tax>1</cart_tax>
    <coupon_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </coupon_lines>
    <created_via>sample string 3</created_via>
    <currency>sample string 6</currency>
    <customer_id>1</customer_id>
    <customer_ip_address>sample string 7</customer_ip_address>
    <customer_note>sample string 9</customer_note>
    <customer_user_agent>sample string 8</customer_user_agent>
    <date_created>2026-03-07T19:20:18.5364439-08:00</date_created>
    <date_created_gmt>2026-03-07T19:20:18.5364439-08:00</date_created_gmt>
    <date_modified>2026-03-07T19:20:18.5364439-08:00</date_modified>
    <date_modified_gmt>2026-03-07T19:20:18.5364439-08:00</date_modified_gmt>
    <discount_tax>1</discount_tax>
    <discount_total>1</discount_total>
    <fee_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </fee_lines>
    <id>1</id>
    <line_items>
      <LineItem>
        <id>1</id>
        <meta_data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </meta_data>
        <name>sample string 2</name>
        <price>12.1</price>
        <product_id>3</product_id>
        <quantity>5.1</quantity>
        <sku>sample string 11</sku>
        <subtotal>sample string 7</subtotal>
        <subtotal_tax>sample string 8</subtotal_tax>
        <tax_class>sample string 6</tax_class>
        <taxes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </taxes>
        <total>sample string 9</total>
        <total_tax>sample string 10</total_tax>
        <variation_id>4</variation_id>
      </LineItem>
      <LineItem>
        <id>1</id>
        <meta_data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </meta_data>
        <name>sample string 2</name>
        <price>12.1</price>
        <product_id>3</product_id>
        <quantity>5.1</quantity>
        <sku>sample string 11</sku>
        <subtotal>sample string 7</subtotal>
        <subtotal_tax>sample string 8</subtotal_tax>
        <tax_class>sample string 6</tax_class>
        <taxes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </taxes>
        <total>sample string 9</total>
        <total_tax>sample string 10</total_tax>
        <variation_id>4</variation_id>
      </LineItem>
    </line_items>
    <meta_data>
      <OrdersMetaData>
        <id>1</id>
        <key>sample string 2</key>
        <value>sample string 3</value>
      </OrdersMetaData>
      <OrdersMetaData>
        <id>1</id>
        <key>sample string 2</key>
        <value>sample string 3</value>
      </OrdersMetaData>
    </meta_data>
    <number>sample string 1</number>
    <order_key>sample string 2</order_key>
    <parent_id>1</parent_id>
    <payment_method>sample string 10</payment_method>
    <payment_method_title>sample string 11</payment_method_title>
    <prices_include_tax>true</prices_include_tax>
    <refunds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </refunds>
    <shipping>
      <address_1>sample string 4</address_1>
      <address_2>sample string 5</address_2>
      <city>sample string 6</city>
      <company>sample string 3</company>
      <country>sample string 9</country>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <postcode>sample string 8</postcode>
      <state>sample string 7</state>
    </shipping>
    <shipping_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </shipping_lines>
    <shipping_tax>1</shipping_tax>
    <shipping_total>1</shipping_total>
    <status>sample string 5</status>
    <tax_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </tax_lines>
    <total>1</total>
    <total_tax>1</total_tax>
    <transaction_id>sample string 12</transaction_id>
    <version>sample string 4</version>
  </Order>
  <Order>
    <billing>
      <address_1>sample string 4</address_1>
      <address_2>sample string 5</address_2>
      <city>sample string 6</city>
      <company>sample string 3</company>
      <country>sample string 9</country>
      <email>sample string 10</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <phone>sample string 11</phone>
      <postcode>sample string 8</postcode>
      <state>sample string 7</state>
    </billing>
    <cart_hash>sample string 13</cart_hash>
    <cart_tax>1</cart_tax>
    <coupon_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </coupon_lines>
    <created_via>sample string 3</created_via>
    <currency>sample string 6</currency>
    <customer_id>1</customer_id>
    <customer_ip_address>sample string 7</customer_ip_address>
    <customer_note>sample string 9</customer_note>
    <customer_user_agent>sample string 8</customer_user_agent>
    <date_created>2026-03-07T19:20:18.5364439-08:00</date_created>
    <date_created_gmt>2026-03-07T19:20:18.5364439-08:00</date_created_gmt>
    <date_modified>2026-03-07T19:20:18.5364439-08:00</date_modified>
    <date_modified_gmt>2026-03-07T19:20:18.5364439-08:00</date_modified_gmt>
    <discount_tax>1</discount_tax>
    <discount_total>1</discount_total>
    <fee_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </fee_lines>
    <id>1</id>
    <line_items>
      <LineItem>
        <id>1</id>
        <meta_data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </meta_data>
        <name>sample string 2</name>
        <price>12.1</price>
        <product_id>3</product_id>
        <quantity>5.1</quantity>
        <sku>sample string 11</sku>
        <subtotal>sample string 7</subtotal>
        <subtotal_tax>sample string 8</subtotal_tax>
        <tax_class>sample string 6</tax_class>
        <taxes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </taxes>
        <total>sample string 9</total>
        <total_tax>sample string 10</total_tax>
        <variation_id>4</variation_id>
      </LineItem>
      <LineItem>
        <id>1</id>
        <meta_data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </meta_data>
        <name>sample string 2</name>
        <price>12.1</price>
        <product_id>3</product_id>
        <quantity>5.1</quantity>
        <sku>sample string 11</sku>
        <subtotal>sample string 7</subtotal>
        <subtotal_tax>sample string 8</subtotal_tax>
        <tax_class>sample string 6</tax_class>
        <taxes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </taxes>
        <total>sample string 9</total>
        <total_tax>sample string 10</total_tax>
        <variation_id>4</variation_id>
      </LineItem>
    </line_items>
    <meta_data>
      <OrdersMetaData>
        <id>1</id>
        <key>sample string 2</key>
        <value>sample string 3</value>
      </OrdersMetaData>
      <OrdersMetaData>
        <id>1</id>
        <key>sample string 2</key>
        <value>sample string 3</value>
      </OrdersMetaData>
    </meta_data>
    <number>sample string 1</number>
    <order_key>sample string 2</order_key>
    <parent_id>1</parent_id>
    <payment_method>sample string 10</payment_method>
    <payment_method_title>sample string 11</payment_method_title>
    <prices_include_tax>true</prices_include_tax>
    <refunds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </refunds>
    <shipping>
      <address_1>sample string 4</address_1>
      <address_2>sample string 5</address_2>
      <city>sample string 6</city>
      <company>sample string 3</company>
      <country>sample string 9</country>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <postcode>sample string 8</postcode>
      <state>sample string 7</state>
    </shipping>
    <shipping_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </shipping_lines>
    <shipping_tax>1</shipping_tax>
    <shipping_total>1</shipping_total>
    <status>sample string 5</status>
    <tax_lines xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </tax_lines>
    <total>1</total>
    <total_tax>1</total_tax>
    <transaction_id>sample string 12</transaction_id>
    <version>sample string 4</version>
  </Order>
</ArrayOfOrder>