MENU navbar-image

Introduction

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

Authenticating requests

This API is not authenticated.

AppTokens

Store app token

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatem/app-tokens/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"accusantium\",
    \"deviceToken\": \"dicta\",
    \"deviceData\": [],
    \"notificationToken\": \"et\",
    \"lang\": \"quia\"
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatem/app-tokens/register"
);

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

let body = {
    "id": "accusantium",
    "deviceToken": "dicta",
    "deviceData": [],
    "notificationToken": "et",
    "lang": "quia"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatem/app-tokens/register';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'id' => 'accusantium',
            'deviceToken' => 'dicta',
            'deviceData' => [],
            'notificationToken' => 'et',
            'lang' => 'quia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/app-tokens/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: voluptatem

Body Parameters

id   string  optional  

Example: accusantium

deviceToken   string   

Example: dicta

deviceData   object   
notificationToken   string  optional  

Example: et

lang   string  optional  

Example: quia

Response

Response Fields

id   string   
accountId   string   
userId   string|null   
type   int   
status   int   
deviceToken   string|null   
deviceData   array   
lang   string|null   
notificationToken   string|null   

Update app token notification token

requires authentication

Example request:
curl --request PATCH \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatem/app-tokens/sit/notification-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"notificationToken\": \"amet\"
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatem/app-tokens/sit/notification-token"
);

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

let body = {
    "notificationToken": "amet"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatem/app-tokens/sit/notification-token';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'notificationToken' => 'amet',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PATCH business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/app-tokens/{appToken}/notification-token

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: voluptatem

appToken   string   

Example: sit

Body Parameters

notificationToken   string  optional  

Example: amet

Update app token lang

requires authentication

Example request:
curl --request PATCH \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/maxime/app-tokens/quo/lang" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"fr\"
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/maxime/app-tokens/quo/lang"
);

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

let body = {
    "lang": "fr"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/maxime/app-tokens/quo/lang';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lang' => 'fr',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PATCH business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/app-tokens/{appToken}/lang

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: maxime

appToken   string   

Example: quo

Body Parameters

lang   string   

Example: fr

Must be one of:
  • 0 - ru
  • 1 - ua
  • 2 - pl
  • 3 - en
  • 4 - fr

Auth

Sign in

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/auth/sign-in" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account\": \"sit\",
    \"login\": \"sunt\",
    \"password\": \"#OZ26AXVzrR\"
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/auth/sign-in"
);

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

let body = {
    "account": "sit",
    "login": "sunt",
    "password": "#OZ26AXVzrR"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/auth/sign-in';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'account' => 'sit',
            'login' => 'sunt',
            'password' => '#OZ26AXVzrR',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/auth/sign-in

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

account   string   

Example: sit

login   string   

Example: sunt

password   string   

Example: #OZ26AXVzrR

Response

Response Fields

courierId   string   
accountId   string   
authToken   string   

Sign out

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/auth/sign-out" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/auth/sign-out"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/auth/sign-out';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/auth/sign-out

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Notifications

Active notifications

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/exercitationem/notifications/active" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/exercitationem/notifications/active"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/exercitationem/notifications/active';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/notifications/active

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: exercitationem

Response

Response Fields

items   object   
id   string   
message   string   
order   object|null   
id   string   
number   string   
companyName   string   
createdTime   int   
hasNext   boolean   

Indicates whether there are more items in the collection

Accept notification

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/debitis/notifications/voluptatem/accept" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/debitis/notifications/voluptatem/accept"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/debitis/notifications/voluptatem/accept';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/notifications/{notification}/accept

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: debitis

notification   string   

The notification. Example: voluptatem

Orders

Competed orders

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/harum/orders/completed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"fromTime\": 11,
    \"toTime\": 13,
    \"limit\": 14,
    \"offset\": 19
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/harum/orders/completed"
);

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

let body = {
    "fromTime": 11,
    "toTime": 13,
    "limit": 14,
    "offset": 19
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/harum/orders/completed';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'fromTime' => 11,
            'toTime' => 13,
            'limit' => 14,
            'offset' => 19,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/completed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: harum

Body Parameters

fromTime   integer   

Example: 11

toTime   integer   

Example: 13

limit   integer  optional  

Example: 14

offset   integer  optional  

Example: 19

Response

Response Fields

items   object   
id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
hasNext   boolean   

Indicates whether there are more items in the collection

Show order

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/modi/orders/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/modi/orders/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/modi/orders/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: modi

id   integer   

The ID of the order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Accept order

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/magnam/orders/1/statuses/accept-by-courier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/magnam/orders/1/statuses/accept-by-courier"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/magnam/orders/1/statuses/accept-by-courier';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/accept-by-courier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: magnam

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Courier arrive to company

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/alias/orders/1/statuses/arrive-to-company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/alias/orders/1/statuses/arrive-to-company"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/alias/orders/1/statuses/arrive-to-company';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/arrive-to-company

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: alias

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Finish order by company

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/beatae/orders/1/statuses/company-finish" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/beatae/orders/1/statuses/company-finish"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/beatae/orders/1/statuses/company-finish';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/company-finish

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: beatae

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Courier arrive to user

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/dicta/orders/1/statuses/arrive-to-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/dicta/orders/1/statuses/arrive-to-user"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/dicta/orders/1/statuses/arrive-to-user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/arrive-to-user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: dicta

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Finish order

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatum/orders/1/statuses/finish" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatum/orders/1/statuses/finish"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/voluptatum/orders/1/statuses/finish';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/finish

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: voluptatum

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Decline arrive to company

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/dicta/orders/1/statuses/arrive-to-company/decline" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/dicta/orders/1/statuses/arrive-to-company/decline"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/dicta/orders/1/statuses/arrive-to-company/decline';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/arrive-to-company/decline

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: dicta

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Decline arrive to user

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/non/orders/1/statuses/arrive-to-user/decline" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/non/orders/1/statuses/arrive-to-user/decline"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/non/orders/1/statuses/arrive-to-user/decline';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/arrive-to-user/decline

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: non

order   integer   

The order. Example: 1

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Decline order status

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/iusto/orders/1/statuses/decline" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"6\"
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/iusto/orders/1/statuses/decline"
);

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

let body = {
    "status": "6"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/iusto/orders/1/statuses/decline';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'status' => '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/statuses/decline

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: iusto

order   integer   

The order. Example: 1

Body Parameters

status   string   

Example: 6

Must be one of:
  • 0 - 4
  • 1 - 5
  • 2 - 6
  • 3 - 7

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Store company delay

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/reiciendis/orders/1/delays/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"time\": 12
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/reiciendis/orders/1/delays/company"
);

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

let body = {
    "time": 12
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/reiciendis/orders/1/delays/company';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'time' => 12,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order_id}/delays/company

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: reiciendis

order_id   integer   

The ID of the order. Example: 1

Body Parameters

time   integer   

Поле value должно быть не меньше чем 0. Example: 12

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Store delivery delay

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/necessitatibus/orders/1/delays/delivery" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"time\": 20
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/necessitatibus/orders/1/delays/delivery"
);

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

let body = {
    "time": 20
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/necessitatibus/orders/1/delays/delivery';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'time' => 20,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order_id}/delays/delivery

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: necessitatibus

order_id   integer   

The ID of the order. Example: 1

Body Parameters

time   integer   

Поле value должно быть не меньше чем 0. Example: 20

Response

Response Fields

id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
cart   object   
items   list   
id   string   
name   string   
price   float   
standardPrice   float   
count   int   
fullPackagePrice   float   
totalPrice   float   
promotions   list   
id   string   
type   int   
promoCode   object|null   
promotionId   string   
compensatedByType   int   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
phoneCall   object|null   
orderId   string   
status   int   
expiredIn   int   

Call to client

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/quo/orders/1/call-to-client" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/quo/orders/1/call-to-client"
);

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

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/quo/orders/1/call-to-client';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/orders/{order}/call-to-client

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: quo

order   integer   

The order. Example: 1

Statistics

Statistics

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/accusamus/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timeFrom\": 19,
    \"timeTo\": 13
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/accusamus/statistics"
);

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

let body = {
    "timeFrom": 19,
    "timeTo": 13
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/accusamus/statistics';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'timeFrom' => 19,
            'timeTo' => 13,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: accusamus

Body Parameters

timeFrom   integer   

Example: 19

timeTo   integer   

Example: 13

Response

Response Fields

ordersCount   int   
successCount   int   
successOnlineCount   int   
cancelledCount   int   
deliveryToHouseCount   int   
deliveryToDoorCount   int   
totalLeadTime   float   
totalIdealOrdersCount   int   
totalShiftsCount   int   
totalSalary   float   
totalOnlineSalary   float   
freeDeliveriesCount   int   
totalDeliveryPrice   float   
totalOnlineDeliveryPrice   float   
totalOnlineOtherPrice   float   
totalCashbackAmount   float   
totalOnlineCashbackAmount   float   
totalCityCertificateCompensationAmount   float   
totalOnlineCityCertificateCompensationAmount   float   
ordersTotalCycleByCourierDistance   float   
ordersTotalCycleByCourierDuration   float   
ordersWithTotalCycleByCourierCount   int   
totalTipsAmount   float   
totalOnlineTipsAmount   float   
totalDeliveringTime   int   
totalWorkTime   int   

Reports

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/qui/reports" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timeFrom\": 15,
    \"timeTo\": 6,
    \"limit\": 13,
    \"offset\": 8
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/qui/reports"
);

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

let body = {
    "timeFrom": 15,
    "timeTo": 6,
    "limit": 13,
    "offset": 8
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/qui/reports';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'timeFrom' => 15,
            'timeTo' => 6,
            'limit' => 13,
            'offset' => 8,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/reports

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: qui

Body Parameters

timeFrom   integer   

Example: 15

timeTo   integer   

Example: 6

limit   integer   

Example: 13

offset   integer   

Example: 8

Response

Response Fields

items   object   
id   string   
deliveryPrice   float   
onlineDeliveryPrice   float   
cityCertificateCompensationAmount   float   
cashbackAmount   float   
onlineTipsAmount   float   
orderOnlineOther   float   
totalAmount   float   
createdTime   int   
order   object   
id   string   
number   string   
status   int   
paymentType   int   
hasNext   boolean   

Indicates whether there are more items in the collection

Tasks

Active tasks

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/eos/tasks/active" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/eos/tasks/active"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/eos/tasks/active';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/tasks/active

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: eos

Response

Response Fields

items   object   
orders   list   
id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
route   object   
distance   float   
duration   float   
positions   list   
latitude   float|null   
longitude   float|null   
hasNext   boolean   

Indicates whether there are more items in the collection

Unassigned tasks

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/ut/tasks/unassigned" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"deliveryId\": \"23bc7edd-edb1-3d1f-ab76-16e9e155180a\",
    \"limit\": 11,
    \"offset\": 5
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/ut/tasks/unassigned"
);

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

let body = {
    "deliveryId": "23bc7edd-edb1-3d1f-ab76-16e9e155180a",
    "limit": 11,
    "offset": 5
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/ut/tasks/unassigned';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'deliveryId' => '23bc7edd-edb1-3d1f-ab76-16e9e155180a',
            'limit' => 11,
            'offset' => 5,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/tasks/unassigned

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: ut

Body Parameters

deliveryId   string   

validation.uuid. Example: 23bc7edd-edb1-3d1f-ab76-16e9e155180a

companyAddressIds   object  optional  
limit   integer  optional  

Example: 11

offset   integer  optional  

Example: 5

Response

Response Fields

items   object   
orders   list   
id   string   
number   string   
paymentType   int   
showCheckPackage   bool   
pickupDetails   object   
time   int   
companyName   string   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
deliveryDetails   object   
time   int   
contact   object   
name   string   
phone   string|null   
address   object   
rawAddress   string   
position   object   
latitude   float|null   
longitude   float|null   
note   string|null   
priceDetails   object|null   
summaryPrice   float   
companyPrice   float   
cashDeliveryPrice   float   
userPrice   float   
deliveryPriceBalance   float   
balance   float   
cityCertificateCompensationAmount   float   
prices   object   
checkPrice   float   
deliveryPrice   float   
cashbackAmount   float   
fullPrice   float   
orderPackagePrice   float|null   
tipsAmount   float|null   
tags   array   
status   int   
deliveryArrivedToUserTime   int|null   
deliveryArrivedToCompanyTime   int|null   
route   object   
distance   float   
duration   float   
positions   list   
latitude   float|null   
longitude   float|null   
hasNext   boolean   

Indicates whether there are more items in the collection

Users

Profile

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/ab/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/ab/user"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/ab/user';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: ab

Response

Response Fields

id   string   
deliveryId   string   
status   int   
callSign   string|null   
name   string|null   
phone   string   
type   int   
currentPosition   object|null   
latitude   float|null   
longitude   float|null   
dateFormatType   string   
measurementSystemType   string   
currency   string   
etherActive   bool   
etherSettings   object   
minutesDelayTrivial   int   
minutesDelayUrgent   int   
timezone   string   
interactionMode   int   
tipsActive   bool   
mainLang   string   
langs   list   
code   string   
locale   string   
trackingPositionInterval   int   

Store position

requires authentication

Example request:
curl --request POST \
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/aperiam/user/position" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"position\": {
        \"latitude\": 409440782.74,
        \"longitude\": 33732
    },
    \"companyAddressId\": \"ad\"
}"

const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/aperiam/user/position"
);

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

let body = {
    "position": {
        "latitude": 409440782.74,
        "longitude": 33732
    },
    "companyAddressId": "ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/aperiam/user/position';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'position' => [
                'latitude' => 409440782.74,
                'longitude' => 33732.0,
            ],
            'companyAddressId' => 'ad',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/user/position

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: aperiam

Body Parameters

position   object   
latitude   number  optional  

Example: 409440782.74

longitude   number  optional  

Example: 33732

companyAddressId   string   

Example: ad

User company addresses

requires authentication

Example request:
curl --request GET \
    --get "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/adipisci/user/company-addresses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/adipisci/user/company-addresses"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://dots.test/business-app/api/couriers/v2/accounts/1/couriers/adipisci/user/company-addresses';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-allow-methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
access-control-allow-headers:  App-Lang, App-Token, App-Account-Token, App-Auth-Token, Content-Type, Accept, Authorization, X-Requested-With, Application
 

{
    "message": "Account is not found"
}

Request      

GET business-app/api/couriers/v2/accounts/{account}/couriers/{courier}/user/company-addresses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

account   integer   

The account. Example: 1

courier   string   

The courier. Example: adipisci

Response

Response Fields

items   object   
id   string   
address   string   
company   object   
id   string   
name   string   
logo   string|null   
hasNext   boolean   

Indicates whether there are more items in the collection