GET
/
api
/
v2
/
platform
/
orders
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "40",
      "type": "order",
      "attributes": {
        "number": "R936148131",
        "item_total": "0.0",
        "total": "0.0",
        "state": "cart",
        "adjustment_total": "0.0",
        "completed_at": null,
        "payment_total": "0.0",
        "shipment_state": null,
        "payment_state": null,
        "email": "murray_harber@strosin.ca",
        "special_instructions": null,
        "created_at": "2022-11-08T19:34:36.444Z",
        "updated_at": "2022-11-08T19:34:36.444Z",
        "currency": "USD",
        "last_ip_address": null,
        "shipment_total": "0.0",
        "additional_tax_total": "0.0",
        "promo_total": "0.0",
        "channel": "spree",
        "included_tax_total": "0.0",
        "item_count": 0,
        "approved_at": null,
        "confirmation_delivered": false,
        "canceled_at": null,
        "state_lock_version": 0,
        "taxable_adjustment_total": "0.0",
        "non_taxable_adjustment_total": "0.0",
        "store_owner_notification_delivered": null,
        "public_metadata": {},
        "private_metadata": {},
        "internal_note": null,
        "display_ship_total": "$0.00",
        "display_shipment_total": "$0.00",
        "display_outstanding_balance": "$0.00",
        "display_item_total": "$0.00",
        "display_adjustment_total": "$0.00",
        "display_included_tax_total": "$0.00",
        "display_additional_tax_total": "$0.00",
        "display_tax_total": "$0.00",
        "display_promo_total": "$0.00",
        "display_total": "$0.00",
        "display_cart_promo_total": "$0.00",
        "display_pre_tax_item_amount": "$0.00",
        "display_pre_tax_total": "$0.00",
        "display_total_applicable_store_credit": "$0.00",
        "display_total_applied_store_credit": "$0.00",
        "display_order_total_after_store_credit": "$0.00",
        "display_total_available_store_credit": "$0.00",
        "display_store_credit_remaining_after_capture": "$0.00"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "41",
            "type": "user"
          }
        },
        "created_by": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "canceler": {
          "data": null
        },
        "bill_address": {
          "data": {
            "id": "52",
            "type": "address"
          }
        },
        "ship_address": {
          "data": null
        },
        "line_items": {
          "data": []
        },
        "payments": {
          "data": []
        },
        "shipments": {
          "data": []
        },
        "state_changes": {
          "data": []
        },
        "return_authorizations": {
          "data": []
        },
        "reimbursements": {
          "data": []
        },
        "adjustments": {
          "data": []
        },
        "all_adjustments": {
          "data": []
        },
        "order_promotions": {
          "data": []
        }
      }
    },
    {
      "id": "41",
      "type": "order",
      "attributes": {
        "number": "R877925031",
        "item_total": "0.0",
        "total": "0.0",
        "state": "cart",
        "adjustment_total": "0.0",
        "completed_at": null,
        "payment_total": "0.0",
        "shipment_state": null,
        "payment_state": null,
        "email": "bronwyn@legroscorkery.ca",
        "special_instructions": null,
        "created_at": "2022-11-08T19:34:36.455Z",
        "updated_at": "2022-11-08T19:34:36.455Z",
        "currency": "USD",
        "last_ip_address": null,
        "shipment_total": "0.0",
        "additional_tax_total": "0.0",
        "promo_total": "0.0",
        "channel": "spree",
        "included_tax_total": "0.0",
        "item_count": 0,
        "approved_at": null,
        "confirmation_delivered": false,
        "canceled_at": null,
        "state_lock_version": 0,
        "taxable_adjustment_total": "0.0",
        "non_taxable_adjustment_total": "0.0",
        "store_owner_notification_delivered": null,
        "public_metadata": {},
        "private_metadata": {},
        "internal_note": null,
        "display_ship_total": "$0.00",
        "display_shipment_total": "$0.00",
        "display_outstanding_balance": "$0.00",
        "display_item_total": "$0.00",
        "display_adjustment_total": "$0.00",
        "display_included_tax_total": "$0.00",
        "display_additional_tax_total": "$0.00",
        "display_tax_total": "$0.00",
        "display_promo_total": "$0.00",
        "display_total": "$0.00",
        "display_cart_promo_total": "$0.00",
        "display_pre_tax_item_amount": "$0.00",
        "display_pre_tax_total": "$0.00",
        "display_total_applicable_store_credit": "$0.00",
        "display_total_applied_store_credit": "$0.00",
        "display_order_total_after_store_credit": "$0.00",
        "display_total_available_store_credit": "$0.00",
        "display_store_credit_remaining_after_capture": "$0.00"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "42",
            "type": "user"
          }
        },
        "created_by": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "canceler": {
          "data": null
        },
        "bill_address": {
          "data": {
            "id": "53",
            "type": "address"
          }
        },
        "ship_address": {
          "data": null
        },
        "line_items": {
          "data": []
        },
        "payments": {
          "data": []
        },
        "shipments": {
          "data": []
        },
        "state_changes": {
          "data": []
        },
        "return_authorizations": {
          "data": []
        },
        "reimbursements": {
          "data": []
        },
        "adjustments": {
          "data": []
        },
        "all_adjustments": {
          "data": []
        },
        "order_promotions": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/orders?page=1&per_page=&include=&filter[state_eq]=",
    "next": "http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[state_eq]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.