Introduction

Base URL: http://localhost

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

This API is not authenticated.

Endpoints

Example request:

curl --request POST \
    "http://localhost/api/v2/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/auth/logout

Example request:

curl --request POST \
    "http://localhost/api/v2/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/auth/logout"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v2/auth/me

Example request:

curl --request GET \
    --get "http://localhost/api/v2/auth/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/auth/me"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "success": false,
    "error": {
        "code": "not_found",
        "message": "Ресурс не найден"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v2/health

Example request:

curl --request GET \
    --get "http://localhost/api/v2/health" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/health"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "success": false,
    "error": {
        "code": "not_found",
        "message": "Ресурс не найден"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v2/orders

Example request:

curl --request GET \
    --get "http://localhost/api/v2/orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "success": false,
    "error": {
        "code": "not_found",
        "message": "Ресурс не найден"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v2/orders/{id}

Example request:

curl --request GET \
    --get "http://localhost/api/v2/orders/56893" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/56893"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "success": false,
    "error": {
        "code": "not_found",
        "message": "Ресурс не найден"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/orders

Example request:

curl --request POST \
    "http://localhost/api/v2/orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PATCH api/v2/orders/{id}

Example request:

curl --request PATCH \
    "http://localhost/api/v2/orders/152380" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/152380"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/orders/{id}/cancel

Example request:

curl --request POST \
    "http://localhost/api/v2/orders/55344/cancel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/55344/cancel"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/orders/{id}/mark-ready

Example request:

curl --request POST \
    "http://localhost/api/v2/orders/8/mark-ready" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/8/mark-ready"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/orders/{id}/change-status

Example request:

curl --request POST \
    "http://localhost/api/v2/orders/15192/change-status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/15192/change-status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/orders/{id}/change-payments

Example request:

curl --request POST \
    "http://localhost/api/v2/orders/57373/change-payments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/57373/change-payments"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v2/clients

Example request:

curl --request GET \
    --get "http://localhost/api/v2/clients" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/clients"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "success": false,
    "error": {
        "code": "not_found",
        "message": "Ресурс не найден"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v2/clients/{id}

Example request:

curl --request GET \
    --get "http://localhost/api/v2/clients/9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/clients/9"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "success": false,
    "error": {
        "code": "not_found",
        "message": "Ресурс не найден"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v2/clients

Example request:

curl --request POST \
    "http://localhost/api/v2/clients" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/clients"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PATCH api/v2/clients/{id}

Example request:

curl --request PATCH \
    "http://localhost/api/v2/clients/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/clients/3"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Introduction

Authenticating requests

Endpoints

POST api/v2/auth/login

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/v2/auth/logout

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v2/auth/me

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v2/health

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v2/orders

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v2/orders/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/v2/orders

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

PATCH api/v2/orders/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/v2/orders/{id}/cancel

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/v2/orders/{id}/mark-ready

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/v2/orders/{id}/change-status

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/v2/orders/{id}/change-payments

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

GET api/v2/clients

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v2/clients/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/v2/clients

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

PATCH api/v2/clients/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request