Retrieve all of the orders from a merchant's store.

The Order object

A Rutter Order represents any order processed by a storeowner's shop. For each order there is an associated Customer.

For each order, there is an array of line_items, which are the products included in the order.

Property

Type

Description

id

string

platform_id

string

This is the platform specific order id for this order.

order_number

string

Order number merchants typically see in their dashboard. Usually it's incremented by 1 for every new order

status

string

The status of the order. One of:

  • active
  • cancelled

payment_status

string

The status of the payment associated with the order. One of:

  • pending
  • paid
  • refunded

fulfillment_status

string

The status of the fulfillment for the order. One of:

  • fulfilled
  • partial
  • unfulfilled

fulfillments

object[]

Array of abridged Fulfillment Objects.

line_items

object[]

Array of line items in the order

billing_address

Address | null

shipping_address

Address | null

customer

object | null

An abridged Customer object.

total_shipping

number | null

The sum of all shipping costs. Null if not applicable.

total_discount

number

The sum of all discounts applied to the total price.

total_tax

number | null

The total tax paid on the item. Null if not applicable

total_price

number

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

iso_currency_code

string

The ISO-4217 currency code of the order.

created_at

string

The ISO 8601 timestamp the order was created.

updated_at

string

The last ISO 8601 timestamp the order was updated.

{
  "id": "0f22c735-57dd-4954-9084-68e41c17b573",
  "platform_id": "7513594",
  "order_number": "1001",
  "status": "active",
  "payment_status": "complete",
  "fulfillment_status": "complete",
  "fulfillments": [
    {
      "order_id": "576ba74eec471ff9b01557cc",
      "carrier": "Fedex",
      "service": "manual",
      "tracking_numbers": ["112345Z2345"],
      "tracking_urls": ["http://track-chinapost.com/startairmail.php?code=112345Z2345"]
    }
  ],
  "line_items": [
    {
      "grams": 500,
      "cost": 25.00,
      "price": 199.99,
      "product_id": 7513594,
      "quantity": 1,
      "sku": "IPOD-342-N",
      "title": "IPod Nano",
      "variant_id": 4264112,
      "vendor": "Apple",
      "name": "IPod Nano - Pink",   
      "total_discount": "5.00",
    }
    ],
  "billing_address": {
     "address1": "123 Amoebobacterieae St",
     "address2": "",
     "city": "Ottawa",
     "first_name": "Bob",
     "last_name": "Bobsen",
     "phone": "555-625-1199",
     "postal_code": "K2P0V6",
     "country_code": "CA",
     "region": "ON"
  },
  "shipping_address": {
     "address1": "123 Amoebobacterieae St",
     "address2": "",
     "city": "Ottawa",
     "first_name": "Bob",
     "last_name": "Bobsen",
     "phone": "555-625-1199",
     "postal_code": "K2P0V6",
     "country_code": "CA",
     "region": "ON"
  },
  "customer": {
     "id": "207119551",
     "email": "[email protected]",
     "first_name": "Bob",
     "last_name": "Norman",
     "orders_count": "1",
     "verified_email": true,
     "phone": "+13125551212",
     "tags": "loyal",
  },
  "total_shipping": 4.99,
  "total_discount": 0,
  "total_tax": 14.28,
  "total_price": 200.21,
  "iso_currency_code": "USD",
  "created_at": "2016-06-23T09:09:34.752Z",
  "updated_at": "2016-06-23T09:10:02.798Z",
}