Tuklo Delivery GraphQL API
Welcome to the party!
Terms of Service
API Endpoints
# Production:
http://localhost:8000/graphql
Headers
# Your foo from bar
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMyIsImp0aSI6ImM5NGUyMzk2NWExZmZiNzBhMGYwMTY4M2U3MTgyOWQzNmVhZWZkYmExMjc5YjlkNTRmYWQ4Njg1NWRlNDEzNGRhMDU2NjczZGI3NDIyZDVmIiwiaWF0IjoxNjY2MjYzNTE2LjQzNTY2NywibmJmIjoxNjY2MjYzNTE2LjQzNTY3MywiZXhwIjoxNjY2MzQ5OTE2LjQyNzM4NCwic3ViIjoiIiwic2NvcGVzIjpbIioiXX0.bROnihG37iKp4PkzUfKy4LkqptPhgYdd-4b_eozumpV81Ltqsd37AISJxa9WAWY4BDb6-2HyC8ix22Njt_jdSS4qhQfjJhfzERYx0WRwGCRKGQhOjnbnz52bm-Ijz_ye78lNc8BMDoXlmMbNTEeZ2c_jDqz2fPrNCouVlKUSuKpoMkmzX7OFmH9C0rq7Q2Gtkezh1KKtYi0K-bE9-t4vqpgYwnm19kyWnqG6vXeWx7CtLgxy4_u54GJECYjnoiI_nrdZ1aSPtVxKygZsxC1XbJFpFu6HGqn_htJt8MlkxKuvGa2clFew4lRTSWLiRIwOnTghSrZ9RqVOZLRP4DnY5hAfC3KgB5jjn2WxSgJeMCdkQpf_UamBXrNEadR-vunl6ziTOQr_L4iBkSaQgaVuJiDz_wKj0vuqBuK4d_TTEVOsmU7vOLIvA3d0eNvwNlG2QNs5LEjUWE2OF_KDgteaW4d_5Z0N1gofvIqubxXCzz-6f4LRE3VEwwNVpu8tfP-TvXY3OZ_6El9gAXT5NQsPW2-8JGEr7sX4exyQLKNR9fGDN-VPPHOJ6xInwR3R6mGmon2Ewn5nZFSXNG7CaHXRsIgpC442MtV_xaP6UUoE03vKljPXypH10W1PpslOoZf66YwtJ4JoBA2MsJIODA66hLdGpQhm38aWVdLjmzUFTp8Queries
allDistributorParents
Response
Returns a DistributorParentPaginator
Arguments
| Name | Description |
|---|---|
name - String
|
|
orderBy - [QueryAllDistributorParentsOrderByOrderByClause!]
|
|
first - Int
|
Default = 10 |
page - Int
|
Example
Query
query AllDistributorParents(
$name: String,
$orderBy: [QueryAllDistributorParentsOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allDistributorParents(
name: $name,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
name
key
pickup_store_enabled
account {
...AccountFragment
}
created_at
updated_at
days_to_order_failed
file {
...FileFragment
}
file_id
company {
...CompanyFragment
}
number_of_attempts
}
}
}
Variables
{
"name": "abc123",
"orderBy": [
QueryAllDistributorParentsOrderByOrderByClause
],
"first": 10,
"page": 123
}
Response
{
"data": {
"allDistributorParents": {
"paginatorInfo": PaginatorInfo,
"data": [DistributorParent]
}
}
}
allLockers
Response
Returns a LockerPaginator
Arguments
| Name | Description |
|---|---|
where - QueryAllLockersWhereWhereConditions
|
|
orderBy - [QueryAllLockersOrderByOrderByClause!]
|
|
first - Int
|
Default = 10 |
page - Int
|
Example
Query
query AllLockers(
$where: QueryAllLockersWhereWhereConditions,
$orderBy: [QueryAllLockersOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allLockers(
where: $where,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
}
}
Variables
{
"where": QueryAllLockersWhereWhereConditions,
"orderBy": [QueryAllLockersOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"allLockers": {
"paginatorInfo": PaginatorInfo,
"data": [Locker]
}
}
}
allPermitsByPickupStore
Response
Returns a PickupStorePermitPaginator
Arguments
| Name | Description |
|---|---|
pickup_store_id - Int
|
|
orderBy - [QueryAllPermitsByPickupStoreOrderByOrderByClause!]
|
|
where - QueryAllPermitsByPickupStoreWhereWhereConditions
|
|
first - Int
|
Default = 10 |
page - Int
|
Example
Query
query AllPermitsByPickupStore(
$pickup_store_id: Int,
$orderBy: [QueryAllPermitsByPickupStoreOrderByOrderByClause!],
$where: QueryAllPermitsByPickupStoreWhereWhereConditions,
$first: Int,
$page: Int
) {
allPermitsByPickupStore(
pickup_store_id: $pickup_store_id,
orderBy: $orderBy,
where: $where,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
}
}
Variables
{
"pickup_store_id": 987,
"orderBy": [
QueryAllPermitsByPickupStoreOrderByOrderByClause
],
"where": QueryAllPermitsByPickupStoreWhereWhereConditions,
"first": 10,
"page": 987
}
Response
{
"data": {
"allPermitsByPickupStore": {
"paginatorInfo": PaginatorInfo,
"data": [PickupStorePermit]
}
}
}
allPickupStorePermits
Response
Returns a PickupStorePermitPaginator
Arguments
| Name | Description |
|---|---|
uuid - String
|
|
orderBy - [QueryAllPickupStorePermitsOrderByOrderByClause!]
|
|
where - QueryAllPickupStorePermitsWhereWhereConditions
|
|
permit - QueryAllPickupStorePermitsPermitWhereHasConditions
|
|
pickupStore - QueryAllPickupStorePermitsPickupStoreWhereHasConditions
|
|
first - Int
|
Default = 10 |
page - Int
|
Example
Query
query AllPickupStorePermits(
$uuid: String,
$orderBy: [QueryAllPickupStorePermitsOrderByOrderByClause!],
$where: QueryAllPickupStorePermitsWhereWhereConditions,
$permit: QueryAllPickupStorePermitsPermitWhereHasConditions,
$pickupStore: QueryAllPickupStorePermitsPickupStoreWhereHasConditions,
$first: Int,
$page: Int
) {
allPickupStorePermits(
uuid: $uuid,
orderBy: $orderBy,
where: $where,
permit: $permit,
pickupStore: $pickupStore,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
}
}
Variables
{
"uuid": "xyz789",
"orderBy": [
QueryAllPickupStorePermitsOrderByOrderByClause
],
"where": QueryAllPickupStorePermitsWhereWhereConditions,
"permit": QueryAllPickupStorePermitsPermitWhereHasConditions,
"pickupStore": QueryAllPickupStorePermitsPickupStoreWhereHasConditions,
"first": 10,
"page": 987
}
Response
{
"data": {
"allPickupStorePermits": {
"paginatorInfo": PaginatorInfo,
"data": [PickupStorePermit]
}
}
}
allPickupStores
Response
Returns a PickupStorePaginator
Arguments
| Name | Description |
|---|---|
name - String
|
|
alias - String
|
|
complexSearch - String
|
|
where - QueryAllPickupStoresWhereWhereConditions
|
|
address - QueryAllPickupStoresAddressWhereHasConditions
|
|
account - QueryAllPickupStoresAccountWhereHasConditions
|
|
user - QueryAllPickupStoresUserWhereHasConditions
|
|
orderBy - [QueryAllPickupStoresOrderByOrderByClause!]
|
|
first - Int
|
Default = 10 |
page - Int
|
Example
Query
query AllPickupStores(
$name: String,
$alias: String,
$complexSearch: String,
$where: QueryAllPickupStoresWhereWhereConditions,
$address: QueryAllPickupStoresAddressWhereHasConditions,
$account: QueryAllPickupStoresAccountWhereHasConditions,
$user: QueryAllPickupStoresUserWhereHasConditions,
$orderBy: [QueryAllPickupStoresOrderByOrderByClause!],
$first: Int,
$page: Int
) {
allPickupStores(
name: $name,
alias: $alias,
complexSearch: $complexSearch,
where: $where,
address: $address,
account: $account,
user: $user,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
}
}
Variables
{
"name": "abc123",
"alias": "xyz789",
"complexSearch": "xyz789",
"where": QueryAllPickupStoresWhereWhereConditions,
"address": QueryAllPickupStoresAddressWhereHasConditions,
"account": QueryAllPickupStoresAccountWhereHasConditions,
"user": QueryAllPickupStoresUserWhereHasConditions,
"orderBy": [QueryAllPickupStoresOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"allPickupStores": {
"paginatorInfo": PaginatorInfo,
"data": [PickupStore]
}
}
}
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]
}
}
}
findAllShipmentsByTrackingNumbers
Response
Returns [Shipment]
Arguments
| Name | Description |
|---|---|
tracking_number - [String]!
|
Example
Query
query FindAllShipmentsByTrackingNumbers($tracking_number: [String]!) {
findAllShipmentsByTrackingNumbers(tracking_number: $tracking_number) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"tracking_number": ["abc123"]}
Response
{
"data": {
"findAllShipmentsByTrackingNumbers": [
{
"id": 4,
"uuid": "abc123",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "abc123",
"type": "DELIVERY",
"weight": 987,
"complete": true,
"cancellable": false,
"cancel_reason": "xyz789",
"notes": "xyz789",
"number_of_delivery_attempts": 123,
"max_attempts_exceeded": true,
"reference_number": "abc123",
"price": 987.65,
"currency": "xyz789",
"product_category": "abc123",
"product_name": "abc123",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "abc123",
"simple_label": "xyz789",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
]
}
}
findBatch
Example
Query
query FindBatch($tracking_number: String) {
findBatch(tracking_number: $tracking_number) {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
created_at
updated_at
}
}
Variables
{"tracking_number": "xyz789"}
Response
{
"data": {
"findBatch": [
{
"id": 4,
"uuid": "abc123",
"dimensions_length": 987,
"dimensions_width": 123,
"dimensions_height": 123,
"tracking_number": "xyz789",
"weight": 123,
"date": "2007-12-03T10:15:30Z",
"status": "DOCUMENTED",
"shipments": [Shipment],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
]
}
}
findPackageByTrackingNumber
Example
Query
query FindPackageByTrackingNumber($tracking_number: String!) {
findPackageByTrackingNumber(tracking_number: $tracking_number) {
id
uuid
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
id
uuid
status
type
address {
...AddressFragment
}
created_at
updated_at
}
}
}
Variables
{"tracking_number": "xyz789"}
Response
{
"data": {
"findPackageByTrackingNumber": {
"id": 4,
"uuid": "abc123",
"shipment": Shipment,
"tracking_number": "abc123",
"status": "DOCUMENTED",
"dimensions_length": 987,
"dimensions_width": 123,
"dimensions_height": 123,
"volume_weight": 987,
"weight": 987,
"expired": true,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"packagesTracking": [PackagesTracking]
}
}
}
findPickupStore
Response
Returns a PickupStore
Arguments
| Name | Description |
|---|---|
uuid - String
|
Example
Query
query FindPickupStore($uuid: String) {
findPickupStore(uuid: $uuid) {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
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
}
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
createdBy {
id
uuid
username
email
first_name
last_name
full_name
}
updatedBy {
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
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
created_at
updated_at
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
accountManager {
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
emailsSent {
...SentEmailTemplateFragment
}
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
id
uuid
commercial_name
corporate_name
phone_number
}
contact_name
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pickupStorePermits {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
pickup_store_has_current_permit
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"findPickupStore": {
"id": "4",
"uuid": "xyz789",
"name": "xyz789",
"alias": "abc123",
"fiscal_name": "abc123",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "xyz789",
"max_package_capacity": 987,
"current_package_capacity": 123,
"address": Address,
"account": Account,
"shipments": [Shipment],
"user": User,
"createdBy": User,
"updatedBy": User,
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"pickupStoreShipments": PickupStoreShipmentPivot,
"accountManager": Employee,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": 4,
"company_id": "4",
"enabled": false,
"company": Company,
"contact_name": "abc123",
"file": File,
"pickupStorePermits": [PickupStorePermit],
"pickup_store_has_current_permit": false
}
}
}
findPickupStorePermit
Response
Returns a PickupStorePermit
Arguments
| Name | Description |
|---|---|
uuid - String!
|
Example
Query
query FindPickupStorePermit($uuid: String!) {
findPickupStorePermit(uuid: $uuid) {
id
uuid
account {
id
uuid
name
}
pickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
code
start_date
end_date
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
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"findPickupStorePermit": {
"id": 4,
"uuid": "abc123",
"account": Account,
"pickupStore": PickupStore,
"file": File,
"code": "abc123",
"start_date": "2007-12-03",
"end_date": "2007-12-03",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"emailsSent": [SentEmailTemplate]
}
}
}
findShipment
Response
Returns [Shipment]
Arguments
| Name | Description |
|---|---|
tracking_number - String
|
Example
Query
query FindShipment($tracking_number: String) {
findShipment(tracking_number: $tracking_number) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"tracking_number": "abc123"}
Response
{
"data": {
"findShipment": [
{
"id": 4,
"uuid": "xyz789",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "xyz789",
"type": "DELIVERY",
"weight": 123,
"complete": true,
"cancellable": true,
"cancel_reason": "abc123",
"notes": "xyz789",
"number_of_delivery_attempts": 123,
"max_attempts_exceeded": false,
"reference_number": "abc123",
"price": 987.65,
"currency": "abc123",
"product_category": "xyz789",
"product_name": "xyz789",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "xyz789",
"simple_label": "xyz789",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
]
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "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]
}
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "abc123",
"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]
}
}
}
getAirWaybill
Response
Returns an AirWaybill
Arguments
| Name | Description |
|---|---|
master - String!
|
Example
Query
query GetAirWaybill($master: String!) {
getAirWaybill(master: $master) {
id
uuid
account {
id
uuid
name
}
distributorParent {
id
uuid
name
key
pickup_store_enabled
account {
...AccountFragment
}
created_at
updated_at
days_to_order_failed
file {
...FileFragment
}
file_id
company {
...CompanyFragment
}
number_of_attempts
}
batches {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
master
status
airport_code
excel_file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pdf_file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
}
}
Variables
{"master": "abc123"}
Response
{
"data": {
"getAirWaybill": {
"id": 4,
"uuid": "abc123",
"account": Account,
"distributorParent": DistributorParent,
"batches": [Batch],
"master": "xyz789",
"status": "PROCESSING_IMPORT",
"airport_code": "xyz789",
"excel_file": File,
"pdf_file": File,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
getDistributorParent
Response
Returns a DistributorParent
Arguments
| Name | Description |
|---|---|
uuid - String
|
Example
Query
query GetDistributorParent($uuid: String) {
getDistributorParent(uuid: $uuid) {
id
uuid
name
key
pickup_store_enabled
account {
id
uuid
name
}
created_at
updated_at
days_to_order_failed
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
file_id
company {
id
uuid
commercial_name
corporate_name
phone_number
}
number_of_attempts
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"getDistributorParent": {
"id": "4",
"uuid": "abc123",
"name": "abc123",
"key": "xyz789",
"pickup_store_enabled": false,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"days_to_order_failed": "xyz789",
"file": File,
"file_id": 4,
"company": Company,
"number_of_attempts": 123
}
}
}
getDistributorParentsByName
Response
Returns [DistributorParent!]!
Arguments
| Name | Description |
|---|---|
name - String!
|
|
orderBy - [QueryGetDistributorParentsByNameOrderByOrderByClause!]
|
Example
Query
query GetDistributorParentsByName(
$name: String!,
$orderBy: [QueryGetDistributorParentsByNameOrderByOrderByClause!]
) {
getDistributorParentsByName(
name: $name,
orderBy: $orderBy
) {
id
uuid
name
key
pickup_store_enabled
account {
id
uuid
name
}
created_at
updated_at
days_to_order_failed
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
file_id
company {
id
uuid
commercial_name
corporate_name
phone_number
}
number_of_attempts
}
}
Variables
{
"name": "xyz789",
"orderBy": [
QueryGetDistributorParentsByNameOrderByOrderByClause
]
}
Response
{
"data": {
"getDistributorParentsByName": [
{
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"key": "abc123",
"pickup_store_enabled": false,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"days_to_order_failed": "xyz789",
"file": File,
"file_id": 4,
"company": Company,
"number_of_attempts": 987
}
]
}
}
getShipments
Response
Returns [Shipment!]!
Arguments
| Name | Description |
|---|---|
where - QueryGetShipmentsWhereWhereConditions
|
|
orderBy - [QueryGetShipmentsOrderByOrderByClause!]
|
Example
Query
query GetShipments(
$where: QueryGetShipmentsWhereWhereConditions,
$orderBy: [QueryGetShipmentsOrderByOrderByClause!]
) {
getShipments(
where: $where,
orderBy: $orderBy
) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{
"where": QueryGetShipmentsWhereWhereConditions,
"orderBy": [QueryGetShipmentsOrderByOrderByClause]
}
Response
{
"data": {
"getShipments": [
{
"id": 4,
"uuid": "xyz789",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "xyz789",
"type": "DELIVERY",
"weight": 987,
"complete": true,
"cancellable": false,
"cancel_reason": "xyz789",
"notes": "xyz789",
"number_of_delivery_attempts": 987,
"max_attempts_exceeded": true,
"reference_number": "abc123",
"price": 123.45,
"currency": "abc123",
"product_category": "abc123",
"product_name": "abc123",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "abc123",
"simple_label": "xyz789",
"digital_label": "abc123",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
]
}
}
incidencesReason
Response
Returns an IncidencesReason
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query IncidencesReason($id: ID!) {
incidencesReason(id: $id) {
id
uuid
account {
id
uuid
name
}
name
category
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
closed
}
}
Variables
{"id": "4"}
Response
{
"data": {
"incidencesReason": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"name": "abc123",
"category": "ATTEMPT",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"closed": true
}
}
}
incidencesReasons
Response
Returns an IncidencesReasonPaginator
Arguments
| Name | Description |
|---|---|
name - String
|
|
where - QueryIncidencesReasonsWhereWhereConditions
|
|
orderBy - [QueryIncidencesReasonsOrderByOrderByClause!]
|
|
first - Int
|
Default = 10 |
page - Int
|
Example
Query
query IncidencesReasons(
$name: String,
$where: QueryIncidencesReasonsWhereWhereConditions,
$orderBy: [QueryIncidencesReasonsOrderByOrderByClause!],
$first: Int,
$page: Int
) {
incidencesReasons(
name: $name,
where: $where,
orderBy: $orderBy,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
account {
...AccountFragment
}
name
category
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
closed
}
}
}
Variables
{
"name": "xyz789",
"where": QueryIncidencesReasonsWhereWhereConditions,
"orderBy": [QueryIncidencesReasonsOrderByOrderByClause],
"first": 10,
"page": 123
}
Response
{
"data": {
"incidencesReasons": {
"paginatorInfo": PaginatorInfo,
"data": [IncidencesReason]
}
}
}
packageScanning
Response
Returns a Package
Arguments
| Name | Description |
|---|---|
tracking_number - String!
|
|
geolocation - GeolocationInput
|
Example
Query
query PackageScanning(
$tracking_number: String!,
$geolocation: GeolocationInput
) {
packageScanning(
tracking_number: $tracking_number,
geolocation: $geolocation
) {
id
uuid
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
id
uuid
status
type
address {
...AddressFragment
}
created_at
updated_at
}
}
}
Variables
{
"tracking_number": "xyz789",
"geolocation": GeolocationInput
}
Response
{
"data": {
"packageScanning": {
"id": "4",
"uuid": "xyz789",
"shipment": Shipment,
"tracking_number": "xyz789",
"status": "DOCUMENTED",
"dimensions_length": 123,
"dimensions_width": 123,
"dimensions_height": 987,
"volume_weight": 123,
"weight": 987,
"expired": false,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"packagesTracking": [PackagesTracking]
}
}
}
packagesTrackingByTrackingNumber
Response
Returns [PackagesTracking!]
Arguments
| Name | Description |
|---|---|
tracking_number - String!
|
Example
Query
query PackagesTrackingByTrackingNumber($tracking_number: String!) {
packagesTrackingByTrackingNumber(tracking_number: $tracking_number) {
id
uuid
status
type
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
}
created_at
updated_at
}
}
Variables
{"tracking_number": "abc123"}
Response
{
"data": {
"packagesTrackingByTrackingNumber": [
{
"id": "4",
"uuid": "abc123",
"status": "DOCUMENTED",
"type": "DELIVERY",
"address": Address,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
]
}
}
searchPickupStores
Response
Returns a PickupStorePaginator
Example
Query
query SearchPickupStores(
$geolocationLongitude: Float!,
$geolocationLatitude: Float!,
$account_id: ID!,
$first: Int,
$page: Int
) {
searchPickupStores(
geolocationLongitude: $geolocationLongitude,
geolocationLatitude: $geolocationLatitude,
account_id: $account_id,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
}
}
Variables
{
"geolocationLongitude": 123.45,
"geolocationLatitude": 123.45,
"account_id": "4",
"first": 10,
"page": 987
}
Response
{
"data": {
"searchPickupStores": {
"paginatorInfo": PaginatorInfo,
"data": [PickupStore]
}
}
}
shipmentsPickupStore
Response
Returns a ShipmentPaginator
Example
Query
query ShipmentsPickupStore(
$pickup_store_id: ID!,
$status: [String],
$final_status: FinalStatusTypes,
$in_store: Boolean,
$status_type: [String],
$created_at: [String],
$search: String,
$first: Int,
$page: Int
) {
shipmentsPickupStore(
pickup_store_id: $pickup_store_id,
status: $status,
final_status: $final_status,
in_store: $in_store,
status_type: $status_type,
created_at: $created_at,
search: $search,
first: $first,
page: $page
) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
}
}
Variables
{
"pickup_store_id": 4,
"status": ["abc123"],
"final_status": "PENDING",
"in_store": false,
"status_type": ["abc123"],
"created_at": ["abc123"],
"search": "xyz789",
"first": 10,
"page": 123
}
Response
{
"data": {
"shipmentsPickupStore": {
"paginatorInfo": PaginatorInfo,
"data": [Shipment]
}
}
}
Mutations
addComment
Response
Returns an Incidence!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - AddCommentInput!
|
Example
Query
mutation AddComment(
$id: ID!,
$input: AddCommentInput!
) {
addComment(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
description
level
notes
incidencesReason {
id
uuid
account {
...AccountFragment
}
name
category
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
closed
}
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
status
delivery_type
informant {
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
emailsSent {
...SentEmailTemplateFragment
}
}
responsible {
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
emailsSent {
...SentEmailTemplateFragment
}
}
comments {
id
uuid
body
created_at
updated_at
}
incidencesTracking {
id
uuid
incidence {
...IncidenceFragment
}
responsible {
...EmployeeFragment
}
status
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
resolved
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
{
"id": "4",
"input": AddCommentInput
}
Response
{
"data": {
"addComment": {
"id": "4",
"uuid": "xyz789",
"account": Account,
"description": "abc123",
"level": "LOW",
"notes": "abc123",
"incidencesReason": IncidencesReason,
"shipment": Shipment,
"status": "OPEN",
"delivery_type": "DOOR",
"informant": Employee,
"responsible": Employee,
"comments": [Comment],
"incidencesTracking": [IncidencesTracking],
"resolved": false,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
addDeliverySlotToShipment
Response
Returns a Shipment
Arguments
| Name | Description |
|---|---|
shipment_id - ID!
|
|
deliverySlot - [DeliverySlotInput!]
|
Example
Query
mutation AddDeliverySlotToShipment(
$shipment_id: ID!,
$deliverySlot: [DeliverySlotInput!]
) {
addDeliverySlotToShipment(
shipment_id: $shipment_id,
deliverySlot: $deliverySlot
) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"shipment_id": 4, "deliverySlot": [DeliverySlotInput]}
Response
{
"data": {
"addDeliverySlotToShipment": {
"id": 4,
"uuid": "abc123",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "abc123",
"type": "DELIVERY",
"weight": 123,
"complete": false,
"cancellable": false,
"cancel_reason": "abc123",
"notes": "abc123",
"number_of_delivery_attempts": 987,
"max_attempts_exceeded": true,
"reference_number": "xyz789",
"price": 123.45,
"currency": "abc123",
"product_category": "xyz789",
"product_name": "abc123",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "xyz789",
"simple_label": "xyz789",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "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]
}
}
}
addProofOfDelivery
Response
Returns a ProofsOfDelivery!
Arguments
| Name | Description |
|---|---|
input - CreateProofOfDeliveryInput!
|
Example
Query
mutation AddProofOfDelivery($input: CreateProofOfDeliveryInput!) {
addProofOfDelivery(input: $input) {
id
uuid
name
document_number
comments
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
delivery_type
created_at
updated_at
}
}
Variables
{"input": CreateProofOfDeliveryInput}
Response
{
"data": {
"addProofOfDelivery": {
"id": "4",
"uuid": "abc123",
"name": "abc123",
"document_number": "abc123",
"comments": "abc123",
"shipment": Shipment,
"delivery_type": "DOOR",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
addProofOfDeliveryByTrackingNumber
Response
Returns a ProofsOfDelivery!
Arguments
| Name | Description |
|---|---|
input - CreateProofOfDeliveryByTrackingNumberInput!
|
Example
Query
mutation AddProofOfDeliveryByTrackingNumber($input: CreateProofOfDeliveryByTrackingNumberInput!) {
addProofOfDeliveryByTrackingNumber(input: $input) {
id
uuid
name
document_number
comments
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
delivery_type
created_at
updated_at
}
}
Variables
{"input": CreateProofOfDeliveryByTrackingNumberInput}
Response
{
"data": {
"addProofOfDeliveryByTrackingNumber": {
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"document_number": "xyz789",
"comments": "abc123",
"shipment": Shipment,
"delivery_type": "DOOR",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
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": "abc123"}}
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
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{
"id": "4",
"input": AssignEmployeeVehicleInput
}
Response
{
"data": {
"assignVehicle": {
"id": "4",
"uuid": "xyz789",
"account": Account,
"company": Company,
"first_name": "xyz789",
"last_name": "xyz789",
"full_name": "abc123",
"email": "xyz789",
"phone_number": "abc123",
"enabled": false,
"available_for_order": false,
"vehicles": [Vehicle],
"assigned": VehicleEmployeePivot,
"current_vehicle": Vehicle,
"vehicle_type": "CAR",
"emailsSent": [SentEmailTemplate]
}
}
}
cancelShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
reason - CancelReasons!
|
Example
Query
mutation CancelShipment(
$id: ID!,
$reason: CancelReasons!
) {
cancelShipment(
id: $id,
reason: $reason
) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"id": 4, "reason": "SELLER_CANCEL"}
Response
{
"data": {
"cancelShipment": {
"id": "4",
"uuid": "abc123",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "abc123",
"type": "DELIVERY",
"weight": 987,
"complete": false,
"cancellable": false,
"cancel_reason": "abc123",
"notes": "xyz789",
"number_of_delivery_attempts": 987,
"max_attempts_exceeded": false,
"reference_number": "xyz789",
"price": 987.65,
"currency": "xyz789",
"product_category": "xyz789",
"product_name": "xyz789",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "xyz789",
"simple_label": "abc123",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
}
}
changeAirWayBillStatus
Response
Returns an AirWaybill!
Arguments
| Name | Description |
|---|---|
input - ChangeAirWayBillStatus!
|
Example
Query
mutation ChangeAirWayBillStatus($input: ChangeAirWayBillStatus!) {
changeAirWayBillStatus(input: $input) {
id
uuid
account {
id
uuid
name
}
distributorParent {
id
uuid
name
key
pickup_store_enabled
account {
...AccountFragment
}
created_at
updated_at
days_to_order_failed
file {
...FileFragment
}
file_id
company {
...CompanyFragment
}
number_of_attempts
}
batches {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
master
status
airport_code
excel_file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pdf_file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
created_at
updated_at
}
}
Variables
{"input": ChangeAirWayBillStatus}
Response
{
"data": {
"changeAirWayBillStatus": {
"id": "4",
"uuid": "abc123",
"account": Account,
"distributorParent": DistributorParent,
"batches": [Batch],
"master": "xyz789",
"status": "PROCESSING_IMPORT",
"airport_code": "xyz789",
"excel_file": File,
"pdf_file": File,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createAirWayBill
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - CreateAirWaybillInput!
|
Example
Query
mutation CreateAirWayBill($input: CreateAirWaybillInput!) {
createAirWayBill(input: $input)
}
Variables
{"input": CreateAirWaybillInput}
Response
{"data": {"createAirWayBill": "abc123"}}
createBatch
Response
Returns a Batch!
Arguments
| Name | Description |
|---|---|
input - CreateBatchInput!
|
Example
Query
mutation CreateBatch($input: CreateBatchInput!) {
createBatch(input: $input) {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
created_at
updated_at
}
}
Variables
{"input": CreateBatchInput}
Response
{
"data": {
"createBatch": {
"id": "4",
"uuid": "abc123",
"dimensions_length": 987,
"dimensions_width": 987,
"dimensions_height": 987,
"tracking_number": "abc123",
"weight": 987,
"date": "2007-12-03T10:15:30Z",
"status": "DOCUMENTED",
"shipments": [Shipment],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createIncidence
Response
Returns an Incidence!
Arguments
| Name | Description |
|---|---|
input - CreateIncidenceInput!
|
Example
Query
mutation CreateIncidence($input: CreateIncidenceInput!) {
createIncidence(input: $input) {
id
uuid
account {
id
uuid
name
}
description
level
notes
incidencesReason {
id
uuid
account {
...AccountFragment
}
name
category
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
closed
}
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
status
delivery_type
informant {
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
emailsSent {
...SentEmailTemplateFragment
}
}
responsible {
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
emailsSent {
...SentEmailTemplateFragment
}
}
comments {
id
uuid
body
created_at
updated_at
}
incidencesTracking {
id
uuid
incidence {
...IncidenceFragment
}
responsible {
...EmployeeFragment
}
status
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
resolved
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": CreateIncidenceInput}
Response
{
"data": {
"createIncidence": {
"id": 4,
"uuid": "abc123",
"account": Account,
"description": "abc123",
"level": "LOW",
"notes": "xyz789",
"incidencesReason": IncidencesReason,
"shipment": Shipment,
"status": "OPEN",
"delivery_type": "DOOR",
"informant": Employee,
"responsible": Employee,
"comments": [Comment],
"incidencesTracking": [IncidencesTracking],
"resolved": false,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createIncidenceByTrackingNumber
Response
Returns an Incidence!
Arguments
| Name | Description |
|---|---|
input - CreateIncidenceByTrackingNumberInput!
|
Example
Query
mutation CreateIncidenceByTrackingNumber($input: CreateIncidenceByTrackingNumberInput!) {
createIncidenceByTrackingNumber(input: $input) {
id
uuid
account {
id
uuid
name
}
description
level
notes
incidencesReason {
id
uuid
account {
...AccountFragment
}
name
category
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
closed
}
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
status
delivery_type
informant {
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
emailsSent {
...SentEmailTemplateFragment
}
}
responsible {
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
emailsSent {
...SentEmailTemplateFragment
}
}
comments {
id
uuid
body
created_at
updated_at
}
incidencesTracking {
id
uuid
incidence {
...IncidenceFragment
}
responsible {
...EmployeeFragment
}
status
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
resolved
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": CreateIncidenceByTrackingNumberInput}
Response
{
"data": {
"createIncidenceByTrackingNumber": {
"id": "4",
"uuid": "abc123",
"account": Account,
"description": "abc123",
"level": "LOW",
"notes": "abc123",
"incidencesReason": IncidencesReason,
"shipment": Shipment,
"status": "OPEN",
"delivery_type": "DOOR",
"informant": Employee,
"responsible": Employee,
"comments": [Comment],
"incidencesTracking": [IncidencesTracking],
"resolved": true,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
createPickupStore
Response
Returns a PickupStore!
Arguments
| Name | Description |
|---|---|
input - CreatePickupStoreInput!
|
Example
Query
mutation CreatePickupStore($input: CreatePickupStoreInput!) {
createPickupStore(input: $input) {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
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
}
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
createdBy {
id
uuid
username
email
first_name
last_name
full_name
}
updatedBy {
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
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
created_at
updated_at
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
accountManager {
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
emailsSent {
...SentEmailTemplateFragment
}
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
id
uuid
commercial_name
corporate_name
phone_number
}
contact_name
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pickupStorePermits {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
pickup_store_has_current_permit
}
}
Variables
{"input": CreatePickupStoreInput}
Response
{
"data": {
"createPickupStore": {
"id": 4,
"uuid": "xyz789",
"name": "xyz789",
"alias": "xyz789",
"fiscal_name": "xyz789",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "abc123",
"max_package_capacity": 987,
"current_package_capacity": 123,
"address": Address,
"account": Account,
"shipments": [Shipment],
"user": User,
"createdBy": User,
"updatedBy": User,
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"pickupStoreShipments": PickupStoreShipmentPivot,
"accountManager": Employee,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": "4",
"company_id": "4",
"enabled": false,
"company": Company,
"contact_name": "xyz789",
"file": File,
"pickupStorePermits": [PickupStorePermit],
"pickup_store_has_current_permit": true
}
}
}
createPickupStorePermit
Response
Returns a PickupStorePermit!
Arguments
| Name | Description |
|---|---|
input - CreatePickupStorePermitInput!
|
Example
Query
mutation CreatePickupStorePermit($input: CreatePickupStorePermitInput!) {
createPickupStorePermit(input: $input) {
id
uuid
account {
id
uuid
name
}
pickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
code
start_date
end_date
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
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"input": CreatePickupStorePermitInput}
Response
{
"data": {
"createPickupStorePermit": {
"id": "4",
"uuid": "xyz789",
"account": Account,
"pickupStore": PickupStore,
"file": File,
"code": "abc123",
"start_date": "2007-12-03",
"end_date": "2007-12-03",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"emailsSent": [SentEmailTemplate]
}
}
}
createShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
input - CreateShipmentInput!
|
Example
Query
mutation CreateShipment($input: CreateShipmentInput!) {
createShipment(input: $input) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"input": CreateShipmentInput}
Response
{
"data": {
"createShipment": {
"id": "4",
"uuid": "abc123",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "xyz789",
"type": "DELIVERY",
"weight": 987,
"complete": false,
"cancellable": false,
"cancel_reason": "xyz789",
"notes": "xyz789",
"number_of_delivery_attempts": 123,
"max_attempts_exceeded": false,
"reference_number": "xyz789",
"price": 987.65,
"currency": "xyz789",
"product_category": "xyz789",
"product_name": "xyz789",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "abc123",
"simple_label": "xyz789",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
}
}
createShipmentLabel
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
input - CreateShipmentLabelInput!
|
Example
Query
mutation CreateShipmentLabel($input: CreateShipmentLabelInput!) {
createShipmentLabel(input: $input) {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"input": CreateShipmentLabelInput}
Response
{
"data": {
"createShipmentLabel": {
"id": "4",
"uuid": "xyz789",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "abc123",
"type": "DELIVERY",
"weight": 123,
"complete": false,
"cancellable": true,
"cancel_reason": "xyz789",
"notes": "xyz789",
"number_of_delivery_attempts": 987,
"max_attempts_exceeded": false,
"reference_number": "abc123",
"price": 987.65,
"currency": "abc123",
"product_category": "abc123",
"product_name": "abc123",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "xyz789",
"simple_label": "xyz789",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "abc123",
"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]
}
}
}
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
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"id": 4, "input": DeleteAssignEmployeeVehicleInput}
Response
{
"data": {
"deleteAssignVehicle": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"company": Company,
"first_name": "abc123",
"last_name": "xyz789",
"full_name": "xyz789",
"email": "abc123",
"phone_number": "abc123",
"enabled": false,
"available_for_order": true,
"vehicles": [Vehicle],
"assigned": VehicleEmployeePivot,
"current_vehicle": Vehicle,
"vehicle_type": "CAR",
"emailsSent": [SentEmailTemplate]
}
}
}
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": "xyz789",
"body": "xyz789",
"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": "abc123",
"body": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
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": "xyz789",
"body": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
deletePickupStore
Response
Returns a PickupStore
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeletePickupStore($id: ID!) {
deletePickupStore(id: $id) {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
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
}
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
createdBy {
id
uuid
username
email
first_name
last_name
full_name
}
updatedBy {
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
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
created_at
updated_at
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
accountManager {
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
emailsSent {
...SentEmailTemplateFragment
}
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
id
uuid
commercial_name
corporate_name
phone_number
}
contact_name
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pickupStorePermits {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
pickup_store_has_current_permit
}
}
Variables
{"id": 4}
Response
{
"data": {
"deletePickupStore": {
"id": 4,
"uuid": "abc123",
"name": "abc123",
"alias": "xyz789",
"fiscal_name": "abc123",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "xyz789",
"max_package_capacity": 123,
"current_package_capacity": 987,
"address": Address,
"account": Account,
"shipments": [Shipment],
"user": User,
"createdBy": User,
"updatedBy": User,
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"pickupStoreShipments": PickupStoreShipmentPivot,
"accountManager": Employee,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": "4",
"company_id": 4,
"enabled": false,
"company": Company,
"contact_name": "abc123",
"file": File,
"pickupStorePermits": [PickupStorePermit],
"pickup_store_has_current_permit": true
}
}
}
deletePickupStorePermit
Response
Returns a PickupStorePermit
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeletePickupStorePermit($id: ID!) {
deletePickupStorePermit(id: $id) {
id
uuid
account {
id
uuid
name
}
pickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
code
start_date
end_date
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
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deletePickupStorePermit": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"pickupStore": PickupStore,
"file": File,
"code": "abc123",
"start_date": "2007-12-03",
"end_date": "2007-12-03",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"emailsSent": [SentEmailTemplate]
}
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "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]
}
}
}
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": "xyz789",
"expires_in": 123,
"token_type": "xyz789"
}
}
}
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"
}
}
}
packageTransition
Response
Returns a Package!
Arguments
| Name | Description |
|---|---|
tracking_number - String!
|
|
geolocation - GeolocationInput
|
|
date - DateTime
|
|
input - PackageTransitionInput!
|
Example
Query
mutation PackageTransition(
$tracking_number: String!,
$geolocation: GeolocationInput,
$date: DateTime,
$input: PackageTransitionInput!
) {
packageTransition(
tracking_number: $tracking_number,
geolocation: $geolocation,
date: $date,
input: $input
) {
id
uuid
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
id
uuid
status
type
address {
...AddressFragment
}
created_at
updated_at
}
}
}
Variables
{
"tracking_number": "xyz789",
"geolocation": GeolocationInput,
"date": "2007-12-03T10:15:30Z",
"input": PackageTransitionInput
}
Response
{
"data": {
"packageTransition": {
"id": 4,
"uuid": "xyz789",
"shipment": Shipment,
"tracking_number": "xyz789",
"status": "DOCUMENTED",
"dimensions_length": 987,
"dimensions_width": 123,
"dimensions_height": 123,
"volume_weight": 123,
"weight": 987,
"expired": false,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"packagesTracking": [PackagesTracking]
}
}
}
postbagInPickupStore
Response
Returns a PickupStore
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
postbagId - ID!
|
|
geolocation - GeolocationInput
|
Example
Query
mutation PostbagInPickupStore(
$id: ID!,
$postbagId: ID!,
$geolocation: GeolocationInput
) {
postbagInPickupStore(
id: $id,
postbagId: $postbagId,
geolocation: $geolocation
) {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
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
}
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
createdBy {
id
uuid
username
email
first_name
last_name
full_name
}
updatedBy {
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
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
created_at
updated_at
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
accountManager {
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
emailsSent {
...SentEmailTemplateFragment
}
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
id
uuid
commercial_name
corporate_name
phone_number
}
contact_name
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pickupStorePermits {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
pickup_store_has_current_permit
}
}
Variables
{"id": 4, "postbagId": 4, "geolocation": GeolocationInput}
Response
{
"data": {
"postbagInPickupStore": {
"id": "4",
"uuid": "xyz789",
"name": "abc123",
"alias": "abc123",
"fiscal_name": "xyz789",
"document_number": "xyz789",
"email": "xyz789",
"phone_number": "abc123",
"max_package_capacity": 123,
"current_package_capacity": 987,
"address": Address,
"account": Account,
"shipments": [Shipment],
"user": User,
"createdBy": User,
"updatedBy": User,
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"pickupStoreShipments": PickupStoreShipmentPivot,
"accountManager": Employee,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": "4",
"company_id": 4,
"enabled": true,
"company": Company,
"contact_name": "xyz789",
"file": File,
"pickupStorePermits": [PickupStorePermit],
"pickup_store_has_current_permit": true
}
}
}
postbagTransition
Response
Returns a Postbag!
Arguments
| Name | Description |
|---|---|
code - String!
|
|
geolocation - GeolocationInput
|
|
transition - String!
|
Example
Query
mutation PostbagTransition(
$code: String!,
$geolocation: GeolocationInput,
$transition: String!
) {
postbagTransition(
code: $code,
geolocation: $geolocation,
transition: $transition
) {
id
uuid
route {
id
uuid
date
day_number
name
distance
net_distance
number_of_shipments
polylines
pending
delivered
failed
finalFailed
finished
start_time
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
postbagsTracking {
id
postbag {
...PostbagFragment
}
address {
...AddressFragment
}
status
}
postbagsScanning {
id
postbag {
...PostbagFragment
}
status
}
qr_code
status
}
}
Variables
{
"code": "abc123",
"geolocation": GeolocationInput,
"transition": "xyz789"
}
Response
{
"data": {
"postbagTransition": {
"id": 4,
"uuid": "xyz789",
"route": Route,
"packages": [Package],
"postbagsTracking": [PostbagsTracking],
"postbagsScanning": [PostbagsScanning],
"qr_code": "abc123",
"status": "abc123"
}
}
}
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": 123,
"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": "xyz789",
"refresh_token": "abc123",
"expires_in": 987,
"token_type": "xyz789"
}
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "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]
}
}
}
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"}}
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"
}
}
}
updateIncidence
Response
Returns an Incidence!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateIncidenceInput!
|
Example
Query
mutation UpdateIncidence(
$id: ID!,
$input: UpdateIncidenceInput!
) {
updateIncidence(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
description
level
notes
incidencesReason {
id
uuid
account {
...AccountFragment
}
name
category
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
closed
}
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
status
delivery_type
informant {
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
emailsSent {
...SentEmailTemplateFragment
}
}
responsible {
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
emailsSent {
...SentEmailTemplateFragment
}
}
comments {
id
uuid
body
created_at
updated_at
}
incidencesTracking {
id
uuid
incidence {
...IncidenceFragment
}
responsible {
...EmployeeFragment
}
status
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
resolved
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
{"id": 4, "input": UpdateIncidenceInput}
Response
{
"data": {
"updateIncidence": {
"id": 4,
"uuid": "xyz789",
"account": Account,
"description": "abc123",
"level": "LOW",
"notes": "abc123",
"incidencesReason": IncidencesReason,
"shipment": Shipment,
"status": "OPEN",
"delivery_type": "DOOR",
"informant": Employee,
"responsible": Employee,
"comments": [Comment],
"incidencesTracking": [IncidencesTracking],
"resolved": true,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
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
exception
day_off
timePeriods {
...TimePeriodFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
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": false,
"openingHours": [OpeningHour],
"model": PickupStore,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
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": "abc123"
}
}
}
updatePickupStore
Response
Returns a PickupStore!
Arguments
| Name | Description |
|---|---|
input - UpdatePickupStoreInput!
|
Example
Query
mutation UpdatePickupStore($input: UpdatePickupStoreInput!) {
updatePickupStore(input: $input) {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
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
}
shipments {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
user {
id
uuid
username
email
first_name
last_name
full_name
}
createdBy {
id
uuid
username
email
first_name
last_name
full_name
}
updatedBy {
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
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
created_at
updated_at
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
accountManager {
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
emailsSent {
...SentEmailTemplateFragment
}
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
id
uuid
commercial_name
corporate_name
phone_number
}
contact_name
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
pickupStorePermits {
id
uuid
account {
...AccountFragment
}
pickupStore {
...PickupStoreFragment
}
file {
...FileFragment
}
code
start_date
end_date
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
emailsSent {
...SentEmailTemplateFragment
}
}
pickup_store_has_current_permit
}
}
Variables
{"input": UpdatePickupStoreInput}
Response
{
"data": {
"updatePickupStore": {
"id": "4",
"uuid": "xyz789",
"name": "xyz789",
"alias": "abc123",
"fiscal_name": "xyz789",
"document_number": "xyz789",
"email": "abc123",
"phone_number": "xyz789",
"max_package_capacity": 987,
"current_package_capacity": 123,
"address": Address,
"account": Account,
"shipments": [Shipment],
"user": User,
"createdBy": User,
"updatedBy": User,
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"pickupStoreShipments": PickupStoreShipmentPivot,
"accountManager": Employee,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": "4",
"company_id": 4,
"enabled": true,
"company": Company,
"contact_name": "xyz789",
"file": File,
"pickupStorePermits": [PickupStorePermit],
"pickup_store_has_current_permit": false
}
}
}
updatePickupStorePermit
Response
Returns a PickupStorePermit!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdatePickupStorePermit!
|
Example
Query
mutation UpdatePickupStorePermit(
$id: ID!,
$input: UpdatePickupStorePermit!
) {
updatePickupStorePermit(
id: $id,
input: $input
) {
id
uuid
account {
id
uuid
name
}
pickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
file {
id
uuid
path
file_original_name
file_mime_type
file_size
encode_file
pivot {
...FilePivotFragment
}
}
code
start_date
end_date
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
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Variables
{"id": 4, "input": UpdatePickupStorePermit}
Response
{
"data": {
"updatePickupStorePermit": {
"id": 4,
"uuid": "abc123",
"account": Account,
"pickupStore": PickupStore,
"file": File,
"code": "xyz789",
"start_date": "2007-12-03",
"end_date": "2007-12-03",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"emailsSent": [SentEmailTemplate]
}
}
}
updateProofOfDelivery
Response
Returns a ProofsOfDelivery!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateProofOfDeliveryInput!
|
Example
Query
mutation UpdateProofOfDelivery(
$id: ID!,
$input: UpdateProofOfDeliveryInput!
) {
updateProofOfDelivery(
id: $id,
input: $input
) {
id
uuid
name
document_number
comments
shipment {
id
uuid
batch {
...BatchFragment
}
date
originAddress {
...AddressFragment
}
destinationAddress {
...AddressFragment
}
proofOfDelivery {
...ProofsOfDeliveryFragment
}
packages {
...PackageFragment
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
...PickupStoreFragment
}
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
destination_pickup_store {
...PickupStoreFragment
}
originPickupStore {
...PickupStoreFragment
}
destinationPickupStore {
...PickupStoreFragment
}
label
simple_label
digital_label
destinationLocker {
...LockerFragment
}
deliverySlot {
...BusinessScheduleFragment
}
emailsSent {
...SentEmailTemplateFragment
}
}
delivery_type
created_at
updated_at
}
}
Variables
{
"id": "4",
"input": UpdateProofOfDeliveryInput
}
Response
{
"data": {
"updateProofOfDelivery": {
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"document_number": "xyz789",
"comments": "abc123",
"shipment": Shipment,
"delivery_type": "DOOR",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
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
standard_consumption
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
emailsSent {
...SentEmailTemplateFragment
}
}
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
emailsSent {
...SentEmailTemplateFragment
}
}
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": "abc123",
"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]
}
}
}
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": "abc123",
"expires_in": 123,
"token_type": "abc123",
"user": User
}
}
}
Subscriptions
shipmentCreated
Response
Returns a Shipment
Example
Query
subscription ShipmentCreated {
shipmentCreated {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Response
{
"data": {
"shipmentCreated": {
"id": 4,
"uuid": "xyz789",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "xyz789",
"type": "DELIVERY",
"weight": 123,
"complete": true,
"cancellable": false,
"cancel_reason": "xyz789",
"notes": "xyz789",
"number_of_delivery_attempts": 987,
"max_attempts_exceeded": false,
"reference_number": "xyz789",
"price": 987.65,
"currency": "abc123",
"product_category": "xyz789",
"product_name": "xyz789",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "xyz789",
"simple_label": "xyz789",
"digital_label": "xyz789",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
}
}
shipmentUpdated
Response
Returns a Shipment
Example
Query
subscription ShipmentUpdated {
shipmentUpdated {
id
uuid
batch {
id
uuid
dimensions_length
dimensions_width
dimensions_height
tracking_number
weight
date
status
shipments {
...ShipmentFragment
}
created_at
updated_at
}
date
originAddress {
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
}
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
}
proofOfDelivery {
id
uuid
name
document_number
comments
shipment {
...ShipmentFragment
}
delivery_type
created_at
updated_at
}
packages {
id
uuid
shipment {
...ShipmentFragment
}
tracking_number
status
dimensions_length
dimensions_width
dimensions_height
volume_weight
weight
expired
created_at
updated_at
packagesTracking {
...PackagesTrackingFragment
}
}
status
tracking_number
type
weight
complete
cancellable
cancel_reason
notes
number_of_delivery_attempts
max_attempts_exceeded
reference_number
price
currency
product_category
product_name
pickupStores {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
pickupStoreShipments {
pickup_store_id
shipment_id
status
type
in_store
created_at
updated_at
}
destination_pickup_store {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
originPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
destinationPickupStore {
id
uuid
name
alias
fiscal_name
document_number
email
phone_number
max_package_capacity
current_package_capacity
address {
...AddressFragment
}
account {
...AccountFragment
}
shipments {
...ShipmentFragment
}
user {
...UserFragment
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
businessSchedule {
...BusinessScheduleFragment
}
created_at
updated_at
pickupStoreShipments {
...PickupStoreShipmentPivotFragment
}
accountManager {
...EmployeeFragment
}
start_deal_date
finish_deal_date
account_manager_id
company_id
enabled
company {
...CompanyFragment
}
contact_name
file {
...FileFragment
}
pickupStorePermits {
...PickupStorePermitFragment
}
pickup_store_has_current_permit
}
label
simple_label
digital_label
destinationLocker {
id
uuid
external_id
name
address {
...AddressFragment
}
created_at
updated_at
}
deliverySlot {
id
uuid
model_id
model_type
type
current
openingHours {
...OpeningHourFragment
}
model {
... on PickupStore {
...PickupStoreFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
created_at
updated_at
}
emailsSent {
id
event
recipient
recipient_name
sendable_id
sendable_type
created_at
updated_at
}
}
}
Response
{
"data": {
"shipmentUpdated": {
"id": 4,
"uuid": "abc123",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "xyz789",
"type": "DELIVERY",
"weight": 987,
"complete": false,
"cancellable": false,
"cancel_reason": "abc123",
"notes": "abc123",
"number_of_delivery_attempts": 123,
"max_attempts_exceeded": true,
"reference_number": "abc123",
"price": 123.45,
"currency": "xyz789",
"product_category": "xyz789",
"product_name": "xyz789",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "abc123",
"simple_label": "xyz789",
"digital_label": "abc123",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
}
}
Types
Account
AddCommentInput
Fields
| Input Field | Description |
|---|---|
comments - CreateCommentHasMany!
|
Example
{"comments": CreateCommentHasMany}
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": "abc123",
"street": "xyz789",
"formatted_address": "xyz789",
"email": "abc123",
"phone_number": "xyz789",
"notes": "xyz789",
"city": "xyz789",
"postal_code": "xyz789",
"country": "abc123",
"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"
}
AirWayBillDistributors
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SHEIN"
AirWayBillStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PROCESSING_IMPORT"
AirWaybill
Example
{
"id": "4",
"uuid": "xyz789",
"account": Account,
"distributorParent": DistributorParent,
"batches": [Batch],
"master": "abc123",
"status": "PROCESSING_IMPORT",
"airport_code": "xyz789",
"excel_file": File,
"pdf_file": File,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
AssignEmployeeInput
AssignEmployeeToVehicleInput
AssignEmployeeVehicleInput
AuthPayload
Batch
Example
{
"id": "4",
"uuid": "abc123",
"dimensions_length": 123,
"dimensions_width": 123,
"dimensions_height": 123,
"tracking_number": "xyz789",
"weight": 987,
"date": "2007-12-03T10:15:30Z",
"status": "DOCUMENTED",
"shipments": [Shipment],
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
BatchStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENTED"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BusinessSchedule
Example
{
"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"
}
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"
CancelReasons
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SELLER_CANCEL"
ChangeAirWayBillStatus
Fields
| Input Field | Description |
|---|---|
master - String!
|
|
status - AirWayBillStatus
|
Example
{
"master": "abc123",
"status": "PROCESSING_IMPORT"
}
Comment
Company
ConnectEmployeesToVehicleBelongsToMany
Fields
| Input Field | Description |
|---|---|
connect - [AssignEmployeeToVehicleInput!]
|
Example
{"connect": [AssignEmployeeToVehicleInput]}
ConnectLockerInput
Fields
| Input Field | Description |
|---|---|
connect - ID
|
Example
{"connect": "4"}
ConnectPickupStoreInput
Fields
| Input Field | Description |
|---|---|
connect - ID
|
Example
{"connect": "4"}
ConnectVehicleFiles
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
document_type - VehicleDocumentType
|
|
expiration_date - String
|
|
comments - String
|
Example
{
"id": "4",
"document_type": "REGISTRATION_CERTIFICATE",
"expiration_date": "abc123",
"comments": "xyz789"
}
CreateAddressInput
Example
{
"name": "abc123",
"street": "xyz789",
"formatted_address": "abc123",
"email": "xyz789",
"phone_number": "abc123",
"notes": "abc123",
"city": "abc123",
"postal_code": "abc123",
"country": "abc123",
"geolocation_latitude": 987.65,
"geolocation_longitude": 987.65,
"province_id": "4"
}
CreateAirWaybillInput
Fields
| Input Field | Description |
|---|---|
distributor_parent_name - AirWayBillDistributors
|
|
excel_file - Upload!
|
|
pdf_file - Upload!
|
Example
{
"distributor_parent_name": "SHEIN",
"excel_file": Upload,
"pdf_file": Upload
}
CreateBatchInput
Fields
| Input Field | Description |
|---|---|
dimensions_length - Int
|
|
dimensions_width - Int
|
|
dimensions_height - Int
|
|
tracking_number - String!
|
|
weight - Int!
|
|
date - Date!
|
|
status - BatchStatus!
|
|
shipments - CreateShipmentHasMany!
|
Example
{
"dimensions_length": 987,
"dimensions_width": 123,
"dimensions_height": 987,
"tracking_number": "xyz789",
"weight": 987,
"date": "2007-12-03",
"status": "DOCUMENTED",
"shipments": CreateShipmentHasMany
}
CreateBelongsTo
Fields
| Input Field | Description |
|---|---|
connect - ID
|
Example
{"connect": 4}
CreateCommentHasMany
Fields
| Input Field | Description |
|---|---|
create - [CreateCommentInput!]
|
Example
{"create": [CreateCommentInput]}
CreateCommentInput
Fields
| Input Field | Description |
|---|---|
body - String!
|
Example
{"body": "xyz789"}
CreateDestinationAddress
Fields
| Input Field | Description |
|---|---|
create - CreateAddressInput
|
Example
{"create": CreateAddressInput}
CreateIncidenceByTrackingNumberInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
level - IncidencesLevel
|
|
status - IncidencesStatus
|
|
notes - String
|
|
incidencesReason - CreateBelongsTo!
|
|
tracking_number - String!
|
|
delivery_type - DeliveryType
|
Example
{
"description": "abc123",
"level": "LOW",
"status": "OPEN",
"notes": "xyz789",
"incidencesReason": CreateBelongsTo,
"tracking_number": "abc123",
"delivery_type": "DOOR"
}
CreateIncidenceInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
level - IncidencesLevel
|
|
status - IncidencesStatus
|
|
notes - String
|
|
incidencesReason - CreateBelongsTo!
|
|
shipment - CreateBelongsTo!
|
|
delivery_type - DeliveryType
|
Example
{
"description": "xyz789",
"level": "LOW",
"status": "OPEN",
"notes": "xyz789",
"incidencesReason": CreateBelongsTo,
"shipment": CreateBelongsTo,
"delivery_type": "DOOR"
}
CreateOriginAddress
Fields
| Input Field | Description |
|---|---|
create - CreateAddressInput
|
Example
{"create": CreateAddressInput}
CreatePackageHasMany
Fields
| Input Field | Description |
|---|---|
create - [CreatePackageInput!]
|
|
connect - [ID!]
|
Example
{"create": [CreatePackageInput], "connect": [4]}
CreatePackageInput
Example
{
"tracking_number": "abc123",
"status": "DOCUMENTED",
"dimensions_length": 123,
"dimensions_width": 123,
"dimensions_height": 987,
"volume_weight": 123,
"weight": 987,
"expired": false
}
CreatePickupStoreInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
alias - String
|
|
document_number - String!
|
|
email - String!
|
|
formatted_address - String!
|
|
street - String!
|
|
phone_number - String
|
|
postal_code - String!
|
|
province_id - ID
|
|
city - String!
|
|
geolocation_latitude - Float
|
|
geolocation_longitude - Float
|
|
first_name - String
|
|
last_name - String
|
|
max_package_capacity - Int
|
|
account_id - ID!
|
|
start_deal_date - Date
|
|
finish_deal_date - Date
|
|
account_manager_id - ID
|
|
company_id - ID
|
|
enabled - Boolean
|
|
contact_name - String
|
|
file_id - ID
|
Example
{
"name": "xyz789",
"alias": "abc123",
"document_number": "abc123",
"email": "abc123",
"formatted_address": "abc123",
"street": "abc123",
"phone_number": "abc123",
"postal_code": "abc123",
"province_id": "4",
"city": "abc123",
"geolocation_latitude": 123.45,
"geolocation_longitude": 987.65,
"first_name": "xyz789",
"last_name": "abc123",
"max_package_capacity": 987,
"account_id": "4",
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": "4",
"company_id": 4,
"enabled": false,
"contact_name": "xyz789",
"file_id": "4"
}
CreatePickupStorePermitInput
CreateProofOfDeliveryByTrackingNumberInput
Example
{
"tracking_number": "abc123",
"name": "abc123",
"document_number": "abc123",
"delivery_type": "DOOR",
"comments": "xyz789",
"contacted": false
}
CreateProofOfDeliveryInput
Fields
| Input Field | Description |
|---|---|
shipment - CreateBelongsTo!
|
|
name - String!
|
|
document_number - String
|
|
delivery_type - DeliveryType
|
|
comments - String
|
|
contacted - Boolean
|
Example
{
"shipment": CreateBelongsTo,
"name": "abc123",
"document_number": "abc123",
"delivery_type": "DOOR",
"comments": "abc123",
"contacted": false
}
CreateShipmentHasMany
Fields
| Input Field | Description |
|---|---|
create - [CreateShipmentInput!]
|
Example
{"create": [CreateShipmentInput]}
CreateShipmentInput
Fields
| Input Field | Description |
|---|---|
date - Date!
|
|
originAddress - CreateOriginAddress
|
|
destinationAddress - CreateDestinationAddress
|
|
packages - CreatePackageHasMany!
|
|
status - ShipmentStatus!
|
|
tracking_number - String
|
|
type - ShipmentTypes!
|
|
weight - Int
|
|
complete - Boolean
|
|
cancellable - Boolean
|
|
notes - String
|
|
reference_number - String
|
|
distributor_parent_id - String
|
|
price - Float
|
|
currency - String
|
|
product_category - String
|
|
product_name - String
|
|
originPickupStore - ConnectPickupStoreInput
|
|
destinationPickupStore - ConnectPickupStoreInput
|
|
destination_locker_id - ID
|
Example
{
"date": "2007-12-03",
"originAddress": CreateOriginAddress,
"destinationAddress": CreateDestinationAddress,
"packages": CreatePackageHasMany,
"status": "DOCUMENTED",
"tracking_number": "xyz789",
"type": "DELIVERY",
"weight": 123,
"complete": false,
"cancellable": true,
"notes": "xyz789",
"reference_number": "xyz789",
"distributor_parent_id": "abc123",
"price": 987.65,
"currency": "xyz789",
"product_category": "xyz789",
"product_name": "abc123",
"originPickupStore": ConnectPickupStoreInput,
"destinationPickupStore": ConnectPickupStoreInput,
"destination_locker_id": "4"
}
CreateShipmentLabelInput
Fields
| Input Field | Description |
|---|---|
date - Date
|
|
tracking_number - String
|
|
type - ShipmentTypes
|
|
originAddress - CreateOriginAddress
|
|
destinationAddress - CreateDestinationAddress
|
|
weight - Int
|
|
cancellable - Boolean
|
|
notes - String
|
|
reference_number - String
|
|
price - Float
|
|
currency - String
|
|
product_category - String
|
|
product_name - String
|
|
originPickupStore - ConnectPickupStoreInput
|
|
destinationPickupStore - ConnectPickupStoreInput
|
|
destinationLocker - ConnectLockerInput
|
|
pickupPoint - String
|
|
distributor_parent_id - ID
|
Example
{
"date": "2007-12-03",
"tracking_number": "abc123",
"type": "DELIVERY",
"originAddress": CreateOriginAddress,
"destinationAddress": CreateDestinationAddress,
"weight": 123,
"cancellable": true,
"notes": "abc123",
"reference_number": "xyz789",
"price": 123.45,
"currency": "xyz789",
"product_category": "abc123",
"product_name": "xyz789",
"originPickupStore": ConnectPickupStoreInput,
"destinationPickupStore": ConnectPickupStoreInput,
"destinationLocker": ConnectLockerInput,
"pickupPoint": "abc123",
"distributor_parent_id": "4"
}
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": "xyz789",
"license_plate_number": "abc123",
"status": "ACTIVE",
"account_id": 987,
"vehicle_model_id": 987,
"distribution_center_id": 987,
"employees": ConnectEmployeesToVehicleBelongsToMany
}
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"}
DeliverySlotInput
Fields
| Input Field | Description |
|---|---|
day_of_week - DaysWeekType!
|
|
time_periods - [TimePeriodInput!]
|
Example
{
"day_of_week": "MONDAY",
"time_periods": [TimePeriodInput]
}
DeliveryType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOOR"
DisconnectVehicleFiles
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": 4}
DistributionCenter
Example
{
"id": "4",
"uuid": "abc123",
"name": "abc123",
"account": Account,
"address": Address,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
DistributorParent
Example
{
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"key": "xyz789",
"pickup_store_enabled": false,
"account": Account,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"days_to_order_failed": "abc123",
"file": File,
"file_id": "4",
"company": Company,
"number_of_attempts": 123
}
DistributorParentPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [DistributorParent!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [DistributorParent]
}
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
|
|
emailsSent - [SentEmailTemplate!]
|
Example
{
"id": 4,
"uuid": "xyz789",
"account": Account,
"company": Company,
"first_name": "xyz789",
"last_name": "abc123",
"full_name": "xyz789",
"email": "abc123",
"phone_number": "xyz789",
"enabled": false,
"available_for_order": true,
"vehicles": [Vehicle],
"assigned": VehicleEmployeePivot,
"current_vehicle": Vehicle,
"vehicle_type": "CAR",
"emailsSent": [SentEmailTemplate]
}
File
Example
{
"id": "4",
"uuid": "abc123",
"path": "abc123",
"file_original_name": "abc123",
"file_mime_type": "abc123",
"file_size": 123,
"encode_file": "xyz789",
"pivot": FilePivot
}
FilePivot
FinalStatusTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PENDING"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
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"
Incidence
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
account - Account
|
|
description - String
|
|
level - IncidencesLevel!
|
|
notes - String
|
|
incidencesReason - IncidencesReason!
|
|
shipment - Shipment!
|
|
status - IncidencesStatus!
|
|
delivery_type - DeliveryType
|
|
informant - Employee
|
|
responsible - Employee
|
|
comments - [Comment]
|
|
incidencesTracking - [IncidencesTracking]
|
|
resolved - Boolean!
|
|
createdBy - User
|
|
updatedBy - User
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"id": 4,
"uuid": "xyz789",
"account": Account,
"description": "abc123",
"level": "LOW",
"notes": "xyz789",
"incidencesReason": IncidencesReason,
"shipment": Shipment,
"status": "OPEN",
"delivery_type": "DOOR",
"informant": Employee,
"responsible": Employee,
"comments": [Comment],
"incidencesTracking": [IncidencesTracking],
"resolved": true,
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
IncidencesLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LOW"
IncidencesReason
Example
{
"id": 4,
"uuid": "abc123",
"account": Account,
"name": "xyz789",
"category": "ATTEMPT",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"closed": true
}
IncidencesReasonCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ATTEMPT"
IncidencesReasonPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [IncidencesReason!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [IncidencesReason]
}
IncidencesStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
IncidencesTracking
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
incidence - Incidence!
|
|
responsible - Employee
|
|
status - IncidencesStatus!
|
|
createdBy - User
|
|
updatedBy - User
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"id": "4",
"uuid": "xyz789",
"incidence": Incidence,
"responsible": Employee,
"status": "OPEN",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
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
Locker
Example
{
"id": 4,
"uuid": "xyz789",
"external_id": "xyz789",
"name": "xyz789",
"address": Address,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
LockerPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [Locker!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Locker]
}
LoginInput
LogoutResponse
Mixed
Example
Mixed
Model
Types
| Union Types |
|---|
Example
PickupStore
NewPasswordWithCodeInput
OpeningHour
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
day - DaysWeekType
|
|
exception - String
|
|
day_off - Boolean
|
|
timePeriods - [TimePeriod!]!
|
|
businessSchedule - BusinessSchedule!
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"id": "4",
"uuid": "abc123",
"day": "MONDAY",
"exception": "xyz789",
"day_off": true,
"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
|
|
exception - Boolean
|
|
timePeriods - [TimePeriodInput]
|
Example
{
"day": "MONDAY",
"day_off": false,
"exception": false,
"timePeriods": [TimePeriodInput]
}
Package
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
shipment - Shipment
|
|
tracking_number - String!
|
|
status - ShipmentStatus!
|
|
dimensions_length - Int
|
|
dimensions_width - Int
|
|
dimensions_height - Int
|
|
volume_weight - Int
|
|
weight - Int
|
|
expired - Boolean
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
|
packagesTracking - [PackagesTracking]
|
Example
{
"id": "4",
"uuid": "abc123",
"shipment": Shipment,
"tracking_number": "xyz789",
"status": "DOCUMENTED",
"dimensions_length": 987,
"dimensions_width": 123,
"dimensions_height": 987,
"volume_weight": 123,
"weight": 123,
"expired": true,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"packagesTracking": [PackagesTracking]
}
PackageTransitionInput
Fields
| Input Field | Description |
|---|---|
transition - PackageTransitionValue!
|
Example
{"transition": "CANCEL"}
PackageTransitionValue
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCEL"
PackagesTracking
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
status - ShipmentStatus
|
|
type - ShipmentTypes
|
|
address - Address
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"id": "4",
"uuid": "abc123",
"status": "DOCUMENTED",
"type": "DELIVERY",
"address": Address,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
PaginatorInfo
Example
{
"count": 123,
"currentPage": 123,
"firstItem": 123,
"hasMorePages": false,
"lastItem": 987,
"lastPage": 123,
"perPage": 987,
"total": 123
}
PickupStore
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
name - String!
|
|
alias - String
|
|
fiscal_name - String
|
|
document_number - String!
|
|
email - String!
|
|
phone_number - String
|
|
max_package_capacity - Int
|
|
current_package_capacity - Int
|
|
address - Address!
|
|
account - Account!
|
|
shipments - [Shipment]
|
|
user - User
|
|
createdBy - User
|
|
updatedBy - User
|
|
businessSchedule - BusinessSchedule
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
|
pickupStoreShipments - PickupStoreShipmentPivot
|
|
accountManager - Employee
|
|
start_deal_date - Date
|
|
finish_deal_date - Date
|
|
account_manager_id - ID
|
|
company_id - ID
|
|
enabled - Boolean
|
|
company - Company
|
|
contact_name - String
|
|
file - File
|
|
pickupStorePermits - [PickupStorePermit!]
|
|
pickup_store_has_current_permit - Boolean
|
Example
{
"id": "4",
"uuid": "abc123",
"name": "xyz789",
"alias": "abc123",
"fiscal_name": "xyz789",
"document_number": "abc123",
"email": "xyz789",
"phone_number": "abc123",
"max_package_capacity": 987,
"current_package_capacity": 987,
"address": Address,
"account": Account,
"shipments": [Shipment],
"user": User,
"createdBy": User,
"updatedBy": User,
"businessSchedule": BusinessSchedule,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"pickupStoreShipments": PickupStoreShipmentPivot,
"accountManager": Employee,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": "4",
"company_id": "4",
"enabled": false,
"company": Company,
"contact_name": "xyz789",
"file": File,
"pickupStorePermits": [PickupStorePermit],
"pickup_store_has_current_permit": true
}
PickupStorePaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [PickupStore!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [PickupStore]
}
PickupStorePermit
Example
{
"id": "4",
"uuid": "xyz789",
"account": Account,
"pickupStore": PickupStore,
"file": File,
"code": "abc123",
"start_date": "2007-12-03",
"end_date": "2007-12-03",
"createdBy": User,
"updatedBy": User,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"emailsSent": [SentEmailTemplate]
}
PickupStorePermitPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [PickupStorePermit!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [PickupStorePermit]
}
PickupStoreShipmentPivot
Example
{
"pickup_store_id": "4",
"shipment_id": 4,
"status": "abc123",
"type": "abc123",
"in_store": false,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
Postbag
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
route - Route
|
|
packages - [Package!]!
|
|
postbagsTracking - [PostbagsTracking]
|
|
postbagsScanning - [PostbagsScanning]
|
|
qr_code - String
|
|
status - String
|
Example
{
"id": "4",
"uuid": "xyz789",
"route": Route,
"packages": [Package],
"postbagsTracking": [PostbagsTracking],
"postbagsScanning": [PostbagsScanning],
"qr_code": "abc123",
"status": "abc123"
}
PostbagStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IN_PREPARATION"
PostbagsScanning
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
postbag - Postbag
|
|
status - PostbagStatus!
|
Example
{"id": 4, "postbag": Postbag, "status": "IN_PREPARATION"}
PostbagsTracking
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
postbag - Postbag
|
|
address - Address
|
|
status - PostbagStatus!
|
Example
{
"id": "4",
"postbag": Postbag,
"address": Address,
"status": "IN_PREPARATION"
}
ProofsOfDelivery
Example
{
"id": "4",
"uuid": "xyz789",
"name": "abc123",
"document_number": "xyz789",
"comments": "xyz789",
"shipment": Shipment,
"delivery_type": "DOOR",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
Province
QueryAllDistributorParentsOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ID"
QueryAllDistributorParentsOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryAllDistributorParentsOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "ID", "order": "ASC"}
QueryAllLockersOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EXTERNAL_ID"
QueryAllLockersOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryAllLockersOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "EXTERNAL_ID", "order": "ASC"}
QueryAllLockersWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EXTERNAL_ID"
QueryAllLockersWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllLockersWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllLockersWhereWhereConditions!]
|
|
OR - [QueryAllLockersWhereWhereConditions!]
|
|
HAS - QueryAllLockersWhereWhereConditionsRelation
|
Example
{
"column": "EXTERNAL_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllLockersWhereWhereConditions],
"OR": [QueryAllLockersWhereWhereConditions],
"HAS": QueryAllLockersWhereWhereConditionsRelation
}
QueryAllLockersWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllLockersWhereWhereConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryAllLockersWhereWhereConditions
}
QueryAllPermitsByPickupStoreOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryAllPermitsByPickupStoreOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryAllPermitsByPickupStoreOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "ID", "order": "ASC"}
QueryAllPermitsByPickupStoreWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryAllPermitsByPickupStoreWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPermitsByPickupStoreWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPermitsByPickupStoreWhereWhereConditions!]
|
|
OR - [QueryAllPermitsByPickupStoreWhereWhereConditions!]
|
|
HAS - QueryAllPermitsByPickupStoreWhereWhereConditionsRelation
|
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryAllPermitsByPickupStoreWhereWhereConditions
],
"OR": [
QueryAllPermitsByPickupStoreWhereWhereConditions
],
"HAS": QueryAllPermitsByPickupStoreWhereWhereConditionsRelation
}
QueryAllPermitsByPickupStoreWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPermitsByPickupStoreWhereWhereConditions
|
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryAllPermitsByPickupStoreWhereWhereConditions
}
QueryAllPickupStorePermitsOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryAllPickupStorePermitsOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStorePermitsOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "ID", "order": "ASC"}
QueryAllPickupStorePermitsPermitColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
QueryAllPickupStorePermitsPermitWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStorePermitsPermitColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStorePermitsPermitWhereHasConditions!]
|
|
OR - [QueryAllPickupStorePermitsPermitWhereHasConditions!]
|
|
HAS - QueryAllPickupStorePermitsPermitWhereHasConditionsRelation
|
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryAllPickupStorePermitsPermitWhereHasConditions
],
"OR": [
QueryAllPickupStorePermitsPermitWhereHasConditions
],
"HAS": QueryAllPickupStorePermitsPermitWhereHasConditionsRelation
}
QueryAllPickupStorePermitsPermitWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStorePermitsPermitWhereHasConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryAllPickupStorePermitsPermitWhereHasConditions
}
QueryAllPickupStorePermitsPickupStoreColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
QueryAllPickupStorePermitsPickupStoreWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStorePermitsPickupStoreColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStorePermitsPickupStoreWhereHasConditions!]
|
|
OR - [QueryAllPickupStorePermitsPickupStoreWhereHasConditions!]
|
|
HAS - QueryAllPickupStorePermitsPickupStoreWhereHasConditionsRelation
|
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryAllPickupStorePermitsPickupStoreWhereHasConditions
],
"OR": [
QueryAllPickupStorePermitsPickupStoreWhereHasConditions
],
"HAS": QueryAllPickupStorePermitsPickupStoreWhereHasConditionsRelation
}
QueryAllPickupStorePermitsPickupStoreWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStorePermitsPickupStoreWhereHasConditions
|
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryAllPickupStorePermitsPickupStoreWhereHasConditions
}
QueryAllPickupStorePermitsWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryAllPickupStorePermitsWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStorePermitsWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStorePermitsWhereWhereConditions!]
|
|
OR - [QueryAllPickupStorePermitsWhereWhereConditions!]
|
|
HAS - QueryAllPickupStorePermitsWhereWhereConditionsRelation
|
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllPickupStorePermitsWhereWhereConditions],
"OR": [QueryAllPickupStorePermitsWhereWhereConditions],
"HAS": QueryAllPickupStorePermitsWhereWhereConditionsRelation
}
QueryAllPickupStorePermitsWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStorePermitsWhereWhereConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryAllPickupStorePermitsWhereWhereConditions
}
QueryAllPickupStoresAccountColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DOMAIN"
QueryAllPickupStoresAccountWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStoresAccountColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStoresAccountWhereHasConditions!]
|
|
OR - [QueryAllPickupStoresAccountWhereHasConditions!]
|
|
HAS - QueryAllPickupStoresAccountWhereHasConditionsRelation
|
Example
{
"column": "DOMAIN",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllPickupStoresAccountWhereHasConditions],
"OR": [QueryAllPickupStoresAccountWhereHasConditions],
"HAS": QueryAllPickupStoresAccountWhereHasConditionsRelation
}
QueryAllPickupStoresAccountWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStoresAccountWhereHasConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryAllPickupStoresAccountWhereHasConditions
}
QueryAllPickupStoresAddressColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"STREET"
QueryAllPickupStoresAddressWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStoresAddressColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStoresAddressWhereHasConditions!]
|
|
OR - [QueryAllPickupStoresAddressWhereHasConditions!]
|
|
HAS - QueryAllPickupStoresAddressWhereHasConditionsRelation
|
Example
{
"column": "STREET",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllPickupStoresAddressWhereHasConditions],
"OR": [QueryAllPickupStoresAddressWhereHasConditions],
"HAS": QueryAllPickupStoresAddressWhereHasConditionsRelation
}
QueryAllPickupStoresAddressWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStoresAddressWhereHasConditions
|
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryAllPickupStoresAddressWhereHasConditions
}
QueryAllPickupStoresOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryAllPickupStoresOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStoresOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "NAME", "order": "ASC"}
QueryAllPickupStoresUserColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
QueryAllPickupStoresUserWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStoresUserColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStoresUserWhereHasConditions!]
|
|
OR - [QueryAllPickupStoresUserWhereHasConditions!]
|
|
HAS - QueryAllPickupStoresUserWhereHasConditionsRelation
|
Example
{
"column": "EMAIL",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllPickupStoresUserWhereHasConditions],
"OR": [QueryAllPickupStoresUserWhereHasConditions],
"HAS": QueryAllPickupStoresUserWhereHasConditionsRelation
}
QueryAllPickupStoresUserWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStoresUserWhereHasConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryAllPickupStoresUserWhereHasConditions
}
QueryAllPickupStoresWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENT_NUMBER"
QueryAllPickupStoresWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllPickupStoresWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllPickupStoresWhereWhereConditions!]
|
|
OR - [QueryAllPickupStoresWhereWhereConditions!]
|
|
HAS - QueryAllPickupStoresWhereWhereConditionsRelation
|
Example
{
"column": "DOCUMENT_NUMBER",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllPickupStoresWhereWhereConditions],
"OR": [QueryAllPickupStoresWhereWhereConditions],
"HAS": QueryAllPickupStoresWhereWhereConditionsRelation
}
QueryAllPickupStoresWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllPickupStoresWhereWhereConditions
|
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryAllPickupStoresWhereWhereConditions
}
QueryAllVehiclesDistributionCenterColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
QueryAllVehiclesDistributionCenterWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllVehiclesDistributionCenterColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllVehiclesDistributionCenterWhereHasConditions!]
|
|
OR - [QueryAllVehiclesDistributionCenterWhereHasConditions!]
|
|
HAS - QueryAllVehiclesDistributionCenterWhereHasConditionsRelation
|
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryAllVehiclesDistributionCenterWhereHasConditions
],
"OR": [
QueryAllVehiclesDistributionCenterWhereHasConditions
],
"HAS": QueryAllVehiclesDistributionCenterWhereHasConditionsRelation
}
QueryAllVehiclesDistributionCenterWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllVehiclesDistributionCenterWhereHasConditions
|
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryAllVehiclesDistributionCenterWhereHasConditions
}
QueryAllVehiclesOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryAllVehiclesOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryAllVehiclesOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "ID", "order": "ASC"}
QueryAllVehiclesVehicleModelColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
QueryAllVehiclesVehicleModelWhereHasConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllVehiclesVehicleModelColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllVehiclesVehicleModelWhereHasConditions!]
|
|
OR - [QueryAllVehiclesVehicleModelWhereHasConditions!]
|
|
HAS - QueryAllVehiclesVehicleModelWhereHasConditionsRelation
|
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllVehiclesVehicleModelWhereHasConditions],
"OR": [QueryAllVehiclesVehicleModelWhereHasConditions],
"HAS": QueryAllVehiclesVehicleModelWhereHasConditionsRelation
}
QueryAllVehiclesVehicleModelWhereHasConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllVehiclesVehicleModelWhereHasConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryAllVehiclesVehicleModelWhereHasConditions
}
QueryAllVehiclesWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"STATUS"
QueryAllVehiclesWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryAllVehiclesWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryAllVehiclesWhereWhereConditions!]
|
|
OR - [QueryAllVehiclesWhereWhereConditions!]
|
|
HAS - QueryAllVehiclesWhereWhereConditionsRelation
|
Example
{
"column": "STATUS",
"operator": "EQ",
"value": Mixed,
"AND": [QueryAllVehiclesWhereWhereConditions],
"OR": [QueryAllVehiclesWhereWhereConditions],
"HAS": QueryAllVehiclesWhereWhereConditionsRelation
}
QueryAllVehiclesWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryAllVehiclesWhereWhereConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryAllVehiclesWhereWhereConditions
}
QueryGetDistributorParentsByNameOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
QueryGetDistributorParentsByNameOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryGetDistributorParentsByNameOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "NAME", "order": "ASC"}
QueryGetShipmentsOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryGetShipmentsOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryGetShipmentsOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "ID", "order": "ASC"}
QueryGetShipmentsWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE"
QueryGetShipmentsWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryGetShipmentsWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryGetShipmentsWhereWhereConditions!]
|
|
OR - [QueryGetShipmentsWhereWhereConditions!]
|
|
HAS - QueryGetShipmentsWhereWhereConditionsRelation
|
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryGetShipmentsWhereWhereConditions],
"OR": [QueryGetShipmentsWhereWhereConditions],
"HAS": QueryGetShipmentsWhereWhereConditionsRelation
}
QueryGetShipmentsWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryGetShipmentsWhereWhereConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryGetShipmentsWhereWhereConditions
}
QueryIncidencesReasonsOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryIncidencesReasonsOrderByOrderByClause
Fields
| Input Field | Description |
|---|---|
column - QueryIncidencesReasonsOrderByColumn!
|
|
order - SortOrder!
|
Example
{"column": "NAME", "order": "ASC"}
QueryIncidencesReasonsWhereColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CATEGORY"
QueryIncidencesReasonsWhereWhereConditions
Fields
| Input Field | Description |
|---|---|
column - QueryIncidencesReasonsWhereColumn
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [QueryIncidencesReasonsWhereWhereConditions!]
|
|
OR - [QueryIncidencesReasonsWhereWhereConditions!]
|
|
HAS - QueryIncidencesReasonsWhereWhereConditionsRelation
|
Example
{
"column": "CATEGORY",
"operator": "EQ",
"value": Mixed,
"AND": [QueryIncidencesReasonsWhereWhereConditions],
"OR": [QueryIncidencesReasonsWhereWhereConditions],
"HAS": QueryIncidencesReasonsWhereWhereConditionsRelation
}
QueryIncidencesReasonsWhereWhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - QueryIncidencesReasonsWhereWhereConditions
|
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryIncidencesReasonsWhereWhereConditions
}
RefreshTokenInput
Fields
| Input Field | Description |
|---|---|
refresh_token - String
|
Example
{"refresh_token": "xyz789"}
RefreshTokenPayload
RegisterInput
RegisterResponse
Fields
| Field Name | Description |
|---|---|
tokens - AuthPayload
|
|
status - RegisterStatuses!
|
Example
{"tokens": AuthPayload, "status": "MUST_VERIFY_EMAIL"}
RegisterStatuses
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MUST_VERIFY_EMAIL"
RemoveDocumentationFromVehicleInput
Fields
| Input Field | Description |
|---|---|
files - RemoveFilesFromVehicle
|
Example
{"files": RemoveFilesFromVehicle}
RemoveFilesFromVehicle
Fields
| Input Field | Description |
|---|---|
disconnect - [DisconnectVehicleFiles!]
|
Example
{"disconnect": [DisconnectVehicleFiles]}
Route
Example
{
"id": "4",
"uuid": "xyz789",
"date": "2007-12-03",
"day_number": 123,
"name": "abc123",
"distance": 123.45,
"net_distance": 987.65,
"number_of_shipments": 123,
"polylines": "abc123",
"pending": 123,
"delivered": 987,
"failed": 987,
"finalFailed": 987,
"finished": false,
"start_time": "xyz789"
}
SQLOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQ"
SentEmailTemplate
Example
{
"id": 4,
"event": "xyz789",
"recipient": "xyz789",
"recipient_name": "xyz789",
"sendable_id": "4",
"sendable_type": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
Shipment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
batch - Batch
|
|
date - Date
|
|
originAddress - Address
|
|
destinationAddress - Address
|
|
proofOfDelivery - ProofsOfDelivery
|
|
packages - [Package!]!
|
|
status - ShipmentStatus!
|
|
tracking_number - String!
|
|
type - ShipmentTypes!
|
|
weight - Int
|
|
complete - Boolean!
|
|
cancellable - Boolean
|
|
cancel_reason - String
|
|
notes - String
|
|
number_of_delivery_attempts - Int
|
|
max_attempts_exceeded - Boolean
|
|
reference_number - String
|
|
price - Float
|
|
currency - String
|
|
product_category - String
|
|
product_name - String
|
|
pickupStores - [PickupStore]
|
|
pickupStoreShipments - PickupStoreShipmentPivot
|
|
destination_pickup_store - PickupStore
|
|
originPickupStore - PickupStore
|
|
destinationPickupStore - PickupStore
|
|
label - String
|
|
simple_label - String
|
|
digital_label - String
|
|
destinationLocker - Locker
|
|
deliverySlot - BusinessSchedule
|
|
emailsSent - [SentEmailTemplate!]
|
Example
{
"id": 4,
"uuid": "xyz789",
"batch": Batch,
"date": "2007-12-03",
"originAddress": Address,
"destinationAddress": Address,
"proofOfDelivery": ProofsOfDelivery,
"packages": [Package],
"status": "DOCUMENTED",
"tracking_number": "abc123",
"type": "DELIVERY",
"weight": 123,
"complete": true,
"cancellable": false,
"cancel_reason": "xyz789",
"notes": "xyz789",
"number_of_delivery_attempts": 123,
"max_attempts_exceeded": true,
"reference_number": "xyz789",
"price": 123.45,
"currency": "abc123",
"product_category": "abc123",
"product_name": "xyz789",
"pickupStores": [PickupStore],
"pickupStoreShipments": PickupStoreShipmentPivot,
"destination_pickup_store": PickupStore,
"originPickupStore": PickupStore,
"destinationPickupStore": PickupStore,
"label": "xyz789",
"simple_label": "xyz789",
"digital_label": "abc123",
"destinationLocker": Locker,
"deliverySlot": BusinessSchedule,
"emailsSent": [SentEmailTemplate]
}
ShipmentPaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [Shipment!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Shipment]
}
ShipmentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENTED"
ShipmentTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELIVERY"
SocialLoginInput
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
TimePeriod
Example
{
"id": 4,
"uuid": "xyz789",
"start": "xyz789",
"close": "xyz789",
"openingHour": OpeningHour,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
TimePeriodInput
TokenInput
TokenPayload
UpdateBelongsTo
UpdateEmployeesToVehicleBelongsToMany
Fields
| Input Field | Description |
|---|---|
connect - [AssignEmployeeToVehicleInput!]
|
|
disconnect - [ID!]
|
Example
{
"connect": [AssignEmployeeToVehicleInput],
"disconnect": ["4"]
}
UpdateIncidenceInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
level - IncidencesLevel
|
|
status - IncidencesStatus
|
|
notes - String
|
|
incidencesReason - UpdateBelongsTo
|
|
delivery_type - DeliveryType
|
|
resolved - Boolean
|
Example
{
"description": "abc123",
"level": "LOW",
"status": "OPEN",
"notes": "abc123",
"incidencesReason": UpdateBelongsTo,
"delivery_type": "DOOR",
"resolved": false
}
UpdatePassword
UpdatePasswordResponse
UpdatePickupStoreInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
alias - String
|
|
document_number - String
|
|
email - String
|
|
formatted_address - String
|
|
street - String
|
|
phone_number - String
|
|
postal_code - String
|
|
province_id - ID
|
|
city - String
|
|
geolocation_latitude - Float
|
|
geolocation_longitude - Float
|
|
first_name - String
|
|
last_name - String
|
|
max_package_capacity - Int
|
|
account_id - ID
|
|
user_id - ID
|
|
start_deal_date - Date
|
|
finish_deal_date - Date
|
|
account_manager_id - ID
|
|
company_id - ID
|
|
enabled - Boolean
|
|
contact_name - String
|
|
file_id - ID
|
Example
{
"id": "4",
"name": "xyz789",
"alias": "abc123",
"document_number": "xyz789",
"email": "abc123",
"formatted_address": "xyz789",
"street": "xyz789",
"phone_number": "xyz789",
"postal_code": "abc123",
"province_id": "4",
"city": "xyz789",
"geolocation_latitude": 123.45,
"geolocation_longitude": 123.45,
"first_name": "xyz789",
"last_name": "xyz789",
"max_package_capacity": 123,
"account_id": 4,
"user_id": 4,
"start_deal_date": "2007-12-03",
"finish_deal_date": "2007-12-03",
"account_manager_id": 4,
"company_id": "4",
"enabled": true,
"contact_name": "xyz789",
"file_id": "4"
}
UpdatePickupStorePermit
UpdateProofOfDeliveryInput
Fields
| Input Field | Description |
|---|---|
shipment - UpdateBelongsTo
|
|
name - String
|
|
document_number - String
|
|
delivery_type - DeliveryType
|
|
comments - String
|
|
contacted - Boolean
|
Example
{
"shipment": UpdateBelongsTo,
"name": "xyz789",
"document_number": "xyz789",
"delivery_type": "DOOR",
"comments": "abc123",
"contacted": false
}
UpdateVehicleInput
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 - UpdateEmployeesToVehicleBelongsToMany
|
Example
{
"identification_number": "abc123",
"license_plate_number": "abc123",
"status": "ACTIVE",
"account_id": 987,
"vehicle_model_id": 123,
"distribution_center_id": 987,
"employees": UpdateEmployeesToVehicleBelongsToMany
}
Upload
Example
Upload
User
Vehicle
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
identification_number - String
|
|
license_plate_number - String!
|
|
status - VehicleStatus!
|
|
created_at - DateTime!
|
|
updated_at - DateTime!
|
|
account - Account
|
|
distributionCenter - DistributionCenter
|
|
vehicleModel - VehicleModel
|
|
employees - [Employee!]!
|
|
assigned - VehicleEmployeePivot
|
|
current_driver - Employee
|
|
files - [File!]
|
Example
{
"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]
}
VehicleBrand
Example
{
"id": 4,
"uuid": "abc123",
"name": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"vehicleModels": VehicleModel
}
VehicleCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
name - String!
|
|
account - Account
|
|
travel_mode - VehicleCategoryTravelMode!
|
|
fuel_type - VehicleCategoryFuelType
|
|
kg_co2 - Float
|
|
full_name - String
|
|
country - String!
|
|
created_at - DateTime!
|
|
updated_at - DateTime!
|
|
vehicleModels - VehicleModel
|
Example
{
"id": 4,
"uuid": "abc123",
"name": "xyz789",
"account": Account,
"travel_mode": "WALKING",
"fuel_type": "E10",
"kg_co2": 987.65,
"full_name": "xyz789",
"country": "xyz789",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"vehicleModels": VehicleModel
}
VehicleCategoryFuelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"E10"
VehicleCategoryTravelMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"WALKING"
VehicleDocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REGISTRATION_CERTIFICATE"
VehicleEmployeePivot
VehicleModel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
name - String!
|
|
capacity - Float!
|
|
standard_consumption - Float
|
|
created_at - DateTime!
|
|
updated_at - DateTime!
|
|
account - Account
|
|
vehicleBrand - VehicleBrand
|
|
vehicleCategory - VehicleCategory
|
Example
{
"id": 4,
"uuid": "xyz789",
"name": "abc123",
"capacity": 987.65,
"standard_consumption": 987.65,
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"account": Account,
"vehicleBrand": VehicleBrand,
"vehicleCategory": VehicleCategory
}
VehiclePaginator
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
|
data - [Vehicle!]!
|
Example
{
"paginatorInfo": PaginatorInfo,
"data": [Vehicle]
}
VehicleStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
VehicleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CAR"
VerifyEmailInput
Fields
| Input Field | Description |
|---|---|
token - String!
|
Example
{"token": "abc123"}
WhereConditions
Fields
| Input Field | Description |
|---|---|
column - String
|
|
operator - SQLOperator
|
|
value - Mixed
|
|
AND - [WhereConditions!]
|
|
OR - [WhereConditions!]
|
|
HAS - WhereConditionsRelation
|
Example
{
"column": "abc123",
"operator": "EQ",
"value": Mixed,
"AND": [WhereConditions],
"OR": [WhereConditions],
"HAS": WhereConditionsRelation
}
WhereConditionsRelation
Fields
| Input Field | Description |
|---|---|
relation - String!
|
|
operator - SQLOperator
|
|
amount - Int
|
|
condition - WhereConditions
|
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": WhereConditions
}