Orders API

FOM ရဲ့ OpenAPI document ကနေ ထုတ်ထားပါတယ်။ Field ရှင်းလင်းချက်တွေက အင်္ဂလိပ်လို ဖြစ်ပါတယ်။ Request တိုင်းမှာ API key လိုပါတယ်၊ Authentication ကို ကြည့်ပါ။

order objectဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

List orders, newest first, or changes since a timeဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

GET /public/v1/orders

Scope: orders:read

Query parameter များဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

ပြန်ရမယ့်အရာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

order object များ တစ်မျက်နှာ (order object).

ဥပမာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

curl "https://api.getfom.com/public/v1/orders?limit=50&updated_since=2026-11-25T08%3A00%3A00.000Z" \
  -H "Authorization: Bearer $FOM_API_KEY"

Create an orderဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

POST /public/v1/orders

Scope: orders:write

Give a customer_id, or a customer with a phone: an existing customer with that phone is used. Items with a variant_id take its name and price unless you send them. Stock is taken when the order is confirmed.

Bodyဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

ပြန်ရမယ့်အရာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

order (order object).

ဥပမာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

curl -X POST "https://api.getfom.com/public/v1/orders" \
  -H "Authorization: Bearer $FOM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "customer": {
      "name": "Daw Aye Aye",
      "phone": "09 9871 2345",
      "township": "Hlaing"
    },
    "items": [
      {
        "name": "T-shirt (Red, M)",
        "qty": 2,
        "unit_price": 12000
      }
    ],
    "delivery_fee": 3000
  }'

One order with its items, customer and deliveryဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

GET /public/v1/orders/{orderId}

Scope: orders:read

Path parameter များဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

ပြန်ရမယ့်အရာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

order (order object).

ဥပမာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

curl "https://api.getfom.com/public/v1/orders/ORDER_ID" \
  -H "Authorization: Bearer $FOM_API_KEY"

Change an order's statusဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

POST /public/v1/orders/{orderId}/status

Scope: orders:write

Moves stock, deliveries and customer messages the same way as in FOM. Send expected_revision to be sure nobody changed the order since you read it.

Path parameter များဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

Bodyဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

ပြန်ရမယ့်အရာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

order (order object).

ဥပမာဤခေါင်းစဉ်၏ လင့်ခ် ကူးမည်

curl -X POST "https://api.getfom.com/public/v1/orders/ORDER_ID/status" \
  -H "Authorization: Bearer $FOM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "status": "confirmed",
    "expected_revision": 3
  }'