Flow Unified API
API ReferenceRetail POS

Order · order

Portable POS order contract with source order identity, status, party references, and normalized line items. currencyCode and locationExternalId matter when targeting Square; lineItems[].productExternalId matters when targeting Lightspeed X-Series sales.

Entity type: order · Methods: GET · POST

Portable POS order contract with source order identity, status, party references, and normalized line items. currencyCode and locationExternalId matter when targeting Square; lineItems[].productExternalId matters when targeting Lightspeed X-Series sales.

Endpoints

GET  /unified/{accountId}/order   # List normalized order records
POST /unified/{accountId}/order   # Create / push one order

Schema

FieldTypeRequiredDescription
externalIdstringYesStable source order identifier. Used as the idempotency key on writes.
orderNumberstringHuman-readable order number / receipt / ticket label.
processedAtstring · ISO 8601Order creation or processing timestamp when available.
customerExternalIdstringSource customer identifier for mapping into target customer ids.
locationExternalIdstringSource location / outlet identifier for targets that require a location mapping.
currencyCodestring · ISO 42173-letter currency code when available.
stateenumNormalized order state. Values: OPEN, COMPLETED, CANCELED, PENDING.
notestringInternal or customer-visible order note.
totalnumberOrder total in major currency units.
taxTotalnumberOrder tax total in major currency units.
lineItemsobject[]YesNormalized order lines. At least one line is required.
lineItems[].productExternalIdstringSource product identifier for line-item product mapping.
lineItems[].skustringSource SKU when present.
lineItems[].namestringLine-item display name; product id can serve as a fallback label.
lineItems[].quantitynumber · > 0YesOrdered quantity.
lineItems[].unitPricenumberUnit price in major currency units.
lineItems[].lineTaxnumberLine tax total in major currency units.
lineItems[].lineDiscountnumberLine discount total in major currency units.

Example object

{
  "externalId": "ord_55310",
  "orderNumber": "R-2210",
  "processedAt": "2026-07-08T17:20:45Z",
  "customerExternalId": "cus_00417",
  "locationExternalId": "loc_soho",
  "currencyCode": "USD",
  "state": "COMPLETED",
  "total": 128,
  "taxTotal": 10.24,
  "lineItems": [
    {
      "productExternalId": "prd_tee_black_m",
      "sku": "TEE-BLK-M",
      "name": "Organic Tee — Black / M",
      "quantity": 2,
      "unitPrice": 32
    },
    {
      "productExternalId": "prd_tote",
      "sku": "TOTE-01",
      "name": "Canvas Tote",
      "quantity": 1,
      "unitPrice": 64
    }
  ]
}

The same shape is used as the POST request body and returned by GET reads — reads from every connected system are normalized to it.

Requests

read order
curl "https://dev.flow.staging.linktoany.com/api/1.0/standalone-link-engine-service/unified/{accountId}/order?mappingKey={readKey}&pageSize=50" \
  -H "authorization: Bearer <token>"
write order
curl -X POST "https://dev.flow.staging.linktoany.com/api/1.0/standalone-link-engine-service/unified/{accountId}/order?mappingKey={writeKey}" \
  -H "authorization: Bearer <token>" \
  -H "content-type: application/json" \
  -d '{"externalId":"ord_55310","orderNumber":"R-2210","processedAt":"2026-07-08T17:20:45Z","customerExternalId":"cus_00417","locationExternalId":"loc_soho","currencyCode":"USD","state":"COMPLETED","total":128,"taxTotal":10.24,"lineItems":[{"productExternalId":"prd_tee_black_m","sku":"TEE-BLK-M","name":"Organic Tee — Black / M","quantity":2,"unitPrice":32},{"productExternalId":"prd_tote","sku":"TOTE-01","name":"Canvas Tote","quantity":1,"unitPrice":64}]}'

Supported systems

SystemReadWriteAuthRate limit
ShopifyYesYesOAuth 2.01 req / s
Lightspeed X-SeriesYesYesOAuth 2.05 req / s · 300 req / min
SquareYesYesOAuth 2.05 req / s

On this page