Get order

GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <your_api_key>

{
  "id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
  "orderCode": "OC-1024",
  "status": "COMPLETED",
  "orderLines": [
    { "productId": "p1", "quantity": 2 }
  ],
  "totals": [
    { "currencyCode": "USD", "total": 125000 }
  ]
}

{
  "orderCode": "OC-1024",
  "status": "OPEN",
  "settlement": {
    "status": "recorded",
    "origin": "ledger",
    "paidSoFar": "200000",
    "total": "359000",
    "currencyCode": "BRL",
    "tenderCount": 1,
    "declinedCount": 0,
    "amountMismatch": true
  },
  "payments": [
    {
      "status": "approved",
      "amount": "200000",
      "currencyCode": "BRL",
      "method": "CASH",
      "transactionId": "POS-0001",
      "occurredAt": "2026-07-30T16:20:04.000Z"
    }
  ]
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "External order id ORD-77 matches 2 orders across vendors; cannot disambiguate"
}

{
  "success": false,
  "error": "NOT_FOUND",
  "message": "Order not found with ID 7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
}

GET

api

fire

external

orders

{orderId}

GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <your_api_key>

{
  "id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
  "orderCode": "OC-1024",
  "status": "COMPLETED",
  "orderLines": [
    { "productId": "p1", "quantity": 2 }
  ],
  "totals": [
    { "currencyCode": "USD", "total": 125000 }
  ]
}

{
  "orderCode": "OC-1024",
  "status": "OPEN",
  "settlement": {
    "status": "recorded",
    "origin": "ledger",
    "paidSoFar": "200000",
    "total": "359000",
    "currencyCode": "BRL",
    "tenderCount": 1,
    "declinedCount": 0,
    "amountMismatch": true
  },
  "payments": [
    {
      "status": "approved",
      "amount": "200000",
      "currencyCode": "BRL",
      "method": "CASH",
      "transactionId": "POS-0001",
      "occurredAt": "2026-07-30T16:20:04.000Z"
    }
  ]
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "External order id ORD-77 matches 2 orders across vendors; cannot disambiguate"
}

{
  "success": false,
  "error": "NOT_FOUND",
  "message": "Order not found with ID 7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
}

Returns a single order projected according to fields. If the order does not exist — or belongs to another tenant — the response is 404 (existence is never leaked across tenants).

Authentication

string

required

Your Fire API key with the orders:read scope. The key must be vendor-scoped — keys without a vendorId are rejected with 403.

Path parameters

string

required

Any of the order’s three public references:

reference	what it is
`orders.id`	Fire’s internal UUID
`order_external`	the id you assigned when creating the order
`metadata.order_id`	a copy of the external id inside the order

No translation needed: use the id you already have.

This is the same set of references accepted by Cancel order, so the id you created the order with also works to read it back.

Query parameters

string

Projection — see Field projection. Omit to return every field.

Request

GET https://api.fire.rest/api/v1/fire/external/orders/7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f?fields=id,orderCode,status,orderLines,totals
x-api-key: <your_api_key>

Response

A single order object, projected according to fields. See the full field list in Field projection. To follow an order that is being charged in parts, ask for settlement (how much has been collected) and payments (with what) — see Payment progress.

{
  "id": "7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
  "orderCode": "OC-1024",
  "status": "COMPLETED",
  "orderLines": [
    { "productId": "p1", "quantity": 2 }
  ],
  "totals": [
    { "currencyCode": "USD", "total": 125000 }
  ]
}

{
  "orderCode": "OC-1024",
  "status": "OPEN",
  "settlement": {
    "status": "recorded",
    "origin": "ledger",
    "paidSoFar": "200000",
    "total": "359000",
    "currencyCode": "BRL",
    "tenderCount": 1,
    "declinedCount": 0,
    "amountMismatch": true
  },
  "payments": [
    {
      "status": "approved",
      "amount": "200000",
      "currencyCode": "BRL",
      "method": "CASH",
      "transactionId": "POS-0001",
      "occurredAt": "2026-07-30T16:20:04.000Z"
    }
  ]
}

{
  "success": false,
  "error": "CONFLICT",
  "message": "External order id ORD-77 matches 2 orders across vendors; cannot disambiguate"
}

{
  "success": false,
  "error": "NOT_FOUND",
  "message": "Order not found with ID 7e2b8c10-1a2b-4c3d-8e9f-0a1b2c3d4e5f"
}

List orders

List all orders of your account and vendor.

List store orders

List the orders of a specific store.

API

Partner APIs

PayBridge

Authentication

Path parameters

Query parameters

Request

Response

List orders

List store orders

​Authentication

​Path parameters

​Query parameters

​Request

​Response

​Related

List orders

List store orders

Authentication

Path parameters

Query parameters

Request

Response

Related