Reject

POST

orders

{id}

reject

Reject an order

curl --request POST \
  --url https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "אין לחמניות"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: 'אין לחמניות'})
};

fetch('https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject"

payload = { "note": "אין לחמניות" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'note' => 'אין לחמניות'
  ]),
  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;
}

{
  "id": 183761,
  "number": "183761",
  "type": "delivery",
  "status": "preparing",
  "placed_at": "2026-10-14T19:30:00+03:00",
  "scheduled_for": null,
  "prep_time_minutes": 25,
  "ready_by": "2026-10-14T19:56:00+03:00",
  "customer": {
    "name": "Rami K.",
    "phone": "+972501234567"
  },
  "delivery": {
    "by": "xfaster",
    "address": null
  },
  "items": [
    {
      "line_id": 991201,
      "item_id": 3062,
      "external_id": "BURG-SMASH",
      "name": "סמאש בורגר",
      "quantity": 2,
      "unit_price": 6000,
      "barcode": null,
      "unit": null,
      "by_weight": false,
      "total": 13000,
      "choices": [
        {
          "group": "מידת עשייה",
          "option": "מדיום",
          "price": 0
        }
      ],
      "addons": [
        {
          "addon_id": 412,
          "external_id": "ADD-CHEDDAR",
          "name": "צ׳דר",
          "quantity": 1,
          "price": 500
        }
      ],
      "components": [],
      "note": null
    }
  ],
  "notes": {
    "customer": "בלי בצל",
    "if_unavailable": null,
    "cutlery": false
  },
  "totals": {
    "items": 13000,
    "discount": 0,
    "coupon": 0,
    "packaging": 0,
    "delivery_fee": 1600,
    "tip": 0,
    "total": 14600,
    "currency": "ILS"
  },
  "payment": {
    "method": "cash",
    "status": "unpaid",
    "store_collects": 0
  },
  "invoice": {
    "issued_by": "xfaster"
  },
  "picking": null,
  "cancellation": null,
  "updated_at": "2026-10-14T19:31:04+03:00"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_status",
    "message": "The order is preparing.",
    "details": {
      "status": "preparing"
    }
  }
}

Authorizations

Authorization

string

header

required

The store's API key (xfp_test_… on the sandbox, xfp_live_… on live). XFaster creates it and shows it once. An integrator key (one key for a POS company) also sends X-XFaster-Store.

Headers

Idempotency-Key

string

Any unique string. Repeating a request with the same key within 24 hours returns the first answer instead of acting twice.

Example:

"5f0c3d1e-8b6a-4e1f-9c2d-7a1b0e4f6d21"

Path Parameters

integer

required

Example:

183761

Body

application/json

reason

enum<string>

required

Available options:

item_unavailable,

too_busy,

closing_soon,

cannot_deliver_address,

other

note

string

Maximum string length: 200

Example:

"אין לחמניות"

Response

The order after the change

integer

Example:

183761

number

string

Example:

"183761"

type

enum<string>

Available options:

delivery,

pickup

status

enum<string>

Available options:

new,

preparing,

ready,

picked_up,

delivered,

collected,

cancelled

placed_at

string<date-time>

scheduled_for

string<date-time> | null

Set for orders placed for later

prep_time_minutes

integer | null

ready_by

string<date-time> | null

customer

object

Show child attributes

delivery

object | null

Show child attributes

items

object[]

Show child attributes

notes

object

Show child attributes

totals

object

items + packaging + delivery_fee + tip - discount - coupon = total

Show child attributes

payment

object

Show child attributes

invoice

object

Show child attributes

picking

enum<string> | null

Markets - lines are final once done

Available options:

picking,

done,

null

cancellation

object | null

Show child attributes

updated_at

string<date-time>

⌘I

Reject an order

curl --request POST \
  --url https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "אין לחמניות"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: 'אין לחמניות'})
};

fetch('https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject"

payload = { "note": "אין לחמניות" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging2.xfaster.net/api/partner/v1/orders/{id}/reject",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'note' => 'אין לחמניות'
  ]),
  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;
}

{
  "id": 183761,
  "number": "183761",
  "type": "delivery",
  "status": "preparing",
  "placed_at": "2026-10-14T19:30:00+03:00",
  "scheduled_for": null,
  "prep_time_minutes": 25,
  "ready_by": "2026-10-14T19:56:00+03:00",
  "customer": {
    "name": "Rami K.",
    "phone": "+972501234567"
  },
  "delivery": {
    "by": "xfaster",
    "address": null
  },
  "items": [
    {
      "line_id": 991201,
      "item_id": 3062,
      "external_id": "BURG-SMASH",
      "name": "סמאש בורגר",
      "quantity": 2,
      "unit_price": 6000,
      "barcode": null,
      "unit": null,
      "by_weight": false,
      "total": 13000,
      "choices": [
        {
          "group": "מידת עשייה",
          "option": "מדיום",
          "price": 0
        }
      ],
      "addons": [
        {
          "addon_id": 412,
          "external_id": "ADD-CHEDDAR",
          "name": "צ׳דר",
          "quantity": 1,
          "price": 500
        }
      ],
      "components": [],
      "note": null
    }
  ],
  "notes": {
    "customer": "בלי בצל",
    "if_unavailable": null,
    "cutlery": false
  },
  "totals": {
    "items": 13000,
    "discount": 0,
    "coupon": 0,
    "packaging": 0,
    "delivery_fee": 1600,
    "tip": 0,
    "total": 14600,
    "currency": "ILS"
  },
  "payment": {
    "method": "cash",
    "status": "unpaid",
    "store_collects": 0
  },
  "invoice": {
    "issued_by": "xfaster"
  },
  "picking": null,
  "cancellation": null,
  "updated_at": "2026-10-14T19:31:04+03:00"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_status",
    "message": "The order is preparing.",
    "details": {
      "status": "preparing"
    }
  }
}

Start here

Orders

Order events

Menu

Store

Go-live

Authorizations

Headers

Path Parameters

Body

Response