Update order status

curl --request PATCH \
  --url https://firespark.cloud/api/integrations/v1/orders/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>"
}
'

import requests

url = "https://firespark.cloud/api/integrations/v1/orders/{id}/status"

payload = { "status": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({status: '<string>'})
};

fetch('https://firespark.cloud/api/integrations/v1/orders/{id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://firespark.cloud/api/integrations/v1/orders/{id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://firespark.cloud/api/integrations/v1/orders/{id}/status"

	payload := strings.NewReader("{\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://firespark.cloud/api/integrations/v1/orders/{id}/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://firespark.cloud/api/integrations/v1/orders/{id}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "ord-48291",
    "status": "COMPLETED",
    "fulfillment_status": "DELIVERED",
    "payment_status": "PAID"
  }
}

PATCH

orders

{id}

status

Update order status

curl --request PATCH \
  --url https://firespark.cloud/api/integrations/v1/orders/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>"
}
'

import requests

url = "https://firespark.cloud/api/integrations/v1/orders/{id}/status"

payload = { "status": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({status: '<string>'})
};

fetch('https://firespark.cloud/api/integrations/v1/orders/{id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://firespark.cloud/api/integrations/v1/orders/{id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://firespark.cloud/api/integrations/v1/orders/{id}/status"

	payload := strings.NewReader("{\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://firespark.cloud/api/integrations/v1/orders/{id}/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://firespark.cloud/api/integrations/v1/orders/{id}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "ord-48291",
    "status": "COMPLETED",
    "fulfillment_status": "DELIVERED",
    "payment_status": "PAID"
  }
}

Updates the operational status of an order after your POS or RMS processes it. Call this endpoint when the kitchen marks an order as preparing, ready, delivered, or cancelled so connected channels reflect the same progress.

Requires an access token with the orders:write scope. See Token to obtain a token.

When to call this endpoint

POS event	Suggested Fire spark update
Ticket accepted in kitchen	`fulfillment_status: PREPARING`
Order bagged / ready for pickup	`fulfillment_status: PREPARED`
Driver dispatched	`fulfillment_status: DELIVERING`
Handed to customer	`fulfillment_status: DELIVERED`, `status: COMPLETED`
Voided in POS	`status: CANCELLED`, `fulfillment_status: CANCELLED`

Fire spark propagates these updates to channels and may emit order.updated webhooks to other integrations listening on the merchant.

Path parameters

Parameter	Required	Description
`id`	Yes	External order identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters.

Request body

Field	Required	Type	Description
`status`	Yes	string	Target order status in your POS workflow

curl -X PATCH "https://firespark.cloud/api/integrations/v1/orders/ord-48291/status" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "COMPLETED"
  }'

Response

Returns the updated order in data.

{
  "data": {
    "id": "ord-48291",
    "status": "COMPLETED",
    "fulfillment_status": "DELIVERED",
    "payment_status": "PAID"
  }
}

Pair this endpoint with order.injected: the webhook delivers the order into your POS; this endpoint keeps Fire spark in sync as the ticket moves through your operational workflow.

Error responses

Status	Description
`401`	Missing or invalid access token
`403`	Token does not include the `orders:write` scope
`404`	No order exists for this id
`422`	Invalid status transition

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

External order identifier.

Required string length: 1 - 64

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

New order status.

status

string

required

Target order status in your POS or RMS workflow.

Response

200 - application/json

data

object

Get order Menu sync

API Documentation

Endpoints

Guides

Resources

Update order status

When to call this endpoint

Path parameters

Request body

Response

Error responses

Authorizations

Path Parameters

Body

Response

​When to call this endpoint

​Path parameters

​Request body

​Response

​Error responses

Authorizations

Path Parameters

Body

Response

When to call this endpoint

Path parameters

Request body

Response

Error responses