Shopify API – Order

top

Receive a single Order

GET /admin/orders/#{id}.xml

Get an XML representation of a single order

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <closed-at type="datetime" nil="true"></closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>bob.norman@hostmail.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note nil="true"></note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">199.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">199.00</total-line-items-price>
  <total-price type="decimal">210.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2008-01-10T11:00:00-05:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
  </note-attributes>
</order>
top

Receive a list of all Orders

Available URL Query parameters:

  • limit — Amount of results (default: 50) (maximum: 250)
  • page — Page to show (default: 1)
  • created_at_min — Show orders created after date (format: 2008-01-01 03:00)
  • created_at_max — Show orders created before date (format: 2008-01-01 03:00)
  • updated_at_min — Show orders last updated after date (format: 2008-01-01 03:00)
  • updated_at_max — Show orders last updated before date (format: 2008-01-01 03:00)
  • status
    • open - All open orders (default)
    • closed - Show only closed orders
    • any - Any order status
  • financial_status
    • authorized - Show only authorized orders
    • pending - Show only pending orders
    • paid - Show only paid orders
    • abandoned - Show only abandoned orders
    • any - Show all authorized, pending, and paid orders (default)
  • fulfillment_status
    • shipped - Show orders that have been shipped
    • partial - Show partially shipped orders
    • unshipped - Show orders that have not yet been shipped
    • any - Show orders with any fulfillment_status. (default)
GET /admin/orders.xml

List all orders

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<orders type="array">
  <order>
    <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
    <closed-at type="datetime" nil="true"></closed-at>
    <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
    <currency>USD</currency>
    <email>bob.norman@hostmail.com</email>
    <financial-status>authorized</financial-status>
    <fulfillment-status nil="true"></fulfillment-status>
    <gateway>authorized_net</gateway>
    <id type="integer">1524531292</id>
    <landing-site>http://www.example.com?source=abc</landing-site>
    <name>#1001</name>
    <note nil="true"></note>
    <number type="integer">1</number>
    <referring-site>http://www.otherexample.com</referring-site>
    <subtotal-price type="decimal">199.00</subtotal-price>
    <taxes-included type="boolean">false</taxes-included>
    <token>b1946ac92492d2347c6235b4d2611184</token>
    <total-discounts type="decimal">0.00</total-discounts>
    <total-line-items-price type="decimal">199.00</total-line-items-price>
    <total-price type="decimal">210.94</total-price>
    <total-tax type="decimal">11.94</total-tax>
    <total-weight type="integer">0</total-weight>
    <updated-at type="datetime">2008-01-10T11:00:00-05:00</updated-at>
    <browser-ip nil="true"></browser-ip>
    <landing-site-ref>abc</landing-site-ref>
    <billing-address>
      <address1>Chestnut Street 92</address1>
      <address2></address2>
      <city>Louisville</city>
      <company nil="true"></company>
      <country>United States</country>
      <first-name>Bob</first-name>
      <last-name>Norman</last-name>
      <phone>555-625-1199</phone>
      <province>Kentucky</province>
      <zip>40202</zip>
      <name>Bob Norman</name>
      <country-code>US</country-code>
      <province-code>KY</province-code>
    </billing-address>
    <shipping-address>
      <address1>Chestnut Street 92</address1>
      <address2></address2>
      <city>Louisville</city>
      <company nil="true"></company>
      <country>United States</country>
      <first-name>Bob</first-name>
      <last-name>Norman</last-name>
      <phone>555-625-1199</phone>
      <province>Kentucky</province>
      <zip>40202</zip>
      <name>Bob Norman</name>
      <country-code>US</country-code>
      <province-code>KY</province-code>
    </shipping-address>
    <line-items type="array">
      <line-item>
        <fulfillment-service>manual</fulfillment-service>
        <fulfillment-status nil="true"></fulfillment-status>
        <grams type="integer">200</grams>
        <id type="integer">703073503</id>
        <price type="decimal">199.00</price>
        <product-id type="integer">1706652214</product-id>
        <quantity type="integer">1</quantity>
        <sku>IPOD2008BLACK</sku>
        <title>IPod Nano - 8gb</title>
        <variant-id type="integer">457924702</variant-id>
        <variant-title>black</variant-title>
        <vendor nil="true"></vendor>
        <name>IPod Nano - 8gb - black</name>
      </line-item>
      <line-item>
        <fulfillment-service>manual</fulfillment-service>
        <fulfillment-status nil="true"></fulfillment-status>
        <grams type="integer">200</grams>
        <id type="integer">1539898872</id>
        <price type="decimal">199.00</price>
        <product-id type="integer">1706652214</product-id>
        <quantity type="integer">1</quantity>
        <sku>IPOD2008GREEN</sku>
        <title>IPod Nano - 8gb</title>
        <variant-id type="integer">1112814679</variant-id>
        <variant-title>green</variant-title>
        <vendor nil="true"></vendor>
        <name>IPod Nano - 8gb - green</name>
      </line-item>
    </line-items>
    <shipping-lines type="array">
      <shipping-line>
        <code>Free Shipping</code>
        <price type="decimal">0.00</price>
        <title>Free Shipping</title>
      </shipping-line>
    </shipping-lines>
    <tax-lines type="array">
      <tax-line>
        <price type="decimal">11.94</price>
        <rate type="float">0.06</rate>
        <title>State Tax</title>
      </tax-line>
    </tax-lines>
    <payment-details>
      <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
      <credit-card-company>Visa</credit-card-company>
    </payment-details>
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
    <note-attributes type="array">
    </note-attributes>
  </order>
</orders>
GET /admin/orders.xml?updated_at_min=2005-07-31 15:57:11 EDT -04:00

List orders last updated after 2005-07-31 15:57:11 in the EDT timezone

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<orders type="array">
  <order>
    <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
    <closed-at type="datetime" nil="true"></closed-at>
    <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
    <currency>USD</currency>
    <email>bob.norman@hostmail.com</email>
    <financial-status>authorized</financial-status>
    <fulfillment-status nil="true"></fulfillment-status>
    <gateway>authorized_net</gateway>
    <id type="integer">1524531292</id>
    <landing-site>http://www.example.com?source=abc</landing-site>
    <name>#1001</name>
    <note nil="true"></note>
    <number type="integer">1</number>
    <referring-site>http://www.otherexample.com</referring-site>
    <subtotal-price type="decimal">199.00</subtotal-price>
    <taxes-included type="boolean">false</taxes-included>
    <token>b1946ac92492d2347c6235b4d2611184</token>
    <total-discounts type="decimal">0.00</total-discounts>
    <total-line-items-price type="decimal">199.00</total-line-items-price>
    <total-price type="decimal">210.94</total-price>
    <total-tax type="decimal">11.94</total-tax>
    <total-weight type="integer">0</total-weight>
    <updated-at type="datetime">2008-01-10T11:00:00-05:00</updated-at>
    <browser-ip nil="true"></browser-ip>
    <landing-site-ref>abc</landing-site-ref>
    <billing-address>
      <address1>Chestnut Street 92</address1>
      <address2></address2>
      <city>Louisville</city>
      <company nil="true"></company>
      <country>United States</country>
      <first-name>Bob</first-name>
      <last-name>Norman</last-name>
      <phone>555-625-1199</phone>
      <province>Kentucky</province>
      <zip>40202</zip>
      <name>Bob Norman</name>
      <country-code>US</country-code>
      <province-code>KY</province-code>
    </billing-address>
    <shipping-address>
      <address1>Chestnut Street 92</address1>
      <address2></address2>
      <city>Louisville</city>
      <company nil="true"></company>
      <country>United States</country>
      <first-name>Bob</first-name>
      <last-name>Norman</last-name>
      <phone>555-625-1199</phone>
      <province>Kentucky</province>
      <zip>40202</zip>
      <name>Bob Norman</name>
      <country-code>US</country-code>
      <province-code>KY</province-code>
    </shipping-address>
    <line-items type="array">
      <line-item>
        <fulfillment-service>manual</fulfillment-service>
        <fulfillment-status nil="true"></fulfillment-status>
        <grams type="integer">200</grams>
        <id type="integer">703073503</id>
        <price type="decimal">199.00</price>
        <product-id type="integer">1706652214</product-id>
        <quantity type="integer">1</quantity>
        <sku>IPOD2008BLACK</sku>
        <title>IPod Nano - 8gb</title>
        <variant-id type="integer">457924702</variant-id>
        <variant-title>black</variant-title>
        <vendor nil="true"></vendor>
        <name>IPod Nano - 8gb - black</name>
      </line-item>
      <line-item>
        <fulfillment-service>manual</fulfillment-service>
        <fulfillment-status nil="true"></fulfillment-status>
        <grams type="integer">200</grams>
        <id type="integer">1539898872</id>
        <price type="decimal">199.00</price>
        <product-id type="integer">1706652214</product-id>
        <quantity type="integer">1</quantity>
        <sku>IPOD2008GREEN</sku>
        <title>IPod Nano - 8gb</title>
        <variant-id type="integer">1112814679</variant-id>
        <variant-title>green</variant-title>
        <vendor nil="true"></vendor>
        <name>IPod Nano - 8gb - green</name>
      </line-item>
    </line-items>
    <shipping-lines type="array">
      <shipping-line>
        <code>Free Shipping</code>
        <price type="decimal">0.00</price>
        <title>Free Shipping</title>
      </shipping-line>
    </shipping-lines>
    <tax-lines type="array">
      <tax-line>
        <price type="decimal">11.94</price>
        <rate type="float">0.06</rate>
        <title>State Tax</title>
      </tax-line>
    </tax-lines>
    <payment-details>
      <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
      <credit-card-company>Visa</credit-card-company>
    </payment-details>
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
    <note-attributes type="array">
    </note-attributes>
  </order>
</orders>
GET /admin/orders.xml?financial_status=authorized

List orders which are authorized and ready to be captured.

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<orders type="array">
  <order>
    <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
    <closed-at type="datetime" nil="true"></closed-at>
    <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
    <currency>USD</currency>
    <email>bob.norman@hostmail.com</email>
    <financial-status>authorized</financial-status>
    <fulfillment-status nil="true"></fulfillment-status>
    <gateway>authorized_net</gateway>
    <id type="integer">1524531292</id>
    <landing-site>http://www.example.com?source=abc</landing-site>
    <name>#1001</name>
    <note nil="true"></note>
    <number type="integer">1</number>
    <referring-site>http://www.otherexample.com</referring-site>
    <subtotal-price type="decimal">199.00</subtotal-price>
    <taxes-included type="boolean">false</taxes-included>
    <token>b1946ac92492d2347c6235b4d2611184</token>
    <total-discounts type="decimal">0.00</total-discounts>
    <total-line-items-price type="decimal">199.00</total-line-items-price>
    <total-price type="decimal">210.94</total-price>
    <total-tax type="decimal">11.94</total-tax>
    <total-weight type="integer">0</total-weight>
    <updated-at type="datetime">2008-01-10T11:00:00-05:00</updated-at>
    <browser-ip nil="true"></browser-ip>
    <landing-site-ref>abc</landing-site-ref>
    <billing-address>
      <address1>Chestnut Street 92</address1>
      <address2></address2>
      <city>Louisville</city>
      <company nil="true"></company>
      <country>United States</country>
      <first-name>Bob</first-name>
      <last-name>Norman</last-name>
      <phone>555-625-1199</phone>
      <province>Kentucky</province>
      <zip>40202</zip>
      <name>Bob Norman</name>
      <country-code>US</country-code>
      <province-code>KY</province-code>
    </billing-address>
    <shipping-address>
      <address1>Chestnut Street 92</address1>
      <address2></address2>
      <city>Louisville</city>
      <company nil="true"></company>
      <country>United States</country>
      <first-name>Bob</first-name>
      <last-name>Norman</last-name>
      <phone>555-625-1199</phone>
      <province>Kentucky</province>
      <zip>40202</zip>
      <name>Bob Norman</name>
      <country-code>US</country-code>
      <province-code>KY</province-code>
    </shipping-address>
    <line-items type="array">
      <line-item>
        <fulfillment-service>manual</fulfillment-service>
        <fulfillment-status nil="true"></fulfillment-status>
        <grams type="integer">200</grams>
        <id type="integer">703073503</id>
        <price type="decimal">199.00</price>
        <product-id type="integer">1706652214</product-id>
        <quantity type="integer">1</quantity>
        <sku>IPOD2008BLACK</sku>
        <title>IPod Nano - 8gb</title>
        <variant-id type="integer">457924702</variant-id>
        <variant-title>black</variant-title>
        <vendor nil="true"></vendor>
        <name>IPod Nano - 8gb - black</name>
      </line-item>
      <line-item>
        <fulfillment-service>manual</fulfillment-service>
        <fulfillment-status nil="true"></fulfillment-status>
        <grams type="integer">200</grams>
        <id type="integer">1539898872</id>
        <price type="decimal">199.00</price>
        <product-id type="integer">1706652214</product-id>
        <quantity type="integer">1</quantity>
        <sku>IPOD2008GREEN</sku>
        <title>IPod Nano - 8gb</title>
        <variant-id type="integer">1112814679</variant-id>
        <variant-title>green</variant-title>
        <vendor nil="true"></vendor>
        <name>IPod Nano - 8gb - green</name>
      </line-item>
    </line-items>
    <shipping-lines type="array">
      <shipping-line>
        <code>Free Shipping</code>
        <price type="decimal">0.00</price>
        <title>Free Shipping</title>
      </shipping-line>
    </shipping-lines>
    <tax-lines type="array">
      <tax-line>
        <price type="decimal">11.94</price>
        <rate type="float">0.06</rate>
        <title>State Tax</title>
      </tax-line>
    </tax-lines>
    <payment-details>
      <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
      <credit-card-company>Visa</credit-card-company>
    </payment-details>
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
    <note-attributes type="array">
    </note-attributes>
  </order>
</orders>
top

Receive a count of all Orders

Available URL Query parameters:

  • created_at_min — Count orders created after date (format: 2008-01-01 03:00)
  • created_at_max — Count orders created before date (format: 2008-01-01 03:00)
  • updated_at_min — Count orders last updated after date (format: 2008-01-01 03:00)
  • updated_at_max — Count orders last updated before date (format: 2008-01-01 03:00)
  • status
    • open - Open orders (default)
    • closed - Only closed orders
    • any - Any order status
  • financial_status
    • authorized - Only authorized orders
    • pending - Only pending orders
    • paid - Only paid orders
    • abandoned - Only abandoned orders
    • any - All authorized, pending, and paid orders (default)
  • fulfillment_status
    • shipped - Orders that have been shipped
    • partial - Partially shipped orders
    • unshipped - Orders that have not yet been shipped
    • any - Orders with any fulfillment_status. (default)
GET /admin/orders/count.xml

Count all orders

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<count type="integer">1</count>
GET /admin/orders/count.xml?financial_status=authorized

Count orders which are authorized and ready to be captured.

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<count type="integer">1</count>
top

Close an Order

POST /admin/orders/#{id}/close.xml

Close a processed order.

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <name>#1001</name>
  <number type="integer">1</number>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <title>State Tax</title>
      <rate type="float">0.06</rate>
    </tax-line>
  </tax-lines>
  <line-items type="array">
    <line-item>
      <price type="decimal">199.0</price>
      <name>IPod Nano - 8gb - black</name>
      <title>IPod Nano - 8gb</title>
      <quantity type="integer">1</quantity>
      <product-id type="integer">1706652214</product-id>
      <id type="integer">703073503</id>
      <grams type="integer">200</grams>
      <sku>IPOD2008BLACK</sku>
      <vendor nil="true"></vendor>
      <fulfillment-status nil="true"></fulfillment-status>
      <variant-title>black</variant-title>
      <fulfillment-service>manual</fulfillment-service>
      <variant-id type="integer">457924702</variant-id>
    </line-item>
    <line-item>
      <price type="decimal">199.0</price>
      <name>IPod Nano - 8gb - green</name>
      <title>IPod Nano - 8gb</title>
      <quantity type="integer">1</quantity>
      <product-id type="integer">1706652214</product-id>
      <id type="integer">1539898872</id>
      <grams type="integer">200</grams>
      <sku>IPOD2008GREEN</sku>
      <vendor nil="true"></vendor>
      <fulfillment-status nil="true"></fulfillment-status>
      <variant-title>green</variant-title>
      <fulfillment-service>manual</fulfillment-service>
      <variant-id type="integer">1112814679</variant-id>
    </line-item>
  </line-items>
  <created-at type="datetime">2008-01-10T16:00:00Z</created-at>
  <browser-ip nil="true"></browser-ip>
  <total-discounts type="decimal">0.0</total-discounts>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <total-price type="decimal">210.94</total-price>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <updated-at type="datetime">2008-01-10T16:00:00Z</updated-at>
  <landing-site-ref>abc</landing-site-ref>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <taxes-included type="boolean">false</taxes-included>
  <id type="integer">1524531292</id>
  <shipping-line>
    <price type="decimal">0.0</price>
    <title>Free Shipping</title>
    <code>Free Shipping</code>
  </shipping-line>
  <shipping-lines type="array">
    <shipping-line>
      <price type="decimal">0.0</price>
      <title>Free Shipping</title>
      <code>Free Shipping</code>
    </shipping-line>
  </shipping-lines>
  <shipping-address>
    <company nil="true"></company>
    <name>Bob Norman</name>
    <city>Louisville</city>
    <address1>Chestnut Street 92</address1>
    <zip>40202</zip>
    <address2 nil="true"></address2>
    <country-code>US</country-code>
    <country>United States</country>
    <province-code>KY</province-code>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <first-name>Bob</first-name>
  </shipping-address>
  <total-line-items-price type="decimal">199.0</total-line-items-price>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">199.0</subtotal-price>
  <billing-address>
    <company nil="true"></company>
    <name>Bob Norman</name>
    <city>Louisville</city>
    <address1>Chestnut Street 92</address1>
    <zip>40202</zip>
    <address2 nil="true"></address2>
    <country-code>US</country-code>
    <country>United States</country>
    <province-code>KY</province-code>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <first-name>Bob</first-name>
  </billing-address>
  <note nil="true"></note>
  <fulfillment-status nil="true"></fulfillment-status>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <note-attributes type="array"/>
  <gateway>authorized_net</gateway>
  <closed-at nil="true"></closed-at>
  <financial-status>authorized</financial-status>
  <currency>USD</currency>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <email>bob.norman@hostmail.com</email>
</order>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <closed-at type="datetime">2009-10-20T07:26:15-04:00</closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>bob.norman@hostmail.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note nil="true"></note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">398.00</total-line-items-price>
  <total-price type="decimal">409.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2009-10-20T07:26:16-04:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
  </note-attributes>
</order>
top

Re-open a closed Order

POST /admin/orders/#{id}/open.xml

Re-opening a closed Order:

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <name>#1001</name>
  <number type="integer">1</number>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <title>State Tax</title>
      <rate type="float">0.06</rate>
    </tax-line>
  </tax-lines>
  <line-items type="array">
    <line-item>
      <price type="decimal">199.0</price>
      <name>IPod Nano - 8gb - black</name>
      <title>IPod Nano - 8gb</title>
      <quantity type="integer">1</quantity>
      <product-id type="integer">1706652214</product-id>
      <id type="integer">703073503</id>
      <grams type="integer">200</grams>
      <sku>IPOD2008BLACK</sku>
      <vendor nil="true"></vendor>
      <fulfillment-status nil="true"></fulfillment-status>
      <variant-title>black</variant-title>
      <fulfillment-service>manual</fulfillment-service>
      <variant-id type="integer">457924702</variant-id>
    </line-item>
    <line-item>
      <price type="decimal">199.0</price>
      <name>IPod Nano - 8gb - green</name>
      <title>IPod Nano - 8gb</title>
      <quantity type="integer">1</quantity>
      <product-id type="integer">1706652214</product-id>
      <id type="integer">1539898872</id>
      <grams type="integer">200</grams>
      <sku>IPOD2008GREEN</sku>
      <vendor nil="true"></vendor>
      <fulfillment-status nil="true"></fulfillment-status>
      <variant-title>green</variant-title>
      <fulfillment-service>manual</fulfillment-service>
      <variant-id type="integer">1112814679</variant-id>
    </line-item>
  </line-items>
  <created-at type="datetime">2008-01-10T16:00:00Z</created-at>
  <browser-ip nil="true"></browser-ip>
  <total-discounts type="decimal">0.0</total-discounts>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <total-price type="decimal">409.94</total-price>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <updated-at type="datetime">2009-10-20T11:26:26Z</updated-at>
  <landing-site-ref>abc</landing-site-ref>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <taxes-included type="boolean">false</taxes-included>
  <id type="integer">1524531292</id>
  <shipping-line>
    <price type="decimal">0.0</price>
    <title>Free Shipping</title>
    <code>Free Shipping</code>
  </shipping-line>
  <shipping-lines type="array">
    <shipping-line>
      <price type="decimal">0.0</price>
      <title>Free Shipping</title>
      <code>Free Shipping</code>
    </shipping-line>
  </shipping-lines>
  <shipping-address>
    <company nil="true"></company>
    <name>Bob Norman</name>
    <city>Louisville</city>
    <address1>Chestnut Street 92</address1>
    <zip>40202</zip>
    <address2 nil="true"></address2>
    <country-code>US</country-code>
    <country>United States</country>
    <province-code>KY</province-code>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <first-name>Bob</first-name>
  </shipping-address>
  <total-line-items-price type="decimal">398.0</total-line-items-price>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.0</subtotal-price>
  <billing-address>
    <company nil="true"></company>
    <name>Bob Norman</name>
    <city>Louisville</city>
    <address1>Chestnut Street 92</address1>
    <zip>40202</zip>
    <address2 nil="true"></address2>
    <country-code>US</country-code>
    <country>United States</country>
    <province-code>KY</province-code>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <first-name>Bob</first-name>
  </billing-address>
  <note nil="true"></note>
  <fulfillment-status nil="true"></fulfillment-status>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <note-attributes type="array"/>
  <gateway>authorized_net</gateway>
  <closed-at type="datetime">2009-10-20T11:26:26Z</closed-at>
  <financial-status>authorized</financial-status>
  <currency>USD</currency>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <email>bob.norman@hostmail.com</email>
</order>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <closed-at type="datetime" nil="true"></closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>bob.norman@hostmail.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note nil="true"></note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">398.00</total-line-items-price>
  <total-price type="decimal">409.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2009-10-20T07:26:26-04:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
  </note-attributes>
</order>
top

Change an Order’s note, email, and buyer-accepts-marketing state (the only attributes modifiable through the API)

PUT /admin/orders/#{id}.xml

Add Note to order.

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <id type="integer">1524531292</id>
  <note>Customer contacted us about a custom engraving on this iPod</note>
</order>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <closed-at type="datetime" nil="true"></closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>bob.norman@hostmail.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note>Customer contacted us about a custom engraving on this iPod</note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">398.00</total-line-items-price>
  <total-price type="decimal">409.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2009-10-20T07:26:30-04:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
  </note-attributes>
</order>
PUT /admin/orders/#{id}.xml

Change an order so that its buyer accepts marketing

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <id type="integer">1524531292</id>
  <buyer-accepts-marketing type="boolean">true</buyer-accepts-marketing>
</order>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">true</buyer-accepts-marketing>
  <closed-at type="datetime" nil="true"></closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>bob.norman@hostmail.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note nil="true"></note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">398.00</total-line-items-price>
  <total-price type="decimal">409.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2009-10-20T07:26:32-04:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
  </note-attributes>
</order>
PUT /admin/orders/#{id}.xml

Change an order’s email

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <id type="integer">1524531292</id>
  <email>a-different@email.com</email>
</order>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <closed-at type="datetime" nil="true"></closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>a-different@email.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note nil="true"></note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">398.00</total-line-items-price>
  <total-price type="decimal">409.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2009-10-20T07:26:34-04:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
  </note-attributes>
</order>
PUT /admin/orders/#{id}.xml

Set Note Attributes on an order

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <id type="integer">1524531292</id>
  <note-attributes type="array">
    <note-attribute>
      <name>colour</name>
      <value>red</value>
    </note-attribute>
  </note-attributes>
</order>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <buyer-accepts-marketing type="boolean">false</buyer-accepts-marketing>
  <closed-at type="datetime" nil="true"></closed-at>
  <created-at type="datetime">2008-01-10T11:00:00-05:00</created-at>
  <currency>USD</currency>
  <email>bob.norman@hostmail.com</email>
  <financial-status>authorized</financial-status>
  <fulfillment-status nil="true"></fulfillment-status>
  <gateway>authorized_net</gateway>
  <id type="integer">1524531292</id>
  <landing-site>http://www.example.com?source=abc</landing-site>
  <name>#1001</name>
  <note nil="true"></note>
  <number type="integer">1</number>
  <referring-site>http://www.otherexample.com</referring-site>
  <subtotal-price type="decimal">398.00</subtotal-price>
  <taxes-included type="boolean">false</taxes-included>
  <token>b1946ac92492d2347c6235b4d2611184</token>
  <total-discounts type="decimal">0.00</total-discounts>
  <total-line-items-price type="decimal">398.00</total-line-items-price>
  <total-price type="decimal">409.94</total-price>
  <total-tax type="decimal">11.94</total-tax>
  <total-weight type="integer">0</total-weight>
  <updated-at type="datetime">2009-10-20T07:26:37-04:00</updated-at>
  <browser-ip nil="true"></browser-ip>
  <landing-site-ref>abc</landing-site-ref>
  <billing-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </billing-address>
  <shipping-address>
    <address1>Chestnut Street 92</address1>
    <address2></address2>
    <city>Louisville</city>
    <company nil="true"></company>
    <country>United States</country>
    <first-name>Bob</first-name>
    <last-name>Norman</last-name>
    <phone>555-625-1199</phone>
    <province>Kentucky</province>
    <zip>40202</zip>
    <name>Bob Norman</name>
    <country-code>US</country-code>
    <province-code>KY</province-code>
  </shipping-address>
  <line-items type="array">
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">703073503</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008BLACK</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">457924702</variant-id>
      <variant-title>black</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - black</name>
    </line-item>
    <line-item>
      <fulfillment-service>manual</fulfillment-service>
      <fulfillment-status nil="true"></fulfillment-status>
      <grams type="integer">200</grams>
      <id type="integer">1539898872</id>
      <price type="decimal">199.00</price>
      <product-id type="integer">1706652214</product-id>
      <quantity type="integer">1</quantity>
      <sku>IPOD2008GREEN</sku>
      <title>IPod Nano - 8gb</title>
      <variant-id type="integer">1112814679</variant-id>
      <variant-title>green</variant-title>
      <vendor nil="true"></vendor>
      <name>IPod Nano - 8gb - green</name>
    </line-item>
  </line-items>
  <shipping-lines type="array">
    <shipping-line>
      <code>Free Shipping</code>
      <price type="decimal">0.00</price>
      <title>Free Shipping</title>
    </shipping-line>
  </shipping-lines>
  <tax-lines type="array">
    <tax-line>
      <price type="decimal">11.94</price>
      <rate type="float">0.06</rate>
      <title>State Tax</title>
    </tax-line>
  </tax-lines>
  <payment-details>
    <credit-card-number>XXXX-XXXX-XXXX-4242</credit-card-number>
    <credit-card-company>Visa</credit-card-company>
  </payment-details>
  <shipping-line>
    <code>Free Shipping</code>
    <price type="decimal">0.00</price>
    <title>Free Shipping</title>
  </shipping-line>
  <note-attributes type="array">
    <note-attribute>
      <name>colour</name>
      <value>red</value>
    </note-attribute>
  </note-attributes>
</order>
top

Remove a Order from the database

DELETE /admin/orders/#{id}.xml

Delete Order on this URL.

Response

           
HTTP/1.1 200 OK
Last updated at Oct 2009 Oct:10 AM.