Create Order

cURL

curl --request POST \
  --url https://api.loyaltylion.com/v2/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<unknown>",
  "customer_email": "<string>",
  "merchant_id": "<string>",
  "total": "<string>",
  "total_shipping": "<string>",
  "total_paid": "<unknown>",
  "merchant_number": "<unknown>",
  "number": "<unknown>",
  "discount_codes": "<unknown>",
  "claimed_reward_ids": [
    123
  ],
  "date": "<string>",
  "ip_address": "<unknown>",
  "user_agent": "<string>",
  "referral_id": "<string>",
  "tracking_id": "<string>",
  "guest": true,
  "line_items": [
    {
      "product_id": "<string>",
      "title": "<string>",
      "quantity": 2,
      "unit_price": "<string>",
      "variant_id": "<string>",
      "sku": "<string>",
      "total_discount": "<string>",
      "total_tax": "<string>"
    }
  ],
  "taxes_included": true
}
'

import requests

url = "https://api.loyaltylion.com/v2/orders"

payload = {
    "customer_id": "<unknown>",
    "customer_email": "<string>",
    "merchant_id": "<string>",
    "total": "<string>",
    "total_shipping": "<string>",
    "total_paid": "<unknown>",
    "merchant_number": "<unknown>",
    "number": "<unknown>",
    "discount_codes": "<unknown>",
    "claimed_reward_ids": [123],
    "date": "<string>",
    "ip_address": "<unknown>",
    "user_agent": "<string>",
    "referral_id": "<string>",
    "tracking_id": "<string>",
    "guest": True,
    "line_items": [
        {
            "product_id": "<string>",
            "title": "<string>",
            "quantity": 2,
            "unit_price": "<string>",
            "variant_id": "<string>",
            "sku": "<string>",
            "total_discount": "<string>",
            "total_tax": "<string>"
        }
    ],
    "taxes_included": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '<unknown>',
    customer_email: '<string>',
    merchant_id: '<string>',
    total: '<string>',
    total_shipping: '<string>',
    total_paid: '<unknown>',
    merchant_number: '<unknown>',
    number: '<unknown>',
    discount_codes: '<unknown>',
    claimed_reward_ids: [123],
    date: '<string>',
    ip_address: '<unknown>',
    user_agent: '<string>',
    referral_id: '<string>',
    tracking_id: '<string>',
    guest: true,
    line_items: [
      {
        product_id: '<string>',
        title: '<string>',
        quantity: 2,
        unit_price: '<string>',
        variant_id: '<string>',
        sku: '<string>',
        total_discount: '<string>',
        total_tax: '<string>'
      }
    ],
    taxes_included: true
  })
};

fetch('https://api.loyaltylion.com/v2/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loyaltylion.com/v2/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '<unknown>',
    'customer_email' => '<string>',
    'merchant_id' => '<string>',
    'total' => '<string>',
    'total_shipping' => '<string>',
    'total_paid' => '<unknown>',
    'merchant_number' => '<unknown>',
    'number' => '<unknown>',
    'discount_codes' => '<unknown>',
    'claimed_reward_ids' => [
        123
    ],
    'date' => '<string>',
    'ip_address' => '<unknown>',
    'user_agent' => '<string>',
    'referral_id' => '<string>',
    'tracking_id' => '<string>',
    'guest' => true,
    'line_items' => [
        [
                'product_id' => '<string>',
                'title' => '<string>',
                'quantity' => 2,
                'unit_price' => '<string>',
                'variant_id' => '<string>',
                'sku' => '<string>',
                'total_discount' => '<string>',
                'total_tax' => '<string>'
        ]
    ],
    'taxes_included' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loyaltylion.com/v2/orders"

	payload := strings.NewReader("{\n  \"customer_id\": \"<unknown>\",\n  \"customer_email\": \"<string>\",\n  \"merchant_id\": \"<string>\",\n  \"total\": \"<string>\",\n  \"total_shipping\": \"<string>\",\n  \"total_paid\": \"<unknown>\",\n  \"merchant_number\": \"<unknown>\",\n  \"number\": \"<unknown>\",\n  \"discount_codes\": \"<unknown>\",\n  \"claimed_reward_ids\": [\n    123\n  ],\n  \"date\": \"<string>\",\n  \"ip_address\": \"<unknown>\",\n  \"user_agent\": \"<string>\",\n  \"referral_id\": \"<string>\",\n  \"tracking_id\": \"<string>\",\n  \"guest\": true,\n  \"line_items\": [\n    {\n      \"product_id\": \"<string>\",\n      \"title\": \"<string>\",\n      \"quantity\": 2,\n      \"unit_price\": \"<string>\",\n      \"variant_id\": \"<string>\",\n      \"sku\": \"<string>\",\n      \"total_discount\": \"<string>\",\n      \"total_tax\": \"<string>\"\n    }\n  ],\n  \"taxes_included\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.loyaltylion.com/v2/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"<unknown>\",\n  \"customer_email\": \"<string>\",\n  \"merchant_id\": \"<string>\",\n  \"total\": \"<string>\",\n  \"total_shipping\": \"<string>\",\n  \"total_paid\": \"<unknown>\",\n  \"merchant_number\": \"<unknown>\",\n  \"number\": \"<unknown>\",\n  \"discount_codes\": \"<unknown>\",\n  \"claimed_reward_ids\": [\n    123\n  ],\n  \"date\": \"<string>\",\n  \"ip_address\": \"<unknown>\",\n  \"user_agent\": \"<string>\",\n  \"referral_id\": \"<string>\",\n  \"tracking_id\": \"<string>\",\n  \"guest\": true,\n  \"line_items\": [\n    {\n      \"product_id\": \"<string>\",\n      \"title\": \"<string>\",\n      \"quantity\": 2,\n      \"unit_price\": \"<string>\",\n      \"variant_id\": \"<string>\",\n      \"sku\": \"<string>\",\n      \"total_discount\": \"<string>\",\n      \"total_tax\": \"<string>\"\n    }\n  ],\n  \"taxes_included\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loyaltylion.com/v2/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"<unknown>\",\n  \"customer_email\": \"<string>\",\n  \"merchant_id\": \"<string>\",\n  \"total\": \"<string>\",\n  \"total_shipping\": \"<string>\",\n  \"total_paid\": \"<unknown>\",\n  \"merchant_number\": \"<unknown>\",\n  \"number\": \"<unknown>\",\n  \"discount_codes\": \"<unknown>\",\n  \"claimed_reward_ids\": [\n    123\n  ],\n  \"date\": \"<string>\",\n  \"ip_address\": \"<unknown>\",\n  \"user_agent\": \"<string>\",\n  \"referral_id\": \"<string>\",\n  \"tracking_id\": \"<string>\",\n  \"guest\": true,\n  \"line_items\": [\n    {\n      \"product_id\": \"<string>\",\n      \"title\": \"<string>\",\n      \"quantity\": 2,\n      \"unit_price\": \"<string>\",\n      \"variant_id\": \"<string>\",\n      \"sku\": \"<string>\",\n      \"total_discount\": \"<string>\",\n      \"total_tax\": \"<string>\"\n    }\n  ],\n  \"taxes_included\": true\n}"

response = http.request(request)
puts response.read_body

""

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": {}
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": {}
  }
}

POST

orders

cURL

curl --request POST \
  --url https://api.loyaltylion.com/v2/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<unknown>",
  "customer_email": "<string>",
  "merchant_id": "<string>",
  "total": "<string>",
  "total_shipping": "<string>",
  "total_paid": "<unknown>",
  "merchant_number": "<unknown>",
  "number": "<unknown>",
  "discount_codes": "<unknown>",
  "claimed_reward_ids": [
    123
  ],
  "date": "<string>",
  "ip_address": "<unknown>",
  "user_agent": "<string>",
  "referral_id": "<string>",
  "tracking_id": "<string>",
  "guest": true,
  "line_items": [
    {
      "product_id": "<string>",
      "title": "<string>",
      "quantity": 2,
      "unit_price": "<string>",
      "variant_id": "<string>",
      "sku": "<string>",
      "total_discount": "<string>",
      "total_tax": "<string>"
    }
  ],
  "taxes_included": true
}
'

import requests

url = "https://api.loyaltylion.com/v2/orders"

payload = {
    "customer_id": "<unknown>",
    "customer_email": "<string>",
    "merchant_id": "<string>",
    "total": "<string>",
    "total_shipping": "<string>",
    "total_paid": "<unknown>",
    "merchant_number": "<unknown>",
    "number": "<unknown>",
    "discount_codes": "<unknown>",
    "claimed_reward_ids": [123],
    "date": "<string>",
    "ip_address": "<unknown>",
    "user_agent": "<string>",
    "referral_id": "<string>",
    "tracking_id": "<string>",
    "guest": True,
    "line_items": [
        {
            "product_id": "<string>",
            "title": "<string>",
            "quantity": 2,
            "unit_price": "<string>",
            "variant_id": "<string>",
            "sku": "<string>",
            "total_discount": "<string>",
            "total_tax": "<string>"
        }
    ],
    "taxes_included": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '<unknown>',
    customer_email: '<string>',
    merchant_id: '<string>',
    total: '<string>',
    total_shipping: '<string>',
    total_paid: '<unknown>',
    merchant_number: '<unknown>',
    number: '<unknown>',
    discount_codes: '<unknown>',
    claimed_reward_ids: [123],
    date: '<string>',
    ip_address: '<unknown>',
    user_agent: '<string>',
    referral_id: '<string>',
    tracking_id: '<string>',
    guest: true,
    line_items: [
      {
        product_id: '<string>',
        title: '<string>',
        quantity: 2,
        unit_price: '<string>',
        variant_id: '<string>',
        sku: '<string>',
        total_discount: '<string>',
        total_tax: '<string>'
      }
    ],
    taxes_included: true
  })
};

fetch('https://api.loyaltylion.com/v2/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loyaltylion.com/v2/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '<unknown>',
    'customer_email' => '<string>',
    'merchant_id' => '<string>',
    'total' => '<string>',
    'total_shipping' => '<string>',
    'total_paid' => '<unknown>',
    'merchant_number' => '<unknown>',
    'number' => '<unknown>',
    'discount_codes' => '<unknown>',
    'claimed_reward_ids' => [
        123
    ],
    'date' => '<string>',
    'ip_address' => '<unknown>',
    'user_agent' => '<string>',
    'referral_id' => '<string>',
    'tracking_id' => '<string>',
    'guest' => true,
    'line_items' => [
        [
                'product_id' => '<string>',
                'title' => '<string>',
                'quantity' => 2,
                'unit_price' => '<string>',
                'variant_id' => '<string>',
                'sku' => '<string>',
                'total_discount' => '<string>',
                'total_tax' => '<string>'
        ]
    ],
    'taxes_included' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loyaltylion.com/v2/orders"

	payload := strings.NewReader("{\n  \"customer_id\": \"<unknown>\",\n  \"customer_email\": \"<string>\",\n  \"merchant_id\": \"<string>\",\n  \"total\": \"<string>\",\n  \"total_shipping\": \"<string>\",\n  \"total_paid\": \"<unknown>\",\n  \"merchant_number\": \"<unknown>\",\n  \"number\": \"<unknown>\",\n  \"discount_codes\": \"<unknown>\",\n  \"claimed_reward_ids\": [\n    123\n  ],\n  \"date\": \"<string>\",\n  \"ip_address\": \"<unknown>\",\n  \"user_agent\": \"<string>\",\n  \"referral_id\": \"<string>\",\n  \"tracking_id\": \"<string>\",\n  \"guest\": true,\n  \"line_items\": [\n    {\n      \"product_id\": \"<string>\",\n      \"title\": \"<string>\",\n      \"quantity\": 2,\n      \"unit_price\": \"<string>\",\n      \"variant_id\": \"<string>\",\n      \"sku\": \"<string>\",\n      \"total_discount\": \"<string>\",\n      \"total_tax\": \"<string>\"\n    }\n  ],\n  \"taxes_included\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.loyaltylion.com/v2/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"<unknown>\",\n  \"customer_email\": \"<string>\",\n  \"merchant_id\": \"<string>\",\n  \"total\": \"<string>\",\n  \"total_shipping\": \"<string>\",\n  \"total_paid\": \"<unknown>\",\n  \"merchant_number\": \"<unknown>\",\n  \"number\": \"<unknown>\",\n  \"discount_codes\": \"<unknown>\",\n  \"claimed_reward_ids\": [\n    123\n  ],\n  \"date\": \"<string>\",\n  \"ip_address\": \"<unknown>\",\n  \"user_agent\": \"<string>\",\n  \"referral_id\": \"<string>\",\n  \"tracking_id\": \"<string>\",\n  \"guest\": true,\n  \"line_items\": [\n    {\n      \"product_id\": \"<string>\",\n      \"title\": \"<string>\",\n      \"quantity\": 2,\n      \"unit_price\": \"<string>\",\n      \"variant_id\": \"<string>\",\n      \"sku\": \"<string>\",\n      \"total_discount\": \"<string>\",\n      \"total_tax\": \"<string>\"\n    }\n  ],\n  \"taxes_included\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loyaltylion.com/v2/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"<unknown>\",\n  \"customer_email\": \"<string>\",\n  \"merchant_id\": \"<string>\",\n  \"total\": \"<string>\",\n  \"total_shipping\": \"<string>\",\n  \"total_paid\": \"<unknown>\",\n  \"merchant_number\": \"<unknown>\",\n  \"number\": \"<unknown>\",\n  \"discount_codes\": \"<unknown>\",\n  \"claimed_reward_ids\": [\n    123\n  ],\n  \"date\": \"<string>\",\n  \"ip_address\": \"<unknown>\",\n  \"user_agent\": \"<string>\",\n  \"referral_id\": \"<string>\",\n  \"tracking_id\": \"<string>\",\n  \"guest\": true,\n  \"line_items\": [\n    {\n      \"product_id\": \"<string>\",\n      \"title\": \"<string>\",\n      \"quantity\": 2,\n      \"unit_price\": \"<string>\",\n      \"variant_id\": \"<string>\",\n      \"sku\": \"<string>\",\n      \"total_discount\": \"<string>\",\n      \"total_tax\": \"<string>\"\n    }\n  ],\n  \"taxes_included\": true\n}"

response = http.request(request)
puts response.read_body

""

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": {}
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": {}
  }
}

Add a new order to LoyaltyLion. This may trigger rules and award points to a customer. Merchants using a supported platform such as Shopify should usually not use this endpoint, as LoyaltyLion will retrieve orders from the platform via webhooks instead.

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

Scopes

write_orders

Query Parameters

site_id

number

Create the order in the specified site. This is only required for programs that have multiple sites. Programs with only a single site can omit this parameter, and the order will be created in the program's only site

Body

application/json

Body

customer_id

string | null

required

The ID of the customer in your platform or ecommerce store who placed the order

customer_email

string

The email address of the customer who placed the order

merchant_id

The ID of the order in your platform or ecommerce store

total

The total amount of order as a decimal string without formatting, e.g. 99.99

total_shipping

The total shipping amount for the order as a decimal string without formatting, e.g. 3.49

total_paid

string | null

The total amount paid for the order as a decimal string without formatting, e.g. 9.99

payment_status

enum<string>

Available options:

not_paid,

partially_paid,

paid

merchant_number

string | null

A optional order number to identify this order in your system

number

string | null

discount_codes

any

claimed_reward_ids

number[]

A list of LoyaltyLion claimed reward IDs that were used with this order

date

string

An ISO 8601 timestamp representing the date of the order. Defaults to now if not provided

ip_address

string | null

The IP address of the customer who placed the order. Used to track referrals

user_agent

string

The user agent of the customer who placed the order. Used to track referrals

referral_id

string

A LoyaltyLion referral ID, used to link this order to a referral

tracking_id

string

A LoyaltyLion tracking ID, used to link this order to a tracking source

guest

boolean

Whether this order was placed by a guest customer

line_items

object[]

The items in the order, up to 500

Maximum array length: 500

Show child attributes

taxes_included

boolean

Whether the unit_price of each line item includes tax. Defaults to false

Response

201

The response is of type string.

Allowed value: ""

Admin API

Resources

Webhooks

Authorizations

Scopes

Query Parameters

Body

Response