Orders

You can use the orders API to view, create and update orders in LoyaltyLion. This is necessary if you want to award points for placing orders.

GET /v2/orders

Returns a list of orders in LoyaltyLion.

Request

You can pass the following optional query parameters with the request.

Response

This endpoint returns a list of order resources.

Example

curl \
  --url 'https://api.loyaltylion.com/v2/orders?since_id=500' \
  --header 'Content-Type: application/json'

POST /v2/orders

Use this endpoint to track a new order in LoyaltyLion.

Request

You must provide a JSON payload with the following fields:

Discount code object

Response

Returns a 201 Created response if the order was created successfully. If the order was invalid, a 422 Unprocessable Entity response is returned.

Example

curl -X POST \
  --url 'https://api.loyaltylion.com/v2/orders' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchant_id": "6253e03b",
    "merchant_number": "1001",
    "customer_id": 100,
    "customer_email": "alice@example.com",
    "total": "99.95",
    "total_shipping": "5.00",
    "payment_status": "not_paid",
    "date": "2018-01-25T01:25:27+01:00",
    "discount_codes": [
      {
        "code": "AU7X-8Q7L",
        "amount": "5.00"
      }
    ]
  }'

PUT /v2/orders/:merchant_id

Use this endpoint to update an existing order in LoyaltyLion, using your internal (from your ecommerce platform) merchant_id to identify the order.

This is a full update and must include the order’s current payment, cancellation and refund status, including any relevant totals if required (total_paid and total_refunded).

The update endpoint is idempotent, so it’s safe to call it every time an order is updated in your system.

Request

You must provide a JSON payload with the following fields:

Response

Returns a 204 No Content response if the update was valid. If the order couldn’t be updated, a 422 Unprocessable Entity response is returned.

Example

curl -X PUT \
  --url 'https://api.loyaltylion.com/v2/orders/6253e03b' \
  --header 'Content-Type: application/json' \
  --data '{
    "payment_status": "partially_paid",
    "refund_status": "not_refunded",
    "cancellation_status": "not_cancelled",
    "total_paid": "50.00",
    "total_refunded": "0"
  }'

GET /v2/orders/:merchant_id

Return a single order, identified by your internal (from your ecommerce platform) merchant_id.

Because orders in LoyaltyLion are copies of your own orders, this isn’t particularly useful for most applications but can help during development.

Request

This endpoint doesn’t have any query parameters.

Response

This endpoint returns the order resource matching the provided merchant_id, or 404 Not Found if no order matches.

Payment object

Payment objects represent individual transactions, if your platform provides individual transaction information for orders. They may have additional fields depending on the platform and transaction method.

Refund object

Refund objects represent individual refund transactions, if your platform provides individual transaction information for order refunds. They may have additional fields depending on the platform and refund method.

Example

curl \
  --url 'https://api.loyaltylion.com/v2/orders/6253e03b' \
  --header 'Content-Type: application/json'