Orders

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

idstringRequired

The Rutter generated unique ID of the order.

platform_idstring

The platform specific ID of the order.

cancelled_atstring

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

payment_statusenumRequired

The payment status of the order.

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

The status of the order.

One ofactive, archived, cancelled, or unknown.
total_discountnumberRequired

The sum of all discounts applied to the total price.

total_pricenumberRequired

The total price of the order.

fulfillment_statusenumnullableRequired

The status of the fulfillment for the order.

One offulfilled, unfulfilled, partial, or unknown.
iso_currency_codestringnullableRequired

The ISO 4217 currency code of the order.

namestring

The name of the order. Supported for SHOPIFY only.

order_numberstring

The merchant facing order ID.

source_namestring

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

total_line_items_pricenumber

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

total_shippingnumbernullableRequired

The sum of all shipping costs.

total_shipping_discountnumber

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

total_taxnumbernullableRequired

The total tax paid on the order.

tagsarray

The tags of the order. Supported for SHOPIFY only.

String array.

billing_addressobjectnullableRequired
Show billing_address attributes
refundsarray
Show refunds attributes
shipping_addressobjectnullableRequired
Show shipping_address attributes
customerobjectnullableRequired
Show customer attributes
line_itemsarrayRequired

The linked Variants and quantities associated with this order.

Show line_items attributes
fulfillmentsarrayRequired
Show fulfillments attributes
transactionsarray

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

Show transactions attributes
created_atstringRequired

The ISO 8601 timestamp that the order was created.

updated_atstringRequired

The ISO 8601 timestamp that the order was last updated.

Endpoints
GET
/orders
GET
/orders/:id
POST
/orders
PATCH
/orders/:id

List Orders

GEThttps://production.rutterapi.com/versioned/orders

The /orders endpoint allows developers to receive user-authorized order data for a merchant's store.

Due to the potentially large number of orders associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_orders response body field to fetch all available transactions.

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    created_at_maxintegerquery

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

    created_at_minintegerquery

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

    cursorstringquery

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

    expandenumquery

    Optionally, include transaction information when fetching orders.

    Can betransactions.
    force_fetchenumquery

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

    One oftrue or false.
    fulfillment_statusenumquery

    Optionally filter orders by their fulfillment_status. Supported for Squarespace, BigCommerce, Magento, Square, Shopify, Wix, Amazon, Etsy, PrestaShop, eBay, Lazada.

    One offulfilled, unfulfilled, partial, or unknown.
    limitintegerquery

    The limit on the number of entities returned.

    order_numberintegerquery

    Optionally filter by order number. Supported for Squarespace, BigCommerce, Magento, WooCommerce, Square, Wix, Amazon, PrestaShop, eBay.

    payment_statusenumquery

    Optionally filters orders by payment_status. Supported for Squarespace, BigCommerce, Magento, Square, Shopify, Wix, Amazon, Etsy, PrestaShop, eBay, Lazada.

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

    Optionally filter by phone number. Format using only numerics. Supported for Magento, WooCommerce, Shopify, Wix.

    propertiesstringquery

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

    updated_at_maxintegerquery

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

    updated_at_minintegerquery

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

Response Body

    The /orders endpoint allows developers to receive user-authorized order data for a merchant's store. Due to the potentially large number of orders associated with a connection, results are paginated.

    connectionobjectRequired
    Show connection attributes
    ordersarrayRequired
    Show orders attributes
    next_cursorstringnullableRequired
Support by integration
  • Alibaba
    Alibaba
  • Amazon
    Amazon
  • Big Commerce
    Big Commerce
  • Ebay
    Ebay
Example Response Body
JSON
1
{


2
  "connection": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "orgId": "00000000-0000-0000-0000-000000000000",


5
    "platform": "SHOPIFY"


6
  },


7
  "orders": [


8
    {


9
      "id": "00000000-0000-0000-0000-000000000000",


10
      "platform_id": "12345678",


11
      "cancelled_at": "2023-01-02T02:34:56.000Z",


12
      "payment_status": "paid",


13
      "status": "active",


14
      "total_discount": 5,


15
      "total_price": 37.34,


16
      "fulfillment_status": "unfulfilled",


17
      "iso_currency_code": "USD",


18
      "order_number": "12345",


19
      "source_name": "web",


20
      "total_line_items_price": 28,


21
      "total_shipping": 12.34,


22
      "total_shipping_discount": 0,


23
      "total_tax": 2,


24
      "billing_address": {


25
        "address1": "123 Rutter Road",


26
        "address2": "Floor 4",


27
        "city": "San Francisco",


28
        "country_code": "USA",


29
        "first_name": "Eric",


30
        "last_name": "Yu",


31
        "postal_code": "94110",


32
        "region": "CA",


33
        "phone": "1234567890"


34
      },


35
      "shipping_address": {


36
        "address1": "123 Rutter Road",


37
        "address2": "Floor 4",


38
        "city": "San Francisco",


39
        "country_code": "USA",


40
        "first_name": "Eric",


41
        "last_name": "Yu",


42
        "postal_code": "94110",


43
        "region": "CA",


44
        "phone": "1234567890"


45
      },


46
      "customer": {


47
        "id": "00000000-0000-0000-0000-000000000000",


48
        "platform_id": "12345678",


49
        "email": "eric@rutter.com",


50
        "first_name": "Eric",


51
        "last_name": "Yu",


52
        "phone": "1234567890",


53
        "created_at": "2023-01-02T02:34:56.000Z",


54
        "updated_at": "2023-01-02T02:34:56.000Z"


55
      },


56
      "fulfillments": [


57
        {


58
          "id": "00000000-0000-0000-0000-000000000000",


59
          "order_id": "00000000-0000-0000-0000-000000000000",


60
          "carrier": "UPS",


61
          "service": "manual",


62
          "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",


63
          "tracking_url": "ABCDEFGH1234567890",


64
          "line_items": [


65
            {


66
              "id": "00000000-0000-0000-0000-000000000000",


67
              "product_id": "00000000-0000-0000-0000-000000000000",


68
              "variant_id": "00000000-0000-0000-0000-000000000000",


69
              "price": 12.34,


70
              "quantity": 2,


71
              "sku": "RUTTER-1",


72
              "title": "Rutter Shirt (Large)"


73
            }


74
          ]


75
        }


76
      ],


77
      "transactions": [


78
        {


79
          "id": "00000000-0000-0000-0000-000000000000",


80
          "order_id": "00000000-0000-0000-0000-000000000000",


81
          "payment_method_type": "card",


82
          "status": "success",


83
          "type": "sale",


84
          "amount": 31.99,


85
          "gateway": "paypal",


86
          "gateway_data": null,


87
          "iso_currency_code": "USD",


88
          "created_at": "2023-02-01T05:21:24.000Z",


89
          "updated_at": "2023-02-01T05:21:24.000Z"


90
        }


91
      ],


92
      "line_items": [


93
        {


94
          "id": "00000000-0000-0000-0000-000000000000",


95
          "platform_id": "12345678",


96
          "product_id": "00000000-0000-0000-0000-000000000000",


97
          "variant_id": "00000000-0000-0000-0000-000000000000",


98
          "price": 14,


99
          "quantity": 1,


100
          "iso_currency_code": "USD",


101
          "sku": "Intelligent-Soft-Table-872793",


102
          "title": "Handcrafted-Practical Wooden Towels",


103
          "unit_cost": 14,


104
          "created_at": "2023-01-02T02:34:56.000Z",


105
          "updated_at": "2023-01-02T02:34:56.000Z"


106
        },


107
        {


108
          "id": "00000000-0000-0000-0000-000000000000",


109
          "platform_id": "12345678",


110
          "product_id": "00000000-0000-0000-0000-000000000000",


111
          "variant_id": "00000000-0000-0000-0000-000000000000",


112
          "price": 14,


113
          "quantity": 1,


114
          "iso_currency_code": "USD",


115
          "sku": "Intelligent-Wooden-Salad-164653",


116
          "title": "Incredible-Tasty Fresh Pants",


117
          "unit_cost": 14,


118
          "created_at": "2023-01-02T02:34:56.000Z",


119
          "updated_at": "2023-01-02T02:34:56.000Z"


120
        }


121
      ],


122
      "created_at": "2023-01-02T02:34:56.000Z",


123
      "updated_at": "2023-01-02T02:34:56.000Z"


124
    }


125
  ],


126
  "next_cursor": null


127
}

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

GEThttps://production.rutterapi.com/versioned/orders/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    expandenumquery

    Optionally, include transaction information when fetching orders.

    Can betransactions.
    force_fetchenumquery

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

    One oftrue or false.

Response Body

    The /orders/{id} endpoint allows developers to receive user-authorized order data for a specific order in a merchant's store.

    connectionobjectRequired
    Show connection attributes
    ordernullableRequired
    Show order attributes
Support by integration
  • Alibaba
    Alibaba
  • Amazon
    Amazon
  • Big Commerce
    Big Commerce
  • Ebay
    Ebay
Example Response Body
JSON
1
{


2
  "connection": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "orgId": "00000000-0000-0000-0000-000000000000",


5
    "platform": "SHOPIFY"


6
  },


7
  "order": {


8
    "id": "00000000-0000-0000-0000-000000000000",


9
    "platform_id": "12345678",


10
    "cancelled_at": "2023-01-02T02:34:56.000Z",


11
    "payment_status": "paid",


12
    "status": "active",


13
    "total_discount": 5,


14
    "total_price": 37.34,


15
    "fulfillment_status": "unfulfilled",


16
    "iso_currency_code": "USD",


17
    "order_number": "12345",


18
    "source_name": "web",


19
    "total_line_items_price": 28,


20
    "total_shipping": 12.34,


21
    "total_shipping_discount": 0,


22
    "total_tax": 2,


23
    "billing_address": {


24
      "address1": "123 Rutter Road",


25
      "address2": "Floor 4",


26
      "city": "San Francisco",


27
      "country_code": "USA",


28
      "first_name": "Eric",


29
      "last_name": "Yu",


30
      "postal_code": "94110",


31
      "region": "CA",


32
      "phone": "1234567890"


33
    },


34
    "shipping_address": {


35
      "address1": "123 Rutter Road",


36
      "address2": "Floor 4",


37
      "city": "San Francisco",


38
      "country_code": "USA",


39
      "first_name": "Eric",


40
      "last_name": "Yu",


41
      "postal_code": "94110",


42
      "region": "CA",


43
      "phone": "1234567890"


44
    },


45
    "customer": {


46
      "id": "00000000-0000-0000-0000-000000000000",


47
      "platform_id": "12345678",


48
      "email": "eric@rutter.com",


49
      "first_name": "Eric",


50
      "last_name": "Yu",


51
      "phone": "1234567890",


52
      "created_at": "2023-01-02T02:34:56.000Z",


53
      "updated_at": "2023-01-02T02:34:56.000Z"


54
    },


55
    "fulfillments": [


56
      {


57
        "id": "00000000-0000-0000-0000-000000000000",


58
        "order_id": "00000000-0000-0000-0000-000000000000",


59
        "carrier": "UPS",


60
        "service": "manual",


61
        "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",


62
        "tracking_url": "ABCDEFGH1234567890",


63
        "line_items": [


64
          {


65
            "id": "00000000-0000-0000-0000-000000000000",


66
            "product_id": "00000000-0000-0000-0000-000000000000",


67
            "variant_id": "00000000-0000-0000-0000-000000000000",


68
            "price": 12.34,


69
            "quantity": 2,


70
            "sku": "RUTTER-1",


71
            "title": "Rutter Shirt (Large)"


72
          }


73
        ]


74
      }


75
    ],


76
    "transactions": [


77
      {


78
        "id": "00000000-0000-0000-0000-000000000000",


79
        "order_id": "00000000-0000-0000-0000-000000000000",


80
        "payment_method_type": "card",


81
        "status": "success",


82
        "type": "sale",


83
        "amount": 31.99,


84
        "gateway": "paypal",


85
        "gateway_data": null,


86
        "iso_currency_code": "USD",


87
        "created_at": "2023-02-01T05:21:24.000Z",


88
        "updated_at": "2023-02-01T05:21:24.000Z"


89
      }


90
    ],


91
    "line_items": [


92
      {


93
        "id": "00000000-0000-0000-0000-000000000000",


94
        "platform_id": "12345678",


95
        "product_id": "00000000-0000-0000-0000-000000000000",


96
        "variant_id": "00000000-0000-0000-0000-000000000000",


97
        "price": 14,


98
        "quantity": 1,


99
        "iso_currency_code": "USD",


100
        "sku": "Intelligent-Soft-Table-872793",


101
        "title": "Handcrafted-Practical Wooden Towels",


102
        "unit_cost": 14,


103
        "created_at": "2023-01-02T02:34:56.000Z",


104
        "updated_at": "2023-01-02T02:34:56.000Z"


105
      },


106
      {


107
        "id": "00000000-0000-0000-0000-000000000000",


108
        "platform_id": "12345678",


109
        "product_id": "00000000-0000-0000-0000-000000000000",


110
        "variant_id": "00000000-0000-0000-0000-000000000000",


111
        "price": 14,


112
        "quantity": 1,


113
        "iso_currency_code": "USD",


114
        "sku": "Intelligent-Wooden-Salad-164653",


115
        "title": "Incredible-Tasty Fresh Pants",


116
        "unit_cost": 14,


117
        "created_at": "2023-01-02T02:34:56.000Z",


118
        "updated_at": "2023-01-02T02:34:56.000Z"


119
      }


120
    ],


121
    "created_at": "2023-01-02T02:34:56.000Z",


122
    "updated_at": "2023-01-02T02:34:56.000Z"


123
  }


124
}

Create an Order

POSThttps://production.rutterapi.com/versioned/orders

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    orderobjectRequired

    The order to create.

    Show order attributes

Response Body

    Companies that use Rutter can programmatically create orders on their storeowner's shops. To do this, make a POST request to our orders endpoint.

    orderobjectRequired
    Show order attributes
Support by integration
  • Big Commerce
    Big Commerce
  • Magento
    Magento
  • Shopify
    Shopify
  • Squarespace
    Squarespace
Example Request Body
JSON
1
{


2
  "order": {


3
    "currency_code": "USD",


4
    "line_items": [


5
      {


6
        "variant_id": "00000000-0000-0000-0000-000000000000",


7
        "quantity": 1


8
      },


9
      {


10
        "variant_id": "00000000-0000-0000-0000-000000000000",


11
        "quantity": 2


12
      }


13
    ],


14
    "customer": {


15
      "email": "eric@rutter.com",


16
      "first_name": "Eric",


17
      "last_name": "Yu"


18
    },


19
    "billing_address": {


20
      "address1": "123 Rutter Road",


21
      "address2": "Floor 4",


22
      "city": "San Francisco",


23
      "country_code": "USA",


24
      "first_name": "Eric",


25
      "last_name": "Yu",


26
      "postal_code": "94110",


27
      "region": "CA",


28
      "email": "eric@rutter.com",


29
      "phone": "1234567890"


30
    },


31
    "shipping_address": {


32
      "address1": "123 Rutter Road",


33
      "address2": "Floor 4",


34
      "city": "San Francisco",


35
      "country_code": "USA",


36
      "first_name": "Eric",


37
      "last_name": "Yu",


38
      "postal_code": "94110",


39
      "region": "CA",


40
      "email": "eric@rutter.com",


41
      "phone": "1234567890"


42
    }


43
  }


44
}
Example Response Body
JSON
1
{


2
  "order": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "cancelled_at": "2023-01-02T02:34:56.000Z",


6
    "payment_status": "paid",


7
    "status": "active",


8
    "total_discount": 5,


9
    "total_price": 37.34,


10
    "fulfillment_status": "unfulfilled",


11
    "iso_currency_code": "USD",


12
    "order_number": "12345",


13
    "source_name": "web",


14
    "total_line_items_price": 28,


15
    "total_shipping": 12.34,


16
    "total_shipping_discount": 0,


17
    "total_tax": 2,


18
    "billing_address": {


19
      "address1": "123 Rutter Road",


20
      "address2": "Floor 4",


21
      "city": "San Francisco",


22
      "country_code": "USA",


23
      "first_name": "Eric",


24
      "last_name": "Yu",


25
      "postal_code": "94110",


26
      "region": "CA",


27
      "phone": "1234567890"


28
    },


29
    "shipping_address": {


30
      "address1": "123 Rutter Road",


31
      "address2": "Floor 4",


32
      "city": "San Francisco",


33
      "country_code": "USA",


34
      "first_name": "Eric",


35
      "last_name": "Yu",


36
      "postal_code": "94110",


37
      "region": "CA",


38
      "phone": "1234567890"


39
    },


40
    "customer": {


41
      "id": "00000000-0000-0000-0000-000000000000",


42
      "platform_id": "12345678",


43
      "email": "eric@rutter.com",


44
      "first_name": "Eric",


45
      "last_name": "Yu",


46
      "phone": "1234567890",


47
      "created_at": "2023-01-02T02:34:56.000Z",


48
      "updated_at": "2023-01-02T02:34:56.000Z"


49
    },


50
    "fulfillments": [


51
      {


52
        "id": "00000000-0000-0000-0000-000000000000",


53
        "order_id": "00000000-0000-0000-0000-000000000000",


54
        "carrier": "UPS",


55
        "service": "manual",


56
        "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",


57
        "tracking_url": "ABCDEFGH1234567890",


58
        "line_items": [


59
          {


60
            "id": "00000000-0000-0000-0000-000000000000",


61
            "product_id": "00000000-0000-0000-0000-000000000000",


62
            "variant_id": "00000000-0000-0000-0000-000000000000",


63
            "price": 12.34,


64
            "quantity": 2,


65
            "sku": "RUTTER-1",


66
            "title": "Rutter Shirt (Large)"


67
          }


68
        ]


69
      }


70
    ],


71
    "transactions": [


72
      {


73
        "id": "00000000-0000-0000-0000-000000000000",


74
        "order_id": "00000000-0000-0000-0000-000000000000",


75
        "payment_method_type": "card",


76
        "status": "success",


77
        "type": "sale",


78
        "amount": 31.99,


79
        "gateway": "paypal",


80
        "gateway_data": null,


81
        "iso_currency_code": "USD",


82
        "created_at": "2023-02-01T05:21:24.000Z",


83
        "updated_at": "2023-02-01T05:21:24.000Z"


84
      }


85
    ],


86
    "line_items": [


87
      {


88
        "id": "00000000-0000-0000-0000-000000000000",


89
        "platform_id": "12345678",


90
        "product_id": "00000000-0000-0000-0000-000000000000",


91
        "variant_id": "00000000-0000-0000-0000-000000000000",


92
        "price": 14,


93
        "quantity": 1,


94
        "iso_currency_code": "USD",


95
        "sku": "Intelligent-Soft-Table-872793",


96
        "title": "Handcrafted-Practical Wooden Towels",


97
        "unit_cost": 14,


98
        "created_at": "2023-01-02T02:34:56.000Z",


99
        "updated_at": "2023-01-02T02:34:56.000Z"


100
      },


101
      {


102
        "id": "00000000-0000-0000-0000-000000000000",


103
        "platform_id": "12345678",


104
        "product_id": "00000000-0000-0000-0000-000000000000",


105
        "variant_id": "00000000-0000-0000-0000-000000000000",


106
        "price": 14,


107
        "quantity": 1,


108
        "iso_currency_code": "USD",


109
        "sku": "Intelligent-Wooden-Salad-164653",


110
        "title": "Incredible-Tasty Fresh Pants",


111
        "unit_cost": 14,


112
        "created_at": "2023-01-02T02:34:56.000Z",


113
        "updated_at": "2023-01-02T02:34:56.000Z"


114
      }


115
    ],


116
    "created_at": "2023-01-02T02:34:56.000Z",


117
    "updated_at": "2023-01-02T02:34:56.000Z"


118
  }


119
}

Update an Order

PATCHhttps://production.rutterapi.com/versioned/orders/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    orderobjectRequired
    Show order attributes

Response Body

    The /orders/{id} endpoint allows developers to receive user-authorized order data for a specific order in a merchant's store.

    connectionobjectRequired
    Show connection attributes
    ordernullableRequired
    Show order attributes
Support by integration
  • Shopify
    Shopify
  • Woo Commerce
    Woo Commerce
Example Request Body
JSON
1
{


2
  "order": {


3
    "status": "cancelled"


4
  }


5
}
Example Response Body
JSON
1
{


2
  "connection": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "orgId": "00000000-0000-0000-0000-000000000000",


5
    "platform": "SHOPIFY"


6
  },


7
  "order": {


8
    "id": "00000000-0000-0000-0000-000000000000",


9
    "platform_id": "12345678",


10
    "cancelled_at": "2023-01-02T02:34:56.000Z",


11
    "payment_status": "paid",


12
    "status": "active",


13
    "total_discount": 5,


14
    "total_price": 37.34,


15
    "fulfillment_status": "unfulfilled",


16
    "iso_currency_code": "USD",


17
    "order_number": "12345",


18
    "source_name": "web",


19
    "total_line_items_price": 28,


20
    "total_shipping": 12.34,


21
    "total_shipping_discount": 0,


22
    "total_tax": 2,


23
    "billing_address": {


24
      "address1": "123 Rutter Road",


25
      "address2": "Floor 4",


26
      "city": "San Francisco",


27
      "country_code": "USA",


28
      "first_name": "Eric",


29
      "last_name": "Yu",


30
      "postal_code": "94110",


31
      "region": "CA",


32
      "phone": "1234567890"


33
    },


34
    "shipping_address": {


35
      "address1": "123 Rutter Road",


36
      "address2": "Floor 4",


37
      "city": "San Francisco",


38
      "country_code": "USA",


39
      "first_name": "Eric",


40
      "last_name": "Yu",


41
      "postal_code": "94110",


42
      "region": "CA",


43
      "phone": "1234567890"


44
    },


45
    "customer": {


46
      "id": "00000000-0000-0000-0000-000000000000",


47
      "platform_id": "12345678",


48
      "email": "eric@rutter.com",


49
      "first_name": "Eric",


50
      "last_name": "Yu",


51
      "phone": "1234567890",


52
      "created_at": "2023-01-02T02:34:56.000Z",


53
      "updated_at": "2023-01-02T02:34:56.000Z"


54
    },


55
    "fulfillments": [


56
      {


57
        "id": "00000000-0000-0000-0000-000000000000",


58
        "order_id": "00000000-0000-0000-0000-000000000000",


59
        "carrier": "UPS",


60
        "service": "manual",


61
        "tracking_number": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890",


62
        "tracking_url": "ABCDEFGH1234567890",


63
        "line_items": [


64
          {


65
            "id": "00000000-0000-0000-0000-000000000000",


66
            "product_id": "00000000-0000-0000-0000-000000000000",


67
            "variant_id": "00000000-0000-0000-0000-000000000000",


68
            "price": 12.34,


69
            "quantity": 2,


70
            "sku": "RUTTER-1",


71
            "title": "Rutter Shirt (Large)"


72
          }


73
        ]


74
      }


75
    ],


76
    "transactions": [


77
      {


78
        "id": "00000000-0000-0000-0000-000000000000",


79
        "order_id": "00000000-0000-0000-0000-000000000000",


80
        "payment_method_type": "card",


81
        "status": "success",


82
        "type": "sale",


83
        "amount": 31.99,


84
        "gateway": "paypal",


85
        "gateway_data": null,


86
        "iso_currency_code": "USD",


87
        "created_at": "2023-02-01T05:21:24.000Z",


88
        "updated_at": "2023-02-01T05:21:24.000Z"


89
      }


90
    ],


91
    "line_items": [


92
      {


93
        "id": "00000000-0000-0000-0000-000000000000",


94
        "platform_id": "12345678",


95
        "product_id": "00000000-0000-0000-0000-000000000000",


96
        "variant_id": "00000000-0000-0000-0000-000000000000",


97
        "price": 14,


98
        "quantity": 1,


99
        "iso_currency_code": "USD",


100
        "sku": "Intelligent-Soft-Table-872793",


101
        "title": "Handcrafted-Practical Wooden Towels",


102
        "unit_cost": 14,


103
        "created_at": "2023-01-02T02:34:56.000Z",


104
        "updated_at": "2023-01-02T02:34:56.000Z"


105
      },


106
      {


107
        "id": "00000000-0000-0000-0000-000000000000",


108
        "platform_id": "12345678",


109
        "product_id": "00000000-0000-0000-0000-000000000000",


110
        "variant_id": "00000000-0000-0000-0000-000000000000",


111
        "price": 14,


112
        "quantity": 1,


113
        "iso_currency_code": "USD",


114
        "sku": "Intelligent-Wooden-Salad-164653",


115
        "title": "Incredible-Tasty Fresh Pants",


116
        "unit_cost": 14,


117
        "created_at": "2023-01-02T02:34:56.000Z",


118
        "updated_at": "2023-01-02T02:34:56.000Z"


119
      }


120
    ],


121
    "created_at": "2023-01-02T02:34:56.000Z",


122
    "updated_at": "2023-01-02T02:34:56.000Z"


123
  }


124
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Products