GET
/
v2
/
orders
curl --request GET \
  --url https://api.loyaltylion.com/v2/orders \
  --header 'Authorization: Bearer <token>'
{
  "orders": [
    {
      "id": 123,
      "merchant_id": "<string>",
      "merchant_number": "<string>",
      "total": "<string>",
      "total_tax": "<string>",
      "total_shipping": "<string>",
      "total_discounts": "<string>",
      "total_paid": "<string>",
      "total_refunded": "<string>",
      "payment_status": "not_paid",
      "fulfillment_status": "fulfilled",
      "refund_status": "not_refunded",
      "cancellation_status": "cancelled",
      "metadata": {
        "shopify_source_url": "<string>",
        "shopify_source_name": "<string>",
        "shopify_location_id": 123
      },
      "created_at": "<string>",
      "updated_at": "<string>",
      "customer": {
        "id": 123,
        "merchant_id": "<string>",
        "email": "<string>",
        "points_pending": 123,
        "points_approved": 123,
        "points_spent": 123
      }
    }
  ],
  "cursor": {
    "prev": "<string>",
    "next": "<string>"
  }
}

Retrieve orders for the program. LoyaltyLion will only hold orders that have been created via the LoyaltyLion API or webhooks from an e-commerce platform.

Authorizations

​
Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Query Parameters

​
since_id
integer

Return only resources whose id is after the specified id

Required range: x >= 0
​
limit
integer
default:100

Max number of resources to return per request

Required range: 1 <= x <= 500
​
page
integer
deprecated

Fetch another page of results. This field is deprecated and will be removed in a future version of the API. Use cursors for pagination instead

Required range: x >= 1
​
cursor
string

Fetch another page of results using a cursor returned in a previous response

​
created_at_min
string
​
created_at_max
string
​
updated_at_min
string
​
updated_at_max
string

Response

200
application/json

200

The response is of type object.