TukTu OnDemand GraphQL API
Welcome to the TukTu GraphQL API reference, the On Demand solution of the Tuklo last mile delivery platform
This reference includes the complete set of GraphQL types, queries, mutations and subscriptions.
Tuktu is a fast delivery service to provide the best customer experience with our immediate delivery app
By connecting with Tuktu, businesses can access their own fleet of drivers and manage their deliveries
Terms of Service
API Endpoints
# Test environment:
https://yourdomain.tuklo.app/graphql
Headers
# Your oauth2 token
Authorization: Bearer tokenAuthentication
We use Oauth2 authentication -> Login
Refresh token
For refresh the token -> Refresh Token
Queries
allDispatchers
Response
Returns a
DispatcherPaginator
Arguments
| Name | Description |
|---|---|
name -
String
|
|
where -
QueryAllDispatchersWhereWhereConditions
|
|
dispatchersRules -
QueryAllDispatchersDispatchersRulesWhereHasConditions
|
|
orderBy -
[QueryAllDispatchersOrderByOrderByClause!]
|
|
first -
Int
|
Default = 10 |
page -
Int
|
Example
Query
query AllDispatchers(
$name: String,
$where: QueryAllDispatchersWhereWhereConditions,
$dispatchersRules: QueryAllDispatchersDispatchersRulesWhereHasConditions,
$orderBy: [QueryAllDispatchersOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allDispatchers(
name: $name,
where: $where,
dispatchersRules: $dispatchersRules,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
name
account {
...AccountFragment
}
dispatchersRules {
...DispatcherRuleFragment
}
created_at
updated_at
}
}
}
Variables
{
"name": "abc123",
"where": QueryAllDispatchersWhereWhereConditions,
"dispatchersRules": QueryAllDispatchersDispatchersRulesWhereHasConditions,
"orderBy": [QueryAllDispatchersOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"allDispatchers": {
"paginatorInfo": PaginatorInfo,
"data": [Dispatcher]
}
}
}
allEstablishmentWebhooks
Response
Returns an
EstablishmentWebhookPaginator
Arguments
| Name | Description |
|---|---|
uuid -
String
|
|
orderBy -
[QueryAllEstablishmentWebhooksOrderByOrderByClause!]
|
|
where -
QueryAllEstablishmentWebhooksWhereWhereConditions
|
|
establishment -
QueryAllEstablishmentWebhooksEstablishmentWhereHasConditions
|
|
first -
Int
|
Default = 10 |
page -
Int
|
Example
Query
query AllEstablishmentWebhooks(
$uuid: String,
$orderBy: [QueryAllEstablishmentWebhooksOrderByOrderByClause!],
$where: QueryAllEstablishmentWebhooksWhereWhereConditions,
$establishment: QueryAllEstablishmentWebhooksEstablishmentWhereHasConditions,
$first: Int,
$page: Int
) {
allEstablishmentWebhooks(
uuid: $uuid,
orderBy: $orderBy,
where: $where,
establishment: $establishment,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
account {
...AccountFragment
}
establishment {
...EstablishmentFragment
}
event
url
created_at
updated_at
}
}
}
Variables
{
"uuid": "abc123",
"orderBy": [
QueryAllEstablishmentWebhooksOrderByOrderByClause
],
"where": QueryAllEstablishmentWebhooksWhereWhereConditions,
"establishment": QueryAllEstablishmentWebhooksEstablishmentWhereHasConditions,
"first": 10,
"page": 123
}
Response
{
"data": {
"allEstablishmentWebhooks": {
"paginatorInfo": PaginatorInfo,
"data": [EstablishmentWebhook]
}
}
}
allEstablishments
Response
Returns an
EstablishmentPaginator
Arguments
| Name | Description |
|---|---|
name -
String
|
|
where -
QueryAllEstablishmentsWhereWhereConditions
|
|
orderBy -
[QueryAllEstablishmentsOrderByOrderByClause!]
|
|
first -
Int
|
Default = 10 |
page -
Int
|
Example
Query
query AllEstablishments(
$name: String,
$where: QueryAllEstablishmentsWhereWhereConditions,
$orderBy: [QueryAllEstablishmentsOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allEstablishments(
name: $name,
where: $where,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
}
}
Variables
{
"name": "abc123",
"where": QueryAllEstablishmentsWhereWhereConditions,
"orderBy": [QueryAllEstablishmentsOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"allEstablishments": {
"paginatorInfo": PaginatorInfo,
"data": [Establishment]
}
}
}
allOrders
Response
Returns an
OrderPaginator
Arguments
| Name | Description |
|---|---|
tracking_number -
String
|
|
where -
QueryAllOrdersWhereWhereConditions
|
|
establishment -
QueryAllOrdersEstablishmentWhereHasConditions
|
|
customer -
QueryAllOrdersCustomerWhereHasConditions
|
|
orderBy -
[QueryAllOrdersOrderByOrderByClause!]
|
|
first -
Int
|
Default = 10 |
page -
Int
|
Example
Query
query AllOrders(
$tracking_number: String,
$where: QueryAllOrdersWhereWhereConditions,
$establishment: QueryAllOrdersEstablishmentWhereHasConditions,
$customer: QueryAllOrdersCustomerWhereHasConditions,
$orderBy: [QueryAllOrdersOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allOrders(
tracking_number: $tracking_number,
where: $where,
establishment: $establishment,
customer: $customer,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
account {
...AccountFragment
}
date
pickup_date
tracking_number
rider {
...EmployeeFragment
}
status
weight
establishment {
...EstablishmentFragment
}
customer {
...CustomerFragment
}
destinationAddress {
...AddressFragment
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
...OrderPackageFragment
}
orderIncidences {
...OrderIncidenceFragment
}
orderTrackings {
...OrderTrackingFragment
}
orderProofsOfDelivery {
...OrdersProofOfDeliveryFragment
}
files {
...FileFragment
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
}
Variables
{
"tracking_number": "abc123",
"where": QueryAllOrdersWhereWhereConditions,
"establishment": QueryAllOrdersEstablishmentWhereHasConditions,
"customer": QueryAllOrdersCustomerWhereHasConditions,
"orderBy": [QueryAllOrdersOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"allOrders": {
"paginatorInfo": PaginatorInfo,
"data": [Order]
}
}
}
allVehicles
Response
Returns a
VehiclePaginator
Arguments
| Name | Description |
|---|---|
license_plate_number -
String
|
|
where -
QueryAllVehiclesWhereWhereConditions
|
|
distributionCenter -
QueryAllVehiclesDistributionCenterWhereHasConditions
|
|
vehicleModel -
QueryAllVehiclesVehicleModelWhereHasConditions
|
|
orderBy -
[QueryAllVehiclesOrderByOrderByClause!]
|
|
first -
Int
|
Default = 10 |
page -
Int
|
Example
Query
query AllVehicles(
$license_plate_number: String,
$where: QueryAllVehiclesWhereWhereConditions,
$distributionCenter: QueryAllVehiclesDistributionCenterWhereHasConditions,
$vehicleModel: QueryAllVehiclesVehicleModelWhereHasConditions,
$orderBy: [QueryAllVehiclesOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allVehicles(
license_plate_number: $license_plate_number,
where: $where,
distributionCenter: $distributionCenter,
vehicleModel: $vehicleModel,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
...AccountFragment
}
distributionCenter {
...DistributionCenterFragment
}
vehicleModel {
...VehicleModelFragment
}
employees {
...EmployeeFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_driver {
...EmployeeFragment
}
files {
...FileFragment
}
}
}
}
Variables
{
"license_plate_number": "xyz789",
"where": QueryAllVehiclesWhereWhereConditions,
"distributionCenter": QueryAllVehiclesDistributionCenterWhereHasConditions,
"vehicleModel": QueryAllVehiclesVehicleModelWhereHasConditions,
"orderBy": [QueryAllVehiclesOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"allVehicles": {
"paginatorInfo": PaginatorInfo,
"data": [Vehicle]
}
}
}
findEstablishmentWebhook
Response
Returns an
EstablishmentWebhook
Arguments
| Name | Description |
|---|---|
uuid -
String!
|
Example
Query
query FindEstablishmentWebhook($uuid: String!) {
findEstablishmentWebhook(uuid: $uuid) {
id
uuid
account {
id
uuid
name
}
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
event
url
created_at
updated_at
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"findEstablishmentWebhook": {
"id": 4,
"uuid": "abc123",
"account": Account,
"establishment": Establishment,
"event": "ORDERS_TRACKING",
"url": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
findEstablishmentWebhookById
Response
Returns an
EstablishmentWebhook
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query FindEstablishmentWebhookById($id: ID!) {
findEstablishmentWebhookById(id: $id) {
id
uuid
account {
id
uuid
name
}
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
event
url
created_at
updated_at
}
}
Variables
{"id": 4}
Response
{
"data": {
"findEstablishmentWebhookById": {
"id": 4,
"uuid": "abc123",
"account": Account,
"establishment": Establishment,
"event": "ORDERS_TRACKING",
"url": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
findVehicle
Example
Query
query FindVehicle($uuid: String) {
findVehicle(uuid: $uuid) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"findVehicle": {
"id": 4,
"uuid": "xyz789",
"identification_number": "xyz789",
"license_plate_number": "xyz789",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
findVehicleById
Example
Query
query FindVehicleById($id: ID!) {
findVehicleById(id: $id) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"findVehicleById": {
"id": "4",
"uuid": "xyz789",
"identification_number": "abc123",
"license_plate_number": "xyz789",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
getCustomer
Example
Query
query GetCustomer(
$email: String,
$phone_number: String
) {
getCustomer(
email: $email,
phone_number: $phone_number
) {
id
uuid
account {
id
uuid
name
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
addresses {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
created_at
updated_at
}
}
Variables
{
"email": "xyz789",
"phone_number": "abc123"
}
Response
{
"data": {
"getCustomer": {
"id": 4,
"uuid": "abc123",
"account": Account,
"first_name": "abc123",
"last_name": "abc123",
"document_type_country": "xyz789",
"document_type": "xyz789",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "xyz789",
"preferred_address": Address,
"addresses": [Address],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
getDispatcher
Response
Returns a
Dispatcher
Arguments
| Name | Description |
|---|---|
uuid -
String
|
Example
Query
query GetDispatcher($uuid: String) {
getDispatcher(uuid: $uuid) {
id
uuid
name
account {
id
uuid
name
}
dispatchersRules {
id
uuid
dispatcher {
...DispatcherFragment
}
trigger
rule
value
created_at
updated_at
}
created_at
updated_at
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"getDispatcher": {
"id": 4,
"uuid": "abc123",
"name": "abc123",
"account": Account,
"dispatchersRules": [DispatcherRule],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
getEstablishment
Response
Returns an
Establishment
Arguments
| Name | Description |
|---|---|
uuid -
String!
|
Example
Query
query GetEstablishment($uuid: String!) {
getEstablishment(uuid: $uuid) {
id
uuid
name
company {
id
uuid
commercial_name
corporate_name
phone_number
}
dispatcher {
id
uuid
name
account {
...AccountFragment
}
dispatchersRules {
...DispatcherRuleFragment
}
created_at
updated_at
}
address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
account {
id
uuid
name
}
created_at
updated_at
phone_number
email
enabled
orders {
id
uuid
account {
...AccountFragment
}
date
pickup_date
tracking_number
rider {
...EmployeeFragment
}
status
weight
establishment {
...EstablishmentFragment
}
customer {
...CustomerFragment
}
destinationAddress {
...AddressFragment
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
...OrderPackageFragment
}
orderIncidences {
...OrderIncidenceFragment
}
orderTrackings {
...OrderTrackingFragment
}
orderProofsOfDelivery {
...OrdersProofOfDeliveryFragment
}
files {
...FileFragment
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
establishmentWebhooks {
id
uuid
account {
...AccountFragment
}
establishment {
...EstablishmentFragment
}
event
url
created_at
updated_at
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
businessSchedule {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
... on Establishment {
...EstablishmentFragment
}
... on CustomerServicePhoneNumber {
...CustomerServicePhoneNumberFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"getEstablishment": {
"id": 4,
"uuid": "xyz789",
"name": "abc123",
"company": Company,
"dispatcher": Dispatcher,
"address": Address,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"phone_number": "abc123",
"email": "abc123",
"enabled": false,
"orders": [Order],
"establishmentWebhooks": [EstablishmentWebhook],
"user": User,
"businessSchedule": BusinessSchedule
}
}
}
getEstablishmentById
Response
Returns an
Establishment
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query GetEstablishmentById($id: ID!) {
getEstablishmentById(id: $id) {
id
uuid
name
company {
id
uuid
commercial_name
corporate_name
phone_number
}
dispatcher {
id
uuid
name
account {
...AccountFragment
}
dispatchersRules {
...DispatcherRuleFragment
}
created_at
updated_at
}
address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
account {
id
uuid
name
}
created_at
updated_at
phone_number
email
enabled
orders {
id
uuid
account {
...AccountFragment
}
date
pickup_date
tracking_number
rider {
...EmployeeFragment
}
status
weight
establishment {
...EstablishmentFragment
}
customer {
...CustomerFragment
}
destinationAddress {
...AddressFragment
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
...OrderPackageFragment
}
orderIncidences {
...OrderIncidenceFragment
}
orderTrackings {
...OrderTrackingFragment
}
orderProofsOfDelivery {
...OrdersProofOfDeliveryFragment
}
files {
...FileFragment
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
establishmentWebhooks {
id
uuid
account {
...AccountFragment
}
establishment {
...EstablishmentFragment
}
event
url
created_at
updated_at
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
businessSchedule {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
... on Establishment {
...EstablishmentFragment
}
... on CustomerServicePhoneNumber {
...CustomerServicePhoneNumberFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getEstablishmentById": {
"id": 4,
"uuid": "xyz789",
"name": "xyz789",
"company": Company,
"dispatcher": Dispatcher,
"address": Address,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"phone_number": "abc123",
"email": "abc123",
"enabled": true,
"orders": [Order],
"establishmentWebhooks": [EstablishmentWebhook],
"user": User,
"businessSchedule": BusinessSchedule
}
}
}
getOrder
Example
Query
query GetOrder($uuid: String!) {
getOrder(uuid: $uuid) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"getOrder": {
"id": 4,
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 123,
"complete": true,
"notes": "xyz789",
"source": "abc123",
"price": 123.45,
"currency": "xyz789",
"cancel_reason": "xyz789",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 987.65,
"autoassign": false,
"scheduled": true
}
}
}
getOrderById
Example
Query
query GetOrderById($id: ID!) {
getOrderById(id: $id) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"id": 4}
Response
{
"data": {
"getOrderById": {
"id": "4",
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 987,
"complete": true,
"notes": "abc123",
"source": "xyz789",
"price": 123.45,
"currency": "xyz789",
"cancel_reason": "xyz789",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 123.45,
"autoassign": true,
"scheduled": true
}
}
}
totalOrdersPerDay
Response
Returns an
OrderPerDayPaginator
Arguments
| Name | Description |
|---|---|
rider_id -
Int!
|
|
status -
OrderStatus
|
|
first -
Int
|
Default = 10 |
page -
Int
|
Example
Query
query TotalOrdersPerDay(
$rider_id: Int!,
$status: OrderStatus,
$first: Int,
$page: Int
) {
totalOrdersPerDay(
rider_id: $rider_id,
status: $status,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
date_formatted
total
total_price
ids
}
}
}
Variables
{"rider_id": 987, "status": "REQUESTED", "first": 10, "page": 123}
Response
{
"data": {
"totalOrdersPerDay": {
"paginatorInfo": PaginatorInfo,
"data": [OrderPerDay]
}
}
}
Mutations
acceptOrderRequest
Example
Query
mutation AcceptOrderRequest(
$id: ID!,
$accepted: Boolean!
) {
acceptOrderRequest(
id: $id,
accepted: $accepted
) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"id": 4, "accepted": false}
Response
{
"data": {
"acceptOrderRequest": {
"id": 4,
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 123,
"complete": false,
"notes": "xyz789",
"source": "abc123",
"price": 987.65,
"currency": "abc123",
"cancel_reason": "abc123",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "abc123",
"distance": 123.45,
"autoassign": true,
"scheduled": true
}
}
}
addDocumentationToVehicle
Response
Returns a
Vehicle!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
AddDocumentationToVehicleInput!
|
Example
Query
mutation AddDocumentationToVehicle(
$id: ID!,
$input: AddDocumentationToVehicleInput!
) {
addDocumentationToVehicle(
id: $id,
input: $input
) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{
"id": "4",
"input": AddDocumentationToVehicleInput
}
Response
{
"data": {
"addDocumentationToVehicle": {
"id": 4,
"uuid": "abc123",
"identification_number": "abc123",
"license_plate_number": "abc123",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
assignEmployee
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
AssignEmployeeInput!
|
Example
Query
mutation AssignEmployee(
$id: ID!,
$input: AssignEmployeeInput!
) {
assignEmployee(
id: $id,
input: $input
)
}
Variables
{
"id": "4",
"input": AssignEmployeeInput
}
Response
{"data": {"assignEmployee": "xyz789"}}
assignOrder
Example
Query
mutation AssignOrder(
$id: ID!,
$rider_id: ID!
) {
assignOrder(
id: $id,
rider_id: $rider_id
) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"id": "4", "rider_id": 4}
Response
{
"data": {
"assignOrder": {
"id": "4",
"uuid": "xyz789",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 987,
"complete": true,
"notes": "abc123",
"source": "xyz789",
"price": 987.65,
"currency": "abc123",
"cancel_reason": "abc123",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 123.45,
"autoassign": true,
"scheduled": true
}
}
}
assignVehicle
Response
Returns an
Employee!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
AssignEmployeeVehicleInput!
|
Example
Query
mutation AssignVehicle(
$id: ID!,
$input: AssignEmployeeVehicleInput!
) {
assignVehicle(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
company {
id
uuid
commercial_name
corporate_name
phone_number
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
...AccountFragment
}
distributionCenter {
...DistributionCenterFragment
}
vehicleModel {
...VehicleModelFragment
}
employees {
...EmployeeFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_driver {
...EmployeeFragment
}
files {
...FileFragment
}
}
assigned {
id
from_date
to_date
}
current_vehicle {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
...AccountFragment
}
distributionCenter {
...DistributionCenterFragment
}
vehicleModel {
...VehicleModelFragment
}
employees {
...EmployeeFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_driver {
...EmployeeFragment
}
files {
...FileFragment
}
}
vehicle_type
}
}
Variables
{"id": 4, "input": AssignEmployeeVehicleInput}
Response
{
"data": {
"assignVehicle": {
"id": "4",
"uuid": "abc123",
"account": Account,
"company": Company,
"first_name": "abc123",
"last_name": "xyz789",
"full_name": "abc123",
"email": "abc123",
"phone_number": "abc123",
"enabled": false,
"available_for_order": false,
"vehicles": [Vehicle],
"assigned": VehicleEmployeePivot,
"current_vehicle": Vehicle,
"vehicle_type": "CAR"
}
}
}
cancelOrder
Response
Returns an
Order
Example
Query
mutation CancelOrder(
$id: ID!,
$cancel_reason: String!,
$order_incidence_reason_id: ID!
) {
cancelOrder(
id: $id,
cancel_reason: $cancel_reason,
order_incidence_reason_id: $order_incidence_reason_id
) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{
"id": "4",
"cancel_reason": "abc123",
"order_incidence_reason_id": 4
}
Response
{
"data": {
"cancelOrder": {
"id": "4",
"uuid": "xyz789",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 987,
"complete": true,
"notes": "abc123",
"source": "xyz789",
"price": 987.65,
"currency": "xyz789",
"cancel_reason": "abc123",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 987.65,
"autoassign": false,
"scheduled": false
}
}
}
createCustomer
Response
Returns a
Customer!
Arguments
| Name | Description |
|---|---|
input -
CreateCustomerInput!
|
Example
Query
mutation CreateCustomer($input: CreateCustomerInput!) {
createCustomer(input: $input) {
id
uuid
account {
id
uuid
name
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
addresses {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
created_at
updated_at
}
}
Variables
{"input": CreateCustomerInput}
Response
{
"data": {
"createCustomer": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"first_name": "xyz789",
"last_name": "abc123",
"document_type_country": "xyz789",
"document_type": "abc123",
"document_number": "xyz789",
"email": "abc123",
"phone_number": "xyz789",
"preferred_address": Address,
"addresses": [Address],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createDispatcher
Response
Returns a
Dispatcher!
Arguments
| Name | Description |
|---|---|
input -
CreateDispatcherInput!
|
Example
Query
mutation CreateDispatcher($input: CreateDispatcherInput!) {
createDispatcher(input: $input) {
id
uuid
name
account {
id
uuid
name
}
dispatchersRules {
id
uuid
dispatcher {
...DispatcherFragment
}
trigger
rule
value
created_at
updated_at
}
created_at
updated_at
}
}
Variables
{"input": CreateDispatcherInput}
Response
{
"data": {
"createDispatcher": {
"id": "4",
"uuid": "xyz789",
"name": "abc123",
"account": Account,
"dispatchersRules": [DispatcherRule],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createEstablishment
Response
Returns an
Establishment!
Arguments
| Name | Description |
|---|---|
input -
CreateEstablishmentInput!
|
Example
Query
mutation CreateEstablishment($input: CreateEstablishmentInput!) {
createEstablishment(input: $input) {
id
uuid
name
company {
id
uuid
commercial_name
corporate_name
phone_number
}
dispatcher {
id
uuid
name
account {
...AccountFragment
}
dispatchersRules {
...DispatcherRuleFragment
}
created_at
updated_at
}
address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
account {
id
uuid
name
}
created_at
updated_at
phone_number
email
enabled
orders {
id
uuid
account {
...AccountFragment
}
date
pickup_date
tracking_number
rider {
...EmployeeFragment
}
status
weight
establishment {
...EstablishmentFragment
}
customer {
...CustomerFragment
}
destinationAddress {
...AddressFragment
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
...OrderPackageFragment
}
orderIncidences {
...OrderIncidenceFragment
}
orderTrackings {
...OrderTrackingFragment
}
orderProofsOfDelivery {
...OrdersProofOfDeliveryFragment
}
files {
...FileFragment
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
establishmentWebhooks {
id
uuid
account {
...AccountFragment
}
establishment {
...EstablishmentFragment
}
event
url
created_at
updated_at
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
businessSchedule {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
... on Establishment {
...EstablishmentFragment
}
... on CustomerServicePhoneNumber {
...CustomerServicePhoneNumberFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
}
}
Variables
{"input": CreateEstablishmentInput}
Response
{
"data": {
"createEstablishment": {
"id": 4,
"uuid": "xyz789",
"name": "abc123",
"company": Company,
"dispatcher": Dispatcher,
"address": Address,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"phone_number": "xyz789",
"email": "xyz789",
"enabled": true,
"orders": [Order],
"establishmentWebhooks": [EstablishmentWebhook],
"user": User,
"businessSchedule": BusinessSchedule
}
}
}
createEstablishmentWebhook
Response
Returns an
EstablishmentWebhook!
Arguments
| Name | Description |
|---|---|
input -
CreateEstablishmentWebhookInput!
|
Example
Query
mutation CreateEstablishmentWebhook($input: CreateEstablishmentWebhookInput!) {
createEstablishmentWebhook(input: $input) {
id
uuid
account {
id
uuid
name
}
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
event
url
created_at
updated_at
}
}
Variables
{"input": CreateEstablishmentWebhookInput}
Response
{
"data": {
"createEstablishmentWebhook": {
"id": "4",
"uuid": "abc123",
"account": Account,
"establishment": Establishment,
"event": "ORDERS_TRACKING",
"url": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createOrder
Response
Returns an
Order!
Arguments
| Name | Description |
|---|---|
input -
CreateOrderInput!
|
Example
Query
mutation CreateOrder($input: CreateOrderInput!) {
createOrder(input: $input) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"input": CreateOrderInput}
Response
{
"data": {
"createOrder": {
"id": "4",
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "abc123",
"rider": Employee,
"status": "REQUESTED",
"weight": 987.65,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 987,
"complete": true,
"notes": "xyz789",
"source": "abc123",
"price": 987.65,
"currency": "abc123",
"cancel_reason": "abc123",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "abc123",
"distance": 123.45,
"autoassign": false,
"scheduled": true
}
}
}
createOrderRequest
Response
Returns an
Order!
Arguments
| Name | Description |
|---|---|
input -
CreateOrderRequestInput!
|
Example
Query
mutation CreateOrderRequest($input: CreateOrderRequestInput!) {
createOrderRequest(input: $input) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"input": CreateOrderRequestInput}
Response
{
"data": {
"createOrderRequest": {
"id": "4",
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 987.65,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 123,
"complete": false,
"notes": "xyz789",
"source": "xyz789",
"price": 123.45,
"currency": "abc123",
"cancel_reason": "xyz789",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "abc123",
"distance": 123.45,
"autoassign": false,
"scheduled": true
}
}
}
createVehicle
Response
Returns a
Vehicle!
Arguments
| Name | Description |
|---|---|
input -
CreateVehicleInput!
|
Example
Query
mutation CreateVehicle($input: CreateVehicleInput!) {
createVehicle(input: $input) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{"input": CreateVehicleInput}
Response
{
"data": {
"createVehicle": {
"id": "4",
"uuid": "xyz789",
"identification_number": "xyz789",
"license_plate_number": "xyz789",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
deleteAssignVehicle
Response
Returns an
Employee!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
DeleteAssignEmployeeVehicleInput!
|
Example
Query
mutation DeleteAssignVehicle(
$id: ID!,
$input: DeleteAssignEmployeeVehicleInput!
) {
deleteAssignVehicle(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
company {
id
uuid
commercial_name
corporate_name
phone_number
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
...AccountFragment
}
distributionCenter {
...DistributionCenterFragment
}
vehicleModel {
...VehicleModelFragment
}
employees {
...EmployeeFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_driver {
...EmployeeFragment
}
files {
...FileFragment
}
}
assigned {
id
from_date
to_date
}
current_vehicle {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
...AccountFragment
}
distributionCenter {
...DistributionCenterFragment
}
vehicleModel {
...VehicleModelFragment
}
employees {
...EmployeeFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_driver {
...EmployeeFragment
}
files {
...FileFragment
}
}
vehicle_type
}
}
Variables
{
"id": "4",
"input": DeleteAssignEmployeeVehicleInput
}
Response
{
"data": {
"deleteAssignVehicle": {
"id": "4",
"uuid": "xyz789",
"account": Account,
"company": Company,
"first_name": "abc123",
"last_name": "abc123",
"full_name": "abc123",
"email": "xyz789",
"phone_number": "xyz789",
"enabled": false,
"available_for_order": true,
"vehicles": [Vehicle],
"assigned": VehicleEmployeePivot,
"current_vehicle": Vehicle,
"vehicle_type": "CAR"
}
}
}
deleteComment
Example
Query
mutation DeleteComment($id: ID!) {
deleteComment(id: $id) {
id
uuid
body
created_at
updated_at
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteComment": {
"id": 4,
"uuid": "abc123",
"body": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deleteCommentContract
Response
Returns a
Comment!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
DeleteCommentContractInput!
|
Example
Query
mutation DeleteCommentContract(
$id: ID!,
$input: DeleteCommentContractInput!
) {
deleteCommentContract(
id: $id,
input: $input
) {
id
uuid
body
created_at
updated_at
}
}
Variables
{
"id": "4",
"input": DeleteCommentContractInput
}
Response
{
"data": {
"deleteCommentContract": {
"id": "4",
"uuid": "xyz789",
"body": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deleteCustomer
Example
Query
mutation DeleteCustomer($id: ID!) {
deleteCustomer(id: $id) {
id
uuid
account {
id
uuid
name
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
addresses {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
created_at
updated_at
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteCustomer": {
"id": 4,
"uuid": "abc123",
"account": Account,
"first_name": "abc123",
"last_name": "abc123",
"document_type_country": "xyz789",
"document_type": "xyz789",
"document_number": "abc123",
"email": "abc123",
"phone_number": "abc123",
"preferred_address": Address,
"addresses": [Address],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deleteDispatcher
Response
Returns a
Dispatcher
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation DeleteDispatcher($id: ID!) {
deleteDispatcher(id: $id) {
id
uuid
name
account {
id
uuid
name
}
dispatchersRules {
id
uuid
dispatcher {
...DispatcherFragment
}
trigger
rule
value
created_at
updated_at
}
created_at
updated_at
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteDispatcher": {
"id": "4",
"uuid": "xyz789",
"name": "xyz789",
"account": Account,
"dispatchersRules": [DispatcherRule],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deleteEstablishment
Response
Returns an
Establishment
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation DeleteEstablishment($id: ID!) {
deleteEstablishment(id: $id) {
id
uuid
name
company {
id
uuid
commercial_name
corporate_name
phone_number
}
dispatcher {
id
uuid
name
account {
...AccountFragment
}
dispatchersRules {
...DispatcherRuleFragment
}
created_at
updated_at
}
address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
account {
id
uuid
name
}
created_at
updated_at
phone_number
email
enabled
orders {
id
uuid
account {
...AccountFragment
}
date
pickup_date
tracking_number
rider {
...EmployeeFragment
}
status
weight
establishment {
...EstablishmentFragment
}
customer {
...CustomerFragment
}
destinationAddress {
...AddressFragment
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
...OrderPackageFragment
}
orderIncidences {
...OrderIncidenceFragment
}
orderTrackings {
...OrderTrackingFragment
}
orderProofsOfDelivery {
...OrdersProofOfDeliveryFragment
}
files {
...FileFragment
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
establishmentWebhooks {
id
uuid
account {
...AccountFragment
}
establishment {
...EstablishmentFragment
}
event
url
created_at
updated_at
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
businessSchedule {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
... on Establishment {
...EstablishmentFragment
}
... on CustomerServicePhoneNumber {
...CustomerServicePhoneNumberFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteEstablishment": {
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"company": Company,
"dispatcher": Dispatcher,
"address": Address,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"phone_number": "abc123",
"email": "abc123",
"enabled": true,
"orders": [Order],
"establishmentWebhooks": [EstablishmentWebhook],
"user": User,
"businessSchedule": BusinessSchedule
}
}
}
deleteEstablishmentWebhook
Response
Returns an
EstablishmentWebhook
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
mutation DeleteEstablishmentWebhook($id: ID!) {
deleteEstablishmentWebhook(id: $id) {
id
uuid
account {
id
uuid
name
}
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
event
url
created_at
updated_at
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteEstablishmentWebhook": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"establishment": Establishment,
"event": "ORDERS_TRACKING",
"url": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deleteOrder
Example
Query
mutation DeleteOrder($id: ID!) {
deleteOrder(id: $id) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteOrder": {
"id": "4",
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "abc123",
"rider": Employee,
"status": "REQUESTED",
"weight": 987.65,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 123,
"complete": false,
"notes": "abc123",
"source": "abc123",
"price": 123.45,
"currency": "xyz789",
"cancel_reason": "xyz789",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 123.45,
"autoassign": true,
"scheduled": true
}
}
}
deleteOrderIncidence
Example
Query
mutation DeleteOrderIncidence($id: ID!) {
deleteOrderIncidence(id: $id) {
id
uuid
body
created_at
updated_at
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteOrderIncidence": {
"id": "4",
"uuid": "abc123",
"body": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deleteVehicle
Example
Query
mutation DeleteVehicle($id: ID!) {
deleteVehicle(id: $id) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteVehicle": {
"id": 4,
"uuid": "abc123",
"identification_number": "abc123",
"license_plate_number": "abc123",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
forgotPassword
Response
Returns a
ForgotPasswordResponse!
Arguments
| Name | Description |
|---|---|
input -
ForgotPasswordInput!
|
Example
Query
mutation ForgotPassword($input: ForgotPasswordInput!) {
forgotPassword(input: $input) {
status
message
}
}
Variables
{"input": ForgotPasswordInput}
Response
{
"data": {
"forgotPassword": {
"status": "xyz789",
"message": "abc123"
}
}
}
getClientToken
Response
Returns a
TokenPayload!
Arguments
| Name | Description |
|---|---|
input -
TokenInput
|
Example
Query
mutation GetClientToken($input: TokenInput) {
getClientToken(input: $input) {
access_token
refresh_token
expires_in
token_type
}
}
Variables
{"input": TokenInput}
Response
{
"data": {
"getClientToken": {
"access_token": "xyz789",
"refresh_token": "abc123",
"expires_in": 123,
"token_type": "xyz789"
}
}
}
launchOrderAssignation
Example
Query
mutation LaunchOrderAssignation($id: ID!) {
launchOrderAssignation(id: $id) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{"id": "4"}
Response
{
"data": {
"launchOrderAssignation": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "abc123",
"rider": Employee,
"status": "REQUESTED",
"weight": 987.65,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 987,
"complete": false,
"notes": "xyz789",
"source": "xyz789",
"price": 987.65,
"currency": "abc123",
"cancel_reason": "xyz789",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 123.45,
"autoassign": false,
"scheduled": true
}
}
}
login
Response
Returns an
AuthPayload!
Arguments
| Name | Description |
|---|---|
input -
LoginInput
|
Example
Query
mutation Login($input: LoginInput) {
login(input: $input) {
access_token
refresh_token
expires_in
token_type
user {
id
uuid
username
email
first_name
last_name
full_name
}
}
}
Variables
{"input": LoginInput}
Response
{
"data": {
"login": {
"access_token": "abc123",
"refresh_token": "abc123",
"expires_in": 123,
"token_type": "abc123",
"user": User
}
}
}
logout
Response
Returns a
LogoutResponse!
Example
Query
mutation Logout {
logout {
status
message
}
}
Response
{
"data": {
"logout": {
"status": "xyz789",
"message": "abc123"
}
}
}
orderTransition
Response
Returns an
Order!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
geolocation -
GeolocationInput
|
|
input -
OrderTransitionInput!
|
Example
Query
mutation OrderTransition(
$id: ID!,
$geolocation: GeolocationInput,
$input: OrderTransitionInput!
) {
orderTransition(
id: $id,
geolocation: $geolocation,
input: $input
) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{
"id": "4",
"geolocation": GeolocationInput,
"input": OrderTransitionInput
}
Response
{
"data": {
"orderTransition": {
"id": 4,
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 987,
"complete": false,
"notes": "abc123",
"source": "abc123",
"price": 123.45,
"currency": "xyz789",
"cancel_reason": "xyz789",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "abc123",
"distance": 987.65,
"autoassign": false,
"scheduled": false
}
}
}
refreshClientToken
Response
Returns a
RefreshTokenPayload!
Arguments
| Name | Description |
|---|---|
input -
RefreshTokenInput
|
Example
Query
mutation RefreshClientToken($input: RefreshTokenInput) {
refreshClientToken(input: $input) {
access_token
refresh_token
expires_in
token_type
}
}
Variables
{"input": RefreshTokenInput}
Response
{
"data": {
"refreshClientToken": {
"access_token": "xyz789",
"refresh_token": "abc123",
"expires_in": 987,
"token_type": "abc123"
}
}
}
refreshToken
Response
Returns a
RefreshTokenPayload!
Arguments
| Name | Description |
|---|---|
input -
RefreshTokenInput
|
Example
Query
mutation RefreshToken($input: RefreshTokenInput) {
refreshToken(input: $input) {
access_token
refresh_token
expires_in
token_type
}
}
Variables
{"input": RefreshTokenInput}
Response
{
"data": {
"refreshToken": {
"access_token": "abc123",
"refresh_token": "abc123",
"expires_in": 987,
"token_type": "abc123"
}
}
}
register
Response
Returns a
RegisterResponse!
Arguments
| Name | Description |
|---|---|
input -
RegisterInput
|
Example
Query
mutation Register($input: RegisterInput) {
register(input: $input) {
tokens {
access_token
refresh_token
expires_in
token_type
user {
...UserFragment
}
}
status
}
}
Variables
{"input": RegisterInput}
Response
{
"data": {
"register": {
"tokens": AuthPayload,
"status": "MUST_VERIFY_EMAIL"
}
}
}
removeDocumentationFromVehicle
Response
Returns a
Vehicle!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
RemoveDocumentationFromVehicleInput!
|
Example
Query
mutation RemoveDocumentationFromVehicle(
$id: ID!,
$input: RemoveDocumentationFromVehicleInput!
) {
removeDocumentationFromVehicle(
id: $id,
input: $input
) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{"id": 4, "input": RemoveDocumentationFromVehicleInput}
Response
{
"data": {
"removeDocumentationFromVehicle": {
"id": 4,
"uuid": "xyz789",
"identification_number": "xyz789",
"license_plate_number": "abc123",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
unassignVehicle
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
AssignEmployeeVehicleInput!
|
Example
Query
mutation UnassignVehicle(
$id: ID!,
$input: AssignEmployeeVehicleInput!
) {
unassignVehicle(
id: $id,
input: $input
)
}
Variables
{
"id": "4",
"input": AssignEmployeeVehicleInput
}
Response
{"data": {"unassignVehicle": "abc123"}}
updateCustomer
Response
Returns a
Customer!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UpdateCustomerInput!
|
Example
Query
mutation UpdateCustomer(
$id: ID!,
$input: UpdateCustomerInput!
) {
updateCustomer(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
addresses {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
created_at
updated_at
}
}
Variables
{
"id": "4",
"input": UpdateCustomerInput
}
Response
{
"data": {
"updateCustomer": {
"id": 4,
"uuid": "abc123",
"account": Account,
"first_name": "abc123",
"last_name": "xyz789",
"document_type_country": "abc123",
"document_type": "abc123",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "xyz789",
"preferred_address": Address,
"addresses": [Address],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
updateDispatcher
Response
Returns a
Dispatcher!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UpdateDispatcherInput!
|
Example
Query
mutation UpdateDispatcher(
$id: ID!,
$input: UpdateDispatcherInput!
) {
updateDispatcher(
id: $id,
input: $input
) {
id
uuid
name
account {
id
uuid
name
}
dispatchersRules {
id
uuid
dispatcher {
...DispatcherFragment
}
trigger
rule
value
created_at
updated_at
}
created_at
updated_at
}
}
Variables
{"id": 4, "input": UpdateDispatcherInput}
Response
{
"data": {
"updateDispatcher": {
"id": 4,
"uuid": "abc123",
"name": "abc123",
"account": Account,
"dispatchersRules": [DispatcherRule],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
updateEstablishment
Response
Returns an
Establishment!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UpdateEstablishmentInput!
|
Example
Query
mutation UpdateEstablishment(
$id: ID!,
$input: UpdateEstablishmentInput!
) {
updateEstablishment(
id: $id,
input: $input
) {
id
uuid
name
company {
id
uuid
commercial_name
corporate_name
phone_number
}
dispatcher {
id
uuid
name
account {
...AccountFragment
}
dispatchersRules {
...DispatcherRuleFragment
}
created_at
updated_at
}
address {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
account {
id
uuid
name
}
created_at
updated_at
phone_number
email
enabled
orders {
id
uuid
account {
...AccountFragment
}
date
pickup_date
tracking_number
rider {
...EmployeeFragment
}
status
weight
establishment {
...EstablishmentFragment
}
customer {
...CustomerFragment
}
destinationAddress {
...AddressFragment
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
...OrderPackageFragment
}
orderIncidences {
...OrderIncidenceFragment
}
orderTrackings {
...OrderTrackingFragment
}
orderProofsOfDelivery {
...OrdersProofOfDeliveryFragment
}
files {
...FileFragment
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
establishmentWebhooks {
id
uuid
account {
...AccountFragment
}
establishment {
...EstablishmentFragment
}
event
url
created_at
updated_at
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
businessSchedule {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
... on Establishment {
...EstablishmentFragment
}
... on CustomerServicePhoneNumber {
...CustomerServicePhoneNumberFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
}
}
Variables
{"id": 4, "input": UpdateEstablishmentInput}
Response
{
"data": {
"updateEstablishment": {
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"company": Company,
"dispatcher": Dispatcher,
"address": Address,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"phone_number": "abc123",
"email": "xyz789",
"enabled": false,
"orders": [Order],
"establishmentWebhooks": [EstablishmentWebhook],
"user": User,
"businessSchedule": BusinessSchedule
}
}
}
updateEstablishmentWebhook
Response
Returns an
EstablishmentWebhook!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UpdateEstablishmentWebhookInput!
|
Example
Query
mutation UpdateEstablishmentWebhook(
$id: ID!,
$input: UpdateEstablishmentWebhookInput!
) {
updateEstablishmentWebhook(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
event
url
created_at
updated_at
}
}
Variables
{
"id": "4",
"input": UpdateEstablishmentWebhookInput
}
Response
{
"data": {
"updateEstablishmentWebhook": {
"id": "4",
"uuid": "abc123",
"account": Account,
"establishment": Establishment,
"event": "ORDERS_TRACKING",
"url": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
updateForgottenPassword
Response
Returns a
ForgotPasswordResponse!
Arguments
| Name | Description |
|---|---|
input -
NewPasswordWithCodeInput
|
Example
Query
mutation UpdateForgottenPassword($input: NewPasswordWithCodeInput) {
updateForgottenPassword(input: $input) {
status
message
}
}
Variables
{"input": NewPasswordWithCodeInput}
Response
{
"data": {
"updateForgottenPassword": {
"status": "abc123",
"message": "xyz789"
}
}
}
updateOrCreateBusinessSchedule
Response
Returns a
BusinessSchedule!
Arguments
| Name | Description |
|---|---|
input -
BusinessScheduleInput!
|
Example
Query
mutation UpdateOrCreateBusinessSchedule($input: BusinessScheduleInput!) {
updateOrCreateBusinessSchedule(input: $input) {
id
uuid
model_id
model_type
type
current
openingHours {
id
uuid
day
day_off
timePeriods {
...TimePeriodFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
}
model {
... on PickupStore {
...PickupStoreFragment
}
... on Establishment {
...EstablishmentFragment
}
... on CustomerServicePhoneNumber {
...CustomerServicePhoneNumberFragment
}
}
createdBy {
id
uuid
username
email
first_name
last_name
full_name
}
updatedBy {
id
uuid
username
email
first_name
last_name
full_name
}
created_at
updated_at
}
}
Variables
{"input": BusinessScheduleInput}
Response
{
"data": {
"updateOrCreateBusinessSchedule": {
"id": 4,
"uuid": "xyz789",
"model_id": "4",
"model_type": "abc123",
"type": "OPENING_SCHEDULE",
"current": true,
"openingHours": [OpeningHour],
"model": PickupStore,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
updateOrder
Response
Returns an
Order!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UpdateOrderInput!
|
Example
Query
mutation UpdateOrder(
$id: ID!,
$input: UpdateOrderInput!
) {
updateOrder(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
date
pickup_date
tracking_number
rider {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
status
weight
establishment {
id
uuid
name
company {
...CompanyFragment
}
dispatcher {
...DispatcherFragment
}
address {
...AddressFragment
}
account {
...AccountFragment
}
created_at
updated_at
phone_number
email
enabled
orders {
...OrderFragment
}
establishmentWebhooks {
...EstablishmentWebhookFragment
}
user {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
}
customer {
id
uuid
account {
...AccountFragment
}
first_name
last_name
document_type_country
document_type
document_number
email
phone_number
preferred_address {
...AddressFragment
}
addresses {
...AddressFragment
}
created_at
updated_at
}
destinationAddress {
id
uuid
name
street
formatted_address
email
phone_number
notes
city
postal_code
country
geolocation_latitude
geolocation_longitude
province {
...ProvinceFragment
}
created_at
updated_at
updated_token
modified_at
}
number_of_packages
complete
notes
source
price
currency
cancel_reason
orderPackages {
id
uuid
account {
...AccountFragment
}
order {
...OrderFragment
}
items {
...ItemFragment
}
tracking_number
alternate_tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
description
num_items
created_at
updated_at
}
orderIncidences {
id
uuid
account {
...AccountFragment
}
description
notes
orderIncidencesReason {
...OrderIncidencesReasonFragment
}
order {
...OrderFragment
}
status
informant {
...EmployeeFragment
}
files {
...FileFragment
}
responsible {
...EmployeeFragment
}
comments {
...CommentFragment
}
orderIncidencesTracking {
...OrderIncidencesTrackingFragment
}
resolved
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
orderTrackings {
id
uuid
status
order {
...OrderFragment
}
address {
...AddressFragment
}
tracked
created_at
updated_at
}
orderProofsOfDelivery {
id
uuid
name
document_number
comments
order {
...OrderFragment
}
created_at
updated_at
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
estimated_time_arrival
distance
autoassign
scheduled
}
}
Variables
{
"id": "4",
"input": UpdateOrderInput
}
Response
{
"data": {
"updateOrder": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "abc123",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 123,
"complete": false,
"notes": "abc123",
"source": "xyz789",
"price": 987.65,
"currency": "abc123",
"cancel_reason": "abc123",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "xyz789",
"distance": 987.65,
"autoassign": false,
"scheduled": true
}
}
}
updatePassword
Response
Returns an
UpdatePasswordResponse!
Arguments
| Name | Description |
|---|---|
input -
UpdatePassword!
|
Example
Query
mutation UpdatePassword($input: UpdatePassword!) {
updatePassword(input: $input) {
status
message
}
}
Variables
{"input": UpdatePassword}
Response
{
"data": {
"updatePassword": {
"status": "abc123",
"message": "xyz789"
}
}
}
updateVehicle
Response
Returns a
Vehicle!
Arguments
| Name | Description |
|---|---|
id -
ID!
|
|
input -
UpdateVehicleInput!
|
Example
Query
mutation UpdateVehicle(
$id: ID!,
$input: UpdateVehicleInput!
) {
updateVehicle(
id: $id,
input: $input
) {
id
uuid
identification_number
license_plate_number
status
created_at
updated_at
account {
id
uuid
name
}
distributionCenter {
id
uuid
name
account {
...AccountFragment
}
address {
...AddressFragment
}
created_at
updated_at
}
vehicleModel {
id
uuid
name
capacity
created_at
updated_at
account {
...AccountFragment
}
vehicleBrand {
...VehicleBrandFragment
}
vehicleCategory {
...VehicleCategoryFragment
}
}
employees {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
assigned {
id
from_date
to_date
}
current_driver {
id
uuid
account {
...AccountFragment
}
company {
...CompanyFragment
}
first_name
last_name
full_name
email
phone_number
enabled
available_for_order
vehicles {
...VehicleFragment
}
assigned {
...VehicleEmployeePivotFragment
}
current_vehicle {
...VehicleFragment
}
vehicle_type
}
files {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
}
}
Variables
{"id": 4, "input": UpdateVehicleInput}
Response
{
"data": {
"updateVehicle": {
"id": 4,
"uuid": "xyz789",
"identification_number": "abc123",
"license_plate_number": "abc123",
"status": "ACTIVE",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"distributionCenter": DistributionCenter,
"vehicleModel": VehicleModel,
"employees": [Employee],
"assigned": VehicleEmployeePivot,
"current_driver": Employee,
"files": [File]
}
}
}
verifyEmail
Response
Returns an
AuthPayload!
Arguments
| Name | Description |
|---|---|
input -
VerifyEmailInput!
|
Example
Query
mutation VerifyEmail($input: VerifyEmailInput!) {
verifyEmail(input: $input) {
access_token
refresh_token
expires_in
token_type
user {
id
uuid
username
email
first_name
last_name
full_name
}
}
}
Variables
{"input": VerifyEmailInput}
Response
{
"data": {
"verifyEmail": {
"access_token": "xyz789",
"refresh_token": "xyz789",
"expires_in": 987,
"token_type": "xyz789",
"user": User
}
}
}
Types
Account
AddDocumentationToVehicleInput
Fields
| Input Field | Description |
|---|---|
files -
AddFilesToVehicles
|
Example
{"files": AddFilesToVehicles}
AddFilesToVehicles
Fields
| Input Field | Description |
|---|---|
connect -
[ConnectVehicleFiles!]
|
Example
{"connect": [ConnectVehicleFiles]}
Address
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
name -
String
|
|
street -
String!
|
|
formatted_address -
String
|
|
email -
String
|
|
phone_number -
String
|
|
notes -
String
|
|
city -
String!
|
|
postal_code -
String!
|
|
country -
String
|
|
geolocation_latitude -
Float
|
|
geolocation_longitude -
Float
|
|
province -
Province
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
|
updated_token -
String
|
|
modified_at -
DateTime
|
Example
{
"id": 4,
"uuid": "xyz789",
"name": "xyz789",
"street": "xyz789",
"formatted_address": "xyz789",
"email": "xyz789",
"phone_number": "abc123",
"notes": "abc123",
"city": "abc123",
"postal_code": "xyz789",
"country": "xyz789",
"geolocation_latitude": 123.45,
"geolocation_longitude": 987.65,
"province": Province,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"updated_token": "abc123",
"modified_at": "2007-12-03T10:15:30Z"
}
AssignEmployeeInput
AssignEmployeeToVehicleInput
AssignEmployeeVehicleInput
AuthPayload
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BusinessSchedule
Example
{
"id": 4,
"uuid": "abc123",
"model_id": 4,
"model_type": "xyz789",
"type": "OPENING_SCHEDULE",
"current": false,
"openingHours": [OpeningHour],
"model": PickupStore,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
BusinessScheduleInput
Fields
| Input Field | Description |
|---|---|
id -
ID
|
|
current -
Boolean
|
|
model_id -
ID!
|
|
model_type -
BusinessScheduleModelType!
|
|
type -
BusinessScheduleType
|
|
openingHours -
[OpeningHourInput]
|
Example
{
"id": 4,
"current": true,
"model_id": 4,
"model_type": "PICKUP_STORE",
"type": "OPENING_SCHEDULE",
"openingHours": [OpeningHourInput]
}
BusinessScheduleModelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PICKUP_STORE"
BusinessScheduleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPENING_SCHEDULE"
Comment
Company
ConnectEmployeesToVehicleBelongsToMany
Fields
| Input Field | Description |
|---|---|
connect -
[AssignEmployeeToVehicleInput!]
|
Example
{"connect": [AssignEmployeeToVehicleInput]}
ConnectVehicleFiles
Fields
| Input Field | Description |
|---|---|
id -
ID
|
|
document_type -
VehicleDocumentType
|
|
expiration_date -
String
|
|
comments -
String
|
Example
{
"id": 4,
"document_type": "REGISTRATION_CERTIFICATE",
"expiration_date": "xyz789",
"comments": "abc123"
}
CreateAddressBelongsTo
Fields
| Input Field | Description |
|---|---|
create -
CreateAddressInput
|
Example
{"create": CreateAddressInput}
CreateAddressInput
Example
{
"name": "xyz789",
"street": "xyz789",
"formatted_address": "xyz789",
"email": "xyz789",
"phone_number": "abc123",
"notes": "xyz789",
"city": "abc123",
"postal_code": "xyz789",
"country": "xyz789",
"geolocation_latitude": 987.65,
"geolocation_longitude": 987.65,
"province_id": "4"
}
CreateBelongsTo
Fields
| Input Field | Description |
|---|---|
connect -
ID
|
Example
{"connect": "4"}
CreateCustomerInput
Fields
| Input Field | Description |
|---|---|
account_id -
ID
|
|
first_name -
String
|
|
last_name -
String
|
|
document_type_country -
String
|
|
document_type -
String
|
|
document_number -
String
|
|
email -
String
|
|
phone_number -
String
|
|
preferred_address -
UpsertAddressBelongsTo
|
|
addresses -
UpdateAddresses
|
Example
{
"account_id": 4,
"first_name": "xyz789",
"last_name": "abc123",
"document_type_country": "abc123",
"document_type": "xyz789",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "xyz789",
"preferred_address": UpsertAddressBelongsTo,
"addresses": UpdateAddresses
}
CreateDispatcherInput
Fields
| Input Field | Description |
|---|---|
name -
String!
|
|
account_id -
Int!
|
|
dispatchersRules -
CreateDispatcherRulesHasMany!
|
Example
{
"name": "abc123",
"account_id": 987,
"dispatchersRules": CreateDispatcherRulesHasMany
}
CreateDispatcherRuleInput
Fields
| Input Field | Description |
|---|---|
trigger -
DispatcherRuleTrigger!
|
|
value -
Int!
|
|
rule -
DispatcherRuleRule!
|
Example
{"trigger": "MAX_JOBS_DRIVER", "value": 123, "rule": "HAS_IS"}
CreateDispatcherRulesHasMany
Fields
| Input Field | Description |
|---|---|
create -
[CreateDispatcherRuleInput!]
|
Example
{"create": [CreateDispatcherRuleInput]}
CreateEstablishmentInput
Fields
| Input Field | Description |
|---|---|
account_id -
ID!
|
|
name -
String!
|
|
company -
CreateBelongsTo!
|
|
dispatcher -
CreateBelongsTo
|
|
address -
CreateAddressBelongsTo!
|
|
phone_number -
String
|
|
email -
String
|
|
enabled -
Boolean
|
|
orders -
CreateOrderHasMany
|
|
establishmentWebhooks -
CreateEstablishmentWebhookHasMany
|
Example
{
"account_id": "4",
"name": "abc123",
"company": CreateBelongsTo,
"dispatcher": CreateBelongsTo,
"address": CreateAddressBelongsTo,
"phone_number": "abc123",
"email": "xyz789",
"enabled": true,
"orders": CreateOrderHasMany,
"establishmentWebhooks": CreateEstablishmentWebhookHasMany
}
CreateEstablishmentWebhookHasMany
Fields
| Input Field | Description |
|---|---|
create -
[CreateEstablishmentWebhookInput!]
|
Example
{"create": [CreateEstablishmentWebhookInput]}
CreateEstablishmentWebhookInput
Fields
| Input Field | Description |
|---|---|
account_id -
ID!
|
|
establishment_id -
ID!
|
|
event -
WebhookEvent!
|
|
url -
String!
|
Example
{
"account_id": 4,
"establishment_id": "4",
"event": "ORDERS_TRACKING",
"url": "xyz789"
}
CreateOrderHasMany
Fields
| Input Field | Description |
|---|---|
create -
[CreateOrderInput!]
|
Example
{"create": [CreateOrderInput]}
CreateOrderInput
Fields
| Input Field | Description |
|---|---|
account_id -
ID!
|
|
establishment_id -
ID!
|
|
customer -
UpdateCustomer
|
|
orderPackages -
CreateOrderPackageHasMany!
|
|
destinationAddress -
CreateAddressBelongsTo!
|
|
date -
DateTime!
|
|
pickup_date -
DateTime!
|
|
status -
OrderStatus!
|
|
tracking_number -
String!
|
|
weight -
Float!
|
|
complete -
Boolean
|
|
notes -
String
|
|
price -
Int
|
|
currency -
String
|
|
rider_id -
ID
|
|
autoassign -
Boolean
|
|
scheduled -
Boolean
|
Example
{
"account_id": 4,
"establishment_id": "4",
"customer": UpdateCustomer,
"orderPackages": CreateOrderPackageHasMany,
"destinationAddress": CreateAddressBelongsTo,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"status": "REQUESTED",
"tracking_number": "xyz789",
"weight": 987.65,
"complete": true,
"notes": "abc123",
"price": 987,
"currency": "xyz789",
"rider_id": "4",
"autoassign": true,
"scheduled": true
}
CreateOrderPackageHasMany
Fields
| Input Field | Description |
|---|---|
create -
[CreateOrderPackageInput!]
|
Example
{"create": [CreateOrderPackageInput]}
CreateOrderPackageInput
Example
{
"account_id": 4,
"order_id": "4",
"tracking_number": "abc123",
"alternate_tracking_number": "abc123",
"status": "REQUESTED",
"dimensions_length": 123.45,
"dimensions_width": 987.65,
"dimensions_height": 123.45,
"volume_weight": 123.45,
"weight": 987.65,
"description": "xyz789",
"num_items": 123
}
CreateOrderRequestInput
Fields
| Input Field | Description |
|---|---|
account_id -
ID!
|
|
establishment_id -
ID!
|
|
customer -
UpdateCustomer
|
|
orderPackages -
CreateOrderPackageHasMany
|
|
destinationAddress -
CreateAddressBelongsTo!
|
|
date -
DateTime!
|
|
pickup_date -
DateTime!
|
|
tracking_number -
String
|
|
weight -
Float
|
|
complete -
Boolean
|
|
notes -
String
|
|
price -
Int
|
|
currency -
String
|
|
rider_id -
ID
|
|
autoassign -
Boolean
|
|
scheduled -
Boolean
|
Example
{
"account_id": 4,
"establishment_id": 4,
"customer": UpdateCustomer,
"orderPackages": CreateOrderPackageHasMany,
"destinationAddress": CreateAddressBelongsTo,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"weight": 123.45,
"complete": false,
"notes": "xyz789",
"price": 123,
"currency": "abc123",
"rider_id": "4",
"autoassign": true,
"scheduled": false
}
CreateVehicleInput
Fields
| Input Field | Description |
|---|---|
identification_number -
String
|
|
license_plate_number -
String!
|
|
status -
VehicleStatus!
|
|
account_id -
Int!
|
|
vehicle_model_id -
Int!
|
|
distribution_center_id -
Int!
|
|
employees -
ConnectEmployeesToVehicleBelongsToMany
|
Example
{
"identification_number": "abc123",
"license_plate_number": "abc123",
"status": "ACTIVE",
"account_id": 987,
"vehicle_model_id": 987,
"distribution_center_id": 987,
"employees": ConnectEmployeesToVehicleBelongsToMany
}
Customer
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
first_name -
String
|
|
last_name -
String
|
|
document_type_country -
String
|
|
document_type -
String
|
|
document_number -
String
|
|
email -
String
|
|
phone_number -
String
|
|
preferred_address -
Address
|
|
addresses -
[Address]
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": 4,
"uuid": "abc123",
"account": Account,
"first_name": "abc123",
"last_name": "xyz789",
"document_type_country": "xyz789",
"document_type": "abc123",
"document_number": "xyz789",
"email": "abc123",
"phone_number": "abc123",
"preferred_address": Address,
"addresses": [Address],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
CustomerServicePhoneNumber
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Example
{"id": 4}
Date
Example
"2007-12-03"
DateTime
Example
"2007-12-03T10:15:30Z"
DaysWeekType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MONDAY"
DeleteAssignEmployeeVehicleInput
DeleteCommentContractInput
Fields
| Input Field | Description |
|---|---|
contract_id -
ID!
|
Example
{"contract_id": "4"}
DisconnectVehicleFiles
Fields
| Input Field | Description |
|---|---|
id -
ID
|
Example
{"id": "4"}
Dispatcher
Example
{
"id": 4,
"uuid": "abc123",
"name": "abc123",
"account": Account,
"dispatchersRules": [DispatcherRule],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
DispatcherPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo -
PaginatorInfo!
|
|
data -
[Dispatcher!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Dispatcher]
}
DispatcherRule
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
dispatcher -
Dispatcher
|
|
trigger -
DispatcherRuleTrigger!
|
|
rule -
DispatcherRuleRule!
|
|
value -
Int!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": "4",
"uuid": "xyz789",
"dispatcher": Dispatcher,
"trigger": "MAX_JOBS_DRIVER",
"rule": "HAS_IS",
"value": 123,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
DispatcherRuleRule
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HAS_IS"
DispatcherRuleTrigger
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MAX_JOBS_DRIVER"
DistributionCenter
Example
{
"id": 4,
"uuid": "xyz789",
"name": "abc123",
"account": Account,
"address": Address,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
Employee
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
company -
Company
|
|
first_name -
String!
|
|
last_name -
String!
|
|
full_name -
String
|
|
email -
String
|
|
phone_number -
String
|
|
enabled -
Boolean!
|
|
available_for_order -
Boolean
|
|
vehicles -
[Vehicle!]
|
|
assigned -
VehicleEmployeePivot
|
|
current_vehicle -
Vehicle
|
|
vehicle_type -
VehicleType
|
Example
{
"id": "4",
"uuid": "abc123",
"account": Account,
"company": Company,
"first_name": "abc123",
"last_name": "xyz789",
"full_name": "xyz789",
"email": "xyz789",
"phone_number": "abc123",
"enabled": false,
"available_for_order": true,
"vehicles": [Vehicle],
"assigned": VehicleEmployeePivot,
"current_vehicle": Vehicle,
"vehicle_type": "CAR"
}
Establishment
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
name -
String!
|
|
company -
Company
|
|
dispatcher -
Dispatcher
|
|
address -
Address
|
|
account -
Account
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
|
phone_number -
String
|
|
email -
String
|
|
enabled -
Boolean!
|
|
orders -
[Order!]
|
|
establishmentWebhooks -
[EstablishmentWebhook!]
|
|
user -
User
|
|
businessSchedule -
BusinessSchedule
|
Example
{
"id": "4",
"uuid": "abc123",
"name": "abc123",
"company": Company,
"dispatcher": Dispatcher,
"address": Address,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"phone_number": "xyz789",
"email": "xyz789",
"enabled": false,
"orders": [Order],
"establishmentWebhooks": [EstablishmentWebhook],
"user": User,
"businessSchedule": BusinessSchedule
}
EstablishmentPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo -
PaginatorInfo!
|
|
data -
[Establishment!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Establishment]
}
EstablishmentWebhook
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
establishment -
Establishment
|
|
event -
WebhookEvent!
|
|
url -
String!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": "4",
"uuid": "xyz789",
"account": Account,
"establishment": Establishment,
"event": "ORDERS_TRACKING",
"url": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
EstablishmentWebhookPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo -
PaginatorInfo!
|
|
data -
[EstablishmentWebhook!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [EstablishmentWebhook]
}
File
Example
{
"id": 4,
"uuid": "abc123",
"path": "abc123",
"file_original_name": "xyz789",
"file_mime_type": "xyz789",
"file_size": 987,
"encode_file": "xyz789",
"pivot": FilePivot
}
FilePivot
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
987.65
ForgotPasswordInput
ForgotPasswordResponse
GeolocationInput
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
IncidencesStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Item
Example
{
"id": 4,
"uuid": "xyz789",
"name": "xyz789",
"reference": "xyz789",
"ean": "abc123",
"barcode": "xyz789",
"cost": 123,
"price": 987,
"weight": 987,
"volume": 123,
"active": true,
"image": File,
"account": Account,
"orderPackage": OrderPackage,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
LoginInput
LogoutResponse
Mixed
Example
Mixed
Model
Types
| Union Types |
|---|
Example
PickupStore
NewPasswordWithCodeInput
OpeningHour
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
day -
DaysWeekType!
|
|
day_off -
Boolean
|
|
timePeriods -
[TimePeriod!]!
|
|
businessSchedule -
BusinessSchedule!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": 4,
"uuid": "abc123",
"day": "MONDAY",
"day_off": false,
"timePeriods": [TimePeriod],
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
OpeningHourInput
Fields
| Input Field | Description |
|---|---|
day -
DaysWeekType
|
|
day_off -
Boolean
|
|
timePeriods -
[TimePeriodInput]
|
Example
{
"day": "MONDAY",
"day_off": false,
"timePeriods": [TimePeriodInput]
}
Order
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
date -
DateTime!
|
|
pickup_date -
DateTime!
|
|
tracking_number -
String!
|
|
rider -
Employee
|
|
status -
OrderStatus!
|
|
weight -
Float!
|
|
establishment -
Establishment
|
|
customer -
Customer
|
|
destinationAddress -
Address
|
|
number_of_packages -
Int!
|
|
complete -
Boolean!
|
|
notes -
String
|
|
source -
String
|
|
price -
Float
|
|
currency -
String
|
|
cancel_reason -
String
|
|
orderPackages -
[OrderPackage]
|
|
orderIncidences -
[OrderIncidence]
|
|
orderTrackings -
[OrderTracking]
|
|
orderProofsOfDelivery -
[OrdersProofOfDelivery!]
|
|
files -
[File!]
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
|
estimated_time_arrival -
String
|
|
distance -
Float
|
|
autoassign -
Boolean!
|
|
scheduled -
Boolean!
|
Example
{
"id": "4",
"uuid": "abc123",
"account": Account,
"date": "2007-12-03T10:15:30Z",
"pickup_date": "2007-12-03T10:15:30Z",
"tracking_number": "xyz789",
"rider": Employee,
"status": "REQUESTED",
"weight": 123.45,
"establishment": Establishment,
"customer": Customer,
"destinationAddress": Address,
"number_of_packages": 123,
"complete": false,
"notes": "abc123",
"source": "abc123",
"price": 123.45,
"currency": "xyz789",
"cancel_reason": "abc123",
"orderPackages": [OrderPackage],
"orderIncidences": [OrderIncidence],
"orderTrackings": [OrderTracking],
"orderProofsOfDelivery": [OrdersProofOfDelivery],
"files": [File],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"estimated_time_arrival": "abc123",
"distance": 987.65,
"autoassign": false,
"scheduled": false
}
OrderIncidence
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
description -
String
|
|
notes -
String
|
|
orderIncidencesReason -
OrderIncidencesReason!
|
|
order -
Order!
|
|
status -
IncidencesStatus!
|
|
informant -
Employee
|
|
files -
[File!]
|
|
responsible -
Employee
|
|
comments -
[Comment]
|
|
orderIncidencesTracking -
[OrderIncidencesTracking]
|
|
resolved -
Boolean!
|
|
createdBy -
User
|
|
updatedBy -
User
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": 4,
"uuid": "abc123",
"account": Account,
"description": "abc123",
"notes": "xyz789",
"orderIncidencesReason": OrderIncidencesReason,
"order": Order,
"status": "OPEN",
"informant": Employee,
"files": [File],
"responsible": Employee,
"comments": [Comment],
"orderIncidencesTracking": [OrderIncidencesTracking],
"resolved": true,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
OrderIncidencesReason
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
name -
String
|
|
category -
OrderIncidencesReasonCategory!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
|
closed -
Boolean
|
|
priority -
OrderIncidencesReasonPriority!
|
|
is_before_pickup -
Boolean
|
|
description_required -
Boolean
|
|
files_required -
Boolean
|
Example
{
"id": 4,
"uuid": "xyz789",
"account": Account,
"name": "xyz789",
"category": "CUSTOMER",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"closed": true,
"priority": "LOW",
"is_before_pickup": true,
"description_required": false,
"files_required": false
}
OrderIncidencesReasonCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER"
OrderIncidencesReasonPriority
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LOW"
OrderIncidencesTracking
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
orderIncidence -
OrderIncidence!
|
|
responsible -
Employee
|
|
status -
IncidencesStatus!
|
|
createdBy -
User
|
|
updatedBy -
User
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": 4,
"uuid": "xyz789",
"orderIncidence": OrderIncidence,
"responsible": Employee,
"status": "OPEN",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
OrderPackage
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
uuid -
String!
|
|
account -
Account
|
|
order -
Order
|
|
items -
[Item]
|
|
tracking_number -
String!
|
|
alternate_tracking_number -
String
|
|
status -
OrderStatus!
|
|
dimensions_length -
Float
|
|
dimensions_width -
Float
|
|
dimensions_height -
Float
|
|
volume_weight -
Float
|
|
weight -
Float
|
|
description -
String
|
|
num_items -
Int!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
Example
{
"id": "4",
"uuid": "xyz789",
"account": Account,
"order": Order,
"items": [Item],
"tracking_number": "abc123",
"alternate_tracking_number": "abc123",
"status": "REQUESTED",
"dimensions_length": 987.65,
"dimensions_width": 123.45,
"dimensions_height": 123.45,
"volume_weight": 987.65,
"weight": 987.65,
"description": "xyz789",
"num_items": 123,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
OrderPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo -
PaginatorInfo!
|
|
data -
[Order!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Order]
}
OrderPerDay
OrderPerDayPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo -
PaginatorInfo!
|
|
data -
[OrderPerDay!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [OrderPerDay]
}
OrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
OrderTracking
Example
{
"id": "4",
"uuid": "abc123",
"status": "REQUESTED",
"order": Order,
"address": Address,
"tracked": false,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
OrderTransitionInput
Fields
| Input Field | Description |
|---|---|
transition -
String!
|
Example
{"transition": "xyz789"}