Create Order

This endpoint records an order made by a customer. It will apply the order to all matching active campaigns and award the necessary points and/or discounts.

❗️

Note:

Customer Tags validation using the customer parameter is available for Shopify, Bigcommerce, Salesforce Commerce Cloud and Generic platforms.
These include/exclude tags must be configured through the Loyalty & Referrals Admin

❗️

Note:

Order Tags validation is available for Shopify, Magento and Generic platforms.
These include/exclude tags must be configured through the Loyalty & Referrals Admin

{
    "customer_email": "[email protected]",
    "total_amount_cents": "15000",
    "currency_code": "USD",
    "order_id": "testing1",
    "status":"paid",
    "created_at": "2019-05-25 20:59:53",
    "coupon_code": "SAVE5",
    "ip_address": "127.0.0.1",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36",
    "discount_amount_cents": "500",
    "items":
     [{
        "name":"Green Shirt",
    "price_cents":"1499",
    "vendor":"coolshirts,inc",
    "id":"472361372358",
    "type":"shirt",
    "quantity":2,
    "collections":"new_arrivals,new"
    }]
}
{
    "customer_email": "[email protected]",
    "total_amount_cents": "15000",
    "currency_code": "USD",
    "order_id": "testing1",
    "status": "paid",
    "created_at": "2019-05-25 20:59:53",
    "coupon_code": "SAVE5",
    "ip_address": "127.0.0.1",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36",
    "discount_amount_cents": "500",
    "items":
      [{
        "name": "Green Shirt",
        "price_cents": "1499",
        "vendor": "coolshirts,inc",
        "id": "472361372358",
        "type": "shirt",
        "quantity": 2,
        "collections": "new_arrivals,new",
    }],
  "customer":
    {
        "tags": "wholesale,non-loyalty",
        "has_account": "true",
        "opt_in": "true",
        "opted_in_at":"2019-05-25 20:59:53",
        }
}

Item Array

The item array should follow this structure:

"items": [{
        "name":"Green Shirt",
    "price_cents":"1499",
    "vendor":"coolshirts,inc",
    "id":"472361372358",
    "type":"shirt",
    "quantity":2,
    "collections":"new_arrivals,new"
    }]
}

Parameter

Type

Description

name

string

A customer facing name for the product.

price_cents

int

The total price of this item (per quantity) in cents.

vendor
Optional

string

The vendor of the product.

id

string

An identifier that uniquely identifies this product in your system.

type
Optional

string

A category or product type, used in filtering eligibility.

quantity

int

The quantity of this product purchased by the customer in this order.

collections
Optional

string

An comma separated list of all the collections (or tags) that this product belongs to.

Language
Response
Click Try It! to start a request and see the response here!