Delivery Company Drivers App Development

Introduction

Build your Sinqro-connected delivery company drivers app (consuming Sinqro APIs and listening Sinqro webhooks)

Getting started

The developer account is automatically created when your company's account is created.

In order to create your POS, marketplace, app or any other platform account, please go to our main site, select your company type and follow the instructions.

If your company's account was already created and you have problems to access your account, contact us through the chat in this site or by email at integrations@sinqro.com

API Environments

As you are going to develop using test accounts, you can work directly in production:

https://api.sinqro.com/driver-app/v1

API Security

About your credentials

You can find your credentials in your developer panel.

Authorization

All services of this API require an authorization token sent in headers ‘x-api-server-access-token’.

You can get your app assigned token in your developer panel.

Authentication

Most of this API services require an authentication token sent in headers'x-api-user-access-token'.

You can the retrieve the user token with a successful request to the login API service.

API SERVICES REFERENCE

DRIVER

Services to manage driver user data

Create new driver

POST /drivers

Create new driver for given delivery account

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
deliveryAccountId	integer	formData	Delivery account identifier
name	string	formData	Driver name
lastname	string	formData	Driver last name
phone ( optional )	string	formData	Driver phone number
email ( optional )	string	formData	Driver email

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Driver login

POST /drivers/login

Login with driver. This method returns a header with a user access token (‘x-api-user-access-token’). This token will be required as authentication method for most of this API services.

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
platformId	integer	formData	Delivery platform identifier
email	string	formData	The driver email for login
password	string	formData	The password for login in clear text

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Logout

POST /logout

Disable current api-user-access-token and detach from device if is necessary

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
deviceId ( optional )	integer	formData	Device identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	Empty body
400	Error/s	object ErrorResponse

Driver request recovery password code

POST /drivers/recoveryPassword

Request a recovery password code. This code only can be used one time.

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
platformId	integer	path	Delivery platform identifier
email	string	formData	The driver email for login

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	boolean
400	Error/s	object ErrorResponse

Check driver recovery code

POST /drivers/checkRecoveryCode

Check driver recovery code using driver email and received recovery code. If the code matches method returns valid x-api-user-access-token allowed to use in post driver password action and set a new password. Once you get a successful response with driver code this code will be disabled

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
platformId	integer	path	Delivery platform identifier
email	string	formData	The driver email for login
recoveryCode	string	formData	The recovery code provided with /drivers/recoveryPassword request

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Patch driver password

PATCH /drivers/{driverId}/password

Change driver password using his current password. This method returns a header with a user access token (‘x-api-user-access-token’). This token will be required as authentication method for most of this API services.

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
oldPassword	string	formData	Old driver password
newPassword	string	formData	New driver password. Minimum length: 6, and maximum length: 24

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Post driver password

POST /drivers/{driverId}/password

Change current driver password using only x-api-user-access-token. This method returns a header with a user access token (‘x-api-user-access-token’). This token will be required as authentication method for most of this API services.

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
password	string	formData	New driver password. Minimum length: 6, and maximum length: 24

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Get driver

GET /drivers/{driverId}

Get driver with user data

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	The driver ID

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Patch driver

PATCH /drivers/{driverId}

Modify driver data

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
name ( optional )	string	formData	Driver name
lastname ( optional )	string	formData	Driver last name
phone ( optional )	string	formData	Driver phone number
image ( optional )	string	formData	Driver profile image. Json format, example: {"filename":"filename.extension", "data":"file base64 encoded"]
transportTypeCode	string	formData	Driver default transport type code

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Driver
400	Error/s	object ErrorResponse

Change driver status

POST /drivers/{driverId}/status

Change driver status

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Delivery identifier
statusCode	string	formData	New status identifier code

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Status
400	Error/s	object ErrorResponse

Get legal conditions

GET /platforms/{platformId}/conditions/driver

Get legal conditions for drivers

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
platformId	integer	path	Platform identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Conditions
400	Error/s	object ErrorResponse

DELIVERY

Services to manage deliveries

Driver deliveries

GET /drivers/{driverId}/deliveries

Get all deliveries assigned to driver

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
from ( optional )	string	query	Date filter. Format YYYY-MM-dd. Example: 2017-10-10
to ( optional )	string	query	Date filter. Format YYYY-MM-dd. Example: 2017-10-10

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Delivery
400	Error/s	object ErrorResponse

Driver active deliveries

GET /drivers/{driverId}/deliveries/active

Get actives deliveries assigned to driver

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Delivery
400	Error/s	object ErrorResponse

Driver finished deliveries

GET /drivers/{driverId}/deliveries/finished

Get closed deliveries assigned to driver

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
limit ( optional )	integer	query	Limit response

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Delivery
400	Error/s	object ErrorResponse

Driver delivery

GET /drivers/{driverId}/deliveries/{deliveryId}

Get driver delivery information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
deliveryId	integer	path	Delivery identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Delivery
400	Error/s	object ErrorResponse

Post delivery status

POST /deliveries/status

Post delivery status

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
externalDeliveryId	string	formData	Delivery external identifier
statusCode	string	formData	New delivery status code

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Delivery
400	Error/s	object ErrorResponse

DELIVERY SHIFT

Services to work with delivery shifts

Get available delivery shifts for driver

GET /drivers/{driverId}/deliveryShifts/available

Get available delivery shifts for driver

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DeliveryShift
400	Error/s	object ErrorResponse

Driver delivery shift

GET /drivers/{driverId}/deliveryShifts/{deliveryShiftId}

Get driver delivery shift information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
deliveryShiftId	integer	path	Delivery shift identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryShift
400	Error/s	object ErrorResponse

DRIVER SERVICES

Services to manage driver services

Get driver services

GET /drivers/{driverId}/services

Get all driver services

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DriverService
400	Error/s	object ErrorResponse

Create driver service

POST /drivers/{driverId}/services

Create new driver service

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
deliveryShiftId	integer	formData	Delivery shift to enroll in

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DriverService
400	Error/s	object ErrorResponse

Get driver service

GET /drivers/{driverId}/services/{serviceId}

Get driver service information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
serviceId	integer	path	Driver service identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DriverService
400	Error/s	object ErrorResponse

Get driver services by status

GET /drivers/{driverId}/services/status/{serviceStatusType}

Get all driver services by status

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
serviceStatusType	string	path	Status type to filter

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DriverService
400	Error/s	object ErrorResponse

Change driver service status

POST /drivers/{driverId}/services/{serviceId}/status

Change driver service status

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
serviceId	integer	path	Driver service identifier
serviceStatusType	string	formData	New status identifier code

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DriverService
400	Error/s	object ErrorResponse

Get current driver services

GET /drivers/{driverId}/currentServices

Return non finished driver services

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DriverService
400	Error/s	object ErrorResponse

DELIVERY CONTRACT

Delivery contract actions

Post delivery contract requests

POST /deliveryContractRequest

Create new delivery contract requests

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	formData	Driver identifier
deliveryAccountId	integer	formData	Delivery account identifier
postalCodes	array	formData	Postal codes array ['12345', '12121']
message	string	formData	Delivery contract request message

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryContractRequest
400	Error/s	object ErrorResponse

Post delivery contract requests status

POST /deliveryContractRequests/{deliveryContractRequestId}/status

Change delivery contract requests status

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
deliveryContractRequestId	integer	path	Delivery contract request identifier
statusCode	string	formData	New status identifier code

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryContractRequest
400	Error/s	object ErrorResponse

Get driver delivery contract requests

GET /drivers/{driverId}/deliveryContractRequests

Get all driver delivery contract requests

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DeliveryContractRequest
400	Error/s	object ErrorResponse

Get driver delivery contract request

GET /drivers/{driverId}/deliveryContractRequests/{deliveryContractRequestId}

Get driver delivery contract request information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
deliveryContractRequestId	integer	path	Delivery contract request identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryContractRequest
400	Error/s	object ErrorResponse

Get delivery account delivery contract requests

GET /deliveryAccounts/{deliveryAccountId}/deliveryContractRequests

Get all delivery account delivery contract requests with drivers with user data

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
deliveryAccountId	integer	path	Delivery account identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DeliveryContractRequest
400	Error/s	object ErrorResponse

Get driver delivery contracts

GET /drivers/{driverId}/deliveryContracts

Get all driver delivery contracts

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DeliveryContractForDriver
400	Error/s	object ErrorResponse

Get driver delivery contract

GET /drivers/{driverId}/deliveryContracts/{deliveryContractId}

Get driver delivery contract information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
deliveryContractId	integer	path	Delivery contract identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryContractExtendedForDriver
400	Error/s	object ErrorResponse

Post driver delivery contract status

POST /drivers/{driverId}/deliveryContracts/{deliveryContractId}/status

Change driver delivery contract status

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
deliveryContractId	integer	path	Delivery contract identifier
statusCode	string	formData	New status identifier code

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryContractExtendedForDriver
400	Error/s	object ErrorResponse

Authorized delivery authorizations

GET /drivers/{driverId}/authorizations/authorized

Get all authorized delivery authorizations

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array DeliveryAuthorization
400	Error/s	object ErrorResponse

Post delivery contract

POST /deliveryAccounts/{deliveryAccountId}/deliveryContract

Create new delivery contract

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
deliveryAccountId	integer	path	Delivery account identifier
driverConditionsId	integer	formData	Driver conditions id
driverEmail	string	formData	Driver email
allowCash	boolean	formData	Driver allow cash payments
allowCreditCard	boolean	formData	Driver allow credit card payments
isEmployee	boolean	formData	Driver is employee flag
deliveryZonesIds	string	formData	Delivery zones ids. Json forma, example: ['23', '43']
selfModeCommissionRate ( optional )	number	formData	Driver self comission rate
billingMode ( optional )	string	formData	Driver billing mode

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryContract
400	Error/s	object ErrorResponse

ACCOUNT

Account actions

Get driver accounts

GET /drivers/{driverId}/accounts

Get driver accounts names and identifiers

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Account
400	Error/s	object ErrorResponse

Get driver account

GET /drivers/{driverId}/account

Get driver account with legal data information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Account
400	Error/s	object ErrorResponse

Patch driver account

PATCH /drivers/{driverId}/account

Modify account legal data

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier
name	string	formData	Account name
legalName	string	formData	Account legal name
legalVatNumber ( optional )	string	formData	Account legal vat number
legalAddress ( optional )	string	formData	Account legal address
legalAddressDetails ( optional )	string	formData	Account legal address details
legalAddressPostalCode ( optional )	string	formData	Account legal address postal code
legalAddressCity ( optional )	string	formData	Account legal address city
legalAddressProvince ( optional )	string	formData	Account legal address province

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Account
400	Error/s	object ErrorResponse

Get delivery account

GET /deliveryAccounts/{deliveryAccountId}

Get delivery account information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
deliveryAccountId	integer	path	Delivery account identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeliveryAccount
400	Error/s	object ErrorResponse

Get driver account payments

GET /drivers/{driverId}/account/payments

Get driver account payments

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
driverId	integer	path	Driver identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Payment
400	Error/s	object ErrorResponse

CHATS

Chat services

Get user chats

GET /users/{userId}/chats

Get all user chats

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
userId	integer	path	User identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Chat
400	Error/s	object ErrorResponse

Get user chats without messages

GET /users/{userId}/chats/list

Get all user chats without messages

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
userId	integer	path	User identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Chat
400	Error/s	object ErrorResponse

Get user chat

GET /users/{userId}/chats/{chatId}

Get user chat information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
userId	integer	path	User identifier
chatId	integer	path	Chat identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Chat
400	Error/s	object ErrorResponse

Post user chat message

POST /users/{userId}/chats/{chatId}/message

Create new user chat message

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
userId	integer	path	User identifier
chatId	integer	path	Chat identifier
message	string	formData	Chat message

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object ChatMessage
400	Error/s	object ErrorResponse

Get account chats

GET /accounts/{accountId}/chats

Get all account chats

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
accountId	integer	path	Account identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Chat
400	Error/s	object ErrorResponse

Get account chats without messages

GET /accounts/{accountId}/chats/list

Get all account chats without messages

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
accountId	integer	path	Account identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array Chat
400	Error/s	object ErrorResponse

Get account chat

GET /accounts/{accountId}/chats/{chatId}

Get account chat information

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
accountId	integer	path	Account identifier
chatId	integer	path	Chat identifier

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object Chat
400	Error/s	object ErrorResponse

Post account chat message

POST /accounts/{accountId}/chats/{chatId}/message

Create new account chat message

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token	string	header	Authentication token
accountId	integer	path	Account identifier
chatId	integer	path	Chat identifier
message	string	formData	Chat message

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object ChatMessage
400	Error/s	object ErrorResponse

COMMON

Common

Post device interaction

POST /deviceInteractions

Post device interaction

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
x-api-user-access-token ( optional )	string	header	Authentication token
token	string	formData	Device token
appBundle	string	formData	Which app bundle is using the device
appMode	string	formData	App mode
appVersion	string	formData	App version
deviceModel	string	formData	Device model
deviceLanguage	string	formData	Device language ISO code
deviceIp	string	formData	Device IP
latitude ( optional )	string	formData	Device latitude position
longitude ( optional )	string	formData	Device longitude position
batteryLevel ( optional )	number	formData	Device battery level
gpsStatus ( optional )	boolean	formData	Device gps status
unlink ( optional )	boolean	formData	Unlink this device from current user

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	object DeviceInteraction
400	Error/s	object ErrorResponse

Get transport types

GET /transportTypes

Get all transport types

REQUEST parameters

x-api-server-access-token

string

header

Authorization token

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array TransportType
400	Error/s	object ErrorResponse

Get unit FAQs

GET /faqs/{unitCode}

Get unit FAQs

REQUEST parameters

x-api-server-access-token	string	header	Authorization token
unitCode	string	path	Unit identifier code. Example: delivery

POSSIBLE RESPONSES

HTTP Code	Description	Body
200	Ok	array PublicationCategory
400	Error/s	Empty body

MODELS REFERENCE

We show the definition of all the models used in the previous API services and notifications:

Account

MODEL ATTRIBUTES

Driver account

id	integer (int32)	Account identifier
name	string	Account name
balanceAmount	number (float)	Account balance amount
legalName	string	Account legal name
legalVatNumber	string	Account legal vat number
legalAddress	string	Account legal address
legalAddressDetails	string	Account legal address extra information
legalAddressPostalCode	string	Account legal address postal code
legalAddressCity	string	Account legal address city
legalAddressProvince	string	Account legal address province

MODEL EXAMPLES

Example

{
    "id": "43",
    "name": "My account",
    "balanceAmount": "0.00",
    "legalName": "My Company S.L",
    "legalVatNumber": "00000000B",
    "legalAddress": "C/ Example, 299",
    "legalAddressDetails": null,
    "legalAddressPostalCode": "12345",
    "legalAddressCity": "Example city",
    "legalAddressProvince": "Example province"
}

Account

MODEL ATTRIBUTES

id	integer (int32)		Account identifier
name	string		Account name

MODEL EXAMPLES

Example

{
    "id": "43",
    "name": "My account"
}

Account

MODEL ATTRIBUTES

Driver account

id	integer (int32)	Account identifier
name	string	Account name
balanceAmount	number (float)	Account balance amount
legalName	string	Account legal name
legalVatNumber	string	Account legal vat number
legalAddress	string	Account legal address
legalAddressDetails	string	Account legal address extra information
legalAddressPostalCode	string	Account legal address postal code
legalAddressCity	string	Account legal address city
legalAddressProvince	string	Account legal address province

MODEL EXAMPLES

Example

{
    "id": "43",
    "name": "My account",
    "balanceAmount": "0.00",
    "legalName": "My Company S.L",
    "legalVatNumber": "00000000B",
    "legalAddress": "C/ Example, 299",
    "legalAddressDetails": null,
    "legalAddressPostalCode": "12345",
    "legalAddressCity": "Example city",
    "legalAddressProvince": "Example province"
}

Chat

MODEL ATTRIBUTES

id	integer (int32)		Chat identifier
title	string		Chat title

MODEL EXAMPLES

Example

{
    "id": "432",
    "title": "Title chat 432"
}

Chat

MODEL ATTRIBUTES

id	integer (int32)		Chat identifier
title	string		Chat title

MODEL EXAMPLES

Example

{
    "id": "432",
    "title": "Title chat 432"
}

Chat

MODEL ATTRIBUTES

id	integer (int32)	Chat identifier
title	string	Chat title
messages	array ChatMessage	Chat messages

MODEL EXAMPLES

Example

{
    "id": "432",
    "title": "Title chat 432",
    "messages": [
        {
            "id": "975",
            "body": "chat content message",
            "senderName": "User 1",
            "outgoing": true,
            "createdAt": "2017-02-09T12:15:00+0000"
        }
    ]
}

ChatMessage

MODEL ATTRIBUTES

id	integer (int32)	Chat message identifier
body	string	Chat message content
senderName	string	Chat message sender name
outgoing	boolean	Return true if chat message was sent by the requester
createdAt	string (date-time)	Chat message creation time

MODEL EXAMPLES

Example

{
    "id": "975",
    "body": "chat content message",
    "senderName": "User 1",
    "outgoing": true,
    "createdAt": "2017-02-09T12:15:00+0000"
}

ChatMessage

MODEL ATTRIBUTES

id	integer (int32)	Chat message identifier
body	string	Chat message content
senderName	string	Chat message sender name
outgoing	boolean	Return true if chat message was sent by the requester
createdAt	string (date-time)	Chat message creation time

MODEL EXAMPLES

Example

{
    "id": "975",
    "body": "chat content message",
    "senderName": "User 1",
    "outgoing": true,
    "createdAt": "2017-02-09T12:15:00+0000"
}

Conditions

MODEL ATTRIBUTES

content

string

Legal conditions content

MODEL EXAMPLES

Example

{
    "content": null
}

Conditions

MODEL ATTRIBUTES

Driver service conditions

id	integer (int64)	Delivery conditions set identifier
perDeliveryBaseAmount	number (float)	Per delivery base amount
perDeliveryKmAmount	number (float)	Per delivery km amount
perDeliveryMinuteAmount	number (float)	Per delivery minute amount
perDeliveryDelayMinuteAmount	number (float)	Per delivery delay minute amount
perShiftAmount	number (float)	Per delivery shift amount
perShiftMinAmount	number (float)	Per delivery shift minimum amount

MODEL EXAMPLES

Example

{
    "id": "754",
    "perDeliveryBaseAmount": "3",
    "perDeliveryKmAmount": false,
    "perDeliveryMinuteAmount": false,
    "perDeliveryDelayMinuteAmount": false,
    "perShiftAmount": false,
    "perShiftMinAmount": false
}

Delivery

MODEL ATTRIBUTES

id	integer (int64)	Delivery identifier
pickupAddress	object PickupAddress	Delivery pickup address
deliveryAddress	object DeliveryAddress	Delivery address
pickupAgreedAt	string (date-time)	Pickup agreed time
pickupConfirmedAt	string (date-time)	Confirmed pickup time
deliveryAgreedAt	string (date-time)	Delivery agreed time
deliveryConfirmedAt	string (date-time)	Confirmed delivery time
pickupInstructions	string	Pickup instructions
deliveryInstructions	string	Driver instructions
forSenderInstructions	string	Instructions for the person or company that will hand the order to the driver
linearDistance	number (float)	Linear distance between pickup and delivery points
realDistance	number (float)	Real distance between pickup and delivery points
estimatedDeliveryDuration	number (float)	Estimated delivery duration in minutes
status	object Status	Current delivery status
pickupContactName	string	Pickup contact name
pickupContactPhone	string	Pickup contact phone number
pickupContactEmail	string	Pickup contact email
destinationContactEmail	string	Destination contact email
destinationContactName	string	Destination contact name
destinationContactPhone	string	Destination contact phone number
deliveryDescription	string	Delivery description
onPickupPayments	array Payment	Payments required on pickup action
onDeliveryPayments	array Payment	Payments required on delivery action
newStatusOptions	array Status	Array with new possible statuses for delivery

MODEL EXAMPLES

Example

{
    "id": 1003,
    "pickupAddress": {
        "id": 1003,
        "street": "C/ Example, 23",
        "details": "Canada building",
        "city": "City name",
        "province": "Province name",
        "postalCode": "12345",
        "latitude": 41.308166,
        "longitude": 2.019725,
        "googlePlaceId": "xxxxxxxxxxxx",
        "placeName": "C/ Example, 23, City name"
    },
    "deliveryAddress": {
        "id": 1003,
        "street": "C/ Example, 23",
        "details": "Canada building",
        "city": "City name",
        "province": "Province name",
        "postalCode": "12345",
        "latitude": 41.308166,
        "longitude": 2.019725,
        "googlePlaceId": "xxxxxxxxxxxx",
        "placeName": "C/ Example, 23, City name"
    },
    "pickupAgreedAt": "2017-02-09T12:00:00+0000",
    "pickupConfirmedAt": "2017-02-09T12:00:00+0000",
    "deliveryAgreedAt": "2017-02-09T12:15:00+0000",
    "deliveryConfirmedAt": "2017-02-09T12:15:00+0000",
    "pickupInstructions": null,
    "deliveryInstructions": null,
    "forSenderInstructions": null,
    "linearDistance": "1.56",
    "realDistance": "1.97",
    "estimatedDeliveryDuration": "15",
    "status": {
        "code": "PICKING",
        "name": "Picking",
        "color": "blue",
        "isFinalStatus": false,
        "callToAction": "Start picking"
    },
    "pickupContactName": "John",
    "pickupContactPhone": "600000000",
    "pickupContactEmail": "john@example.com",
    "destinationContactEmail": "jane@example.com",
    "destinationContactName": "Jane",
    "destinationContactPhone": "600000000",
    "deliveryDescription": "Selling point order delivery",
    "onPickupPayments": [
        {
            "id": 1003,
            "amount": "28.60",
            "paymentMethodName": "Cash"
        }
    ],
    "onDeliveryPayments": [
        {
            "id": 1003,
            "amount": "28.60",
            "paymentMethodName": "Cash"
        }
    ],
    "newStatusOptions": [
        {
            "code": "PICKING",
            "name": "Picking",
            "color": "blue",
            "isFinalStatus": false,
            "callToAction": "Start picking"
        }
    ]
}

Delivery

MODEL ATTRIBUTES

id	integer (int64)	Delivery identifier
pickupAddress	object PickupAddress	Delivery pickup address
deliveryAddress	object DeliveryAddress	Delivery address
pickupAgreedAt	string (date-time)	Pickup agreed time
pickupConfirmedAt	string (date-time)	Confirmed pickup time
deliveryAgreedAt	string (date-time)	Delivery agreed time
deliveryConfirmedAt	string (date-time)	Confirmed delivery time
pickupInstructions	string	Pickup instructions
deliveryInstructions	string	Driver instructions
forSenderInstructions	string	Instructions for the person or company that will hand the order to the driver
linearDistance	number (float)	Linear distance between pickup and delivery points
realDistance	number (float)	Real distance between pickup and delivery points
estimatedDeliveryDuration	number (float)	Estimated delivery duration in minutes
status	object Status	Current delivery status
pickupContactName	string	Pickup contact name
pickupContactPhone	string	Pickup contact phone number
pickupContactEmail	string	Pickup contact email
destinationContactEmail	string	Destination contact email
destinationContactName	string	Destination contact name
destinationContactPhone	string	Destination contact phone number
deliveryDescription	string	Delivery description
onPickupPayments	array Payment	Payments required on pickup action
onDeliveryPayments	array Payment	Payments required on delivery action
newStatusOptions	array Status	Array with new possible statuses for delivery

MODEL EXAMPLES

Example

{
    "id": 1003,
    "pickupAddress": {
        "id": 1003,
        "street": "C/ Example, 23",
        "details": "Canada building",
        "city": "City name",
        "province": "Province name",
        "postalCode": "12345",
        "latitude": 41.308166,
        "longitude": 2.019725,
        "googlePlaceId": "xxxxxxxxxxxx",
        "placeName": "C/ Example, 23, City name"
    },
    "deliveryAddress": {
        "id": 1003,
        "street": "C/ Example, 23",
        "details": "Canada building",
        "city": "City name",
        "province": "Province name",
        "postalCode": "12345",
        "latitude": 41.308166,
        "longitude": 2.019725,
        "googlePlaceId": "xxxxxxxxxxxx",
        "placeName": "C/ Example, 23, City name"
    },
    "pickupAgreedAt": "2017-02-09T12:00:00+0000",
    "pickupConfirmedAt": "2017-02-09T12:00:00+0000",
    "deliveryAgreedAt": "2017-02-09T12:15:00+0000",
    "deliveryConfirmedAt": "2017-02-09T12:15:00+0000",
    "pickupInstructions": null,
    "deliveryInstructions": null,
    "forSenderInstructions": null,
    "linearDistance": "1.56",
    "realDistance": "1.97",
    "estimatedDeliveryDuration": "15",
    "status": {
        "code": "PICKING",
        "name": "Picking",
        "color": "blue",
        "isFinalStatus": false,
        "callToAction": "Start picking"
    },
    "pickupContactName": "John",
    "pickupContactPhone": "600000000",
    "pickupContactEmail": "john@example.com",
    "destinationContactEmail": "jane@example.com",
    "destinationContactName": "Jane",
    "destinationContactPhone": "600000000",
    "deliveryDescription": "Selling point order delivery",
    "onPickupPayments": [
        {
            "id": 1003,
            "amount": "28.60",
            "paymentMethodName": "Cash"
        }
    ],
    "onDeliveryPayments": [
        {
            "id": 1003,
            "amount": "28.60",
            "paymentMethodName": "Cash"
        }
    ],
    "newStatusOptions": [
        {
            "code": "PICKING",
            "name": "Picking",
            "color": "blue",
            "isFinalStatus": false,
            "callToAction": "Start picking"
        }
    ]
}

Delivery

MODEL ATTRIBUTES

Delivery

id	integer (int64)	Delivery identifier
pickupAddress	object PickupAddress	Delivery pickup address
deliveryAddress	object DeliveryAddress	Delivery address
pickupAgreedAt	string (date-time)	Pickup agreed time
pickupConfirmedAt	string (date-time)	Confirmed pickup time
deliveryAgreedAt	string (date-time)	Delivery agreed time
deliveryConfirmedAt	string (date-time)	Confirmed delivery time
pickupInstructions	string	Pickup instructions
deliveryInstructions	string	Driver instructions
forSenderInstructions	string	Instructions for the person or company that will hand the order to the driver
linearDistance	number (float)	Linear distance between pickup and delivery points
realDistance	number (float)	Real distance between pickup and delivery points
estimatedDeliveryDuration	number (float)	Estimated delivery duration in minutes
status	object Status	Current delivery status
pickupContactName	string	Pickup contact name
pickupContactPhone	string	Pickup contact phone number
pickupContactEmail	string	Pickup contact email
destinationContactEmail	string	Destination contact email
destinationContactName	string	Destination contact name
destinationContactPhone	string	Destination contact phone number
deliveryDescription	string	Delivery description
onPickupPayments	array Payment	Payments required on pickup action
onDeliveryPayments	array Payment	Payments required on delivery action
newStatusOptions	array Status	Array with new possible statuses for delivery
driver	object driver	Driver
deliveryPrice	number (float)	Delivery price without taxes

MODEL EXAMPLES

Example

{
    "id": 1003,
    "pickupAddress": {
        "id": 1003,
        "street": "C/ Example, 23",
        "details": "Canada building",
        "city": "City name",
        "province": "Province name",
        "postalCode": "12345",
        "latitude": 41.308166,
        "longitude": 2.019725,
        "googlePlaceId": "xxxxxxxxxxxx",
        "placeName": "C/ Example, 23, City name"
    },
    "deliveryAddress": {
        "id": 1003,
        "street": "C/ Example, 23",
        "details": "Canada building",
        "city": "City name",
        "province": "Province name",
        "postalCode": "12345",
        "latitude": 41.308166,
        "longitude": 2.019725,
        "googlePlaceId": "xxxxxxxxxxxx",
        "placeName": "C/ Example, 23, City name"
    },
    "pickupAgreedAt": "2017-02-09T12:00:00+0000",
    "pickupConfirmedAt": "2017-02-09T12:00:00+0000",
    "deliveryAgreedAt": "2017-02-09T12:15:00+0000",
    "deliveryConfirmedAt": "2017-02-09T12:15:00+0000",
    "pickupInstructions": null,
    "deliveryInstructions": null,
    "forSenderInstructions": null,
    "linearDistance": "1.56",
    "realDistance": "1.97",
    "estimatedDeliveryDuration": "15",
    "status": {
        "code": "PICKING",
        "name": "Picking",
        "color": "blue",
        "isFinalStatus": false,
        "callToAction": "Start picking"
    },
    "pickupContactName": "John",
    "pickupContactPhone": "600000000",
    "pickupContactEmail": "john@example.com",
    "destinationContactEmail": "jane@example.com",
    "destinationContactName": "Jane",
    "destinationContactPhone": "600000000",
    "deliveryDescription": "Selling point order delivery",
    "onPickupPayments": [
        {
            "id": 1003,
            "amount": "28.60",
            "paymentMethodName": "Cash"
        }
    ],
    "onDeliveryPayments": [
        {
            "id": 1003,
            "amount": "28.60",
            "paymentMethodName": "Cash"
        }
    ],
    "newStatusOptions": [
        {
            "code": "PICKING",
            "name": "Picking",
            "color": "blue",
            "isFinalStatus": false,
            "callToAction": "Start picking"
        }
    ],
    "driver": {
        "id": 1003,
        "email": "john@example.com",
        "name": "John",
        "lastname": "Doe",
        "image": "https://cdn.sinqro.com/assets/images/placeholder_image.jpg",
        "phone": "+34600000000",
        "transport": {
            "code": "SCOOTER",
            "name": "Scooter"
        },
        "status": {
            "code": "onduty",
            "name": "En servicio",
            "color": "#5aac44"
        },
        "lastGeolocation": {
            "latitude": 41.308166,
            "longitude": 2.019725,
            "createdAt": "2018-03-015T12:15:00+0000"
        }
    },
    "deliveryPrice": 5
}

DeliveryAccount

MODEL ATTRIBUTES

Delivery contract delivery account

id	integer (int64)	Delivery account identifier
name	string	Delivery account name
horizontalLogo	string	Delivery account horizontal logo url

MODEL EXAMPLES

Example

{
    "id": "754",
    "name": "Delivery account name",
    "horizontalLogo": "http://route-to-logo.com"
}

DeliveryAccount

MODEL ATTRIBUTES

id	integer (int64)	Delivery account identifier
name	string	Delivery account name
horizontalLogo	string	Delivery account horizontal logo url

MODEL EXAMPLES

Example

{
    "id": "754",
    "name": "Delivery account name",
    "horizontalLogo": "http://route-to-logo.com"
}

DeliveryAddress

MODEL ATTRIBUTES

Delivery address

id	integer (int64)	Address identifier
street	string	Address street with number
details	string	Extra address information
city	string	Address city name
province	string	Address province name
postalCode	string	Address postal code
latitude	number (float)	Address latitude
longitude	number (float)	Address longitude
googlePlaceId	string	Google place identifier
placeName	string	Place name

MODEL EXAMPLES

Example

{
    "id": 1003,
    "street": "C/ Example, 23",
    "details": "Canada building",
    "city": "City name",
    "province": "Province name",
    "postalCode": "12345",
    "latitude": 41.308166,
    "longitude": 2.019725,
    "googlePlaceId": "xxxxxxxxxxxx",
    "placeName": "C/ Example, 23, City name"
}

DeliveryAuthorization

MODEL ATTRIBUTES

Delivery contract delivery authorization

id	integer (int64)	Delivery authorization identifier
deliveryZone	object DeliveryZone	If delivery authorization is for delivery zone returns delivery zone
sellingPointName	string	If delivery authorization is only for selling point, returns selling point name
platformName	string	Delivery authorization platform name
status	object Status	Delivery authorization current status

MODEL EXAMPLES

Example

{
    "id": "754",
    "deliveryZone": {
        "id": "754",
        "name": "XXX zone",
        "postalCodes": [
            null
        ]
    },
    "sellingPointName": "Natural Ice Creams",
    "platformName": "Delivery&Co",
    "status": {
        "code": "authorized",
        "name": "Authorized",
        "color": "#5aac44"
    }
}

DeliveryAuthorization

MODEL ATTRIBUTES

id	integer (int64)	Delivery authorization identifier
deliveryZone	object DeliveryZone	If delivery authorization is for delivery zone returns delivery zone
sellingPointName	string	If delivery authorization is only for selling point, returns selling point name
platformName	string	Delivery authorization platform name
status	object Status	Delivery authorization current status

MODEL EXAMPLES

Example

{
    "id": "754",
    "deliveryZone": {
        "id": "754",
        "name": "XXX zone",
        "postalCodes": [
            null
        ]
    },
    "sellingPointName": "Natural Ice Creams",
    "platformName": "Delivery&Co",
    "status": {
        "code": "authorized",
        "name": "Authorized",
        "color": "#5aac44"
    }
}

DeliveryConditions

MODEL ATTRIBUTES

Delivery contract delivery conditions

id	integer (int64)	Delivery conditions set identifier
perDeliveryBaseAmount	number (float)	Per delivery base amount
perDeliveryKmAmount	number (float)	Per delivery km amount
perDeliveryMinuteAmount	number (float)	Per delivery minute amount
perDeliveryDelayMinuteAmount	number (float)	Per delivery delay minute amount
perShiftAmount	number (float)	Per delivery shift amount
perShiftMinAmount	number (float)	Per delivery shift minimum amount

MODEL EXAMPLES

Example

{
    "id": "754",
    "perDeliveryBaseAmount": "3",
    "perDeliveryKmAmount": false,
    "perDeliveryMinuteAmount": false,
    "perDeliveryDelayMinuteAmount": false,
    "perShiftAmount": false,
    "perShiftMinAmount": false
}

DeliveryConditionsSetRules

MODEL ATTRIBUTES

Delivery conditions rule

pickupPostalCode	string	Pickup postal code
deliveryPostalCode	string	Delivery postal code
transportType	object TransportType	Transport type

MODEL EXAMPLES

Example

{
    "pickupPostalCode": "08800",
    "deliveryPostalCode": "08800",
    "transportType": {
        "code": "SCOOTER",
        "name": "Scooter"
    }
}

DeliveryContract

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract identifier
status	object Status	Delivery contract status
deliveryConditions	object DeliveryConditions	Delivery contract delivery conditions
deliveryAccount	object DeliveryAccount	Delivery contract delivery account
driver	object Driver	Delivery contract driver
allowCash	boolean	Returns true if the driver is allowed to manage cash payments
allowCreditCard	boolean	Returns true if the driver is allowed to manage credit card payments
isEmployee	boolean	Returns true if the driver is employee of the delivery account
billingMode	string	Driver billing mode
deliveryAuthorizations	array	Delivery contract delivery authorizations
createdAt	string (date-time)	Delivery contract creation time

MODEL EXAMPLES

Example

{
    "id": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Activo",
        "color": "#5aac44",
        "callToAction": null
    },
    "deliveryConditions": {
        "id": "754",
        "perDeliveryBaseAmount": "3",
        "perDeliveryKmAmount": false,
        "perDeliveryMinuteAmount": false,
        "perDeliveryDelayMinuteAmount": false,
        "perShiftAmount": false,
        "perShiftMinAmount": false
    },
    "deliveryAccount": {
        "id": "754",
        "name": "Delivery account name",
        "horizontalLogo": "http://route-to-logo.com"
    },
    "driver": {
        "id": 1003,
        "transport": {
            "code": "SCOOTER",
            "name": "Scooter"
        }
    },
    "allowCash": false,
    "allowCreditCard": false,
    "isEmployee": false,
    "billingMode": "DEFAULT | SELF",
    "deliveryAuthorizations": [
        [
            {
                "id": "754",
                "deliveryZone": {
                    "id": "754",
                    "name": "XXX zone",
                    "postalCodes": [
                        null
                    ]
                },
                "sellingPointName": "Natural Ice Creams",
                "platformName": "Delivery&Co",
                "status": {
                    "code": "authorized",
                    "name": "Authorized",
                    "color": "#5aac44"
                }
            }
        ]
    ],
    "createdAt": "2017-02-09T12:15:00+0000"
}

DeliveryContractExtendedForDriver

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract identifier
status	object Status	Delivery contract status
deliveryConditions	object DeliveryConditions	Delivery contract delivery conditions
deliveryAccount	object DeliveryAccount	Delivery contract delivery account
allowCash	boolean	Returns true if the driver is allowed to manage cash payments
allowCreditCard	boolean	Returns true if the driver is allowed to manage credit card payments
isEmployee	boolean	Returns true if the driver is employee of the delivery account
billingMode	string	Driver billing mode
deliveryAuthorizations	array	Delivery contract delivery authorizations
newStatusOptions	array	Array with new possible statuses for delivery contract
createdAt	string (date-time)	Delivery contract creation time

MODEL EXAMPLES

Example

{
    "id": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Activo",
        "color": "#5aac44",
        "callToAction": null
    },
    "deliveryConditions": {
        "id": "754",
        "perDeliveryBaseAmount": "3",
        "perDeliveryKmAmount": false,
        "perDeliveryMinuteAmount": false,
        "perDeliveryDelayMinuteAmount": false,
        "perShiftAmount": false,
        "perShiftMinAmount": false
    },
    "deliveryAccount": {
        "id": "754",
        "name": "Delivery account name",
        "horizontalLogo": "http://route-to-logo.com"
    },
    "allowCash": false,
    "allowCreditCard": false,
    "isEmployee": false,
    "billingMode": "DEFAULT | SELF",
    "deliveryAuthorizations": [
        [
            {
                "id": "754",
                "deliveryZone": {
                    "id": "754",
                    "name": "XXX zone",
                    "postalCodes": [
                        null
                    ]
                },
                "sellingPointName": "Natural Ice Creams",
                "platformName": "Delivery&Co",
                "status": {
                    "code": "authorized",
                    "name": "Authorized",
                    "color": "#5aac44"
                }
            }
        ]
    ],
    "newStatusOptions": [
        [
            {
                "code": "ACTIVE",
                "name": "Activo",
                "color": "#5aac44",
                "callToAction": null
            }
        ]
    ],
    "createdAt": "2017-02-09T12:15:00+0000"
}

DeliveryContractForDriver

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract identifier
status	object Status	Delivery contract status
deliveryAccount	object DeliveryAccount	Delivery contract delivery account
allowCash	boolean	Returns true if the driver is allowed to manage cash payments
allowCreditCard	boolean	Returns true if the driver is allowed to manage credit card payments
isEmployee	boolean	Returns true if the driver is employee of the delivery account
billingMode	string	Driver billing mode
createdAt	string (date-time)	Delivery contract creation time

MODEL EXAMPLES

Example

{
    "id": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Activo",
        "color": "#5aac44",
        "callToAction": null
    },
    "deliveryAccount": {
        "id": "754",
        "name": "Delivery account name",
        "horizontalLogo": "http://route-to-logo.com"
    },
    "allowCash": false,
    "allowCreditCard": false,
    "isEmployee": false,
    "billingMode": "DEFAULT | SELF",
    "createdAt": "2017-02-09T12:15:00+0000"
}

DeliveryContractRequest

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract request identifier
chatId	integer (int64)	Delivery contract request chat identifier
status	object Status	Delivery contract request current status
postalCodes	array	Delivery contract request postal codes
message	string	First delivery contract request message
createdAt	string (date-time)	Delivery contract request creation time

MODEL EXAMPLES

Example

{
    "id": "754",
    "chatId": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Active",
        "color": "#5aac44"
    },
    "postalCodes": [
        null
    ],
    "message": "Hi... I'm interested in...",
    "createdAt": "2017-02-09T12:15:00+0000"
}

DeliveryContractRequest

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract request identifier
chatId	integer (int64)	Delivery contract request chat identifier
status	object Status	Delivery contract request current status
postalCodes	array	Delivery contract request postal codes
message	string	First delivery contract request message
createdAt	string (date-time)	Delivery contract request creation time
deliveryAccount	object deliveryAccount	Delivery contract request delivery account

MODEL EXAMPLES

Example

{
    "id": "754",
    "chatId": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Active",
        "color": "#5aac44"
    },
    "postalCodes": [
        null
    ],
    "message": "Hi... I'm interested in...",
    "createdAt": "2017-02-09T12:15:00+0000",
    "deliveryAccount": {
        "id": "754",
        "name": "Delivery account name",
        "horizontalLogo": "http://route-to-logo.com"
    }
}

DeliveryContractRequest

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract request identifier
chatId	integer (int64)	Delivery contract request chat identifier
status	object Status	Delivery contract request current status
postalCodes	array	Delivery contract request postal codes
message	string	First delivery contract request message
createdAt	string (date-time)	Delivery contract request creation time
deliveryAccount	object deliveryAccount	Delivery contract request delivery account

MODEL EXAMPLES

Example

{
    "id": "754",
    "chatId": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Active",
        "color": "#5aac44"
    },
    "postalCodes": [
        null
    ],
    "message": "Hi... I'm interested in...",
    "createdAt": "2017-02-09T12:15:00+0000",
    "deliveryAccount": {
        "id": "754",
        "name": "Delivery account name",
        "horizontalLogo": "http://route-to-logo.com"
    }
}

DeliveryContractRequest

MODEL ATTRIBUTES

id	integer (int64)	Delivery contract request identifier
chatId	integer (int64)	Delivery contract request chat identifier
status	object Status	Delivery contract request current status
postalCodes	array	Delivery contract request postal codes
message	string	First delivery contract request message
createdAt	string (date-time)	Delivery contract request creation time
driver	object driver	Delivery contract request driver

MODEL EXAMPLES

Example

{
    "id": "754",
    "chatId": "754",
    "status": {
        "code": "ACTIVE",
        "name": "Active",
        "color": "#5aac44"
    },
    "postalCodes": [
        null
    ],
    "message": "Hi... I'm interested in...",
    "createdAt": "2017-02-09T12:15:00+0000",
    "driver": {
        "id": 1003,
        "transport": {
            "code": "SCOOTER",
            "name": "Scooter"
        }
    }
}

DeliveryShift

MODEL ATTRIBUTES

id	integer (int64)	Delivery shift identifier
startsAt	string (date-time)	Delivery shift start time
endsAt	string (date-time)	Delivery shift end time
platformName	string	Delivery shift platform name
status	object Status	Current delivery shift status
deliveryConditionsSetRules	array	Array with Delivery conditions rules

MODEL EXAMPLES

Example

{
    "id": "754",
    "startsAt": "2017-02-12T23:30:00+0000",
    "endsAt": "2017-02-12T21:30:00+0000",
    "platformName": "Delivery&Co",
    "status": {
        "code": "ACTIVE",
        "name": "Active",
        "color": "#5aac44"
    },
    "deliveryConditionsSetRules": [
        [
            {
                "pickupPostalCode": "08800",
                "deliveryPostalCode": "08800",
                "transportType": {
                    "code": "SCOOTER",
                    "name": "Scooter"
                }
            }
        ]
    ]
}

DeliveryShift

MODEL ATTRIBUTES

id	integer (int64)	Delivery shift identifier
startsAt	string (date-time)	Delivery shift start time
endsAt	string (date-time)	Delivery shift end time
platformName	string	Delivery shift platform name
status	object Status	Current delivery shift status
deliveryConditionsSetRules	array	Array with Delivery conditions rules

MODEL EXAMPLES

Example

{
    "id": "754",
    "startsAt": "2017-02-12T23:30:00+0000",
    "endsAt": "2017-02-12T21:30:00+0000",
    "platformName": "Delivery&Co",
    "status": {
        "code": "ACTIVE",
        "name": "Active",
        "color": "#5aac44"
    },
    "deliveryConditionsSetRules": [
        [
            {
                "pickupPostalCode": "08800",
                "deliveryPostalCode": "08800",
                "transportType": {
                    "code": "SCOOTER",
                    "name": "Scooter"
                }
            }
        ]
    ]
}

DeliveryZone

MODEL ATTRIBUTES

If delivery authorization is for delivery zone returns delivery zone

id	integer (int64)	Delivery zone identifier
name	string	Zone name
postalCodes	array	Delivery zone postal codes

MODEL EXAMPLES

Example

{
    "id": "754",
    "name": "XXX zone",
    "postalCodes": [
        null
    ]
}

DeviceInteraction

MODEL ATTRIBUTES

Order

deviceId	integer (int64)		Device identifier
deviceToken	string		Device token

MODEL EXAMPLES

Example

{
    "deviceId": 1221,
    "deviceToken": "4b6c259950e13ddc5d391baf121112bb0d3b0cc80e9d0deee375ae50329d37a2338"
}

Driver

MODEL ATTRIBUTES

id	integer (int64)	Driver identifier
email	string	Driver email
name	string	Driver name
lastname	string	Driver last name
image	string	Driver image url
phone	string	In international format. Ex. +34600000000
transport	object TransportType
status	object Status	Current driver status

MODEL EXAMPLES

Example

{
    "id": 1003,
    "email": "john@example.com",
    "name": "John",
    "lastname": "Doe",
    "image": "https://cdn.sinqro.com/assets/images/placeholder_image.jpg",
    "phone": "+34600000000",
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    },
    "status": {
        "code": "onduty",
        "name": "En servicio",
        "color": "#5aac44"
    }
}

Driver

MODEL ATTRIBUTES

id	integer (int64)	Driver identifier
email	string	Driver email
name	string	Driver name
lastname	string	Driver last name
image	string	Driver image url
phone	string	In international format. Ex. +34600000000
transport	object Transport	Driver transport type
status	object Status	Current driver status
account	object Account	Driver account

MODEL EXAMPLES

Example

{
    "id": 1003,
    "email": "john@example.com",
    "name": "John",
    "lastname": "Doe",
    "image": "https://cdn.sinqro.com/assets/images/placeholder_image.jpg",
    "phone": "+34600000000",
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    },
    "status": {
        "code": "onduty",
        "name": "En servicio",
        "color": "#5aac44"
    },
    "account": {
        "id": "43",
        "name": "My account",
        "balanceAmount": "0.00",
        "legalName": "My Company S.L",
        "legalVatNumber": "00000000B",
        "legalAddress": "C/ Example, 299",
        "legalAddressDetails": null,
        "legalAddressPostalCode": "12345",
        "legalAddressCity": "Example city",
        "legalAddressProvince": "Example province"
    }
}

Driver

MODEL ATTRIBUTES

Delivery contract driver

id	integer (int64)		Driver identifier
transport	object TransportType		Driver transport type

MODEL EXAMPLES

Example

{
    "id": 1003,
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    }
}

DriverService

MODEL ATTRIBUTES

id	integer (int64)	Delivery identifier
scheduledEndTime	string (date-time)	Scheduled end time
scheduledStartTime	string (date-time)	Scheduled start time
conditions	object Conditions	Driver service conditions
status	object Status	Current driver service status
transport	object Transport	Transport type
newStatusOptions	array Status	Array with new possible statuses for driver service

MODEL EXAMPLES

Example

{
    "id": "754",
    "scheduledEndTime": "2017-02-12T23:30:00+0000",
    "scheduledStartTime": "2017-02-12T21:30:00+0000",
    "conditions": {
        "id": "754",
        "perDeliveryBaseAmount": "3",
        "perDeliveryKmAmount": false,
        "perDeliveryMinuteAmount": false,
        "perDeliveryDelayMinuteAmount": false,
        "perShiftAmount": false,
        "perShiftMinAmount": false
    },
    "status": {
        "code": "SCHEDULED",
        "name": "Scheduled",
        "color": "blue"
    },
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    },
    "newStatusOptions": [
        {
            "code": "ACTIVE",
            "name": "Activo",
            "color": "#5aac44",
            "callToAction": null
        }
    ]
}

DriverService

MODEL ATTRIBUTES

id	integer (int64)	Delivery identifier
scheduledEndTime	string (date-time)	Scheduled end time
scheduledStartTime	string (date-time)	Scheduled start time
conditions	object Conditions	Driver service conditions
status	object Status	Current driver service status
transport	object Transport	Transport type
newStatusOptions	array Status	Array with new possible statuses for driver service

MODEL EXAMPLES

Example

{
    "id": "754",
    "scheduledEndTime": "2017-02-12T23:30:00+0000",
    "scheduledStartTime": "2017-02-12T21:30:00+0000",
    "conditions": {
        "id": "754",
        "perDeliveryBaseAmount": "3",
        "perDeliveryKmAmount": false,
        "perDeliveryMinuteAmount": false,
        "perDeliveryDelayMinuteAmount": false,
        "perShiftAmount": false,
        "perShiftMinAmount": false
    },
    "status": {
        "code": "SCHEDULED",
        "name": "Scheduled",
        "color": "blue"
    },
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    },
    "newStatusOptions": [
        {
            "code": "ACTIVE",
            "name": "Activo",
            "color": "#5aac44",
            "callToAction": null
        }
    ]
}

Error

MODEL ATTRIBUTES

Error

code	string		Error code identifier
message	string		Error description

MODEL EXAMPLES

Example

{
    "code": "ERROR_CODE_EXAMPLE",
    "message": "Error message"
}

ErrorResponse

MODEL ATTRIBUTES

Error response

errors	array Error	Errors
code	string	Error code identifier
message	string	Error description
httpResponseCode	string	HTTP response code

MODEL EXAMPLES

Example

{
    "errors": [
        {
            "code": "ERROR_CODE_EXAMPLE",
            "message": "Error message"
        }
    ],
    "code": "ERROR_CODE_EXAMPLE",
    "message": "Error message",
    "httpResponseCode": "400"
}

Geolocation

MODEL ATTRIBUTES

Driver last geolocation

latitude	number (float)	Geolocation latitude
longitude	number (float)	Geolocation longitude
createdAt	string (date-time)	Geolocation creation time

MODEL EXAMPLES

Example

{
    "latitude": 41.308166,
    "longitude": 2.019725,
    "createdAt": "2018-03-015T12:15:00+0000"
}

Payment

MODEL ATTRIBUTES

Payments required on pickup action

id	integer (int64)	Payment identifier
amount	number (float)	Payment amount
paymentMethodName	string	Payment method name

MODEL EXAMPLES

Example

{
    "id": 1003,
    "amount": "28.60",
    "paymentMethodName": "Cash"
}

Payment

MODEL ATTRIBUTES

Payments required on delivery action

id	integer (int64)	Payment identifier
amount	number (float)	Payment amount
paymentMethodName	string	Payment method name

MODEL EXAMPLES

Example

{
    "id": 1003,
    "amount": "28.60",
    "paymentMethodName": "Cash"
}

Payment

MODEL ATTRIBUTES

id	integer (int32)	Payment identifier
concept	string	Payment concept
amount	number (float)	Payment amount
paymentMethodName	string	Payment method name
status	object Status	Delivery authorization current status
date	string (date-time)	Payment date
resultingAccountAmount	number (float)	Resulting account amount
walletImpact	number (float)	Wallet impact

MODEL EXAMPLES

Example

{
    "id": "1256",
    "concept": "Wallet",
    "amount": "4.00",
    "paymentMethodName": "Wallet",
    "status": {
        "code": "DONE",
        "name": "Done",
        "color": "#5aac44"
    },
    "date": "2017-02-09T12:15:00+0000",
    "resultingAccountAmount": "4.00",
    "walletImpact": "4.00"
}

PickupAddress

MODEL ATTRIBUTES

Delivery pickup address

id	integer (int64)	Address identifier
street	string	Address street with number
details	string	Extra address information
city	string	Address city name
province	string	Address province name
postalCode	string	Address postal code
latitude	number (float)	Address latitude
longitude	number (float)	Address longitude
googlePlaceId	string	Google place identifier
placeName	string	Place name

MODEL EXAMPLES

Example

{
    "id": 1003,
    "street": "C/ Example, 23",
    "details": "Canada building",
    "city": "City name",
    "province": "Province name",
    "postalCode": "12345",
    "latitude": 41.308166,
    "longitude": 2.019725,
    "googlePlaceId": "xxxxxxxxxxxx",
    "placeName": "C/ Example, 23, City name"
}

Publication

MODEL ATTRIBUTES

title	string		Publication title
content	string		Publication content

MODEL EXAMPLES

Example

{
    "title": "Publication title",
    "content": "Publication content"
}

PublicationCategory

MODEL ATTRIBUTES

id	integer (int64)	Publication category identifier
name	string	Publication category name
publications	array Publication	Category publications

MODEL EXAMPLES

Example

{
    "id": "101",
    "name": "Publication category name",
    "publications": [
        {
            "title": "Publication title",
            "content": "Publication content"
        }
    ]
}

Status

MODEL ATTRIBUTES

Current driver status

code	string	Status identifier code Possible values offduty onduty pending disabled
name	string	Status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "onduty",
    "name": "En servicio",
    "color": "#5aac44"
}

Status

MODEL ATTRIBUTES

Current driver status

code	string	Status identifier code Possible values offduty onduty pending disabled
name	string	Status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "onduty",
    "name": "En servicio",
    "color": "#5aac44"
}

Status

MODEL ATTRIBUTES

Current delivery status

code	string	Delivery status identifier code Possible values WAITING_DRIVER_ACCEPTANCE PICKING WAITING_SELLING_POINT_ACCEPTANCE WAITING_SELLING_POINT_PREPARATION DELIVERING WAITING_CUSTOMER DELIVERED CANCELLED INCIDENT ACCEPTED_BY_DRIVER
name	string	Delivery status name
color	string	HEX color code for the status
isFinalStatus	boolean	Return if is the last possible status
callToAction	string	Delivery status call to action message

MODEL EXAMPLES

Example

{
    "code": "PICKING",
    "name": "Picking",
    "color": "blue",
    "isFinalStatus": false,
    "callToAction": "Start picking"
}

Status

MODEL ATTRIBUTES

New possible delivery status

code	string	Delivery status identifier code Possible values WAITING_DRIVER_ACCEPTANCE PICKING WAITING_SELLING_POINT_ACCEPTANCE WAITING_SELLING_POINT_PREPARATION DELIVERING WAITING_CUSTOMER DELIVERED CANCELLED INCIDENT ACCEPTED_BY_DRIVER
name	string	Delivery status name
color	string	HEX color code for the status
isFinalStatus	boolean	Return if is the last possible status
callToAction	string	Delivery status call to action message

MODEL EXAMPLES

Example

{
    "code": "PICKING",
    "name": "Picking",
    "color": "blue",
    "isFinalStatus": false,
    "callToAction": "Start picking"
}

Status

MODEL ATTRIBUTES

Current delivery shift status

code	string	Status identifier code Possible values ACTIVE PAUSED FINISHED CANCELLED
name	string	Status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "ACTIVE",
    "name": "Active",
    "color": "#5aac44"
}

Status

MODEL ATTRIBUTES

Current driver service status

code	string	Driver service status identifier code Possible values SCHEDULED ACTIVE FINISHED PAUSED
name	string	Driver service status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "SCHEDULED",
    "name": "Scheduled",
    "color": "blue"
}

Status

MODEL ATTRIBUTES

Driver service status

code	string	Status identifier code Possible values SCHEDULED ACTIVE FINISHED PAUSED
name	string	Status name
color	string	HEX color code for the status
callToAction	string	Call to action if is needed

MODEL EXAMPLES

Example

{
    "code": "ACTIVE",
    "name": "Activo",
    "color": "#5aac44",
    "callToAction": null
}

Status

MODEL ATTRIBUTES

Delivery contract request current status

code	string	Status identifier code Possible values ACTIVE CLOSED
name	string	Status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "ACTIVE",
    "name": "Active",
    "color": "#5aac44"
}

Status

MODEL ATTRIBUTES

Delivery contract status

code	string	Status identifier code Possible values ACTIVE PENDING_DELIVERY_ACCOUNT_RESPONSE PENDING_DRIVER_RESPONSE FINISHED REFUSED_BY_DELIVERY_ACCOUNT REFUSED_BY_DRIVER
name	string	Status name
color	string	HEX color code for the status
callToAction	string	Call to action if is needed

MODEL EXAMPLES

Example

{
    "code": "ACTIVE",
    "name": "Activo",
    "color": "#5aac44",
    "callToAction": null
}

Status

MODEL ATTRIBUTES

Delivery authorization current status

code	string	Status identifier code Possible values requested authorized denied
name	string	Status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "authorized",
    "name": "Authorized",
    "color": "#5aac44"
}

Status

MODEL ATTRIBUTES

Delivery contract status

code	string	Status identifier code Possible values ACTIVE PENDING_DELIVERY_ACCOUNT_RESPONSE PENDING_DRIVER_RESPONSE FINISHED REFUSED_BY_DELIVERY_ACCOUNT REFUSED_BY_DRIVER
name	string	Status name
color	string	HEX color code for the status
callToAction	string	Call to action if is needed

MODEL EXAMPLES

Example

{
    "code": "ACTIVE",
    "name": "Activo",
    "color": "#5aac44",
    "callToAction": null
}

Status

MODEL ATTRIBUTES

Delivery authorization current status

code	string	Payment status identifier code Possible values AUTHORIZED DONE CAPTURED FAILED PAY_ACTION_FAILED CANCELLED
name	string	Payment status name
color	string	HEX color code for the status

MODEL EXAMPLES

Example

{
    "code": "DONE",
    "name": "Done",
    "color": "#5aac44"
}

Transport

MODEL ATTRIBUTES

Driver transport type

code	string		Transport type identifier code Possible values BIKE SCOOTER MOTORBIKE CAR VAN WALKING
name	string		Transport type name

MODEL EXAMPLES

Example

{
    "code": "SCOOTER",
    "name": "Scooter"
}

Transport

MODEL ATTRIBUTES

Transport type

code	string		Transport type identifier code Possible values BIKE SCOOTER MOTORBIKE CAR VAN WALKING
name	string		Transport type name

MODEL EXAMPLES

Example

{
    "code": "SCOOTER",
    "name": "Scooter"
}

TransportType

MODEL ATTRIBUTES

code	string		Transport type identifier code Possible values BIKE SCOOTER MOTORBIKE CAR VAN WALKING
name	string		Transport type name

MODEL EXAMPLES

Example

{
    "code": "SCOOTER",
    "name": "Scooter"
}

TransportType

MODEL ATTRIBUTES

Transport type

code	string		Transport type identifier code Possible values BIKE SCOOTER MOTORBIKE CAR VAN WALKING
name	string		Transport type name

MODEL EXAMPLES

Example

{
    "code": "SCOOTER",
    "name": "Scooter"
}

TransportType

MODEL ATTRIBUTES

Driver transport type

code	string		Transport type identifier code Possible values BIKE SCOOTER MOTORBIKE CAR VAN WALKING
name	string		Transport type name

MODEL EXAMPLES

Example

{
    "code": "SCOOTER",
    "name": "Scooter"
}

TransportType

MODEL ATTRIBUTES

code	string		Transport type identifier code Possible values BIKE SCOOTER MOTORBIKE CAR VAN WALKING
name	string		Transport type name

MODEL EXAMPLES

Example

{
    "code": "SCOOTER",
    "name": "Scooter"
}

deliveryAccount

MODEL ATTRIBUTES

Delivery contract request delivery account

id	integer (int64)	Delivery account identifier
name	string	Delivery account name
horizontalLogo	string	Delivery account horizontal logo url

MODEL EXAMPLES

Example

{
    "id": "754",
    "name": "Delivery account name",
    "horizontalLogo": "http://route-to-logo.com"
}

driver

MODEL ATTRIBUTES

Driver

id	integer (int64)	Driver identifier
email	string	Driver email
name	string	Driver name
lastname	string	Driver last name
image	string	Driver image url
phone	string	In international format. Ex. +34600000000
transport	object TransportType
status	object Status	Current driver status
lastGeolocation	object Geolocation	Driver last geolocation

MODEL EXAMPLES

Example

{
    "id": 1003,
    "email": "john@example.com",
    "name": "John",
    "lastname": "Doe",
    "image": "https://cdn.sinqro.com/assets/images/placeholder_image.jpg",
    "phone": "+34600000000",
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    },
    "status": {
        "code": "onduty",
        "name": "En servicio",
        "color": "#5aac44"
    },
    "lastGeolocation": {
        "latitude": 41.308166,
        "longitude": 2.019725,
        "createdAt": "2018-03-015T12:15:00+0000"
    }
}

driver

MODEL ATTRIBUTES

Delivery contract request driver

id	integer (int64)		Driver identifier
transport	object TransportType		Driver transport type

MODEL EXAMPLES

Example

{
    "id": 1003,
    "transport": {
        "code": "SCOOTER",
        "name": "Scooter"
    }
}