Commerce

Orders
Get API Keys

The Order object

A Rutter Order represents an order processed by a merchant's store. Every order is linked to Fulfillments, Transactions, Products, Variants, and a Customer.

Every order contains a line_items array containing information about the products included in the order.

Properties

idstring

The Rutter generated unique ID of the order.

statusenum

The status of the order.

One ofactive, archived, cancelled, or unknown.
payment_statusenum

The payment status of the order.

One ofpending, paid, refunded, failed, or unknown.
fulfillment_statusenumnullable

The status of the fulfillment for the order.

One offulfilled, unfulfilled, partial, or unknown.
line_itemsarray

The linked Variants and quantities associated with this order.

Show line_items attributes
billing_addressobjectnullable
Show billing_address attributes
shipping_addressobjectnullable
Show shipping_address attributes
customerobjectnullable
Show customer attributes
total_shippingnumbernullable

The sum of all shipping costs.

total_discountnumber

The sum of all discounts applied to the total price.

total_taxnumbernullable

The total tax paid on the order.

total_pricenumber

The total price of the order.

iso_currency_codestringnullable

The ISO 4217 currency code of the order.

created_atstring

The ISO 8601 timestamp that the order was created.

updated_atstring

The ISO 8601 timestamp that the order was last updated.

fulfillmentsarray
Show fulfillments attributes
transactionsarrayoptional

An array of Transactions linked to the order. Included if you pass the expand=transactions query parameter.

Show transactions attributes
platform_idstringoptional

The platform specific ID of the order.

order_numberstringoptional

The merchant facing order ID.

total_shipping_discountnumberoptional

The sum of all discounts on shipping applied to the total price.

refundsarrayoptional
Show refunds attributes
namestringoptional

The name of the order. Supported for SHOPIFY only.

cancelled_atstringoptional

The ISO 8601 timestamp that the order was cancelled. SHOPIFY only.

source_namestringoptional

The source name of the order. Supported for SHOPIFY only.

total_line_items_pricenumberoptional

The total price of all line items of the order. Supported for SHOPIFY only.

tagsarrayoptional

The tags of the order. Supported for SHOPIFY only.

String array.

Example Order Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "order_number": "12345",
  "status": "active",
  "payment_status": "paid",
  "fulfillment_status": "unfulfilled",
  "iso_currency_code": "USD",
  "total_shipping": 12.34,
  "total_discount": 5,
  "total_tax": 2,
  "total_price": 37.34,
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "total_shipping_discount": 0,
  "cancelled_at": "2023-01-02T02:34:56.000Z",
  "source_name": "web",
  "total_line_items_price": 28,
  "fulfillments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "order_id": "00000000-0000-0000-0000-000000000000",
      "carrier": "UPS",
      "service": "manual",
      "tracking_url": "ABCDEFGH1234567890",
      "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",
      "line_items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "variant_id": "00000000-0000-0000-0000-000000000000",
          "product_id": "00000000-0000-0000-0000-000000000000",
          "title": "Rutter Shirt (Large)",
          "price": 12.34,
          "quantity": 2,
          "sku": "RUTTER-1"
        }
      ]
    }
  ],
  "line_items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "product_id": "00000000-0000-0000-0000-000000000000",
      "variant_id": "00000000-0000-0000-0000-000000000000",
      "price": 14,
      "unit_cost": 14,
      "iso_currency_code": "USD",
      "fulfillment_service": "manual",
      "inventory_management": "shopify",
      "quantity": 1,
      "inventory": {
        "locations": [],
        "total_count": 1
      },
      "requires_shipping": true,
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "total_discount": 0,
      "sku": "Intelligent-Soft-Table-872793",
      "title": "Handcrafted-Practical Wooden Towels",
      "barcode": "57113",
      "vendor": "Hudson, Conroy and Stark",
      "name": "Handmade Soft Cheese"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "product_id": "00000000-0000-0000-0000-000000000000",
      "variant_id": "00000000-0000-0000-0000-000000000000",
      "price": 14,
      "unit_cost": 14,
      "iso_currency_code": "USD",
      "fulfillment_service": "manual",
      "inventory_management": "shopify",
      "quantity": 1,
      "inventory": {
        "locations": [],
        "total_count": 1
      },
      "requires_shipping": true,
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "total_discount": 0,
      "sku": "Intelligent-Wooden-Salad-164653",
      "title": "Incredible-Tasty Fresh Pants",
      "barcode": "88523",
      "vendor": "Zieme Group",
      "name": "Unbranded Wooden Bacon"
    }
  ],
  "transactions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "order_id": "00000000-0000-0000-0000-000000000000",
      "gateway": "paypal",
      "type": "sale",
      "amount": 31.99,
      "iso_currency_code": "USD",
      "status": "success",
      "created_at": "2023-02-01T05:21:24.000Z",
      "updated_at": "2023-02-01T05:21:24.000Z",
      "payment_method_type": "card",
      "gateway_data": null
    }
  ],
  "shipping_address": {
    "address1": "123 Rutter Road",
    "address2": "Floor 4",
    "city": "San Francisco",
    "postal_code": "94110",
    "region": "CA",
    "country_code": "USA",
    "first_name": "Eric",
    "last_name": "Yu",
    "phone": "1234567890"
  },
  "billing_address": {
    "address1": "123 Rutter Road",
    "address2": "Floor 4",
    "city": "San Francisco",
    "postal_code": "94110",
    "region": "CA",
    "country_code": "USA",
    "first_name": "Eric",
    "last_name": "Yu",
    "phone": "1234567890"
  },
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "first_name": "Eric",
    "last_name": "Yu",
    "email": "eric@rutter.com",
    "phone": "1234567890",
    "orders": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}

List Orders

GET /orders
Supported for: AmazonBigCommerceEbayEtsyGumroadLazadaMagentoMercado LibrePrestaShopShopeeShoperShopifyShoplazzaSquareSquarespaceWalmartWixWooCommerce

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    created_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum created_at datetime to fetch entities from.

    created_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum created_at datetime to fetch entities from.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Optionally, include transaction information when fetching orders.

    Can betransactions.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    fulfillment_statusenumoptionalquery

    Optionally filter orders by their fulfillment_status.

    One offulfilled, unfulfilled, partial, or unknown.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    order_numberintegeroptionalquery

    Optionally filter by order number.

    payment_statusenumoptionalquery

    Optionally filters orders by payment_status.

    One ofpending, paid, refunded, failed, or unknown.
    propertiesstringoptionalquery

    Optionally return only certain fields specified by a comma-separated list of field names. E.g. id,status

    updated_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.

Response Body

    ordersA list of orders
    Show orders attributes
    connectionConnection
    Show connection attributes
    next_cursorstringnullable
Example Response Body
{
  "orders": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "order_number": "12345",
      "status": "active",
      "payment_status": "paid",
      "fulfillment_status": "unfulfilled",
      "iso_currency_code": "USD",
      "total_shipping": 12.34,
      "total_discount": 5,
      "total_tax": 2,
      "total_price": 37.34,
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "total_shipping_discount": 0,
      "cancelled_at": "2023-01-02T02:34:56.000Z",
      "source_name": "web",
      "total_line_items_price": 28,
      "fulfillments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "order_id": "00000000-0000-0000-0000-000000000000",
          "carrier": "UPS",
          "service": "manual",
          "tracking_url": "ABCDEFGH1234567890",
          "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",
          "line_items": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "variant_id": "00000000-0000-0000-0000-000000000000",
              "product_id": "00000000-0000-0000-0000-000000000000",
              "title": "Rutter Shirt (Large)",
              "price": 12.34,
              "quantity": 2,
              "sku": "RUTTER-1"
            }
          ]
        }
      ],
      "line_items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "platform_id": "12345678",
          "product_id": "00000000-0000-0000-0000-000000000000",
          "variant_id": "00000000-0000-0000-0000-000000000000",
          "price": 14,
          "unit_cost": 14,
          "iso_currency_code": "USD",
          "fulfillment_service": "manual",
          "inventory_management": "shopify",
          "quantity": 1,
          "inventory": {
            "locations": [],
            "total_count": 1
          },
          "requires_shipping": true,
          "created_at": "2023-01-02T02:34:56.000Z",
          "updated_at": "2023-01-02T02:34:56.000Z",
          "total_discount": 0,
          "sku": "Intelligent-Soft-Table-872793",
          "title": "Handcrafted-Practical Wooden Towels",
          "barcode": "57113",
          "vendor": "Hudson, Conroy and Stark",
          "name": "Handmade Soft Cheese"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "platform_id": "12345678",
          "product_id": "00000000-0000-0000-0000-000000000000",
          "variant_id": "00000000-0000-0000-0000-000000000000",
          "price": 14,
          "unit_cost": 14,
          "iso_currency_code": "USD",
          "fulfillment_service": "manual",
          "inventory_management": "shopify",
          "quantity": 1,
          "inventory": {
            "locations": [],
            "total_count": 1
          },
          "requires_shipping": true,
          "created_at": "2023-01-02T02:34:56.000Z",
          "updated_at": "2023-01-02T02:34:56.000Z",
          "total_discount": 0,
          "sku": "Intelligent-Wooden-Salad-164653",
          "title": "Incredible-Tasty Fresh Pants",
          "barcode": "88523",
          "vendor": "Zieme Group",
          "name": "Unbranded Wooden Bacon"
        }
      ],
      "transactions": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "order_id": "00000000-0000-0000-0000-000000000000",
          "gateway": "paypal",
          "type": "sale",
          "amount": 31.99,
          "iso_currency_code": "USD",
          "status": "success",
          "created_at": "2023-02-01T05:21:24.000Z",
          "updated_at": "2023-02-01T05:21:24.000Z",
          "payment_method_type": "card",
          "gateway_data": null
        }
      ],
      "shipping_address": {
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "postal_code": "94110",
        "region": "CA",
        "country_code": "USA",
        "first_name": "Eric",
        "last_name": "Yu",
        "phone": "1234567890"
      },
      "billing_address": {
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "postal_code": "94110",
        "region": "CA",
        "country_code": "USA",
        "first_name": "Eric",
        "last_name": "Yu",
        "phone": "1234567890"
      },
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "first_name": "Eric",
        "last_name": "Yu",
        "email": "eric@rutter.com",
        "phone": "1234567890",
        "orders": [
          {
            "id": "00000000-0000-0000-0000-000000000000"
          }
        ],
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z"
      }
    }
  ],
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY",
    "orgId": "00000000-0000-0000-0000-000000000000"
  },
  "next_cursor": null
}

Platform Differences

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

Amazon

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

  • 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.
  • If the order is a replacement order, no price info is available.
  • 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

Ebay

Rutter currently fetches 90 days worth of orders due to Ebay's own limitation.

Fetch an Order

GET /orders/:id
Supported for: AmazonBigCommerceEbayEtsyGumroadLazadaMagentoMercado LibrePrestaShopShopeeShoperShopifySquareSquarespaceWalmartWixWooCommerce

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    expandenumoptionalquery

    Optionally, include transaction information when fetching orders.

    Can betransactions.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    ordernullable
    Show order attributes
    connectionConnection
    Show connection attributes
Example Response Body
{
  "order": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "order_number": "12345",
    "status": "active",
    "payment_status": "paid",
    "fulfillment_status": "unfulfilled",
    "iso_currency_code": "USD",
    "total_shipping": 12.34,
    "total_discount": 5,
    "total_tax": 2,
    "total_price": 37.34,
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "total_shipping_discount": 0,
    "cancelled_at": "2023-01-02T02:34:56.000Z",
    "source_name": "web",
    "total_line_items_price": 28,
    "fulfillments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "order_id": "00000000-0000-0000-0000-000000000000",
        "carrier": "UPS",
        "service": "manual",
        "tracking_url": "ABCDEFGH1234567890",
        "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",
        "line_items": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "variant_id": "00000000-0000-0000-0000-000000000000",
            "product_id": "00000000-0000-0000-0000-000000000000",
            "title": "Rutter Shirt (Large)",
            "price": 12.34,
            "quantity": 2,
            "sku": "RUTTER-1"
          }
        ]
      }
    ],
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "price": 14,
        "unit_cost": 14,
        "iso_currency_code": "USD",
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "quantity": 1,
        "inventory": {
          "locations": [],
          "total_count": 1
        },
        "requires_shipping": true,
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z",
        "total_discount": 0,
        "sku": "Intelligent-Soft-Table-872793",
        "title": "Handcrafted-Practical Wooden Towels",
        "barcode": "57113",
        "vendor": "Hudson, Conroy and Stark",
        "name": "Handmade Soft Cheese"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "price": 14,
        "unit_cost": 14,
        "iso_currency_code": "USD",
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "quantity": 1,
        "inventory": {
          "locations": [],
          "total_count": 1
        },
        "requires_shipping": true,
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z",
        "total_discount": 0,
        "sku": "Intelligent-Wooden-Salad-164653",
        "title": "Incredible-Tasty Fresh Pants",
        "barcode": "88523",
        "vendor": "Zieme Group",
        "name": "Unbranded Wooden Bacon"
      }
    ],
    "transactions": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "order_id": "00000000-0000-0000-0000-000000000000",
        "gateway": "paypal",
        "type": "sale",
        "amount": 31.99,
        "iso_currency_code": "USD",
        "status": "success",
        "created_at": "2023-02-01T05:21:24.000Z",
        "updated_at": "2023-02-01T05:21:24.000Z",
        "payment_method_type": "card",
        "gateway_data": null
      }
    ],
    "shipping_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890"
    },
    "billing_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890"
    },
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "first_name": "Eric",
      "last_name": "Yu",
      "email": "eric@rutter.com",
      "phone": "1234567890",
      "orders": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Create an Order

POST /orders
Supported for: BigCommerceMagentoShopifySquarespaceWixWooCommerce

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    orderobject

    The order to create.

    Show order attributes

Response Body

    orderOrder
    Show order attributes
Example Request Body
{
  "order": {
    "currency_code": "USD",
    "line_items": [
      {
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "quantity": 1
      },
      {
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "quantity": 2
      }
    ],
    "shipping_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890",
      "email": "eric@rutter.com"
    },
    "billing_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890",
      "email": "eric@rutter.com"
    },
    "customer": {
      "first_name": "Eric",
      "last_name": "Yu",
      "email": "eric@rutter.com"
    }
  }
}
Example Response Body
{
  "order": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "order_number": "12345",
    "status": "active",
    "payment_status": "paid",
    "fulfillment_status": "unfulfilled",
    "iso_currency_code": "USD",
    "total_shipping": 12.34,
    "total_discount": 5,
    "total_tax": 2,
    "total_price": 37.34,
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "total_shipping_discount": 0,
    "cancelled_at": "2023-01-02T02:34:56.000Z",
    "source_name": "web",
    "total_line_items_price": 28,
    "fulfillments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "order_id": "00000000-0000-0000-0000-000000000000",
        "carrier": "UPS",
        "service": "manual",
        "tracking_url": "ABCDEFGH1234567890",
        "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",
        "line_items": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "variant_id": "00000000-0000-0000-0000-000000000000",
            "product_id": "00000000-0000-0000-0000-000000000000",
            "title": "Rutter Shirt (Large)",
            "price": 12.34,
            "quantity": 2,
            "sku": "RUTTER-1"
          }
        ]
      }
    ],
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "price": 14,
        "unit_cost": 14,
        "iso_currency_code": "USD",
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "quantity": 1,
        "inventory": {
          "locations": [],
          "total_count": 1
        },
        "requires_shipping": true,
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z",
        "total_discount": 0,
        "sku": "Intelligent-Soft-Table-872793",
        "title": "Handcrafted-Practical Wooden Towels",
        "barcode": "57113",
        "vendor": "Hudson, Conroy and Stark",
        "name": "Handmade Soft Cheese"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "price": 14,
        "unit_cost": 14,
        "iso_currency_code": "USD",
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "quantity": 1,
        "inventory": {
          "locations": [],
          "total_count": 1
        },
        "requires_shipping": true,
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z",
        "total_discount": 0,
        "sku": "Intelligent-Wooden-Salad-164653",
        "title": "Incredible-Tasty Fresh Pants",
        "barcode": "88523",
        "vendor": "Zieme Group",
        "name": "Unbranded Wooden Bacon"
      }
    ],
    "transactions": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "order_id": "00000000-0000-0000-0000-000000000000",
        "gateway": "paypal",
        "type": "sale",
        "amount": 31.99,
        "iso_currency_code": "USD",
        "status": "success",
        "created_at": "2023-02-01T05:21:24.000Z",
        "updated_at": "2023-02-01T05:21:24.000Z",
        "payment_method_type": "card",
        "gateway_data": null
      }
    ],
    "shipping_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890"
    },
    "billing_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890"
    },
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "first_name": "Eric",
      "last_name": "Yu",
      "email": "eric@rutter.com",
      "phone": "1234567890",
      "orders": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  }
}

Update an Order

PATCH /orders/:id
Supported for: WooCommerce

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

Request Body

    orderobject
    Show order attributes

Response Body

    ordernullable
    Show order attributes
    connectionConnection
    Show connection attributes
Example Request Body
{
  "order": {
    "status": "cancelled"
  }
}
Example Response Body
{
  "order": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "order_number": "12345",
    "status": "active",
    "payment_status": "paid",
    "fulfillment_status": "unfulfilled",
    "iso_currency_code": "USD",
    "total_shipping": 12.34,
    "total_discount": 5,
    "total_tax": 2,
    "total_price": 37.34,
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "total_shipping_discount": 0,
    "cancelled_at": "2023-01-02T02:34:56.000Z",
    "source_name": "web",
    "total_line_items_price": 28,
    "fulfillments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "order_id": "00000000-0000-0000-0000-000000000000",
        "carrier": "UPS",
        "service": "manual",
        "tracking_url": "ABCDEFGH1234567890",
        "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",
        "line_items": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "variant_id": "00000000-0000-0000-0000-000000000000",
            "product_id": "00000000-0000-0000-0000-000000000000",
            "title": "Rutter Shirt (Large)",
            "price": 12.34,
            "quantity": 2,
            "sku": "RUTTER-1"
          }
        ]
      }
    ],
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "price": 14,
        "unit_cost": 14,
        "iso_currency_code": "USD",
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "quantity": 1,
        "inventory": {
          "locations": [],
          "total_count": 1
        },
        "requires_shipping": true,
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z",
        "total_discount": 0,
        "sku": "Intelligent-Soft-Table-872793",
        "title": "Handcrafted-Practical Wooden Towels",
        "barcode": "57113",
        "vendor": "Hudson, Conroy and Stark",
        "name": "Handmade Soft Cheese"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "price": 14,
        "unit_cost": 14,
        "iso_currency_code": "USD",
        "fulfillment_service": "manual",
        "inventory_management": "shopify",
        "quantity": 1,
        "inventory": {
          "locations": [],
          "total_count": 1
        },
        "requires_shipping": true,
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z",
        "total_discount": 0,
        "sku": "Intelligent-Wooden-Salad-164653",
        "title": "Incredible-Tasty Fresh Pants",
        "barcode": "88523",
        "vendor": "Zieme Group",
        "name": "Unbranded Wooden Bacon"
      }
    ],
    "transactions": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "order_id": "00000000-0000-0000-0000-000000000000",
        "gateway": "paypal",
        "type": "sale",
        "amount": 31.99,
        "iso_currency_code": "USD",
        "status": "success",
        "created_at": "2023-02-01T05:21:24.000Z",
        "updated_at": "2023-02-01T05:21:24.000Z",
        "payment_method_type": "card",
        "gateway_data": null
      }
    ],
    "shipping_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890"
    },
    "billing_address": {
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "postal_code": "94110",
      "region": "CA",
      "country_code": "USA",
      "first_name": "Eric",
      "last_name": "Yu",
      "phone": "1234567890"
    },
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "first_name": "Eric",
      "last_name": "Yu",
      "email": "eric@rutter.com",
      "phone": "1234567890",
      "orders": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}
Previous
Store
Next
Products