API docs by Redocly

Synkro Public API (0.5.0)

Download OpenAPI specification:

Public APIs for integrations with Synkro.

Health

Service healthcheck

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Companies

Bulk partner company import

Imports in batch the companies that collaborate with the caller company. If a company already exists in Synkro, a partnership request is created. If a company does not exist, an onboarding invitation is sent.

Authorizations:
ApiKeyAuth
header Parameters
X-Idempotency-Key
required
string

Required for mutating endpoints, generated by the ERP client. Synkro does not expose an endpoint to generate this key. Same key + same payload => same response. Same key + different payload => 409.

X-Correlation-Id
string
Request Body schema: application/json
required
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",
  • "status": "accepted"
}

Company import status

Authorizations:
ApiKeyAuth
path Parameters
importId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",
  • "status": "pending",
  • "totals": {
    },
  • "error_items": [
    ]
}

Partners

Active partners list

Authorizations:
ApiKeyAuth
query Parameters
cursor
string
limit
integer [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "next_cursor": "string",
  • "items": [
    ]
}

RelationshipTypes

Relationship types list

Returns relationship types.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Assets

Available asset list

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Workers

Company workers list

Authorizations:
ApiKeyAuth
query Parameters
is_active
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Locations

Locations list

Authorizations:
ApiKeyAuth
query Parameters
cursor
string
limit
integer [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "next_cursor": "string",
  • "items": [
    ]
}

Upsert location

Authorizations:
ApiKeyAuth
header Parameters
X-Idempotency-Key
required
string

Required for mutating endpoints, generated by the ERP client. Synkro does not expose an endpoint to generate this key. Same key + same payload => same response. Same key + different payload => 409.

X-Correlation-Id
string
Request Body schema: application/json
required
id
string or null <uuid>
name
required
string
address
string or null
city
string or null
country_code
string or null
latitude
number or null <double>
longitude
number or null <double>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "country_code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Delete location

Authorizations:
ApiKeyAuth
path Parameters
locationId
required
string <uuid>
header Parameters
X-Idempotency-Key
required
string

Required for mutating endpoints, generated by the ERP client. Synkro does not expose an endpoint to generate this key. Same key + same payload => same response. Same key + different payload => 409.

X-Correlation-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Missions

Mission list with nested includes

Authorizations:
ApiKeyAuth
query Parameters
cursor
string
limit
integer [ 1 .. 200 ]
Default: 50
include
string
Example: include=tasks.steps,participants,assets,confirmations

Responses

Response samples

Content type
application/json
{
  • "next_cursor": "string",
  • "items": [
    ]
}

Create mission

Authorizations:
ApiKeyAuth
header Parameters
X-Idempotency-Key
required
string

Required for mutating endpoints, generated by the ERP client. Synkro does not expose an endpoint to generate this key. Same key + same payload => same response. Same key + different payload => 409.

X-Correlation-Id
string
Request Body schema: application/json
required
template_code
required
string
external_ref
required
string
origin_company_id
required
string <uuid>
destination_company_id
required
string <uuid>
assigned_carrier_company_id
string or null <uuid>
planned_pickup
string or null <date-time>
planned_delivery
string or null <date-time>
level_of_proof
string
Default: "single"
Enum: "single" "double"
Array of objects
object

Responses

Request samples

Content type
application/json
{
  • "template_code": "string",
  • "external_ref": "string",
  • "origin_company_id": "9619af02-4331-46cb-8ac4-8dce2a3ae728",
  • "destination_company_id": "28beb504-2451-443f-8cc2-f19d4e44d193",
  • "assigned_carrier_company_id": "37314bb0-83e4-4dcb-a0d4-59ac272f26df",
  • "planned_pickup": "2019-08-24T14:15:22Z",
  • "planned_delivery": "2019-08-24T14:15:22Z",
  • "level_of_proof": "single",
  • "assets": [
    ],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Update mission workers (upsert)

Authorizations:
ApiKeyAuth
path Parameters
missionId
required
string <uuid>
header Parameters
X-Idempotency-Key
required
string

Required for mutating endpoints, generated by the ERP client. Synkro does not expose an endpoint to generate this key. Same key + same payload => same response. Same key + different payload => 409.

X-Correlation-Id
string
Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_count": 0
}

Remove worker from mission

Authorizations:
ApiKeyAuth
path Parameters
missionId
required
string <uuid>
workerId
required
string <uuid>
header Parameters
X-Idempotency-Key
required
string

Required for mutating endpoints, generated by the ERP client. Synkro does not expose an endpoint to generate this key. Same key + same payload => same response. Same key + different payload => 409.

X-Correlation-Id
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Balances

Open balances grouped by asset

Authorizations:
ApiKeyAuth
query Parameters
include_missions
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Open balances against a specific company

Authorizations:
ApiKeyAuth
path Parameters
companyId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}