Certu API Specification API Reference

Certu API Specification for Integration

API Endpoints

TH SIT server:
https://app-sit.certu.io/api/graphql
MX SIT server:
https://mx-sit.certu.io/api/graphql

Authentication

api_key

API key to authenticate requests

type

apiKey

name

x-api-key

header

x-api-key: 4d318a62-f199-4a63-a090-ee19eb00621a

Order

Order management domain

Order

List Orders

List orders by Shipper Code

shipperCode:

string

Shipper unique identifier

Example

Request Content-Types: application/json

Query

query orders($shipperCode: String!){
  orders(shipperCode: $shipperCode){
    referenceNo
    purchaseNo
    pickupLocation
    deliveryLocation
    contactPerson
    contactPhoneNumber
    receiverCode
    status
    customerRequestedDate
    expirationDate
    appointmentDateTime
    orderComments
    businessChannel
  }
}

Variables

{
  "shipperCode": "string"
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "orders": [
      {
        "referenceNo": "string",
        "purchaseNo": "string",
        "pickupLocation": "string",
        "deliveryLocation": "string",
        "contactPerson": "string",
        "contactPhoneNumber": "string",
        "receiverCode": "string",
        "status": "string",
        "orderComments": "string",
        "businessChannel": "string"
      }
    ]
  }
}

Order

Get Order

Get order by PO number and Shipper Code

shipperCode:

string

Shipper unique identifier

referenceNo:

string

Order reference number

Example

Request Content-Types: application/json

Query

query order($shipperCode: String!, $referenceNo: String!){
  order(shipperCode: $shipperCode, referenceNo: $referenceNo){
    referenceNo
    purchaseNo
    pickupLocation
    deliveryLocation
    contactPerson
    contactPhoneNumber
    receiverCode
    status
    customerRequestedDate
    expirationDate
    appointmentDateTime
    orderComments
    businessChannel
  }
}

Variables

{
  "shipperCode": "string",
  "referenceNo": "string"
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "order": {
      "referenceNo": "string",
      "purchaseNo": "string",
      "pickupLocation": "string",
      "deliveryLocation": "string",
      "contactPerson": "string",
      "contactPhoneNumber": "string",
      "receiverCode": "string",
      "status": "string",
      "orderComments": "string",
      "businessChannel": "string"
    }
  }
}

Order

Create Order

Create order

shipperCode:

string

Shipper unique identifier

input:

CreateOrderInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createOrder($shipperCode: String!, $input: CreateOrderInput!){
  createOrder(shipperCode: $shipperCode, input: $input){
    referenceNo
    purchaseNo
    pickupLocation
    deliveryLocation
    contactPerson
    contactPhoneNumber
    receiverCode
    status
    customerRequestedDate
    expirationDate
    appointmentDateTime
    orderComments
    businessChannel
  }
}

Variables

{
  "shipperCode": "string",
  "input": {
    "referenceNo": "string",
    "purchaseNo": "string",
    "customerRequestedDate": "object",
    "expirationDate": "object",
    "appointmentDateTime": "object",
    "receiverCode": "string",
    "receiverContactName": "string",
    "receiverContactPhoneNumber": "string",
    "pickupLocation": "string",
    "deliveryLocation": "string",
    "deliveryLocationInfo": {
      "contactPerson": "string",
      "contactPhoneNumber": "string",
      "locationName": "string",
      "address": "string",
      "latitude": "number",
      "longitude": "number"
    },
    "orderComments": "string",
    "businessChannel": "string",
    "orderItems": [
      {
        "lineItemIndex": "string",
        "productSku": "string",
        "lot": "string",
        "quantity": "number",
        "orderItemComments": "string"
      }
    ],
    "customField1": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField2": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField3": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField4": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField5": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField6": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField7": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField8": {}
  }
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createOrder": {
      "referenceNo": "string",
      "purchaseNo": "string",
      "pickupLocation": "string",
      "deliveryLocation": "string",
      "contactPerson": "string",
      "contactPhoneNumber": "string",
      "receiverCode": "string",
      "status": "string",
      "orderComments": "string",
      "businessChannel": "string"
    }
  }
}

Order

Update Order

Update order

shipperCode:

string

Shipper unique identifier

referenceNo:

string

Order reference number

input:

UpdateOrderInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateOrder($shipperCode: String!, $referenceNo: String!, $input: UpdateOrderInput!){
  updateOrder(shipperCode: $shipperCode, referenceNo: $referenceNo, input: $input){
    referenceNo
    purchaseNo
    pickupLocation
    deliveryLocation
    contactPerson
    contactPhoneNumber
    receiverCode
    status
    customerRequestedDate
    expirationDate
    appointmentDateTime
    orderComments
    businessChannel
  }
}

Variables

{
  "shipperCode": "string",
  "referenceNo": "string",
  "input": {
    "purchaseNo": "string",
    "customerRequestedDate": "object",
    "expirationDate": "object",
    "appointmentDateTime": "object",
    "receiverCode": "string",
    "receiverContactName": "string",
    "receiverContactPhoneNumber": "string",
    "pickupLocation": "string",
    "deliveryLocation": "string",
    "deliveryLocationInfo": {
      "contactPerson": "string",
      "contactPhoneNumber": "string",
      "locationName": "string",
      "address": "string",
      "latitude": "number",
      "longitude": "number"
    },
    "orderComments": "string",
    "businessChannel": "string",
    "orderItems": [
      {
        "lineItemIndex": "string",
        "productSku": "string",
        "lot": "string",
        "quantity": "number",
        "orderItemComments": "string"
      }
    ],
    "customField1": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField2": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField3": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField4": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField5": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField6": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField7": {
      "fieldName": "string",
      "fieldValue": "string"
    },
    "customField8": {
      "fieldName": "string"
    }
  }
}

Try it now

200 OK

Successful operation

type

Order

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateOrder": {
      "referenceNo": "string",
      "purchaseNo": "string",
      "pickupLocation": "string",
      "deliveryLocation": "string",
      "contactPerson": "string",
      "contactPhoneNumber": "string",
      "receiverCode": "string",
      "status": "string",
      "orderComments": "string",
      "businessChannel": "string"
    }
  }
}

Order

Cancel Order

Cancel order

shipperCode:

string

Shipper unique identifier

referenceNo:

string

Order reference number

input:

CancelOrderInput

(no description)

Example

Request Content-Types: application/json

Query

mutation cancelOrder($shipperCode: String!, $referenceNo: String!, $input: CancelOrderInput!){
  cancelOrder(shipperCode: $shipperCode, referenceNo: $referenceNo, input: $input)
}

Variables

{
  "shipperCode": "string",
  "referenceNo": "string",
  "input": {
    "cancelType": "string",
    "remark": "string"
  }
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "cancelOrder": "string"
  }
}

Receiver

Master data domain

Receiver

List Receivers

List receivers

shipperCode:

string

Shipper unique identifier

Example

Request Content-Types: application/json

Query

query receivers($shipperCode: String!){
  receivers(shipperCode: $shipperCode){
    shipperCode
    receiverCode
    displayName
    name
  }
}

Variables

{
  "shipperCode": "string"
}

Try it now

200 OK

Successful operation

type

Receiver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "receivers": [
      {
        "shipperCode": "string",
        "receiverCode": "string",
        "displayName": "string",
        "name": "string"
      }
    ]
  }
}

Receiver

Get Receiver

Get receiver by code

shipperCode:

string

Shipper unique identifier

receiverCode:

string

Receiver unique identifier

Example

Request Content-Types: application/json

Query

query receiver($shipperCode: String!, $receiverCode: String!){
  receiver(shipperCode: $shipperCode, receiverCode: $receiverCode){
    shipperCode
    receiverCode
    displayName
    name
  }
}

Variables

{
  "shipperCode": "string",
  "receiverCode": "string"
}

Try it now

200 OK

Successful operation

type

Receiver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "receiver": {
      "shipperCode": "string",
      "receiverCode": "string",
      "displayName": "string",
      "name": "string"
    }
  }
}

Receiver

Create Receiver

Create receiver

input:

CreateReceiverInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createReceiver($input: CreateReceiverInput!){
  createReceiver(input: $input){
    shipperCode
    receiverCode
    displayName
    name
  }
}

Variables

{
  "input": {
    "receiverCode": "string",
    "name": "string",
    "displayName": "string",
    "locations": [
      {
        "locationCode": "string",
        "name": "string",
        "displayName": "string",
        "lat": "number",
        "lng": "number",
        "contactPerson": "string",
        "contactNumber": "string",
        "openHour": "string",
        "closeHour": "string",
        "locationType": "string",
        "street1": "string",
        "street2": "string",
        "street3": "string",
        "district": "string",
        "province": "string",
        "country": "string",
        "zipcode": "string",
        "allowedTruckClasses": [
          "string"
        ],
        "loadDurationMinute": "number",
        "unloadDurationMinute": "number",
        "palletExchangeType": "string"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

Receiver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createReceiver": {
      "shipperCode": "string",
      "receiverCode": "string",
      "displayName": "string",
      "name": "string"
    }
  }
}

Receiver

Update Receiver

Update receiver

shipperCode:

string

Shipper unique identifier

receiverCode:

string

Receiver unique identifier

input:

UpdateReceiverInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateReceiver($shipperCode: String!, $receiverCode: String!, $input: UpdateReceiverInput!){
  updateReceiver(shipperCode: $shipperCode, receiverCode: $receiverCode, input: $input){
    shipperCode
    receiverCode
    displayName
    name
  }
}

Variables

{
  "shipperCode": "string",
  "receiverCode": "string",
  "input": {
    "name": "string",
    "displayName": "string",
    "locations": [
      {
        "locationCode": "string",
        "name": "string",
        "displayName": "string",
        "lat": "number",
        "lng": "number",
        "contactPerson": "string",
        "contactNumber": "string",
        "openHour": "string",
        "closeHour": "string",
        "locationType": "string",
        "street1": "string",
        "street2": "string",
        "street3": "string",
        "district": "string",
        "province": "string",
        "country": "string",
        "zipcode": "string",
        "allowedTruckClasses": [
          "string"
        ],
        "loadDurationMinute": "number",
        "unloadDurationMinute": "number",
        "palletExchangeType": "string"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

Receiver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateReceiver": {
      "shipperCode": "string",
      "receiverCode": "string",
      "displayName": "string",
      "name": "string"
    }
  }
}

Product

Master data domain

Product

List Products

List products

shipperCode:

string

Shipper unique identifier

Example

Request Content-Types: application/json

Query

query products($shipperCode: String!){
  products(shipperCode: $shipperCode){
    shipperCode
    productSku
    name
    unit
    volume
    volumeUnit
    volumeBase
    weight
    weightUnit
    baseToCase
    baseToPallet
    dimensionHeight
    dimensionWidth
    dimensionLength
    remark
    price
    saleUnit
    ti
    hi
    caseToPallet
    baseWidth
    baseLength
    baseHeight
    baseWeight
    caseWidth
    caseLength
    caseHeight
    caseWeight
    palletWidth
    palletLength
    palletHeight
    palletWeight
    status
    statusChangedDateTime
  }
}

Variables

{
  "shipperCode": "string"
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "products": [
      {
        "shipperCode": "string",
        "productSku": "string",
        "name": "string",
        "unit": "string",
        "volume": "number",
        "volumeUnit": "string",
        "volumeBase": "number",
        "weight": "number",
        "weightUnit": "string",
        "baseToCase": "integer",
        "baseToPallet": "integer",
        "dimensionHeight": "number",
        "dimensionWidth": "number",
        "dimensionLength": "number",
        "remark": "string",
        "price": "number",
        "saleUnit": "string",
        "ti": "integer",
        "hi": "integer",
        "caseToPallet": "integer",
        "baseWidth": "number",
        "baseLength": "number",
        "baseHeight": "number",
        "baseWeight": "number",
        "caseWidth": "number",
        "caseLength": "number",
        "caseHeight": "number",
        "caseWeight": "number",
        "palletWidth": "number",
        "palletLength": "number",
        "palletHeight": "number",
        "palletWeight": "number",
        "status": "string"
      }
    ]
  }
}

Product

Get Product

Get product by code

shipperCode:

string

Shipper unique identifier

productSku:

string

Product unique identifier

Example

Request Content-Types: application/json

Query

query product($shipperCode: String!, $productSku: String!){
  product(shipperCode: $shipperCode, productSku: $productSku){
    shipperCode
    productSku
    name
    unit
    volume
    volumeUnit
    volumeBase
    weight
    weightUnit
    baseToCase
    baseToPallet
    dimensionHeight
    dimensionWidth
    dimensionLength
    remark
    price
    saleUnit
    ti
    hi
    caseToPallet
    baseWidth
    baseLength
    baseHeight
    baseWeight
    caseWidth
    caseLength
    caseHeight
    caseWeight
    palletWidth
    palletLength
    palletHeight
    palletWeight
    status
    statusChangedDateTime
  }
}

Variables

{
  "shipperCode": "string",
  "productSku": "string"
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "product": {
      "shipperCode": "string",
      "productSku": "string",
      "name": "string",
      "unit": "string",
      "volume": "number",
      "volumeUnit": "string",
      "volumeBase": "number",
      "weight": "number",
      "weightUnit": "string",
      "baseToCase": "integer",
      "baseToPallet": "integer",
      "dimensionHeight": "number",
      "dimensionWidth": "number",
      "dimensionLength": "number",
      "remark": "string",
      "price": "number",
      "saleUnit": "string",
      "ti": "integer",
      "hi": "integer",
      "caseToPallet": "integer",
      "baseWidth": "number",
      "baseLength": "number",
      "baseHeight": "number",
      "baseWeight": "number",
      "caseWidth": "number",
      "caseLength": "number",
      "caseHeight": "number",
      "caseWeight": "number",
      "palletWidth": "number",
      "palletLength": "number",
      "palletHeight": "number",
      "palletWeight": "number",
      "status": "string"
    }
  }
}

Product

Create Product

Create product

shipperCode:

string

Shipper unique identifier

input:

CreateProductInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createProduct($shipperCode: String!, $input: CreateProductInput!){
  createProduct(shipperCode: $shipperCode, input: $input){
    shipperCode
    productSku
    name
    unit
    volume
    volumeUnit
    volumeBase
    weight
    weightUnit
    baseToCase
    baseToPallet
    dimensionHeight
    dimensionWidth
    dimensionLength
    remark
    price
    saleUnit
    ti
    hi
    caseToPallet
    baseWidth
    baseLength
    baseHeight
    baseWeight
    caseWidth
    caseLength
    caseHeight
    caseWeight
    palletWidth
    palletLength
    palletHeight
    palletWeight
    status
    statusChangedDateTime
  }
}

Variables

{
  "shipperCode": "string",
  "input": {
    "productSku": "string",
    "name": "string",
    "baseUnit": "string",
    "saleUnit": "string",
    "weight": "number",
    "weightUnit": "string",
    "volume": "number",
    "volumeBase": "number",
    "volumeUnit": "string",
    "ti": "number",
    "hi": "number",
    "baseToCase": "number",
    "baseToPallet": "number",
    "caseToPallet": "number",
    "baseHeight": "number",
    "baseWidth": "number",
    "baseLength": "number",
    "baseWeight": "number",
    "caseHeight": "number",
    "caseWidth": "number",
    "caseLength": "number",
    "caseWeight": "number",
    "palletHeight": "number",
    "palletWidth": "number",
    "palletLength": "number",
    "palletWeight": "number",
    "price": "number",
    "remark": "string"
  }
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createProduct": {
      "shipperCode": "string",
      "productSku": "string",
      "name": "string",
      "unit": "string",
      "volume": "number",
      "volumeUnit": "string",
      "volumeBase": "number",
      "weight": "number",
      "weightUnit": "string",
      "baseToCase": "integer",
      "baseToPallet": "integer",
      "dimensionHeight": "number",
      "dimensionWidth": "number",
      "dimensionLength": "number",
      "remark": "string",
      "price": "number",
      "saleUnit": "string",
      "ti": "integer",
      "hi": "integer",
      "caseToPallet": "integer",
      "baseWidth": "number",
      "baseLength": "number",
      "baseHeight": "number",
      "baseWeight": "number",
      "caseWidth": "number",
      "caseLength": "number",
      "caseHeight": "number",
      "caseWeight": "number",
      "palletWidth": "number",
      "palletLength": "number",
      "palletHeight": "number",
      "palletWeight": "number",
      "status": "string"
    }
  }
}

Product

Update Product

Update product

shipperCode:

string

Shipper unique identifier

productSku:

string

Product unique identifier

input:

UpdateProductInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateProduct($shipperCode: String!, $productSku: String!, $input: UpdateProductInput!){
  updateProduct(shipperCode: $shipperCode, productSku: $productSku, input: $input){
    shipperCode
    productSku
    name
    unit
    volume
    volumeUnit
    volumeBase
    weight
    weightUnit
    baseToCase
    baseToPallet
    dimensionHeight
    dimensionWidth
    dimensionLength
    remark
    price
    saleUnit
    ti
    hi
    caseToPallet
    baseWidth
    baseLength
    baseHeight
    baseWeight
    caseWidth
    caseLength
    caseHeight
    caseWeight
    palletWidth
    palletLength
    palletHeight
    palletWeight
    status
    statusChangedDateTime
  }
}

Variables

{
  "shipperCode": "string",
  "productSku": "string",
  "input": {
    "name": "string",
    "baseUnit": "string",
    "saleUnit": "string",
    "weightUnit": "string",
    "volumeUnit": "string",
    "ti": "number",
    "hi": "number",
    "baseToCase": "number",
    "baseToPallet": "number",
    "caseToPallet": "number",
    "baseHeight": "number",
    "baseWidth": "number",
    "baseLength": "number",
    "baseWeight": "number",
    "caseHeight": "number",
    "caseWidth": "number",
    "caseLength": "number",
    "caseWeight": "number",
    "palletHeight": "number",
    "palletWidth": "number",
    "palletLength": "number",
    "palletWeight": "number",
    "price": "number",
    "remark": "string"
  }
}

Try it now

200 OK

Successful operation

type

Product

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateProduct": {
      "shipperCode": "string",
      "productSku": "string",
      "name": "string",
      "unit": "string",
      "volume": "number",
      "volumeUnit": "string",
      "volumeBase": "number",
      "weight": "number",
      "weightUnit": "string",
      "baseToCase": "integer",
      "baseToPallet": "integer",
      "dimensionHeight": "number",
      "dimensionWidth": "number",
      "dimensionLength": "number",
      "remark": "string",
      "price": "number",
      "saleUnit": "string",
      "ti": "integer",
      "hi": "integer",
      "caseToPallet": "integer",
      "baseWidth": "number",
      "baseLength": "number",
      "baseHeight": "number",
      "baseWeight": "number",
      "caseWidth": "number",
      "caseLength": "number",
      "caseHeight": "number",
      "caseWeight": "number",
      "palletWidth": "number",
      "palletLength": "number",
      "palletHeight": "number",
      "palletWeight": "number",
      "status": "string"
    }
  }
}

Location

Master data domain

Location

List Locations

List locations

tenantCode:

string

Tenant unique identifier

Example

Request Content-Types: application/json

Query

query locations($tenantCode: String!){
  locations(tenantCode: $tenantCode){
    tenantCode
    locationCode
    displayName
    name
    lat
    lng
    type
    contactPerson
    contactNumber
    street1
    street2
    street3
    district
    province
    country
    zipcode
    allowedTruckClasses
    status
    statusChangedDateTime
  }
}

Variables

{
  "tenantCode": "string"
}

Try it now

200 OK

Successful operation

type

Location

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "locations": [
      {
        "tenantCode": "string",
        "locationCode": "string",
        "displayName": "string",
        "name": "string",
        "lat": "number",
        "lng": "number",
        "contactPerson": "string",
        "contactNumber": "string",
        "street1": "string",
        "street2": "string",
        "street3": "string",
        "district": "string",
        "province": "string",
        "country": "string",
        "zipcode": "string",
        "allowedTruckClasses": [
          null
        ],
        "status": "string"
      }
    ]
  }
}

Location

Get Location

Get location by code

tenantCode:

string

Tenant unique identifier

locationCode:

string

Location unique identifier

Example

Request Content-Types: application/json

Query

query location($tenantCode: String!, $locationCode: String!){
  location(tenantCode: $tenantCode, locationCode: $locationCode){
    tenantCode
    locationCode
    displayName
    name
    lat
    lng
    type
    contactPerson
    contactNumber
    street1
    street2
    street3
    district
    province
    country
    zipcode
    allowedTruckClasses
    status
    statusChangedDateTime
  }
}

Variables

{
  "tenantCode": "string",
  "locationCode": "string"
}

Try it now

200 OK

Successful operation

type

Location

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "location": {
      "tenantCode": "string",
      "locationCode": "string",
      "displayName": "string",
      "name": "string",
      "lat": "number",
      "lng": "number",
      "contactPerson": "string",
      "contactNumber": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string",
      "district": "string",
      "province": "string",
      "country": "string",
      "zipcode": "string",
      "allowedTruckClasses": [
        null
      ],
      "status": "string"
    }
  }
}

Location

Create Location

Create location

tenantCode:

string

Tenant unique identifier

input:

CreateLocationInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createLocation($tenantCode: String!, $input: CreateLocationInput!){
  createLocation(tenantCode: $tenantCode, input: $input){
    tenantCode
    locationCode
    displayName
    name
    lat
    lng
    type
    contactPerson
    contactNumber
    street1
    street2
    street3
    district
    province
    country
    zipcode
    allowedTruckClasses
    status
    statusChangedDateTime
  }
}

Variables

{
  "tenantCode": "string",
  "input": {
    "locationCode": "string",
    "name": "string",
    "displayName": "string",
    "lat": "number",
    "lng": "number",
    "contactPerson": "string",
    "contactNumber": "string",
    "openHour": "string",
    "closeHour": "string",
    "locationType": "string",
    "street1": "string",
    "street2": "string",
    "street3": "string",
    "district": "string",
    "province": "string",
    "country": "string",
    "zipcode": "string",
    "allowedTruckClasses": [
      "string"
    ],
    "loadDurationMinute": "number",
    "unloadDurationMinute": "number",
    "palletExchangeType": "string"
  }
}

Try it now

200 OK

Successful operation

type

Location

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createLocation": {
      "tenantCode": "string",
      "locationCode": "string",
      "displayName": "string",
      "name": "string",
      "lat": "number",
      "lng": "number",
      "contactPerson": "string",
      "contactNumber": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string",
      "district": "string",
      "province": "string",
      "country": "string",
      "zipcode": "string",
      "allowedTruckClasses": [
        null
      ],
      "status": "string"
    }
  }
}

Location

Update Location

Update location

tenantCode:

string

Tenant unique identifier

locationCode:

string

Location unique identifier

input:

UpdateLocationInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateLocation($tenantCode: String!, $locationCode: String!, $input: UpdateLocationInput!){
  updateLocation(tenantCode: $tenantCode, locationCode: $locationCode, input: $input){
    tenantCode
    locationCode
    displayName
    name
    lat
    lng
    type
    contactPerson
    contactNumber
    street1
    street2
    street3
    district
    province
    country
    zipcode
    allowedTruckClasses
    status
    statusChangedDateTime
  }
}

Variables

{
  "tenantCode": "string",
  "locationCode": "string",
  "input": {
    "name": "string",
    "displayName": "string",
    "lat": "number",
    "lng": "number",
    "contactPerson": "string",
    "contactNumber": "string",
    "openHour": "string",
    "closeHour": "string",
    "locationType": "string",
    "street1": "string",
    "street2": "string",
    "street3": "string",
    "district": "string",
    "province": "string",
    "country": "string",
    "zipcode": "string",
    "allowedTruckClasses": [
      "string"
    ],
    "loadDurationMinute": "number",
    "unloadDurationMinute": "number",
    "palletExchangeType": "string"
  }
}

Try it now

200 OK

Successful operation

type

Location

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateLocation": {
      "tenantCode": "string",
      "locationCode": "string",
      "displayName": "string",
      "name": "string",
      "lat": "number",
      "lng": "number",
      "contactPerson": "string",
      "contactNumber": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string",
      "district": "string",
      "province": "string",
      "country": "string",
      "zipcode": "string",
      "allowedTruckClasses": [
        null
      ],
      "status": "string"
    }
  }
}

Device

Fleet management domain

Device

List Devices

List devices

carrierCode:

string

Carrier unique identifier

Example

Request Content-Types: application/json

Query

query devices($carrierCode: String!){
  devices(carrierCode: $carrierCode){
    carrierCode
    deviceCode
    name
    serialNo
    imei
  }
}

Variables

{
  "carrierCode": "string"
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "devices": [
      {
        "carrierCode": "string",
        "deviceCode": "string",
        "name": "string",
        "serialNo": "string",
        "imei": "string"
      }
    ]
  }
}

Device

Get Device

Get device by code

carrierCode:

string

Carrier unique identifier

deviceCode:

string

Device unique identifier

Example

Request Content-Types: application/json

Query

query device($carrierCode: String!, $deviceCode: String!){
  device(carrierCode: $carrierCode, deviceCode: $deviceCode){
    carrierCode
    deviceCode
    name
    serialNo
    imei
  }
}

Variables

{
  "carrierCode": "string",
  "deviceCode": "string"
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "device": {
      "carrierCode": "string",
      "deviceCode": "string",
      "name": "string",
      "serialNo": "string",
      "imei": "string"
    }
  }
}

Device

Create Device

Create device

carrierCode:

string

Carrier unique identifier

input:

CreateDeviceInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createDevice($carrierCode: String!, $input: CreateDeviceInput!){
  createDevice(carrierCode: $carrierCode, input: $input){
    carrierCode
    deviceCode
    name
    serialNo
    imei
  }
}

Variables

{
  "carrierCode": "string",
  "input": {
    "deviceCode": "string",
    "name": "string",
    "serialNo": "string",
    "imei": "string",
    "remark": "string"
  }
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createDevice": {
      "carrierCode": "string",
      "deviceCode": "string",
      "name": "string",
      "serialNo": "string",
      "imei": "string"
    }
  }
}

Device

Update Device

Update device

carrierCode:

string

Carrier unique identifier

deviceCode:

string

Device unique identifier

input:

UpdateDeviceInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateDevice($carrierCode: String!, $deviceCode: String!, $input: UpdateDeviceInput!){
  updateDevice(carrierCode: $carrierCode, deviceCode: $deviceCode, input: $input){
    carrierCode
    deviceCode
    name
    serialNo
    imei
  }
}

Variables

{
  "carrierCode": "string",
  "deviceCode": "string",
  "input": {
    "name": "string",
    "serialNo": "string",
    "imei": "string",
    "remark": "string"
  }
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateDevice": {
      "carrierCode": "string",
      "deviceCode": "string",
      "name": "string",
      "serialNo": "string",
      "imei": "string"
    }
  }
}

Device

Update Device Location

Update device location

deviceCode:

string

Device unique identifier

input:

UpdateDeviceLocationInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateDeviceLocation($deviceCode: String!, $input: UpdateDeviceLocationInput!){
  updateDeviceLocation(deviceCode: $deviceCode, input: $input)
}

Variables

{
  "deviceCode": "string",
  "input": {
    "lat": "number",
    "lng": "number",
    "timestamp": "object"
  }
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateDeviceLocation": "string"
  }
}

Driver

Fleet management domain

Driver

List Drivers

List drivers

carrierCode:

string

Carrier unique identifier

Example

Request Content-Types: application/json

Query

query drivers($carrierCode: String!){
  drivers(carrierCode: $carrierCode){
    displayName
    name
    driverLicense
    phone
    tenantCode
    carrierCode
  }
}

Variables

{
  "carrierCode": "string"
}

Try it now

200 OK

Successful operation

type

TruckDriver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "drivers": [
      {
        "displayName": "string",
        "name": "string",
        "driverLicense": "string",
        "phone": "string",
        "tenantCode": "string",
        "carrierCode": "string"
      }
    ]
  }
}

Driver

Get Driver

Get driver by code

carrierCode:

string

Carrier unique identifier

id:

string

Driver unique identifier

Example

Request Content-Types: application/json

Query

query driver($carrierCode: String!, $id: ID!){
  driver(carrierCode: $carrierCode, id: $id){
    displayName
    name
    driverLicense
    phone
    tenantCode
    carrierCode
  }
}

Variables

{
  "carrierCode": "string",
  "id": "string"
}

Try it now

200 OK

Successful operation

type

TruckDriver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "driver": {
      "displayName": "string",
      "name": "string",
      "driverLicense": "string",
      "phone": "string",
      "tenantCode": "string",
      "carrierCode": "string"
    }
  }
}

Driver

Create Driver

Create driver

carrierCode:

string

Carrier unique identifier

input:

CreateTruckDriverInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createTruckDriver($carrierCode: String!, $input: CreateTruckDriverInput!){
  createTruckDriver(carrierCode: $carrierCode, input: $input){
    displayName
    name
    driverLicense
    phone
    tenantCode
    carrierCode
  }
}

Variables

{
  "carrierCode": "string",
  "input": {
    "carrierCode": "string",
    "displayName": "string",
    "name": "string",
    "driverLicense": "string",
    "phone": "string",
    "countryCode": "string"
  }
}

Try it now

200 OK

Successful operation

type

TruckDriver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createTruckDriver": {
      "displayName": "string",
      "name": "string",
      "driverLicense": "string",
      "phone": "string",
      "tenantCode": "string",
      "carrierCode": "string"
    }
  }
}

Driver

Update Driver

Update driver

carrierCode:

string

Carrier unique identifier

id:

string

Driver unique identifier

input:

UpdateTruckDriverInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateTruckDriver($carrierCode: String!, $id: ID!, $input: UpdateTruckDriverInput!){
  updateTruckDriver(carrierCode: $carrierCode, id: $id, input: $input){
    displayName
    name
    driverLicense
    phone
    tenantCode
    carrierCode
  }
}

Variables

{
  "carrierCode": "string",
  "id": "string",
  "input": {
    "carrierCode": "string",
    "displayName": "string",
    "name": "string",
    "driverLicense": "string",
    "phone": "string",
    "countryCode": "string"
  }
}

Try it now

200 OK

Successful operation

type

TruckDriver

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateTruckDriver": {
      "displayName": "string",
      "name": "string",
      "driverLicense": "string",
      "phone": "string",
      "tenantCode": "string",
      "carrierCode": "string"
    }
  }
}

Truck

Truck management

Truck

List Trucks

List trucks

carrierCode:

string

Carrier unique identifier

Example

Request Content-Types: application/json

Query

query trucks($carrierCode: String!){
  trucks(carrierCode: $carrierCode){
    carrierCode
    licensePlate
    displayName
    maxPalletAmount
    maxWeight
    dimensionHeight
    dimensionWidth
    dimensionLength
  }
}

Variables

{
  "carrierCode": "string"
}

Try it now

200 OK

Successful operation

type

Truck

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "trucks": [
      {
        "carrierCode": "string",
        "licensePlate": "string",
        "displayName": "string",
        "maxPalletAmount": "number",
        "maxWeight": "number",
        "dimensionHeight": "number",
        "dimensionWidth": "number",
        "dimensionLength": "number"
      }
    ]
  }
}

Truck

Get Truck

Get truck by license plate

carrierCode:

string

Carrier unique identifier

licensePlate:

string

Truck unique identifier

Example

Request Content-Types: application/json

Query

query truck($carrierCode: String!, $licensePlate: String!){
  truck(carrierCode: $carrierCode, licensePlate: $licensePlate){
    carrierCode
    licensePlate
    displayName
    maxPalletAmount
    maxWeight
    dimensionHeight
    dimensionWidth
    dimensionLength
  }
}

Variables

{
  "carrierCode": "string",
  "licensePlate": "string"
}

Try it now

200 OK

Successful operation

type

Truck

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "truck": {
      "carrierCode": "string",
      "licensePlate": "string",
      "displayName": "string",
      "maxPalletAmount": "number",
      "maxWeight": "number",
      "dimensionHeight": "number",
      "dimensionWidth": "number",
      "dimensionLength": "number"
    }
  }
}

Truck

Create Truck

Create truck

carrierCode:

string

Carrier unique identifier

input:

CreateTruckInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createTruck($carrierCode: String!, $input: CreateTruckInput!){
  createTruck(carrierCode: $carrierCode, input: $input){
    carrierCode
    licensePlate
    displayName
    maxPalletAmount
    maxWeight
    dimensionHeight
    dimensionWidth
    dimensionLength
  }
}

Variables

{
  "carrierCode": "string",
  "input": {
    "licensePlate": "string",
    "displayName": "string",
    "maxPalletAmount": "number",
    "maxWeight": "number",
    "dimensionHeight": "number",
    "dimensionWidth": "number",
    "dimensionLength": "number",
    "truckClasses": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

Truck

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createTruck": {
      "carrierCode": "string",
      "licensePlate": "string",
      "displayName": "string",
      "maxPalletAmount": "number",
      "maxWeight": "number",
      "dimensionHeight": "number",
      "dimensionWidth": "number",
      "dimensionLength": "number"
    }
  }
}

Truck

Update truck

carrierCode:

string

Carrier unique identifier

licensePlate:

string

Truck unique identifier

input:

UpdateTruckInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateTruck($carrierCode: String!, $licensePlate: String!, $input: UpdateTruckInput!){
  updateTruck(carrierCode: $carrierCode, licensePlate: $licensePlate, input: $input){
    carrierCode
    licensePlate
    displayName
    maxPalletAmount
    maxWeight
    dimensionHeight
    dimensionWidth
    dimensionLength
  }
}

Variables

{
  "carrierCode": "string",
  "licensePlate": "string",
  "input": {
    "displayName": "string",
    "maxPalletAmount": "number",
    "maxWeight": "number",
    "dimensionHeight": "number",
    "dimensionWidth": "number",
    "dimensionLength": "number",
    "truckClasses": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

Truck

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateTruck": {
      "carrierCode": "string",
      "licensePlate": "string",
      "displayName": "string",
      "maxPalletAmount": "number",
      "maxWeight": "number",
      "dimensionHeight": "number",
      "dimensionWidth": "number",
      "dimensionLength": "number"
    }
  }
}

Inventory

Inventory management

Inventory

Get inventory

Get inventory by location code

shipperCode:

string

Shipper unique identifier

locationCode:

string

Location unique identifier

Example

Request Content-Types: application/json

Query

query inventory($shipperCode: String!, $locationCode: String!){
  inventory(shipperCode: $shipperCode, locationCode: $locationCode){
    shipperCode
  }
}

Variables

{
  "shipperCode": "string",
  "locationCode": "string"
}

Try it now

200 OK

Successful operation

type

Inventory

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "inventory": {
      "shipperCode": "string"
    }
  }
}

Inventory

Adjust Inventory Level

Adjust inventory level

shipperCode:

string

Shipper unique identifier

productSKU:

string

Product SKU

locationCode:

string

Location unique identifier

adjustAmount:

integer

Uses positive to increase level, negative to decrease

remark:

string

Remark

Example

Request Content-Types: application/json

Query

mutation adjustInventoryLevel($shipperCode: String!, $productSKU: String!, $locationCode: String!, $adjustAmount: Int!, $remark: String){
  adjustInventoryLevel(shipperCode: $shipperCode, productSKU: $productSKU, locationCode: $locationCode, adjustAmount: $adjustAmount, remark: $remark)
}

Variables

{
  "shipperCode": "string",
  "productSKU": "string",
  "locationCode": "string",
  "adjustAmount": "integer",
  "remark": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "adjustInventoryLevel": "string"
  }
}

Inventory

Sync Inventory Level

Sync inventory level

shipperCode:

string

Shipper unique identifier

productSKU:

string

Product SKU

locationCode:

string

Location unique identifier

amount:

integer

Set to specific amount

remark:

string

Remark

Example

Request Content-Types: application/json

Query

mutation setInventoryLevel($shipperCode: String!, $productSKU: String!, $locationCode: String!, $amount: Int!, $remark: String){
  setInventoryLevel(shipperCode: $shipperCode, productSKU: $productSKU, locationCode: $locationCode, amount: $amount, remark: $remark)
}

Variables

{
  "shipperCode": "string",
  "productSKU": "string",
  "locationCode": "string",
  "amount": "integer",
  "remark": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setInventoryLevel": "string"
  }
}

Schema Definitions

Boolean: boolean

The Boolean scalar type represents true or false.

Example

boolean

CancelOrderInput: object

cancelType: OrderCancellationType: Cancellation type
remark: String: Remark

Example

{
  "cancelType": "string",
  "remark": "string"
}

CreateDeviceInput: object

deviceCode: String: Device unique identifier
name: String: Device name
serialNo: String: Device serial number
imei: String: Device IMEI number
remark: String: Remark

Example

{
  "deviceCode": "string",
  "name": "string",
  "serialNo": "string",
  "imei": "string",
  "remark": "string"
}

CreateLocationInput: object

locationCode: String: Location unique identifier
name: String: Location name
displayName: String: Location display name
lat: Float: Latitude of location
lng: Float: Longitude of location
contactPerson: String: Name of the contact person
contactNumber: String: Phone number of the contact person
openHour: String 08:00: Opening hour with HH:mm format e.g. 08:00
closeHour: String 16:00: Closing hour with HH:mm format e.g. 16:00
locationType: LocationType: Location type e.g. receiver, warehouse
street1: String: Street address
street2: String: More information for street address
street3: String: More information for street address
district: String: District
province: String: Province
country: String: Country
zipcode: String: Zipcode
allowedTruckClasses: TruckClassEnum: Eligible truck classes
loadDurationMinute: Int: Loading time in minute
unloadDurationMinute: Int: Unloading time in minute
palletExchangeType: PalletExchangeTypeEnum: ???

Example

{
  "locationCode": "string",
  "name": "string",
  "displayName": "string",
  "lat": "number",
  "lng": "number",
  "contactPerson": "string",
  "contactNumber": "string",
  "openHour": "string",
  "closeHour": "string",
  "locationType": "string",
  "street1": "string",
  "street2": "string",
  "street3": "string",
  "district": "string",
  "province": "string",
  "country": "string",
  "zipcode": "string",
  "allowedTruckClasses": [
    "string"
  ],
  "loadDurationMinute": "number",
  "unloadDurationMinute": "number",
  "palletExchangeType": "string"
}

CreateOrderInput: object

referenceNo: String: Reference number
purchaseNo: String: Purchase order number
customerRequestedDate: Time: Customer request date to deliver
expirationDate: Time: Deadline to deliver
appointmentDateTime: Time: Pre-specify delivery date & time
receiverCode: String: Receiver unique identifier
receiverContactName: String: Receiver contact name
receiverContactPhoneNumber: String: Receiver contact phone number
pickupLocation: String: Pick-up location unique identifier
deliveryLocation: String: Delivery location unique identifier
deliveryLocationInfo: deliveryLocationInfoInput: Delivery location info (address, contact person, contact number)
orderComments: String
businessChannel: String
orderItems: CreateOrderItemInput: Order items
customField1: CustomFieldInput: Custom fields
customField2: CustomFieldInput
customField3: CustomFieldInput
customField4: CustomFieldInput
customField5: CustomFieldInput
customField6: CustomFieldInput
customField7: CustomFieldInput
customField8: CustomFieldInput
customField9: CustomFieldInput
customField10: CustomFieldInput
customField11: CustomFieldInput
customField12: CustomFieldInput
customField13: CustomFieldInput
customField14: CustomFieldInput
customField15: CustomFieldInput
customField16: CustomFieldInput
customField17: CustomFieldInput
customField18: CustomFieldInput
customField19: CustomFieldInput
customField20: CustomFieldInput

Example

{
  "referenceNo": "string",
  "purchaseNo": "string",
  "customerRequestedDate": "object",
  "expirationDate": "object",
  "appointmentDateTime": "object",
  "receiverCode": "string",
  "receiverContactName": "string",
  "receiverContactPhoneNumber": "string",
  "pickupLocation": "string",
  "deliveryLocation": "string",
  "deliveryLocationInfo": {
    "contactPerson": "string",
    "contactPhoneNumber": "string",
    "locationName": "string",
    "address": "string",
    "latitude": "number",
    "longitude": "number"
  },
  "orderComments": "string",
  "businessChannel": "string",
  "orderItems": [
    {
      "lineItemIndex": "string",
      "productSku": "string",
      "lot": "string",
      "quantity": "number",
      "orderItemComments": "string"
    }
  ],
  "customField1": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField2": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField3": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField4": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField5": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField6": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField7": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField8": {
    "fieldName": "string",
    "fieldValue": "string"
  }
}

CreateOrderItemInput: object

lineItemIndex: String: Unique identifier of a line item
productSku: String: Product SKU
lot: String: Lot of the SKU
quantity: Int: Quantity of product (in base unit)
orderItemComments: String: Remark

Example

{
  "lineItemIndex": "string",
  "productSku": "string",
  "lot": "string",
  "quantity": "number",
  "orderItemComments": "string"
}

CreateProductInput: object

productSku: String: Product SKU
name: String: Product name
baseUnit: String: Product base unit e.g. bottle, pack
saleUnit: String: Product sale unit e.g. case
weight: Float: Product weight
weightUnit: String kg: Product weight unit
volume: Float: Product pallet volume
volumeBase: Float: Product base volume
volumeUnit: String cc: Product volume unit
ti: Int: Number of cases fit in pallet (horizontal)
hi: Int: Number of row fit in pallet (vertical)
baseToCase: Int: Conversion of base to case
baseToPallet: Int: Conversion of base to pallet
caseToPallet: Int: Conversion of case to pallet
baseHeight: Float: Product height
baseWidth: Float: Product Width
baseLength: Float: Product length
baseWeight: Float: Product weight
caseHeight: Float: Case height
caseWidth: Float: Case width
caseLength: Float: Case length
caseWeight: Float: Case weight
palletHeight: Float: Pallet height
palletWidth: Float: Pallet width
palletLength: Float: Pallet length
palletWeight: Float: Pallet weight
price: Float: Product price
remark: String: Remark

Example

{
  "productSku": "string",
  "name": "string",
  "baseUnit": "string",
  "saleUnit": "string",
  "weight": "number",
  "weightUnit": "string",
  "volume": "number",
  "volumeBase": "number",
  "volumeUnit": "string",
  "ti": "number",
  "hi": "number",
  "baseToCase": "number",
  "baseToPallet": "number",
  "caseToPallet": "number",
  "baseHeight": "number",
  "baseWidth": "number",
  "baseLength": "number",
  "baseWeight": "number",
  "caseHeight": "number",
  "caseWidth": "number",
  "caseLength": "number",
  "caseWeight": "number",
  "palletHeight": "number",
  "palletWidth": "number",
  "palletLength": "number",
  "palletWeight": "number",
  "price": "number",
  "remark": "string"
}

CreateReceiverInput: object

receiverCode: String: Receiver unique identifier
name: String: Receiver full name
displayName: String: Receiver display name
locations: CreateLocationInput: Receiver's drop-off locations

Example

{
  "receiverCode": "string",
  "name": "string",
  "displayName": "string",
  "locations": [
    {
      "locationCode": "string",
      "name": "string",
      "displayName": "string",
      "lat": "number",
      "lng": "number",
      "contactPerson": "string",
      "contactNumber": "string",
      "openHour": "string",
      "closeHour": "string",
      "locationType": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string",
      "district": "string",
      "province": "string",
      "country": "string",
      "zipcode": "string",
      "allowedTruckClasses": [
        "string"
      ],
      "loadDurationMinute": "number",
      "unloadDurationMinute": "number",
      "palletExchangeType": "string"
    }
  ]
}

CreateTruckDriverInput: object

carrierCode: String: Carrier unique identifier
displayName: String: Driver display name
name: String: Driver full name
driverLicense: String: Driver license
phone: String: Driver phone number
countryCode: String: Phone number country code

Example

{
  "carrierCode": "string",
  "displayName": "string",
  "name": "string",
  "driverLicense": "string",
  "phone": "string",
  "countryCode": "string"
}

CreateTruckInput: object

licensePlate: String: Truck unique identifier
displayName: String: Truck display name
maxPalletAmount: Float: Maximum truck pallet capacity
maxWeight: Float: Maximum truck weight limit
dimensionHeight: Float: Truck container dimension height
dimensionWidth: Float: Truck container dimension width
dimensionLength: Float: Truck container dimension length
truckClasses: TruckClassEnum: Truck class e.g. 4W, 22W

Example

{
  "licensePlate": "string",
  "displayName": "string",
  "maxPalletAmount": "number",
  "maxWeight": "number",
  "dimensionHeight": "number",
  "dimensionWidth": "number",
  "dimensionLength": "number",
  "truckClasses": [
    "string"
  ]
}

Cursor: object

Example

object

CustomField: object

fieldName: object: Custom field name
return: String arguments: object
fieldValue: object: Custom field value
return: String arguments: object

Example

{
  "fieldName": {
    "return": "string",
    "arguments": {}
  },
  "fieldValue": {
    "return": "string",
    "arguments": {}
  }
}

CustomFieldInput: object

fieldName: String: Custom field name
fieldValue: String: Custom field value

Example

{
  "fieldName": "string",
  "fieldValue": "string"
}

Device: object

carrierCode: object: Carrier unique identifier
return: String arguments: object
deviceCode: object: Device unique identifier
return: String arguments: object
name: object: Device name
return: String arguments: object
serialNo: object: Device serial number
return: String arguments: object
imei: object: Device IMEI number
return: String arguments: object

Example

{
  "carrierCode": {
    "return": "string",
    "arguments": {}
  },
  "deviceCode": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "serialNo": {
    "return": "string",
    "arguments": {}
  },
  "imei": {
    "return": "string",
    "arguments": {}
  }
}

DeviceStatus: string

object unknown
object active
object inactive

Float: number

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

Example

number

ID: object

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

object

Int: number

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

number

Inventory: object

shipperCode: object
return: String arguments: object
location: object
return: Location arguments: object
products: object
return: Product arguments: object

Example

{
  "shipperCode": {
    "return": "string",
    "arguments": {}
  },
  "location": {
    "return": {
      "tenantCode": {
        "return": "string",
        "arguments": {}
      },
      "locationCode": {
        "return": "string",
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "lat": {
        "return": "number",
        "arguments": {}
      },
      "lng": {
        "return": "number",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "contactPerson": {
        "return": "string",
        "arguments": {}
      },
      "contactNumber": {
        "return": "string",
        "arguments": {}
      },
      "street1": {
        "return": "string",
        "arguments": {}
      },
      "street2": {
        "return": "string",
        "arguments": {}
      },
      "street3": {
        "return": "string",
        "arguments": {}
      },
      "district": {
        "return": "string",
        "arguments": {}
      },
      "province": {
        "return": "string",
        "arguments": {}
      },
      "country": {
        "return": "string",
        "arguments": {}
      },
      "zipcode": {
        "return": "string",
        "arguments": {}
      },
      "allowedTruckClasses": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "statusChangedDateTime": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "products": {
    "return": [
      {
        "shipperCode": {
          "return": "string",
          "arguments": {}
        },
        "productSku": {
          "return": "string",
          "arguments": {}
        },
        "name": {}
      }
    ]
  }
}

JSON: object

Example

object

Location: object

tenantCode: object: Tenant unique identifier
return: String arguments: object
locationCode: object: Location unique identifier
return: String arguments: object
displayName: object: Location display name
return: String arguments: object
name: object: Location full name
return: String arguments: object
lat: object: Location latitude
return: Float arguments: object
lng: object: Location longitude
return: Float arguments: object
type: object: Location type e.g. receiver, warehouse
return: LocationType arguments: object
contactPerson: object: Name of the contact person
return: String arguments: object
contactNumber: object: Phone number of the contact person
return: String arguments: object
street1: object: Street address
return: String arguments: object
street2: object: More information for street address
return: String arguments: object
street3: object: More information for street address
return: String arguments: object
district: object: District
return: String arguments: object
province: object: Province
return: String arguments: object
country: object: Country
return: String arguments: object
zipcode: object: Zipcode
return: String arguments: object
allowedTruckClasses: object: Eligible truck classes
return: TruckClassEnum arguments: object
status: object
return: String arguments: object
statusChangedDateTime: object
return: Time arguments: object

Example

{
  "tenantCode": {
    "return": "string",
    "arguments": {}
  },
  "locationCode": {
    "return": "string",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "lat": {
    "return": "number",
    "arguments": {}
  },
  "lng": {
    "return": "number",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "contactPerson": {
    "return": "string",
    "arguments": {}
  },
  "contactNumber": {
    "return": "string",
    "arguments": {}
  },
  "street1": {
    "return": "string",
    "arguments": {}
  },
  "street2": {
    "return": "string",
    "arguments": {}
  },
  "street3": {
    "return": "string",
    "arguments": {}
  },
  "district": {
    "return": "string",
    "arguments": {}
  },
  "province": {
    "return": "string",
    "arguments": {}
  },
  "country": {
    "return": "string",
    "arguments": {}
  },
  "zipcode": {
    "return": "string",
    "arguments": {}
  },
  "allowedTruckClasses": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "statusChangedDateTime": {
    "return": "object",
    "arguments": {}
  }
}

LocationType: string

object parking
object warehouse
object receiver
object factory

Order: object

referenceNo: object
return: String arguments: object
purchaseNo: object
return: String arguments: object
pickupLocation: object
return: String arguments: object
deliveryLocation: object
return: String arguments: object
deliveryLocationInfo: object
return: deliveryLocationInfo arguments: object
contactPerson: object
return: String arguments: object
contactPhoneNumber: object
return: String arguments: object
receiverCode: object
return: String arguments: object
status: object
return: String arguments: object
customerRequestedDate: object
return: Time arguments: object
expirationDate: object
return: Time arguments: object
appointmentDateTime: object
return: Time arguments: object
orderComments: object
return: String arguments: object
businessChannel: object
return: String arguments: object
orderItems: object
return: OrderItem arguments: object
customField1: object: Custom fields
return: CustomField arguments: object
customField2: object
return: CustomField arguments: object
customField3: object
return: CustomField arguments: object
customField4: object
return: CustomField arguments: object
customField5: object
return: CustomField arguments: object
customField6: object
return: CustomField arguments: object
customField7: object
return: CustomField arguments: object
customField8: object
return: CustomField arguments: object
customField9: object
return: CustomField arguments: object
customField10: object
return: CustomField arguments: object
customField11: object
return: CustomField arguments: object
customField12: object
return: CustomField arguments: object
customField13: object
return: CustomField arguments: object
customField14: object
return: CustomField arguments: object
customField15: object
return: CustomField arguments: object
customField16: object
return: CustomField arguments: object
customField17: object
return: CustomField arguments: object
customField18: object
return: CustomField arguments: object
customField19: object
return: CustomField arguments: object
customField20: object
return: CustomField arguments: object

Example

{
  "referenceNo": {
    "return": "string",
    "arguments": {}
  },
  "purchaseNo": {
    "return": "string",
    "arguments": {}
  },
  "pickupLocation": {
    "return": "string",
    "arguments": {}
  },
  "deliveryLocation": {
    "return": "string",
    "arguments": {}
  },
  "deliveryLocationInfo": {
    "return": {
      "contactPerson": {
        "return": "string",
        "arguments": {}
      },
      "contactPhoneNumber": {
        "return": "string",
        "arguments": {}
      },
      "locationName": {
        "return": "string",
        "arguments": {}
      },
      "address": {
        "return": "string",
        "arguments": {}
      },
      "latitude": {
        "return": "number",
        "arguments": {}
      },
      "longitude": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "contactPerson": {
    "return": "string",
    "arguments": {}
  },
  "contactPhoneNumber": {
    "return": "string",
    "arguments": {}
  },
  "receiverCode": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "customerRequestedDate": {
    "return": "object",
    "arguments": {}
  },
  "expirationDate": {
    "return": "object",
    "arguments": {}
  },
  "appointmentDateTime": {
    "return": "object",
    "arguments": {}
  },
  "orderComments": {
    "return": "string",
    "arguments": {}
  },
  "businessChannel": {
    "return": "string",
    "arguments": {}
  },
  "orderItems": {
    "return": [
      {
        "lineItemIndex": {
          "return": "string",
          "arguments": {}
        },
        "productSku": {
          "return": "string",
          "arguments": {}
        },
        "quantity": {
          "return": "number",
          "arguments": {}
        },
        "lot": {
          "return": "string"
        }
      }
    ]
  }
}

OrderCancellationType: string

object cancelled_by_shipper: Cancelled due to shipper
object cancelled_by_receiver: Cancelled due to receiver

OrderItem: object

lineItemIndex: object: Unique identifier of a line item
return: String arguments: object
productSku: object
return: String arguments: object
quantity: object
return: Int arguments: object
lot: object: Lot of the SKU
return: String arguments: object
orderItemComments: object: Remark
return: String arguments: object

Example

{
  "lineItemIndex": {
    "return": "string",
    "arguments": {}
  },
  "productSku": {
    "return": "string",
    "arguments": {}
  },
  "quantity": {
    "return": "number",
    "arguments": {}
  },
  "lot": {
    "return": "string",
    "arguments": {}
  },
  "orderItemComments": {
    "return": "string",
    "arguments": {}
  }
}

PageInfo: object

hasNextPage: object
return: Boolean arguments: object
hasPreviousPage: object
return: Boolean arguments: object
startCursor: object
return: Cursor arguments: object
endCursor: object
return: Cursor arguments: object

Example

{
  "hasNextPage": {
    "return": "boolean",
    "arguments": {}
  },
  "hasPreviousPage": {
    "return": "boolean",
    "arguments": {}
  },
  "startCursor": {
    "return": "object",
    "arguments": {}
  },
  "endCursor": {
    "return": "object",
    "arguments": {}
  }
}

PalletExchangeTypeEnum: string

object exchange
object return

Product: object

shipperCode: object
return: String arguments: object
productSku: object
return: String arguments: object
name: object
return: String arguments: object
unit: object
return: String arguments: object
volume: object
return: Float arguments: object
volumeUnit: object
return: String arguments: object
volumeBase: object
return: Float arguments: object
weight: object
return: Float arguments: object
weightUnit: object
return: String arguments: object
baseToCase: object
return: Int arguments: object
baseToPallet: object
return: Int arguments: object
dimensionHeight: object
return: Float arguments: object
dimensionWidth: object
return: Float arguments: object
dimensionLength: object
return: Float arguments: object
remark: object
return: String arguments: object
price: object
return: Float arguments: object
saleUnit: object
return: String arguments: object
ti: object
return: Int arguments: object
hi: object
return: Int arguments: object
caseToPallet: object
return: Int arguments: object
baseWidth: object
return: Float arguments: object
baseLength: object
return: Float arguments: object
baseHeight: object
return: Float arguments: object
baseWeight: object
return: Float arguments: object
caseWidth: object
return: Float arguments: object
caseLength: object
return: Float arguments: object
caseHeight: object
return: Float arguments: object
caseWeight: object
return: Float arguments: object
palletWidth: object
return: Float arguments: object
palletLength: object
return: Float arguments: object
palletHeight: object
return: Float arguments: object
palletWeight: object
return: Float arguments: object
status: object
return: String arguments: object
statusChangedDateTime: object
return: Time arguments: object

Example

{
  "shipperCode": {
    "return": "string",
    "arguments": {}
  },
  "productSku": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "unit": {
    "return": "string",
    "arguments": {}
  },
  "volume": {
    "return": "number",
    "arguments": {}
  },
  "volumeUnit": {
    "return": "string",
    "arguments": {}
  },
  "volumeBase": {
    "return": "number",
    "arguments": {}
  },
  "weight": {
    "return": "number",
    "arguments": {}
  },
  "weightUnit": {
    "return": "string",
    "arguments": {}
  },
  "baseToCase": {
    "return": "number",
    "arguments": {}
  },
  "baseToPallet": {
    "return": "number",
    "arguments": {}
  },
  "dimensionHeight": {
    "return": "number",
    "arguments": {}
  },
  "dimensionWidth": {
    "return": "number",
    "arguments": {}
  },
  "dimensionLength": {
    "return": "number",
    "arguments": {}
  },
  "remark": {
    "return": "string",
    "arguments": {}
  },
  "price": {
    "return": "number",
    "arguments": {}
  },
  "saleUnit": {
    "return": "string",
    "arguments": {}
  },
  "ti": {
    "return": "number",
    "arguments": {}
  },
  "hi": {
    "return": "number",
    "arguments": {}
  },
  "caseToPallet": {
    "return": "number",
    "arguments": {}
  },
  "baseWidth": {
    "return": "number",
    "arguments": {}
  },
  "baseLength": {
    "return": "number",
    "arguments": {}
  },
  "baseHeight": {
    "return": "number",
    "arguments": {}
  },
  "baseWeight": {
    "return": "number",
    "arguments": {}
  },
  "caseWidth": {
    "return": "number"
  }
}

Receiver: object

shipperCode: object: Shipper unique identifier
return: String arguments: object
receiverCode: object: Receiver unique identifier
return: String arguments: object
displayName: object: Receiver display name
return: String arguments: object
name: object: Receiver full name
return: String arguments: object
locations: object: Receiver's drop-off locations
return: Location arguments: object

Example

{
  "shipperCode": {
    "return": "string",
    "arguments": {}
  },
  "receiverCode": {
    "return": "string",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "locations": {
    "return": [
      {
        "tenantCode": {
          "return": "string",
          "arguments": {}
        },
        "locationCode": {
          "return": "string",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "lat": {
          "return": "number",
          "arguments": {}
        },
        "lng": {
          "return": "number",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        },
        "contactPerson": {
          "return": "string",
          "arguments": {}
        },
        "contactNumber": {
          "return": "string",
          "arguments": {}
        },
        "street1": {
          "return": "string",
          "arguments": {}
        },
        "street2": {
          "return": "string",
          "arguments": {}
        },
        "street3": {
          "return": "string",
          "arguments": {}
        },
        "district": {
          "return": "string",
          "arguments": {}
        },
        "province": {
          "return": "string",
          "arguments": {}
        },
        "country": {
          "return": "string",
          "arguments": {}
        },
        "zipcode": {
          "return": "string",
          "arguments": {}
        },
        "allowedTruckClasses": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "statusChangedDateTime": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

String: string

The Stringscalar 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.

Time: object

Example

object

Truck: object

carrierCode: object: Carrier unique identifier
return: String arguments: object
licensePlate: object: Truck unique identifier
return: String arguments: object
displayName: object: Truck display name
return: String arguments: object
maxPalletAmount: object: Maximum truck pallet capacity
return: Float arguments: object
maxWeight: object: Maximum truck weight limit
return: Float arguments: object
dimensionHeight: object: Truck container dimension height
return: Float arguments: object
dimensionWidth: object: Truck container dimension width
return: Float arguments: object
dimensionLength: object: Truck container dimension length
return: Float arguments: object
truckClass: object: Truck class e.g. 4W, 22W
return: TruckClass arguments: object
device: object: Attached device
return: Device arguments: object

Example

{
  "carrierCode": {
    "return": "string",
    "arguments": {}
  },
  "licensePlate": {
    "return": "string",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "maxPalletAmount": {
    "return": "number",
    "arguments": {}
  },
  "maxWeight": {
    "return": "number",
    "arguments": {}
  },
  "dimensionHeight": {
    "return": "number",
    "arguments": {}
  },
  "dimensionWidth": {
    "return": "number",
    "arguments": {}
  },
  "dimensionLength": {
    "return": "number",
    "arguments": {}
  },
  "truckClass": {
    "return": [
      {
        "name": {
          "return": "string",
          "arguments": {}
        },
        "code": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "device": {
    "return": {
      "carrierCode": {
        "return": "string",
        "arguments": {}
      },
      "deviceCode": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "serialNo": {
        "return": "string",
        "arguments": {}
      },
      "imei": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

TruckClass: object

name: object: Truck class name
return: String arguments: object
code: object: Truck class unique identifier
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "code": {
    "return": "string",
    "arguments": {}
  }
}

TruckClassEnum: string

object truck_4w
object truck_4wj
object truck_6w
object truck_10w
object truck_18w
object truck_22w

TruckDriver: object

displayName: object: Driver display name
return: String arguments: object
name: object: Driver full name
return: String arguments: object
driverLicense: object: Driver license plate
return: String arguments: object
phone: object: Driver phone number
return: String arguments: object
tenantCode: object: Tenant unique identifier
return: String arguments: object
carrierCode: object: Carrier unique identifier
return: String arguments: object

Example

{
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "driverLicense": {
    "return": "string",
    "arguments": {}
  },
  "phone": {
    "return": "string",
    "arguments": {}
  },
  "tenantCode": {
    "return": "string",
    "arguments": {}
  },
  "carrierCode": {
    "return": "string",
    "arguments": {}
  }
}

TruckFeatureEnum: string

object other
object lift
object refrigerated
object ambient

UpdateDeviceInput: object

name: String: Device name
serialNo: String: Device serial number
imei: String: Device imei
remark: String: Remark

Example

{
  "name": "string",
  "serialNo": "string",
  "imei": "string",
  "remark": "string"
}

UpdateDeviceLocationInput: object

lat: Float: Current device latitude
lng: Float: Current device longitude
timestamp: Time: Current timestamp

Example

{
  "lat": "number",
  "lng": "number",
  "timestamp": "object"
}

UpdateLocationInput: object

name: String: Location name
displayName: String: Location display name
lat: Float: Latitude of location
lng: Float: Longitude of location
contactPerson: String: Name of the contact person
contactNumber: String: Phone number of the contact person
openHour: String 08:00: Opening hour with HH:mm format e.g. 08:00
closeHour: String 16:00: Closing hour with HH:mm format e.g. 16:00
locationType: LocationType: Location type e.g. customer, warehouse
street1: String: Street address
street2: String: More information for street address
street3: String: More information for street address
district: String: District
province: String: Province
country: String: Country
zipcode: String: Zipcode
allowedTruckClasses: TruckClassEnum: Eligible truck classes
loadDurationMinute: Int: Loading time in minute
unloadDurationMinute: Int: Unloading time in minute
palletExchangeType: PalletExchangeTypeEnum: ???

Example

{
  "name": "string",
  "displayName": "string",
  "lat": "number",
  "lng": "number",
  "contactPerson": "string",
  "contactNumber": "string",
  "openHour": "string",
  "closeHour": "string",
  "locationType": "string",
  "street1": "string",
  "street2": "string",
  "street3": "string",
  "district": "string",
  "province": "string",
  "country": "string",
  "zipcode": "string",
  "allowedTruckClasses": [
    "string"
  ],
  "loadDurationMinute": "number",
  "unloadDurationMinute": "number",
  "palletExchangeType": "string"
}

UpdateOrderInput: object

purchaseNo: String: Purchase order number
customerRequestedDate: Time: Customer request date to deliver
expirationDate: Time: Deadline to deliver
appointmentDateTime: Time: Pre-specify delivery date & time
receiverCode: String: Receiver unique identifier
receiverContactName: String: Receiver contact name
receiverContactPhoneNumber: String: Receiver contact phone number
pickupLocation: String: Pick-up location unique identifier
deliveryLocation: String: Delivery location unique identifier
deliveryLocationInfo: deliveryLocationInfoInput: Delivery location info (address, contact person, contact number)
orderComments: String
businessChannel: String
orderItems: UpdateOrderItemInput: Order items
customField1: CustomFieldInput: Custom fields
customField2: CustomFieldInput
customField3: CustomFieldInput
customField4: CustomFieldInput
customField5: CustomFieldInput
customField6: CustomFieldInput
customField7: CustomFieldInput
customField8: CustomFieldInput
customField9: CustomFieldInput
customField10: CustomFieldInput
customField11: CustomFieldInput
customField12: CustomFieldInput
customField13: CustomFieldInput
customField14: CustomFieldInput
customField15: CustomFieldInput
customField16: CustomFieldInput
customField17: CustomFieldInput
customField18: CustomFieldInput
customField19: CustomFieldInput
customField20: CustomFieldInput

Example

{
  "purchaseNo": "string",
  "customerRequestedDate": "object",
  "expirationDate": "object",
  "appointmentDateTime": "object",
  "receiverCode": "string",
  "receiverContactName": "string",
  "receiverContactPhoneNumber": "string",
  "pickupLocation": "string",
  "deliveryLocation": "string",
  "deliveryLocationInfo": {
    "contactPerson": "string",
    "contactPhoneNumber": "string",
    "locationName": "string",
    "address": "string",
    "latitude": "number",
    "longitude": "number"
  },
  "orderComments": "string",
  "businessChannel": "string",
  "orderItems": [
    {
      "lineItemIndex": "string",
      "productSku": "string",
      "lot": "string",
      "quantity": "number",
      "orderItemComments": "string"
    }
  ],
  "customField1": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField2": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField3": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField4": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField5": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField6": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField7": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField8": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "customField9": {}
}

UpdateOrderItemInput: object

lineItemIndex: String: Unique identifier of a line item
productSku: String: Product SKU
lot: String: Lot of the SKU
quantity: Int: Quantity of product (in base unit)
orderItemComments: String: Remark

Example

{
  "lineItemIndex": "string",
  "productSku": "string",
  "lot": "string",
  "quantity": "number",
  "orderItemComments": "string"
}

UpdateProductInput: object

name: String: Product name
baseUnit: String: Product base unit e.g. bottle, pack
saleUnit: String: Product sale unit e.g. case
weightUnit: String kg: Product weight unit
volumeUnit: String cc: Product volume unit
ti: Int: Number of cases fit in pallet (horizontal)
hi: Int: Number of row fit in pallet (vertical)
baseToCase: Int: Conversion of base to case
baseToPallet: Int: Conversion of base to pallet
caseToPallet: Int: Conversion of case to pallet
baseHeight: Float: Product height
baseWidth: Float: Product Width
baseLength: Float: Product length
baseWeight: Float: Product weight
caseHeight: Float: Case height
caseWidth: Float: Case width
caseLength: Float: Case length
caseWeight: Float: Case weight
palletHeight: Float: Pallet height
palletWidth: Float: Pallet width
palletLength: Float: Pallet length
palletWeight: Float: Pallet weight
price: Float: Product price
remark: String: Remark

Example

{
  "name": "string",
  "baseUnit": "string",
  "saleUnit": "string",
  "weightUnit": "string",
  "volumeUnit": "string",
  "ti": "number",
  "hi": "number",
  "baseToCase": "number",
  "baseToPallet": "number",
  "caseToPallet": "number",
  "baseHeight": "number",
  "baseWidth": "number",
  "baseLength": "number",
  "baseWeight": "number",
  "caseHeight": "number",
  "caseWidth": "number",
  "caseLength": "number",
  "caseWeight": "number",
  "palletHeight": "number",
  "palletWidth": "number",
  "palletLength": "number",
  "palletWeight": "number",
  "price": "number",
  "remark": "string"
}

UpdateReceiverInput: object

name: String: Receiver full name
displayName: String: Receiver display name
locations: CreateLocationInput: Receiver's drop-off locations

Example

{
  "name": "string",
  "displayName": "string",
  "locations": [
    {
      "locationCode": "string",
      "name": "string",
      "displayName": "string",
      "lat": "number",
      "lng": "number",
      "contactPerson": "string",
      "contactNumber": "string",
      "openHour": "string",
      "closeHour": "string",
      "locationType": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string",
      "district": "string",
      "province": "string",
      "country": "string",
      "zipcode": "string",
      "allowedTruckClasses": [
        "string"
      ],
      "loadDurationMinute": "number",
      "unloadDurationMinute": "number",
      "palletExchangeType": "string"
    }
  ]
}

UpdateTruckDriverInput: object

carrierCode: String: Carrier unique identifier
displayName: String: Driver display name
name: String: Driver full name
driverLicense: String: Driver license
phone: String: Driver phone number
countryCode: String: Phone number country code

Example

{
  "carrierCode": "string",
  "displayName": "string",
  "name": "string",
  "driverLicense": "string",
  "phone": "string",
  "countryCode": "string"
}

UpdateTruckInput: object

displayName: String: Truck display name
maxPalletAmount: Float: Maximum truck pallet capacity
maxWeight: Float: Maximum truck weight limit
dimensionHeight: Float: Truck container dimension height
dimensionWidth: Float: Truck container dimension width
dimensionLength: Float: Truck container dimension length
truckClasses: TruckClassEnum: Truck class e.g. 4W, 22W

Example

{
  "displayName": "string",
  "maxPalletAmount": "number",
  "maxWeight": "number",
  "dimensionHeight": "number",
  "dimensionWidth": "number",
  "dimensionLength": "number",
  "truckClasses": [
    "string"
  ]
}

Upload: object

Example

object

deliveryLocationInfo: object

contactPerson: object: Contact person
return: String arguments: object
contactPhoneNumber: object: Phone number of the contact person
return: String arguments: object
locationName: object: Location name
return: String arguments: object
address: object: Address
return: String arguments: object
latitude: object: Latitude
return: Float arguments: object
longitude: object: Longitude
return: Float arguments: object

Example

{
  "contactPerson": {
    "return": "string",
    "arguments": {}
  },
  "contactPhoneNumber": {
    "return": "string",
    "arguments": {}
  },
  "locationName": {
    "return": "string",
    "arguments": {}
  },
  "address": {
    "return": "string",
    "arguments": {}
  },
  "latitude": {
    "return": "number",
    "arguments": {}
  },
  "longitude": {
    "return": "number",
    "arguments": {}
  }
}

deliveryLocationInfoInput: object

contactPerson: String: Contact person
contactPhoneNumber: String: Phone number of the contact person
locationName: String: Location name
address: String: Address
latitude: Float: Latitude
longitude: Float: Longitude

Example

{
  "contactPerson": "string",
  "contactPhoneNumber": "string",
  "locationName": "string",
  "address": "string",
  "latitude": "number",
  "longitude": "number"
}

Documentation by DociQL