Pickup / delivery times - xMenu API Doc

POST

/

order

/

pickup_delivery_times

Pickup / delivery times

curl --request POST \
  --url https://app.xmenu.it/api/order/pickup_delivery_times \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "dmethod": "<string>",
  "subrestaurant_uid": "<string>",
  "place_id": "<string>",
  "language": "<string>"
}
'

import requests

url = "https://app.xmenu.it/api/order/pickup_delivery_times"

payload = {
    "dmethod": "<string>",
    "subrestaurant_uid": "<string>",
    "place_id": "<string>",
    "language": "<string>"
}
headers = {
    "X-Client-Id": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dmethod: '<string>',
    subrestaurant_uid: '<string>',
    place_id: '<string>',
    language: '<string>'
  })
};

fetch('https://app.xmenu.it/api/order/pickup_delivery_times', 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://app.xmenu.it/api/order/pickup_delivery_times",
  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([
    'dmethod' => '<string>',
    'subrestaurant_uid' => '<string>',
    'place_id' => '<string>',
    'language' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

$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://app.xmenu.it/api/order/pickup_delivery_times"

	payload := strings.NewReader("{\n  \"dmethod\": \"<string>\",\n  \"subrestaurant_uid\": \"<string>\",\n  \"place_id\": \"<string>\",\n  \"language\": \"<string>\"\n}")

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

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	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.post("https://app.xmenu.it/api/order/pickup_delivery_times")
  .header("X-Client-Id", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dmethod\": \"<string>\",\n  \"subrestaurant_uid\": \"<string>\",\n  \"place_id\": \"<string>\",\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/order/pickup_delivery_times")

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

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dmethod\": \"<string>\",\n  \"subrestaurant_uid\": \"<string>\",\n  \"place_id\": \"<string>\",\n  \"language\": \"<string>\"\n}"

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

{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "data": {
    "pickup_times": [
      {
        "date": "2023-11-07T05:31:56Z",
        "formatted": "<string>"
      }
    ],
    "delivery_times": [
      {
        "date": "2023-11-07T05:31:56Z",
        "formatted": "<string>"
      }
    ]
  }
}

write:orders

Authorizations

X-Client-Id

string

header

required

Client ID for API Client authentication (must be used together with Client Secret)

X-Client-Secret

string

header

required

Client Secret for API Client authentication (must be used together with Client ID)

Body

application/json

dmethod

string

required

Delivery method:

0 = pickup at location
1 = home delivery
0t = at table
20 = pickup at pickup point
0e-{id} = event (where {id} is the event ID)
dcf-{id} = custom method (where {id} is the method ID)

subrestaurant_uid

string

Location identifier. Required for multi-location restaurants

place_id

string

Address identifier (obtained from address validation). Required if dmethod = 1 (home delivery)

language

string

ISO 639-1 language code; defaults to restaurant settings

Response

Available times response

success

boolean

required

Operation result: true if successful, false if failed

error

string

Error code if the operation failed. Possible values:

VALIDATION_ERROR = missing or invalid parameters (dmethod, subrestaurant_uid for multi-location restaurants, place_id for delivery) - see the message field for details
SUBRESTAURANT_NOT_FOUND = location not found
INVALID_ADDRESS = invalid, incomplete or not found address
ADDRESS_NOT_SERVED = address outside service zone
DELIVERY_NOT_AVAILABLE = delivery service unavailable
EXTERNAL_SERVICE_ERROR = the geocoding/distance external service is temporarily unavailable

See Error codes for general error codes that may also occur.

message

string

Human-readable error description if the operation failed

data

object

Available times data (present only if success = true)

Show child attributes

Pickup / delivery times

curl --request POST \
  --url https://app.xmenu.it/api/order/pickup_delivery_times \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "dmethod": "<string>",
  "subrestaurant_uid": "<string>",
  "place_id": "<string>",
  "language": "<string>"
}
'

import requests

url = "https://app.xmenu.it/api/order/pickup_delivery_times"

payload = {
    "dmethod": "<string>",
    "subrestaurant_uid": "<string>",
    "place_id": "<string>",
    "language": "<string>"
}
headers = {
    "X-Client-Id": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dmethod: '<string>',
    subrestaurant_uid: '<string>',
    place_id: '<string>',
    language: '<string>'
  })
};

fetch('https://app.xmenu.it/api/order/pickup_delivery_times', 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://app.xmenu.it/api/order/pickup_delivery_times",
  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([
    'dmethod' => '<string>',
    'subrestaurant_uid' => '<string>',
    'place_id' => '<string>',
    'language' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

$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://app.xmenu.it/api/order/pickup_delivery_times"

	payload := strings.NewReader("{\n  \"dmethod\": \"<string>\",\n  \"subrestaurant_uid\": \"<string>\",\n  \"place_id\": \"<string>\",\n  \"language\": \"<string>\"\n}")

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

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	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.post("https://app.xmenu.it/api/order/pickup_delivery_times")
  .header("X-Client-Id", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dmethod\": \"<string>\",\n  \"subrestaurant_uid\": \"<string>\",\n  \"place_id\": \"<string>\",\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/order/pickup_delivery_times")

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

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dmethod\": \"<string>\",\n  \"subrestaurant_uid\": \"<string>\",\n  \"place_id\": \"<string>\",\n  \"language\": \"<string>\"\n}"

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

{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "data": {
    "pickup_times": [
      {
        "date": "2023-11-07T05:31:56Z",
        "formatted": "<string>"
      }
    ],
    "delivery_times": [
      {
        "date": "2023-11-07T05:31:56Z",
        "formatted": "<string>"
      }
    ]
  }
}