Orders

Orders represent the purchases made by customers in your e-commerce platform. They contain information about the transaction, associated products, pricing, and discount details. All order endpoints are scoped to a language.

The order model

The order model contains all the information about a customer purchase, including the products ordered, pricing, status, and any custom attributes you have defined.

Properties

Name
id
Type
string
Description
Unique identifier for the order.
Name
ordered_at
Type
datetime
Description
The date and time when the order was placed.
Name
profile_id
Type
string
Description
The unique identifier of the profile (customer) who placed the order.
Name
product_ids
Type
array
Description
An array of product identifiers included in the order.
Name
currency
Type
string
Description
The currency code used for the order (e.g., EUR, USD).
Name
created_at
Type
datetime
Description
The date and time when the order record was created.
Name
checkout_id
Type
string
Description
The identifier of the checkout session associated with this order.
Name
number
Type
string
Description
The human-readable order number.
Name
price
Type
number
Description
The total price of the order.
Name
status
Type
string
Description
The current status of the order (e.g., pending, completed, cancelled).
Name
discount_code
Type
string
Description
The discount code applied to the order, if any.
Name
is_discount_applied
Type
boolean
Description
Whether a discount was applied to the order.
Name
paid
Type
boolean
Description
Whether the order has been paid.
Name
custom_attributes
Type
array
Description
An array of custom attribute objects with name and a value field (string_value, integer_value, date_value, datetime_value, or boolean_value).

GET/v2/languages/:language_id/orders

List all orders

This endpoint allows you to retrieve a paginated list of all orders for a given language. By default, a maximum of ten orders are shown per page, with a maximum of 250 per page.

Optional attributes

Name
page
Type
integer
Description
Page offset to fetch. Defaults to 1.
Name
per_page
Type
integer
Description
Number of orders per page. Defaults to 10, maximum 250.
Name
created_after
Type
timestamp
Description
Only return orders created after this date.
Name
created_before
Type
timestamp
Description
Only return orders created before this date.
Name
updated_after
Type
timestamp
Description
Only return orders updated after this date.
Name
updated_before
Type
timestamp
Description
Only return orders updated before this date.

Request

GET

/v2/languages/:language_id/orders

curl -G https://app.reloadify.com/api/v2/languages/en/orders \
  -H "Authorization: Bearer {token}" \
  -d per_page=10 \
  -d page=1

Response

{
  "data": [
    {
      "id": "ord_abc123",
      "ordered_at": "2026-03-15T14:32:00Z",
      "profile_id": "prof_abc123",
      "product_ids": ["prod_001", "prod_002"],
      "currency": "EUR",
      "created_at": "2026-03-15T14:32:00Z",
      "checkout_id": "chk_789",
      "number": "ORD-10042",
      "price": 89.95,
      "status": "completed",
      "discount_code": "SPRING10",
      "is_discount_applied": true,
      "paid": true,
      "custom_attributes": [
        {
          "name": "shipping_method",
          "string_value": "express"
        }
      ]
    },
    {
      "id": "ord_def456"
      // ...
    }
  ]
}

PUT/v2/languages/:language_id/orders

Create or update an order

This endpoint allows you to create a new order or update an existing one. If an order with the given ID already exists, it will be updated. The request body must be wrapped in an order object.

Required attributes

Name
id
Type
string
Description
The unique identifier for the order in your system.
Name
ordered_at
Type
datetime
Description
The date and time when the order was placed.
Name
profile_id
Type
string
Description
The unique identifier of the profile (customer) who placed the order.

Optional attributes

Name
currency
Type
string
Description
The currency code used for the order (e.g., EUR, USD).
Name
created_at
Type
datetime
Description
The date and time when the order record was created.
Name
checkout_id
Type
string
Description
The identifier of the checkout session associated with this order.
Name
number
Type
string
Description
The human-readable order number.
Name
price
Type
number
Description
The total price of the order.
Name
status
Type
string
Description
The current status of the order (e.g., pending, completed, cancelled).
Name
discount_code
Type
string
Description
The discount code applied to the order.
Name
is_discount_applied
Type
boolean
Description
Whether a discount was applied to the order.
Name
paid
Type
boolean
Description
Whether the order has been paid.
Name
custom_attributes
Type
array
Description
An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

Request

PUT

/v2/languages/:language_id/orders

curl -X PUT https://app.reloadify.com/api/v2/languages/en/orders \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "id": "ord_abc123",
      "ordered_at": "2026-03-15T14:32:00Z",
      "profile_id": "prof_abc123",
      "currency": "EUR",
      "number": "ORD-10042",
      "price": 89.95,
      "status": "completed",
      "discount_code": "SPRING10",
      "is_discount_applied": true,
      "paid": true,
      "custom_attributes": [
        {
          "name": "shipping_method",
          "string_value": "express"
        }
      ]
    }
  }'

Response

{
  "id": "ord_abc123",
  "ordered_at": "2026-03-15T14:32:00Z",
  "profile_id": "prof_abc123",
  "product_ids": [],
  "currency": "EUR",
  "created_at": "2026-03-15T14:32:00Z",
  "checkout_id": null,
  "number": "ORD-10042",
  "price": 89.95,
  "status": "completed",
  "discount_code": "SPRING10",
  "is_discount_applied": true,
  "paid": true,
  "custom_attributes": [
    {
      "name": "shipping_method",
      "string_value": "express"
    }
  ]
}

GET/v2/languages/:language_id/orders/:order_id

Retrieve an order

This endpoint allows you to retrieve an order by providing the order ID. Refer to the model at the top of this page to see which properties are included with order objects.

Request

GET

/v2/languages/en/orders/ord_abc123

curl https://app.reloadify.com/api/v2/languages/en/orders/ord_abc123 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "ord_abc123",
  "ordered_at": "2026-03-15T14:32:00Z",
  "profile_id": "prof_abc123",
  "product_ids": ["prod_001", "prod_002"],
  "currency": "EUR",
  "created_at": "2026-03-15T14:32:00Z",
  "checkout_id": "chk_789",
  "number": "ORD-10042",
  "price": 89.95,
  "status": "completed",
  "discount_code": "SPRING10",
  "is_discount_applied": true,
  "paid": true,
  "custom_attributes": [
    {
      "name": "shipping_method",
      "string_value": "express"
    }
  ]
}

DELETE/v2/languages/:language_id/orders/:order_id

Delete an order

This endpoint allows you to delete an order. Be careful — this action is irreversible and will remove all data associated with the order.

Request

DELETE

/v2/languages/en/orders/ord_abc123

curl -X DELETE https://app.reloadify.com/api/v2/languages/en/orders/ord_abc123 \
  -H "Authorization: Bearer {token}"

GET/v2/languages/:language_id/orders/:order_id/products

List order products

This endpoint allows you to retrieve all products associated with a specific order. The response includes the product details for each item in the order.

Request

GET

/v2/languages/en/orders/ord_abc123/products

curl https://app.reloadify.com/api/v2/languages/en/orders/ord_abc123/products \
  -H "Authorization: Bearer {token}"

Response

{
  "data": [
    {
      "id": "prod_001",
      "variant_id": "var_001",
      "quantity": 2,
      "custom_attributes": []
    },
    {
      "id": "prod_002",
      "variant_id": null,
      "quantity": 1,
      "custom_attributes": []
    }
  ]
}

PUT/v2/languages/:language_id/orders/:order_id/products/:product_id

Add a product to an order

This endpoint allows you to add a product to an existing order. You must provide the quantity, and you can optionally include a variant ID and custom attributes.

Required attributes

Name
quantity
Type
integer
Description
The quantity of the product to add to the order.

Optional attributes

Name
variant_id
Type
string
Description
The variant identifier for the product, if applicable.
Name
custom_attributes
Type
array
Description
An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

Request

PUT

/v2/languages/en/orders/ord_abc123/products/prod_003

curl -X PUT https://app.reloadify.com/api/v2/languages/en/orders/ord_abc123/products/prod_003 \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 3,
    "variant_id": "var_005",
    "custom_attributes": [
      {
        "name": "gift_wrap",
        "boolean_value": true
      }
    ]
  }'

Response

{
  "id": "prod_003",
  "variant_id": "var_005",
  "quantity": 3,
  "custom_attributes": [
    {
      "name": "gift_wrap",
      "boolean_value": true
    }
  ]
}

DELETE/v2/languages/:language_id/orders/:order_id/products/:product_id

Remove a product from an order

This endpoint allows you to remove a product from an order. You can optionally pass a variant_id query parameter to remove a specific variant of the product.

Optional attributes

Name
variant_id
Type
string
Description
The variant identifier to remove. If omitted, the product itself will be removed regardless of variant.

Request

DELETE

/v2/languages/en/orders/ord_abc123/products/prod_003

curl -X DELETE https://app.reloadify.com/api/v2/languages/en/orders/ord_abc123/products/prod_003 \
  -H "Authorization: Bearer {token}" \
  -d variant_id=var_005