Pause new orders - XFaster Partner Docs

POST

/

store

/

busy

Pause new orders (busy)

curl --request POST \
  --url https://staging2.xfaster.net/api/partner/v1/store/busy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "minutes": 30
}'

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

fetch('https://staging2.xfaster.net/api/partner/v1/store/busy', 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/store/busy"

payload = { "minutes": 30 }
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/store/busy",
  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([
    'minutes' => 30
  ]),
  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": 64,
  "name": "TABOON Plus",
  "accepting_orders": true,
  "reason": null,
  "open": true,
  "busy_until": null,
  "delivery": true,
  "pickup": true,
  "invoices": "xfaster",
  "hours": [
    {
      "day": "sunday",
      "open": "11:00",
      "close": "23:00"
    },
    {
      "day": "friday",
      "open": "11:00",
      "close": "01:00"
    }
  ]
}

{
  "error": {
    "code": "prep_time_out_of_range",
    "message": "Preparation time must be between 5 and 120 minutes.",
    "details": {
      "min": 5,
      "max": 120
    }
  }
}

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"

Body

application/json

minutes

integer

required

How long to pause new orders.

Required range: 15 <= x <= 120

Example:

30

Response

The store, now busy

id

integer

Example:

64

name

string

Example:

"TABOON Plus"

accepting_orders

boolean

Example:

false

reason

enum<string> | null

Available options:

busy,

closed,

outside_hours,

null

Example:

"busy"

open

boolean

busy_until

string<date-time> | null

delivery

boolean

pickup

boolean

invoices

enum<string>

xfaster = the store's PayPlus already issues the customer's invoice; store = your POS issues the receipt

Available options:

xfaster,

store

hours

object[]

Show child attributes

⌘I

Pause new orders (busy)

curl --request POST \
  --url https://staging2.xfaster.net/api/partner/v1/store/busy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "minutes": 30
}'

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

fetch('https://staging2.xfaster.net/api/partner/v1/store/busy', 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/store/busy"

payload = { "minutes": 30 }
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/store/busy",
  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([
    'minutes' => 30
  ]),
  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": 64,
  "name": "TABOON Plus",
  "accepting_orders": true,
  "reason": null,
  "open": true,
  "busy_until": null,
  "delivery": true,
  "pickup": true,
  "invoices": "xfaster",
  "hours": [
    {
      "day": "sunday",
      "open": "11:00",
      "close": "23:00"
    },
    {
      "day": "friday",
      "open": "11:00",
      "close": "01:00"
    }
  ]
}

{
  "error": {
    "code": "prep_time_out_of_range",
    "message": "Preparation time must be between 5 and 120 minutes.",
    "details": {
      "min": 5,
      "max": 120
    }
  }
}