Documentation Powered by ReDoc

API platform (v1)

Download OpenAPI specification:Download

                This page lists the REST services exposed by *APIm.workato.COM/SCHEDULE*.
                An API key is required to invoke the services. Contact the service owner to get your API key.

Authentication

api_key

Regular API token

Security Scheme Type API Key
Header parameter name: API-Token

oauth2

JWT or OAuth 2.0 token

Security Scheme Type API Key
Header parameter name: Authorization

Active

Active services

Set Window

This function and API sets the schedule window for a particular freight bill via the API.   Example cURL statement

curl -XPUT -d '{"param1":"value1","param2":"value2"}' -H 'API-TOKEN: YOUR_TOKEN' 'https://apim.workato.com/v1/schedule'

  Example using JWT or OAuth 2.0 token

curl -XPUT -d '{"param1":"value1","param2":"value2"}' -H 'Authorization: Bearer YOUR_TOKEN' 'https://apim.workato.com/v1/schedule'
Authorizations:
api_key
Request Body schema: application/json
billNumber
required
string

Freight Bill Number

token
required
string

Time based hash

zipCode
required
string
selectedDate
required
string <date-time>
selectedStartTime
required
string
selectedEndTime
required
string

Responses

Request samples

Content type
application/json
{
  • "billNumber": "string",
  • "token": "string",
  • "zipCode": "string",
  • "selectedDate": "2019-08-24T14:15:22Z",
  • "selectedStartTime": "string",
  • "selectedEndTime": "string"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "error_state": 0,
  • "error_code": 0,
  • "error_message": "string"
}

Update Time Window and Status in TruckMate

When a customer schedule an order online that information - delivery time window and scheduled status- is passed to TruckMate via this recipe. This recipe is being called by Metalake as part of their code for Online Scheduler   Example cURL statement

curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'API-TOKEN: YOUR_TOKEN' 'https://apim.workato.com/v1/schedule/update'

  Example using JWT or OAuth 2.0 token

curl -XPOST -d '{"param1":"value1","param2":"value2"}' -H 'Authorization: Bearer YOUR_TOKEN' 'https://apim.workato.com/v1/schedule/update'
Authorizations:
api_key
Request Body schema: application/json
detailLineId
required
string
windowStart
required
string
windowEnd
required
string

Responses

Request samples

Content type
application/json
{
  • "detailLineId": "string",
  • "windowStart": "string",
  • "windowEnd": "string"
}

Response samples

Content type
application/json
{ }

Get Schedule Windows

When there is a new call for callable recipe, do action   Example cURL statement

curl -XGET -H 'API-TOKEN: YOUR_TOKEN' 'https://apim.workato.com/v1/schedule/windows?param1=value1&param2=value2'

  Example using JWT or OAuth 2.0 token

curl -XGET -H 'Authorization: Bearer YOUR_TOKEN' 'https://apim.workato.com/v1/schedule/windows?param1=value1&param2=value2'
Authorizations:
api_key
query Parameters
billNumber
required
string

Freight Bill Number

zipCode
required
string

Consignee Zip code

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "token": "string",
  • "windows": [
    ]
}

Inactive

Inactive services