Order - LiteCore API Reference

Order details

reference

string

required

Order reference

Example:

"ORD-123456"

items

object

Order line items

Show child attributes

shipping_address

object

Address information

Show child attributes

billing_address

object

Address information

Show child attributes

amount

integer

Order amount in minor units

Required range: x >= 0

Example:

10000

currency

string

Currency code (ISO 4217)

Required string length: 3

Pattern: ^[A-Z]{3}$

Example:

"SAR"

description

string

Order description

Example:

"Order description"

OrderItemsOrder line items

{
  "reference": "ORD-123456",
  "items": {
    "products": [
      {
        "id": "prod_123",
        "price": 5000,
        "quantity": 2,
        "name": "T-Shirt",
        "metadata": {
          "color": "Blue",
          "size": "L"
        }
      }
    ],
    "vat": {
      "amount": 750
    },
    "shipping": {
      "amount": 1000
    }
  },
  "shipping_address": {
    "name": "John Doe",
    "email": "john@example.com",
    "street": "123 Main St",
    "city": "Riyadh",
    "state": "Riyadh Region",
    "zip": "12213",
    "country": "SA"
  },
  "billing_address": {
    "name": "John Doe",
    "email": "john@example.com",
    "street": "123 Main St",
    "city": "Riyadh",
    "state": "Riyadh Region",
    "zip": "12213",
    "country": "SA"
  },
  "amount": 10000,
  "currency": "SAR",
  "description": "Order description"
}