curl --request POST \
  --url https://sandbox.api.leyyow.com/api/public/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_name": "Ada Okafor",
  "customer_email": "ada@example.com",
  "customer_phone": "+2348012345678",
  "items": [
    {
      "variant": "550e8400-e29b-41d4-a716-446655440000",
      "popup_inventory": null,
      "quantity": 2,
      "notes": ""
    }
  ],
  "delivery_address": "12 Example Street, Lagos",
  "delivery_method": "manual",
  "fulfilment_method": "delivery",
  "payment_source": "paystack",
  "courier": {},
  "rate": "",
  "manual_delivery_option": "7bf56f3d-20c2-4a52-b5d2-a1a98610e79f"
}
'

{
  "error": null,
  "message": "Request successful.",
  "data": {
    "order": {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "LYW-10482",
      "source": "storefront",
      "store": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "store_name": "<string>",
      "store_email": "jsmith@example.com",
      "store_phone": "<string>",
      "logo": "<string>",
      "location": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_name": "<string>",
      "customer": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_name": "<string>",
      "customer_phone": "<string>",
      "customer_email": "jsmith@example.com",
      "customer_address": "<string>",
      "user": "<string>",
      "total_amount": "45000.00",
      "subtotal": "45000.00",
      "discount_amount": "45000.00",
      "tax_amount": "45000.00",
      "tax_rate_used": "7.50",
      "total_paid": 123,
      "outstanding_balance": 123,
      "payment_status": "pending",
      "payment_status_display": "Pending",
      "fulfilment_status": "<string>",
      "fulfilment_status_display": "<string>",
      "fulfilment_method": "pickup",
      "delivery_fee": "45000.00",
      "manual_delivery_type": "<string>",
      "delivery_address": "<string>",
      "delivery_method": "<string>",
      "courier": {},
      "rate": "<string>",
      "tracking_number": "<string>",
      "has_shipping": true,
      "order_date": "2023-11-07T05:31:56Z",
      "shipping_details": {},
      "coupon": "<string>",
      "items": [
        {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variant": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variant_name": "<string>",
          "variant_sku": "<string>",
          "product_name": "<string>",
          "image": "<string>",
          "popup_inventory": "<string>",
          "quantity": 123,
          "unit_price": "45000.00",
          "total_price": "45000.00",
          "fulfilment_status": "<string>",
          "qty_fulfilled": 123,
          "notes": "<string>",
          "attributes": [
            {
              "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "attribute": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "attribute_name": "Size",
              "attribute_value": "Medium"
            }
          ],
          "product_images": [
            {
              "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "image": "<string>",
              "alt_text": "<string>",
              "is_primary": true,
              "order": 123,
              "sort_order": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "created_at": "2023-11-07T05:31:56Z"
    },
    "payment": {
      "payment_link": "<string>"
    }
  }
}

{
  "error": "manual_delivery_option is required when delivery_method is manual.",
  "message": "Order could not be created.",
  "data": null
}

{
  "error": "Invalid or revoked API key.",
  "message": "Authentication failed.",
  "data": null
}

{
  "error": "Product not found.",
  "message": "The requested resource does not exist.",
  "data": null
}

{
  "error": "Insufficient sellable stock for one or more items.",
  "message": "Order could not be created.",
  "data": null
}

{
  "error": "Shipping quote has expired.",
  "message": "Order could not be created.",
  "data": null
}

{
  "error": "Rate limit exceeded.",
  "message": "Too many requests.",
  "data": null
}

Orders

Create order

Creates an order and returns a Paystack payment link. The order is saved with source storefront and appears in the suite as Website.

Send the customer’s choices only. Leyyow validates stock, then calculates unit prices, tax, delivery fee, and total server-side.

Fulfilment field combinations

The delivery fields must be sent as a matching set:

Customer choice	`fulfilment_method`	`delivery_method`	`manual_delivery_option`	`rate`	`courier`
Pickup	`pickup`	`null`	`null`	`""`	`{}`
Manual or Express	`delivery`	`manual`	option `uid`	`""`	`{}`
Managed (ShipBubble)	`delivery`	`shipbubble`	`null`	quote `request_token`	chosen `Courier`

After payment, Paystack returns the customer to the Checkout Return URL saved in the suite.

POST

api

public

orders

curl --request POST \
  --url https://sandbox.api.leyyow.com/api/public/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_name": "Ada Okafor",
  "customer_email": "ada@example.com",
  "customer_phone": "+2348012345678",
  "items": [
    {
      "variant": "550e8400-e29b-41d4-a716-446655440000",
      "popup_inventory": null,
      "quantity": 2,
      "notes": ""
    }
  ],
  "delivery_address": "12 Example Street, Lagos",
  "delivery_method": "manual",
  "fulfilment_method": "delivery",
  "payment_source": "paystack",
  "courier": {},
  "rate": "",
  "manual_delivery_option": "7bf56f3d-20c2-4a52-b5d2-a1a98610e79f"
}
'

{
  "error": null,
  "message": "Request successful.",
  "data": {
    "order": {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "LYW-10482",
      "source": "storefront",
      "store": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "store_name": "<string>",
      "store_email": "jsmith@example.com",
      "store_phone": "<string>",
      "logo": "<string>",
      "location": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_name": "<string>",
      "customer": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_name": "<string>",
      "customer_phone": "<string>",
      "customer_email": "jsmith@example.com",
      "customer_address": "<string>",
      "user": "<string>",
      "total_amount": "45000.00",
      "subtotal": "45000.00",
      "discount_amount": "45000.00",
      "tax_amount": "45000.00",
      "tax_rate_used": "7.50",
      "total_paid": 123,
      "outstanding_balance": 123,
      "payment_status": "pending",
      "payment_status_display": "Pending",
      "fulfilment_status": "<string>",
      "fulfilment_status_display": "<string>",
      "fulfilment_method": "pickup",
      "delivery_fee": "45000.00",
      "manual_delivery_type": "<string>",
      "delivery_address": "<string>",
      "delivery_method": "<string>",
      "courier": {},
      "rate": "<string>",
      "tracking_number": "<string>",
      "has_shipping": true,
      "order_date": "2023-11-07T05:31:56Z",
      "shipping_details": {},
      "coupon": "<string>",
      "items": [
        {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variant": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variant_name": "<string>",
          "variant_sku": "<string>",
          "product_name": "<string>",
          "image": "<string>",
          "popup_inventory": "<string>",
          "quantity": 123,
          "unit_price": "45000.00",
          "total_price": "45000.00",
          "fulfilment_status": "<string>",
          "qty_fulfilled": 123,
          "notes": "<string>",
          "attributes": [
            {
              "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "attribute": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "attribute_name": "Size",
              "attribute_value": "Medium"
            }
          ],
          "product_images": [
            {
              "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "image": "<string>",
              "alt_text": "<string>",
              "is_primary": true,
              "order": 123,
              "sort_order": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "created_at": "2023-11-07T05:31:56Z"
    },
    "payment": {
      "payment_link": "<string>"
    }
  }
}

{
  "error": "manual_delivery_option is required when delivery_method is manual.",
  "message": "Order could not be created.",
  "data": null
}

{
  "error": "Invalid or revoked API key.",
  "message": "Authentication failed.",
  "data": null
}

{
  "error": "Product not found.",
  "message": "The requested resource does not exist.",
  "data": null
}

{
  "error": "Insufficient sellable stock for one or more items.",
  "message": "Order could not be created.",
  "data": null
}

{
  "error": "Shipping quote has expired.",
  "message": "Order could not be created.",
  "data": null
}

{
  "error": "Rate limit exceeded.",
  "message": "Too many requests.",
  "data": null
}

Authorizations

Authorization

string

header

required

Store API key created in the Leyyow suite under Settings → Public API. Sent as Authorization: Bearer <key>.

Body

application/json

customer_name

string

required

Example:

"Ada Okafor"

customer_email

string<email>

required

customer_phone

string

required

Example:

"+2348012345678"

items

object[]

required

Minimum array length: 1

Show child attributes

fulfilment_method

enum<string>

required

Available options:

pickup,

delivery

payment_source

enum<string>

required

Available options:

paystack

delivery_address

string | null

Required when fulfilment_method is delivery.

delivery_method

enum<string> | null

manual for Manual or Express Delivery, shipbubble for Managed Delivery, null for pickup.

Available options:

manual,

shipbubble,

null

courier

object

The full Courier object from the shipping quote. Send {} for pickup and manual delivery.

rate

string

The request_token from the shipping quote. Send "" for pickup and manual delivery.

manual_delivery_option

string<uuid> | null

uid of the chosen delivery option. Required when delivery_method is manual, otherwise null.

Response

Order created.

error

string | null

required

Human-readable failure reason, or null on success.

Example:

null

message

string

required

Short status message.

Example:

"Request successful."

data

object

required

Response payload. null on failure.

Show child attributes

Getting Started

APIs

Create order

Fulfilment field combinations

Authorizations

Body

Response