Orders

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

The Order object

A Rutter Order represents any order processed by a store owner'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. For any status that is unknown or other, it's because Rutter isn't able to determine its status into one of our pre-defined statuses.

See Platform Differences for unique behavior for certain platforms.

PropertyTypeDescription
idstringThe Rutter ID of the order. This value is a UUID generated by Rutter that uniquely identifies an order regardless of platforms.
platform_idstringThis is the platform specific order id for this order.
order_numberstringOrder number merchants typically see in their dashboard. Usually it's incremented by 1 for every new order
statusstringThe status of the order. One of:
- active
- cancelled
- archived
- unknown
payment_statusstringThe status of the payment associated with the order. One of:
- pending
- paid
- refunded - if an order is partially refunded, it will also be marked as refunded order
- unknown
fulfillment_statusstringThe status of the fulfillment for the order. One of:
- fulfilled
- partial - means the order is partially fulfilled.
- unfulfilled
- unknown
fulfillmentsobject[]Array of abridged Fulfillment Object.
line_itemsobject[]Array of line items in the order
refundsobject[] | nullArray of refunds in the order, if available. This value can be null if a platform doesn't supply refunds information.
billing_addressobject | nullThe billing address of the customer for the order. This value can be null if the customer did not purchase the product online or as a guest.
shipping_addressobject | nullThe shipping address of the customer for the order. This value can be null if the customer did not purchase the product online or as a guest.
customerobject | nullAn abridged Customer object. This value can be null if the customer did not purchase the product online or as a guest.
total_shippingfloat | nullThe sum of all shipping costs. This value is null if the no shipping was set.
total_discountfloatThe sum of all discounts applied to the total price. It should be non-negative.
total_taxfloat | nullThe total tax paid on the order. This value is null if no tax was set on the order.
total_pricefloatThe sum of all line item prices, shipping, taxes, tips, and minus discounts, in the shop currency. It should be equal to how much the buyer pays out of pocket when the buyer places the order.
iso_currency_codestring | nullThe ISO 4217 currency code of the order. This can be null if the platform does not return correct information.
created_atstringThe ISO 8601 timestamp the order was created.
updated_atstringThe last ISO 8601 timestamp the order was updated.
transactionsobject[]Not included by default. See Fetch Order Expansions.
{
  "id": "0f22c735-57dd-4954-9084-68e41c17b573",
  "platform_id": "7513594",
  "order_number": "1001",
  "status": "active",
  "payment_status": "refunded",
  "fulfillment_status": "partial",
  "fulfillments": [
    {
      "order_id": "0f22c735-57dd-4954-9084-68e41c17b573",
      "carrier": "China Post",
      "service": "One Day Delivery",
      "tracking_number": "112345Z2345",
      "tracking_url": "http://track-chinapost.com/startairmail.php?code=112345Z2345",
      "line_items": [
        {
          "id": "123",
          "product_id": "78f91173-d270-41a9-b03d-e18ac7cc13e0",
          "variant_id": "819f582e-af2d-44c9-8d1e-e352c581a4d4",
          "title": "IPod Nano",
          "price": 250.00,
          "iso_currency_code": "USD",
          "sku": "IPOD-342-N",
          "quantity": 1
        }
      ]
    }
  ],
  "line_items": [
    {
      "id": "123",
      "product_id": "78f91173-d270-41a9-b03d-e18ac7cc13e0",
      "variant_id": "819f582e-af2d-44c9-8d1e-e352c581a4d4",
      "unit_cost": 250.00,
      "price": 500.00,
      "quantity": 2,
      "iso_currency_code": "USD",
      "sku": "IPOD-342-N",
      "title": "IPod Nano",
    }
  ],
  "refunds": [
    {
      "line_items": [
        {
          "line_item_id": "123",
          "quantity": 1
        }
      ]
    }
  ],
  "billing_address": {
    "address1": "123 Amoebobacterieae St",
    "address2": null,
    "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": null,
    "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"
  },
  "total_shipping": 4.99,
  "total_discount": 0,
  "total_tax": 14.28,
  "total_price": 519.27,
  "iso_currency_code": "USD",
  "created_at": "2016-06-23T09:09:34.752Z",
  "updated_at": "2016-06-23T09:10:02.798Z"
}

Platform Differences

There can be some differences in field values due to platform-specific limitations or if the connection is missing required scopes.

Amazon

total_price: The total_price will be unavailable through the Amazon API and 0 in the following scenarios:

  1. The order status is cancelled, pending , or unshipped. Cancelled orders do not have this info, whereas pending orders could later be updated to have price info.
  2. If the order is a replacement order, no price info is available.
  3. If the order is sold through Non-Amazon sales channel it may not have price info.

Shopify

Rutter supplements the Order object with the following properties from Shopify: name, cancelled_at, source_name, total_line_items_price, tags