QwykSchedules API (1.1)

Download OpenAPI specification:Download

About

The QwykSchedules API is an HTTP API served by the QwykSchedules web appproviding endpoints to interact with your schedules that are generated based on your routing guide setup.

Versioning

The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break.

This documentation is for version 1.1 of the API.

API Version	Changes
Latest	None
1.1	Added new fields, clarified descriptions
1.0	None

Authentication

JSONWebToken

Authentication credentials need to be passed as a JWT token in the Authorization header for all requests. Your tokens are self-issued through the App.

Security scheme type:	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"Bearer token"

Locations

Query the locations database

Get product / segment locations

Authorizations:

JSONWebToken

path Parameters

organization_id required	integer Your assigned organization ID
product required	string Enum:"air" "fcl" "lcl" "csl" The product you wish to query locations for
segment required	string Enum:"origin" "destination" The segment (origin/destination) you wish to query locations for
query required	string Your search query

Responses

200

List of available locations

get /{organization_id}/{product}/locations/{segment}/{query}

Production server

https://schedules.qwyk.io/api/schedules/c/{organization_id}/{product}/locations/{segment}/{query}

Response samples

Content type

application/json

Copy

Expand all Collapse all

[

{
- "locode": "string",
- "display_name": "string"
}

]

Schedules

Obtain a tradelane schedule

Send a schedule request

This method allows for the synchronous retrieval of your schedule for a given product and tradelane.

Authorizations:

JSONWebToken

path Parameters

organization_id required	integer Your assigned organization ID
product required	string Enum:"air" "fcl" "lcl" "csl" The product you wish to query schedules for
origin required	string <locode> The origin to query schedules from
destination required	string <locode> The destination to query schedules to

Responses

200

Response with array of schedules

404

Not Found

get /{organization_id}/{product}/{origin}/{destination}

Production server

https://schedules.qwyk.io/api/schedules/c/{organization_id}/{product}/{origin}/{destination}

Response samples

Content type

application/json

Copy

Expand all Collapse all

[

{
- "carrier":
  {
  - "code": "string",
  - "display_name": "string"
  },
- "vessel": "string",
- "voyage": "string",
- "closing": "2019-07-31T09:20:51Z",
- "closing_cargo": "2019-07-31T09:20:51Z",
- "closing_doc": "2019-07-31T09:20:51Z",
- "closing_imo": "2019-07-31T09:20:51Z",
- "etd": "2019-07-31T09:20:51Z",
- "eta": "2019-07-31T09:20:51Z",
- "origin": "string",
- "origin_is_precarriage": true,
- "origin_via": "string",
- "destination": "string",
- "destination_via": "string",
- "legs":
  [
  - {
    "id": 0,
    "ident": "string",
    "carrier":
    {
    "code": "string",
    "display_name": "string"
    },
    "origin": "string",
    "destination": "string",
    "etd": "2019-07-31T09:20:51Z",
    "eta": "2019-07-31T09:20:51Z",
    "notes": "string",
    "service": "string",
    "vesselinfo": { },
    "type": "precarriage"
    }
  ],
- "service": "string",
- "notes": "string"
}

]