TukLo Last Mile Delivery GraphQL API

Welcome to the TukLo GraphQL API reference! the Last Mile Delivery made simple

This reference includes the complete set of GraphQL types, queries, mutations and subscriptions.

Tuktu is a fast delivery service to provide the best customer experience with our immediate delivery app

By connecting with TukLo, businesses can access to our end to end logistic platform.

Contact

API Support

soporte@tuklo.io

API Endpoints
# Test environment:
https://yourdomain.tuklo.app/graphql
Headers
# Your oauth2 token
Authorization: Bearer token

Authentication

We use Oauth2 authentication -> Login

Refresh token

For refresh the token -> Refresh Token

Queries

allExternalPickupStores

Response

Returns a PickupStorePaginator

Arguments
Name Description
name - String
address - QueryAllExternalPickupStoresAddressWhereHasConditions
orderBy - [QueryAllExternalPickupStoresOrderByOrderByClause!]
first - Int Default = 10
page - Int

Example

Query
query AllExternalPickupStores(
  $name: String,
  $address: QueryAllExternalPickupStoresAddressWhereHasConditions,
  $orderBy: [QueryAllExternalPickupStoresOrderByOrderByClause!],
  $first: Int,
  $page: Int
) {
  allExternalPickupStores(
    name: $name,
    address: $address,
    orderBy: $orderBy,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
  }
}
Variables
{
  "name": "abc123",
  "address": QueryAllExternalPickupStoresAddressWhereHasConditions,
  "orderBy": [
    QueryAllExternalPickupStoresOrderByOrderByClause
  ],
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "allExternalPickupStores": {
      "paginatorInfo": PaginatorInfo,
      "data": [PickupStore]
    }
  }
}

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]
    }
  }
}

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": "abc123",
  "where": QueryAllVehiclesWhereWhereConditions,
  "distributionCenter": QueryAllVehiclesDistributionCenterWhereHasConditions,
  "vehicleModel": QueryAllVehiclesVehicleModelWhereHasConditions,
  "orderBy": [QueryAllVehiclesOrderByOrderByClause],
  "first": 10,
  "page": 987
}
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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
Variables
{"tracking_number": ["xyz789"]}
Response
{
  "data": {
    "findAllShipmentsByTrackingNumbers": [
      {
        "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": "abc123",
        "number_of_delivery_attempts": 123,
        "reference_number": "xyz789",
        "price": 987.65,
        "currency": "abc123",
        "product_category": "abc123",
        "product_name": "xyz789",
        "pickupStores": [PickupStore],
        "pickupStoreShipments": PickupStoreShipmentPivot,
        "destination_pickup_store": PickupStore,
        "originPickupStore": PickupStore,
        "destinationPickupStore": PickupStore,
        "label": "abc123",
        "digital_label": "abc123",
        "destinationLocker": Locker,
        "deliverySlot": BusinessSchedule
      }
    ]
  }
}

findBatch

Response

Returns [Batch]

Arguments
Name Description
tracking_number - String

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
      reference_number
      price
      currency
      product_category
      product_name
      pickupStores {
        ...PickupStoreFragment
      }
      pickupStoreShipments {
        ...PickupStoreShipmentPivotFragment
      }
      destination_pickup_store {
        ...PickupStoreFragment
      }
      originPickupStore {
        ...PickupStoreFragment
      }
      destinationPickupStore {
        ...PickupStoreFragment
      }
      label
      digital_label
      destinationLocker {
        ...LockerFragment
      }
      deliverySlot {
        ...BusinessScheduleFragment
      }
    }
    created_at
    updated_at
  }
}
Variables
{"tracking_number": "xyz789"}
Response
{
  "data": {
    "findBatch": [
      {
        "id": "4",
        "uuid": "xyz789",
        "dimensions_length": 987,
        "dimensions_width": 123,
        "dimensions_height": 987,
        "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"
      }
    ]
  }
}

findExternalPickupStore

Response

Returns a PickupStore

Arguments
Name Description
uuid - String

Example

Query
query FindExternalPickupStore($uuid: String) {
  findExternalPickupStore(uuid: $uuid) {
    id
    uuid
    name
    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
    }
    businessSchedule {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
    file {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"uuid": "abc123"}
Response
{
  "data": {
    "findExternalPickupStore": {
      "id": "4",
      "uuid": "xyz789",
      "name": "xyz789",
      "fiscal_name": "abc123",
      "document_number": "abc123",
      "email": "xyz789",
      "phone_number": "abc123",
      "max_package_capacity": 987,
      "current_package_capacity": 123,
      "address": Address,
      "businessSchedule": BusinessSchedule,
      "file": File
    }
  }
}

findPackageByTrackingNumber

Response

Returns a Package

Arguments
Name Description
tracking_number - String!

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
      reference_number
      price
      currency
      product_category
      product_name
      pickupStores {
        ...PickupStoreFragment
      }
      pickupStoreShipments {
        ...PickupStoreShipmentPivotFragment
      }
      destination_pickup_store {
        ...PickupStoreFragment
      }
      originPickupStore {
        ...PickupStoreFragment
      }
      destinationPickupStore {
        ...PickupStoreFragment
      }
      label
      digital_label
      destinationLocker {
        ...LockerFragment
      }
      deliverySlot {
        ...BusinessScheduleFragment
      }
    }
    tracking_number
    status
    dimensions_length
    dimensions_width
    dimensions_height
    volume_weight
    weight
    created_at
    updated_at
    packagesTracking {
      id
      uuid
      status
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
  }
}
Variables
{"tracking_number": "xyz789"}
Response
{
  "data": {
    "findPackageByTrackingNumber": {
      "id": 4,
      "uuid": "xyz789",
      "shipment": Shipment,
      "tracking_number": "abc123",
      "status": "DOCUMENTED",
      "dimensions_length": 123,
      "dimensions_width": 987,
      "dimensions_height": 987,
      "volume_weight": 987,
      "weight": 987,
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z",
      "packagesTracking": [PackageTracking]
    }
  }
}

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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
Variables
{"tracking_number": "abc123"}
Response
{
  "data": {
    "findShipment": [
      {
        "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": "abc123",
        "number_of_delivery_attempts": 987,
        "reference_number": "xyz789",
        "price": 987.65,
        "currency": "abc123",
        "product_category": "xyz789",
        "product_name": "abc123",
        "pickupStores": [PickupStore],
        "pickupStoreShipments": PickupStoreShipmentPivot,
        "destination_pickup_store": PickupStore,
        "originPickupStore": PickupStore,
        "destinationPickupStore": PickupStore,
        "label": "abc123",
        "digital_label": "xyz789",
        "destinationLocker": Locker,
        "deliverySlot": BusinessSchedule
      }
    ]
  }
}

findVehicle

Response

Returns a Vehicle

Arguments
Name Description
uuid - String

Example

Query
query FindVehicle($uuid: String) {
  findVehicle(uuid: $uuid) {
    id
    uuid
    identification_number
    license_plate_number
    status
    created_at
    updated_at
    account {
      id
      uuid
      name
    }
    distributionCenter {
      id
      uuid
      name
      account {
        ...AccountFragment
      }
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    vehicleModel {
      id
      uuid
      name
      capacity
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"uuid": "xyz789"}
Response
{
  "data": {
    "findVehicle": {
      "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]
    }
  }
}

findVehicleById

Response

Returns a Vehicle

Arguments
Name Description
id - ID!

Example

Query
query FindVehicleById($id: ID!) {
  findVehicleById(id: $id) {
    id
    uuid
    identification_number
    license_plate_number
    status
    created_at
    updated_at
    account {
      id
      uuid
      name
    }
    distributionCenter {
      id
      uuid
      name
      account {
        ...AccountFragment
      }
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    vehicleModel {
      id
      uuid
      name
      capacity
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "findVehicleById": {
      "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]
    }
  }
}

getShipments

Response

Returns [Shipment!]!

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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
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": "abc123",
        "type": "DELIVERY",
        "weight": 123,
        "complete": false,
        "cancellable": true,
        "cancel_reason": "xyz789",
        "notes": "abc123",
        "number_of_delivery_attempts": 123,
        "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": "abc123",
        "digital_label": "xyz789",
        "destinationLocker": Locker,
        "deliverySlot": BusinessSchedule
      }
    ]
  }
}

packagesTrackingByTrackingNumber

Response

Returns [PackageTracking!]

Arguments
Name Description
tracking_number - String!

Example

Query
query PackagesTrackingByTrackingNumber($tracking_number: String!) {
  packagesTrackingByTrackingNumber(tracking_number: $tracking_number) {
    id
    uuid
    status
    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": "xyz789"}
Response
{
  "data": {
    "packagesTrackingByTrackingNumber": [
      {
        "id": 4,
        "uuid": "abc123",
        "status": "DOCUMENTED",
        "address": Address,
        "created_at": "2007-12-03T10:15:30Z",
        "updated_at": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

shipmentsPickupStore

Response

Returns a ShipmentPaginator

Arguments
Name Description
pickup_store_id - ID!
status - [String]
final_status - FinalStatusTypes
in_store - Boolean
status_type - [String]
created_at - [String]
search - String
first - Int Default = 10
page - Int

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
      reference_number
      price
      currency
      product_category
      product_name
      pickupStores {
        ...PickupStoreFragment
      }
      pickupStoreShipments {
        ...PickupStoreShipmentPivotFragment
      }
      destination_pickup_store {
        ...PickupStoreFragment
      }
      originPickupStore {
        ...PickupStoreFragment
      }
      destinationPickupStore {
        ...PickupStoreFragment
      }
      label
      digital_label
      destinationLocker {
        ...LockerFragment
      }
      deliverySlot {
        ...BusinessScheduleFragment
      }
    }
  }
}
Variables
{
  "pickup_store_id": 4,
  "status": ["xyz789"],
  "final_status": "PENDING",
  "in_store": false,
  "status_type": ["xyz789"],
  "created_at": ["xyz789"],
  "search": "xyz789",
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "shipmentsPickupStore": {
      "paginatorInfo": PaginatorInfo,
      "data": [Shipment]
    }
  }
}

Mutations

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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
Variables
{
  "shipment_id": "4",
  "deliverySlot": [DeliverySlotInput]
}
Response
{
  "data": {
    "addDeliverySlotToShipment": {
      "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": false,
      "cancellable": false,
      "cancel_reason": "abc123",
      "notes": "xyz789",
      "number_of_delivery_attempts": 123,
      "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",
      "digital_label": "xyz789",
      "destinationLocker": Locker,
      "deliverySlot": BusinessSchedule
    }
  }
}

addDocumentationToVehicle

Response

Returns a Vehicle!

Arguments
Name Description
id - ID!
input - AddDocumentationToVehicleInput!

Example

Query
mutation AddDocumentationToVehicle(
  $id: ID!,
  $input: AddDocumentationToVehicleInput!
) {
  addDocumentationToVehicle(
    id: $id,
    input: $input
  ) {
    id
    uuid
    identification_number
    license_plate_number
    status
    created_at
    updated_at
    account {
      id
      uuid
      name
    }
    distributionCenter {
      id
      uuid
      name
      account {
        ...AccountFragment
      }
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    vehicleModel {
      id
      uuid
      name
      capacity
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"id": 4, "input": AddDocumentationToVehicleInput}
Response
{
  "data": {
    "addDocumentationToVehicle": {
      "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]
    }
  }
}

assignEmployee

Response

Returns a String

Arguments
Name Description
id - ID!
input - AssignEmployeeInput!

Example

Query
mutation AssignEmployee(
  $id: ID!,
  $input: AssignEmployeeInput!
) {
  assignEmployee(
    id: $id,
    input: $input
  )
}
Variables
{"id": 4, "input": AssignEmployeeInput}
Response
{"data": {"assignEmployee": "xyz789"}}

assignVehicle

Response

Returns an Employee!

Arguments
Name Description
id - ID!
input - AssignEmployeeVehicleInput!

Example

Query
mutation AssignVehicle(
  $id: ID!,
  $input: AssignEmployeeVehicleInput!
) {
  assignVehicle(
    id: $id,
    input: $input
  ) {
    id
    uuid
    account {
      id
      uuid
      name
    }
    company {
      id
      uuid
      commercial_name
      corporate_name
      phone_number
    }
    first_name
    last_name
    full_name
    email
    phone_number
    enabled
    available_for_order
    vehicles {
      id
      uuid
      identification_number
      license_plate_number
      status
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      distributionCenter {
        ...DistributionCenterFragment
      }
      vehicleModel {
        ...VehicleModelFragment
      }
      employees {
        ...EmployeeFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_driver {
        ...EmployeeFragment
      }
      files {
        ...FileFragment
      }
    }
    assigned {
      id
      from_date
      to_date
    }
    current_vehicle {
      id
      uuid
      identification_number
      license_plate_number
      status
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      distributionCenter {
        ...DistributionCenterFragment
      }
      vehicleModel {
        ...VehicleModelFragment
      }
      employees {
        ...EmployeeFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_driver {
        ...EmployeeFragment
      }
      files {
        ...FileFragment
      }
    }
    vehicle_type
  }
}
Variables
{
  "id": "4",
  "input": AssignEmployeeVehicleInput
}
Response
{
  "data": {
    "assignVehicle": {
      "id": "4",
      "uuid": "xyz789",
      "account": Account,
      "company": Company,
      "first_name": "abc123",
      "last_name": "xyz789",
      "full_name": "abc123",
      "email": "abc123",
      "phone_number": "xyz789",
      "enabled": false,
      "available_for_order": false,
      "vehicles": [Vehicle],
      "assigned": VehicleEmployeePivot,
      "current_vehicle": Vehicle,
      "vehicle_type": "CAR"
    }
  }
}

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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
Variables
{"id": 4, "reason": "SELLER_CANCEL"}
Response
{
  "data": {
    "cancelShipment": {
      "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": false,
      "cancellable": false,
      "cancel_reason": "xyz789",
      "notes": "xyz789",
      "number_of_delivery_attempts": 987,
      "reference_number": "xyz789",
      "price": 987.65,
      "currency": "abc123",
      "product_category": "abc123",
      "product_name": "abc123",
      "pickupStores": [PickupStore],
      "pickupStoreShipments": PickupStoreShipmentPivot,
      "destination_pickup_store": PickupStore,
      "originPickupStore": PickupStore,
      "destinationPickupStore": PickupStore,
      "label": "abc123",
      "digital_label": "xyz789",
      "destinationLocker": Locker,
      "deliverySlot": BusinessSchedule
    }
  }
}

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
      reference_number
      price
      currency
      product_category
      product_name
      pickupStores {
        ...PickupStoreFragment
      }
      pickupStoreShipments {
        ...PickupStoreShipmentPivotFragment
      }
      destination_pickup_store {
        ...PickupStoreFragment
      }
      originPickupStore {
        ...PickupStoreFragment
      }
      destinationPickupStore {
        ...PickupStoreFragment
      }
      label
      digital_label
      destinationLocker {
        ...LockerFragment
      }
      deliverySlot {
        ...BusinessScheduleFragment
      }
    }
    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": 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"
    }
  }
}

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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
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": 123,
      "complete": false,
      "cancellable": false,
      "cancel_reason": "xyz789",
      "notes": "abc123",
      "number_of_delivery_attempts": 987,
      "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",
      "digital_label": "abc123",
      "destinationLocker": Locker,
      "deliverySlot": BusinessSchedule
    }
  }
}

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
      created_at
      updated_at
      packagesTracking {
        ...PackageTrackingFragment
      }
    }
    status
    tracking_number
    type
    weight
    complete
    cancellable
    cancel_reason
    notes
    number_of_delivery_attempts
    reference_number
    price
    currency
    product_category
    product_name
    pickupStores {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    pickupStoreShipments {
      pickup_store_id
      status
      type
      in_store
      created_at
      updated_at
    }
    destination_pickup_store {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    originPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    destinationPickupStore {
      id
      uuid
      name
      fiscal_name
      document_number
      email
      phone_number
      max_package_capacity
      current_package_capacity
      address {
        ...AddressFragment
      }
      businessSchedule {
        ...BusinessScheduleFragment
      }
      file {
        ...FileFragment
      }
    }
    label
    digital_label
    destinationLocker {
      id
      uuid
      external_id
      name
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    deliverySlot {
      id
      uuid
      model_id
      model_type
      current
      openingHours {
        ...OpeningHourFragment
      }
      model {
        ... on PickupStore {
          ...PickupStoreFragment
        }
      }
    }
  }
}
Variables
{"input": CreateShipmentLabelInput}
Response
{
  "data": {
    "createShipmentLabel": {
      "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": true,
      "cancellable": false,
      "cancel_reason": "xyz789",
      "notes": "abc123",
      "number_of_delivery_attempts": 123,
      "reference_number": "abc123",
      "price": 987.65,
      "currency": "xyz789",
      "product_category": "xyz789",
      "product_name": "abc123",
      "pickupStores": [PickupStore],
      "pickupStoreShipments": PickupStoreShipmentPivot,
      "destination_pickup_store": PickupStore,
      "originPickupStore": PickupStore,
      "destinationPickupStore": PickupStore,
      "label": "xyz789",
      "digital_label": "abc123",
      "destinationLocker": Locker,
      "deliverySlot": BusinessSchedule
    }
  }
}

createVehicle

Response

Returns a Vehicle!

Arguments
Name Description
input - CreateVehicleInput!

Example

Query
mutation CreateVehicle($input: CreateVehicleInput!) {
  createVehicle(input: $input) {
    id
    uuid
    identification_number
    license_plate_number
    status
    created_at
    updated_at
    account {
      id
      uuid
      name
    }
    distributionCenter {
      id
      uuid
      name
      account {
        ...AccountFragment
      }
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    vehicleModel {
      id
      uuid
      name
      capacity
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"input": CreateVehicleInput}
Response
{
  "data": {
    "createVehicle": {
      "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]
    }
  }
}

deleteAssignVehicle

Response

Returns an Employee!

Arguments
Name Description
id - ID!
input - DeleteAssignEmployeeVehicleInput!

Example

Query
mutation DeleteAssignVehicle(
  $id: ID!,
  $input: DeleteAssignEmployeeVehicleInput!
) {
  deleteAssignVehicle(
    id: $id,
    input: $input
  ) {
    id
    uuid
    account {
      id
      uuid
      name
    }
    company {
      id
      uuid
      commercial_name
      corporate_name
      phone_number
    }
    first_name
    last_name
    full_name
    email
    phone_number
    enabled
    available_for_order
    vehicles {
      id
      uuid
      identification_number
      license_plate_number
      status
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      distributionCenter {
        ...DistributionCenterFragment
      }
      vehicleModel {
        ...VehicleModelFragment
      }
      employees {
        ...EmployeeFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_driver {
        ...EmployeeFragment
      }
      files {
        ...FileFragment
      }
    }
    assigned {
      id
      from_date
      to_date
    }
    current_vehicle {
      id
      uuid
      identification_number
      license_plate_number
      status
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      distributionCenter {
        ...DistributionCenterFragment
      }
      vehicleModel {
        ...VehicleModelFragment
      }
      employees {
        ...EmployeeFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_driver {
        ...EmployeeFragment
      }
      files {
        ...FileFragment
      }
    }
    vehicle_type
  }
}
Variables
{"id": 4, "input": DeleteAssignEmployeeVehicleInput}
Response
{
  "data": {
    "deleteAssignVehicle": {
      "id": "4",
      "uuid": "abc123",
      "account": Account,
      "company": Company,
      "first_name": "xyz789",
      "last_name": "xyz789",
      "full_name": "abc123",
      "email": "abc123",
      "phone_number": "abc123",
      "enabled": true,
      "available_for_order": true,
      "vehicles": [Vehicle],
      "assigned": VehicleEmployeePivot,
      "current_vehicle": Vehicle,
      "vehicle_type": "CAR"
    }
  }
}

deleteComment

Response

Returns a Comment!

Arguments
Name Description
id - ID!

Example

Query
mutation DeleteComment($id: ID!) {
  deleteComment(id: $id) {
    id
    uuid
    body
    created_at
    updated_at
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteComment": {
      "id": "4",
      "uuid": "abc123",
      "body": "abc123",
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z"
    }
  }
}

deleteCommentContract

Response

Returns a Comment!

Arguments
Name Description
id - ID!
input - DeleteCommentContractInput!

Example

Query
mutation DeleteCommentContract(
  $id: ID!,
  $input: DeleteCommentContractInput!
) {
  deleteCommentContract(
    id: $id,
    input: $input
  ) {
    id
    uuid
    body
    created_at
    updated_at
  }
}
Variables
{"id": 4, "input": DeleteCommentContractInput}
Response
{
  "data": {
    "deleteCommentContract": {
      "id": 4,
      "uuid": "abc123",
      "body": "xyz789",
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z"
    }
  }
}

deleteOrderIncidence

Response

Returns a Comment!

Arguments
Name Description
id - ID!

Example

Query
mutation DeleteOrderIncidence($id: ID!) {
  deleteOrderIncidence(id: $id) {
    id
    uuid
    body
    created_at
    updated_at
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteOrderIncidence": {
      "id": "4",
      "uuid": "abc123",
      "body": "abc123",
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z"
    }
  }
}

deleteVehicle

Response

Returns a Vehicle

Arguments
Name Description
id - ID!

Example

Query
mutation DeleteVehicle($id: ID!) {
  deleteVehicle(id: $id) {
    id
    uuid
    identification_number
    license_plate_number
    status
    created_at
    updated_at
    account {
      id
      uuid
      name
    }
    distributionCenter {
      id
      uuid
      name
      account {
        ...AccountFragment
      }
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    vehicleModel {
      id
      uuid
      name
      capacity
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteVehicle": {
      "id": "4",
      "uuid": "abc123",
      "identification_number": "abc123",
      "license_plate_number": "abc123",
      "status": "ACTIVE",
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z",
      "account": Account,
      "distributionCenter": DistributionCenter,
      "vehicleModel": VehicleModel,
      "employees": [Employee],
      "assigned": VehicleEmployeePivot,
      "current_driver": Employee,
      "files": [File]
    }
  }
}

forgotPassword

Response

Returns a ForgotPasswordResponse!

Arguments
Name Description
input - ForgotPasswordInput!

Example

Query
mutation ForgotPassword($input: ForgotPasswordInput!) {
  forgotPassword(input: $input) {
    status
    message
  }
}
Variables
{"input": ForgotPasswordInput}
Response
{
  "data": {
    "forgotPassword": {
      "status": "xyz789",
      "message": "abc123"
    }
  }
}

getClientToken

Response

Returns a TokenPayload!

Arguments
Name Description
input - TokenInput

Example

Query
mutation GetClientToken($input: TokenInput) {
  getClientToken(input: $input) {
    access_token
    refresh_token
    expires_in
    token_type
  }
}
Variables
{"input": TokenInput}
Response
{
  "data": {
    "getClientToken": {
      "access_token": "abc123",
      "refresh_token": "abc123",
      "expires_in": 987,
      "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": "xyz789",
      "expires_in": 987,
      "token_type": "abc123",
      "user": User
    }
  }
}

logout

Response

Returns a LogoutResponse!

Example

Query
mutation Logout {
  logout {
    status
    message
  }
}
Response
{
  "data": {
    "logout": {
      "status": "abc123",
      "message": "xyz789"
    }
  }
}

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": "xyz789",
      "expires_in": 987,
      "token_type": "xyz789"
    }
  }
}

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": 123,
      "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
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
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]
    }
  }
}

socialLogin

Response

Returns an AuthPayload!

Arguments
Name Description
input - SocialLoginInput!

Example

Query
mutation SocialLogin($input: SocialLoginInput!) {
  socialLogin(input: $input) {
    access_token
    refresh_token
    expires_in
    token_type
    user {
      id
      uuid
      username
      email
      first_name
      last_name
      full_name
    }
  }
}
Variables
{"input": SocialLoginInput}
Response
{
  "data": {
    "socialLogin": {
      "access_token": "xyz789",
      "refresh_token": "xyz789",
      "expires_in": 123,
      "token_type": "abc123",
      "user": User
    }
  }
}

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": "xyz789"}}

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": "xyz789",
      "message": "xyz789"
    }
  }
}

updatePassword

Response

Returns an UpdatePasswordResponse!

Arguments
Name Description
input - UpdatePassword!

Example

Query
mutation UpdatePassword($input: UpdatePassword!) {
  updatePassword(input: $input) {
    status
    message
  }
}
Variables
{"input": UpdatePassword}
Response
{
  "data": {
    "updatePassword": {
      "status": "abc123",
      "message": "xyz789"
    }
  }
}

updateVehicle

Response

Returns a Vehicle!

Arguments
Name Description
id - ID!
input - UpdateVehicleInput!

Example

Query
mutation UpdateVehicle(
  $id: ID!,
  $input: UpdateVehicleInput!
) {
  updateVehicle(
    id: $id,
    input: $input
  ) {
    id
    uuid
    identification_number
    license_plate_number
    status
    created_at
    updated_at
    account {
      id
      uuid
      name
    }
    distributionCenter {
      id
      uuid
      name
      account {
        ...AccountFragment
      }
      address {
        ...AddressFragment
      }
      created_at
      updated_at
    }
    vehicleModel {
      id
      uuid
      name
      capacity
      created_at
      updated_at
      account {
        ...AccountFragment
      }
      vehicleBrand {
        ...VehicleBrandFragment
      }
      vehicleCategory {
        ...VehicleCategoryFragment
      }
    }
    employees {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    assigned {
      id
      from_date
      to_date
    }
    current_driver {
      id
      uuid
      account {
        ...AccountFragment
      }
      company {
        ...CompanyFragment
      }
      first_name
      last_name
      full_name
      email
      phone_number
      enabled
      available_for_order
      vehicles {
        ...VehicleFragment
      }
      assigned {
        ...VehicleEmployeePivotFragment
      }
      current_vehicle {
        ...VehicleFragment
      }
      vehicle_type
    }
    files {
      id
      uuid
      encode_file
    }
  }
}
Variables
{"id": 4, "input": UpdateVehicleInput}
Response
{
  "data": {
    "updateVehicle": {
      "id": 4,
      "uuid": "xyz789",
      "identification_number": "abc123",
      "license_plate_number": "abc123",
      "status": "ACTIVE",
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z",
      "account": Account,
      "distributionCenter": DistributionCenter,
      "vehicleModel": VehicleModel,
      "employees": [Employee],
      "assigned": VehicleEmployeePivot,
      "current_driver": Employee,
      "files": [File]
    }
  }
}

verifyEmail

Response

Returns an AuthPayload!

Arguments
Name Description
input - VerifyEmailInput!

Example

Query
mutation VerifyEmail($input: VerifyEmailInput!) {
  verifyEmail(input: $input) {
    access_token
    refresh_token
    expires_in
    token_type
    user {
      id
      uuid
      username
      email
      first_name
      last_name
      full_name
    }
  }
}
Variables
{"input": VerifyEmailInput}
Response
{
  "data": {
    "verifyEmail": {
      "access_token": "abc123",
      "refresh_token": "xyz789",
      "expires_in": 987,
      "token_type": "xyz789",
      "user": User
    }
  }
}

Types

Account

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
Example
{
  "id": "4",
  "uuid": "abc123",
  "name": "abc123"
}

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": "abc123",
  "name": "abc123",
  "street": "xyz789",
  "formatted_address": "abc123",
  "email": "xyz789",
  "phone_number": "abc123",
  "notes": "xyz789",
  "city": "abc123",
  "postal_code": "xyz789",
  "country": "abc123",
  "geolocation_latitude": 987.65,
  "geolocation_longitude": 123.45,
  "province": Province,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z",
  "updated_token": "xyz789",
  "modified_at": "2007-12-03T10:15:30Z"
}

AssignEmployeeInput

Fields
Input Field Description
employee_id - ID
date - Date
Example
{"employee_id": 4, "date": "2007-12-03"}

AssignEmployeeToVehicleInput

Fields
Input Field Description
employee_id - ID
from_date - String!
to_date - String
Example
{
  "employee_id": "4",
  "from_date": "abc123",
  "to_date": "abc123"
}

AssignEmployeeVehicleInput

Fields
Input Field Description
vehicle_id - ID
from_date - String!
to_date - String
pivot_id - Int
replace_assignation - Boolean
Example
{
  "vehicle_id": 4,
  "from_date": "abc123",
  "to_date": "abc123",
  "pivot_id": 123,
  "replace_assignation": false
}

AuthPayload

Fields
Field Name Description
access_token - String
refresh_token - String
expires_in - Int
token_type - String
user - User
Example
{
  "access_token": "abc123",
  "refresh_token": "abc123",
  "expires_in": 987,
  "token_type": "xyz789",
  "user": User
}

Batch

Fields
Field Name Description
id - ID!
uuid - String!
dimensions_length - Int
dimensions_width - Int
dimensions_height - Int
tracking_number - String!
weight - Int
date - DateTime
status - BatchStatus!
shipments - [Shipment!]!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "uuid": "xyz789",
  "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"
}

BatchStatus

Values
Enum Value Description

DOCUMENTED

HUB

PROCESSED

NO_SHOW

FOR_RETURN

RETURNED

LOST

TRANSFERRED

IN_TRANSIT

Example
"DOCUMENTED"

Boolean

Description

The Boolean scalar type represents true or false.

BusinessSchedule

Fields
Field Name Description
id - ID!
uuid - String!
model_id - ID!
model_type - String!
current - Boolean!
openingHours - [OpeningHour!]!
model - Model!
Example
{
  "id": "4",
  "uuid": "abc123",
  "model_id": "4",
  "model_type": "xyz789",
  "current": true,
  "openingHours": [OpeningHour],
  "model": PickupStore
}

CancelReasons

Values
Enum Value Description

SELLER_CANCEL

BUYER_CANCEL

Example
"SELLER_CANCEL"

Comment

Fields
Field Name Description
id - ID!
uuid - String!
body - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": 4,
  "uuid": "xyz789",
  "body": "abc123",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

Company

Fields
Field Name Description
id - ID!
uuid - String!
commercial_name - String!
corporate_name - String
phone_number - String
Example
{
  "id": 4,
  "uuid": "abc123",
  "commercial_name": "xyz789",
  "corporate_name": "xyz789",
  "phone_number": "abc123"
}

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": "xyz789",
  "comments": "xyz789"
}

CreateAddressInput

Fields
Input Field Description
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_id - ID
Example
{
  "name": "xyz789",
  "street": "xyz789",
  "formatted_address": "abc123",
  "email": "abc123",
  "phone_number": "abc123",
  "notes": "abc123",
  "city": "xyz789",
  "postal_code": "xyz789",
  "country": "abc123",
  "geolocation_latitude": 987.65,
  "geolocation_longitude": 987.65,
  "province_id": "4"
}

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": 123,
  "dimensions_width": 987,
  "dimensions_height": 987,
  "tracking_number": "abc123",
  "weight": 123,
  "date": "2007-12-03",
  "status": "DOCUMENTED",
  "shipments": CreateShipmentHasMany
}

CreateDestinationAddress

Fields
Input Field Description
create - CreateAddressInput
Example
{"create": CreateAddressInput}

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

Fields
Input Field Description
tracking_number - String!
status - ShipmentStatus!
dimensions_length - Int
dimensions_width - Int
dimensions_height - Int
volume_weight - Int
weight - Int
Example
{
  "tracking_number": "xyz789",
  "status": "DOCUMENTED",
  "dimensions_length": 123,
  "dimensions_width": 123,
  "dimensions_height": 987,
  "volume_weight": 123,
  "weight": 987
}

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": true,
  "cancellable": true,
  "notes": "abc123",
  "reference_number": "xyz789",
  "distributor_parent_id": "abc123",
  "price": 123.45,
  "currency": "xyz789",
  "product_category": "xyz789",
  "product_name": "abc123",
  "originPickupStore": ConnectPickupStoreInput,
  "destinationPickupStore": ConnectPickupStoreInput,
  "destination_locker_id": "4"
}

CreateShipmentLabelInput

Fields
Input Field Description
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
Example
{
  "originAddress": CreateOriginAddress,
  "destinationAddress": CreateDestinationAddress,
  "weight": 123,
  "cancellable": true,
  "notes": "xyz789",
  "reference_number": "xyz789",
  "price": 987.65,
  "currency": "xyz789",
  "product_category": "abc123",
  "product_name": "abc123",
  "originPickupStore": ConnectPickupStoreInput,
  "destinationPickupStore": ConnectPickupStoreInput,
  "destinationLocker": ConnectLockerInput,
  "pickupPoint": "abc123"
}

CreateVehicleInput

Fields
Input Field Description
identification_number - String
license_plate_number - String!
status - VehicleStatus!
account_id - Int!
vehicle_model_id - Int!
distribution_center_id - Int!
employees - ConnectEmployeesToVehicleBelongsToMany
Example
{
  "identification_number": "abc123",
  "license_plate_number": "xyz789",
  "status": "ACTIVE",
  "account_id": 987,
  "vehicle_model_id": 123,
  "distribution_center_id": 123,
  "employees": ConnectEmployeesToVehicleBelongsToMany
}

Date

Example
"2007-12-03"

DateTime

Example
"2007-12-03T10:15:30Z"

DaysWeekType

Values
Enum Value Description

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Example
"MONDAY"

DeleteAssignEmployeeVehicleInput

Fields
Input Field Description
vehicle_id - ID!
pivot_id - Int!
Example
{"vehicle_id": 4, "pivot_id": 123}

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

DOOR

LOCKER

MAILBOX

SHOP

PERSON_NEIGHBOR

PERSON_FLATMATE

PERSON_ANOTHER

PUDO

Example
"DOOR"

DisconnectVehicleFiles

Fields
Input Field Description
id - ID
Example
{"id": "4"}

DistributionCenter

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
account - Account
address - Address
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "uuid": "xyz789",
  "name": "abc123",
  "account": Account,
  "address": Address,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

Employee

Fields
Field Name Description
id - ID!
uuid - String!
account - Account
company - Company
first_name - String!
last_name - String!
full_name - String
email - String
phone_number - String
enabled - Boolean!
available_for_order - Boolean
vehicles - [Vehicle!]
assigned - VehicleEmployeePivot
current_vehicle - Vehicle
vehicle_type - VehicleType
Example
{
  "id": "4",
  "uuid": "abc123",
  "account": Account,
  "company": Company,
  "first_name": "xyz789",
  "last_name": "abc123",
  "full_name": "xyz789",
  "email": "xyz789",
  "phone_number": "abc123",
  "enabled": true,
  "available_for_order": true,
  "vehicles": [Vehicle],
  "assigned": VehicleEmployeePivot,
  "current_vehicle": Vehicle,
  "vehicle_type": "CAR"
}

File

Fields
Field Name Description
id - ID!
uuid - String
encode_file - String
Example
{
  "id": "4",
  "uuid": "abc123",
  "encode_file": "abc123"
}

FinalStatusTypes

Values
Enum Value Description

PENDING

COMPLETED

Example
"PENDING"

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45

ForgotPasswordInput

Fields
Input Field Description
email - String!
domain - String
Example
{
  "email": "abc123",
  "domain": "abc123"
}

ForgotPasswordResponse

Fields
Field Name Description
status - String!
message - String
Example
{
  "status": "xyz789",
  "message": "abc123"
}

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

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
123

Locker

Fields
Field Name Description
id - ID!
uuid - String!
external_id - String!
name - String
address - Address!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "uuid": "abc123",
  "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

Fields
Input Field Description
username - String!
password - String!
domain - String!
device_token - String
Example
{
  "username": "xyz789",
  "password": "abc123",
  "domain": "abc123",
  "device_token": "abc123"
}

LogoutResponse

Fields
Field Name Description
status - String!
message - String
Example
{
  "status": "xyz789",
  "message": "abc123"
}

Mixed

Example
Mixed

Model

Types
Union Types

PickupStore

Example
PickupStore

NewPasswordWithCodeInput

Fields
Input Field Description
domain - String
email - String!
token - String!
password - String!
password_confirmation - String!
Example
{
  "domain": "xyz789",
  "email": "xyz789",
  "token": "abc123",
  "password": "abc123",
  "password_confirmation": "xyz789"
}

OpeningHour

Fields
Field Name Description
id - ID!
uuid - String!
day - DaysWeekType!
day_off - Boolean
timePeriods - [TimePeriod!]!
businessSchedule - BusinessSchedule!
Example
{
  "id": 4,
  "uuid": "abc123",
  "day": "MONDAY",
  "day_off": true,
  "timePeriods": [TimePeriod],
  "businessSchedule": BusinessSchedule
}

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
created_at - DateTime
updated_at - DateTime
packagesTracking - [PackageTracking]
Example
{
  "id": 4,
  "uuid": "xyz789",
  "shipment": Shipment,
  "tracking_number": "xyz789",
  "status": "DOCUMENTED",
  "dimensions_length": 987,
  "dimensions_width": 123,
  "dimensions_height": 123,
  "volume_weight": 987,
  "weight": 987,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z",
  "packagesTracking": [PackageTracking]
}

PackageTracking

Fields
Field Name Description
id - ID!
uuid - String!
status - ShipmentStatus
address - Address
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "uuid": "abc123",
  "status": "DOCUMENTED",
  "address": Address,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PaginatorInfo

Fields
Field Name Description
count - Int!
currentPage - Int!
firstItem - Int
hasMorePages - Boolean!
lastItem - Int
lastPage - Int!
perPage - Int!
total - Int!
Example
{
  "count": 123,
  "currentPage": 123,
  "firstItem": 123,
  "hasMorePages": false,
  "lastItem": 123,
  "lastPage": 987,
  "perPage": 123,
  "total": 987
}

PickupStore

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
fiscal_name - String!
document_number - String!
email - String!
phone_number - String
max_package_capacity - Int
current_package_capacity - Int
address - Address!
businessSchedule - BusinessSchedule
file - File
Example
{
  "id": "4",
  "uuid": "xyz789",
  "name": "xyz789",
  "fiscal_name": "abc123",
  "document_number": "abc123",
  "email": "xyz789",
  "phone_number": "abc123",
  "max_package_capacity": 123,
  "current_package_capacity": 987,
  "address": Address,
  "businessSchedule": BusinessSchedule,
  "file": File
}

PickupStorePaginator

Fields
Field Name Description
paginatorInfo - PaginatorInfo!
data - [PickupStore!]!
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [PickupStore]
}

PickupStoreShipmentPivot

Fields
Field Name Description
pickup_store_id - ID!
status - String!
type - String
in_store - Boolean
created_at - DateTime
updated_at - DateTime
Example
{
  "pickup_store_id": 4,
  "status": "xyz789",
  "type": "xyz789",
  "in_store": false,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

ProofsOfDelivery

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
document_number - String
comments - String
shipment - Shipment
delivery_type - DeliveryType
created_at - DateTime
updated_at - DateTime
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

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
code - Int!
country - String
Example
{
  "id": 4,
  "uuid": "abc123",
  "name": "xyz789",
  "code": 123,
  "country": "abc123"
}

QueryAllExternalPickupStoresAddressColumn

Values
Enum Value Description

STREET

POSTAL_CODE

Example
"STREET"

QueryAllExternalPickupStoresAddressWhereHasConditions

Example
{
  "column": "STREET",
  "operator": "EQ",
  "value": Mixed,
  "AND": [
    QueryAllExternalPickupStoresAddressWhereHasConditions
  ],
  "OR": [
    QueryAllExternalPickupStoresAddressWhereHasConditions
  ],
  "HAS": QueryAllExternalPickupStoresAddressWhereHasConditionsRelation
}

QueryAllExternalPickupStoresAddressWhereHasConditionsRelation

Fields
Input Field Description
relation - String!
operator - SQLOperator
amount - Int
condition - QueryAllExternalPickupStoresAddressWhereHasConditions
Example
{
  "relation": "xyz789",
  "operator": "EQ",
  "amount": 987,
  "condition": QueryAllExternalPickupStoresAddressWhereHasConditions
}

QueryAllExternalPickupStoresOrderByColumn

Values
Enum Value Description

NAME

Example
"NAME"

QueryAllExternalPickupStoresOrderByOrderByClause

Fields
Input Field Description
column - QueryAllExternalPickupStoresOrderByColumn!
order - SortOrder!
Example
{"column": "NAME", "order": "ASC"}

QueryAllLockersOrderByColumn

Values
Enum Value Description

EXTERNAL_ID

CREATED_AT

Example
"EXTERNAL_ID"

QueryAllLockersOrderByOrderByClause

Fields
Input Field Description
column - QueryAllLockersOrderByColumn!
order - SortOrder!
Example
{"column": "EXTERNAL_ID", "order": "ASC"}

QueryAllLockersWhereColumn

Values
Enum Value Description

EXTERNAL_ID

NAME

Example
"EXTERNAL_ID"

QueryAllLockersWhereWhereConditions

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
}

QueryAllVehiclesDistributionCenterColumn

Values
Enum Value Description

NAME

Example
"NAME"

QueryAllVehiclesDistributionCenterWhereHasConditions

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": "xyz789",
  "operator": "EQ",
  "amount": 987,
  "condition": QueryAllVehiclesDistributionCenterWhereHasConditions
}

QueryAllVehiclesOrderByColumn

Values
Enum Value Description

ID

IDENTIFICATION_NUMBER

LICENSE_PLATE_NUMBER

STATUS

Example
"ID"

QueryAllVehiclesOrderByOrderByClause

Fields
Input Field Description
column - QueryAllVehiclesOrderByColumn!
order - SortOrder!
Example
{"column": "ID", "order": "ASC"}

QueryAllVehiclesVehicleModelColumn

Values
Enum Value Description

NAME

Example
"NAME"

QueryAllVehiclesVehicleModelWhereHasConditions

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": "abc123",
  "operator": "EQ",
  "amount": 123,
  "condition": QueryAllVehiclesVehicleModelWhereHasConditions
}

QueryAllVehiclesWhereColumn

Values
Enum Value Description

STATUS

DISTRIBUTION_CENTER_ID

MODEL_ID

Example
"STATUS"

QueryAllVehiclesWhereWhereConditions

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": 123,
  "condition": QueryAllVehiclesWhereWhereConditions
}

QueryGetShipmentsOrderByColumn

Values
Enum Value Description

ID

TRACKING_NUMBER

TYPE

STATUS

DATE

NUMBER_OF_PACKAGES

NUMBER_OF_DELIVERY_ATTEMPTS

COMPLETE

Example
"ID"

QueryGetShipmentsOrderByOrderByClause

Fields
Input Field Description
column - QueryGetShipmentsOrderByColumn!
order - SortOrder!
Example
{"column": "ID", "order": "ASC"}

QueryGetShipmentsWhereColumn

Values
Enum Value Description

DATE

STATUS

Example
"DATE"

QueryGetShipmentsWhereWhereConditions

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": "abc123",
  "operator": "EQ",
  "amount": 123,
  "condition": QueryGetShipmentsWhereWhereConditions
}

RefreshTokenInput

Fields
Input Field Description
refresh_token - String
Example
{"refresh_token": "xyz789"}

RefreshTokenPayload

Fields
Field Name Description
access_token - String!
refresh_token - String!
expires_in - Int!
token_type - String!
Example
{
  "access_token": "xyz789",
  "refresh_token": "xyz789",
  "expires_in": 123,
  "token_type": "xyz789"
}

RegisterInput

Fields
Input Field Description
name - String!
email - String!
password - String!
password_confirmation - String!
Example
{
  "name": "xyz789",
  "email": "abc123",
  "password": "xyz789",
  "password_confirmation": "xyz789"
}

RegisterResponse

Fields
Field Name Description
tokens - AuthPayload
status - RegisterStatuses!
Example
{"tokens": AuthPayload, "status": "MUST_VERIFY_EMAIL"}

RegisterStatuses

Values
Enum Value Description

MUST_VERIFY_EMAIL

SUCCESS

Example
"MUST_VERIFY_EMAIL"

RemoveDocumentationFromVehicleInput

Fields
Input Field Description
files - RemoveFilesFromVehicle
Example
{"files": RemoveFilesFromVehicle}

RemoveFilesFromVehicle

Fields
Input Field Description
disconnect - [DisconnectVehicleFiles!]
Example
{"disconnect": [DisconnectVehicleFiles]}

SQLOperator

Values
Enum Value Description

EQ

NEQ

GT

GTE

LT

LTE

LIKE

NOT_LIKE

IN

NOT_IN

BETWEEN

NOT_BETWEEN

IS_NULL

IS_NOT_NULL

Example
"EQ"

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
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
digital_label - String
destinationLocker - Locker
deliverySlot - BusinessSchedule
Example
{
  "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": "xyz789",
  "notes": "abc123",
  "number_of_delivery_attempts": 123,
  "reference_number": "abc123",
  "price": 987.65,
  "currency": "abc123",
  "product_category": "xyz789",
  "product_name": "abc123",
  "pickupStores": [PickupStore],
  "pickupStoreShipments": PickupStoreShipmentPivot,
  "destination_pickup_store": PickupStore,
  "originPickupStore": PickupStore,
  "destinationPickupStore": PickupStore,
  "label": "abc123",
  "digital_label": "abc123",
  "destinationLocker": Locker,
  "deliverySlot": BusinessSchedule
}

ShipmentPaginator

Fields
Field Name Description
paginatorInfo - PaginatorInfo!
data - [Shipment!]!
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [Shipment]
}

ShipmentStatus

Values
Enum Value Description

DOCUMENTED

HUB

READY_FOR_DELIVERY

OUT_FOR_DELIVERY

DELIVERED

FAILED

NO_SHOW

FOR_RETURN

RETURNED

LOST

TRANSFERRED

IN_TRANSIT

BLOCKED

TO_PICKUP_STORE

IN_PICKUP_STORE

IN_DROPOFF_PUDO

IN_PICKUP_PUDO

FOR_PICKUP

PICKED_UP

CANCELED

Example
"DOCUMENTED"

ShipmentTypes

Values
Enum Value Description

DELIVERY

PICKUP

RETURN

Example
"DELIVERY"

SocialLoginInput

Fields
Input Field Description
provider - String!
token - String!
Example
{
  "provider": "abc123",
  "token": "xyz789"
}

SortOrder

Values
Enum Value Description

ASC

DESC

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
"abc123"

TimePeriod

Fields
Field Name Description
id - ID!
uuid - String!
start - String!
close - String!
openingHour - OpeningHour!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": 4,
  "uuid": "xyz789",
  "start": "abc123",
  "close": "abc123",
  "openingHour": OpeningHour,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

TimePeriodInput

Fields
Input Field Description
start - String
close - String
Example
{
  "start": "abc123",
  "close": "xyz789"
}

TokenInput

Fields
Input Field Description
grant_type - String!
client_id - Int!
client_secret - String!
scope - String
Example
{
  "grant_type": "abc123",
  "client_id": 987,
  "client_secret": "xyz789",
  "scope": "abc123"
}

TokenPayload

Fields
Field Name Description
access_token - String!
refresh_token - String!
expires_in - Int!
token_type - String!
Example
{
  "access_token": "xyz789",
  "refresh_token": "abc123",
  "expires_in": 987,
  "token_type": "abc123"
}

UpdateEmployeesToVehicleBelongsToMany

Fields
Input Field Description
connect - [AssignEmployeeToVehicleInput!]
disconnect - [ID!]
Example
{
  "connect": [AssignEmployeeToVehicleInput],
  "disconnect": ["4"]
}

UpdatePassword

Fields
Input Field Description
old_password - String!
password - String!
password_confirmation - String!
Example
{
  "old_password": "xyz789",
  "password": "abc123",
  "password_confirmation": "abc123"
}

UpdatePasswordResponse

Fields
Field Name Description
status - String!
message - String
Example
{
  "status": "xyz789",
  "message": "abc123"
}

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": "xyz789",
  "status": "ACTIVE",
  "account_id": 987,
  "vehicle_model_id": 987,
  "distribution_center_id": 987,
  "employees": UpdateEmployeesToVehicleBelongsToMany
}

User

Fields
Field Name Description
id - ID!
uuid - String!
username - String!
email - String
first_name - String
last_name - String
full_name - String
Example
{
  "id": "4",
  "uuid": "abc123",
  "username": "xyz789",
  "email": "abc123",
  "first_name": "abc123",
  "last_name": "xyz789",
  "full_name": "abc123"
}

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": "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]
}

VehicleBrand

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
created_at - DateTime!
updated_at - DateTime!
account - Account
vehicleModels - VehicleModel
Example
{
  "id": 4,
  "uuid": "xyz789",
  "name": "xyz789",
  "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!
created_at - DateTime!
updated_at - DateTime!
vehicleModels - VehicleModel
Example
{
  "id": 4,
  "uuid": "abc123",
  "name": "xyz789",
  "account": Account,
  "travel_mode": "WALKING",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z",
  "vehicleModels": VehicleModel
}

VehicleCategoryTravelMode

Values
Enum Value Description

WALKING

CYCLING

DRIVING

Example
"WALKING"

VehicleDocumentType

Values
Enum Value Description

REGISTRATION_CERTIFICATE

SPECIFICATION_SHEET

TRANSPORT_CARD

INSURANCE

OTHER

Example
"REGISTRATION_CERTIFICATE"

VehicleEmployeePivot

Fields
Field Name Description
id - ID
from_date - String
to_date - String
Example
{
  "id": 4,
  "from_date": "abc123",
  "to_date": "xyz789"
}

VehicleModel

Fields
Field Name Description
id - ID!
uuid - String!
name - String!
capacity - Float!
created_at - DateTime!
updated_at - DateTime!
account - Account
vehicleBrand - VehicleBrand
vehicleCategory - VehicleCategory
Example
{
  "id": "4",
  "uuid": "xyz789",
  "name": "abc123",
  "capacity": 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

ACTIVE

INACTIVE

ON_GARAGE

BLOCKED

Example
"ACTIVE"

VehicleType

Values
Enum Value Description

CAR

MOTORCYCLE

BICYCLE

VAN

WALKER

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": "abc123",
  "operator": "EQ",
  "amount": 123,
  "condition": WhereConditions
}