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 or phone number, billing address and payment information.

Order

Orders can also be created manually from the Shopify admin. Manually created orders can be given any payment status, and payment can be accepted by entering the customer's payment details or sending them an email containing a link to the order's checkout.

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.

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 Shopify POS will not necessarily have customer information attached to them.

If you wish to create a refund, please see the Refund API.

What you can do with Order

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

Order properties

billing_address
"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
  }
]

The mailing address associated with the payment method. This address is an optional field that will not be available on orders that do not require one. It has the following properties:

  • address1: The street address of the billing address.
  • address2: An optional additional field for the street address of the billing address.
  • city: The city of the billing address.
  • company: The company of the person associated with the billing address.
  • country: The name of the country of the billing address.
  • country_code: The two-letter code (ISO 3166-1 alpha-2 two-letter country code) for the country of the billing 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 billing address.
  • longitude: The longitude of the billing address.
  • name: The full name of the person associated with the payment method.
  • phone: The phone number at the billing address.
  • province: The name of the state or province of the billing address.
  • province_code: The two-letter abbreviation of the state or province of the billing address.
  • zip:The zip or postal code of the billing address.

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
"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"

This auto-generated property is the date and time when the order was created in Shopify, in ISO 8601 format.

currency
"currency": "USD"

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

customer
"customer": [
  {
    "accepts_marketing": false,
    "created_at": "2012-03-13T16:09:55-04:00",
    "email": "bob.norman@hostmail.com",
    "phone": "+13125551212",
    "first_name": "Bob",
    "id": 207119551,
    "last_name": "Norman",
    "note": 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 existence of a customer object. This value may be null if the order was created through Shopify 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.
  • phone: The customer's phone number.
  • first_name: The customer's first name.
  • 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. The type field determines the unit of this amount.
  • code: The discount code.
  • type: The type of discount. Valid values are:
    • fixed_amount: The default value. Applies a discount of amount as a unit of the store's currency. For example, if amount is 30 and the store's currency is USD, then 30 USD is deducted from the order total when the discount is applied.
    • percentage: Applies a percentage discount of amount. For example, if amount is 30, then 30% of the order total will be deducted when the discount is applied.
    • shipping: Applies a free shipping discount on orders that have a shipping rate less than or equal to amount. For example, if amount is 30, the discount will give the customer free shipping for any shipping rate that is less than or equal to $30.

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

The customer's email address.

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
"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
"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,
    "properties": [
      {
        "name": "custom engraving",
"value": "Happy Birthday Mom!"
      }
    ],
    "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 - open_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 whether or not the line_item is a gift card. If so, the item is not taxed or considered for shipping charges.
  • properties: An array of custom information for an item that has been added to the cart. Often used to provide product customization options. For more information, see the documentation on collecting customization information on the product page.
  • 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.

location_id
"location_id": 49202758

Only present on orders processed at point of sale. The unique numeric identifier for the physical location at which the order was processed.

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
"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.

payment_gateway_names
"payment_gateway_names": ["authorize_net","Cash on Delivery (COD)"]

The list of all payment gateways used for the order.

phone
"phone": "+557734881234"

The customer's phone number.

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 based on the current date and time in Shopify.

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.

refunds

The list of refunds applied to the order.

shipping_address
"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
"shipping_lines": [
  {
    "code": "Free Shipping",
    "price": 0.0,
    "source": "shopify",
    "title": "Free Shipping",
    "tax_lines": [
      {
      }
    ],
    "carrier_identifier": "third_party_carrier_identifier",
    "requested_fulfillment_service_id": "third_party_fulfillment_service_id"
  }
]

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.
  • carrier_identifier: A reference to the carrier service that provided the rate. Present if the rate was computed by a third party carrier service; null otherwise.
  • requested_fulfillment_service_id: A reference to the fulfillment service that is being requested for the shipping method. Present if shipping method requires processing by a third party fulfillment service; null otherwise.

source_name
"source_name": "web"

Where the order originated. May only be set during creation, and is not writeable thereafter. Orders created through official Shopify 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
"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.
When creating an order through the API, tax lines may be specified on the order or the line items but not both. Tax lines specified on the order are split on the taxable line items in the created order.

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": 300

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.

user_id
"user_id": 31522279

Only present on orders processed at point of sale. The unique numerical identifier for the user logged into the terminal at the time the order was processed at.

order_status_url
"order_status_url": "https://checkout.shopify.com/112233/checkouts/4207896aad57dfb159/thank_you_token?key=753621327b9e8a64789651bf221dfe35"

The URL pointing to the order status web page. The URL will be null unless the order was created from a checkout.

Endpoints

GET /admin/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

(default: 50) (maximum: 250)
page

Page to show

(default: 1)
since_id

Restrict results to after the specified ID

created_at_min

Show orders created after date (format: 2014-04-25T16:15:47-04:00)

created_at_max

Show orders created before date (format: 2014-04-25T16:15:47-04:00)

updated_at_min

Show orders last updated after date (format: 2014-04-25T16:15:47-04:00)

updated_at_max

Show orders last updated before date (format: 2014-04-25T16:15:47-04:00)

processed_at_min

Show orders imported after date (format: 2014-04-25T16:15:47-04:00)

processed_at_max

Show orders imported before date (format: 2014-04-25T16:15:47-04:00)

status
  • open - All open orders (default)
  • closed - Show only closed orders
  • cancelled - Show only cancelled orders
  • any - Any order status
financial_status
  • authorized - Show only authorized orders
  • pending - Show only pending orders
  • paid - Show only paid orders
  • partially_paid - Show only partially paid orders
  • refunded - Show only refunded orders
  • voided - Show only voided orders
  • partially_refunded - Show only partially_refunded orders
  • any - Show all authorized, pending, and paid orders (default). This is a filter, not a value.
  • unpaid - Show all authorized, or partially_paid orders. This is a filter, not a value.
fulfillment_status
  • shipped - Show orders that have been shipped
  • partial - Show partially shipped orders
  • unshipped - Show orders that have not yet been shipped
  • any - Show orders with any fulfillment_status. (default)
fields

comma-separated list of fields to include in the response

List orders which are authorized and ready to be captured.

GET /admin/orders.json?financial_status=authorized
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "id": 450789469,
      "email": "bob.norman@hostmail.com",
      "closed_at": null,
      "created_at": "2008-01-10T11:00:00-05:00",
      "updated_at": "2008-01-10T11:00:00-05:00",
      "number": 1,
      "note": null,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "gateway": "authorize_net",
      "test": false,
      "total_price": "409.94",
      "subtotal_price": "398.00",
      "total_weight": 0,
      "total_tax": "11.94",
      "taxes_included": false,
      "currency": "USD",
      "financial_status": "authorized",
      "confirmed": false,
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "buyer_accepts_marketing": false,
      "name": "#1001",
      "referring_site": "http:\/\/www.otherexample.com",
      "landing_site": "http:\/\/www.example.com?source=abc",
      "cancelled_at": null,
      "cancel_reason": null,
      "total_price_usd": "409.94",
      "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
      "reference": "fhwdgads",
      "user_id": null,
      "location_id": null,
      "source_identifier": "fhwdgads",
      "source_url": null,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "device_id": null,
      "phone": "+557734881234",
      "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"
        }
      ],
      "payment_gateway_names": [
        "bogus"
      ],
      "processing_method": "direct",
      "checkout_id": 901414060,
      "source_name": "web",
      "fulfillment_status": null,
      "tax_lines": [
        {
          "title": "State Tax",
          "price": "11.94",
          "rate": 0.06
        }
      ],
      "tags": "",
      "contact_email": "bob.norman@hostmail.com",
      "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
      "line_items": [
        {
          "id": 466157049,
          "variant_id": 39072856,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008GREEN",
          "variant_title": "green",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "shopify",
          "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",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 518995019,
          "variant_id": 49148385,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008RED",
          "variant_title": "red",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 703073504,
          "variant_id": 457924702,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008BLACK",
          "variant_title": "black",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        }
      ],
      "shipping_lines": [
        {
          "id": 369256396,
          "title": "Free Shipping",
          "price": "0.00",
          "code": "Free Shipping",
          "source": "shopify",
          "phone": null,
          "requested_fulfillment_service_id": null,
          "delivery_category": null,
          "carrier_identifier": null,
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "shipping_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "fulfillments": [
        {
          "id": 255858046,
          "order_id": 450789469,
          "status": "failure",
          "created_at": "2017-06-13T18:20:28-04:00",
          "service": "manual",
          "updated_at": "2017-06-13T18:20:28-04:00",
          "tracking_company": null,
          "shipment_status": null,
          "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": [
            {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          ]
        }
      ],
      "client_details": {
        "browser_ip": "0.0.0.0",
        "accept_language": null,
        "user_agent": null,
        "session_hash": null,
        "browser_width": null,
        "browser_height": null
      },
      "refunds": [
        {
          "id": 509562969,
          "order_id": 450789469,
          "created_at": "2017-06-13T18:20:28-04:00",
          "note": "it broke during shipping",
          "restock": true,
          "user_id": 799407056,
          "processed_at": "2017-06-13T18:20:28-04:00",
          "refund_line_items": [
            {
              "id": 104689539,
              "quantity": 1,
              "line_item_id": 703073504,
              "subtotal": 195.67,
              "total_tax": 3.98,
              "line_item": {
                "id": 703073504,
                "variant_id": 457924702,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008BLACK",
                "variant_title": "black",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "shopify",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            },
            {
              "id": 709875399,
              "quantity": 1,
              "line_item_id": 466157049,
              "subtotal": 195.66,
              "total_tax": 3.98,
              "line_item": {
                "id": 466157049,
                "variant_id": 39072856,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008GREEN",
                "variant_title": "green",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "shopify",
                "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",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            }
          ],
          "transactions": [
            {
              "id": 179259969,
              "order_id": 450789469,
              "amount": "209.00",
              "kind": "refund",
              "gateway": "bogus",
              "status": "success",
              "message": null,
              "created_at": "2005-08-05T12:59:12-04:00",
              "test": false,
              "authorization": "authorization-key",
              "currency": "USD",
              "location_id": null,
              "user_id": null,
              "parent_id": 801038806,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ],
          "order_adjustments": [
          ]
        }
      ],
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "id": 207119551,
        "email": "bob.norman@hostmail.com",
        "accepts_marketing": false,
        "created_at": "2017-06-13T18:20:28-04:00",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "first_name": "Bob",
        "last_name": "Norman",
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "last_order_id": 450789469,
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "phone": null,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "id": 207119551,
          "first_name": null,
          "last_name": null,
          "company": null,
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "province": "Kentucky",
          "country": "United States",
          "zip": "40202",
          "phone": "555-625-1199",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}

List all orders

GET /admin/orders.json
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "id": 450789469,
      "email": "bob.norman@hostmail.com",
      "closed_at": null,
      "created_at": "2008-01-10T11:00:00-05:00",
      "updated_at": "2008-01-10T11:00:00-05:00",
      "number": 1,
      "note": null,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "gateway": "authorize_net",
      "test": false,
      "total_price": "409.94",
      "subtotal_price": "398.00",
      "total_weight": 0,
      "total_tax": "11.94",
      "taxes_included": false,
      "currency": "USD",
      "financial_status": "authorized",
      "confirmed": false,
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "buyer_accepts_marketing": false,
      "name": "#1001",
      "referring_site": "http:\/\/www.otherexample.com",
      "landing_site": "http:\/\/www.example.com?source=abc",
      "cancelled_at": null,
      "cancel_reason": null,
      "total_price_usd": "409.94",
      "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
      "reference": "fhwdgads",
      "user_id": null,
      "location_id": null,
      "source_identifier": "fhwdgads",
      "source_url": null,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "device_id": null,
      "phone": "+557734881234",
      "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"
        }
      ],
      "payment_gateway_names": [
        "bogus"
      ],
      "processing_method": "direct",
      "checkout_id": 901414060,
      "source_name": "web",
      "fulfillment_status": null,
      "tax_lines": [
        {
          "title": "State Tax",
          "price": "11.94",
          "rate": 0.06
        }
      ],
      "tags": "",
      "contact_email": "bob.norman@hostmail.com",
      "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
      "line_items": [
        {
          "id": 466157049,
          "variant_id": 39072856,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008GREEN",
          "variant_title": "green",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "shopify",
          "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",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 518995019,
          "variant_id": 49148385,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008RED",
          "variant_title": "red",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 703073504,
          "variant_id": 457924702,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008BLACK",
          "variant_title": "black",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        }
      ],
      "shipping_lines": [
        {
          "id": 369256396,
          "title": "Free Shipping",
          "price": "0.00",
          "code": "Free Shipping",
          "source": "shopify",
          "phone": null,
          "requested_fulfillment_service_id": null,
          "delivery_category": null,
          "carrier_identifier": null,
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "shipping_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "fulfillments": [
        {
          "id": 255858046,
          "order_id": 450789469,
          "status": "failure",
          "created_at": "2017-06-13T18:20:28-04:00",
          "service": "manual",
          "updated_at": "2017-06-13T18:20:28-04:00",
          "tracking_company": null,
          "shipment_status": null,
          "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": [
            {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          ]
        }
      ],
      "client_details": {
        "browser_ip": "0.0.0.0",
        "accept_language": null,
        "user_agent": null,
        "session_hash": null,
        "browser_width": null,
        "browser_height": null
      },
      "refunds": [
        {
          "id": 509562969,
          "order_id": 450789469,
          "created_at": "2017-06-13T18:20:28-04:00",
          "note": "it broke during shipping",
          "restock": true,
          "user_id": 799407056,
          "processed_at": "2017-06-13T18:20:28-04:00",
          "refund_line_items": [
            {
              "id": 104689539,
              "quantity": 1,
              "line_item_id": 703073504,
              "subtotal": 195.67,
              "total_tax": 3.98,
              "line_item": {
                "id": 703073504,
                "variant_id": 457924702,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008BLACK",
                "variant_title": "black",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "shopify",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            },
            {
              "id": 709875399,
              "quantity": 1,
              "line_item_id": 466157049,
              "subtotal": 195.66,
              "total_tax": 3.98,
              "line_item": {
                "id": 466157049,
                "variant_id": 39072856,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008GREEN",
                "variant_title": "green",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "shopify",
                "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",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            }
          ],
          "transactions": [
            {
              "id": 179259969,
              "order_id": 450789469,
              "amount": "209.00",
              "kind": "refund",
              "gateway": "bogus",
              "status": "success",
              "message": null,
              "created_at": "2005-08-05T12:59:12-04:00",
              "test": false,
              "authorization": "authorization-key",
              "currency": "USD",
              "location_id": null,
              "user_id": null,
              "parent_id": 801038806,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ],
          "order_adjustments": [
          ]
        }
      ],
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "id": 207119551,
        "email": "bob.norman@hostmail.com",
        "accepts_marketing": false,
        "created_at": "2017-06-13T18:20:28-04:00",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "first_name": "Bob",
        "last_name": "Norman",
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "last_order_id": 450789469,
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "phone": null,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "id": 207119551,
          "first_name": null,
          "last_name": null,
          "company": null,
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "province": "Kentucky",
          "country": "United States",
          "zip": "40202",
          "phone": "555-625-1199",
          "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 /admin/orders.json?updated_at_min=2005-07-31 15:57:11 EDT -04:00
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "id": 450789469,
      "email": "bob.norman@hostmail.com",
      "closed_at": null,
      "created_at": "2008-01-10T11:00:00-05:00",
      "updated_at": "2008-01-10T11:00:00-05:00",
      "number": 1,
      "note": null,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "gateway": "authorize_net",
      "test": false,
      "total_price": "409.94",
      "subtotal_price": "398.00",
      "total_weight": 0,
      "total_tax": "11.94",
      "taxes_included": false,
      "currency": "USD",
      "financial_status": "authorized",
      "confirmed": false,
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "buyer_accepts_marketing": false,
      "name": "#1001",
      "referring_site": "http:\/\/www.otherexample.com",
      "landing_site": "http:\/\/www.example.com?source=abc",
      "cancelled_at": null,
      "cancel_reason": null,
      "total_price_usd": "409.94",
      "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
      "reference": "fhwdgads",
      "user_id": null,
      "location_id": null,
      "source_identifier": "fhwdgads",
      "source_url": null,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "device_id": null,
      "phone": "+557734881234",
      "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"
        }
      ],
      "payment_gateway_names": [
        "bogus"
      ],
      "processing_method": "direct",
      "checkout_id": 901414060,
      "source_name": "web",
      "fulfillment_status": null,
      "tax_lines": [
        {
          "title": "State Tax",
          "price": "11.94",
          "rate": 0.06
        }
      ],
      "tags": "",
      "contact_email": "bob.norman@hostmail.com",
      "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
      "line_items": [
        {
          "id": 466157049,
          "variant_id": 39072856,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008GREEN",
          "variant_title": "green",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "shopify",
          "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",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 518995019,
          "variant_id": 49148385,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008RED",
          "variant_title": "red",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 703073504,
          "variant_id": 457924702,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008BLACK",
          "variant_title": "black",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        }
      ],
      "shipping_lines": [
        {
          "id": 369256396,
          "title": "Free Shipping",
          "price": "0.00",
          "code": "Free Shipping",
          "source": "shopify",
          "phone": null,
          "requested_fulfillment_service_id": null,
          "delivery_category": null,
          "carrier_identifier": null,
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "shipping_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "fulfillments": [
        {
          "id": 255858046,
          "order_id": 450789469,
          "status": "failure",
          "created_at": "2017-06-13T18:20:28-04:00",
          "service": "manual",
          "updated_at": "2017-06-13T18:20:28-04:00",
          "tracking_company": null,
          "shipment_status": null,
          "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": [
            {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          ]
        }
      ],
      "client_details": {
        "browser_ip": "0.0.0.0",
        "accept_language": null,
        "user_agent": null,
        "session_hash": null,
        "browser_width": null,
        "browser_height": null
      },
      "refunds": [
        {
          "id": 509562969,
          "order_id": 450789469,
          "created_at": "2017-06-13T18:20:28-04:00",
          "note": "it broke during shipping",
          "restock": true,
          "user_id": 799407056,
          "processed_at": "2017-06-13T18:20:28-04:00",
          "refund_line_items": [
            {
              "id": 104689539,
              "quantity": 1,
              "line_item_id": 703073504,
              "subtotal": 195.67,
              "total_tax": 3.98,
              "line_item": {
                "id": 703073504,
                "variant_id": 457924702,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008BLACK",
                "variant_title": "black",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "shopify",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            },
            {
              "id": 709875399,
              "quantity": 1,
              "line_item_id": 466157049,
              "subtotal": 195.66,
              "total_tax": 3.98,
              "line_item": {
                "id": 466157049,
                "variant_id": 39072856,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008GREEN",
                "variant_title": "green",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "shopify",
                "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",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            }
          ],
          "transactions": [
            {
              "id": 179259969,
              "order_id": 450789469,
              "amount": "209.00",
              "kind": "refund",
              "gateway": "bogus",
              "status": "success",
              "message": null,
              "created_at": "2005-08-05T12:59:12-04:00",
              "test": false,
              "authorization": "authorization-key",
              "currency": "USD",
              "location_id": null,
              "user_id": null,
              "parent_id": 801038806,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ],
          "order_adjustments": [
          ]
        }
      ],
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "id": 207119551,
        "email": "bob.norman@hostmail.com",
        "accepts_marketing": false,
        "created_at": "2017-06-13T18:20:28-04:00",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "first_name": "Bob",
        "last_name": "Norman",
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "last_order_id": 450789469,
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "phone": null,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "id": 207119551,
          "first_name": null,
          "last_name": null,
          "company": null,
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "province": "Kentucky",
          "country": "United States",
          "zip": "40202",
          "phone": "555-625-1199",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}

List of specific orders

GET /admin/orders.json?ids=1073459968
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "id": 1073459968,
      "email": "",
      "closed_at": null,
      "created_at": "2017-06-13T18:29:27-04:00",
      "updated_at": "2017-06-13T18:29:27-04:00",
      "number": 2,
      "note": null,
      "token": "32192a4077305c07719ba561b6885bf6",
      "gateway": "",
      "test": false,
      "total_price": "199.00",
      "subtotal_price": "199.00",
      "total_weight": null,
      "total_tax": "0.00",
      "taxes_included": false,
      "currency": "USD",
      "financial_status": "paid",
      "confirmed": true,
      "total_discounts": "0.00",
      "total_line_items_price": "199.00",
      "cart_token": null,
      "buyer_accepts_marketing": false,
      "name": "#1002",
      "referring_site": null,
      "landing_site": null,
      "cancelled_at": null,
      "cancel_reason": null,
      "total_price_usd": "199.00",
      "checkout_token": null,
      "reference": null,
      "user_id": null,
      "location_id": null,
      "source_identifier": null,
      "source_url": null,
      "processed_at": "2017-06-13T18:29:27-04:00",
      "device_id": null,
      "phone": null,
      "browser_ip": null,
      "landing_site_ref": null,
      "order_number": 1002,
      "discount_codes": [
      ],
      "note_attributes": [
      ],
      "payment_gateway_names": [
      ],
      "processing_method": "",
      "checkout_id": null,
      "source_name": "755357713",
      "fulfillment_status": null,
      "tax_lines": [
      ],
      "tags": "",
      "contact_email": null,
      "order_status_url": null,
      "line_items": [
        {
          "id": 1071823176,
          "variant_id": 447654529,
          "title": "IPod Touch 8GB",
          "quantity": 1,
          "price": "199.00",
          "grams": 567,
          "sku": "IPOD2009BLACK",
          "variant_title": "Black",
          "vendor": "Apple",
          "fulfillment_service": "manual",
          "product_id": 921728736,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Touch 8GB - Black",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
          ]
        }
      ],
      "shipping_lines": [
      ],
      "fulfillments": [
      ],
      "refunds": [
      ]
    }
  ]
}

List all orders, showing only some attributes

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

List all orders after the specified ID

GET /admin/orders.json?since_id=123
View Response
HTTP/1.1 200 OK
{
  "orders": [
    {
      "id": 450789469,
      "email": "bob.norman@hostmail.com",
      "closed_at": null,
      "created_at": "2008-01-10T11:00:00-05:00",
      "updated_at": "2008-01-10T11:00:00-05:00",
      "number": 1,
      "note": null,
      "token": "b1946ac92492d2347c6235b4d2611184",
      "gateway": "authorize_net",
      "test": false,
      "total_price": "409.94",
      "subtotal_price": "398.00",
      "total_weight": 0,
      "total_tax": "11.94",
      "taxes_included": false,
      "currency": "USD",
      "financial_status": "authorized",
      "confirmed": false,
      "total_discounts": "0.00",
      "total_line_items_price": "398.00",
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "buyer_accepts_marketing": false,
      "name": "#1001",
      "referring_site": "http:\/\/www.otherexample.com",
      "landing_site": "http:\/\/www.example.com?source=abc",
      "cancelled_at": null,
      "cancel_reason": null,
      "total_price_usd": "409.94",
      "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
      "reference": "fhwdgads",
      "user_id": null,
      "location_id": null,
      "source_identifier": "fhwdgads",
      "source_url": null,
      "processed_at": "2008-01-10T11:00:00-05:00",
      "device_id": null,
      "phone": "+557734881234",
      "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"
        }
      ],
      "payment_gateway_names": [
        "bogus"
      ],
      "processing_method": "direct",
      "checkout_id": 901414060,
      "source_name": "web",
      "fulfillment_status": null,
      "tax_lines": [
        {
          "title": "State Tax",
          "price": "11.94",
          "rate": 0.06
        }
      ],
      "tags": "",
      "contact_email": "bob.norman@hostmail.com",
      "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
      "line_items": [
        {
          "id": 466157049,
          "variant_id": 39072856,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008GREEN",
          "variant_title": "green",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - green",
          "variant_inventory_management": "shopify",
          "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",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 518995019,
          "variant_id": 49148385,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008RED",
          "variant_title": "red",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - red",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        },
        {
          "id": 703073504,
          "variant_id": 457924702,
          "title": "IPod Nano - 8gb",
          "quantity": 1,
          "price": "199.00",
          "grams": 200,
          "sku": "IPOD2008BLACK",
          "variant_title": "black",
          "vendor": null,
          "fulfillment_service": "manual",
          "product_id": 632910392,
          "requires_shipping": true,
          "taxable": true,
          "gift_card": false,
          "name": "IPod Nano - 8gb - black",
          "variant_inventory_management": "shopify",
          "properties": [
          ],
          "product_exists": true,
          "fulfillable_quantity": 1,
          "total_discount": "0.00",
          "fulfillment_status": null,
          "tax_lines": [
            {
              "title": "State Tax",
              "price": "3.98",
              "rate": 0.06
            }
          ]
        }
      ],
      "shipping_lines": [
        {
          "id": 369256396,
          "title": "Free Shipping",
          "price": "0.00",
          "code": "Free Shipping",
          "source": "shopify",
          "phone": null,
          "requested_fulfillment_service_id": null,
          "delivery_category": null,
          "carrier_identifier": null,
          "tax_lines": [
          ]
        }
      ],
      "billing_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "shipping_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "555-625-1199",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "fulfillments": [
        {
          "id": 255858046,
          "order_id": 450789469,
          "status": "failure",
          "created_at": "2017-06-13T18:20:28-04:00",
          "service": "manual",
          "updated_at": "2017-06-13T18:20:28-04:00",
          "tracking_company": null,
          "shipment_status": null,
          "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": [
            {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          ]
        }
      ],
      "client_details": {
        "browser_ip": "0.0.0.0",
        "accept_language": null,
        "user_agent": null,
        "session_hash": null,
        "browser_width": null,
        "browser_height": null
      },
      "refunds": [
        {
          "id": 509562969,
          "order_id": 450789469,
          "created_at": "2017-06-13T18:20:28-04:00",
          "note": "it broke during shipping",
          "restock": true,
          "user_id": 799407056,
          "processed_at": "2017-06-13T18:20:28-04:00",
          "refund_line_items": [
            {
              "id": 104689539,
              "quantity": 1,
              "line_item_id": 703073504,
              "subtotal": 195.67,
              "total_tax": 3.98,
              "line_item": {
                "id": 703073504,
                "variant_id": 457924702,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008BLACK",
                "variant_title": "black",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - black",
                "variant_inventory_management": "shopify",
                "properties": [
                ],
                "product_exists": true,
                "fulfillable_quantity": 1,
                "total_discount": "0.00",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            },
            {
              "id": 709875399,
              "quantity": 1,
              "line_item_id": 466157049,
              "subtotal": 195.66,
              "total_tax": 3.98,
              "line_item": {
                "id": 466157049,
                "variant_id": 39072856,
                "title": "IPod Nano - 8gb",
                "quantity": 1,
                "price": "199.00",
                "grams": 200,
                "sku": "IPOD2008GREEN",
                "variant_title": "green",
                "vendor": null,
                "fulfillment_service": "manual",
                "product_id": 632910392,
                "requires_shipping": true,
                "taxable": true,
                "gift_card": false,
                "name": "IPod Nano - 8gb - green",
                "variant_inventory_management": "shopify",
                "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",
                "fulfillment_status": null,
                "tax_lines": [
                  {
                    "title": "State Tax",
                    "price": "3.98",
                    "rate": 0.06
                  }
                ]
              }
            }
          ],
          "transactions": [
            {
              "id": 179259969,
              "order_id": 450789469,
              "amount": "209.00",
              "kind": "refund",
              "gateway": "bogus",
              "status": "success",
              "message": null,
              "created_at": "2005-08-05T12:59:12-04:00",
              "test": false,
              "authorization": "authorization-key",
              "currency": "USD",
              "location_id": null,
              "user_id": null,
              "parent_id": 801038806,
              "device_id": null,
              "receipt": {},
              "error_code": null,
              "source_name": "web"
            }
          ],
          "order_adjustments": [
          ]
        }
      ],
      "payment_details": {
        "credit_card_bin": null,
        "avs_result_code": null,
        "cvv_result_code": null,
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "customer": {
        "id": 207119551,
        "email": "bob.norman@hostmail.com",
        "accepts_marketing": false,
        "created_at": "2017-06-13T18:20:28-04:00",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "first_name": "Bob",
        "last_name": "Norman",
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "41.94",
        "last_order_id": 450789469,
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "phone": null,
        "tags": "",
        "last_order_name": "#1001",
        "default_address": {
          "id": 207119551,
          "first_name": null,
          "last_name": null,
          "company": null,
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "province": "Kentucky",
          "country": "United States",
          "zip": "40202",
          "phone": "555-625-1199",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}
GET /admin/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 /admin/orders/#{id}.json
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2008-01-10T11:00:00-05:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": false,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Get only particular fields

GET /admin/orders/#{id}.json?fields=id,line_items,name,total_price
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "total_price": "409.94",
    "name": "#1001",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ]
  }
}
GET /admin/orders/count.json
Retrieve a count of all the orders
created_at_min

Count orders created after date (format: 2014-04-25T16:15:47-04:00)

created_at_max

Count orders created before date (format: 2014-04-25T16:15:47-04:00)

updated_at_min

Count orders last updated after date (format: 2014-04-25T16:15:47-04:00)

updated_at_max

Count orders last updated before date (format: 2014-04-25T16:15:47-04:00)

status
  • open - Open orders (default)
  • closed - Only closed orders
  • any - Any order status
financial_status
  • authorized - Only authorized orders
  • pending - Only pending orders
  • paid - Only paid orders
  • refunded - Show only refunded orders
  • voided - Show only voided orders
  • any - All authorized, pending, and paid orders (default)
fulfillment_status
  • shipped - Orders that have been shipped
  • partial - Partially shipped orders
  • unshipped - Orders that have not yet been shipped
  • any - Orders with any fulfillment_status. (default)

Count all orders

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

Count orders which are authorized and ready to be captured.

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

Close a processed order

POST /admin/orders/#{id}/close.json
{}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": "2017-06-13T18:29:14-04:00",
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:14-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}
POST /admin/orders/450789469/open.json
Re-open a closed Order

Re-opening a closed Order

POST /admin/orders/#{id}/open.json
{}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:21-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}
POST /admin/orders/450789469/cancel.json
Cancel an Order
amount

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

(default: false)
restock

Restock the items for this order back to your store

(default: false)
reason

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

(default: other)
email

Send an email to the customer notifying them of the cancellation

(default: false)
refund

As specified in the Refund documentation. Required for some more complex refund situations.

(default: false)

If an Order has multiple refundable transactions, attempting to refund an amount less than its net payment without a refund parameter will return an error

POST /admin/orders/#{id}/cancel.json
{
  "note": "Broke in shipping",
  "amount": "109.00"
}
View Response
HTTP/1.1 422 Unprocessable Entity
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:15-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus",
      "gift_card"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  },
  "error": "Refund parameter required to process refund"
}

Canceling and refunding an Order using the amount parameter

POST /admin/orders/#{id}/cancel.json
{
  "note": "Broke in shipping",
  "amount": "10.00"
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:23-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "bogus",
    "test": true,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 0,
            "total_discount": "0.00",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 929361464,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:29:23-04:00",
        "note": null,
        "restock": null,
        "user_id": null,
        "processed_at": "2017-06-13T18:29:23-04:00",
        "refund_line_items": [
          {
            "id": 1058498308,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 0,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 1058498309,
            "quantity": 1,
            "line_item_id": 518995019,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 518995019,
              "variant_id": 49148385,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008RED",
              "variant_title": "red",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - red",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 0,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 1058498310,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 0,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 1068278475,
            "order_id": 450789469,
            "amount": "10.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": "Bogus Gateway: Forced success",
            "created_at": "2017-06-13T18:29:23-04:00",
            "test": true,
            "authorization": null,
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 1068278474,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "755357713"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  },
  "notice": "Order has been canceled."
}

Canceling and refunding an Order using the refund parameter

POST /admin/orders/#{id}/cancel.json
{
  "refund": {
    "restock": true,
    "note": "Broke in shipping",
    "shipping": {
      "full_refund": true
    },
    "refund_line_items": [
      {
        "line_item_id": 466157049,
        "quantity": 1
      }
    ],
    "transactions": [
      {
        "parent_id": 1068278480,
        "amount": "10.00",
        "kind": "refund",
        "gateway": "bogus"
      },
      {
        "parent_id": 1068278481,
        "amount": "100.00",
        "kind": "refund",
        "gateway": "gift_card"
      }
    ]
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:30-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "gift_card",
    "test": true,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus",
      "gift_card"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "properties": [
          {
            "name": "Custom Engraving Front",
            "value": "Happy Birthday"
          },
          {
            "name": "Custom Engraving Back",
            "value": "Merry Christmas"
          }
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "properties": [
              {
                "name": "Custom Engraving Front",
                "value": "Happy Birthday"
              },
              {
                "name": "Custom Engraving Back",
                "value": "Merry Christmas"
              }
            ],
            "product_exists": true,
            "fulfillable_quantity": 0,
            "total_discount": "0.00",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 929361465,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:29:29-04:00",
        "note": "Broke in shipping",
        "restock": true,
        "user_id": null,
        "processed_at": "2017-06-13T18:29:29-04:00",
        "refund_line_items": [
          {
            "id": 1058498311,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 0,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 1068278482,
            "order_id": 450789469,
            "amount": "10.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": "Bogus Gateway: Forced success",
            "created_at": "2017-06-13T18:29:29-04:00",
            "test": true,
            "authorization": null,
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 1068278480,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "755357713"
          },
          {
            "id": 1068278483,
            "order_id": 450789469,
            "amount": "100.00",
            "kind": "refund",
            "gateway": "gift_card",
            "status": "success",
            "message": null,
            "created_at": "2017-06-13T18:29:29-04:00",
            "test": false,
            "authorization": null,
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 1068278481,
            "device_id": null,
            "receipt": {
              "gift_card_id": 48394658,
              "gift_card_last_characters": "0d0d"
            },
            "error_code": null,
            "source_name": "755357713"
          }
        ],
        "order_adjustments": [
          {
            "id": 1030976843,
            "order_id": 450789469,
            "refund_id": 929361465,
            "amount": "89.64",
            "tax_amount": "0.00",
            "kind": "refund_discrepancy",
            "reason": "Refund discrepancy"
          }
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  },
  "notice": "Order has been canceled."
}

Canceling an Order

POST /admin/orders/#{id}/cancel.json
{}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2008-01-10T11:00:00-05:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": false,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  },
  "notice": "Order has been canceled."
}
POST /admin/orders.json
Create a new order
order

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

  • send_receipt - Determines whether an order confirmation will be sent to the customer. Default: false.
  • send_fulfillment_receipt - Determines whether a fulfillment confirmation will be sent to the customer. Default: false.
  • inventory_behaviour - Determines which inventory updating behaviour is used. The following values are available:
    • 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.

Creating an order with tax lines on both line items and the order will return an error

POST /admin/orders.json
{
  "order": {
    "line_items": [
      {
        "title": "Clicky Keyboard",
        "price": 99.99,
        "grams": "600",
        "quantity": 1,
        "tax_lines": [
          {
            "price": 1.0,
            "rate": 0.01,
            "title": "Keyboard tax"
          }
        ]
      }
    ],
    "tax_lines": [
      {
        "price": 6.0,
        "rate": 0.06,
        "title": "State tax"
      }
    ]
  }
}
View Response
HTTP/1.1 422 Unprocessable Entity
{
  "errors": {
    "order": [
      "Tax lines must be associated with either order or line item but not both"
    ]
  }
}

Create a simple order without sending order/fulfillment receipt

POST /admin/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": {
    "id": 1073459964,
    "email": "foo@example.com",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:17-04:00",
    "updated_at": "2017-06-13T18:29:17-04:00",
    "number": 2,
    "note": null,
    "token": "843e9b1ae7ac934bba6953f0855eda63",
    "gateway": "",
    "test": false,
    "total_price": "199.00",
    "subtotal_price": "199.00",
    "total_weight": null,
    "total_tax": "0.00",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "paid",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "199.00",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:17-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": "fulfilled",
    "tax_lines": [
    ],
    "tags": "",
    "contact_email": "foo@example.com",
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823172,
        "variant_id": 447654529,
        "title": "IPod Touch 8GB",
        "quantity": 1,
        "price": "199.00",
        "grams": 567,
        "sku": "IPOD2009BLACK",
        "variant_title": "Black",
        "vendor": "Apple",
        "fulfillment_service": "manual",
        "product_id": 921728736,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
      {
        "id": 1022782901,
        "order_id": 1073459964,
        "status": "success",
        "created_at": "2017-06-13T18:29:17-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:29:17-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "tracking_number": null,
        "tracking_numbers": [
        ],
        "tracking_url": null,
        "tracking_urls": [
        ],
        "receipt": {},
        "line_items": [
          {
            "id": 1071823172,
            "variant_id": 447654529,
            "title": "IPod Touch 8GB",
            "quantity": 1,
            "price": "199.00",
            "grams": 567,
            "sku": "IPOD2009BLACK",
            "variant_title": "Black",
            "vendor": "Apple",
            "fulfillment_service": "manual",
            "product_id": 921728736,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Touch 8GB - Black",
            "variant_inventory_management": "shopify",
            "properties": [
            ],
            "product_exists": true,
            "fulfillable_quantity": 0,
            "total_discount": "0.00",
            "fulfillment_status": "fulfilled",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "refunds": [
    ],
    "customer": {
      "id": 1073339461,
      "email": "foo@example.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:29:17-04:00",
      "updated_at": "2017-06-13T18:29:17-04:00",
      "first_name": null,
      "last_name": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "0.00",
      "last_order_id": 1073459964,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1002"
    }
  }
}

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

POST /admin/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": {
    "id": 1073459965,
    "email": "foo@example.com",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:18-04:00",
    "updated_at": "2017-06-13T18:29:18-04:00",
    "number": 2,
    "note": null,
    "token": "15a6d731341034d88dc57d053d885c95",
    "gateway": "",
    "test": false,
    "total_price": "199.00",
    "subtotal_price": "199.00",
    "total_weight": null,
    "total_tax": "0.00",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "paid",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "199.00",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:18-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": "fulfilled",
    "tax_lines": [
    ],
    "tags": "",
    "contact_email": "foo@example.com",
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823173,
        "variant_id": 447654529,
        "title": "IPod Touch 8GB",
        "quantity": 1,
        "price": "199.00",
        "grams": 567,
        "sku": "IPOD2009BLACK",
        "variant_title": "Black",
        "vendor": "Apple",
        "fulfillment_service": "manual",
        "product_id": 921728736,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 0,
        "total_discount": "0.00",
        "fulfillment_status": "fulfilled",
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
      {
        "id": 1022782902,
        "order_id": 1073459965,
        "status": "success",
        "created_at": "2017-06-13T18:29:18-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:29:18-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "tracking_number": null,
        "tracking_numbers": [
        ],
        "tracking_url": null,
        "tracking_urls": [
        ],
        "receipt": {},
        "line_items": [
          {
            "id": 1071823173,
            "variant_id": 447654529,
            "title": "IPod Touch 8GB",
            "quantity": 1,
            "price": "199.00",
            "grams": 567,
            "sku": "IPOD2009BLACK",
            "variant_title": "Black",
            "vendor": "Apple",
            "fulfillment_service": "manual",
            "product_id": 921728736,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Touch 8GB - Black",
            "variant_inventory_management": "shopify",
            "properties": [
            ],
            "product_exists": true,
            "fulfillable_quantity": 0,
            "total_discount": "0.00",
            "fulfillment_status": "fulfilled",
            "tax_lines": [
            ]
          }
        ]
      }
    ],
    "refunds": [
    ],
    "customer": {
      "id": 1073339462,
      "email": "foo@example.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:29:18-04:00",
      "updated_at": "2017-06-13T18:29:18-04:00",
      "first_name": null,
      "last_name": null,
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "0.00",
      "last_order_id": 1073459965,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1002"
    }
  }
}

Create a simple order with only a product variant id.

POST /admin/orders.json
{
  "order": {
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "id": 1073459966,
    "email": "",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:20-04:00",
    "updated_at": "2017-06-13T18:29:20-04:00",
    "number": 2,
    "note": null,
    "token": "619a74337f849148fff36e38c7fb6f1e",
    "gateway": "",
    "test": false,
    "total_price": "199.00",
    "subtotal_price": "199.00",
    "total_weight": null,
    "total_tax": "0.00",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "paid",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "199.00",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:20-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": null,
    "tax_lines": [
    ],
    "tags": "",
    "contact_email": null,
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823174,
        "variant_id": 447654529,
        "title": "IPod Touch 8GB",
        "quantity": 1,
        "price": "199.00",
        "grams": 567,
        "sku": "IPOD2009BLACK",
        "variant_title": "Black",
        "vendor": "Apple",
        "fulfillment_service": "manual",
        "product_id": 921728736,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ]
  }
}

Create a pending order with an existing customer

POST /admin/orders.json
{
  "order": {
    "line_items": [
      {
        "variant_id": 447654529,
        "quantity": 1
      }
    ],
    "customer": {
      "id": 207119551
    },
    "financial_status": "pending"
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "id": 1073459967,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:20-04:00",
    "updated_at": "2017-06-13T18:29:20-04:00",
    "number": 2,
    "note": null,
    "token": "8af430b6c7792c6bf7fd2b16b44d7187",
    "gateway": "",
    "test": false,
    "total_price": "199.00",
    "subtotal_price": "199.00",
    "total_weight": null,
    "total_tax": "0.00",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "pending",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "199.00",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:20-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": null,
    "tax_lines": [
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823175,
        "variant_id": 447654529,
        "title": "IPod Touch 8GB",
        "quantity": 1,
        "price": "199.00",
        "grams": 567,
        "sku": "IPOD2009BLACK",
        "variant_title": "Black",
        "vendor": "Apple",
        "fulfillment_service": "manual",
        "product_id": 921728736,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ],
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:29:20-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 2,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 1073459967,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1002",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "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 /admin/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": "K2P 1L4"
    },
    "shipping_address": {
      "first_name": "Jane",
      "last_name": "Smith",
      "address1": "123 Fake Street",
      "phone": "777-777-7777",
      "city": "Fakecity",
      "province": "Ontario",
      "country": "Canada",
      "zip": "K2P 1L4"
    },
    "email": "jane@example.com",
    "transactions": [
      {
        "kind": "authorization",
        "status": "success",
        "amount": 50.0
      }
    ],
    "financial_status": "partially_paid"
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "id": 1073459970,
    "email": "jane@example.com",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:31-04:00",
    "updated_at": "2017-06-13T18:29:31-04:00",
    "number": 2,
    "note": null,
    "token": "d4d84cebc225f2504992031ca63e7a71",
    "gateway": "",
    "test": false,
    "total_price": "199.00",
    "subtotal_price": "199.00",
    "total_weight": null,
    "total_tax": "0.00",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "partially_paid",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "199.00",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "199.00",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:31-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
      ""
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": null,
    "tax_lines": [
    ],
    "tags": "",
    "contact_email": "jane@example.com",
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823178,
        "variant_id": 447654529,
        "title": "IPod Touch 8GB",
        "quantity": 1,
        "price": "199.00",
        "grams": 567,
        "sku": "IPOD2009BLACK",
        "variant_title": "Black",
        "vendor": "Apple",
        "fulfillment_service": "manual",
        "product_id": 921728736,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Touch 8GB - Black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
        ]
      }
    ],
    "shipping_lines": [
    ],
    "billing_address": {
      "first_name": "John",
      "address1": "123 Fake Street",
      "phone": "555-555-5555",
      "city": "Fakecity",
      "zip": "K2P 1L4",
      "province": "Ontario",
      "country": "Canada",
      "last_name": "Smith",
      "address2": null,
      "company": null,
      "latitude": null,
      "longitude": null,
      "name": "John Smith",
      "country_code": "CA",
      "province_code": "ON"
    },
    "shipping_address": {
      "first_name": "Jane",
      "address1": "123 Fake Street",
      "phone": "777-777-7777",
      "city": "Fakecity",
      "zip": "K2P 1L4",
      "province": "Ontario",
      "country": "Canada",
      "last_name": "Smith",
      "address2": null,
      "company": null,
      "latitude": null,
      "longitude": null,
      "name": "Jane Smith",
      "country_code": "CA",
      "province_code": "ON"
    },
    "fulfillments": [
    ],
    "refunds": [
    ],
    "customer": {
      "id": 1073339463,
      "email": "paul.norman@example.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:29:31-04:00",
      "updated_at": "2017-06-13T18:29:31-04:00",
      "first_name": "John",
      "last_name": "Smith",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "0.00",
      "last_order_id": 1073459970,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1002",
      "default_address": {
        "id": 1053317297,
        "first_name": "Jane",
        "last_name": "Smith",
        "company": null,
        "address1": "123 Fake Street",
        "address2": null,
        "city": "Fakecity",
        "province": "Ontario",
        "country": "Canada",
        "zip": "K2P 1L4",
        "phone": "777-777-7777",
        "name": "Jane Smith",
        "province_code": "ON",
        "country_code": "CA",
        "country_name": "Canada",
        "default": true
      }
    }
  }
}

Create a more comprehensive order

POST /admin/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": {
    "id": 1073459971,
    "email": "",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:32-04:00",
    "updated_at": "2017-06-13T18:29:32-04:00",
    "number": 2,
    "note": null,
    "token": "84fbaeee0637bb9d8fc76a1bbc3cdc45",
    "gateway": "",
    "test": false,
    "total_price": "238.47",
    "subtotal_price": "224.97",
    "total_weight": null,
    "total_tax": "13.50",
    "taxes_included": false,
    "currency": "EUR",
    "financial_status": "paid",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "224.97",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "340.54",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:32-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
      ""
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State tax",
        "price": "13.50",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": null,
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823179,
        "variant_id": null,
        "title": "Big Brown Bear Boots",
        "quantity": 3,
        "price": "74.99",
        "grams": 1300,
        "sku": null,
        "variant_title": null,
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": null,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "Big Brown Bear Boots",
        "variant_inventory_management": null,
        "properties": [
        ],
        "product_exists": false,
        "fulfillable_quantity": 3,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State tax",
            "price": "13.50",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ]
  }
}

Create an order with tax lines split onto taxable line items

POST /admin/orders.json
{
  "order": {
    "line_items": [
      {
        "title": "Red Leather Coat",
        "price": 129.99,
        "grams": "1700",
        "quantity": 1
      },
      {
        "title": "Blue Suede Shoes",
        "price": 85.95,
        "grams": "750",
        "quantity": 1,
        "taxable": false
      },
      {
        "title": "Raspberry Beret",
        "price": 19.99,
        "grams": "320",
        "quantity": 2
      }
    ],
    "tax_lines": [
      {
        "price": 10.2,
        "rate": 0.06,
        "title": "State tax"
      },
      {
        "price": 4.25,
        "rate": 0.025,
        "title": "County tax"
      }
    ],
    "total_tax": 14.45
  }
}
View Response
HTTP/1.1 201 Created
{
  "order": {
    "id": 1073459972,
    "email": "",
    "closed_at": null,
    "created_at": "2017-06-13T18:29:38-04:00",
    "updated_at": "2017-06-13T18:29:38-04:00",
    "number": 2,
    "note": null,
    "token": "b35d55fac69bf0baff2580783492434a",
    "gateway": "",
    "test": false,
    "total_price": "270.37",
    "subtotal_price": "255.92",
    "total_weight": null,
    "total_tax": "14.45",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "paid",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "255.92",
    "cart_token": null,
    "buyer_accepts_marketing": false,
    "name": "#1002",
    "referring_site": null,
    "landing_site": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "270.37",
    "checkout_token": null,
    "reference": null,
    "user_id": null,
    "location_id": null,
    "source_identifier": null,
    "source_url": null,
    "processed_at": "2017-06-13T18:29:38-04:00",
    "device_id": null,
    "phone": null,
    "browser_ip": null,
    "landing_site_ref": null,
    "order_number": 1002,
    "discount_codes": [
    ],
    "note_attributes": [
    ],
    "payment_gateway_names": [
    ],
    "processing_method": "",
    "checkout_id": null,
    "source_name": "755357713",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State tax",
        "price": "10.20",
        "rate": 0.06
      },
      {
        "title": "County tax",
        "price": "4.25",
        "rate": 0.025
      }
    ],
    "tags": "",
    "contact_email": null,
    "order_status_url": null,
    "line_items": [
      {
        "id": 1071823180,
        "variant_id": null,
        "title": "Red Leather Coat",
        "quantity": 1,
        "price": "129.99",
        "grams": 1700,
        "sku": null,
        "variant_title": null,
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": null,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "Red Leather Coat",
        "variant_inventory_management": null,
        "properties": [
        ],
        "product_exists": false,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State tax",
            "price": "7.81",
            "rate": 0.06
          },
          {
            "title": "County tax",
            "price": "3.26",
            "rate": 0.025
          }
        ]
      },
      {
        "id": 1071823181,
        "variant_id": null,
        "title": "Blue Suede Shoes",
        "quantity": 1,
        "price": "85.95",
        "grams": 750,
        "sku": null,
        "variant_title": null,
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": null,
        "requires_shipping": true,
        "taxable": false,
        "gift_card": false,
        "name": "Blue Suede Shoes",
        "variant_inventory_management": null,
        "properties": [
        ],
        "product_exists": false,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
        ]
      },
      {
        "id": 1071823182,
        "variant_id": null,
        "title": "Raspberry Beret",
        "quantity": 2,
        "price": "19.99",
        "grams": 320,
        "sku": null,
        "variant_title": null,
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": null,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "Raspberry Beret",
        "variant_inventory_management": null,
        "properties": [
        ],
        "product_exists": false,
        "fulfillable_quantity": 2,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State tax",
            "price": "2.39",
            "rate": 0.06
          },
          {
            "title": "County tax",
            "price": "0.99",
            "rate": 0.025
          }
        ]
      }
    ],
    "shipping_lines": [
    ],
    "fulfillments": [
    ],
    "refunds": [
    ]
  }
}
PUT /admin/orders/450789469.json
Update an order
order

Change an order’s attributes such as note, email, buyer-accepts-marketing, or remove the customer association. You can also send the shipping_address object as part of an order to update any shipping_address parameter.

  • shipping_address - Enables you to update shipping address parameters

Remove customer from an order

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "customer": null
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:13-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    }
  }
}

Add a metafield to an existing order

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "metafields": [
      {
        "key": "new",
        "value": "newvalue",
        "value_type": "string",
        "namespace": "global"
      }
    ]
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:16-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Change an order so that its buyer accepts marketing

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "buyer_accepts_marketing": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:22-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": true,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Change an order’s email

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "email": "a-different@email.com"
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "a-different@email.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:28-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "a-different@email.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Update an order's tags

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "tags": "External, Inbound, Outbound"
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:32-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "External, Inbound, Outbound",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Change an order’s phone

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "phone": "+15145556677"
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:33-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+15145556677",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Add Note to order

PUT /admin/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": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:34-04:00",
    "number": 1,
    "note": "Customer contacted us about a custom engraving on this iPod",
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Update the shipping address of an existing order

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "shipping_address": {
      "address1": "123 Ship Street",
      "city": "Shipsville"
    }
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:39-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "123 Ship Street",
      "phone": "555-625-1199",
      "city": "Shipsville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}

Set Note Attributes on an order

PUT /admin/orders/#{id}.json
{
  "order": {
    "id": 450789469,
    "note_attributes": [
      {
        "name": "colour",
        "value": "red"
      }
    ]
  }
}
View Response
HTTP/1.1 200 OK
{
  "order": {
    "id": 450789469,
    "email": "bob.norman@hostmail.com",
    "closed_at": null,
    "created_at": "2008-01-10T11:00:00-05:00",
    "updated_at": "2017-06-13T18:29:40-04:00",
    "number": 1,
    "note": null,
    "token": "b1946ac92492d2347c6235b4d2611184",
    "gateway": "authorize_net",
    "test": false,
    "total_price": "409.94",
    "subtotal_price": "398.00",
    "total_weight": 0,
    "total_tax": "11.94",
    "taxes_included": false,
    "currency": "USD",
    "financial_status": "authorized",
    "confirmed": true,
    "total_discounts": "0.00",
    "total_line_items_price": "398.00",
    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
    "buyer_accepts_marketing": false,
    "name": "#1001",
    "referring_site": "http:\/\/www.otherexample.com",
    "landing_site": "http:\/\/www.example.com?source=abc",
    "cancelled_at": null,
    "cancel_reason": null,
    "total_price_usd": "409.94",
    "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
    "reference": "fhwdgads",
    "user_id": null,
    "location_id": null,
    "source_identifier": "fhwdgads",
    "source_url": null,
    "processed_at": "2008-01-10T11:00:00-05:00",
    "device_id": null,
    "phone": "+557734881234",
    "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"
      }
    ],
    "payment_gateway_names": [
      "bogus"
    ],
    "processing_method": "direct",
    "checkout_id": 901414060,
    "source_name": "web",
    "fulfillment_status": null,
    "tax_lines": [
      {
        "title": "State Tax",
        "price": "11.94",
        "rate": 0.06
      }
    ],
    "tags": "",
    "contact_email": "bob.norman@hostmail.com",
    "order_status_url": "https:\/\/checkout.local\/690933842\/checkouts\/bd5a8aa1ecd019dd3520ff791ee3a24c\/thank_you_token",
    "line_items": [
      {
        "id": 466157049,
        "variant_id": 39072856,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008GREEN",
        "variant_title": "green",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - green",
        "variant_inventory_management": "shopify",
        "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",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 518995019,
        "variant_id": 49148385,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008RED",
        "variant_title": "red",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - red",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      },
      {
        "id": 703073504,
        "variant_id": 457924702,
        "title": "IPod Nano - 8gb",
        "quantity": 1,
        "price": "199.00",
        "grams": 200,
        "sku": "IPOD2008BLACK",
        "variant_title": "black",
        "vendor": null,
        "fulfillment_service": "manual",
        "product_id": 632910392,
        "requires_shipping": true,
        "taxable": true,
        "gift_card": false,
        "name": "IPod Nano - 8gb - black",
        "variant_inventory_management": "shopify",
        "properties": [
        ],
        "product_exists": true,
        "fulfillable_quantity": 1,
        "total_discount": "0.00",
        "fulfillment_status": null,
        "tax_lines": [
          {
            "title": "State Tax",
            "price": "3.98",
            "rate": 0.06
          }
        ]
      }
    ],
    "shipping_lines": [
      {
        "id": 369256396,
        "title": "Free Shipping",
        "price": "0.00",
        "code": "Free Shipping",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "tax_lines": [
        ]
      }
    ],
    "billing_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "shipping_address": {
      "first_name": "Bob",
      "address1": "Chestnut Street 92",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "last_name": "Norman",
      "address2": "",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY"
    },
    "fulfillments": [
      {
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "created_at": "2017-06-13T18:20:28-04:00",
        "service": "manual",
        "updated_at": "2017-06-13T18:20:28-04:00",
        "tracking_company": null,
        "shipment_status": null,
        "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": [
          {
            "id": 466157049,
            "variant_id": 39072856,
            "title": "IPod Nano - 8gb",
            "quantity": 1,
            "price": "199.00",
            "grams": 200,
            "sku": "IPOD2008GREEN",
            "variant_title": "green",
            "vendor": null,
            "fulfillment_service": "manual",
            "product_id": 632910392,
            "requires_shipping": true,
            "taxable": true,
            "gift_card": false,
            "name": "IPod Nano - 8gb - green",
            "variant_inventory_management": "shopify",
            "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",
            "fulfillment_status": null,
            "tax_lines": [
              {
                "title": "State Tax",
                "price": "3.98",
                "rate": 0.06
              }
            ]
          }
        ]
      }
    ],
    "client_details": {
      "browser_ip": "0.0.0.0",
      "accept_language": null,
      "user_agent": null,
      "session_hash": null,
      "browser_width": null,
      "browser_height": null
    },
    "refunds": [
      {
        "id": 509562969,
        "order_id": 450789469,
        "created_at": "2017-06-13T18:20:28-04:00",
        "note": "it broke during shipping",
        "restock": true,
        "user_id": 799407056,
        "processed_at": "2017-06-13T18:20:28-04:00",
        "refund_line_items": [
          {
            "id": 104689539,
            "quantity": 1,
            "line_item_id": 703073504,
            "subtotal": 195.67,
            "total_tax": 3.98,
            "line_item": {
              "id": 703073504,
              "variant_id": 457924702,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008BLACK",
              "variant_title": "black",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - black",
              "variant_inventory_management": "shopify",
              "properties": [
              ],
              "product_exists": true,
              "fulfillable_quantity": 1,
              "total_discount": "0.00",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          },
          {
            "id": 709875399,
            "quantity": 1,
            "line_item_id": 466157049,
            "subtotal": 195.66,
            "total_tax": 3.98,
            "line_item": {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "price": "199.00",
              "grams": 200,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "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",
              "fulfillment_status": null,
              "tax_lines": [
                {
                  "title": "State Tax",
                  "price": "3.98",
                  "rate": 0.06
                }
              ]
            }
          }
        ],
        "transactions": [
          {
            "id": 179259969,
            "order_id": 450789469,
            "amount": "209.00",
            "kind": "refund",
            "gateway": "bogus",
            "status": "success",
            "message": null,
            "created_at": "2005-08-05T12:59:12-04:00",
            "test": false,
            "authorization": "authorization-key",
            "currency": "USD",
            "location_id": null,
            "user_id": null,
            "parent_id": 801038806,
            "device_id": null,
            "receipt": {},
            "error_code": null,
            "source_name": "web"
          }
        ],
        "order_adjustments": [
        ]
      }
    ],
    "payment_details": {
      "credit_card_bin": null,
      "avs_result_code": null,
      "cvv_result_code": null,
      "credit_card_number": "•••• •••• •••• 4242",
      "credit_card_company": "Visa"
    },
    "customer": {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2017-06-13T18:20:28-04:00",
      "updated_at": "2017-06-13T18:20:28-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "41.94",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": null,
      "tags": "",
      "last_order_name": "#1001",
      "default_address": {
        "id": 207119551,
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    }
  }
}
DELETE /admin/orders/450789469.json
Delete an order. Orders that interact with an online gateway cannot be deleted.

Delete an order

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