Order

An order is a customer's completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time s/he provides an email address, billing address and payment information.

#

You should note that orders can be created through the API, but no payment information will be collected, and no transaction performed. You can mark the order with any payment status. Orders cannot be created through the store's admin panel. The only way to create an order and accept payments via haravan is by entering the storefront, adding items to cart, and completing checkout.

You should also note that you can change only a few of an order's attributes using the API. You cannot change the items or the quantities in an order.

Orders that have been created via the haravan POS will not necessarily have customer information attached to them.

What can you do with Order?

The haravan API lets you do the following with the Order resource. More detailed versions of these general actions may be available:

Order Properties

billing_address
{ "address1" : "123 Amoebobacterieae St" } { "address2" : "" } { "city" : "Ottawa" } { "company" : "null" } {"country" : "US" } { "first_name" : "null" } { "id" : 207119551 } { "last_name" : "null" } { "phone" : "(555)555-5555" } { "province" : "KY" } { "zip" : "40202" } { "name" : "null" } { "province_code" : "null" } {"country_code" : "null" } { "default" : true }
browser_ip
{ "browser_ip" : "null" }

The IP address of the browser used by the customer when placing the order.

buyer_accepts_marketing
{ "buyer_accepts_marketing" : false }

Indicates whether or not the person who placed the order would like to receive email updates from the shop. This is set when checking the "I want to receive occasional emails about new products, promotions and other news" checkbox during checkout. Valid values are "true" and "false."

cancel_reason
{ "cancel_reason" : "null" }

The reason why the order was cancelled. If the order was not cancelled, this value is "null." If the order was cancelled, the value will be one of the following:

  • customer: The customer changed or cancelled the order.
  • fraud: The order was fraudulent.
  • inventory: Items in the order were not in inventory.
  • other: The order was cancelled for a reason not in the list above.


cancelled_at
{ "cancelled_at" : "null" }

The date and time when the order was cancelled. If the order was cancelled, the API returns this value in ISO 8601 format. If the order was not cancelled, this value is "null."

cart_token
{ "cart_token" : "68778783ad298f1c80c3bafcddeea" }

Unique identifier for a particular cart that is attached to a particular order.

client_details
{ "accept_language" : "null" }
{ "browser_height" : "null" }
{ "browser_ip" : "0.0.0.0" }
{ "browser_width" : "null" }
{ "session_hash" : "null" }
{ "user_agent" : "null" }


An object containing information about the client:

  • accept_language:
  • browser_height: The browser screen height in pixels, if available.
  • browser_ip: The browser IP address.
  • browser_width: The browser screen width in pixels, if available.
  • session_hash: A hash of the session.
  • user_agent


closed_at
{ "closed_at" : "null" }

The date and time when the order was closed. If the order was closed, the API returns this value in ISO 8601 format. If the order was not closed, this value is null.

created_at
{ "created_at" : "2008-01-10T11:00:00-05:00" }

The date and time when the order was created in haravan, in ISO 8601 format. This value will be identical to :processed_at until April 2015

currency
{ "currency" : "USD" }

The three letter code (ISO 4217) for the currency used for the payment.

customer
{ "accepts_marketing" : false }
{ "created_at" : "2012-03-13T16:09:55-04:00" }
{ "email" : "bob.norman@hostmail.com" }
{ "first_name" : "Bob" }
{ "id" : 207119551 }
{ "last_name" : "Norman" }
{ "note" : "null" }>
{ "last_name" : "null" }
{ "orders_count" : "0" }
{ "state" : "null" }
{ "total_spent" : "0.00" }
{ "updated_at" : "2012-03-13T16:09:55-04:00" }
{ "tags" : "tagcity" }


An object containing information about the customer. It is important to note that the order may not have a customer and consumers should not depend on the existance of a customer object. This value may be null if the order was created through haravan POS

Customer objects may contain the following fields:
  • accepts_marketing: Indicates whether or not the customer would like to receive email updates from the shop. Valid values are true and false.
  • created_at: The date and time when the customer record was created.
  • email: The customer's email address.
  • first_name: The customer's first name.
  • order_id: A unique numeric identifier for the customer.
  • last_name: The customer's last name.
  • note: Extra information about the customer
  • orders_count: The number of orders placed by this customer to a shop. Pulls the current information
  • state:
  • total_spent:
  • updated_at: The date and time when the customer record was last updated.
  • tags: Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. For example, if an order has three tags: tag1, tag2, tag3.


discount_codes
{ "discount_codes" : "[]" }


Applicable discount codes that can be applied to the order. If no codes exist the value will default to blank.

A Discount code will include the following fields:
  • amount: The amount of the discount.
  • code: The discount code.
  • type: The type of discount. Can be one of: "percentage", "shipping", "fixed_amount" (default).


email
{ "email" : "bob.norman@hostmail.com" }

The customer's email address. Is required when a billing address is present.

financial_status
{ "financial_status" : "authorized" }


  • pending: The finances are pending.
  • authorized: The finances have been authorized.
  • partially_paid: The finances have been partially paid.
  • paid: The finances have been paid. (This is the default value.)
  • partially_refunded: The finances have been partially refunded.
  • refunded: The finances have been refunded.
  • voided: The finances have been voided.


fulfillments
{ "created_at" : "2012-03-13T16:09:54-04:00" }
{ "id" : 255858046 }
{ "order_id" : 450789469 }
{ "status" : "failure" }
{ "tracking_company" : "null" }
{ "tracking_number" : "1Z2345" }
{ "updated_at" : "2012-05-01T14:22:25-04:00" }


  • created_at: The date and time when the fulfillment was created. The API returns this value in ISO 8601 format.
  • id: The unique numeric identifier for the fulfillment.
  • line_items: A historical record of each item in the fulfillment.
  • order_id: The unique numeric identifier for the order.
  • receipt: A textfield with information about the receipt.
  • status: The status of the fulfillment.
  • tracking_company: The name of the shipping company.
  • tracking_number: The shipping number, provided by the shipping company.
  • updated_at: The date and time when the fulfillment was last modified. The API returns this value in ISO 8601 format.


fulfillment_status
{ "fulfillment_status" : "null" }


  • fulfilled: Every line item in the order has been fulfilled.
  • null: None of the line items in the order have been fulfilled.
  • partial: At least one line item in the order has been fulfilled.


tags
{ "tags" : "tagsational" }

Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. For example, if an order has three tags: tag1, tag2, tag3. Each individual tag is limited to 40 characters in length.

gateway
{ "gateway" : "authorize_net" }

Deprecated as of July 14, 2014. This information is instead available on transactions The payment gateway used.

id
{ "id" : "450789469" }

The unique numeric identifier for the order. This one is used for API purposes. This is different from the order_number property (see below), which is also a unique numeric identifier for the order, but used by the shop owner and customer.

landing_site
{ "landing_site" : "http://www.example.com?source=abc" }

The URL for the page where the buyer landed when entering the shop.

line_items
{ "fulfillable_quantity" : 1 }
{ "fulfillment_service" : "amazon" }
{ "fulfillment_status" : "fulfilled" }
{ "grams" : 500 }
{ "id" : 669751112 }
{ "price" : "199.99" }
{ "product_id" : 7513594 }
{ "quantity" : 1 }
{ "requires_shipping" : true }
{ "sku" : "IPOD-342-N" }
{ "title" : "IPod Nano" }
{ "variant_id" : 4264112 }
{ "variant_title" : "Pink" }
{ "vendor" : "Apple" }
{ "name" : "IPod Nano - Pink" }>
{ "gift_card" : false }
{ "taxable" : true }
{ "tax_lines" : "[]" }
{ "total_discount" : "5.00" }

A list of line item objects, each one containing information about an item in the order. Each line_item object has the following properties:

  • fulfillable_quantity: The amount available to fulfill. This is the quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity.
  • fulfillment_service: Service provider who is doing the fulfillment. Valid values are either "manual" or the name of the provider. eg: "amazon", "shipwire", etc.
  • fulfillment_status: How far along an order is in terms line items fulfilled. Valid values are: fulfilled, null or partial.
  • grams: The weight of the item in grams.
  • id: The id of the line item.
  • price: The price of the item before discounts have been applied.
  • product_id: The unique numeric identifier for the product in the fulfillment. Can be null if the original product associated with the order is deleted at a later date
  • quantity: The number of products that were purchased.
  • requires_shipping: States whether or not the fulfillment requires shipping. Values are: true or false.
  • sku: A unique identifier of the item in the fulfillment.
  • title: The title of the product.
  • variant_id: The id of the product variant.
  • variant_title: The title of the product variant.
  • vendor: The name of the supplier of the item.
  • name: The name of the product variant.
  • gift_card: States wether or not the line_item is a gift card. If so, the item is not taxed or considered for shipping charges.
  • taxable: States whether or not the product was taxable. Values are: true or false.
  • tax_lines: A list of tax_line objects, each of which details the taxes applicable to this line_item.
  • total_discount: The total discount amount applied to this line item. This value is not subtracted in the line item price.


name
{ "name" : "#1001" }

The customer's order name as represented by a number.

note
{ "note" : "null" }

The text of an optional note that a shop owner can attach to the order.

note_attributes
{ "note_attributes" : [{ "name" : "custom name" }, { "value" : "custom value" }] }

Extra information that is added to the order. Each array entry must contain a hash with "name" and "value" keys as shown above.

number
{ "number" : "1" }

Numerical identifier unique to the shop. A number is sequential and starts at 1000.

order_number
{ "order_number" : 1001 }

A unique numeric identifier for the order. This one is used by the shop owner and customer. This is different from the id property, which is also a unique numeric identifier for the order, but used for API purposes.

payment_details
{ "avs_result_code" : "null" }
{ "credit_card_bin" : "null" }
{ "cvv_result_code" : "null" }
{ "credit_card_number" : "•••• •••• •••• 4242" }
{ "credit_card_company" : "Visa" }

Deprecated as of July 7, 2014. This information is instead available on transactions An object containing information about the payment. It has the following properties:

  • avs_result_code: The Response code from AVS the address verification system. The code is a single letter; see this chart for the codes and their definitions.
  • credit_card_bin: The issuer identification number (IIN), formerly known as bank identification number (BIN) ] of the customer's credit card. This is made up of the first few digits of the credit card number.
  • credit_card_company: The name of the company who issued the customer's credit card.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted with Xs.
  • cvv_result_code: The Response code from the credit card company indicating whether the customer entered the card security code, a.k.a. card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions.


processed_at
{ "processed_at" : "2008-01-10T11:00:00-05:00" }

The date and time when the order was imported, in ISO 8601 format. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated.

processing_method
{ "processing_method" : "direct" }

States the type of payment processing method. Valid values are: checkout, direct, manual, offsite or express.

referring_site
{ "referring_site" : "http://www.anexample.com" }

The website that the customer clicked on to come to the shop.

refund

The list of refunds applied to the order.

shipping_address
{ "address1" : "123 Amoebobacterieae St" }
{ "address2" : "" }
{ "city" : "Ottawa" }
{ "company" : "null" }
{ "country" : "Canada" }
{ "first_name" : "Bob" }
{ "last_name" : "Bobsen" }
{ "latitude" : "45.41634" }
{ "longitude" : "-75.6868" }
{ "phone" : "555-625-1199" }
{ "province" : "Ontario" }
{ "zip" : "K2P0V6" }
{ "name" : "Bob Bobsen" }
{ "country_code" : "CA" }
{ "province_code" : "ON" }

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require one. It has the following properties:

  • address1: The street address of the shipping address.
  • address2: An optional additional field for the street address of the shipping address.
  • city: The city of the shipping address.
  • company: The company of the person associated with the shipping address.
  • country: The name of the country of the shipping address.
  • country_code: The two-letter code for the country of the shipping address.
  • first_name: The first name of the person associated with the payment method.
  • last_name: The last name of the person associated with the payment method.
  • latitude: The latitude of the shipping address.
  • longitude: The longitude of the shipping address.
  • name: The full name of the person associated with the payment method.
  • phone: The phone number at the shipping address.
  • province: The name of the state or province of the shipping address.
  • province_code: The two-letter abbreviation of the state or province of the shipping address.
  • zip: The zip or postal code of the shipping address.


shipping_lines
{ "code" : "Free Shipping" }
{ "price" : 0.0 }
{ "source" : "haravan" }
{ "title" : "Free Shipping" }
{ "tax_lines" : "[]" }

An array of shipping_line objects, each of which details the shipping methods used. Each shipping_line has the following properties:

  • code: A reference to the shipping method.
  • price: The price of this shipping method.
  • source: The source of the shipping method.
  • title: The title of the shipping method.
  • tax_lines: A list of tax_line objects, each of which details the taxes applicable to this shipping_line.
source_name
{ "source_name" : "web" }

Where the order originated. May only be set during creation, and is not writeable thereafter. Orders created through official haravan channels have protected values that cannot be assigned by other API clients during order creation. These protected values are: "web", "pos", "iphone", and "android" Orders created via the API may be assigned any other string of your choice. If source_name is unspecified, new orders are assigned the value "api".

subtotal_price
{ "subtotal_price" : 398.0 }

Price of the order before shipping and taxes

tax_lines
{ "price" : 11.94 }
{ "rate" : 0.06 }
{ "title" : "State Tax" }

An array of tax_line objects, each of which details the total taxes applicable to the order. Each tax_line has the following properties:

  • price: The amount of tax to be charged.
  • rate: The rate of tax to be applied.
  • title: The name of the tax.


taxes_included
{ "taxes_included" : "false" }

States whether or not taxes are included in the order subtotal. Valid values are "true" or "false".

token
{ "token" : "b1946ac92492d2347c6235b4d2611184" }

Unique identifier for a particular order.

total_discounts
{ "total_discounts" : "0.00" }

The total amount of the discounts to be applied to the price of the order.

total_line_items_price
{ "total_line_items_price" : "398.00" }

The sum of all the prices of all the items in the order.

total_price
{ "total_price" : "409.94" }

The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

total_tax
{ "total_tax" : "11.94" }

The sum of all the taxes applied to the order (must be positive).

total_weight
{ "total_weight" : "0" }

The sum of all the weights of the line items in the order, in grams.

updated_at
{ "updated_at" : "2012-08-24T14:02:15-04:00" }

The date and time when the order was last modified. The API returns this value in ISO 8601 format.

Endpoints

GET/com/orders.json

Retrieve a list of Orders (OPEN Orders by default, use status=any for ALL orders)

ids

A comma-separated list of order ids

limit

Amount of results

page

Page to show

since_id

Restrict results to after the specified ID

created_at_min

Show orders created after date (format: 2008-12-31 03:00)

created_at_max

Show orders created before date (format: 2008-12-31 03:00)

updated_at_min

Show orders last updated after date (format: 2008-12-31 03:00)

updated_at_max

Show orders last updated before date (format: 2008-12-31 03:00)

processed_at_min

Show orders imported after date (format: 2008-12-31 03:00)

processed_at_max

Show orders imported before date (format: 2008-12-31 03:00)

financial_status
The current payment status. One of: 'pending', 'partially_paid', 'paid', 'partiallyrefunded', 'refunded', 'voided'.
fulfillment_status
The current fulfillment status of the order. One of: 'null', 'not_fulfilled', 'partial', 'fulfilled'.
fields

comma-separated list of fields to include in the response

List all orders

GET /com/orders.json
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "buyer_accepts_marketing": false,
      "cancel_reason": null,
      "cancelled_at": null,
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "checkout_token": null,
      "closed_at": null,
      "confirmed": false,
      "created_at": "2008-01-10T11:00:00-05:00",
      "currency": "USD",
      "device_id": null,
      "email": "bob.norman@hostmail.com",
      "financial_status": "authorized",
      "fulfillment_status": null,
      "gateway": "authorize_net",
      "id": 450789469,
      "landing_site": "http:\/\/www.example.com?source=abc",
      "location_id": null,
      "name": "#1001",
      "note": null,
      "number": 1,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "reference": "fhwdgads",
      "referring_site": "http:\/\/www.otherexample.com",
      "source_identifier": "fhwdgads",
      "source_url": null,
      "subtotal_price": "398.00",
      "taxes_included": false,
      "test": false,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "total_price": "409.94",
      "total_price_usd": "409.94",
      "total_tax": "11.94",
      "total_weight": 0,
      "updated_at": "2008-01-10T11:00:00-05:00",
      "user_id": null,
      "browser_ip": null,
      "landing_site_ref": "abc",
      "order_number": 1001,
      "discount_codes": [
        {
          "code": "TENOFF",
          "amount": "10.00",
          "type": "percentage"
        }
      ],
      "note_attributes": [
        {
          "name": "custom engraving",
          "value": "Happy Birthday"
        },
        {
          "name": "colour",
          "value": "green"
        }
      ],
      "processing_method": "direct",
      "source": "browser",
      "checkout_id": 450789469,
      "source_name": "web",
      "tax_lines": [
        {
          "price": "11.94",
          "rate": 0.06,
          "title": "State Tax"
        }
      ],
      "tags": "",
      "line_items": [
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 466157049,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008GREEN",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 39072856,
          "variant_title": "green",
          "vendor": null,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "haravan",
          "properties": [
            {
              "name": "Custom Engraving Front",
              "value": "Happy Birthday"
            },
            {
              "name": "Custom Engraving Back",
              "value": "Merry Christmas"
            }
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 518995019,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 49148385,
          "variant_title": "red",
          "vendor": null,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 703073504,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008BLACK",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 457924702,
          "variant_title": "black",
          "vendor": null,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        }
      ],
      "shipping_lines": [
        {
          "code": "Free Shipping",
          "price": "0.00",
          "source": "haravan",
          "title": "Free Shipping",
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "shipping_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "fulfillments": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 255858046,
          "order_id": 450789469,
          "service": "manual",
          "status": "failure",
          "tracking_company": null,
          "updated_at": "2015-03-28T13:29:45-04:00",
          "tracking_number": "1Z2345",
          "tracking_numbers": [
            "1Z2345"
          ],
          "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
          "tracking_urls": [
            "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
          ],
          "receipt": {
            "testcase": true,
            "authorization": "123456"
          },
          "line_items": [
            {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          ]
        }
      ],
      "client_details": {
        "accept_language": null,
        "browser_height": null,
        "browser_ip": "0.0.0.0",
        "browser_width": null,
        "session_hash": null,
        "user_agent": null
      },
      "refunds": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 509562969,
          "note": "it broke during shipping",
          "order_id": 450789469,
          "restock": true,
          "user_id": 799407056,
          "refund_line_items": [
            {
              "id": 104689539,
              "line_item_id": 703073504,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 703073504,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008BLACK",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 457924702,
                "variant_title": "black",
                "vendor": null,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "haravan",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            },
            {
              "id": 709875399,
              "line_item_id": 466157049,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 466157049,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008GREEN",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 39072856,
                "variant_title": "green",
                "vendor": null,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "haravan",
                "properties": [
                  {
                    "name": "Custom Engraving Front",
                    "value": "Happy Birthday"
                  },
                  {
                    "name": "Custom Engraving Back",
                    "value": "Merry Christmas"
                  }
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            }
          ],
          "transactions": [
            {
              "amount": "209.00",
              "authorization": "authorization-key",
              "created_at": "2005-08-05T12:59:12-04:00",
              "currency": "USD",
              "gateway": "bogus",
              "id": 179259969,
              "kind": "refund",
              "location_id": null,
              "message": null,
              "order_id": 450789469,
              "parent_id": null,
              "status": "success",
              "test": false,
              "user_id": null,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ]
        }
      ],
      "payment_details": {
        "avs_result_code": null,
        "credit_card_bin": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "accepts_marketing": false,
        "created_at": "2015-03-28T13:29:45-04:00",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "id": 207119551,
        "last_name": "Norman",
        "last_order_id": 450789469,
        "multipass_identifier": null,
        "note": null,
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "updated_at": "2015-03-28T13:29:45-04:00",
        "verified_email": true,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "company": null,
          "country": "United States",
          "first_name": null,
          "id": 207119551,
          "last_name": null,
          "phone": "555-625-1199",
          "province": "Kentucky",
          "zip": "40202",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}

List of specific orders

GET /com/orders.json?ids=1073459968
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "buyer_accepts_marketing": false,
      "cancel_reason": null,
      "cancelled_at": null,
      "cart_token": null,
      "checkout_token": null,
      "closed_at": null,
      "confirmed": true,
      "created_at": "2015-03-28T13:30:39-04:00",
      "currency": "USD",
      "device_id": null,
      "email": "",
      "financial_status": "paid",
      "fulfillment_status": null,
      "gateway": "",
      "id": 1073459968,
      "landing_site": null,
      "location_id": null,
      "name": "#1002",
      "note": null,
      "number": 2,
      "processed_at": "2015-03-28T13:30:39-04:00",
      "reference": null,
      "referring_site": null,
      "source_identifier": null,
      "source_url": null,
      "subtotal_price": "199.00",
      "taxes_included": false,
      "test": false,
      "token": "f0b73ed55096180c2af69ac6fe12f4f8",
      "total_discounts": "0.00",
      "total_line_items_price": "199.00",
      "total_price": "199.00",
      "total_price_usd": "199.00",
      "total_tax": "0.00",
      "total_weight": 0,
      "updated_at": "2015-03-28T13:30:39-04:00",
      "user_id": null,
      "browser_ip": null,
      "landing_site_ref": null,
      "order_number": 1002,
      "discount_codes": [
      ],
      "note_attributes": [
      ],
      "processing_method": "",
      "source": "755357713",
      "checkout_id": null,
      "source_name": "755357713",
      "tax_lines": [
      ],
      "tags": "",
      "line_items": [
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 1071823178,
          "price": "199.00",
          "product_id": 921728736,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2009BLACK",
          "taxable": true,
          "title": "IPod Touch 8GB",
          "variant_id": 447654529,
          "variant_title": "Black",
          "vendor": null,
          "name": "IPod Touch 8GB - Black",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        }
      ],
      "shipping_lines": [
      ],
      "fulfillments": [
      ],
      "refunds": [
      ]
    }
  ]
}

List orders which are authorized and ready to be captured.

GET /com/orders.json?financial_status=authorized
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "buyer_accepts_marketing": false,
      "cancel_reason": null,
      "cancelled_at": null,
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "checkout_token": null,
      "closed_at": null,
      "confirmed": false,
      "created_at": "2008-01-10T11:00:00-05:00",
      "currency": "USD",
      "device_id": null,
      "email": "bob.norman@hostmail.com",
      "financial_status": "authorized",
      "fulfillment_status": null,
      "gateway": "authorize_net",
      "id": 450789469,
      "landing_site": "http:\/\/www.example.com?source=abc",
      "location_id": null,
      "name": "#1001",
      "note": null,
      "number": 1,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "reference": "fhwdgads",
      "referring_site": "http:\/\/www.otherexample.com",
      "source_identifier": "fhwdgads",
      "source_url": null,
      "subtotal_price": "398.00",
      "taxes_included": false,
      "test": false,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "total_price": "409.94",
      "total_price_usd": "409.94",
      "total_tax": "11.94",
      "total_weight": 0,
      "updated_at": "2008-01-10T11:00:00-05:00",
      "user_id": null,
      "browser_ip": null,
      "landing_site_ref": "abc",
      "order_number": 1001,
      "discount_codes": [
        {
          "code": "TENOFF",
          "amount": "10.00",
          "type": "percentage"
        }
      ],
      "note_attributes": [
        {
          "name": "custom engraving",
          "value": "Happy Birthday"
        },
        {
          "name": "colour",
          "value": "green"
        }
      ],
      "processing_method": "direct",
      "source": "browser",
      "checkout_id": 450789469,
      "source_name": "web",
      "tax_lines": [
        {
          "price": "11.94",
          "rate": 0.06,
          "title": "State Tax"
        }
      ],
      "tags": "",
      "line_items": [
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 466157049,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008GREEN",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 39072856,
          "variant_title": "green",
          "vendor": null,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "haravan",
          "properties": [
            {
              "name": "Custom Engraving Front",
              "value": "Happy Birthday"
            },
            {
              "name": "Custom Engraving Back",
              "value": "Merry Christmas"
            }
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 518995019,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 49148385,
          "variant_title": "red",
          "vendor": null,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 703073504,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008BLACK",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 457924702,
          "variant_title": "black",
          "vendor": null,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        }
      ],
      "shipping_lines": [
        {
          "code": "Free Shipping",
          "price": "0.00",
          "source": "haravan",
          "title": "Free Shipping",
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "shipping_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "fulfillments": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 255858046,
          "order_id": 450789469,
          "service": "manual",
          "status": "failure",
          "tracking_company": null,
          "updated_at": "2015-03-28T13:29:45-04:00",
          "tracking_number": "1Z2345",
          "tracking_numbers": [
            "1Z2345"
          ],
          "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
          "tracking_urls": [
            "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
          ],
          "receipt": {
            "testcase": true,
            "authorization": "123456"
          },
          "line_items": [
            {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          ]
        }
      ],
      "client_details": {
        "accept_language": null,
        "browser_height": null,
        "browser_ip": "0.0.0.0",
        "browser_width": null,
        "session_hash": null,
        "user_agent": null
      },
      "refunds": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 509562969,
          "note": "it broke during shipping",
          "order_id": 450789469,
          "restock": true,
          "user_id": 799407056,
          "refund_line_items": [
            {
              "id": 104689539,
              "line_item_id": 703073504,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 703073504,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008BLACK",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 457924702,
                "variant_title": "black",
                "vendor": null,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "haravan",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            },
            {
              "id": 709875399,
              "line_item_id": 466157049,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 466157049,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008GREEN",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 39072856,
                "variant_title": "green",
                "vendor": null,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "haravan",
                "properties": [
                  {
                    "name": "Custom Engraving Front",
                    "value": "Happy Birthday"
                  },
                  {
                    "name": "Custom Engraving Back",
                    "value": "Merry Christmas"
                  }
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            }
          ],
          "transactions": [
            {
              "amount": "209.00",
              "authorization": "authorization-key",
              "created_at": "2005-08-05T12:59:12-04:00",
              "currency": "USD",
              "gateway": "bogus",
              "id": 179259969,
              "kind": "refund",
              "location_id": null,
              "message": null,
              "order_id": 450789469,
              "parent_id": null,
              "status": "success",
              "test": false,
              "user_id": null,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ]
        }
      ],
      "payment_details": {
        "avs_result_code": null,
        "credit_card_bin": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "accepts_marketing": false,
        "created_at": "2015-03-28T13:29:45-04:00",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "id": 207119551,
        "last_name": "Norman",
        "last_order_id": 450789469,
        "multipass_identifier": null,
        "note": null,
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "updated_at": "2015-03-28T13:29:45-04:00",
        "verified_email": true,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "company": null,
          "country": "United States",
          "first_name": null,
          "id": 207119551,
          "last_name": null,
          "phone": "555-625-1199",
          "province": "Kentucky",
          "zip": "40202",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}

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

GET /com/orders.json?updated_at_min=2005-07-31 15:57:11 EDT -04:00
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "buyer_accepts_marketing": false,
      "cancel_reason": null,
      "cancelled_at": null,
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "checkout_token": null,
      "closed_at": null,
      "confirmed": false,
      "created_at": "2008-01-10T11:00:00-05:00",
      "currency": "USD",
      "device_id": null,
      "email": "bob.norman@hostmail.com",
      "financial_status": "authorized",
      "fulfillment_status": null,
      "gateway": "authorize_net",
      "id": 450789469,
      "landing_site": "http:\/\/www.example.com?source=abc",
      "location_id": null,
      "name": "#1001",
      "note": null,
      "number": 1,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "reference": "fhwdgads",
      "referring_site": "http:\/\/www.otherexample.com",
      "source_identifier": "fhwdgads",
      "source_url": null,
      "subtotal_price": "398.00",
      "taxes_included": false,
      "test": false,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "total_price": "409.94",
      "total_price_usd": "409.94",
      "total_tax": "11.94",
      "total_weight": 0,
      "updated_at": "2008-01-10T11:00:00-05:00",
      "user_id": null,
      "browser_ip": null,
      "landing_site_ref": "abc",
      "order_number": 1001,
      "discount_codes": [
        {
          "code": "TENOFF",
          "amount": "10.00",
          "type": "percentage"
        }
      ],
      "note_attributes": [
        {
          "name": "custom engraving",
          "value": "Happy Birthday"
        },
        {
          "name": "colour",
          "value": "green"
        }
      ],
      "processing_method": "direct",
      "source": "browser",
      "checkout_id": 450789469,
      "source_name": "web",
      "tax_lines": [
        {
          "price": "11.94",
          "rate": 0.06,
          "title": "State Tax"
        }
      ],
      "tags": "",
      "line_items": [
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 466157049,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008GREEN",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 39072856,
          "variant_title": "green",
          "vendor": null,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "haravan",
          "properties": [
            {
              "name": "Custom Engraving Front",
              "value": "Happy Birthday"
            },
            {
              "name": "Custom Engraving Back",
              "value": "Merry Christmas"
            }
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 518995019,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 49148385,
          "variant_title": "red",
          "vendor": null,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 703073504,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008BLACK",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 457924702,
          "variant_title": "black",
          "vendor": null,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        }
      ],
      "shipping_lines": [
        {
          "code": "Free Shipping",
          "price": "0.00",
          "source": "haravan",
          "title": "Free Shipping",
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "shipping_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "fulfillments": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 255858046,
          "order_id": 450789469,
          "service": "manual",
          "status": "failure",
          "tracking_company": null,
          "updated_at": "2015-03-28T13:29:45-04:00",
          "tracking_number": "1Z2345",
          "tracking_numbers": [
            "1Z2345"
          ],
          "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
          "tracking_urls": [
            "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
          ],
          "receipt": {
            "testcase": true,
            "authorization": "123456"
          },
          "line_items": [
            {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          ]
        }
      ],
      "client_details": {
        "accept_language": null,
        "browser_height": null,
        "browser_ip": "0.0.0.0",
        "browser_width": null,
        "session_hash": null,
        "user_agent": null
      },
      "refunds": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 509562969,
          "note": "it broke during shipping",
          "order_id": 450789469,
          "restock": true,
          "user_id": 799407056,
          "refund_line_items": [
            {
              "id": 104689539,
              "line_item_id": 703073504,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 703073504,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008BLACK",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 457924702,
                "variant_title": "black",
                "vendor": null,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "haravan",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            },
            {
              "id": 709875399,
              "line_item_id": 466157049,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 466157049,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008GREEN",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 39072856,
                "variant_title": "green",
                "vendor": null,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "haravan",
                "properties": [
                  {
                    "name": "Custom Engraving Front",
                    "value": "Happy Birthday"
                  },
                  {
                    "name": "Custom Engraving Back",
                    "value": "Merry Christmas"
                  }
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            }
          ],
          "transactions": [
            {
              "amount": "209.00",
              "authorization": "authorization-key",
              "created_at": "2005-08-05T12:59:12-04:00",
              "currency": "USD",
              "gateway": "bogus",
              "id": 179259969,
              "kind": "refund",
              "location_id": null,
              "message": null,
              "order_id": 450789469,
              "parent_id": null,
              "status": "success",
              "test": false,
              "user_id": null,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ]
        }
      ],
      "payment_details": {
        "avs_result_code": null,
        "credit_card_bin": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "accepts_marketing": false,
        "created_at": "2015-03-28T13:29:45-04:00",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "id": 207119551,
        "last_name": "Norman",
        "last_order_id": 450789469,
        "multipass_identifier": null,
        "note": null,
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "updated_at": "2015-03-28T13:29:45-04:00",
        "verified_email": true,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "company": null,
          "country": "United States",
          "first_name": null,
          "id": 207119551,
          "last_name": null,
          "phone": "555-625-1199",
          "province": "Kentucky",
          "zip": "40202",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}

List all orders, showing only some attributes

GET /com/orders.json?fields=created_at,id,name,total-price
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "created_at": "2008-01-10T11:00:00-05:00",
      "id": 450789469,
      "name": "#1001",
      "total_price": "409.94"
    }
  ]
}

List all orders after the specified ID

GET /com/orders.json?since_id=123
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "buyer_accepts_marketing": false,
      "cancel_reason": null,
      "cancelled_at": null,
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "checkout_token": null,
      "closed_at": null,
      "confirmed": false,
      "created_at": "2008-01-10T11:00:00-05:00",
      "currency": "USD",
      "device_id": null,
      "email": "bob.norman@hostmail.com",
      "financial_status": "authorized",
      "fulfillment_status": null,
      "gateway": "authorize_net",
      "id": 450789469,
      "landing_site": "http:\/\/www.example.com?source=abc",
      "location_id": null,
      "name": "#1001",
      "note": null,
      "number": 1,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "reference": "fhwdgads",
      "referring_site": "http:\/\/www.otherexample.com",
      "source_identifier": "fhwdgads",
      "source_url": null,
      "subtotal_price": "398.00",
      "taxes_included": false,
      "test": false,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "total_price": "409.94",
      "total_price_usd": "409.94",
      "total_tax": "11.94",
      "total_weight": 0,
      "updated_at": "2008-01-10T11:00:00-05:00",
      "user_id": null,
      "browser_ip": null,
      "landing_site_ref": "abc",
      "order_number": 1001,
      "discount_codes": [
        {
          "code": "TENOFF",
          "amount": "10.00",
          "type": "percentage"
        }
      ],
      "note_attributes": [
        {
          "name": "custom engraving",
          "value": "Happy Birthday"
        },
        {
          "name": "colour",
          "value": "green"
        }
      ],
      "processing_method": "direct",
      "source": "browser",
      "checkout_id": 450789469,
      "source_name": "web",
      "tax_lines": [
        {
          "price": "11.94",
          "rate": 0.06,
          "title": "State Tax"
        }
      ],
      "tags": "",
      "line_items": [
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 466157049,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008GREEN",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 39072856,
          "variant_title": "green",
          "vendor": null,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "haravan",
          "properties": [
            {
              "name": "Custom Engraving Front",
              "value": "Happy Birthday"
            },
            {
              "name": "Custom Engraving Back",
              "value": "Merry Christmas"
            }
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 518995019,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 49148385,
          "variant_title": "red",
          "vendor": null,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        },
        {
          "fulfillment_service": "manual",
          "fulfillment_status": null,
          "gift_card": false,
          "grams": 200,
          "id": 703073504,
          "price": "199.00",
          "product_id": 632910392,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008BLACK",
          "taxable": true,
          "title": "IPod Nano - 8gb",
          "variant_id": 457924702,
          "variant_title": "black",
          "vendor": null,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "haravan",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "tax_lines": [
          ]
        }
      ],
      "shipping_lines": [
        {
          "code": "Free Shipping",
          "price": "0.00",
          "source": "haravan",
          "title": "Free Shipping",
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "shipping_address": {
        "address1": "123 Amoebobacterieae St",
        "address2": "",
        "city": "Ottawa",
        "company": "",
        "country": "Canada",
        "first_name": "Bob",
        "last_name": "Bobsen",
        "latitude": 45.41634,
        "longitude": -75.6868,
        "phone": "(555)555-5555",
        "province": "Ontario",
        "zip": "K2P0V6",
        "name": "Bob Bobsen",
        "country_code": "CA",
        "province_code": "ON"
      },
      "fulfillments": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 255858046,
          "order_id": 450789469,
          "service": "manual",
          "status": "failure",
          "tracking_company": null,
          "updated_at": "2015-03-28T13:29:45-04:00",
          "tracking_number": "1Z2345",
          "tracking_numbers": [
            "1Z2345"
          ],
          "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
          "tracking_urls": [
            "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
          ],
          "receipt": {
            "testcase": true,
            "authorization": "123456"
          },
          "line_items": [
            {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          ]
        }
      ],
      "client_details": {
        "accept_language": null,
        "browser_height": null,
        "browser_ip": "0.0.0.0",
        "browser_width": null,
        "session_hash": null,
        "user_agent": null
      },
      "refunds": [
        {
          "created_at": "2015-03-28T13:29:45-04:00",
          "id": 509562969,
          "note": "it broke during shipping",
          "order_id": 450789469,
          "restock": true,
          "user_id": 799407056,
          "refund_line_items": [
            {
              "id": 104689539,
              "line_item_id": 703073504,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 703073504,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008BLACK",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 457924702,
                "variant_title": "black",
                "vendor": null,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "haravan",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            },
            {
              "id": 709875399,
              "line_item_id": 466157049,
              "quantity": 1,
              "line_item": {
                "fulfillment_service": "manual",
                "fulfillment_status": null,
                "gift_card": false,
                "grams": 200,
                "id": 466157049,
                "price": "199.00",
                "product_id": 632910392,
                "quantity": 1,
                "requires_shipping": true,
                "sku": "IPOD2008GREEN",
                "taxable": true,
                "title": "IPod Nano - 8gb",
                "variant_id": 39072856,
                "variant_title": "green",
                "vendor": null,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "haravan",
                "properties": [
                  {
                    "name": "Custom Engraving Front",
                    "value": "Happy Birthday"
                  },
                  {
                    "name": "Custom Engraving Back",
                    "value": "Merry Christmas"
                  }
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "tax_lines": [
                ]
              }
            }
          ],
          "transactions": [
            {
              "amount": "209.00",
              "authorization": "authorization-key",
              "created_at": "2005-08-05T12:59:12-04:00",
              "currency": "USD",
              "gateway": "bogus",
              "id": 179259969,
              "kind": "refund",
              "location_id": null,
              "message": null,
              "order_id": 450789469,
              "parent_id": null,
              "status": "success",
              "test": false,
              "user_id": null,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ]
        }
      ],
      "payment_details": {
        "avs_result_code": null,
        "credit_card_bin": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "accepts_marketing": false,
        "created_at": "2015-03-28T13:29:45-04:00",
        "email": "bob.norman@hostmail.com",
        "first_name": "Bob",
        "id": 207119551,
        "last_name": "Norman",
        "last_order_id": 450789469,
        "multipass_identifier": null,
        "note": null,
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "updated_at": "2015-03-28T13:29:45-04:00",
        "verified_email": true,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "company": null,
          "country": "United States",
          "first_name": null,
          "id": 207119551,
          "last_name": null,
          "phone": "555-625-1199",
          "province": "Kentucky",
          "zip": "40202",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}
GET/com/orders/450789469.json

Retrieve a specific order

fields

comma-separated list of fields to include in the response

Get a representation of a single order

GET /com/orders/#{id}.json
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": false,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2008-01-10T11:00:00-05:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:29:45-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Get only particular fields

GET /com/orders/#{id}.json?fields=id,line_items,name,total_price
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "name": "#1001",
    "total_price": "409.94",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ]
  }
}
GET/com/orders/count.json

Retrieve a count of all the orders

created_at_min

Count orders created after date (format: 2008-12-31 03:00)

created_at_max

Count orders created before date (format: 2008-12-31 03:00)

updated_at_min

Count orders last updated after date (format: 2008-12-31 03:00)

updated_at_max

Count orders last updated before date (format: 2008-12-31 03:00)

financial_status
The current payment status. One of: 'pending', 'partially_paid', 'paid', 'partiallyrefunded', 'refunded', 'voided'.
fulfillment_status
The current fulfillment status of the order. One of: 'null', 'not_fulfilled', 'partial', 'fulfilled'.

Count all orders

GET /com/orders/count.json
View Response
HTTP/1.1 200 OK
{
  "count": 1
}

Count orders which are authorized and ready to be captured.

GET /com/orders/count.json?financial_status=authorized
View Response
HTTP/1.1 200 OK
{
  "count": 1
}
POST/com/orders/450789469/close.json

Close an order


Close a processed order

POST /com/orders/#{id}/close.json
{}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": "2015-03-28T13:30:35-04:00",
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:35-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:35-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}
POST/com/orders/450789469/open.json

Re-open a closed Order


Re-opening a closed Order

POST /com/orders/#{id}/open.json
{}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:41-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:41-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}
POST/com/orders/450789469/cancel.json

Cancel an Order

amount

Amount to refund (decimal ex: 21.20). If set, haravan will attempt to void/refund the payment depending on the status.

restock

Restock the items for this order back to your store

reason

The reason for the order cancellation (one of customer, inventory, fraud, other)

email

Send an email to the customer notifying them of the cancellation

Cancelling an Order

POST /com/orders/#{id}/cancel.json
{}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": false,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2008-01-10T11:00:00-05:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:29:45-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}
POST/com/orders.json

Create a new order

order

In addition to the properties defined earlier, you can use the following flags

  • bypass (default): Do not claim inventory.
  • decrement_ignoring_policy: Ignore the product's inventory policy and claim amounts no matter what.
  • decrement_obeying_policy: Obey the product's inventory policy.

Create a simple order with only a product variant id.

POST /com/orders.json
{
  "order": {
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": null,
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2015-03-28T13:30:36-04:00",
    "currency": "USD",
    "device_id": null,
    "email": "",
    "financial_status": "paid",
    "fulfillment_status": null,
    "gateway": "",
    "id": 1073459962,
    "landing_site": null,
    "location_id": null,
    "name": "#1002",
    "note": null,
    "number": 2,
    "processed_at": "2015-03-28T13:30:36-04:00",
    "reference": null,
    "referring_site": null,
    "source_identifier": null,
    "source_url": null,
    "subtotal_price": "199.00",
    "taxes_included": false,
    "test": false,
    "token": "f16e29f68fe7b57a0a2ff005202178b0",
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "total_price": "199.00",
    "total_price_usd": "199.00",
    "total_tax": "0.00",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:36-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "processing_method": "",
    "source": "755357713",
    "checkout_id": null,
    "source_name": "755357713",
    "tax_lines": [
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 1071823172,
        "price": "199.00",
        "product_id": 921728736,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2009BLACK",
        "taxable": true,
        "title": "IPod Touch 8GB",
        "variant_id": 447654529,
        "variant_title": "Black",
        "vendor": null,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ]
  }
}

Create a simple order, sending order receipt and fulfillment receipt to the customer

POST /com/orders.json
{
  "order": {
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "send_receipt": true,
    "send_fulfillment_receipt": true,
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": null,
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2015-03-28T13:30:36-04:00",
    "currency": "USD",
    "device_id": null,
    "email": "foo@example.com",
    "financial_status": "paid",
    "fulfillment_status": "fulfilled",
    "gateway": "",
    "id": 1073459963,
    "landing_site": null,
    "location_id": null,
    "name": "#1002",
    "note": null,
    "number": 2,
    "processed_at": "2015-03-28T13:30:36-04:00",
    "reference": null,
    "referring_site": null,
    "source_identifier": null,
    "source_url": null,
    "subtotal_price": "199.00",
    "taxes_included": false,
    "test": false,
    "token": "5d5257c9b70808a3719a3ba25f493411",
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "total_price": "199.00",
    "total_price_usd": "199.00",
    "total_tax": "0.00",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:36-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "processing_method": "",
    "source": "755357713",
    "checkout_id": null,
    "source_name": "755357713",
    "tax_lines": [
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": "fulfilled",
        "gift_card": false,
        "grams": 200,
        "id": 1071823173,
        "price": "199.00",
        "product_id": 921728736,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2009BLACK",
        "taxable": true,
        "title": "IPod Touch 8GB",
        "variant_id": 447654529,
        "variant_title": "Black",
        "vendor": null,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:30:36-04:00",
        "id": 1022782902,
        "order_id": 1073459963,
        "service": "manual",
        "status": "success",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:30:36-04:00",
        "tracking_number": null,
        "tracking_numbers": [
        ],
        "tracking_url": null,
        "tracking_urls": [
        ],
        "receipt": {},
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": "fulfilled",
            "gift_card": false,
            "grams": 200,
            "id": 1071823173,
            "price": "199.00",
            "product_id": 921728736,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2009BLACK",
            "taxable": true,
            "title": "IPod Touch 8GB",
            "variant_id": 447654529,
            "variant_title": "Black",
            "vendor": null,
            "name": "IPod Touch 8GB - Black",
            "variant_inventory_management": "haravan",
            "properties": [
            ],
            "product_exists": true,
            "fulfillable_quantity": 0,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "refunds": [
    ],
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:30:36-04:00",
      "email": "foo@example.com",
      "first_name": null,
      "id": 1018520259,
      "last_name": null,
      "last_order_id": 1073459963,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "0.00",
      "updated_at": "2015-03-28T13:30:36-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1002"
    }
  }
}

Create a simple order without sending order/fulfillment receipt

POST /com/orders.json
{
  "order": {
    "email": "foo@example.com",
    "fulfillment_status": "fulfilled",
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": null,
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2015-03-28T13:30:36-04:00",
    "currency": "USD",
    "device_id": null,
    "email": "foo@example.com",
    "financial_status": "paid",
    "fulfillment_status": "fulfilled",
    "gateway": "",
    "id": 1073459964,
    "landing_site": null,
    "location_id": null,
    "name": "#1002",
    "note": null,
    "number": 2,
    "processed_at": "2015-03-28T13:30:36-04:00",
    "reference": null,
    "referring_site": null,
    "source_identifier": null,
    "source_url": null,
    "subtotal_price": "199.00",
    "taxes_included": false,
    "test": false,
    "token": "9d07439c215af45d51dabf3b45c27dd0",
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "total_price": "199.00",
    "total_price_usd": "199.00",
    "total_tax": "0.00",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:36-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "processing_method": "",
    "source": "755357713",
    "checkout_id": null,
    "source_name": "755357713",
    "tax_lines": [
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": "fulfilled",
        "gift_card": false,
        "grams": 200,
        "id": 1071823174,
        "price": "199.00",
        "product_id": 921728736,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2009BLACK",
        "taxable": true,
        "title": "IPod Touch 8GB",
        "variant_id": 447654529,
        "variant_title": "Black",
        "vendor": null,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:30:36-04:00",
        "id": 1022782903,
        "order_id": 1073459964,
        "service": "manual",
        "status": "success",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:30:36-04:00",
        "tracking_number": null,
        "tracking_numbers": [
        ],
        "tracking_url": null,
        "tracking_urls": [
        ],
        "receipt": {},
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": "fulfilled",
            "gift_card": false,
            "grams": 200,
            "id": 1071823174,
            "price": "199.00",
            "product_id": 921728736,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2009BLACK",
            "taxable": true,
            "title": "IPod Touch 8GB",
            "variant_id": 447654529,
            "variant_title": "Black",
            "vendor": null,
            "name": "IPod Touch 8GB - Black",
            "variant_inventory_management": "haravan",
            "properties": [
            ],
            "product_exists": true,
            "fulfillable_quantity": 0,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "refunds": [
    ],
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:30:37-04:00",
      "email": "foo@example.com",
      "first_name": null,
      "id": 1018520260,
      "last_name": null,
      "last_order_id": 1073459964,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "0.00",
      "updated_at": "2015-03-28T13:30:37-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1002"
    }
  }
}

Create a more comprehensive order

POST /com/orders.json
{
  "order": {
    "line_items": [
      {
        "title": "Big Brown Bear Boots",
        "price": 74.99,
        "grams": "1300",
        "quantity": 3
      }
    ],
    "tax_lines": [
      {
        "price": 13.5,
        "rate": 0.06,
        "title": "State tax"
      }
    ],
    "transactions": [
      {
        "kind": "sale",
        "status": "success",
        "amount": 238.47
      }
    ],
    "total_tax": 13.5,
    "currency": "EUR"
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": null,
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2015-03-28T13:30:37-04:00",
    "currency": "EUR",
    "device_id": null,
    "email": "",
    "financial_status": "paid",
    "fulfillment_status": null,
    "gateway": "",
    "id": 1073459965,
    "landing_site": null,
    "location_id": null,
    "name": "#1002",
    "note": null,
    "number": 2,
    "processed_at": "2015-03-28T13:30:37-04:00",
    "reference": null,
    "referring_site": null,
    "source_identifier": null,
    "source_url": null,
    "subtotal_price": "224.97",
    "taxes_included": false,
    "test": false,
    "token": "605e8ec1d27412a0220f5f8fb474f3f9",
    "total_discounts": "0.00",
    "total_line_items_price": "224.97",
    "total_price": "238.47",
    "total_price_usd": "340.54",
    "total_tax": "13.50",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:37-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "processing_method": "",
    "source": "755357713",
    "checkout_id": null,
    "source_name": "755357713",
    "tax_lines": [
      {
        "price": "13.50",
        "rate": 0.06,
        "title": "State tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 1300,
        "id": 1071823175,
        "price": "74.99",
        "product_id": null,
        "quantity": 3,
        "requires_shipping": true,
        "sku": null,
        "taxable": true,
        "title": "Big Brown Bear Boots",
        "variant_id": null,
        "variant_title": null,
        "vendor": null,
        "name": "Big Brown Bear Boots",
        "variant_inventory_management": null,
        "properties": [
        ],
        "product_exists": false,
        "fulfillable_quantity": 3,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ]
  }
}

Create a pending order with an existing customer

POST /com/orders.json
{
  "order": {
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ],
    "customer": {
      "id": 207119551
    },
    "financial_status": "pending"
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": null,
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2015-03-28T13:30:37-04:00",
    "currency": "USD",
    "device_id": null,
    "email": "",
    "financial_status": "pending",
    "fulfillment_status": null,
    "gateway": "",
    "id": 1073459966,
    "landing_site": null,
    "location_id": null,
    "name": "#1002",
    "note": null,
    "number": 2,
    "processed_at": "2015-03-28T13:30:37-04:00",
    "reference": null,
    "referring_site": null,
    "source_identifier": null,
    "source_url": null,
    "subtotal_price": "199.00",
    "taxes_included": false,
    "test": false,
    "token": "f5694049c22ac820ca057fe7b7ed950c",
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "total_price": "199.00",
    "total_price_usd": "199.00",
    "total_tax": "0.00",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:37-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "processing_method": "",
    "source": "755357713",
    "checkout_id": null,
    "source_name": "755357713",
    "tax_lines": [
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 1071823176,
        "price": "199.00",
        "product_id": 921728736,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2009BLACK",
        "taxable": true,
        "title": "IPod Touch 8GB",
        "variant_id": 447654529,
        "variant_title": "Black",
        "vendor": null,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ],
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 1073459966,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 2,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:37-04:00",
      "verified_email": false,
      "tags": "",
      "last_order_name": "#1002",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Create a partially paid order with a new customer and addresses

POST /com/orders.json
{
  "order": {
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ],
    "customer": {
      "first_name": "Paul",
      "last_name": "Norman",
      "email": "paul.norman@example.com"
    },
    "billing_address": {
      "first_name": "John",
      "last_name": "Smith",
      "address1": "123 Fake Street",
      "phone": "555-555-5555",
      "city": "Fakecity",
      "province": "Ontario",
      "country": "Canada",
      "zip": "H0H0H0"
    },
    "shipping_address": {
      "first_name": "Jane",
      "last_name": "Smith",
      "address1": "123 Fake Street",
      "phone": "777-777-7777",
      "city": "Fakecity",
      "province": "Ontario",
      "country": "Canada",
      "zip": "H0H0H0"
    },
    "email": "jane@example.com",
    "transactions": [
      {
        "kind": "authorization",
        "status": "success",
        "amount": 50.0
      }
    ],
    "financial_status": "partially_paid"
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": null,
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2015-03-28T13:30:38-04:00",
    "currency": "USD",
    "device_id": null,
    "email": "jane@example.com",
    "financial_status": "partially_paid",
    "fulfillment_status": null,
    "gateway": "",
    "id": 1073459967,
    "landing_site": null,
    "location_id": null,
    "name": "#1002",
    "note": null,
    "number": 2,
    "processed_at": "2015-03-28T13:30:38-04:00",
    "reference": null,
    "referring_site": null,
    "source_identifier": null,
    "source_url": null,
    "subtotal_price": "199.00",
    "taxes_included": false,
    "test": false,
    "token": "2f33a9724f3b95ca6c4eac47f8936fbe",
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "total_price": "199.00",
    "total_price_usd": "199.00",
    "total_tax": "0.00",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:38-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "processing_method": "",
    "source": "755357713",
    "checkout_id": null,
    "source_name": "755357713",
    "tax_lines": [
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 1071823177,
        "price": "199.00",
        "product_id": 921728736,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2009BLACK",
        "taxable": true,
        "title": "IPod Touch 8GB",
        "variant_id": 447654529,
        "variant_title": "Black",
        "vendor": null,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "billing_address": {
      "address1": "123 Fake Street",
      "address2": null,
      "city": "Fakecity",
      "company": null,
      "country": "Canada",
      "first_name": "John",
      "last_name": "Smith",
      "latitude": null,
      "longitude": null,
      "phone": "555-555-5555",
      "province": "Ontario",
      "zip": "H0H0H0",
      "name": "John Smith",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Fake Street",
      "address2": null,
      "city": "Fakecity",
      "company": null,
      "country": "Canada",
      "first_name": "Jane",
      "last_name": "Smith",
      "latitude": null,
      "longitude": null,
      "phone": "777-777-7777",
      "province": "Ontario",
      "zip": "H0H0H0",
      "name": "Jane Smith",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
    ],
    "refunds": [
    ],
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:30:38-04:00",
      "email": "paul.norman@example.com",
      "first_name": "John",
      "id": 1018520261,
      "last_name": "Smith",
      "last_order_id": 1073459967,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "0.00",
      "updated_at": "2015-03-28T13:30:38-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1002",
      "default_address": {
        "address1": "123 Fake Street",
        "address2": null,
        "city": "Fakecity",
        "company": null,
        "country": "Canada",
        "first_name": "Jane",
        "id": 1053317308,
        "last_name": "Smith",
        "phone": "777-777-7777",
        "province": "Ontario",
        "zip": "H0H0H0",
        "name": "Jane Smith",
        "province_code": "ON",
        "country_code": "CA",
        "country_name": "Canada",
        "default": true
      }
    }
  }
}
PUT/com/orders/450789469.json

Change an order’s attributes such as note, email, buyer-accepts-marketing, or remove the customer association


Add Note to order

PUT /com/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "note": "Customer contacted us about a custom engraving on this iPod"
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": "Customer contacted us about a custom engraving on this iPod",
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:42-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:42-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Set Note Attributes on an order

PUT /com/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "note_attributes": [
      {
        "name": "colour",
        "value": "red"
      }
    ]
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:43-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "colour",
        "value": "red"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:43-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Change an order’s email

PUT /com/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "email": "a-different@email.com"
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "a-different@email.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:44-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:44-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Change an order so that its buyer accepts marketing

PUT /com/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "buyer_accepts_marketing": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": true,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:44-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:44-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Add a metafield to an existing order

PUT /com/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "metafields": [
      {
        "key": "new",
        "value": "newvalue",
        "value_type": "string",
        "namespace": "global"
      }
    ]
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:45-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "accepts_marketing": false,
      "created_at": "2015-03-28T13:29:45-04:00",
      "email": "bob.norman@hostmail.com",
      "first_name": "Bob",
      "id": 207119551,
      "last_name": "Norman",
      "last_order_id": 450789469,
      "multipass_identifier": null,
      "note": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "updated_at": "2015-03-28T13:30:45-04:00",
      "verified_email": true,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "company": null,
        "country": "United States",
        "first_name": null,
        "id": 207119551,
        "last_name": null,
        "phone": "555-625-1199",
        "province": "Kentucky",
        "zip": "40202",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Remove customer from an order

PUT /com/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "customer": null
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "buyer_accepts_marketing": false,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "checkout_token": null,
    "closed_at": null,
    "confirmed": true,
    "created_at": "2008-01-10T11:00:00-05:00",
    "currency": "USD",
    "device_id": null,
    "email": "bob.norman@hostmail.com",
    "financial_status": "authorized",
    "fulfillment_status": null,
    "gateway": "authorize_net",
    "id": 450789469,
    "landing_site": "http:\/\/www.example.com?source=abc",
    "location_id": null,
    "name": "#1001",
    "note": null,
    "number": 1,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "reference": "fhwdgads",
    "referring_site": "http:\/\/www.otherexample.com",
    "source_identifier": "fhwdgads",
    "source_url": null,
    "subtotal_price": "398.00",
    "taxes_included": false,
    "test": false,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "total_price": "409.94",
    "total_price_usd": "409.94",
    "total_tax": "11.94",
    "total_weight": 0,
    "updated_at": "2015-03-28T13:30:45-04:00",
    "user_id": null,
    "browser_ip": null,
    "landing_site_ref": "abc",
    "order_number": 1001,
    "discount_codes": [
      {
        "code": "TENOFF",
        "amount": "10.00",
        "type": "percentage"
      }
    ],
    "note_attributes": [
      {
        "name": "custom engraving",
        "value": "Happy Birthday"
      },
      {
        "name": "colour",
        "value": "green"
      }
    ],
    "processing_method": "direct",
    "source": "browser",
    "checkout_id": 450789469,
    "source_name": "web",
    "tax_lines": [
      {
        "price": "11.94",
        "rate": 0.06,
        "title": "State Tax"
      }
    ],
    "tags": "",
    "line_items": [
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 466157049,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 39072856,
        "variant_title": "green",
        "vendor": null,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "haravan",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 518995019,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 49148385,
        "variant_title": "red",
        "vendor": null,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      },
      {
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 200,
        "id": 703073504,
        "price": "199.00",
        "product_id": 632910392,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "taxable": true,
        "title": "IPod Nano - 8gb",
        "variant_id": 457924702,
        "variant_title": "black",
        "vendor": null,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "haravan",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
      {
        "code": "Free Shipping",
        "price": "0.00",
        "source": "haravan",
        "title": "Free Shipping",
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "address1": "123 Amoebobacterieae St",
      "address2": "",
      "city": "Ottawa",
      "company": "",
      "country": "Canada",
      "first_name": "Bob",
      "last_name": "Bobsen",
      "latitude": 45.41634,
      "longitude": -75.6868,
      "phone": "(555)555-5555",
      "province": "Ontario",
      "zip": "K2P0V6",
      "name": "Bob Bobsen",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "service": "manual",
        "status": "failure",
        "tracking_company": null,
        "updated_at": "2015-03-28T13:29:45-04:00",
        "tracking_number": "1Z2345",
        "tracking_numbers": [
          "1Z2345"
        ],
        "tracking_url": "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track",
        "tracking_urls": [
          "http:\/\/wwwapps.ups.com\/etracking\/tracking.cgi?InquiryNumber1=1Z2345&TypeOfInquiryNumber=T&AcceptUPSLicenseAgreement=yes&submit=Track"
        ],
        "receipt": {
          "testcase": true,
          "authorization": "123456"
        },
        "line_items": [
          {
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 200,
            "id": 466157049,
            "price": "199.00",
            "product_id": 632910392,
            "quantity": 1,
            "requires_shipping": true,
            "sku": "IPOD2008GREEN",
            "taxable": true,
            "title": "IPod Nano - 8gb",
            "variant_id": 39072856,
            "variant_title": "green",
            "vendor": null,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "haravan",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 1,
            "total_discount": "0.00",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "client_details": {
      "accept_language": null,
      "browser_height": null,
      "browser_ip": "0.0.0.0",
      "browser_width": null,
      "session_hash": null,
      "user_agent": null
    },
    "refunds": [
      {
        "created_at": "2015-03-28T13:29:45-04:00",
        "id": 509562969,
        "note": "it broke during shipping",
        "order_id": 450789469,
        "restock": true,
        "user_id": 799407056,
        "refund_line_items": [
          {
            "id": 104689539,
            "line_item_id": 703073504,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 703073504,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008BLACK",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 457924702,
              "variant_title": "black",
              "vendor": null,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "haravan",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          },
          {
            "id": 709875399,
            "line_item_id": 466157049,
            "quantity": 1,
            "line_item": {
              "fulfillment_service": "manual",
              "fulfillment_status": null,
              "gift_card": false,
              "grams": 200,
              "id": 466157049,
              "price": "199.00",
              "product_id": 632910392,
              "quantity": 1,
              "requires_shipping": true,
              "sku": "IPOD2008GREEN",
              "taxable": true,
              "title": "IPod Nano - 8gb",
              "variant_id": 39072856,
              "variant_title": "green",
              "vendor": null,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "haravan",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "tax_lines": [
              ]
            }
          }
        ],
        "transactions": [
          {
            "amount": "209.00",
            "authorization": "authorization-key",
            "created_at": "2005-08-05T12:59:12-04:00",
            "currency": "USD",
            "gateway": "bogus",
            "id": 179259969,
            "kind": "refund",
            "location_id": null,
            "message": null,
            "order_id": 450789469,
            "parent_id": null,
            "status": "success",
            "test": false,
            "user_id": null,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ]
      }
    ],
    "payment_details": {
      "avs_result_code": null,
      "credit_card_bin": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    }
  }
}
DELETE/com/orders/450789469.json

Delete an order


Permanently delete an order

DELETE /com/orders/#{id}.json
View Response
HTTP/1.1 200 OK
{}