Update order status

POST/api/crm/v2/orders.updatev2

operationId: orders.update

Moves the order to a new order_status from the extended list.

Authorization

api-token + language + role

Request body `application/json`

object

idintegerrequired

Example: 12863356

order_statusstring (ExpandedOrderStatus) required

Order status: on the way, completed, assembling, in the kitchen, not processed, ready for dispatch, waiting to be sent to kitchen, waiting for remake, cancelled, confirmed, prepared, awaiting payment, partial refund

Values:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcookedwaiting_for_paymentpart_refund

Example: confirmed

Responses

object

statusstringrequired

Values:successerror

Example: success

One of the options

object

dataobjectrequired

descriptionstringrequired

Translated message about the result of the status update

Example: Status successfully changed to In transit!

object

errorobjectrequired

codeintegerrequired

Example: 299

descriptionstringrequired

Example: Status update error

variablesobject

descriptionstringrequired

Translated status update message (includes a list of items if stock is insufficient)

Example: Cannot confirm, out of stock: Margherita Pizza - 2, Cola - 1

curl -X POST 'https://foodsoul.pro/api/crm/v2/orders.update' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":12863356,"order_status":"confirmed"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/orders.update', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 12863356,
        'order_status' => 'confirmed',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/orders.update", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 12863356,
        "order_status": "confirmed"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/orders.update",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "id": 12863356,
        "order_status": "confirmed",
    },
)
data = response.json()

Response 200

{
  "data": {
    "description": "Status successfully changed to In transit!"
  }
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.

Update order status

Authorization

Request body application/json

Responses

Request body `application/json`