{"info":{"_postman_id":"470d91f8-1ea4-4d28-80f6-e34e5b8aa9e1","name":"FourKites Dynamic Yard APIs","description":"

The FourKites Dynamic Yard APIs allow teams and systems operating at a warehouse to interact programmatically with activity in the yard. By exposing core functionality of the Dynamic Yard platform, warehouse management and other on-site systems can seamlessly interact with yard operations to drive efficiency and automation.

For more information on the FourKites Dynamic Yard solution, please visit the Yard Management Software Overview.

Dynamic Yard Integration Points

The typical transactional flow between Dynamic Yard and a WMS (or other system) is diagrammed below. A high-level summary of how Dynamic Yard API support integration at each process in a yard operation are listed below the diagram.

Dynamic Yard offers a 2-way integration which means you are able to subscribe to specific events generated in the platform to keep a warehouse or other systems up-to-date with the latest activity from the yard.

\n\n

Data Flow and APIs

Gate Check-In: event-based webhook captures when trailers arrive at the facility
\n
Move Request API: enables the warehouse to create spot requests to move trailers into open dock doors
\n
Move Confirmation: event-based webhook sends status events to the warehouse informing them on the lifecycle of spot tasks
\n
Trailer Update API: enables the warehouse to update trailer status, shipment detail, and other attributes as loading / unloading takes place
\n
Move Request API: enables the warehouse to create pull requests to move trailers from dock doors once loading / unloading has been completed
\n
Move Confirmation: event-based webhook sends status events to the warehouse informing them on the lifecycle of pull tasks. The warehouse can receive a status once the spotter has hooked to the trailer, effectively clearing the door
\n
Trailer Confirmation: event-based webhook informs the warehouse of any changes in a trailer's location, status, and service attributes relating to eligibility
\n
Gate Check-Out: event-based webhook captures the check-out event, completing a trailers lifecycle at the facility
\n

Which APIs to Use?

The first step should be identifying which APIs to use when integrating with Dynamic Yard. Each API is grouped under a parent category which describes its function in automating a specific workflow between external systems and Dynamic Yard. Reading through the below sections will help identify which APIs will best maximize efficiencies based upon your organization's goals.

Manage Shipment Data

The Manage Shipment Data section outlines APIs that typically receive data from transportation planning systems. Specifically, this relates to appointment scheduling and planning inbound/outbound deliveries to/from the facility. It is recommended to select either the Appointments API or the Deliveries API as the main method of creating delivery objects in Dynamic Yard.

\n
Note: if your organization plans to use either the Core Track or Appointment Manager products alongside Dynamic Yard, the Loads / Appointments integration path is recommended to create pending deliveries in Dynamic Yard. If you are unsure of your organization's FourKites platform usage, please check with your FourKites Delivery Consultant
\n

Appointments: If expected deliveries at a facility will have a pre-defined and known trailer ahead of time, then it's best to create pending delivery objects using the Create Appointment API. This will supply the ability to associate one or multiple deliveries to an expected trailer along with any other attributes (seal number, seal status, trailer type, carrier, etc.).
\n
Deliveries: Useful when attributes about a trailer, carrier, or other inputs are not known ahead of time. While it is more limited in functionality than the Appointment API, it allows for a simpler format for creating deliveries if the additional information offered with Appointments are not needed or applicable (trailer type, carrier, etc.)
\n
Loads / Appointments: If you plan on leveraging either the Core Track (real-time visibility) or Appointment Manager products from FourKites, the recommendation is to create a single \"load\" object using the Tracking API . This API will simultaneously create the following data objects in FourKites:
\n
- Core Track: Load for real-time tracking and visibility using dedicated GPS and carrier integrations
  \n
- Appointment Manager: Appointment for scheduling at a given facility
  \n
- Dynamic Yard: Delivery to load / unload from trailers in the yard
  \n
\n

Manage Trailers

The Manage Trailers section is crucial in enabling efficiency of yard operations. The APIs in this section support automatically creating move requests and updating the status of trailers based upon warehouse activity.

Equipment / Trailers: This API supplies critical functionality around updating trailer status, load status, and associating or removing deliveries (loading / unloading). This keeps the yard up to date on the warehouse's operations and can prepare the trailer to be moved to/from dock doors efficiently.
\n
Move Requests: The other area of automation between the warehouse and yard is with generating move requests. The Move Request API supplies functionality to create and manage moves directly from an external system (most commonly a WMS). Both Spot and Pull requests can easily be created using this API. However, moves can still be created manually in Dynamic Yard for subsets of loads if needed
\n
Manage Doors: Dynamic Yard offers a door update API to easily mark doors as active or inactive, enabling the warehouse to directly restrict which doors can be used for move request if they need to be taken out of service
\n

Manage Dock Doors

The Manage Dock Doors section supplies optional APIs for updating the status of dock doors in Dynamic Yard. This can help keep the warehouses status in sync with doors in Dynamic Yard.

Manage Doors: Dynamic Yard offers a door update API to easily mark doors as active or inactive, enabling the warehouse to directly restrict which doors can be used for move request if they need to be taken out of service

Manage Gate Activity

The Manage Gate Activity section details optional APIs which can automatically check trailers into the yard based upon an external source of data.

Check-In: If another system or automated reader is capturing the check-in process, the Gate Check-In API can be used to create the same check-in event inside Dynamic Yard. This will populate the trailer in the yard and associate it to any shipments currently ready to unload.
\n
Check-Out: Similar to the check-in event, if a separate system or automated reader is capturing trailers leaving the facility, sending data to the Gate Check-Out API will easily check trailers out of the yard
\n

Webhooks (Events Generated by Dynamic Yard)

Each webhook is meant to sync the warehouse with activities occurring in the yard. This makes consuming them crucial to maximizing efficient interaction between systems.

Gate Check-In: This webhook notifies any subscribing system that a trailer has arrived at the facility. Key details about the trailer, its status, and any deliveries it's hauling are present on this webhook
\n
Gate Check-Out: Once a trailer has departed the yard this webhook can notify subscribing systems to mark the trailer as departed from the system
\n
Trailer Update Confirmation: This message notifies any subscribing systems that a change has occurred on a trailer. Anything from updating an attribute, condition, status, or location of a trailer will trigger this message. This is a key component to keeping downstream systems in sync with the latest details from the yard
\n
Move Confirmation: If move requests are being integrated between the warehouse and the yard, it is crucial that this webhook is in scope. This will deliver a status update on the move as it goes through its lifecycle, letting the warehouse know whether the trailer is at the door or has been moved from the door
\n

API Usage and Specifics

The FourKites API is accessible over HTTPS, is RESTful, and speaks JSON in both directions. As the API uses JSON for both requests and responses, we will assume that requests with a payload are using properly formatted JSON, however we still recommend setting the Content-Type header to the value application/json.

Generate Client Credentials

The client_id and client_secret can be generated under the “API Access” section with administrator access to the application. Follow the below steps to generate credentials for your company tenant and environment:

\n\n

On the left-hand navigation bar, locate the Developer section and click API Access

\n\n

Click the Generate API Client button and your credentials will be displayed. Copy the values and store in a secure location.

\n\n

Status Codes and Error Handling

FourKites uses conventional HTTP response codes to indicate the success or failure of an API request.

Codes in the 2xx range indicate success
\n
Codes in the 4xx range indicate an error due to the information provided (e.g., a required parameter was omitted, an invalid value given, etc.)
\n
Codes in the 5xx range indicate an error with FourKites' servers (these are rare)
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Status	Description
`200`	OK	Response to a successful REST API action. The HTTP method can be GET, POST, PUT, PATCH or DELETE.
`401`	Unauthorized	If received when making a token request, then the client_id or client_secret are invalid. If received when making an API request using a bearer token, check if the token is valid or expired. If unsure, try retrieving a new token and making the request again
`400`	Bad Request	Indicates that the server could not understand the request due to invalid syntax, format or input
`404`	Not Found	The URL requested does not exist
`500`	Internal Server Error	There was an issue with the Dynamic Yard server. Try again later

Customer-level errors will primarily fall under the 400 status codes. These are defined by errors caused by invalid URL parameters or request fields in the JSON body. Each error will come with an error_message key explaining the cause of the error along with steps for remediation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Field	Description
`error_code`	This a custom Error Code that is returned to provide more context. This is not directly related to a HTTP Status Code as it can mean request or resource specific errors as described below
`error_message`	Specific message with information on the cause of the error along with steps for remediation

A few example error messages are below:

\n\n

Environments

FourKites Dynamic Yard offers 2 environments for customer use: staging and production. Staging should be used when testing APIs, responses, and outbound callbacks (i.e. webhooks from FourKites Dynamic Yard). The URLs for accessing both environments are below. If you do not have an account in the staging environment, please reach out to your FourKites Customer Success Manager:

Staging: https://dy-staging.fourkites.com
\n
Production: https://dy.fourkites.com
\n

Postman Collection

The easiest way to start using the FourKites Dynamic Yard APIs is by clicking the Run in Postman button above. Postman is a free tool which helps developers run and debug API requests. Every endpoint you see documented here is readily available by running our Postman collection.

Import the Postman Environment

To import the Postman collection, click on File and then Import:

\n\n

Next, select the option on the modal window for File import, and load the file supplied by FourKites ending in “.postman_environment.json”. If you do not have a Postman Environment file please reach out to your FourKites Delivery Consultant or Customer Success Manager:

\n\n

The following variables come pre-loaded in the collection supplied by FourKites and remain static:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable Name	Description
`dynamic_yard_url`	URL host for the Dynamic Yard APIs
`scac`	Demo carrier SCAC code which can be used for initial testing
`site_code`	Unique site code in Dynamic Yard
`client_id`	Client ID used to authenticate with the Oauth2 service. Value must be generated by an admin within the customer site
`secret`	Secret used to authenticate with the Oauth2 service. Value must be generated by an admin within the customer site

Additional variables are dynamically updated when using the collection (see below section on Pre-Request and Test scripts):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable Name	Description
`delivery_id`	Unique identifier for a pending inbound / outbound delivery at the site
`appointment_id`	Unique identifier for an appointment associated with a delivery at the site
`trailer_number`	Trailer number checking into or out of the site
`tractor_number`	Tractor number checking into or out of the site
`scheduled_time`	Scheduled time for a delivery to arrive at the site
`check_time`	Time the trailer checked into the site

Pre-Request and Test Scripts

When using the collection, there are embedded Pre-Request and Test scripts which will run before and after certain requests. These are meant to automatically generate or save variables to persist across calls when operating within the Postman environment. These can be helpful when staging sample data or quickly understanding API behavior without keying in and copy/pasting values across calls. You can also overwrite the pre-loaded variables and enter your own request JSON.

APIs which use the Pre-Request scripts to generate data are the following:

Create Appointment (Generates timestamps, trailer number, and delivery ID)
\n
Create Delivery (Generates timestamps and delivery ID)
\n

\n\n

APIs which use the Test scripts to save data returned on responses as variables are the following:

Generate Oauth2 Token (Saves the access_token)
\n
Create Spot / Pull Task (saves the unique move request ID)
\n

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Dynamic Yard Integration Points","slug":"dynamic-yard-integration-points"},{"content":"Which APIs to Use?","slug":"which-apis-to-use"},{"content":"API Usage and Specifics","slug":"api-usage-and-specifics"},{"content":"Status Codes and Error Handling","slug":"status-codes-and-error-handling"},{"content":"Postman Collection","slug":"postman-collection"}],"owner":"19175603","collectionId":"470d91f8-1ea4-4d28-80f6-e34e5b8aa9e1","publishedId":"2s8YzP3R29","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-01-09T18:10:26.000Z"},"item":[{"name":"Authentication","item":[{"name":"Generate Oauth2 Token","event":[{"listen":"test","script":{"exec":["pm.environment.set('access_token', JSON.parse(responseBody).access_token);"],"type":"text/javascript","id":"81d4698c-8c41-48da-a7d9-3b687d81ce49"}}],"id":"dc3773f9-9835-4481-b7af-e38dc513fa3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/auth/token","description":"

The client token endpoint generates a security token using a Client ID and Secret pair. The token may then be used to authenticate subsequent requests to the API.

It must be placed inside the header of each request as a Bearer Token. Authorization: Bearer {TOKEN}

\n","urlObject":{"path":["auth","token"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc3773f9-9835-4481-b7af-e38dc513fa3b"}],"id":"638fe71a-abd6-436a-a364-0fd95f9cd7eb","description":"

The Dynamic Yard APIs use Oauth2 for authentication. Specifically, the “client_credentials” authorization flow is utilized as a means of generating a bearer token which can be used for follow-up requests.

When sending in a request for an Oauth2 token, a client_id and client_secret are utilized. These values are passed in a JSON body to the token URL which will issue an access_token if the request is successful. The client_id and client_secret can be generated under the “API Access” section with administrator access to the application.

\n","_postman_id":"638fe71a-abd6-436a-a364-0fd95f9cd7eb"},{"name":"Manage Shipment Data","item":[{"name":"Appointments","item":[{"name":"Create Appointment","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"d7730d5a-b5b2-4cd7-9327-5673c202e7cd"}}],"id":"40dfaef1-aba2-4ea7-bf8f-becb4806e82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

Create a delivery associated with an appointment.

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"2d1e045c-28c5-411a-9f43-3dc3efbcfd13","name":"Create Appointment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\",\n \"type\": \"Inbound_Only\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:30:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"C4650AAB_B7D2\"\n"}],"_postman_id":"40dfaef1-aba2-4ea7-bf8f-becb4806e82e"},{"name":"Create Appointment at Dock","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"9f6a95b6-c569-46bb-947a-720421bf0468"}}],"id":"01e3f789-2979-4943-be22-48c113daf04f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"name\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"route_id\": \"HT8485\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\",\n \"location\": {\n \"dock_name\": \"Shipping Dock\",\n \"door_name\": \"Door 38\"\n }\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\",\n \"type\": \"Inbound_Only\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"640eab08-d8f7-48b4-9bd2-0f93dc3f77cd","name":"Create Appointment at Dock","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"name\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"route_id\": \"HT8485\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\",\n \"location\": {\n \"dock_name\": \"Shipping Dock\",\n \"door_name\": \"Door 38\"\n }\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\",\n \"type\": \"Inbound_Only\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Feb 2022 22:07:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"E2EA8B97_0C26\""}],"_postman_id":"01e3f789-2979-4943-be22-48c113daf04f"},{"name":"Appointment w/ Inbound Trailer","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"6ee3d11f-dcd5-491d-9ef4-4eff4df445bb"}}],"id":"94f222ee-3c3f-441e-ab1b-c46e4085c9bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

If attributes about the inbound trailer are known ahead of time, specific attributes about the trailer scheduled to haul the delivery can be pre-populated. This means that when the gate checks in the delivery at the facility, the trailer attributes will pre-populate on the check-in form, prevent errors and dual entry.

Attributes about an expected inbound trailer are added in the inbound_trailer object. This object has a list of optional fields which will be pre-populated on the trailer check-in form if the delivery created in this message is selected.

{\n    \"assignments\": [\n        {...}\n    ],\n    \"inbound_trailer\": {...}\n}\n\n

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"dc338764-82b3-4750-98ff-8edf4cddfd78","name":"Create Appointment - Inbound Trailer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\",\n \"type\": \"Inbound_Only\",\n \"inbound_trailer\": {\n \"name\": \"94858394\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:31:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"542144B8_68F2\"\n"}],"_postman_id":"94f222ee-3c3f-441e-ab1b-c46e4085c9bf"},{"name":"Appointment w/ Outbound Trailer","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"9c25e921-9727-4556-96ae-d9ead2958c55"}}],"id":"197d42ff-85d2-4543-806b-f4a2d5526dec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

Similar to the inbound trailer object, you can add attributes about the trailer expected to depart from the facility in the outbound_trailer object. This object has a list of optional fields which will be pre-populated on the trailer check-in form if the delivery created in this message is selected.

{\n    \"assignments\": [\n        {...}\n    ],\n    \"outbound_trailer\": {...}\n}\n\n

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"e556ee5e-111a-40f8-b197-cb7c8807105a","name":"Create Appointment - Outbound Trailer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_departure_end\": {{scheduled_time}},\n \"scheduled_departure_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Outbound\"\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\",\n \"type\": \"Outbound_Only\",\n \"outbound_trailer\": {\n \"name\": \"94858FSD394\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:31:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"F6C23976_D71B\"\n"}],"_postman_id":"197d42ff-85d2-4543-806b-f4a2d5526dec"},{"name":"Appointment w/ Drop and Hook","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"5bd92d10-6555-4f80-b598-5113a0791b51"}}],"id":"610bceed-dfd6-4647-918a-9c0ade236fbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

In the case of a drop-and-hook scenario, both the inbound and outbound deliveries can be created along with the associated trailers. This is a combination of all of the above scenarios, but with type of the appointment specified as Drop_and_Hook.

If all deliveries/trailers are not known at the same time then it is advisable to break apart the API and send separate requests with an Inbound_Only and Outbound_Only rather than as a single Drop_and_Hook movement.

Required Fields for Drop and Hook

In order to fully create a drop-and-hook scenario with the Appointment API, both the inbound and outbound deliveries need to be specified along with their associated trailer. If not, errors will result on the API:

{\n    \"error_code\": 3067,\n    \"error_message\": \"yms.v1.errors: TMS appointment payload is invalid no inbound assignments, inbound trailer requires inbound assignments\"\n}\n\n

{\n    \"error_code\": 3067,\n    \"error_message\": \"yms.v1.errors: TMS appointment payload is invalid no outbound assignments, outbound trailer requires outbound assignments\"\n}\n\n

Or in the case of a missing inbound_trailer or outbound_trailer object:

{\n    \"error_code\": 3067,\n    \"error_message\": \"yms.v1.errors: TMS appointment payload is invalid inbound trailer not defined, Drop_and_Hook inbound and outbound trailers have to be defined\"\n}\n\n

{\n    \"error_code\": 3067,\n    \"error_message\": \"yms.v1.errors: TMS appointment payload is invalid outbound trailer not defined, Drop_and_Hook inbound and outbound trailers have to be defined\"\n}\n\n

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"7eee09f5-5973-40df-b9d0-f6ee6592cb7e","name":"Create Appointment - Drop and Hook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"TMS\"\n },\n \"direction\": \"Inbound\"\n },\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"origin_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_departure_end\": {{scheduled_time}},\n \"scheduled_departure_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"TMS\"\n },\n \"direction\": \"Outbound\"\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"TMS\",\n \"type\": \"Drop_and_Hook\",\n \"inbound_trailer\": {\n \"name\": \"HS9SDS3S85\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\"\n },\n \"outbound_trailer\": {\n \"name\": \"US9SDS3S85\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:31:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"52319DE3_580B\"\n"}],"_postman_id":"610bceed-dfd6-4647-918a-9c0ade236fbf"},{"name":"Appointment w/ Custom Attributes","event":[{"listen":"prerequest","script":{"id":"6ee3d11f-dcd5-491d-9ef4-4eff4df445bb","exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript"}}],"id":"5e0a76c5-be8c-4532-940c-16db31818afb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

Custom Trailer Attributes

The additional_attributes array contains a list of custom attributes created on the trailer check-in form and are configured in the Nomenclature setup. Once configured, please work with your FourKites Delivery Consultant to obtain the specific JSON keys which correlate to your custom trailer attributes.

Format

The format of additional_attributes are as keys inside an object. An example is below. In this example, there are 2 additional attributes which are associated with the trailer:

{\n    \"assignments\": [\n        { ... }\n    ],\n    \"id\": \"N8475664\",\n    \"site_code\": \"SS03\",\n    \"tms\": \"Customer_TMS\",\n    \"type\": \"Inbound_Only\",\n    \"inbound_trailer\": {\n        \"name\": \"94858394\",\n        \"type\": \"Container\",\n        \"carrier_code\": \"0010\",\n        \"seal\": \"A45733QR\",\n        \"seal_status\": \"Intact\",\n        \"additional_attributes\": {\n            \"customer_number\": \"3658\",\n            \"building_code\": \"B856\"\n        }\n    }\n}\n\n

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"e07ea310-bd17-4369-bd30-3b2a52beb3c6","name":"Appointment w/ Custom Attributes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"name\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"tms\": \"Customer_TMS\",\n \"type\": \"Inbound_Only\",\n \"inbound_trailer\": {\n \"name\": \"HGIU845297\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\",\n \"additional_attributes\": {\n \"customer\": \"ABC, Inc\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Fri, 17 Mar 2023 20:33:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"1217CE08_E37F\"\n"}],"_postman_id":"5e0a76c5-be8c-4532-940c-16db31818afb"},{"name":"Update Appointment","event":[{"listen":"prerequest","script":{"exec":["let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"ae1756b8-f746-419b-8afb-b816e8d7ae07"}}],"id":"1f177ee3-67fa-4761-8bd2-91bdbcb07a66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"id\": \"{{delivery_id}}\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"site_code\": \"{{site_code}}\",\n \"type\": \"Inbound_Only\",\n \"inbound_trailer\": {\n \"name\": \"948SD583T94\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/appointments/{{appointment_id}}","description":"

When updating an appointment, the only details which can be changed are those outside of the assignments section. Delivery details cannot be updated using the Update Appointment operation. If you need to update delivery details, please see the Update Delivery API call under the \"Deliveries\" folder in the next section.

Updating Appointment Fields

The most common data points which are updated on an appointment including the following objects. In keeping with the differentiation between managing appointments vs deliveries, an \"appointment\" encompasses a delivery, an expected truck, expected carrier, and expected trailer. If those details are not known, then it might be advisable to use the Create Delivery API to manage delivery information in Dynamic Yard.

tractor : object containing information about the inbound tractor/truck which will be arriving with or picking up the delivery from the facility
inbound_trailer : object containing information about the inbound trailer which holds the inbound delivery to be unloaded at the facility
outbound_trailer: object containing information about the inbound trailer which will be loaded with the outbound delivery

\n","urlObject":{"path":["tms","v1","tms","Customer_TMS","appointments","{{appointment_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"989db5ac-d174-4d87-9c87-63a5ba5a20bd","name":"Update Appointment","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignments\": [\n {\n \"delivery\": {\n \"id\": \"{{delivery_id}}\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"site_code\": \"{{site_code}}\",\n \"type\": \"Inbound_Only\",\n \"inbound_trailer\": {\n \"name\": \"948SD583T94\",\n \"type\": \"Container\",\n \"carrier_code\": \"{{scac}}\",\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/appointments/{{appointment_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:31:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"null\n"}],"_postman_id":"1f177ee3-67fa-4761-8bd2-91bdbcb07a66"},{"name":"Delete Appointment","id":"b1565936-c3c9-4214-9843-45de8fcc252a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/appointments/{{delivery_id}}","description":"

Delete an existing delivery. The delivery must be present in the system for the API call to be successful.

NOTE: This API is the same as the Delete Delivery API as the functionality is the same. In both situations, deleting the delivery object will remove any associated appointment and its trailer associations.

\n","urlObject":{"path":["tms","v1","tms","Customer_TMS","appointments","{{delivery_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"acea5647-93f4-4b19-b8b4-96531a8dba34","name":"Delete Appointment","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/appointments/{{delivery_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 16:15:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"\""}],"_postman_id":"b1565936-c3c9-4214-9843-45de8fcc252a"}],"id":"8365d04a-4efe-47a3-89b5-621e04e797f0","description":"

The Appointment API allows a customer system to add one or multiple deliveries in Dynamic Yard. Additionally, the Appointment API has the added benefit of associating an expected trailer, carrier, seal number, or other attributes with the delivery object. This allows more data points to pre-populate on the trailer when checked in by the gate.

You must supply a unique id and tms combination in the payload, along with the site_code of the site for which you are populating the delivery
Origin and Destination can be supplied using the site_code for each site

Managing Dock Schedules

An additional benefit of the Appointment API is that supports a location attribute which can pre-populate a dock door which can be used to unload / load that specific delivery. The location is also generalized so that if you'd like the facility to determine the exact door based upon availability, you can simply specify the dock_name so that the gate or the yard can determine the exact door_name at a later time.

Please see the Create Appointment at Dock API sample for an example of how to designate a specific dock or door for the delivery.

Field Definitions

Assignments / Delivery Object

The following fields are defined within each delivery object. As an appointment could have one or more deliveries associated with it, the assignments field supports an array of values:

{\n    \"assignments\": [\n        {\n           \"delivery\":{...}\n        }\n    ]\n}\n\n

delivery.tms
- Type: String
- Required: M
- Description: The name of the TMS source. If not applicable, can be defaulted to \"TMS\"
\n
delivery.id
- Type: String
- Required: M
- Description: Number/ID of the specific delivery associated with the trailer. In most situations, this field can be the same as the name field listed below, but it must be unique. If your shipment numbers may repeat or be recycled over time, it is recommended to use a more unique identifier as the id and send the UI-facing identifier for the shipment/delivery in the name field shown below
\n
delivery.bill_of_lading
- Type: String
- Required: O
- Description: Shipment number of Bill of Lading associated with the delivery
\n
delivery.name
- Type: String
- Required: O
- Description: Name/identifier of the Delivery which will show up in the UI. If unloading the trailer then it is the delivery that needs to be unloaded. If loading the trailer then it is the delivery that needs to be loaded
\n
delivery.site_code
- Type: String
- Required: M
- Description: The code of the site to which this delivery belongs
\n
delivery.route_id
- Type: String
- Required: O
- Description: Code associated with the route
\n
delivery.origin_code
- Type: String
- Required: CM*
- Description: Code of the origin site. *Must be populated if the destination_code is not present
\n
delivery.destination_code
- Type: String
- Required: CM*
- Description: Code of the destination site. *Must be populated if the origin_code is not present
\n
delivery.scheduled_arrival_start
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Earliest time the delivery is scheduled to arrive, if inbound to the facility. This is represented in Unix seconds
\n
delivery.scheduled_arrival_end
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Latest time the delivery is scheduled to arrive, if inbound to the facility. This is represented in Unix seconds
\n
delivery.scheduled_departure_start
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Earliest time the delivery is scheduled to depart, if outbound from the facility. This is represented in Unix seconds
\n
delivery.scheduled_departure_end
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Latest time the delivery is scheduled to depart, if outbound from the facility. This is represented in Unix seconds
\n
delivery.estimated_arrival_time
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Latest time the delivery is scheduled to depart, if outbound from the facility. This is represented in Unix seconds
\n
priority
- Type: String
- Required: O
- Description: Sets the priority of the delivery at the site. Valid values: Normal | Priority | Expedited
\n
direction
- Type: String
- Required: M
- Description: Specifies whether the delivery is inbound or outbound
\n

Appointment Fields

Appointment fields apply to all deliveries specified in the assignments array above:

{\n    \"assignments\": [\n        {\n           \"delivery\":{...}\n        }\n    ],\n    ... appointment fields ...\n}\n\n

id
- Type: String
- Required: M
- Description: Identifier of the appointment. If creating a single delivery through the API, it is recommended to make this the same as the delivery ID
\n
site_code
- Type: String
- Required: M
- Description: The code of the site to which this appointment belongs
\n
tms
- Type: String
- Required: M
- Description: The name of the TMS source. If not applicable, can be defaulted to \"TMS\"
\n
type
- Type: String
- Required: M
- Description: Type of delivery. Valid values: Live | Drop_and_Hook | Inbound_Only | Outbound_Only | Check_in_Only
\n

Inbound / Outbound Trailer Fields

name
- Type: String
- Required: O
- Description: UI facing trailer name/number which will pre-populate when the delivery is selected
\n
type
- Type: String
- Required: O
- Description: Trailer type which will prepopulate when the delivery is selected
\n
carrier_code
- Type: String
- Required: O
- Description: Carrier code which will prepopulate when the delivery is selected. Must be a valid carrier code configured in the site
\n
seal
- Type: String
- Required: O
- Description: Seal number which will prepopulate when the delivery is selected
\n
seal_status
- Type: String
- Required: O
- Description: Seal status which will prepopulate when the delivery is selected
\n

\n","_postman_id":"8365d04a-4efe-47a3-89b5-621e04e797f0"},{"name":"Deliveries","item":[{"name":"Create Delivery - Inbound","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"17e02efa-78c8-4ff4-94cd-733f420205b9"}}],"id":"6a1cdf03-4e28-4908-b4a3-abc219458747","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"tms\": \"Customer_TMS\",\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"name\": \"{{delivery_id}}\",\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"priority\": \"Normal\",\n \"external_url\": \"http://delivery.external.url\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/deliveries/","description":"

Create a single delivery that is meant to be unloaded at the facility (Inbound).

\n","urlObject":{"path":["tms","v1","deliveries",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"70ac88ed-9721-4506-9ffc-888c3a15c252","name":"Create Delivery - Inbound","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tms\": \"Customer_TMS\",\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"name\": \"{{delivery_id}}\",\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"priority\": \"Normal\",\n \"external_url\": \"http://delivery.external.url\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/deliveries/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:33:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"0D4C50AA_57D8\"\n"}],"_postman_id":"6a1cdf03-4e28-4908-b4a3-abc219458747"},{"name":"Create Delivery - Outbound","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","","pm.environment.set('delivery_id', id + '_' + id_str);","pm.environment.set('appointment_id', id + '_' + id_str);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"724beba8-1dbd-4c2f-bdcd-7a321457d108"}}],"id":"6a9d8735-0dc3-4ff4-b5de-4083e4c7e2da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"tms\": \"Customer_TMS\",\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"name\": \"{{delivery_id}}\",\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"origin_code\": \"{{site_code}}\",\n \"scheduled_departure_start\": {{scheduled_time}},\n \"scheduled_departure_end\": {{scheduled_time}},\n \"priority\": \"Normal\",\n \"external_url\": \"http://delivery.external.url\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/deliveries/","description":"

Create a single delivery that is meant to be loaded and shipped from the facility (Outbound).

\n","urlObject":{"path":["tms","v1","deliveries",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"61a3c8e9-9aee-4f90-b446-6b7d9d18309f","name":"Create Delivery - Outbound","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tms\": \"Customer_TMS\",\n \"id\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"name\": \"{{delivery_id}}\",\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"origin_code\": \"{{site_code}}\",\n \"scheduled_departure_start\": {{scheduled_time}},\n \"scheduled_departure_end\": {{scheduled_time}},\n \"priority\": \"Normal\",\n \"external_url\": \"http://delivery.external.url\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/deliveries/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:33:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"85FE20AF_595B\"\n"}],"_postman_id":"6a9d8735-0dc3-4ff4-b5de-4083e4c7e2da"},{"name":"Update Delivery","event":[{"listen":"prerequest","script":{"exec":["let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000))","pm.environment.set('scheduled_time', scheduled_time)"],"type":"text/javascript","id":"f1508260-f217-4c05-8c08-61d107620dbf"}}],"id":"96d56a7c-196a-4401-ba7e-0a8da24e8801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"tms\": \"Customer_TMS\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/deliveries/{{delivery_id}}","description":"

Updating fields on a delivery can be done regardless of whether the delivery is created as part of an appointment (see previous section) or as a standalone delivery without appointment details associated with it (truck, trailer, carrier, etc.). When updating a delivery, details about the shipment are being changed as opposed to the equipment and carrier responsible for hauling the shipment.

\n
If your organization does not know information about the carrier, truck or trailer expected to arrive at a facility, it is advisable to simply use the Deliveries API and not use the Appointments API. \"Appointments\" in Dynamic Yard encompass information about equipment, carrier, and other information. You should only use Appointments if that information is known by your organization prior to being checked in at the facility
\n

\n","urlObject":{"path":["tms","v1","tms","Customer_TMS","deliveries","{{delivery_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"2e4f1826-b6fc-4010-ac47-f81ecd562c98","name":"Update Delivery","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"destination_code\": \"{{site_code}}\",\n \"id\": \"{{delivery_id}}\",\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"tms\": \"Customer_TMS\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/deliveries/{{delivery_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:33:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\"85FE20AF_595B\"\n"}],"_postman_id":"96d56a7c-196a-4401-ba7e-0a8da24e8801"},{"name":"Delete Delivery","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"765fa2a7-1436-4557-b1f5-ee70a9346aa3"}}],"id":"ebdef660-d18c-4813-a75b-df8832461ddc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/deliveries/{{delivery_id}}","description":"

Delete an existing delivery in the application.

The Delivery API allows a customer system to add a delivery in Dynamic Yard. A delivery is associated with a load and can be tied to a trailer during gate check-in.

You must supply a unique id and tms combination in the payload, along with the site_code of the site for which you are populating the delivery
Origin and Destination can be supplied using the site_code for each site

Field Definitions

tms
- Type: String
- Required: M
- Description: The name of the TMS source. If not applicable, can be defaulted to \"TMS\"
\n
id
- Type: String
- Required: M
- Description: Number/ID of the specific delivery associated with the trailer. If unloading the trailer then it is the delivery that needs to be unloaded. If loading the trailer then it is the delivery that needs to be loaded
\n
name
- Type: String
- Required: O
- Description: A name for the delivery that does not have to be unique. If not provided, this will be set to the TMS identifier for the delivery
\n
bill_of_lading
- Type: String
- Required: M
- Description: Bill of Lading associated with the delivery
\n
site_code
- Type: String
- Required: M
- Description: The code of the site to which this delivery is scheduled to be unloaded / loaded at
\n
route_id
- Type: String
- Required: O
- Description: Code associated with the route
\n
origin_code
- Type: String
- Required: CM*
- Description: Code of the origin site. *Must be populated if the \"destination_code\" is not present
\n
destination_code
- Type: String
- Required: CM*
- Description: Code of the destination site. *Must be populated if the \"origin_code\" is not present
\n
scheduled_arrival_start
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Earliest time the delivery is scheduled to arrive. This is represented in Unix seconds
\n
scheduled_arrival_end
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Latest time the delivery is scheduled to arrive. This is represented in Unix seconds
\n
scheduled_departure_start
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Earliest time the delivery is scheduled to depart. This is represented in Unix seconds
\n
scheduled_departure_end
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Latest time the delivery is scheduled to depart. This is represented in Unix seconds
\n
estimated_arrival_time
- Type: Unix Date/Time (Int64)
- Required: O
- Description: Estimated time the delivery is scheduled to arrive. This is represented in Unix seconds
\n
priority
- Type: String
- Required: O
- Description: Sets the priority of the delivery at the site. Valid values: Normal | Priority | Expedited
\n
external_url
- Type: String
- Required: O
- Description: External URL which can take users to more details about the delivery in an external system
\n

\n","_postman_id":"e7e8cf90-3a92-4126-833c-eebbe8b99ff8"},{"name":"Get Requests","item":[{"name":"Get Appointments","id":"b5c26108-4c8e-48e7-aee1-e745a344ab98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}","description":"

Pulls a list of appointments at the specified site.

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Filter by unique site code within Dynamic Yard

\n","type":"text/plain"},"key":"site_code","value":"{{site_code}}"}],"variable":[]}},"response":[{"id":"68428bdf-7b78-468d-be8c-0a4fb28b7c00","name":"Get Appointments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"}]}},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"assignments\": [\n {\n \"direction\": \"Inbound\"\n }\n ],\n \"inbound_trailer\": {\n \"additional_attributes\": {\n \"shipper_number\": \"12345\"\n },\n \"audit\": null,\n \"audit_note\": null,\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_code\": \"0010\",\n \"carrier_id\": 1830,\n \"check_in_time\": 1641480012.1748517,\n \"check_out_time\": null,\n \"comments\": null,\n \"condition\": null,\n \"damage\": null,\n \"damage_note\": null,\n \"delivery_ids\": [\n 9558\n ],\n \"door_info\": null,\n \"fuel_level\": null,\n \"id\": 11031,\n \"load_status\": \"Full\",\n \"load_type\": \"Inbound Production\",\n \"location_id\": null,\n \"name\": \"805C5AA\",\n \"out_of_service\": null,\n \"out_of_service_note\": null,\n \"parking_info\": null,\n \"preferred_locations\": {\n \"docks\": [],\n \"doors\": [],\n \"parking_lots\": [],\n \"parking_spots\": []\n },\n \"process_status\": \"Loaded\",\n \"product_protection_check_source_name\": null,\n \"product_protection_check_source_type\": null,\n \"product_protection_check_time\": null,\n \"product_protection_check_user_id\": null,\n \"ready\": null,\n \"refrigerated\": false,\n \"refrigeration_status\": \"Not_Available\",\n \"seal\": \"SEAL948584\",\n \"seal_status\": \"Intact\",\n \"site_id\": 396,\n \"site_name\": \"Sample Site 03\",\n \"site_owner_code\": null,\n \"site_owner_id\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1641488439.5436454,\n \"switcher_vehicle_id\": null,\n \"tag_code\": null,\n \"temperature\": null,\n \"temperature_display_unit\": null,\n \"temperature_set_point\": null,\n \"trailer_id\": 2017,\n \"trailer_name\": \"805C5AA\",\n \"trailer_type\": \"Container\",\n \"trailer_type_id\": 239,\n \"usage\": null,\n \"user_id\": 646\n },\n \"site_code\": \"SS03\",\n \"tractor\": {\n \"carrier_code\": \"0010\",\n \"license_country\": \"USA\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"name\": \"Bill McDriver\",\n \"phone\": \"(120)111-2222\"\n },\n \"type\": \"Inbound_Only\"\n }\n ]\n}"}],"_postman_id":"b5c26108-4c8e-48e7-aee1-e745a344ab98"},{"name":"Get Appointment by ID","id":"82354c11-6f77-4903-8f36-9a64182b3580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&id={{appointment_id}}&tms=TMS","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Filter by unique site code within Dynamic Yard

\n","type":"text/plain"},"key":"site_code","value":"{{site_code}}"},{"description":{"content":"

Unique identifier for the appointment. Please see the \"id\" field of the Appointment fields for more information

\n","type":"text/plain"},"key":"id","value":"{{appointment_id}}"},{"description":{"content":"

Specific TMS associated with the appointment. Can be defaulted when creating appointments

\n","type":"text/plain"},"key":"tms","value":"TMS"}],"variable":[]}},"response":[{"id":"1a6bd4ef-56e1-4edd-b0f1-e98e3ae47d13","name":"Get Appointment by ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&id={{appointment_id}}&tms=TMS","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"},{"key":"id","value":"{{appointment_id}}","description":"Unique identifier for the appointment. Please see the \"id\" field of the Appointment fields for more information"},{"key":"tms","value":"TMS","description":"Specific TMS associated with the appointment. Can be defaulted when creating appointments"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 May 2022 13:09:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"55E6B5EF\",\n \"destination_code\": \"SS03\",\n \"id\": \"55E6B5EF_5664\",\n \"route_id\": \"PRO9838759\",\n \"scheduled_arrival_end\": 1641481564,\n \"scheduled_arrival_start\": 1641481564,\n \"site_code\": \"SS03\",\n \"tms\": \"TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"id\": \"55E6B5EF_5664\",\n \"inbound_trailer\": {\n \"additional_attributes\": null,\n \"audit\": null,\n \"audit_note\": null,\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_code\": \"0010\",\n \"carrier_id\": 1830,\n \"check_in_time\": null,\n \"check_out_time\": null,\n \"comments\": null,\n \"condition\": null,\n \"damage\": null,\n \"damage_note\": null,\n \"delivery_ids\": [],\n \"door_info\": null,\n \"id\": 10971,\n \"load_status\": null,\n \"load_type\": null,\n \"location_id\": null,\n \"name\": null,\n \"old_tag_code\": null,\n \"out_of_service\": null,\n \"out_of_service_note\": null,\n \"parking_info\": null,\n \"preferred_locations\": {\n \"docks\": [],\n \"doors\": [],\n \"parking_lots\": [],\n \"parking_spots\": []\n },\n \"process_status\": null,\n \"ready\": null,\n \"refrigerated\": null,\n \"seal\": \"hello545345\",\n \"seal_status\": null,\n \"site_id\": null,\n \"site_name\": null,\n \"site_owner_code\": null,\n \"site_owner_id\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1641481564.5422013,\n \"switcher_vehicle_id\": null,\n \"tag_code\": null,\n \"tag_type_id\": null,\n \"trailer_id\": 2024,\n \"trailer_name\": null,\n \"trailer_type\": null,\n \"trailer_type_id\": null,\n \"usage\": null,\n \"user_id\": null\n },\n \"site_code\": \"SS03\",\n \"tms\": \"TMS\",\n \"tractor\": {\n \"carrier_code\": null,\n \"name\": null\n },\n \"type\": \"Inbound_Only\"\n }\n ],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 1\n}"},{"id":"9bf2278b-e5a7-4c43-ab8f-6360ecc93c4d","name":"No Matching Appointments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&id={{appointment_id}}&tms=TMS","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"},{"key":"id","value":"{{appointment_id}}","description":"Unique identifier for the appointment. Please see the \"id\" field of the Appointment fields for more information"},{"key":"tms","value":"TMS","description":"Specific TMS associated with the appointment. Can be defaulted when creating appointments"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 May 2022 13:11:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 0\n}"}],"_postman_id":"82354c11-6f77-4903-8f36-9a64182b3580"},{"name":"Get Appointment by Inbound Trailer","id":"9c69c4b1-7157-4568-83cd-c987140dab47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&inbound_trailer_name=84754875848HSH","description":"

You can also fetch a list of appointments by the equipment (trailer, container, etc.). This will return information about the inbound/outbound trailer along with the appointment it is associated with. This is helpful in situations where you want to get a list of any pending deliveries, the scheduled appointment, and trailer information based on just the equipment identifier.

Query Parameters

Valid parameters include:

inbound_trailer_name: any appointments which are associated with the inbound trailer will return
outbound_trailer_name: any appointments which are associated with the outbound trailer will return

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Filter by unique site code within Dynamic Yard

\n","type":"text/plain"},"key":"site_code","value":"{{site_code}}"},{"description":{"content":"

Inbound trailer associated with the appointment

\n","type":"text/plain"},"key":"inbound_trailer_name","value":"84754875848HSH"}],"variable":[]}},"response":[{"id":"e9286936-2b53-4beb-a3bc-50db07321da0","name":"Get Appointment by Inbound Trailer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&inbound_trailer_name=84754875848HSH","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"},{"key":"inbound_trailer_name","value":"84754875848HSH"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 May 2022 19:22:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"additional_attributes\": {\n \"vessel_status\": \"AG\"\n },\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"C8EF3500_677B\",\n \"destination_code\": \"SS03\",\n \"id\": \"C8EF3500_677B\",\n \"scheduled_arrival_end\": 1653420118,\n \"scheduled_arrival_start\": 1653420118,\n \"site_code\": \"SS03\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Inbound\"\n }\n ],\n \"id\": \"new_appointment_id_1\",\n \"inbound_trailer\": {\n \"additional_attributes\": null,\n \"audit\": null,\n \"audit_note\": null,\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_code\": \"ATCL\",\n \"carrier_id\": 4605,\n \"check_in_time\": null,\n \"check_out_time\": null,\n \"comments\": null,\n \"condition\": null,\n \"damage\": null,\n \"damage_note\": null,\n \"delivery_ids\": [],\n \"device_number\": null,\n \"door_info\": null,\n \"id\": 47273,\n \"load_status\": null,\n \"load_type\": null,\n \"location_id\": null,\n \"name\": \"84754875848HSH\",\n \"old_tag_code\": null,\n \"out_of_service\": null,\n \"out_of_service_note\": null,\n \"parking_info\": null,\n \"preferred_locations\": {\n \"docks\": [],\n \"doors\": [],\n \"parking_lots\": [],\n \"parking_spots\": []\n },\n \"process_status\": null,\n \"ready\": null,\n \"refrigerated\": false,\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\",\n \"site_id\": null,\n \"site_name\": null,\n \"site_owner_code\": null,\n \"site_owner_id\": null,\n \"site_time_zone\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1653420118.618945,\n \"switcher_vehicle_id\": null,\n \"tag_code\": null,\n \"tag_type_id\": null,\n \"trailer_id\": 11985,\n \"trailer_name\": \"84754875848HSH\",\n \"trailer_type\": \"Container\",\n \"trailer_type_id\": 239,\n \"usage\": null,\n \"user_id\": null\n },\n \"site_code\": \"SS03\",\n \"tms\": \"Customer_TMS\",\n \"tractor\": {\n \"carrier_code\": null,\n \"name\": null\n },\n \"type\": \"Inbound_Only\"\n }\n ],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 1\n}"},{"id":"7d95b9c1-b722-4285-b496-a19a608ea61c","name":"No Matching Trailer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&inbound_trailer_name=2D42B6CN","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"},{"key":"inbound_trailer_name","value":"2D42B6CN"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 May 2022 19:20:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 0\n}"}],"_postman_id":"9c69c4b1-7157-4568-83cd-c987140dab47"},{"name":"Get Appointment by Outbound Trailer","id":"fdb5f4a2-6e88-42ee-b23a-97a64e0a245b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&outbound_trailer_name=HSUE9385","description":"

Query Parameters

Valid parameters include:

inbound_trailer_name: any appointments which are associated with the inbound trailer will return
outbound_trailer_name: any appointments which are associated with the outbound trailer will return

\n","urlObject":{"path":["tms","v1","appointments",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Filter by unique site code within Dynamic Yard

\n","type":"text/plain"},"key":"site_code","value":"{{site_code}}"},{"description":{"content":"

Outbound trailer associated with the appointment

\n","type":"text/plain"},"key":"outbound_trailer_name","value":"HSUE9385"}],"variable":[]}},"response":[{"id":"578454b9-c908-492e-90a5-c11e58fc5915","name":"Get Appointment by Outbound Trailer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&outbound_trailer_name=HSUE9385","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"},{"key":"outbound_trailer_name","value":"HSUE9385","description":"Outbound trailer associated with the appointment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 May 2022 19:28:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"additional_attributes\": {\n \"vessel_status\": \"AG\"\n },\n \"assignments\": [\n {\n \"delivery\": {\n \"bill_of_lading\": \"4FC239BE_1A80\",\n \"destination_code\": \"SS03\",\n \"id\": \"4FC239BE_1A80\",\n \"scheduled_arrival_end\": 1653420497,\n \"scheduled_arrival_start\": 1653420497,\n \"site_code\": \"SS03\",\n \"tms\": \"Customer_TMS\"\n },\n \"direction\": \"Outbound\"\n }\n ],\n \"id\": \"4FC239BE_1A80\",\n \"outbound_trailer\": {\n \"additional_attributes\": null,\n \"audit\": null,\n \"audit_note\": null,\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_code\": \"ATCL\",\n \"carrier_id\": 4605,\n \"check_in_time\": null,\n \"check_out_time\": null,\n \"comments\": null,\n \"condition\": null,\n \"damage\": null,\n \"damage_note\": null,\n \"delivery_ids\": [],\n \"device_number\": null,\n \"door_info\": null,\n \"id\": 47275,\n \"load_status\": null,\n \"load_type\": null,\n \"location_id\": null,\n \"name\": \"HSUE9385\",\n \"old_tag_code\": null,\n \"out_of_service\": null,\n \"out_of_service_note\": null,\n \"parking_info\": null,\n \"preferred_locations\": {\n \"docks\": [],\n \"doors\": [],\n \"parking_lots\": [],\n \"parking_spots\": []\n },\n \"process_status\": null,\n \"ready\": null,\n \"refrigerated\": false,\n \"seal\": \"A45733QR\",\n \"seal_status\": \"Intact\",\n \"site_id\": null,\n \"site_name\": null,\n \"site_owner_code\": null,\n \"site_owner_id\": null,\n \"site_time_zone\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1653420497.9800668,\n \"switcher_vehicle_id\": null,\n \"tag_code\": null,\n \"tag_type_id\": null,\n \"trailer_id\": 11986,\n \"trailer_name\": \"HSUE9385\",\n \"trailer_type\": \"Container\",\n \"trailer_type_id\": 239,\n \"usage\": null,\n \"user_id\": null\n },\n \"site_code\": \"SS03\",\n \"tms\": \"Customer_TMS\",\n \"tractor\": {\n \"carrier_code\": null,\n \"name\": null\n },\n \"type\": \"Outbound_Only\"\n }\n ],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 1\n}"},{"id":"209c0e09-5504-477a-b8f9-311faefc0b29","name":"No Matching Trailer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/appointments/?site_code={{site_code}}&inbound_trailer_name=2D42B6CN","host":["{{dynamic_yard_url}}"],"path":["tms","v1","appointments",""],"query":[{"key":"site_code","value":"{{site_code}}","description":"Filter by unique site code within Dynamic Yard"},{"key":"inbound_trailer_name","value":"2D42B6CN"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 May 2022 19:20:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 0\n}"}],"_postman_id":"fdb5f4a2-6e88-42ee-b23a-97a64e0a245b"},{"name":"Get Deliveries","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"e3ae253e-ea4d-4e36-9570-59a28e0fa8f7"}}],"id":"76ed8eb2-f3c5-4b5f-83fd-83796f1e2fb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/deliveries/?page=0&page_size=50","description":"

Pulls a list of deliveries at the specified site.

\n","urlObject":{"path":["tms","v1","deliveries",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Page number to retrieve. The list of pages starts at 0

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

Number of deliveries per page to retrieve. Max size is 1000 per page

\n","type":"text/plain"},"key":"page_size","value":"50"}],"variable":[]}},"response":[{"id":"91c70ff1-96fd-4a64-bc05-376b5bdc9855","name":"Get Deliveries","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/deliveries/?page=1&page_size=50","host":["{{dynamic_yard_url}}"],"path":["tms","v1","deliveries",""],"query":[{"key":"page","value":"1","description":"Page number to retrieve"},{"key":"page_size","value":"50","description":"Number of deliveries per page to retrieve"}]}},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"actual_arrival_time\": null,\n \"actual_departure_time\": null,\n \"bill_of_lading\": \"81D927EB_ECA3\",\n \"canceled\": false,\n \"customer_info\": {\n \"customer_id\": null,\n \"customer_name\": null\n },\n \"destination_code\": null,\n \"destination_name\": null,\n \"direction\": \"Outbound\",\n \"estimated_arrival_time\": null,\n \"external_url\": \"http://delivery.external.url\",\n \"id\": \"81D927EB_ECA3\",\n \"name\": \"81D927EB_ECA3\",\n \"origin_code\": \"SS03\",\n \"origin_name\": \"Sample Site 03\",\n \"priority\": \"Normal\",\n \"processed\": false,\n \"route_id\": null,\n \"safety_check\": null,\n \"safety_check_time\": null,\n \"scheduled_arrival_end\": 1641599132,\n \"scheduled_arrival_start\": 1641599132,\n \"scheduled_departure_end\": null,\n \"scheduled_departure_start\": null,\n \"site_code\": \"SS03\",\n \"site_name\": \"Sample Site 03\",\n \"tms\": \"Customer_TMS\",\n \"trailer_info\": {\n \"carrier_code\": null,\n \"carrier_id\": null,\n \"carrier_name\": null\n }\n },\n {\n \"actual_arrival_time\": null,\n \"actual_departure_time\": null,\n \"bill_of_lading\": \"5C4194BF\",\n \"canceled\": false,\n \"customer_info\": {\n \"customer_id\": null,\n \"customer_name\": null\n },\n \"destination_code\": \"SS03\",\n \"destination_name\": \"Sample Site 03\",\n \"direction\": \"Inbound\",\n \"estimated_arrival_time\": null,\n \"external_url\": null,\n \"id\": \"F93C8AE8_4301\",\n \"name\": \"F93C8AE8_4301\",\n \"origin_code\": null,\n \"origin_name\": null,\n \"priority\": null,\n \"processed\": false,\n \"route_id\": \"PRO9838759\",\n \"safety_check\": null,\n \"safety_check_time\": null,\n \"scheduled_arrival_end\": 1641753450,\n \"scheduled_arrival_start\": 1641753450,\n \"scheduled_departure_end\": null,\n \"scheduled_departure_start\": null,\n \"site_code\": \"SS03\",\n \"site_name\": \"Sample Site 03\",\n \"tms\": \"TMS\",\n \"trailer_info\": {\n \"carrier_code\": null,\n \"carrier_id\": null,\n \"carrier_name\": null\n }\n }\n ],\n \"page_count\": 1,\n \"page_size\": 50,\n \"total\": 2\n}"}],"_postman_id":"76ed8eb2-f3c5-4b5f-83fd-83796f1e2fb9"},{"name":"Get Single Delivery","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"3bc6aa00-adee-43b4-9bfa-9abd2c302918"}}],"id":"76cf4bc0-2d51-48c0-8d0d-0434688c4904","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/deliveries/{{delivery_id}}","description":"

Get data for a single delivery. Must pass a valid delivery_id in the URL path.

\n","urlObject":{"path":["tms","v1","tms","Customer_TMS","deliveries","{{delivery_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"82c09301-87cb-430c-8962-679e7ed01f7e","name":"Get Single Delivery","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{dynamic_yard_url}}/tms/v1/tms/Customer_TMS/deliveries/{{delivery_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Wed, 12 Jan 2022 19:06:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"723"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"actual_arrival_time\":null,\"actual_departure_time\":null,\"bill_of_lading\":\"39F4E78F_D760\",\"canceled\":false,\"destination_code\":\"SS03\",\"destination_name\":\"Sample Site 03\",\"direction\":\"Inbound\",\"estimated_arrival_time\":null,\"external_url\":null,\"id\":\"39F4E78F_D760\",\"name\":\"39F4E78F_D760\",\"origin_code\":null,\"origin_name\":null,\"priority\":null,\"processed\":false,\"route_id\":\"HT8485\",\"safety_check\":null,\"safety_check_time\":null,\"scheduled_arrival_end\":1642014395,\"scheduled_arrival_start\":1642014395,\"scheduled_departure_end\":null,\"scheduled_departure_start\":null,\"site_code\":\"SS03\",\"site_name\":\"Sample Site 03\",\"tms\":\"Customer_TMS\",\"trailer_info\":{\"carrier_code\":null,\"carrier_id\":null,\"carrier_name\":null},\"trailer_name\":null}\n"}],"_postman_id":"76cf4bc0-2d51-48c0-8d0d-0434688c4904"},{"name":"Get Delivery by Delivery Name","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"fab57b01-b6d0-4c6b-917a-2e50dec8e229"}}],"id":"64bbf937-ae1a-4d69-9633-fb31f25ce41a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/deliveries/?name=63AD53CE_2976","urlObject":{"path":["tms","v1","deliveries",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Alphanumeric string matching the delivery ID (or \"name\") which is visible on the front-end. This value is set when creating the delivery

\n","type":"text/plain"},"key":"name","value":"63AD53CE_2976"}],"variable":[]}},"response":[{"id":"6dfb00f5-961f-46a6-b205-e8655735fbb3","name":"Get Delivery by Delivery Name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/deliveries/?name=63AD53CE_2976","host":["{{dynamic_yard_url}}"],"path":["tms","v1","deliveries",""],"query":[{"key":"name","value":"63AD53CE_2976"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 May 2022 21:34:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"912"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"actual_arrival_time\": null,\n \"actual_departure_time\": null,\n \"bill_of_lading\": \"63AD53CE_2976\",\n \"canceled\": false,\n \"customer_info\": {\n \"customer_id\": null,\n \"customer_name\": null\n },\n \"destination_code\": \"SS03\",\n \"destination_name\": \"Sample Site 03\",\n \"direction\": \"Inbound\",\n \"estimated_arrival_time\": null,\n \"external_url\": \"http://delivery.external.url\",\n \"id\": \"63AD53CE_2976\",\n \"load_reference_numbers\": null,\n \"name\": \"63AD53CE_2976\",\n \"origin_code\": null,\n \"origin_name\": null,\n \"po_numbers\": null,\n \"priority\": \"Normal\",\n \"processed\": false,\n \"reference_numbers\": null,\n \"route_id\": null,\n \"safety_check\": null,\n \"safety_check_time\": null,\n \"scheduled_arrival_end\": 1651257901,\n \"scheduled_arrival_start\": 1651257901,\n \"scheduled_departure_end\": null,\n \"scheduled_departure_start\": null,\n \"site_code\": \"SS03\",\n \"site_name\": \"Sample Site 03\",\n \"tms\": \"Customer_TMS\",\n \"trailer_info\": {\n \"carrier_code\": null,\n \"carrier_id\": null,\n \"carrier_name\": null\n }\n }\n ],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 1\n}"},{"id":"a53a926e-0291-4145-8d20-39b216c3a08c","name":"No Deliveries Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/deliveries/?name=63AD53CE_2977","host":["{{dynamic_yard_url}}"],"path":["tms","v1","deliveries",""],"query":[{"key":"name","value":"63AD53CE_2977"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 May 2022 21:35:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 0\n}"}],"_postman_id":"64bbf937-ae1a-4d69-9633-fb31f25ce41a"},{"name":"Get Delivery by BOL","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"faaf8f87-213c-4706-9776-2afb7df0576f"}}],"id":"73c0fd4c-cc31-4c63-8490-9cf3cb86872c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/tms/v1/deliveries/?bill_of_lading=63AD53CE_2977","urlObject":{"path":["tms","v1","deliveries",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Alphanumeric string which matches the delivery's bill of lading. This is set when creating the delivery and is an optional field

\n","type":"text/plain"},"key":"bill_of_lading","value":"63AD53CE_2977"}],"variable":[]}},"response":[{"id":"0825bc76-75b3-4330-b162-f5fdd0e59cbd","name":"Get Delivery by BOL","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/deliveries/?bill_of_lading=63AD53CE_2977","host":["{{dynamic_yard_url}}"],"path":["tms","v1","deliveries",""],"query":[{"key":"bill_of_lading","value":"63AD53CE_2977"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 May 2022 21:35:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"912"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"actual_arrival_time\": null,\n \"actual_departure_time\": null,\n \"bill_of_lading\": \"63AD53CE_2976\",\n \"canceled\": false,\n \"customer_info\": {\n \"customer_id\": null,\n \"customer_name\": null\n },\n \"destination_code\": \"SS03\",\n \"destination_name\": \"Sample Site 03\",\n \"direction\": \"Inbound\",\n \"estimated_arrival_time\": null,\n \"external_url\": \"http://delivery.external.url\",\n \"id\": \"63AD53CE_2976\",\n \"load_reference_numbers\": null,\n \"name\": \"63AD53CE_2976\",\n \"origin_code\": null,\n \"origin_name\": null,\n \"po_numbers\": null,\n \"priority\": \"Normal\",\n \"processed\": false,\n \"reference_numbers\": null,\n \"route_id\": null,\n \"safety_check\": null,\n \"safety_check_time\": null,\n \"scheduled_arrival_end\": 1651257901,\n \"scheduled_arrival_start\": 1651257901,\n \"scheduled_departure_end\": null,\n \"scheduled_departure_start\": null,\n \"site_code\": \"SS03\",\n \"site_name\": \"Sample Site 03\",\n \"tms\": \"Customer_TMS\",\n \"trailer_info\": {\n \"carrier_code\": null,\n \"carrier_id\": null,\n \"carrier_name\": null\n }\n }\n ],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 1\n}"},{"id":"fbd4c90d-c50f-45cc-8185-2b48159edcd5","name":"No Deliveries Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/tms/v1/deliveries/?bill_of_lading=63AD53CE_2977","host":["{{dynamic_yard_url}}"],"path":["tms","v1","deliveries",""],"query":[{"key":"bill_of_lading","value":"63AD53CE_2977"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 May 2022 21:37:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"page_count\": 1,\n \"page_size\": 100,\n \"total\": 0\n}"}],"_postman_id":"73c0fd4c-cc31-4c63-8490-9cf3cb86872c"}],"id":"50a3a2c8-7a33-4382-a0ff-955543e7e072","description":"

The following APIs are available to pull batch data out of Dynamic Yard. They are not designed to be injected into operational workflows, but they can be if the data is sufficient. The recommendation is to utilize webhooks to receive event-based data from Dynamic Yard whenever possible.

\n","_postman_id":"50a3a2c8-7a33-4382-a0ff-955543e7e072"}],"id":"2191f5d7-56a7-4083-b1cf-f30028f5cb03","description":"

The following section details APIs which typically map to data held in a Transportation Management System (TMS). Mainly, these APIs support creation of pending deliveries and shipments inside Dynamic Yard. Additional descriptions of the APIs can be found in the following sections.

Delivery Management

There are 2 methods for creating deliveries, depending upon the mix of FourKites products in use. For example, if the Core Tracking and Dynamic Yard products are used in tandem, then a single integration point can be leverage to both create trackable loads as well as pending deliveries at facilities in Dynamic Yard. Conversely, if only Dynamic Yard is being used, then alternate APIs can supply more targeted information for the application.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Product	API	Description
Core Track	Create Load	If the Core Track product is in use, then the Create Delivery / Load API should be used. Additionally, if there is an existing integration is in place with the Core Track product then no additional work needs to be done as part of the Dynamic Yard implementation
Appointment Manager	Create Load	If the Appointment Manager product is in use, then the Create Delivery / Load API should be used to create appointments and deliveries
Dynamic Yard	Delivery Appointment	If Dynamic Yard is being implemented as a standalone instance without Core Track or Appointment Manager, then either the Create Delivery API or Create Appointment API should be used. Please work with your FourKites integration engineer to understand which option is better suited for your instance

","_postman_id":"2191f5d7-56a7-4083-b1cf-f30028f5cb03"},{"name":"Manage Trailers","item":[{"name":"Equipment / Trailers","item":[{"name":"Update Trailer (Loaded)","id":"250d5a4b-8d43-41ae-96c7-2dc4d7a73267","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Loaded\",\n \"load_status\": \"Full\",\n \"delivery_names\": [\n \"{{delivery_id}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

Example request of a loaded (Full) trailer. Note the current process_status and load_status fields. Additionally, the delivery_names array has a delivery_id in it indicating that it is currently on the trailer.

\n","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"908ec903-d6f0-4556-8503-a927fd9f1561","name":"Update Trailer (Loaded)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": 2078,\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Loaded\",\n \"load_status\": \"Full\",\n \"delivery_names\": [\n \"0D4C50AA_57D8\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:35:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"2078\n"}],"_postman_id":"250d5a4b-8d43-41ae-96c7-2dc4d7a73267"},{"name":"Update Trailer (Unloaded)","id":"1d5415d1-e86c-4fcf-b5ee-ed5281035302","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

Example request of an unloaded (Empty) trailer. Note the changes in the process_status and load_status fields. Additionally, the delivery_names array is empty, indicating that no deliveries are currently on the trailer. The corresponding deliveries would be removed from the trailer in Dynamic Yard.

\n","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"413b84a2-265f-405d-a08d-0564f7866a87","name":"Update Trailer (Unloaded)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"2071\n"}],"_postman_id":"1d5415d1-e86c-4fcf-b5ee-ed5281035302"},{"name":"Update Trailer w/ Custom Attributes","id":"db0d99ba-4985-42e5-942d-dc4113abd154","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Load\",\n \"load_status\": \"Empty\",\n \"delivery_names\": [],\n \"additional_attributes\": [\n {\n \"type\": \"toggle\",\n \"name\": \"Passed Inspection Check?\",\n \"value\": \"yes\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

It's also possible to update custom attributes on a trailer using the Trailer Update API. First, please ensure that the custom trailer attributes have been configured on the Nomenclature section of the Dynamic Yard Admin portal. From there, you can use the field name (the name visible to users) to pass a value over the API.

The additional_attributes array can contain any number of custom attributes which you'd like to edit on a trailer:

\"additional_attributes\": [\n        {\n            \"type\": \"toggle\",\n            \"name\": \"Passed Inspection Check?\",\n            \"value\": \"Yes\"\n        },\n        {\n            \"type\": \"text\",\n            \"name\": \"Additional Freight Description\",\n            \"value\": \"30 pallets\"\n        }\n    ]\n\n

\n","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"3f5e11fe-246c-43d8-a280-149850f4b71a","name":"Update Trailer w/ Custom Attributes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Load\",\n \"load_status\": \"Empty\",\n \"delivery_names\": [],\n \"additional_attributes\": [\n {\n \"type\": \"toggle\",\n \"name\": \"Passed Inspection Check?\",\n \"value\": \"yes\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Jul 2022 12:20:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"6"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"25113"},{"id":"90eaa6eb-87be-4bf0-98e8-c16519d7810a","name":"Invalid Data Type","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Load\",\n \"load_status\": \"Empty\",\n \"delivery_names\": [],\n \"additional_attributes\": [\n {\n \"type\": \"boolean\",\n \"name\": \"Passed Inspection Check?\",\n \"value\": \"false\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Jul 2022 12:21:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"142"},{"key":"Connection","value":"keep-alive"},{"key":"content_type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": 2000,\n \"error_message\": \"yms_db.db.errors: Invalid input msg (Incorrect type field: should be one of the text, dropdown, toggle)\"\n}"},{"id":"a5c743a0-436d-46c2-86c5-fd6c05cb07c7","name":"Invalid Value","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Load\",\n \"load_status\": \"Empty\",\n \"delivery_names\": [],\n \"additional_attributes\": [\n {\n \"type\": \"toggle\",\n \"name\": \"Passed Inspection Check?\",\n \"value\": \"false\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Jul 2022 12:21:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"content_type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": 2000,\n \"error_message\": \"yms_db.db.errors: Invalid input msg (Type toggle should have 'yes' or 'no' values.)\"\n}"}],"_postman_id":"db0d99ba-4985-42e5-942d-dc4113abd154"},{"name":"Update Trailer Location (Door)","id":"fa94a792-22f4-4b87-8117-ce1ff9280a51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"trailer_number\": \"{{trailer_number}}\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 05\",\n \"dock_name\": \"Consumables Dock\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

It is possible to update the location of the trailer using the Update Trailer API. By using the dock_name and door_name fields, you can update the location to that specific door and see it reflected in Dynamic Yard. This should be used when locations need to be synced between the warehouse and the Dynamic Yard.

Note the optional fields which are present on this API payload:

door_name
- Type: String
- Required: O
- Description: Name for the specific door which the trailer's location should be placed into. If specified, this must be a door which is associated to the dock_name
\n
dock_name
- Type: String
- Required: O
- Description: Name for the specific dock which the trailer's location should be placed into. If specified, this must be a dock which is associated to the door_name
\n

The values in the sample payload below would update a trailer's location as shown in the screenshot

\n
Note: please ensure that you use a valid dock_name and door_name configured in your organization's Dynamic Yard platform. The values in the sample are test/demo values
\n

","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"110cbdac-92c6-4a4a-9c96-9248044d5ca4","name":"Update Trailer (Unloaded)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"2071\n"}],"_postman_id":"fa94a792-22f4-4b87-8117-ce1ff9280a51"},{"name":"Update Trailer Location (Yard)","id":"d0b64719-f47e-4a37-a028-9996b1bee73d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"trailer_number\": \"{{trailer_number}}\",\n \"site_code\": \"{{site_code}}\",\n \"parking_spot_name\": \"025\",\n \"parking_lot_name\": \"Rail Yard\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

It is possible to update the location of the trailer using the Update Trailer API. By using the parking_lot_name and parking_spot_name fields, you can update the location to that specific yard spot and see it reflected in Dynamic Yard. Most commonly, parking locations are managed in Dynamic Yard using drive-by inventory updates. However, if there is a reason that another external system must update a trailer's yard location, it can be achieved using the following fields.

Note the optional fields which are present on this API payload:

parking_spot_name
- Type: String
- Required: O
- Description: Name for the specific parking spot which the trailer's location should be placed into. If specified, this must be a spot which is associated to the parking_lot_name
\n
parking_lot_name
- Type: String
- Required: O
- Description: Name for the specific parking lot which the trailer's location should be placed into. If specified, this must be a parking lot which is associated to the parking_spot_name
\n

The values in the sample payload below would update a trailer's location as shown in the screenshot

\n
Note: please ensure that you use a valid parking_spot_name and parking_lot_name configured in your organization's Dynamic Yard platform. The values in the sample are test/demo values
\n

","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"171721fa-4e58-4438-9fef-75573c44321b","name":"Update Trailer (Unloaded)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"2071\n"}],"_postman_id":"d0b64719-f47e-4a37-a028-9996b1bee73d"},{"name":"Update Trailer Number","id":"1c18ccff-1cbc-4620-92d2-6cf1459652c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": 96630,\n \"carrier_code\": \"{{scac}}\",\n \"trailer_number\": \"3E52078\",\n \"site_code\": \"{{site_code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

When updating the trailer_number (what users see on the Dynamic Yard platform), you will need to specify the trailer_id so that Dynamic Yard knows which trailer to reference. Since the trailer_id is a static primary key generated by Dynamic Yard, this allows uniqueness across systems, even if the trailer_number needs to change.

\n","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"74383eea-0196-4b5a-a0a4-b8cc9e417fe7","name":"Update Trailer (Unloaded)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer •••••••","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": 69037,\n \"site_code\": \"SS03\",\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://dy-staging.fourkites.com/wms/v1/trailers/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"2071\n"}],"_postman_id":"1c18ccff-1cbc-4620-92d2-6cf1459652c7"}],"id":"34577991-d18a-4d9c-9905-8e18e39d1273","description":"

The Update Trailer API allows a customer system to change the status of the trailer and mark it as “unloaded” or “loaded”. In addition, deliveries can be removed or added based upon the loading status of those shipments. The API also supports process status changes.

Requires trailer_id as well as delivery_id
Optionally it receives actual_load, containing the load definition of what was actually unloaded from the trailer.
seal can also be specified to indicate the seal number placed on the trailer when the loading process has finished

Trailers have two statuses associated with them:

Load Status: this is the status of the trailer and indicates whether it is empty, partially loaded, or full
Process Status: this is an accompaniment to the Load Status and signals the intention with the trailer. Ex: an Empty trailer could either be ready to be \"loaded\" or could have just been \"unloaded\". The Process Status helps clarify this intent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Load Status	Associated Process Statuses	Description
Empty	In Gate / Load / Unloaded	Trailer is fully empty. Applies to an empty trailer entering the yard or a previously full trailer which was unloaded
Partial	In Gate / Load / Loaded / Unload / Unloaded	Trailer is partially loaded. It can be used as an intermediate status while a WMS continues to load/unload the trailer
Full	In Gate / Unload / Loaded	Trailer is fully loaded. Applies to a full inbound trailer entering the yard or a trailer recently loaded with an outbound shipment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Process Status	Description
In Gate	Trailer was just processed at the gate
Unload	The intention is the unload the trailer
Unloaded	The trailer has been unloaded
Load	The intention is to load the trailer
Loaded	The trailer has been loaded

Field Definitions

trailer_id
- Type: Number (Int32)
- Required: M
- Description: Unique Dynamic Yard generated ID for the trailer. This is generated when a trailer is checked into the yard. _See *_Gate Check-In** webhook
\n
trailer_number
- Type: String
- Required: O
- Description: The UI-visible trailer number. This field should only be used if you would like to change the trailer number for users in the UI. *the trailer_id is required in order to process this update
\n
carrier_code
- Type: String
- Required: O
- Description: The carrier code associated with the trailer. This field can be used to change the carrier associated with the trailer. *the trailer_id is required in order to process this update
\n
door_name
- Type: String
- Required: O
- Description: Name for the specific door which the trailer's location should be placed into. If specified, this must be a door which is associated to the dock_name
\n
dock_name
- Type: String
- Required: O
- Description: Name for the specific dock which the trailer's location should be placed into. If specified, this must be a dock which is associated to the door_name
\n
parking_spot_name
- Type: String
- Required: O
- Description: Name for the specific parking spot which the trailer's location should be placed into. If specified, this must be a spot which is associated to the parking_lot_name
\n
parking_lot_name
- Type: String
- Required: O
- Description: Name for the specific parking lot which the trailer's location should be placed into. If specified, this must be a parking lot which is associated to the parking_spot_name
\n
process_status
- Type: String
- Required: O
- Description: Process status associated with the trailer. *See table above describing process statuses
\n
load_status
- Type: String
- Required: O
- Description: Load status associated with the trailer. This is often updated when the warehouse is finished loading/unloading the trailer. *See table above describing load statuses
\n
load_type
- Type: String
- Required: O
- Description: Load type associated with the trailer. This is typically correlated with the type of freight on the trailer (or what is intended to be loaded on the trailer). This must match values configured in the site nomenclature setup under Load Types
\n
site_code
- Type: String
- Required: M
- Description: Unique code for the site
\n
delivery_names
- Type: Array (List of Strings)
- Required: O
- Description: Names/identifiers of the specific delivery(s) associated with the trailer. The API expects any delivery still present on the trailer to be passed in this array. If the array is empty then all deliveries will be removed from the trailer
\n

Additional Attributes

Custom trailer attributes can also be added/updated using the additional_attributes array. These fields are optional and will depend on your operational processes. For more information, please inquire with your FourKites Delivery Consultant on how to configure custom trailer attributes.

The below fields are arranged as keys within each object of the additional_attributes:

\"additional_attributes\": [\n     {\n         \"type\": \"toggle\",\n         \"name\": \"Passed Inspection Check?\",\n         \"value\": \"yes\"\n     }\n ]\n\n

type
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: Data type of the custom trailer attribute. Valid values: toggle | text | dropdown
\n
name
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: Name of the custom trailer attribute. The name must match exactly what is configured/visible in the Dynamic Yard UI
\n
value
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: Value of the custom attribute. If using the toggle option, please ensure that all letters are lowercase (\"yes\" or \"no\")
\n

\n","_postman_id":"34577991-d18a-4d9c-9905-8e18e39d1273"},{"name":"Move Requests","item":[{"name":"Create Spot Task","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"25a62873-6b81-4aa3-8777-8d9c85fcc75a"}}],"id":"0a31eba5-fae9-4823-ae9b-5588dfa4be35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Door\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 09\",\n \"dock_name\": \"Rail Dock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

Create a spot request to move a trailer into a dock door.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"bd79943b-bd89-42d2-94e3-14d7b7671085","name":"Create Spot Task","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Door\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 11\",\n \"dock_name\": \"Rail Dock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"1481\n"}],"_postman_id":"0a31eba5-fae9-4823-ae9b-5588dfa4be35"},{"name":"Queue Spot Task","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"f5769416-5811-457f-86e5-c889544158e7"}}],"id":"f65c7ed2-76f0-47db-ad04-58ea66ca6523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

Spot Task Queueing

When creating spot tasks, there may be a situation where you want to queue a trailer (or multiple trailers) at a given door, and then allow Dynamic Yard to automatically generate those tasks once the door has been vacated by an existing trailer.

As a demonstration of this functionality in Dynamic Yard, consider the following steps:

Trailer A is currently occupying door 10
A spot request is created by the warehouse to queue Trailer B into door 10 as soon as Trailer A is pulled from the door
1. Trailer A is still being loaded/unloaded and occupying the door
\n
Dynamic Yard will queue Trailer B at the door. A spot request will not be immediately created as the door is occupied
Once Trailer A is pulled from door 10 and it is now vacated. Dynamic Yard will automatically create a new spot request to move Trailer B into door 10

This can work for as many trailers as you need to place in a door's queue. The door_queue API supports this same functionality over the API.

Field Definitions and API Responses

All field definitions will match those of the Create Spot Task field definitions (you can select that API sample from the \"Move Requests\" folder to view those field definitions). However, a key difference is how the API will respond.

Spot Request Created

When using the door_queue API, if no trailer is currently occupying the door, a move request will be directly created. The response on the API will indicate the move_request_id which was generated:

{\n    \"dock_name\": \"Rail Dock\",\n    \"door_name\": \"Door 9\",\n    \"destination\": \"Door\",\n    \"move_request\": true,\n    \"move_request_id\": 18546\n}\n\n

Trailer Queued - Spot Move Deferred

In a situation where the door is currently occupied, the API will accept the details, but will respond indicating that a move has not been created. This means that the trailer was queued at the door, and Dynamic Yard will automatically create the intended spot task as soon as the door is empty (or the queue moves to the point where the trailer is the \"next up\").

You can see that the move_request_id is null and the move_request boolean field is set to false:

{\n    \"dock_name\": \"Rail Dock\",\n    \"door_name\": \"Door 9\",\n    \"destination\": \"Door\",\n    \"move_request\": false,\n    \"move_request_id\": null\n}\n\n

\n","urlObject":{"path":["wms","v1","doors","door_queue"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"2e7db073-250a-444e-8dbd-ee913fd46f9a","name":"Trailer Queued","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Door\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 11\",\n \"dock_name\": \"Rail Dock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/doors/door_queue"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"dock_name\": \"Rail Dock\",\n \"door_name\": \"Door 11\",\n \"move_request\": false,\n \"move_request_id\": null\n}\n"},{"id":"12f1eb9d-6c00-4792-ba9f-1f762fef2aa7","name":"Spot Move Created","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Door\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 14\",\n \"dock_name\": \"Rail Dock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/doors/door_queue"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"dock_name\": \"Rail Dock\",\n \"door_name\": \"Door 11\",\n \"move_request\": true,\n \"move_request_id\": 18654\n}\n"}],"_postman_id":"f65c7ed2-76f0-47db-ad04-58ea66ca6523"},{"name":"Create Pull Task (no destination)","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"97275865-008b-4023-896a-79bb950322bc"}}],"id":"3aa39107-4d12-49db-9445-00c046bda27c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"trailer_id\": {{trailer_id}},\n \"destination\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

Create a pull request to move a trailer from a dock door and back into the yard.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"9319c106-3d6e-4230-9550-ec555c7ad0bd","name":"Create Pull Task (no destination)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"trailer_id\": 2079,\n \"destination\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:38:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"1482\n"}],"_postman_id":"3aa39107-4d12-49db-9445-00c046bda27c"},{"name":"Create Pull Task (if destination known)","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"bc63b942-11d9-4ef8-a780-1607ebe32dc2"}}],"id":"23a3e27d-a0bc-476d-9bc9-5d1ae62d5ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Yard\",\n \"parking_lot_name\": \"LOT98\",\n \"parking_spot_name\": \"51-30\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

PULL requests can also be created and specify an exact location in the yard to move the trailer into. This is less common as the warehouse typically delegates yard spots to Dynamic Yard. However, by passing the parking_lot_name and parking_spot_name, it's possible to create a PULL with a pre-defined parking spot to move the trailer to from the door.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"4b905dee-6a5e-4fd1-814d-74402ba382d5","name":"Create Pull Task (if destination known)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"trailer_id\": 2079,\n \"destination\": \"Yard\",\n \"parking_lot_name\": \"Rail Yard\",\n \"parking_spot_name\": \"030\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:39:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"1483\n"}],"_postman_id":"23a3e27d-a0bc-476d-9bc9-5d1ae62d5ac9"},{"name":"Update Move Request","id":"451755df-dddf-4371-9eb6-20428261b4f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Yard\",\n \"parking_lot_name\": \"Rail Yard\",\n \"parking_spot_name\": \"015\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/{{move_request_id}}","description":"

Attributes about a move request can be updated after created. The same rules around field requirements for SPOT and PULL requests apply.

\n","urlObject":{"path":["wms","v1","move_requests","{{move_request_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"451755df-dddf-4371-9eb6-20428261b4f6"},{"name":"Delete Move Request","id":"a7db588f-c243-4f15-95a6-6cae1c7e1f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/move_requests/{{move_request_id}}","description":"

If a move request is no longer needed, it can be deleted/cancelled directly via the API. The unique move_request_id is required as a URL path parameter.

\n","urlObject":{"path":["wms","v1","move_requests","{{move_request_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"86279829-fed6-4ec1-9cb5-9dfd90018707","name":"Delete Move Request","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/{{move_request_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:36:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"200\n"}],"_postman_id":"a7db588f-c243-4f15-95a6-6cae1c7e1f4b"}],"id":"1d3b3b94-2fcf-455d-9821-b7baeb183130","description":"

The Move Request API supplies the ability to create tasks in the yard to SPOT a trailer to a dock door or PULL a trailer from a door.

SPOT Moves: For SPOT moves with a destination of Door, both the door_name and dock_name must be present for the move to be created
PULL Moves: For PULL moves, the destination can be left as null and Dynamic Yard will accept ownership of where to move the trailer once it is pulled from the door. This allows the warehouse to delegate yard spot decisions to Dynamic Yard and focus exclusively on operations specific to the door
- Optionally, if the warehouse has a preference on which parking spot to move the trailer to, the destination can be sent as Yard along with a parking_lot_name and a parking_spot_name
\n

For more information on Move Request statues, please see the Move Confirmation message under the Webhooks section.

Field Definitions

SPOT Task

trailer_id
- Type: Number (Int32)
- Required: M
- Description: Unique Dynamic Yard generated ID for the trailer. This is generated when a trailer is checked into the yard. See Gate Check-In webhook for details on how to capture this ID
\n
destination
- Type: String
- Required: M
- Description: Type of destination of the move. Valid values: Yard | Door | null (if no preference on PULL requests)
\n
site_code
- Type: String
- Required: M
- Description: Unique code for the site
\n
door_name
- Type: String
- Required: CM*
- Description: Name for the specific door which the trailer is intended to be spotted into. *Mandatory for SPOT requests
\n
dock_name
- Type: String
- Required: CM*
- Description: Name for the specific dock which the trailer is intended to be spotted into. *Mandatory for SPOT requests
\n
status
- Type: String
- Required: O
- Description: Status of the move. Typically, this is managed directly by activity in Dynamic Yard as opposed to an external system. It is not recommended to send this to Dynamic Yard
\n
priority
- Type: String
- Required: O
- Description: Priority of the move. Valid values: Normal | Priority
\n

PULL Task

trailer_id
- Type: Number (Int32)
- Required: M
- Description: Unique Dynamic Yard generated ID for the trailer. This is generated when a trailer is checked into the yard. *See Gate Check-In webhook
\n
destination
- Type: String
- Required: M
- Description: Type of destination of the move. Valid values: Yard | Door | null (if no preference on PULL requests)
\n
site_code
- Type: String
- Required: M
- Description: Unique code for the site
\n
parking_spot_name
- Type: String
- Required: O
- Description: Name for the specific parking spot which the trailer is intended to be pulled into. *Optional for PULL requests
\n
parking_lot_name
- Type: String
- Required: O
- Description: Name for the specific parking lot which the trailer is intended to be spotted into. *Optional for PULL requests
\n
status
- Type: String
- Required: O
- Description: Status of the move. Typically, this is managed directly by activity in Dynamic Yard as opposed to an external system. It is not recommended to send this to Dynamic Yard
\n
priority
- Type: String
- Required: O
- Description: Priority of the move. Valid values: Normal | Priority
\n

\n","_postman_id":"1d3b3b94-2fcf-455d-9821-b7baeb183130"},{"name":"Miscellaneous","item":[{"name":"Create Site Message Alert","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"13c83c17-d92d-492a-b327-c1a9a5efbcff"}}],"id":"7e952e5e-ebdd-44f9-9b58-c6bfa1b03264","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"message\": \"Severe weather is headed towards this area, please be careful\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/site_broadcast_messages/","description":"

The Create Site Message Alert API allows an external system to create a broadcast alert for all Dynamic Yard users at the specific site. This will display as a banner in the application which will alert users to the message:

Field Definitions

site_code
- Type: String
- Required: M
- Description: Valid site code for the facility. This is the site code used in Dynamic Yard
\n
message
- Type: String
- Required: M
- Description: Message or alert which will be displayed to users in Dynamic Yard when logging in
\n

\n","urlObject":{"path":["wms","v1","site_broadcast_messages",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"dc4d80d9-b37f-4aef-9c98-302063031f15","name":"Create Site Message Alert","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"message\": \"Severe weather is headed towards this area, please be careful\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/site_broadcast_messages/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Jun 2022 21:57:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"6"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"84315"}],"_postman_id":"7e952e5e-ebdd-44f9-9b58-c6bfa1b03264"}],"id":"701b4954-8f07-46e3-b7fb-918c5b53fae9","description":"

The miscellaneous folder contains any optional API calls which can perform miscellaneous activities in Dynamic Yard. You may peruse them and check if they suit any additional needs or integration activities for your organization.

\n","_postman_id":"701b4954-8f07-46e3-b7fb-918c5b53fae9"},{"name":"Get Requests","item":[{"name":"Get Parking Lots","id":"0ef732a3-46af-441b-923a-890f1bcfad28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/parking_lots/?name=Rail Yard&include_rule_info=true&site_id=396&include_spots=true","urlObject":{"path":["wms","v1","parking_lots",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Name of the parking lot

\n","type":"text/plain"},"key":"name","value":"Rail Yard"},{"description":{"content":"

Return rule information associated with the parking lots

\n","type":"text/plain"},"key":"include_rule_info","value":"true"},{"description":{"content":"

Unique site ID within Dynamic Yard

\n","type":"text/plain"},"key":"site_id","value":"396"},{"description":{"content":"

Include a list of parking spots associated with the parking lot

\n","type":"text/plain"},"key":"include_spots","value":"true"}],"variable":[]}},"response":[{"id":"febc3ba3-f84f-4bff-a44a-7c830f85314b","name":"Get Parking Lots","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/parking_lots/?name=Rail Yard&include_rule_info=true&site_id=396&include_spots=true","host":["{{dynamic_yard_url}}"],"path":["wms","v1","parking_lots",""],"query":[{"key":"name","value":"Rail Yard","description":"Name of the parking lot"},{"key":"include_rule_info","value":"true","description":"Return rule information associated with the parking lots"},{"key":"site_id","value":"396","description":"Unique site ID within Dynamic Yard"},{"key":"include_spots","value":"true","description":"Include a list of parking spots associated with the parking lot"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:43:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"18820"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"archived\": false,\n \"capacity\": null,\n \"defines_spots\": true,\n \"deleted\": false,\n \"geofence_id\": null,\n \"id\": 1339,\n \"location_id\": 56215,\n \"move_request_info\": null,\n \"name\": \"Rail Yard\",\n \"parking_spots\": [\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68079,\n \"location_id\": 56461,\n \"move_request_info\": null,\n \"name\": \"001\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68080,\n \"location_id\": 56462,\n \"move_request_info\": null,\n \"name\": \"002\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68081,\n \"location_id\": 56463,\n \"move_request_info\": null,\n \"name\": \"003\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68082,\n \"location_id\": 56464,\n \"move_request_info\": null,\n \"name\": \"004\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68083,\n \"location_id\": 56465,\n \"move_request_info\": null,\n \"name\": \"005\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68084,\n \"location_id\": 56466,\n \"move_request_info\": null,\n \"name\": \"006\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68085,\n \"location_id\": 56467,\n \"move_request_info\": null,\n \"name\": \"007\",\n \"occupied\": true,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": [\n 2984\n ]\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68086,\n \"location_id\": 56468,\n \"move_request_info\": null,\n \"name\": \"008\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68087,\n \"location_id\": 56469,\n \"move_request_info\": null,\n \"name\": \"009\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68088,\n \"location_id\": 56470,\n \"move_request_info\": null,\n \"name\": \"010\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68089,\n \"location_id\": 56471,\n \"move_request_info\": null,\n \"name\": \"011\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68090,\n \"location_id\": 56472,\n \"move_request_info\": null,\n \"name\": \"012\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68091,\n \"location_id\": 56473,\n \"move_request_info\": null,\n \"name\": \"013\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68092,\n \"location_id\": 56474,\n \"move_request_info\": null,\n \"name\": \"014\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68093,\n \"location_id\": 56475,\n \"move_request_info\": null,\n \"name\": \"015\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68094,\n \"location_id\": 56476,\n \"move_request_info\": null,\n \"name\": \"016\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68095,\n \"location_id\": 56477,\n \"move_request_info\": null,\n \"name\": \"017\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68096,\n \"location_id\": 56478,\n \"move_request_info\": null,\n \"name\": \"018\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68097,\n \"location_id\": 56479,\n \"move_request_info\": null,\n \"name\": \"019\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68098,\n \"location_id\": 56480,\n \"move_request_info\": null,\n \"name\": \"020\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68099,\n \"location_id\": 56481,\n \"move_request_info\": null,\n \"name\": \"021\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68100,\n \"location_id\": 56482,\n \"move_request_info\": null,\n \"name\": \"022\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68101,\n \"location_id\": 56483,\n \"move_request_info\": null,\n \"name\": \"023\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68102,\n \"location_id\": 56484,\n \"move_request_info\": null,\n \"name\": \"024\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68103,\n \"location_id\": 56485,\n \"move_request_info\": null,\n \"name\": \"025\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68104,\n \"location_id\": 56486,\n \"move_request_info\": null,\n \"name\": \"026\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68105,\n \"location_id\": 56487,\n \"move_request_info\": null,\n \"name\": \"027\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68106,\n \"location_id\": 56488,\n \"move_request_info\": null,\n \"name\": \"028\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68107,\n \"location_id\": 56489,\n \"move_request_info\": null,\n \"name\": \"029\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68108,\n \"location_id\": 56490,\n \"move_request_info\": null,\n \"name\": \"030\",\n \"occupied\": true,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": [\n 2803\n ]\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68109,\n \"location_id\": 56491,\n \"move_request_info\": null,\n \"name\": \"031\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68110,\n \"location_id\": 56492,\n \"move_request_info\": null,\n \"name\": \"032\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68111,\n \"location_id\": 56493,\n \"move_request_info\": null,\n \"name\": \"033\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68112,\n \"location_id\": 56494,\n \"move_request_info\": null,\n \"name\": \"034\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68113,\n \"location_id\": 56495,\n \"move_request_info\": null,\n \"name\": \"035\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68114,\n \"location_id\": 56496,\n \"move_request_info\": null,\n \"name\": \"036\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68115,\n \"location_id\": 56497,\n \"move_request_info\": null,\n \"name\": \"037\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68116,\n \"location_id\": 56498,\n \"move_request_info\": null,\n \"name\": \"038\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68117,\n \"location_id\": 56499,\n \"move_request_info\": null,\n \"name\": \"039\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68118,\n \"location_id\": 56500,\n \"move_request_info\": null,\n \"name\": \"040\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68119,\n \"location_id\": 56501,\n \"move_request_info\": null,\n \"name\": \"041\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68120,\n \"location_id\": 56502,\n \"move_request_info\": null,\n \"name\": \"042\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68121,\n \"location_id\": 56503,\n \"move_request_info\": null,\n \"name\": \"043\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68122,\n \"location_id\": 56504,\n \"move_request_info\": null,\n \"name\": \"044\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68123,\n \"location_id\": 56505,\n \"move_request_info\": null,\n \"name\": \"045\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68124,\n \"location_id\": 56506,\n \"move_request_info\": null,\n \"name\": \"046\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68125,\n \"location_id\": 56507,\n \"move_request_info\": null,\n \"name\": \"047\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68126,\n \"location_id\": 56508,\n \"move_request_info\": null,\n \"name\": \"048\",\n \"occupied\": true,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": [\n 2813\n ]\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68127,\n \"location_id\": 56509,\n \"move_request_info\": null,\n \"name\": \"049\",\n \"occupied\": true,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": [\n 2976\n ]\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68128,\n \"location_id\": 56510,\n \"move_request_info\": null,\n \"name\": \"050\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68129,\n \"location_id\": 56511,\n \"move_request_info\": null,\n \"name\": \"051\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68130,\n \"location_id\": 56512,\n \"move_request_info\": null,\n \"name\": \"052\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68131,\n \"location_id\": 56513,\n \"move_request_info\": null,\n \"name\": \"053\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68132,\n \"location_id\": 56514,\n \"move_request_info\": null,\n \"name\": \"054\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68133,\n \"location_id\": 56515,\n \"move_request_info\": null,\n \"name\": \"055\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68134,\n \"location_id\": 56516,\n \"move_request_info\": null,\n \"name\": \"056\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68135,\n \"location_id\": 56517,\n \"move_request_info\": null,\n \"name\": \"057\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68136,\n \"location_id\": 56518,\n \"move_request_info\": null,\n \"name\": \"058\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68137,\n \"location_id\": 56519,\n \"move_request_info\": null,\n \"name\": \"059\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68138,\n \"location_id\": 56520,\n \"move_request_info\": null,\n \"name\": \"060\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68139,\n \"location_id\": 56521,\n \"move_request_info\": null,\n \"name\": \"061\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68140,\n \"location_id\": 56522,\n \"move_request_info\": null,\n \"name\": \"062\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68141,\n \"location_id\": 56523,\n \"move_request_info\": null,\n \"name\": \"063\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68142,\n \"location_id\": 56524,\n \"move_request_info\": null,\n \"name\": \"064\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68143,\n \"location_id\": 56525,\n \"move_request_info\": null,\n \"name\": \"065\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68144,\n \"location_id\": 56526,\n \"move_request_info\": null,\n \"name\": \"066\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68145,\n \"location_id\": 56527,\n \"move_request_info\": null,\n \"name\": \"067\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68146,\n \"location_id\": 56528,\n \"move_request_info\": null,\n \"name\": \"068\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68147,\n \"location_id\": 56529,\n \"move_request_info\": null,\n \"name\": \"069\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68148,\n \"location_id\": 56530,\n \"move_request_info\": null,\n \"name\": \"070\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n }\n ],\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"site_id\": 396,\n \"trailer_ids\": [\n 2984,\n 2803,\n 2813,\n 2976\n ],\n \"update_time\": \"Wed, 22 Dec 2021 20:55:47 GMT\"\n }\n]"}],"_postman_id":"0ef732a3-46af-441b-923a-890f1bcfad28"},{"name":"Get Parking Spots","id":"6c2fd056-c9b8-4ecc-8c67-07352bdc7b4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/parking_spots/?parking_lot_id=1336&available=true&include_rule_info=true&site_id=396","urlObject":{"path":["wms","v1","parking_spots",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

The parking lot id of the parking spots to retreieve

\n","type":"text/plain"},"key":"parking_lot_id","value":"1336"},{"description":{"content":"

Filter parking spots by availability

\n","type":"text/plain"},"key":"available","value":"true"},{"description":{"content":"

Return rule information associated with the parking spots

\n","type":"text/plain"},"key":"include_rule_info","value":"true"},{"description":{"content":"

Unique site ID within Dynamic Yard

\n","type":"text/plain"},"key":"site_id","value":"396"}],"variable":[]}},"response":[{"id":"4fdfcef8-0175-4d9e-a274-5671309b1af7","name":"Get Parking Spots","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/parking_spots/?parking_lot_id=1336&available=true&include_rule_info=true&site_id=396","host":["{{dynamic_yard_url}}"],"path":["wms","v1","parking_spots",""],"query":[{"key":"parking_lot_id","value":"1336","description":"The parking lot id of the parking spots to retreieve"},{"key":"available","value":"true","description":"Filter parking spots by availability"},{"key":"include_rule_info","value":"true","description":"Return rule information associated with the parking spots"},{"key":"site_id","value":"396","description":"Unique site ID within Dynamic Yard"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:44:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"17426"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68079,\n \"location_id\": 56461,\n \"move_request_info\": null,\n \"name\": \"001\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68080,\n \"location_id\": 56462,\n \"move_request_info\": null,\n \"name\": \"002\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68081,\n \"location_id\": 56463,\n \"move_request_info\": null,\n \"name\": \"003\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68082,\n \"location_id\": 56464,\n \"move_request_info\": null,\n \"name\": \"004\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68083,\n \"location_id\": 56465,\n \"move_request_info\": null,\n \"name\": \"005\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68084,\n \"location_id\": 56466,\n \"move_request_info\": null,\n \"name\": \"006\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68086,\n \"location_id\": 56468,\n \"move_request_info\": null,\n \"name\": \"008\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68087,\n \"location_id\": 56469,\n \"move_request_info\": null,\n \"name\": \"009\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68088,\n \"location_id\": 56470,\n \"move_request_info\": null,\n \"name\": \"010\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68089,\n \"location_id\": 56471,\n \"move_request_info\": null,\n \"name\": \"011\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68090,\n \"location_id\": 56472,\n \"move_request_info\": null,\n \"name\": \"012\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68091,\n \"location_id\": 56473,\n \"move_request_info\": null,\n \"name\": \"013\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68092,\n \"location_id\": 56474,\n \"move_request_info\": null,\n \"name\": \"014\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68093,\n \"location_id\": 56475,\n \"move_request_info\": null,\n \"name\": \"015\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68094,\n \"location_id\": 56476,\n \"move_request_info\": null,\n \"name\": \"016\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68095,\n \"location_id\": 56477,\n \"move_request_info\": null,\n \"name\": \"017\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68096,\n \"location_id\": 56478,\n \"move_request_info\": null,\n \"name\": \"018\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68097,\n \"location_id\": 56479,\n \"move_request_info\": null,\n \"name\": \"019\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68098,\n \"location_id\": 56480,\n \"move_request_info\": null,\n \"name\": \"020\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68099,\n \"location_id\": 56481,\n \"move_request_info\": null,\n \"name\": \"021\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68100,\n \"location_id\": 56482,\n \"move_request_info\": null,\n \"name\": \"022\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68101,\n \"location_id\": 56483,\n \"move_request_info\": null,\n \"name\": \"023\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68102,\n \"location_id\": 56484,\n \"move_request_info\": null,\n \"name\": \"024\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68103,\n \"location_id\": 56485,\n \"move_request_info\": null,\n \"name\": \"025\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68104,\n \"location_id\": 56486,\n \"move_request_info\": null,\n \"name\": \"026\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68105,\n \"location_id\": 56487,\n \"move_request_info\": null,\n \"name\": \"027\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68106,\n \"location_id\": 56488,\n \"move_request_info\": null,\n \"name\": \"028\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68107,\n \"location_id\": 56489,\n \"move_request_info\": null,\n \"name\": \"029\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68109,\n \"location_id\": 56491,\n \"move_request_info\": null,\n \"name\": \"031\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68110,\n \"location_id\": 56492,\n \"move_request_info\": null,\n \"name\": \"032\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68111,\n \"location_id\": 56493,\n \"move_request_info\": null,\n \"name\": \"033\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68112,\n \"location_id\": 56494,\n \"move_request_info\": null,\n \"name\": \"034\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68113,\n \"location_id\": 56495,\n \"move_request_info\": null,\n \"name\": \"035\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68114,\n \"location_id\": 56496,\n \"move_request_info\": null,\n \"name\": \"036\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68115,\n \"location_id\": 56497,\n \"move_request_info\": null,\n \"name\": \"037\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68116,\n \"location_id\": 56498,\n \"move_request_info\": null,\n \"name\": \"038\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68117,\n \"location_id\": 56499,\n \"move_request_info\": null,\n \"name\": \"039\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68118,\n \"location_id\": 56500,\n \"move_request_info\": null,\n \"name\": \"040\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68119,\n \"location_id\": 56501,\n \"move_request_info\": null,\n \"name\": \"041\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68120,\n \"location_id\": 56502,\n \"move_request_info\": null,\n \"name\": \"042\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68121,\n \"location_id\": 56503,\n \"move_request_info\": null,\n \"name\": \"043\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68122,\n \"location_id\": 56504,\n \"move_request_info\": null,\n \"name\": \"044\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68123,\n \"location_id\": 56505,\n \"move_request_info\": null,\n \"name\": \"045\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68124,\n \"location_id\": 56506,\n \"move_request_info\": null,\n \"name\": \"046\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68125,\n \"location_id\": 56507,\n \"move_request_info\": null,\n \"name\": \"047\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68128,\n \"location_id\": 56510,\n \"move_request_info\": null,\n \"name\": \"050\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68129,\n \"location_id\": 56511,\n \"move_request_info\": null,\n \"name\": \"051\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68130,\n \"location_id\": 56512,\n \"move_request_info\": null,\n \"name\": \"052\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68131,\n \"location_id\": 56513,\n \"move_request_info\": null,\n \"name\": \"053\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68132,\n \"location_id\": 56514,\n \"move_request_info\": null,\n \"name\": \"054\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68133,\n \"location_id\": 56515,\n \"move_request_info\": null,\n \"name\": \"055\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68134,\n \"location_id\": 56516,\n \"move_request_info\": null,\n \"name\": \"056\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68135,\n \"location_id\": 56517,\n \"move_request_info\": null,\n \"name\": \"057\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68136,\n \"location_id\": 56518,\n \"move_request_info\": null,\n \"name\": \"058\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68137,\n \"location_id\": 56519,\n \"move_request_info\": null,\n \"name\": \"059\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68138,\n \"location_id\": 56520,\n \"move_request_info\": null,\n \"name\": \"060\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68139,\n \"location_id\": 56521,\n \"move_request_info\": null,\n \"name\": \"061\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68140,\n \"location_id\": 56522,\n \"move_request_info\": null,\n \"name\": \"062\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68141,\n \"location_id\": 56523,\n \"move_request_info\": null,\n \"name\": \"063\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68142,\n \"location_id\": 56524,\n \"move_request_info\": null,\n \"name\": \"064\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68143,\n \"location_id\": 56525,\n \"move_request_info\": null,\n \"name\": \"065\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68144,\n \"location_id\": 56526,\n \"move_request_info\": null,\n \"name\": \"066\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68145,\n \"location_id\": 56527,\n \"move_request_info\": null,\n \"name\": \"067\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68146,\n \"location_id\": 56528,\n \"move_request_info\": null,\n \"name\": \"068\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68147,\n \"location_id\": 56529,\n \"move_request_info\": null,\n \"name\": \"069\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 68148,\n \"location_id\": 56530,\n \"move_request_info\": null,\n \"name\": \"070\",\n \"occupied\": false,\n \"parking_lot_id\": 1339,\n \"parking_lot_name\": \"Rail Yard\",\n \"reservation_status\": \"Not_Reserved\",\n \"rules\": [],\n \"spot_status\": \"Active\",\n \"trailer_ids\": []\n }\n]"}],"_postman_id":"6c2fd056-c9b8-4ecc-8c67-07352bdc7b4d"},{"name":"Get Docks","id":"d1891895-82ef-4247-8a52-95a77e264044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/docks/?site_id=396&include_rule_info=true","urlObject":{"path":["wms","v1","docks",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Unique site ID within Dynamic Yard

\n","type":"text/plain"},"key":"site_id","value":"396"},{"description":{"content":"

Return rule information associated with the dock

\n","type":"text/plain"},"key":"include_rule_info","value":"true"}],"variable":[]}},"response":[{"id":"376edf97-5d72-42f8-a327-1fc65233ed9d","name":"Get Docks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/docks/?site_id=396&include_rule_info=true","host":["{{dynamic_yard_url}}"],"path":["wms","v1","docks",""],"query":[{"key":"site_id","value":"396","description":"Unique site ID within Dynamic Yard"},{"key":"include_rule_info","value":"true","description":"Return rule information associated with the dock"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:44:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"646"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 1680,\n \"location_id\": 56007,\n \"name\": \"Rail Dock\",\n \"rules\": [],\n \"site_id\": 396,\n \"update_time\": \"Wed, 22 Dec 2021 20:55:43 GMT\"\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 1681,\n \"location_id\": 56019,\n \"name\": \"Steel Dock\",\n \"rules\": [],\n \"site_id\": 396,\n \"update_time\": \"Wed, 22 Dec 2021 20:55:43 GMT\"\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 1682,\n \"location_id\": 56028,\n \"name\": \"Consumables Dock\",\n \"rules\": [],\n \"site_id\": 396,\n \"update_time\": \"Wed, 22 Dec 2021 20:55:43 GMT\"\n },\n {\n \"archived\": false,\n \"geofence_id\": null,\n \"id\": 1683,\n \"location_id\": 56045,\n \"name\": \"Shipping Dock\",\n \"rules\": [],\n \"site_id\": 396,\n \"update_time\": \"Wed, 22 Dec 2021 20:55:43 GMT\"\n }\n]"}],"_postman_id":"d1891895-82ef-4247-8a52-95a77e264044"},{"name":"Get Dock Doors","id":"5e3ee144-ca84-46b3-93dc-96a6184de377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/doors/?site_id=396&dock_name=Rail Dock&available=true&occupied=false&name=Door 11","urlObject":{"path":["wms","v1","doors",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Unique site ID in Dynamic Yard

\n","type":"text/plain"},"key":"site_id","value":"396"},{"description":{"content":"

Name of the dock the door is associated with

\n","type":"text/plain"},"key":"dock_name","value":"Rail Dock"},{"description":{"content":"

Available status of the door

\n","type":"text/plain"},"key":"available","value":"true"},{"description":{"content":"

Occupied status of the door

\n","type":"text/plain"},"key":"occupied","value":"false"},{"description":{"content":"

Name of the door

\n","type":"text/plain"},"key":"name","value":"Door 11"}],"variable":[]}},"response":[{"id":"035f71a8-2168-4378-ae22-be1241d385cb","name":"Get Dock Doors","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/doors/?site_id=396&dock_name=Rail Dock&available=true&occupied=false","host":["{{dynamic_yard_url}}"],"path":["wms","v1","doors",""],"query":[{"key":"site_id","value":"396","description":"Unique site ID in Dynamic Yard"},{"key":"dock_name","value":"Rail Dock","description":"Name of the dock the door is associated with"},{"key":"available","value":"true","description":"Available status of the door"},{"key":"occupied","value":"false","description":"Occupied status of the door"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:45:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1154"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15249,\n \"location_id\": 56013,\n \"move_request_info\": null,\n \"name\": \"Door 23\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n },\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15251,\n \"location_id\": 56015,\n \"move_request_info\": null,\n \"name\": \"Door 25\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n },\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15252,\n \"location_id\": 56016,\n \"move_request_info\": null,\n \"name\": \"Door 26\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n },\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15254,\n \"location_id\": 56018,\n \"move_request_info\": null,\n \"name\": \"Door 28\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n }\n]"}],"_postman_id":"5e3ee144-ca84-46b3-93dc-96a6184de377"},{"name":"Get Trailers","id":"d5101671-397c-40a7-ad6d-a4f2b70b2814","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/trailers/?include_delivery_info=true&include_preferred_location_info=true&include_carrier_info=true¤t_site_id=396","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Include deliveries associated with the trailer

\n","type":"text/plain"},"key":"include_delivery_info","value":"true"},{"description":{"content":"

Include information on the preferred location of the trailer (if applicable)

\n","type":"text/plain"},"key":"include_preferred_location_info","value":"true"},{"description":{"content":"

Include information on the carrier associated with the trailer

\n","type":"text/plain"},"key":"include_carrier_info","value":"true"},{"description":{"content":"

Filter by trailers associated with a given site

\n","type":"text/plain"},"key":"current_site_id","value":"396"}],"variable":[]}},"response":[{"id":"35fe9ca6-30ff-44a7-a132-65d90d3ed4ba","name":"Get Trailers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/trailers/?include_delivery_info=true&include_preferred_location_info=true&include_carrier_info=true¤t_site_id=399","host":["{{dynamic_yard_url}}"],"path":["wms","v1","trailers",""],"query":[{"key":"include_delivery_info","value":"true","description":"Include deliveries associated with the trailer"},{"key":"include_preferred_location_info","value":"true","description":"Include information on the preferred location of the trailer (if applicable)"},{"key":"include_carrier_info","value":"true","description":"Include information on the carrier associated with the trailer"},{"key":"current_site_id","value":"399","description":"Filter by trailers associated with a given site"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 May 2022 01:12:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"additional_attributes\": null,\n \"audit\": null,\n \"audit_note\": null,\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_id\": 4485,\n \"carrier_info\": {\n \"carrier_code\": \"TC02\",\n \"id\": 4485,\n \"name\": \"Test Carrier 4\"\n },\n \"check_in_time\": 1652317904.8021019,\n \"check_out_time\": null,\n \"comments\": null,\n \"condition\": \"Clean\",\n \"damage\": null,\n \"damage_note\": null,\n \"delivery_ids\": [],\n \"door_info\": null,\n \"id\": 44921,\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"location_id\": null,\n \"old_tag_code\": null,\n \"out_of_service\": null,\n \"out_of_service_note\": null,\n \"parking_info\": null,\n \"preferred_locations\": {\n \"dock_ids\": [],\n \"door_ids\": [],\n \"parking_lot_ids\": [],\n \"parking_spot_ids\": []\n },\n \"process_status\": \"In_Gate\",\n \"ready\": null,\n \"refrigerated\": false,\n \"seal\": \"4857429485\",\n \"seal_status\": \"Intact\",\n \"site_id\": 399,\n \"site_name\": \"Sample Site 06\",\n \"site_owner_id\": null,\n \"site_owner_name\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1652317904.8021019,\n \"switcher_vehicle_id\": null,\n \"tag_code\": null,\n \"tag_type_id\": null,\n \"trailer_id\": 10943,\n \"trailer_name\": \"485748\",\n \"trailer_type\": \"Container\",\n \"trailer_type_id\": 239,\n \"usage\": \"Over the Road\",\n \"user_id\": 646\n },\n {\n \"additional_attributes\": null,\n \"audit\": null,\n \"audit_note\": null,\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_id\": 4485,\n \"carrier_info\": {\n \"carrier_code\": \"TC02\",\n \"id\": 4485,\n \"name\": \"Test Carrier 4\"\n },\n \"check_in_time\": 1652317943.203098,\n \"check_out_time\": null,\n \"comments\": null,\n \"condition\": \"Clean\",\n \"damage\": null,\n \"damage_note\": null,\n \"delivery_ids\": [],\n \"door_info\": null,\n \"id\": 44924,\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"location_id\": null,\n \"old_tag_code\": null,\n \"out_of_service\": null,\n \"out_of_service_note\": null,\n \"parking_info\": null,\n \"preferred_locations\": {\n \"dock_ids\": [],\n \"door_ids\": [],\n \"parking_lot_ids\": [],\n \"parking_spot_ids\": []\n },\n \"process_status\": \"In_Gate\",\n \"ready\": null,\n \"refrigerated\": false,\n \"seal\": \"84839485748\",\n \"seal_status\": \"Intact\",\n \"site_id\": 399,\n \"site_name\": \"Sample Site 06\",\n \"site_owner_id\": null,\n \"site_owner_name\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1652317943.203098,\n \"switcher_vehicle_id\": null,\n \"tag_code\": null,\n \"tag_type_id\": null,\n \"trailer_id\": 10944,\n \"trailer_name\": \"HUJK958685\",\n \"trailer_type\": \"Rail Car: Dry Van Enclosed\",\n \"trailer_type_id\": 242,\n \"usage\": \"Empty Pickup\",\n \"user_id\": 646\n }\n]"}],"_postman_id":"d5101671-397c-40a7-ad6d-a4f2b70b2814"},{"name":"Get Move Requests","id":"d7210b1d-8d6d-4628-baac-e2ba7adb2755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/move_requests/?site_id=396&trailer_id=2069&dock_name=Rail Dock&door_name=Door 08&from=1641666363&status=Logged&include_completed=true","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Unique site ID within Dynamic Yard

\n","type":"text/plain"},"key":"site_id","value":"396"},{"description":{"content":"

Trailer ID associated with the move request

\n","type":"text/plain"},"key":"trailer_id","value":"2069"},{"description":{"content":"

Name of the dock the move is to/from (SPOT / PULL)

\n","type":"text/plain"},"key":"dock_name","value":"Rail Dock"},{"description":{"content":"

Name of the door the move is to/from (SPOT / PULL)

\n","type":"text/plain"},"key":"door_name","value":"Door 08"},{"description":{"content":"

Filters by move requests falling after the specified time

\n","type":"text/plain"},"key":"from","value":"1641666363"},{"description":{"content":"

Filter move requests by matching status

\n","type":"text/plain"},"key":"status","value":"Logged"},{"description":{"content":"

Boolean value which controls whether the output contians completed moves. Keep as true if you intend on searching for moves in a \"Completed\" status

\n","type":"text/plain"},"key":"include_completed","value":"true"}],"variable":[]}},"response":[{"id":"aad32cd9-ae8b-43a5-b53c-f2aee1375ca6","name":"Get Move Requests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/move_requests/?site_id=396&&from=1641666363","host":["{{dynamic_yard_url}}"],"path":["wms","v1","move_requests",""],"query":[{"key":"site_id","value":"396","description":"Unique site ID within Dynamic Yard"},{"key":null,"value":null},{"key":"from","value":"1641666363","description":"Filters by move requests falling after the specified time"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:47:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1132"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"assignee\": {\n \"assignee_id\": 714,\n \"assignment_reason\": \"_match_neither: picked an available switcher in the site\",\n \"email_address\": \"jockey@shipperapi.com\",\n \"first_name\": \"Jockey\",\n \"last_name\": \"User\"\n },\n \"assignee_comments\": null,\n \"carrier_code\": \"DPED\",\n \"carrier_id\": 1906,\n \"carrier_name\": \"Derek 1234\",\n \"created_time\": 1644436043.440649,\n \"destination\": \"Door\",\n \"from\": {\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_id\": 15246,\n \"door_name\": \"Door 19\",\n \"location_id\": 56010,\n \"parking_lot_id\": null,\n \"parking_lot_name\": null,\n \"parking_spot_id\": null,\n \"parking_spot_name\": null\n },\n \"id\": 1842,\n \"mover_type\": \"Switcher\",\n \"priority\": \"Normal\",\n \"rejected\": false,\n \"requestor\": {\n \"email_address\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"requestor_id\": null\n },\n \"requestor_comments\": null,\n \"site_id\": 396,\n \"source_name\": null,\n \"source_type\": \"User\",\n \"status\": \"Logged\",\n \"status_end_time\": null,\n \"status_start_time\": 1644436043.8196867,\n \"to\": {\n \"dock_id\": 1683,\n \"dock_name\": \"Shipping Dock\",\n \"door_id\": 15279,\n \"door_name\": \"Door 30\",\n \"location_id\": 56046,\n \"parking_lot_id\": null,\n \"parking_lot_name\": null,\n \"parking_spot_id\": null,\n \"parking_spot_name\": null\n },\n \"trailer_id\": 3148,\n \"trailer_name\": \"New_Test_Trailer\",\n \"user_id\": null\n }\n]"}],"_postman_id":"d7210b1d-8d6d-4628-baac-e2ba7adb2755"},{"name":"Get Single Trailer","id":"3ae8c765-4717-4292-8921-78c4af902cc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/trailers?include_delivery_info=true&include_preferred_location_info=true&include_carrier_info=true¤t_site_id=396&trailer_name=645DCA8&carrier_code={{scac}}","urlObject":{"path":["wms","v1","trailers"],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Include deliveries associated with the trailer

\n","type":"text/plain"},"key":"include_delivery_info","value":"true"},{"description":{"content":"

Include information on the preferred location of the trailer

\n","type":"text/plain"},"key":"include_preferred_location_info","value":"true"},{"description":{"content":"

Include information on the carrier associated with the trailer

\n","type":"text/plain"},"key":"include_carrier_info","value":"true"},{"description":{"content":"

Unique site ID within Dynamic Yard

\n","type":"text/plain"},"key":"current_site_id","value":"396"},{"description":{"content":"

Exact trailer name - requires carrier_code

\n","type":"text/plain"},"key":"trailer_name","value":"645DCA8"},{"description":{"content":"

Carrier code or SCAC code

\n","type":"text/plain"},"key":"carrier_code","value":"{{scac}}"}],"variable":[]}},"response":[{"id":"d886bdeb-81c8-42d3-af59-602b5a7e0129","name":"Get Single Trailer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/trailers?include_delivery_info=true&include_preferred_location_info=true&include_carrier_info=true¤t_site_id=396&trailer_name=645DCA8&carrier_code={{scac}}","host":["{{dynamic_yard_url}}"],"path":["wms","v1","trailers"],"query":[{"key":"include_delivery_info","value":"true","description":"Include deliveries associated with the trailer"},{"key":"include_preferred_location_info","value":"true","description":"Include information on the preferred location of the trailer"},{"key":"include_carrier_info","value":"true","description":"Include information on the carrier associated with the trailer"},{"key":"current_site_id","value":"396","description":"Unique site ID within Dynamic Yard"},{"key":"trailer_name","value":"645DCA8","description":"Exact trailer name - requires carrier_code"},{"key":"carrier_code","value":"{{scac}}","description":"Carrier code or SCAC code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:49:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2954"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"additional_attributes\": null,\n \"audit\": false,\n \"audit_note\": \"\",\n \"broker_code\": null,\n \"broker_id\": null,\n \"broker_name\": null,\n \"carrier_id\": 1830,\n \"carrier_info\": {\n \"carrier_code\": \"0010\",\n \"id\": 1830,\n \"name\": \"McClure / Prinzi\"\n },\n \"check_in_time\": 1641480303.0720391,\n \"check_out_time\": null,\n \"comments\": \"\",\n \"condition\": null,\n \"damage\": false,\n \"damage_note\": \"\",\n \"deliveries\": [\n {\n \"actual_arrival_time\": null,\n \"actual_departure_time\": null,\n \"actual_load_id\": null,\n \"bill_of_lading\": \"55E6B5EF\",\n \"canceled\": false,\n \"customer_id\": null,\n \"customer_name\": null,\n \"destination_code\": \"SS03\",\n \"destination_id\": 396,\n \"destination_name\": \"Sample Site 03\",\n \"estimated_arrival_time\": null,\n \"external_url\": null,\n \"id\": 9558,\n \"name\": \"55E6B5EF_5664\",\n \"origin_code\": null,\n \"origin_id\": null,\n \"origin_name\": null,\n \"priority\": null,\n \"processed\": false,\n \"route_id\": \"PRO9838759\",\n \"safety_check\": null,\n \"safety_check_time\": null,\n \"scheduled_arrival_end\": 1641481564,\n \"scheduled_arrival_start\": 1641481564,\n \"scheduled_departure_end\": null,\n \"scheduled_departure_start\": null,\n \"scheduled_load_id\": null,\n \"site_code\": \"SS03\",\n \"site_id\": 396,\n \"site_name\": \"Sample Site 03\",\n \"tms_id\": \"55E6B5EF_5664\",\n \"tms_source\": \"TMS\",\n \"update_time\": \"Thu, 06 Jan 2022 15:06:04 GMT\"\n }\n ],\n \"delivery_ids\": [\n 9558\n ],\n \"delivery_info\": {\n \"actual_arrival_time\": null,\n \"actual_departure_time\": null,\n \"actual_load_id\": null,\n \"bill_of_lading\": \"55E6B5EF\",\n \"canceled\": false,\n \"customer_id\": null,\n \"customer_name\": null,\n \"destination_code\": \"SS03\",\n \"destination_id\": 396,\n \"destination_name\": \"Sample Site 03\",\n \"estimated_arrival_time\": null,\n \"external_url\": null,\n \"id\": 9558,\n \"name\": \"55E6B5EF_5664\",\n \"origin_code\": null,\n \"origin_id\": null,\n \"origin_name\": null,\n \"priority\": null,\n \"processed\": false,\n \"route_id\": \"PRO9838759\",\n \"safety_check\": null,\n \"safety_check_time\": null,\n \"scheduled_arrival_end\": 1641481564,\n \"scheduled_arrival_start\": 1641481564,\n \"scheduled_departure_end\": null,\n \"scheduled_departure_start\": null,\n \"scheduled_load_id\": null,\n \"site_code\": \"SS03\",\n \"site_id\": 396,\n \"site_name\": \"Sample Site 03\",\n \"tms_id\": \"55E6B5EF_5664\",\n \"tms_source\": \"TMS\",\n \"update_time\": \"Thu, 06 Jan 2022 15:06:04 GMT\"\n },\n \"door_info\": null,\n \"fuel_level\": null,\n \"id\": 14470,\n \"load_status\": \"Full\",\n \"load_type\": \"Inbound Production\",\n \"location_id\": null,\n \"out_of_service\": false,\n \"out_of_service_note\": \"\",\n \"parking_info\": null,\n \"preferred_locations\": {\n \"dock_ids\": [],\n \"door_ids\": [],\n \"parking_lot_ids\": [],\n \"parking_spot_ids\": []\n },\n \"process_status\": \"Loaded\",\n \"product_protection_check_source_name\": null,\n \"product_protection_check_source_type\": null,\n \"product_protection_check_time\": null,\n \"product_protection_check_user_id\": null,\n \"ready\": false,\n \"refrigerated\": false,\n \"refrigeration_status\": \"Not_Available\",\n \"seal\": null,\n \"seal_status\": null,\n \"site_id\": 396,\n \"site_name\": \"Sample Site 03\",\n \"site_owner_id\": null,\n \"site_owner_name\": null,\n \"status_end_time\": null,\n \"status_start_time\": 1642186372.230499,\n \"switcher_vehicle_id\": null,\n \"tag_code\": \"\",\n \"temperature\": null,\n \"temperature_display_unit\": null,\n \"temperature_set_point\": null,\n \"trailer_id\": 2019,\n \"trailer_name\": \"645DCA8\",\n \"trailer_type\": \"Container\",\n \"trailer_type_id\": 239,\n \"usage\": null,\n \"user_id\": 713\n }\n]"},{"id":"f9b9f8f1-a0be-4b4e-b3f2-7f70b369566c","name":"No Matching Trailer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/trailers?include_delivery_info=true&include_preferred_location_info=true&include_carrier_info=true¤t_site_id=396&trailer_name=64DCA8&carrier_code={{scac}}","host":["{{dynamic_yard_url}}"],"path":["wms","v1","trailers"],"query":[{"key":"include_delivery_info","value":"true","description":"Include deliveries associated with the trailer"},{"key":"include_preferred_location_info","value":"true","description":"Include information on the preferred location of the trailer"},{"key":"include_carrier_info","value":"true","description":"Include information on the carrier associated with the trailer"},{"key":"current_site_id","value":"396","description":"Unique site ID within Dynamic Yard"},{"key":"trailer_name","value":"64DCA8","description":"Exact trailer name - requires carrier_code"},{"key":"carrier_code","value":"{{scac}}","description":"Carrier code or SCAC code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:50:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"3ae8c765-4717-4292-8921-78c4af902cc4"}],"id":"1aa5e22b-f5f1-4390-a0e6-12368f3ea164","_postman_id":"1aa5e22b-f5f1-4390-a0e6-12368f3ea164","description":""}],"id":"e2db86d8-6855-4159-ace7-71f6ae72c9ec","description":"

The WMS section details APIs which are typically used to integrate Dynamic Yard with a Warehouse Management System (WMS). The APIs covered here are intended to automate the interactions between warehouse operations and the yard, focusing on connection points between systems.

\n","_postman_id":"e2db86d8-6855-4159-ace7-71f6ae72c9ec"},{"name":"Manage Dock Doors","item":[{"name":"Get Dock Doors","id":"2b03ccf9-e377-40f7-9f44-7d39d6c25804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"url":"{{dynamic_yard_url}}/wms/v1/doors/?site_id=396&dock_name=Rail Dock","description":"

This API allows you to get a list of doors under a specific dock on the site. The site_id is the internal site identifier in Dynamic Yard. Please contact your FourKites Delivery Consultant for a list of your static site ID's.

The dock_name will need to match a valid dock name from the Setup page:

Door Identifier

Once you have called the API for the target dock name, you should save the id in the JSON object for the specific door you'd like to update. That id will then be sent as a URL parameter in the Update Dock Door API described below.

\n","urlObject":{"path":["wms","v1","doors",""],"host":["{{dynamic_yard_url}}"],"query":[{"description":{"content":"

Unique site ID in Dynamic Yard

\n","type":"text/plain"},"key":"site_id","value":"396"},{"description":{"content":"

Name of the dock the door is associated with

\n","type":"text/plain"},"key":"dock_name","value":"Rail Dock"}],"variable":[]}},"response":[{"id":"d4d29a44-f1e6-4828-be5d-1a43bb1d177a","name":"Get Dock Doors","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"url":{"raw":"{{dynamic_yard_url}}/wms/v1/doors/?site_id=396&dock_name=Rail Dock&available=true&occupied=false","host":["{{dynamic_yard_url}}"],"path":["wms","v1","doors",""],"query":[{"key":"site_id","value":"396","description":"Unique site ID in Dynamic Yard"},{"key":"dock_name","value":"Rail Dock","description":"Name of the dock the door is associated with"},{"key":"available","value":"true","description":"Available status of the door"},{"key":"occupied","value":"false","description":"Occupied status of the door"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Feb 2022 19:45:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1154"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15249,\n \"location_id\": 56013,\n \"move_request_info\": null,\n \"name\": \"Door 23\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n },\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15251,\n \"location_id\": 56015,\n \"move_request_info\": null,\n \"name\": \"Door 25\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n },\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15252,\n \"location_id\": 56016,\n \"move_request_info\": null,\n \"name\": \"Door 26\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n },\n {\n \"archived\": false,\n \"building_code\": \"\",\n \"dock_id\": 1680,\n \"dock_name\": \"Rail Dock\",\n \"door_status\": \"Active\",\n \"geofence_id\": null,\n \"id\": 15254,\n \"location_id\": 56018,\n \"move_request_info\": null,\n \"name\": \"Door 28\",\n \"occupied\": false,\n \"queue\": [],\n \"reservation_status\": \"Not_Reserved\",\n \"site_id\": 396,\n \"trailer_id\": null\n }\n]"}],"_postman_id":"2b03ccf9-e377-40f7-9f44-7d39d6c25804"},{"name":"Update Dock Door","id":"308cdfee-4623-4e33-b021-716687d27fa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

Oauth2 token generated using client_id and client_secret

\n"}],"body":{"mode":"raw","raw":"{\n \"door_status\": \"Active\",\n \"building_code\": \"B948\",\n \"name\": \"Door 605\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/doors/{{door_id}}","description":"

Dynamic Yard also supports the ability to manage the status of dock doors in the yard. The main purpose of this API is to allow a WMS to mark a door as Active or Inactive, which can ensure that yard operations are unable to select doors which the WMS has marked as Inactive.

Path Parameter

In order to update a door, you will first need to fetch the list of dock doors which will supply the Dynamic Yard primary key of the door. As such, using the update API is predicated upon making a GET call into the dock doors list first.

Once you've have retrieved your target dock door from the list returned on the previous API, you will supply the id as the door_id in the URL path:

curl --location --request PUT 'https://dy-staging.fourkites.com/wms/v1/doors/:id' \\\n--header 'Authorization: Bearer TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"door_status\": \"Active\",\n    \"building_code\": \"B948\",\n    \"name\": \"Door 605\"\n}'\n\n

Field Definitions

There are 3 fields available to update on a door. Below are the definitions of each.

door_status
- Type: String
- Required: M
- Description: Specify the status of the door in the yard. Valid options include:
  - Active
  - Inactive
  - Rules_Disabled
  \n
\n
building_code
- Type: String
- Required: O
- Description: If a building code is associated with the door, it can be updated using this field
\n
name
- Type: String
- Required: O
- Description: The name of the dock door. It is recommended to keep this the same as during the initial implementation, if possible. If you do not intend to change the name of the door, it is recommended to exclude this field from the API request
\n

\n","urlObject":{"path":["wms","v1","doors","{{door_id}}"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"5dfb55d9-95d2-4adc-a168-9b786c141e70","name":"Update Dock Door","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"door_status\": \"Active\",\n \"building_code\": \"B948\",\n \"name\": \"Door 605\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/doors/{{door_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Apr 2022 14:49:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Server-Timing","value":"cacheCleared"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"200"},{"id":"94f866d7-058e-45c3-8014-69dc2b024dd4","name":"Invalid Door Status","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"door_status\": \"active\",\n \"building_code\": \"B948\",\n \"name\": \"Door 605\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/doors/{{door_id}}"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Apr 2022 14:50:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"142"},{"key":"Connection","value":"keep-alive"},{"key":"content_type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": 2013,\n \"error_message\": \"yms_db.db.errors: Invalid door status 'active'. Must be one of ('Active', 'Inactive', 'Rules_Disabled')\"\n}"},{"id":"308f0600-36e1-4c33-aebd-2d168fea23f4","name":"Invalid Door ID","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Oauth2 token generated using client_id and client_secret"}],"body":{"mode":"raw","raw":"{\n \"door_status\": \"Active\",\n \"building_code\": \"B948\",\n \"name\": \"Door 605\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/doors/{{door_id}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Thu, 21 Apr 2022 14:49:47 GMT"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"141"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"\n \n Internal Server Error\n \n \n

\n
Internal Server Error
\n

\n \n"}],"_postman_id":"308cdfee-4623-4e33-b021-716687d27fa2"}],"id":"91884f87-073a-4446-88af-f38c07b779d3","description":"

As part of the integration points with a WMS, it may be necessary for the WMS to mark dock doors as active/inactive in Dynamic Yard. This helps facilitate more efficient interaction with Dynamic Yard in cases where a dock door may need to be marked as inactive. In such cases, the door will no longer be able to be selected by users in the yard, helping to avoid conflicts between warehouse and yard operations.

Managing Door Information

There are 2 steps required in interacting with dock doors via API:

Get all dock doors for a site and target the door you intend to update
Send a request to update the target door

Below are the 2 API calls referenced in this flow.

\n","_postman_id":"91884f87-073a-4446-88af-f38c07b779d3"},{"name":"Manage Gate Activity","item":[{"name":"Gate Check-In","item":[{"name":"Check-In Empty Trailer","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","let check_time = Math.floor((Math.floor(Date.now()) / 1000))","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000) +1000)","","pm.environment.set('check_time', check_time);","pm.environment.set('scheduled_time', scheduled_time);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","pm.environment.set('tractor_number', uuid.v4().toUpperCase().substring(4,12).replace(/-/g, ''));","","pm.environment.set('delivery_id', id + '_' + id_str)"],"type":"text/javascript","id":"942770c6-e975-4063-b422-1d57d369ba6c"}}],"id":"8398c195-2141-4e8f-a391-f849178e1454","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"

Oauth2 token generated using client_id and client_secret

Check an empty trailer into the yard. Note how the deliveries array is empty, which matches the load_status of Empty.

\n","urlObject":{"path":["gate","v1","checkin"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"4e8fc73f-7f34-4037-b639-d0a7a8500d08","name":"Check-In - Empty Trailer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Oauth2 token generated using client_id and client_secret"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 17:42:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"129"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"trailer_check_id\": 10961,\n \"trailer_id\": 16830,\n \"trailer_number\": \"D4053BE\",\n \"gate_pass_id\": 45244,\n \"trailer_status_id\": 54641\n}"}],"_postman_id":"8398c195-2141-4e8f-a391-f849178e1454"},{"name":"Check-In Full Trailer","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","let check_time = Math.floor((Math.floor(Date.now()) / 1000))","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000) +1000)","","pm.environment.set('check_time', check_time);","pm.environment.set('scheduled_time', scheduled_time);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","pm.environment.set('tractor_number', uuid.v4().toUpperCase().substring(4,12).replace(/-/g, ''));","","pm.environment.set('delivery_id', id + '_' + id_str)"],"type":"text/javascript","id":"9094eef9-d874-412e-ae72-d7539551a036"}}],"id":"6dfdfb14-b0ca-45b7-af8f-5449e78eee89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"

Oauth2 token generated using client_id and client_secret

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Inbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is checked-in to be unloaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Full\",\n \"load_type\": \"Inbound Production\",\n \"seal_status\": \"Intact\",\n \"seal\": \"SEAL948584\"\n },\n \"deliveries\": [\n {\n \"name\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"origin_code\": \"{{site_code}}\",\n \"destination_code\": \"{{site_code}}\"\n }\n ]\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin","description":"

Example check-in payload for a full trailer. Note the presence of an object within the deliveries array and the load_status of Full inside the trailer object.

\n","urlObject":{"path":["gate","v1","checkin"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"770900ec-3f8d-43fe-b945-90bdcaafffa2","name":"Check-In - Full Trailer","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Oauth2 token generated using client_id and client_secret"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Inbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is checked-in to be unloaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Full\",\n \"load_type\": \"Inbound Production\",\n \"seal_status\": \"Intact\",\n \"seal\": \"SEAL948584\"\n },\n \"deliveries\": [\n {\n \"name\": \"{{delivery_id}}\",\n \"site_code\": \"{{site_code}}\",\n \"scheduled_arrival_start\": {{scheduled_time}},\n \"scheduled_arrival_end\": {{scheduled_time}},\n \"bill_of_lading\": \"{{delivery_id}}\",\n \"origin_code\": \"{{site_code}}\",\n \"destination_code\": \"{{site_code}}\"\n }\n ]\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 17:42:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"129"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"trailer_check_id\": 10962,\n \"trailer_id\": 16831,\n \"trailer_number\": \"CABFF45\",\n \"gate_pass_id\": 45245,\n \"trailer_status_id\": 54644\n}"}],"_postman_id":"6dfdfb14-b0ca-45b7-af8f-5449e78eee89"},{"name":"Check-In w/ Trailer Tag","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","let check_time = Math.floor((Math.floor(Date.now()) / 1000))","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000) +1000)","","pm.environment.set('check_time', check_time);","pm.environment.set('scheduled_time', scheduled_time);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","pm.environment.set('tractor_number', uuid.v4().toUpperCase().substring(4,12).replace(/-/g, ''));","","pm.environment.set('delivery_id', id + '_' + id_str)"],"type":"text/javascript","id":"9f9a9b9f-0d48-4552-a333-56e4a42f1b64"}}],"id":"b3f8b7fc-6243-43be-8a63-a5fd4f728048","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"

Oauth2 token generated using client_id and client_secret

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"tag_code\": \"457473\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin","urlObject":{"path":["gate","v1","checkin"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"e5c0b6ff-22c6-403a-8077-61edfb742082","name":"Check-In - w/ Trailer Tag","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Oauth2 token generated using client_id and client_secret"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"tag_code\": \"757473\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 May 2022 13:13:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"trailer_check_id\": 10962,\n \"trailer_id\": 16831,\n \"trailer_number\": \"CABFF45\",\n \"gate_pass_id\": 45245,\n \"trailer_status_id\": 54644\n}"},{"id":"190cf20d-cfd0-474b-a5d7-b53affb05988","name":"Invalid Trailer Tag","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Oauth2 token generated using client_id and client_secret"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"tag_code\": \"457473A\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 May 2022 17:32:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"197"},{"key":"Connection","value":"keep-alive"},{"key":"content_type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": 2151,\n \"error_message\": \"yms_db.db.errors: Trailer checkin payload is invalid {'trailer': {'tag_code': [\\\"The 'tag_code' should be an uppercase, hexadecimal value six digits long\\\"]}}\"\n}"}],"_postman_id":"b3f8b7fc-6243-43be-8a63-a5fd4f728048"},{"name":"Check-In w/ Additional Attributes","event":[{"listen":"prerequest","script":{"exec":["const uuid = require('uuid');","","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","let check_time = Math.floor((Math.floor(Date.now()) / 1000))","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000) +1000)","","pm.environment.set('check_time', check_time);","pm.environment.set('scheduled_time', scheduled_time);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","pm.environment.set('tractor_number', uuid.v4().toUpperCase().substring(4,12).replace(/-/g, ''));","","pm.environment.set('delivery_id', id + '_' + id_str)"],"type":"text/javascript","id":"6f6b23da-0e89-40c8-b0d6-bcbe97a809ff"}}],"id":"b24fcf36-cb99-417c-bb05-c427acdf79ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"

Oauth2 token generated using client_id and client_secret

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"dock_name\": \"Shipping Dock\",\n \"door_name\": \"Door 36\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin","urlObject":{"path":["gate","v1","checkin"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"b1a36ffe-bc37-4bd7-8527-3436accde18c","name":"Check-In to Dock Door","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Oauth2 token generated using client_id and client_secret"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"dock_name\": \"Shipping Dock\",\n \"door_name\": \"Door 36\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 08 Jan 2023 22:11:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"131"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"trailer_check_id\": 16569, \"trailer_id\": 96614, \"trailer_number\": \"EF67CD7\", \"gate_pass_id\": 151488, \"trailer_status_id\": 153629}\n"},{"id":"7eb95035-e8ef-42fc-8b5a-0713218efa65","name":"Door already occupied","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Oauth2 token generated using client_id and client_secret"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"appointment_type\": \"Outbound_Only\",\n \"check_time\": {{check_time}},\n \"comments\": \"Trailer is ready to be loaded\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"dock_name\": \"Shipping Dock\",\n \"door_name\": \"Door 36\"\n },\n \"deliveries\": []\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkin"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Mon, 09 Jan 2023 00:35:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"209"},{"key":"Connection","value":"keep-alive"},{"key":"content_type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"error_code\":2151,\"error_message\":\"yms_db.db.errors: Trailer checkin payload is invalid {'trailer': {'_schema': ['Destination door is already occupied by trailer EF67CD7 (trailer_id: 96614)']}}\"}\n"}],"_postman_id":"70dbb80b-a907-4edd-b8c0-fe61646a68e8"},{"name":"Check-In to Parking Spot","event":[{"listen":"prerequest","script":{"id":"942770c6-e975-4063-b422-1d57d369ba6c","exec":["const uuid = require('uuid');","","let id = uuid.v4().toUpperCase().substring(0,8);","let id_str = uuid.v4().toUpperCase().substring(4,8);","let check_time = Math.floor((Math.floor(Date.now()) / 1000))","let scheduled_time = Math.floor((Math.floor(Date.now()) / 1000) +1000)","","pm.environment.set('check_time', check_time);","pm.environment.set('scheduled_time', scheduled_time);","pm.environment.set('trailer_number', uuid.v4().toUpperCase().substring(2,10).replace(/-/g, ''));","pm.environment.set('tractor_number', uuid.v4().toUpperCase().substring(4,12).replace(/-/g, ''));","","pm.environment.set('delivery_id', id + '_' + id_str)"],"type":"text/javascript"}}],"id":"bd66b2da-4033-471c-b622-4d5383d5be61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"

Oauth2 token generated using client_id and client_secret

The Gate APIs allow automation to take place between kiosks or other systems which might capture such activities and relay it to Dynamic Yard. Specifically the Gate Check-In API allows a trailer to be automatically checked into the yard and associated with a delivery (if full). Additionally, the Gate Check-Out API offers the corollary function of checking an existing trailer out of the facility.

Field Definitions

Transaction Details

site_code
\n
- Type: String
  \n
- Required: O
  \n
- Description: Unique code for the site
  \n
\n
appointment_type
\n
- Type: String
  \n
- Required: CM*
  \n
- Description:Type of check-in into the yard. *Only required for the checkin API. These correspond to the check-in options on the “Gate” page in the UI. Valid values for the API: Drop_And_Hook | Live | Inbound_Only | Outbound_Only | Check_in_Only
  \n
\n
gate_pass
\n
- Type: String
  \n
- Required: CM*
  \n
- Description: Gate pass ID issued when the trailer was initially checked into the yard. *Only required for the checkout API
  \n
\n
check_time
\n
- Type: Unix Time (Int32)
  \n
- Required: M
  \n
- Description: Time of check-in event. If not specified, the time will default to the current date/time
  \n
\n
comments
\n
- Type: String
  \n
- Required: O
  \n
- Description: Comments related to the check-in
  \n
\n

Trailer Details

carrier_code
\n
- Type: String
  \n
- Required: M
  \n
- Description: Code of the carrier associated with the trailer. Commonly this is the SCAC code, but can also be another identifier used as master data within Dynamic Yard
  \n
\n
door_name
\n
- Type: String
  \n
- Required: O
  \n
- Description: Name for the specific door which the trailer's location should be placed into. If specified, this must be a door which is associated to the dock_name
  \n
\n
dock_name
\n
- Type: String
  \n
- Required: O
  \n
- Description: Name for the specific dock which the trailer's location should be placed into. If specified, this must be a dock which is associated to the door_name
  \n
\n
name
\n
- Type: String
  \n
- Required: M
  \n
- Description: Unique identifier or number for the trailer. This will become the trailer number in Dynamic Yard
  \n
\n
type
\n
- Type: String
  \n
- Required: M
  \n
- Description: Type of the trailer which corresponds to the valid options configured in Dynamic Yard (“40’ Container”, “53’ Dry Van”, etc.)
  \n
\n
tag_code
\n
- Type: String
  \n
- Required: O
  \n
- Description: Identifier for the trailer tag or RFID tag associated with the trailer. Trailer tag formats are defined as master data within Dynamic Yard. Please contact your FourKites Delivery Consultant for additional information
  \n
\n
load_status
\n
- Type: String
  \n
- Required: M
  \n
- Description: The state of the trailer’s load as it applies to the site. Available options include: Full | Partial | Empty
  \n
\n
load_type
\n
- Type: String
  \n
- Required: O
  \n
- Description: Type of the load which is on the trailer. Valid options include: For Pickup | For Reload | Inbound Production | Inbound Returnables | Outbound Production | Outbound Returnables
  \n
\n
door_name
\n
- Type: String
  \n
- Required: O
  \n
- Description: Name for the specific door which the trailer's location should be placed into. If specified, this must be a door which is associated to the dock_name
  \n
\n
dock_name
\n
- Type: String
  \n
- Required: O
  \n
- Description: Name for the specific dock which the trailer's location should be placed into. If specified, this must be a dock which is associated to the door_name
  \n
\n
parking_spot_name
\n
- Type: String
  \n
- Required: O
  \n
- Description: Name for the specific parking spot which the trailer's location should be placed into. If specified, this must be a spot which is associated to the parking_lot_name
  \n
\n
parking_lot_name
\n
- Type: String
  \n
- Required: O
  \n
- Description: Name for the specific parking lot which the trailer's location should be placed into. If specified, this must be a parking lot which is associated to the parking_spot_name
  \n
\n

Tractor Details

The tractor section is optional for check-in events. The \"M\" and \"O\" designations below refer to whether the tractor object is included in the payload. If included, the following indicators apply.

carrier_code
\n
- Type: String
  \n
- Required: M
  \n
- Description: Code of the carrier associated with the tractor. Commonly this is the SCAC code, but can also be another identifier used as master data within Dynamic Yard
  \n
\n
name
\n
- Type: String
  \n
- Required: M
  \n
- Description: Unique identifier or number for the tractor
  \n
\n
country
\n
- Type: String
  \n
- Required: O
  \n
- Description: Country associated with the tractor
  \n
\n
state
\n
- Type: String
  \n
- Required: M
  \n
- Description: State associated with the tractor
  \n
\n
license_plate
\n
- Type: String
  \n
- Required: O
  \n
- Description: License plate number associated with the tractor
  \n
\n

Driver Details

The driver object is optional for check-in events. The \"M\" and \"O\" designations below refer to whether the driver object is included in the payload. If included, the following indicators apply.

name
\n
- Type: String
  \n
- Required: M
  \n
- Description: Name of the driver
  \n
\n
license_number
\n
- Type: String
  \n
- Required: O
  \n
- Description: Driver's license number
  \n
\n
license_state
\n
- Type: String
  \n
- Required: O
  \n
- Description: State associated with the driver's license
  \n
\n
license_country
\n
- Type: String
  \n
- Required: O
  \n
- Description: Country associated with the driver's license
  \n
\n
phone
\n
- Type: String
  \n
- Required: O
  \n
- Description: Driver's phone number
  \n
\n

Delivery Details

\n
Note: Deliveries can only be associated to trailers checking into the yard. This object cannot be associated to trailers checking out of the yard. If attempted an error will be thrown
\n

{\n    \"error_code\": 2150,\n    \"error_message\": \"yms_db.db.errors: Trailer checkout payload is invalid {'deliveries': ['Unknown field.']}\"\n}\n\n

There can be multiple deliveries associated with a trailer upon check-in. If multiple are listed, each of these fields apply to the object within the deliveries array:

{ ...\n  \"deliveries\": [\n     { ... delivery 1 ... },\n     { ... delivery 2 ... }\n   ]\n}\n\n

Please see the DELIVERIES section for field-level definitions and requirements for deliveries.

Additional Attributes

The below fields are arranged as keys within each object of the additional_attributes:

\"additional_attributes\": [\n    {\n        \"form\": \"trailer\",\n        \"type\": \"dropdown\",\n        \"name\": \"Trailer Material\",\n        \"value\": \"Steel\"\n    }\n]\n\n

form
\n
- Type: String
  \n
- Required: *CM (Mandatory if using custom attributes)
  \n
- Description: The form in Dynamic Yard which the attribute is associated with. This should always be hard-coded to trailer
  \n
\n
type
\n
- Type: String
  \n
- Required: *CM (Mandatory if using custom attributes)
  \n
- Description: Data type of the custom trailer attribute. Valid values: toggle | text | dropdown
  \n
\n
name
\n
- Type: String
  \n
- Required: *CM (Mandatory if using custom attributes)
  \n
- Description: Name of the custom trailer attribute. The name must match exactly what is configured/visible in the Dynamic Yard UI
  \n
\n
value
\n
- Type: String
  \n
- Required: *CM (Mandatory if using custom attributes)
  \n
- Description: Value of the custom attribute. If using the toggle option, please ensure that all letters are lowercase (\"yes\" or \"no\")
  \n
\n

\n","_postman_id":"2d2422d0-e6b7-471c-becc-ef8b904c1a94"},{"name":"Gate Check-Out","item":[{"name":"Check-Out Trailer","id":"2fc49e3d-9e25-45b9-b4d1-35679b4c5ae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"gate_pass\": \"6021\",\n \"comments\": \"Trailer is ready to check-out\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"Inbound Production\"\n }\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkout","description":"

The Gate Check-Out API includes a field for gate_pass which is generated when a trailer is checked into the yard. This pass associates the trailer to its details upon entry.

Additionally, the appointment_type is not required and should be removed from check-out API calls as the appointment at the facility has been fulfilled.

Deliveries also cannot be referenced to a trailer checking out of the yard. As such, a full trailer will simply be noted as such with the load_status of \"Full\".

\n","urlObject":{"path":["gate","v1","checkout"],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[{"id":"87b14e12-a1bf-47e4-83c2-0dd00ac0bb4f","name":"Gate Check-Out","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"gate_pass\": \"6021\",\n \"comments\": \"Trailer is ready to check-out\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"Inbound Production\"\n }\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkout"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 09 Jan 2022 19:37:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"75"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"trailer_check_id\": 2016, \"trailer_id\": 2080, \"trailer_status_id\": 11329}\n"},{"id":"804df263-5ce1-4711-b0f4-3972e19993a1","name":"Trailer not on site","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"gate_pass\": \"6021\",\n \"comments\": \"Trailer is ready to check-out\",\n \"tractor\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{tractor_number}}\",\n \"country\": \"USA\",\n \"state\": \"IL\",\n \"license_plate\": \"AZ 3596\"\n },\n \"driver\": {\n \"name\": \"Jane Doe\",\n \"license_number\": \"DL100100100\",\n \"license_state\": \"IL\",\n \"license_country\": \"USA\",\n \"phone\": \"(120)111-2222\"\n },\n \"trailer\": {\n \"carrier_code\": \"{{scac}}\",\n \"name\": \"{{trailer_number}}\",\n \"type\": \"Container\",\n \"load_status\": \"Empty\",\n \"load_type\": \"Inbound Production\"\n }\n}"},"url":"{{dynamic_yard_url}}/gate/v1/checkout"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 08 Jan 2023 22:09:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"keep-alive"},{"key":"content_type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"error_code\":2150,\"error_message\":\"yms_db.db.errors: Trailer checkout payload is invalid Invalid trailer\"}\n"}],"_postman_id":"2fc49e3d-9e25-45b9-b4d1-35679b4c5ae6"}],"id":"f2991a75-809d-469c-900c-e2c819212f09","description":"

Field Definitions

Transaction Details

site_code
- Type: String
- Required: O
- Description: Unique code for the site
\n
appointment_type
- Type: String
- Required: CM*
- Description:Type of check-in into the yard. *Only required for the checkin API. These correspond to the check-in options on the “Gate” page in the UI. Valid values for the API: Drop_And_Hook | Live | Inbound_Only | Outbound_Only | Check_in_Only
\n
gate_pass
- Type: String
- Required: CM*
- Description: Gate pass ID issued when the trailer was initially checked into the yard. *Only required for the checkout API
\n
check_time
- Type: Unix Time (Int32)
- Required: M
- Description: Time of check-in event. If not specified, the time will default to the current date/time
\n
comments
- Type: String
- Required: O
- Description: Comments related to the check-in
\n

Trailer Details

carrier_code
- Type: String
- Required: M
- Description: Code of the carrier associated with the trailer. Commonly this is the SCAC code, but can also be another identifier used as master data within Dynamic Yard
\n
door_name
- Type: String
- Required: O
- Description: Name for the specific door which the trailer's location should be placed into. If specified, this must be a door which is associated to the dock_name
\n
dock_name
- Type: String
- Required: O
- Description: Name for the specific dock which the trailer's location should be placed into. If specified, this must be a dock which is associated to the door_name
\n
name
- Type: String
- Required: M
- Description: Unique identifier or number for the trailer. This will become the trailer number in Dynamic Yard
\n
type
- Type: String
- Required: M
- Description: Type of the trailer which corresponds to the valid options configured in Dynamic Yard (“40’ Container”, “53’ Dry Van”, etc.)
\n
tag_code
- Type: String
- Required: O
- Description: Identifier for the trailer tag or RFID tag associated with the trailer. Trailer tag formats are defined as master data within Dynamic Yard. Please contact your FourKites Delivery Consultant for additional information
\n
load_status
- Type: String
- Required: M
- Description: The state of the trailer’s load as it applies to the site. Available options include: Full | Partial | Empty
\n
load_type
- Type: String
- Required: O
- Description: Type of the load which is on the trailer. Valid options include: For Pickup | For Reload | Inbound Production | Inbound Returnables | Outbound Production | Outbound Returnables
\n

Tractor Details

carrier_code
- Type: String
- Required: M
- Description: Code of the carrier associated with the tractor. Commonly this is the SCAC code, but can also be another identifier used as master data within Dynamic Yard
\n
name
- Type: String
- Required: M
- Description: Unique identifier or number for the tractor
\n
country
- Type: String
- Required: O
- Description: Country associated with the tractor
\n
state
- Type: String
- Required: M
- Description: State associated with the tractor
\n
license_plate
- Type: String
- Required: O
- Description: License plate number associated with the tractor
\n

Driver Details

name
- Type: String
- Required: M
- Description: Name of the driver
\n
license_number
- Type: String
- Required: O
- Description: Driver's license number
\n
license_state
- Type: String
- Required: M
- Description: State associated with the driver's license
\n
license_country
- Type: String
- Required: O
- Description: Country associated with the driver's license
\n
phone
- Type: String
- Required: O
- Description: Driver's phone number
\n

Delivery Details

\n
Note: Deliveries can only be associated to trailers checking into the yard. This object cannot be associated to trailers checking out of the yard. If attempted an error will be thrown
\n

{\n    \"error_code\": 2150,\n    \"error_message\": \"yms_db.db.errors: Trailer checkout payload is invalid {'deliveries': ['Unknown field.']}\"\n}\n\n

There can be multiple deliveries associated with a trailer upon check-in. If multiple are listed, each of these fields apply to the object within the deliveries array:

{ ...\n  \"deliveries\": [\n     { ... delivery 1 ... },\n     { ... delivery 2 ... }\n   ]\n}\n\n

Please see the DELIVERIES section for field-level definitions and requirements for deliveries.

Additional Attributes

The below fields are arranged as keys within each object of the additional_attributes:

\"additional_attributes\": [\n    {\n        \"form\": \"trailer\",\n        \"type\": \"dropdown\",\n        \"name\": \"Trailer Material\",\n        \"value\": \"Steel\"\n    }\n]\n\n

form
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: The form in Dynamic Yard which the attribute is associated with. This should always be hard-coded to trailer
\n
type
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: Data type of the custom trailer attribute. Valid values: toggle | text | dropdown
\n
name
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: Name of the custom trailer attribute. The name must match exactly what is configured/visible in the Dynamic Yard UI
\n
value
- Type: String
- Required: *CM (Mandatory if using custom attributes)
- Description: Value of the custom attribute. If using the toggle option, please ensure that all letters are lowercase (\"yes\" or \"no\")
\n

\n","_postman_id":"f2991a75-809d-469c-900c-e2c819212f09"}],"id":"8fb3d3a8-de3b-47ee-b54e-08721502743c","description":"

The Gate APIs can be used to automatically check a trailer in / out of a facility. These can be used to integrate with a kiosk or other system used by the guard shack to check a trailer in and pass the relevant information over into Dynamic Yard.

Many of the fields are optional, so it is recommended to pass as many fields as will be useful during yard operations on the trailer.

\n","_postman_id":"8fb3d3a8-de3b-47ee-b54e-08721502743c"},{"name":"Manage Loads and Appointments","item":[{"name":"Create Load","event":[{"listen":"prerequest","script":{"exec":["// seed the payload with updated variables","","var uuid = require('uuid');","var uniqueNum = uuid.v4().toUpperCase().substring(0,8);","","pm.environment.set('load_number', uniqueNum);","","","function roundTimeQuarterHour() {"," var timeToReturn = new Date();",""," timeToReturn.setMilliseconds(Math.round(timeToReturn.getMilliseconds() / 1000) * 1000);"," timeToReturn.setSeconds(Math.round(timeToReturn.getSeconds() / 60) * 60);"," timeToReturn.setMinutes(Math.round(timeToReturn.getMinutes() / 15) * 15);"," return timeToReturn;","}","","// set the appt dates for pickup","","pm.environment.set('pickup_early', roundTimeQuarterHour().addDays(-3));","pm.environment.set('pickup_late', roundTimeQuarterHour().addDays(-2));","","// set the appt dates for delivery","","pm.environment.set('deliver_early', roundTimeQuarterHour().addDays(1));","pm.environment.set('deliver_late', roundTimeQuarterHour().addDays(2));","","",""],"type":"text/javascript","id":"da655225-12be-404f-9665-2bd8821f92d2"}},{"listen":"test","script":{"exec":["pm.environment.set('tracking_id', JSON.parse(responseBody).loadId);"],"type":"text/javascript","id":"5b4163f8-1956-4b71-8f50-f763399aa97c"}}],"id":"19102bb5-7d0d-46c8-a799-34eab5bfdc50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text","description":"

API key generated on the FourKites developer portal

\n"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{load_number}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickup_early}}\",\n \"latestAppointmentTime\": \"{{pickup_late}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliver_early}}\",\n \"latestAppointmentTime\": \"{{deliver_late}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking","description":"

Create a load using the Core Track service. This data is passed down into Appointment Manager and can also create a delivery in Dynamic Yard.

\n","urlObject":{"path":["api","v1","tracking"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"3feb0703-5e75-47f9-95fb-035a1aebb053","name":"Create Non-Trackable Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{loadNumber}}\",\n \"nonTrackable\": true,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickUpEarly}}\",\n \"latestAppointmentTime\": \"{{pickUpLate}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliverEarly}}\",\n \"latestAppointmentTime\": \"{{deliverLate}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gatewayUrl}}/api/v1/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:19:53 GMT"},{"key":"ETag","value":"W/\"77b963a36babd0e76db8ccf49d95d605\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"87531694-55a6-463d-967d-0ab6e4117997"},{"key":"X-Runtime","value":"0.012072"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"97"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"loadId\":\"test-company__0E4D56AD\",\"message\":\"Non trackable load submitted\"}"},{"id":"cd0d5b22-1447-4687-ab75-a345361a7931","name":"Create Trackable Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{loadNumber}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickUpEarly}}\",\n \"latestAppointmentTime\": \"{{pickUpLate}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliverEarly}}\",\n \"latestAppointmentTime\": \"{{deliverLate}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gatewayUrl}}/api/v1/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:20:19 GMT"},{"key":"ETag","value":"W/\"be8540488d87371ac975d677c0dfb1e6\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"c30aa4f3-8391-44cf-909e-2f1f2884aefa"},{"key":"X-Runtime","value":"1.163315"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"message\":\"Load creation request has been submitted successfully\",\"loadId\":172631173}"}],"_postman_id":"19102bb5-7d0d-46c8-a799-34eab5bfdc50"},{"name":"Create Load w/ Pallets","event":[{"listen":"prerequest","script":{"exec":["// seed the payload with updated variables","","var uuid = require('uuid');","var uniqueNum = uuid.v4().toUpperCase().substring(0,8);","","pm.environment.set('load_number', uniqueNum);","","","function roundTimeQuarterHour() {"," var timeToReturn = new Date();",""," timeToReturn.setMilliseconds(Math.round(timeToReturn.getMilliseconds() / 1000) * 1000);"," timeToReturn.setSeconds(Math.round(timeToReturn.getSeconds() / 60) * 60);"," timeToReturn.setMinutes(Math.round(timeToReturn.getMinutes() / 15) * 15);"," return timeToReturn;","}","","// set the appt dates for pickup","","pm.environment.set('pickup_early', roundTimeQuarterHour().addDays(-3));","pm.environment.set('pickup_late', roundTimeQuarterHour().addDays(-2));","","// set the appt dates for delivery","","pm.environment.set('deliver_early', roundTimeQuarterHour().addDays(1));","pm.environment.set('deliver_late', roundTimeQuarterHour().addDays(2));","","",""],"type":"text/javascript","id":"71444d88-e8fc-427d-a558-f88037d0fa5e"}},{"listen":"test","script":{"exec":["pm.environment.set('tracking_id', JSON.parse(responseBody).loadId);"],"type":"text/javascript","id":"21baad44-68df-4235-aed6-18152df8678d"}}],"id":"8cd1f49c-0736-404f-a8a8-3ecedbd10bf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text","description":"

API key generated on the FourKites developer portal

\n"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{load_number}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickup_early}}\",\n \"latestAppointmentTime\": \"{{pickup_late}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliver_early}}\",\n \"latestAppointmentTime\": \"{{deliver_late}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\",\n \"pallets\": [\n {\n \"number\": \"123444444\",\n \"parts\": [\n {\n \"customerPartNumber\": \"65-2333SS\",\n \"quantity\": \"21\",\n \"shipperPartNumber\": \"59924\",\n \"weight\": \"880.32 LB\"\n },\n {\n \"customerPartNumber\": \"65-24S\",\n \"quantity\": \"15\",\n \"shipperPartNumber\": \"1255524\",\n \"weight\": \"628.8 LB\"\n }\n ]\n }\n ]\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking","description":"

Create a load with pallets at one or both of the stops. Pallets are optional and are used for view-only purposes in FourKites products. Please see the Field Definitions above for more information.

\n","urlObject":{"path":["api","v1","tracking"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"9caec54a-8308-4196-8302-1381a9c2862c","name":"Create Non-Trackable Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"0010\",\n \"loadNumber\": \"\",\n \"nonTrackable\": true,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"\",\n \"latestAppointmentTime\": \"\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"\",\n \"latestAppointmentTime\": \"\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:19:53 GMT"},{"key":"ETag","value":"W/\"77b963a36babd0e76db8ccf49d95d605\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"87531694-55a6-463d-967d-0ab6e4117997"},{"key":"X-Runtime","value":"0.012072"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"97"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"loadId\":\"test-company__0E4D56AD\",\"message\":\"Non trackable load submitted\"}"},{"id":"7df5d0d7-0a49-420c-a4b1-b5d48298f004","name":"Create Trackable Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{loadNumber}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickUpEarly}}\",\n \"latestAppointmentTime\": \"{{pickUpLate}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliverEarly}}\",\n \"latestAppointmentTime\": \"{{deliverLate}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:20:19 GMT"},{"key":"ETag","value":"W/\"be8540488d87371ac975d677c0dfb1e6\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"c30aa4f3-8391-44cf-909e-2f1f2884aefa"},{"key":"X-Runtime","value":"1.163315"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"message\":\"Load creation request has been submitted successfully\",\"loadId\":172631173}"}],"_postman_id":"8cd1f49c-0736-404f-a8a8-3ecedbd10bf2"},{"name":"Specify Appointment Calendar","event":[{"listen":"prerequest","script":{"exec":["// seed the payload with updated variables","","var uuid = require('uuid');","var uniqueNum = uuid.v4().toUpperCase().substring(0,8);","","pm.environment.set('load_number', uniqueNum);","","","function roundTimeQuarterHour() {"," var timeToReturn = new Date();",""," timeToReturn.setMilliseconds(Math.round(timeToReturn.getMilliseconds() / 1000) * 1000);"," timeToReturn.setSeconds(Math.round(timeToReturn.getSeconds() / 60) * 60);"," timeToReturn.setMinutes(Math.round(timeToReturn.getMinutes() / 15) * 15);"," return timeToReturn;","}","","// set the appt dates for pickup","","pm.environment.set('pickup_early', roundTimeQuarterHour().addDays(-3));","pm.environment.set('pickup_late', roundTimeQuarterHour().addDays(-2));","","// set the appt dates for delivery","","pm.environment.set('deliver_early', roundTimeQuarterHour().addDays(1));","pm.environment.set('deliver_late', roundTimeQuarterHour().addDays(2));","","",""],"type":"text/javascript","id":"a6bb9603-0f10-4097-ac08-0c37d3dcb5c0"}},{"listen":"test","script":{"exec":["pm.environment.set('tracking_id', JSON.parse(responseBody).loadId);"],"type":"text/javascript","id":"fc855d51-95f5-4764-bfc0-fd265a6129b8"}}],"id":"7f23cbb8-91f7-44f5-a8a9-7ad3c658e894","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text","description":"

API key generated on the FourKites developer portal

\n"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{load_number}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"94BC8\",\n \"Type: BLK DRY\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickup_early}}\",\n \"latestAppointmentTime\": \"{{pickup_late}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliver_early}}\",\n \"latestAppointmentTime\": \"{{deliver_late}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking","description":"

When creating a load with the Create Load API, you can also set a specific attributes about the appointment which can help assign that shipment to a given calendar configuration. Please continue reading below to see how the matching is done when creating a load/appointment and how that data matches to a calendar.

Specify a Calendar in Appointment Manager

Before calendars can be specified on the API, different appointment \"types\" must be configured inside Appointment Manager. Please see the Appointment Manager product documentation for more information on configuring calendars.

Once a calendar(s) is configured, the following values are determined by the load you create:

Shipping Type: This is determined by whether the stop aligned with facility is a \"pickup\" or \"delivery\". These fields align with the stopType in the API
Product Type: This field can be passed inside the referenceNumbers array with a prefix of Type . Even if this field has been renamed in the UI, you can still send the prefix of Type and it will match the appropriate field. Below is an example:
- Type: BLK DY
\n

When setting the Product Type in the referenceNumbers, it can be listed alongside other references. In the example below, it is the 3rd reference number in the array:

\"referenceNumbers\": [\n   \"TU-2945\",\n   \"94BC8\",\n   \"Type: BLK DRY\"\n]\n\n

This will find a match to a configured Product Type and associate the appointment to an appropriate calendar. When editing an appointment, you can view the associated Product Type inherited from the API call:

The calendar which the appointment is eligible for will then be determined by the calendar's configuration. For more information on configuring Appointment Manager calendars, please reference the product documentation:

\n","urlObject":{"path":["api","v1","tracking"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"9eb52987-eab3-4714-97f5-2434ae90737f","name":"Create Non-Trackable Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{loadNumber}}\",\n \"nonTrackable\": true,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"94BC8\",\n \"Type: BLK DRY\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickUpEarly}}\",\n \"latestAppointmentTime\": \"{{pickUpLate}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliverEarly}}\",\n \"latestAppointmentTime\": \"{{deliverLate}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:19:53 GMT"},{"key":"ETag","value":"W/\"77b963a36babd0e76db8ccf49d95d605\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"87531694-55a6-463d-967d-0ab6e4117997"},{"key":"X-Runtime","value":"0.012072"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"97"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"loadId\":\"test-company__0E4D56AD\",\"message\":\"Non trackable load submitted\"}"},{"id":"0f90d2ec-13f4-4a32-9266-b8cc8ba469a9","name":"Create Trackable Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"{{scac}}\",\n \"loadNumber\": \"{{loadNumber}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"94BC8\",\n \"Type: BLK DRY\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickUpEarly}}\",\n \"latestAppointmentTime\": \"{{pickUpLate}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliverEarly}}\",\n \"latestAppointmentTime\": \"{{deliverLate}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:20:19 GMT"},{"key":"ETag","value":"W/\"be8540488d87371ac975d677c0dfb1e6\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"c30aa4f3-8391-44cf-909e-2f1f2884aefa"},{"key":"X-Runtime","value":"1.163315"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"message\":\"Load creation request has been submitted successfully\",\"loadId\":172631173}"}],"_postman_id":"7f23cbb8-91f7-44f5-a8a9-7ad3c658e894"},{"name":"Update Load - Full","event":[{"listen":"prerequest","script":{"exec":["// seed the payload with updated variables","","var uuid = require('uuid');","var uniqueNum = uuid.v4().toUpperCase().substring(0,8);","","pm.environment.set('load_number', uniqueNum);","","","function roundTimeQuarterHour() {"," var timeToReturn = new Date();",""," timeToReturn.setMilliseconds(Math.round(timeToReturn.getMilliseconds() / 1000) * 1000);"," timeToReturn.setSeconds(Math.round(timeToReturn.getSeconds() / 60) * 60);"," timeToReturn.setMinutes(Math.round(timeToReturn.getMinutes() / 15) * 15);"," return timeToReturn;","}","","// set the appt dates for pickup","","pm.environment.set('pickup_early', roundTimeQuarterHour().addDays(-3));","pm.environment.set('pickup_late', roundTimeQuarterHour().addDays(-2));","","// set the appt dates for delivery","","pm.environment.set('deliver_early', roundTimeQuarterHour().addDays(1));","pm.environment.set('deliver_late', roundTimeQuarterHour().addDays(2));","","",""],"type":"text/javascript","id":"4464c953-ab25-48c8-80ca-f0b0868427f7"}}],"id":"e2ee98a9-5a3d-4269-88e7-e12a8a5d0f44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"apikey","value":"{{api_key}}","type":"text","description":"

API key generated on the FourKites developer portal

\n"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"cc79\",\n \"loadNumber\": \"{{load_number}}\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\",\n \"K9784\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{pickup_early}}\",\n \"latestAppointmentTime\": \"{{pickup_late}}\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"{{deliver_early}}\",\n \"latestAppointmentTime\": \"{{deliver_late}}\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking/{{tracking_id}}?simpleUpdate=true","description":"

In order to update a load, you can use the PATCH verb and specify the unique FourKites generated tracking_id in the URL path. This will allow the updates to take place on the load.

\n","urlObject":{"path":["api","v1","tracking","{{tracking_id}}"],"host":["{{gateway_url}}"],"query":[{"description":{"content":"

If set to \"true\" then FourKites will assume the full representation of the load is present and will detect updates by reviewing each field

\n","type":"text/plain"},"key":"simpleUpdate","value":"true"}],"variable":[]}},"response":[{"id":"0afc19f6-b576-4533-b237-972a236d213f","name":"Update Load","originalRequest":{"method":"PATCH","header":[{"key":"apikey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"cc79\",\n \"loadNumber\": \"65DB088F\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\",\n \"K9784\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"2022-01-07T18:15:00.000Z\",\n \"latestAppointmentTime\": \"2022-01-08T18:15:00.000Z\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"2022-01-11T18:15:00.000Z\",\n \"latestAppointmentTime\": \"2022-01-12T18:15:00.000Z\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gatewayUrl}}/api/v1/tracking/{{tracking_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:23:09 GMT"},{"key":"ETag","value":"W/\"c7f0e032851f731c17af85bd25fcb779\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"58"},{"key":"X-Request-Id","value":"f6a41aa0-a996-44d7-8a7c-c516c7b7616b"},{"key":"X-Runtime","value":"0.474743"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"message\":\"Load updated successfully\"}"}],"_postman_id":"e2ee98a9-5a3d-4269-88e7-e12a8a5d0f44"},{"name":"Update Load - Partial","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"2751c0ad-7804-4737-98d0-6abacaebced7"}}],"id":"d6021aca-6569-4ed5-af48-3c201f0e3054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"apikey","value":"{{api_key}}","type":"text","description":"

API key generated on the FourKites developer portal

\n"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"cc79\",\n \"loadNumber\": \"{{load_number}}\",\n \"stops\": [\n {\n \"earliestAppointmentTime\": \"2022-02-01T18:15:00.000Z\",\n \"latestAppointmentTime\": \"2022-02-01T18:15:00.000Z\",\n \"name\": \"Port of Longbeach\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking/{{tracking_id}}","description":"

In order to update a load, you can use the PATCH verb and specify the unique FourKites generated tracking_id in the URL path. This will allow the updates to take place on the load.

\n","urlObject":{"path":["api","v1","tracking","{{tracking_id}}"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"bfef59f9-1403-4ee1-b760-4da98063fc83","name":"Update Load","originalRequest":{"method":"PATCH","header":[{"key":"apikey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"load\": {\n \"carrier\": \"cc79\",\n \"loadNumber\": \"65DB088F\",\n \"nonTrackable\": false,\n \"proNumber\": \"4638\",\n \"referenceNumbers\": [\n \"TU-2945\",\n \"80982\",\n \"94BC8\",\n \"K9784\"\n ],\n \"stops\": [\n {\n \"addressLine1\": \"300 S Riverside\",\n \"addressLine2\": null,\n \"city\": \"Chicago\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"2022-01-07T18:15:00.000Z\",\n \"latestAppointmentTime\": \"2022-01-08T18:15:00.000Z\",\n \"name\": \"FourKites HQ\",\n \"postalCode\": \"60661\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"shipTo\": \"1234\",\n \"state\": \"IL\",\n \"sequence\": \"1\",\n \"stopReferenceId\": \"123\",\n \"stopType\": \"pickup\"\n },\n {\n \"addressLine1\": \"425 South Palos Verdes Street\",\n \"addressLine2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"customer\": {\n \"id\": \"789789\",\n \"poNumbers\": [\n \"00210123OF-203503\"\n ]\n },\n \"earliestAppointmentTime\": \"2022-01-11T18:15:00.000Z\",\n \"latestAppointmentTime\": \"2022-01-12T18:15:00.000Z\",\n \"name\": \"Port of Longbeach\",\n \"postalCode\": \"90731\",\n \"referenceNumbers\": [\n \"1234567\",\n \"2412422222\"\n ],\n \"state\": \"CA\",\n \"sequence\": \"2\",\n \"stopReferenceId\": \"9876\",\n \"stopType\": \"delivery\"\n }\n ],\n \"tags\": [\n \"temp\",\n \"field2\",\n \"Inbound\"\n ]\n },\n \"trackingInfo\": {\n \"trailerNumber\": \"643\",\n \"truckNumber\": \"1085\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gatewayUrl}}/api/v1/tracking/{{tracking_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:23:09 GMT"},{"key":"ETag","value":"W/\"c7f0e032851f731c17af85bd25fcb779\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"58"},{"key":"X-Request-Id","value":"f6a41aa0-a996-44d7-8a7c-c516c7b7616b"},{"key":"X-Runtime","value":"0.474743"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"message\":\"Load updated successfully\"}"}],"_postman_id":"d6021aca-6569-4ed5-af48-3c201f0e3054"},{"name":"Delete Load","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"504621c0-c347-420a-8c51-4c9ed6961eff"}}],"id":"9f978d2d-4154-4612-a97f-8cc01ed98652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{api_key}}","type":"text","description":"

API key generated on the FourKites developer portal

\n"}],"body":{"mode":"raw","raw":"{\n \"trackingIds\": [\n {{tracking_id}}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/tracking/delete_loads","description":"

The Delete Loads API accepts an array of FourKites tracking_ids (returned when creating the load). If only one load needs to be deleted, a single value can be passed into the array.

\n","urlObject":{"path":["api","v1","tracking","delete_loads"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"dfb25f4a-4e04-4ac6-8eb4-3a42886d77ce","name":"Delete Load","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trackingIds\": [\n {{tracking_id}}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{gatewayUrl}}/api/v1/tracking/delete_loads"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 10 Jan 2022 18:25:17 GMT"},{"key":"ETag","value":"W/\"62e5b7878baa3b0f68abe17f2854a08d\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-RateLimit-Limit-minute","value":"60"},{"key":"X-RateLimit-Remaining-minute","value":"59"},{"key":"X-Request-Id","value":"81f7b3a6-13ff-4fc6-83ca-3f413599b799"},{"key":"X-Runtime","value":"0.170580"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"message\":\"Tracking records submitted for deletion\",\"deletedTrackingIds\":[172631173]}"}],"_postman_id":"9f978d2d-4154-4612-a97f-8cc01ed98652"}],"id":"e77f50ea-445c-4f69-873c-6b82b566dedb","description":"

\n
Note*: This API should only be used if the Core Track or Appointment Manager product have been purchased.
\n

Core Track Usage

The Create Load API supplies a single API to seed data into all 3 FourKites products. Below are the 3 objects which can be created via a single message:

Core Track: Create a load for real-time tracking
Appointment Manager: Create an appointment for a shipment which can be scheduled/rescheduled by carriers
Dynamic Yard: add pending arrival or departures at a live Dynamic Yard site

If the FourKites Core Tracking platform is used, then loads created in Core Track will automatically integrate into Dynamic Yard, creating pending deliveries. This allows for the usage of a single TMS integration with FourKites at the Core Track level. From there, references, trailer numbers, appointments and other information already sent to Core Track will automatically populate in Dynamic Yard.

The following API specification is only if Core Track or Appointment Manager is not used. If the Core Track platform is used, then no separate load or delivery integration needs to be built.

For additional documentation on Core Track APIs and callbacks, please review the FourKites APIs documentation.

Authentication

The Create / Update Load API uses API key to authenticate requests. This key can be generated from the FourKites Developer Portal. Each request requires an API key in order to authenticate:

curl --location -g --request POST 'https://api-staging.fourkites.com/api/v1/tracking' \\\n--header 'apikey: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{}'\n\n

Rate Limiting

Fourkites APIs have rate limits that cap the number of requests that can be successfully made. If you exceed the specified rate limit, your request will be throttled, and you will receive HTTP 429 Too Many Requests response from the API. The rate limits will be applied per apikey and the default rate limit is 60 requests per minute. Please contact your Customer Success Manager to request an increase in the rate limit.

Below are the response headers related to the rate limit, that can be used for retries. For example, in cases where there are intermittent spikes in request rate, an exponential retry can be implemented.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Format	Description
X-RateLimit-Limit-minute	Integer	Total number of requests permitted for the apikey per minute
X-RateLimit-Remaining-minute	Integer	Number of API request that will be accepted in the current minute

Status Codes

FourKites uses conventional HTTP response codes to indicate the success or failure of an API request.

Codes in the 2xx range indicate success
Codes in the 4xx range indicate an error due to the information provided (e.g., a required parameter was omitted, an invalid value given, etc.)
Codes in the 5xx range indicate an error with FourKites' servers (these are rare)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Status	Description
200	OK	Response to a successful REST API action. The HTTP method can be GET, POST, PUT, PATCH or DELETE
400	Bad Request	Indicates that the server could not understand the request due to invalid syntax, format or input
401	Unauthorized	Invalid API Key
403	Forbidden	When the authentication succeeded but authenticated user doesn't have permission to the request resource
404	Not Found	You either do not have permission or an entity does not exist
429	Too Many Requests	Too Many Requests – Your request rate is too high. Try again later
500	Internal Server Error	There was an issue processing the request. Please try again later or log a support ticket with FourKites
502	Bad Gateway	Indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server. Please try again later
504	Gateway Timeout	Indicates that the server, while acting as a gateway or proxy, cannot get a response in time. Please try again later

Error Handling

Each request has specific errors that are detailed throughout the documentation. This document contains a general description of errors that could occur across all request types and a description of the common error response format. There are two errors formats which denote generic/default and custom errors which can be resource or action specific.

Default Errors

Default errors contain a message in the body which provides information about the nature of the error:

{\n  \"message\": \"No API key found in request\"\n}\n\n

Custom Errors

Custom errors provide an object with different keys containing information about the error. Custom error codes and the details in the errorDetails field are not directly related to a HTTP Status Code as it can mean request or resource specific errors as described below

{\n  \"errorCode\": 2002,\n  \"errorDetails\": [\"Invalid value for param: shipment.type\"],\n  \"errorMessage\": \"Validation Exception\",\n  \"occurredAt\": \"2020-07-28T06:46:30Z\",\n  \"requestId\": \"brlfhvhghpuac6sl1jrg\"\n}\n\n

The following table outlines different custom errors:

Full and Partial Updates

There are 2 types of updates which can be performed on FourKites loads:

Full Update: the entire payload representation is sent again with the latest information on the load. FourKites will detect any field(s) which have changed and run it as an update. If certain field(s) have not changed then they will not be altered
Partial Update: only the field(s) which have changed are sent in the message. This allows a more targeted approach to updates but requires the source system to know which fields have been changed.

The full update is invoked using a query parameter simpleUpdate=true. Leaving this parameter off of the request will default to a partial update.

Field Definitions

The following field definitions outline the most common and useful fields for creating loads for use in Appointment Manager and Dynamic Yard. For additional field-level specifications which may be outside this list please visit the \"Create Load\" section of the FourKites Developer Portal.

Load / Shipment Details

loadNumber
- Type: String
- Required: M
- Description: Unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS
\n
carrier
- Type: String
- Required: O
- Description: SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites for the customer
\n
nonTrackable
- Type: Boolean
- Required: O
- Description: indicator specifying if the load should be created in the Core Track platform. If \"true\" the load will bypass Core Track (as it is considered \"non-trackable\") but the data will continue to pass down to Appointment Manager and Dynamic Yard for use as appointments and deliveries
\n
referenceNumbers
- Type: String
- Required: M
- Description: List of unique identifiers for the load. These can be used to search for the load the platform
\n
tags
- Type: String
- Required: M
- Description: List of labels or categories associated with the load. Tags can be used to filter groups of loads
\n
proNumber
- Type: String
- Required: O
- Description: Number created usually after pickup or at pickup for LTL loads
\n
trackingNumber
- Type: String
- Required: O
- Description: Tracking number provided by the carrier. Used only for parcel loads
\n
priority
- Type: String
- Required: O
- Description: Indicates whether the load is normal or priority. Valid values:
  - normal
  - high
  - hot
  \n
\n

Stop Details

addressLine1
- Type: String
- Required: M
- Description: First line of the stop’s street address
\n
addressLine2
- Type: String
- Required: O
- Description: Second line of the stop’s street address
\n
city
- Type: String
- Required: M
- Description: Stop's city
\n
state
- Type: String
- Required: M
- Description: State / region of the stop. Must be a valid ISO code for the state / region. In the US, these are the 2-character state codes
\n
postalCode
- Type: String
- Required: M
- Description: Valid postal code of the stop
\n
country
- Type: String
- Required: M
- Description: Valid country code of the stop
\n
externalAddressId
- Type: String
- Required: O
- Description: Alphanumeric code which is globally unique to a specific location. For many companies, it is the same number used for ship-to / ship-from. *If used, FourKites will ignore the address data provided in a load create file and use only location ID to route to the address as maintained in Address Manager. This allows you to pass just this code without street address information
\n
timeInUtc
- Type: Boolean
- Required: O
- Description: Indicates whether the appointment times sent in the message are in UTC. By default, FourKites assumes the times are in the local time of the stop
\n
appointmentTime
- Type: String
- Required: O
- Description: Scheduled appointment time of the stop in ISO-8601 format
\n
earliestAppointmentTime
- Type: String
- Required: O
- Description: In the case of a window of earliest/latest times, this is the early window of the appointment time in ISO-8601 format. If this time matches that in the “latest” field it will combine to a single time in the platform
\n
latestAppointmentTime
- Type: String
- Required: O
- Description: In the case of a window of earliest/latest times, this is the late window of the appointment time in ISO-8601 format. If this time matches that in the “earliest” field it will combine to a single time in the platform
\n
referenceNumbers
- Type: Array
- Required: O
- Description: List of unique references associated with the stop
\n
sequence
- Type: String
- Required: O
- Description: The stop’s sequence in the order of pickup / delivery. It is recommended to start with 1 (for the first pickup) and increment by 1 for each subsequent stop
\n
stopReferenceId
- Type: String
- Required: O
- Description: Alphanumeric code generated in the load creator’s system which is unique to a specific stop in a specific load. It is used to know which stop and update is applied to in FourKites
\n
customer.id
- Type: String
- Required: O
- Description: Unique identifier for a customer loaded in the shipper’s master data in FourKites. Please refer to supporting documentation on using customers in FourKites
\n
customer.poNumbers
- Type: Array
- Required: O
- Description: List of PO Numbers associated with the stop
\n
loadingType
- Type: String
- Required: O
- Description: Designates whether the shipment should be handled Live or as a Drop-and-Hook. Valid values include: live | drop
  - This field determines the Appointment Type in Appointment Manager
  \n
\n

Pallet Details

FourKites supports storing limited information about the pallets or freight associated with a shipment. The pallet information can be included as part of the stop object (so it can be unique for pickup and/or delivery). The structure is as follows.

Inside the parts array is an object representing each individual pallet. The field definitions below correspond to each individual pallet. Within the pallet object, each field is considered optional. This means that you can only include quantity and weight , or any other combination of fields within the object.

\n
Pallets are optional and do not influence tracking, appointment scheduling, or Dynamic Yard features. The information contained here is for viewing / informational purposes inside the Core Track and Appointment Manager products only
\n

\"pallets\": [\n    {\n        \"parts\": [\n            { ...1st pallet... },\n            { ...2nd pallet... }\n        ]\n    }\n]\n\n

customerPartNumber
- Type: String
- Required: O
- Description: Unique number representing a number associated with the customer's part(s). This is a free-text field, so this can represent any value, not necessarily one which maps to a \"part\". This value is only visible in the Core Track platform, it is not visible in Appointment Manager or Dynamic Yard
\n
shipperPartNumber
- Type: String
- Required: O
- Description: Unique number representing a number associated with the shipper's part(s). This is a free-text field, so this can represent any value, not necessarily one which maps to a \"part\". This value is only visible in the Core Track platform, it is not visible in Appointment Manager or Dynamic Yard
\n
quantity
- Type: String
- Required: O
- Description: Quantity of pieces on the pallet. In Appointment Manager, all values in this field will summed and shown in the \"Total Pallets Count\" field. This value is only visible in the Core Track and Appointment Manager platforms, it is not visible in Dynamic Yard
\n
weight
- Type: String
- Required: O
- Description: Total weight of items on the pallet. In Appointment Manager, all values in this field will summed and shown in the \"Total Weight\" field. This value is only visible in the Core Track and Appointment Manager platforms, it is not visible in Dynamic Yard
\n

Asset Information

truckNumber
- Type: String
- Required: O
- Description: Tractor or asset number assigned to the load. Typically, this is received from the carrier via FourKites’s carrier integrations
\n
trailerNumber
- Type: String
- Required: O
- Description: Alphanumeric code generated in the load creator’s system which is unique to a specific stop in a specific load. It is used to know which stop and update is applied to in FourKites
\n
containerNumber
- Type: String
- Required: O
- Description: Alphanumeric code generated in the load creator’s system which is unique to a specific stop in a specific load. It is used to know which stop and update is applied to in FourKites
\n

\n","_postman_id":"e77f50ea-445c-4f69-873c-6b82b566dedb"},{"name":"Webhooks","item":[{"name":"Dynamic Yard","item":[{"name":"Gate Check-In","id":"2c676f3a-e6d0-4fce-bc6d-10b583b6172d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"additional_attributes\": [\n {\n \"form\": \"trailer\",\n \"label\": \"Building Number\",\n \"name\": \"building_number\",\n \"type\": \"Option\",\n \"value\": \"B8475\"\n }\n ],\n \"appointment_type\": \"Live\",\n \"audit_trailer\": true,\n \"audit_trailer_notes\": null,\n \"carrier_name\": \"McClure / Prinzi\",\n \"comments\": null,\n \"delivery_ids\": [\n \"8BD5427B_D2F1\"\n ],\n \"delivery_info\": [\n {\n \"customer\": null,\n \"delivery_id\": \"30808495_BCCC\"\n }\n ],\n \"delivery_reference_numbers\": [\n \"4858\",\n \"H9948\"\n ],\n \"direction\": \"Inbound\",\n \"equipment_type\": \"Container\",\n \"gate_pass_number\": 9839,\n \"is_brokered\": true,\n \"load_numbers\": [\n \"8BD5427B_D2F1\"\n ],\n \"load_status\": \"Full\",\n \"load_type\": null,\n \"location_name\": \"046\",\n \"location_parent_name\": \"Storage Yard\",\n \"location_type\": \"Spot\",\n \"message_type\": \"GATE_TRANSACTION\",\n \"out_of_service\": null,\n \"out_of_service_notes\": null,\n \"process_status\": \"Unload\",\n \"scac\": \"0010\",\n \"seal_number\": \"79874687\",\n \"seal_status\": \"Intact\",\n \"site_code\": \"SS03\",\n \"tractor_carrier_name\": \"McClure / Prinzi\",\n \"tractor_name\": \"75768\",\n \"tractor_scac\": \"0010\",\n \"trailer_arrival_time\": \"2022-08-31T21:44:09.930416\",\n \"trailer_condition\": \"Dirty\",\n \"trailer_damage\": true,\n \"trailer_damage_notes\": null,\n \"trailer_departure_time\": null,\n \"trailer_id\": 2803,\n \"trailer_tag\": \"847584747\",\n \"trailer_number\": \"H84758\",\n \"trailer_usage\": \"Over the Road\",\n \"transaction_type\": \"ARRIVAL\",\n \"turnaway_reason\": null\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when a trailer is checked into a site. This is associated with the Check_In trigger.

Field Definitions

All fields on the webhooks will be present on every message, the schema is static. However, the Required field on each will notate whether or not a field can be nullable. For array values, an empty array would return if optional and an empty list.

Optional String field example when empty: \"turnaway_reason\": null
Optional Array field example when empty: \"load_numbers\": []

Custom Trailer Attributes

The additional_attributes array contains a list of custom attributes created on the trailer check-in form and are configured in the Nomenclature setup. If your organization does not have a need for custom fields to be entered by users in Dynamic Yard, this array will be empty. Otherwise, the fields and their values will be listed.

Trailer / Equipment Detail

additional_attributes
- Type: Array
- Required: O
- Description: Array of additional/custom attributes created on the trailer. If no custom attributes are defined in the company setup, this will be an empty array. See the Custom Attributes section in the description for more information
\n
appointment_type
- Type: String
- Required: M
- Description: Type of check-in and is selected by the gate. Please view the check-in modal window for additional details for different types of check-in options. Valid values: Live | Drop_and_Hook | Inbound_Only | Outbound_Only | Check_in_Only
\n
audit_trailer
- Type: Boolean
- Required: O
- Description: Indicates whether the trailer needs to be audited. If not used, the field will pass as null
\n
audit_trailer_notes
- Type: String
- Required: O
- Description: Notes left about the trailer's audit status. If no notes are left, the field will pass as null
\n
equipment_type
- Type: String
- Required: M
- Description: The type of trailer (e.g. 53' Dry Van, Container, etc.). Values are configurable in the UI as customer master data
\n
location_name
- Type: String
- Required: O
- Description: Name of last location of the trailer prior to check-out. Will be either a parking spot name or dock door name. If the trailer has an \"Unassigned\" location then this will be null
\n
location_parent_name
- Type: String
- Required: O
- Description: Name of the last dock or parking lot where the trailer is was located prior to check-out. If the trailer is in a parking spot, this will be the parking lot name associated with that spot. If the trailer is in a dock door, this will be the dock name associated with that door. If the trailer has an \"Unassigned\" location then this will be null
\n
location_type
- Type: String
- Required: O
- Description: Type of the last location of the trailer prior to check-out. Will be either \"Spot\" or \"Door\". If the trailer has an \"Unassigned\" location then this will be null
\n
message_type
- Type: String
- Required: M
- Description: Type of webhook. Will always be GATE_TRANSACTION
\n
out_of_service
- Type: Boolean
- Required: M
- Description: true/false indicator as to whether the trailer is eligible for use
\n
out_of_service_notes
- Type: String
- Required: M
- Description: Notes left about the trailer's service status. If no notes left, field will pass as null
\n
seal_number
- Type: String
- Required: O
- Description: Seal number associated with the trailer
\n
seal_status
- Type: String
- Required: O
- Description: Seal status of the trailer (e.g. \"Intact\" or \"Broken\")
\n
site_code
- Type: String
- Required: M
- Description: Unique identifier for the site
\n
tractor_name
- Type: String
- Required: O
- Description: Truck/tractor number entered on the UI by the gate
\n
trailer_arrival_time
- Type: ISO8601 Date/Time
- Required: M
- Description: Arrival time of the trailer at the facility
\n
trailer_condition
- Type: String
- Required: O
- Description: Condition of the trailer (e.g. \"Clean\", \"Dirty\"). Values are configurable as master data
\n
trailer_damage
- Type: Boolean
- Required: O
- Description: Boolean flag indicating whether or not the trailer is damaged. If not checked, field will pass as null
\n
trailer_damage_notes
- Type: String
- Required: O
- Description: Notes left about the damage status of a trailer. If no notes are used, field will pass as null
\n
trailer_departure_time
- Type: ISO8601 Date/Time
- Required: O
- Description: Departure time of the trailer from the facility. Will always be null for check-in events
\n
trailer_id
- Type: String
- Required: M
- Description: Unique trailer ID generated by Dynamic Yard. It is recommended to store this ID as it is used for other Dynamic Yard APIs
\n
trailer_tag
- Type: String
- Required: O
- Description: RFID tag associated with the trailer, or placed on the trailer by the gate. If RFID tags are not used, this field will be null
\n
trailer_number
- Type: String
- Required: M
- Description: Trailer number entered by the gate upon check-in
\n
trailer_usage
- Type: String
- Required: O
- Description: This is a custom label that can be used to identify how the trailer is being used (dedicated fleet, storage, OTR, etc). This status is tied to the usage of the trailer, not the descriptor of the trailer
\n
transaction_type
- Type: String
- Required: M
- Description: Will be either ARRIVAL or TURN_AWAY depending upon whether the trailer was checked into the facility or turned away
\n
turnaway_reason
- Type: String
- Required: O
- Description: If the trailer is turned away, this will contain the specific reason
\n

Delivery / Shipment Detail

delivery_ids
- Type: Array
- Required: O
- Description: List of delivery IDs (shipments) associated with the trailer. These are listed on the delivery object. Will only be populated if the trailer is full
\n
delivery_info
- Type: Array of Objects
- Required: O
- Description: A list of objects showing the customer associated with each delivery. The object will contain two fields: customer and delivery_id to demonstrate the link between the two:
\n

\"delivery_info\": [\n        {\n            \"customer\": \"ABC Store\",\n            \"delivery_id\": \"30808495_BCCC\"\n        }\n    ]\n\n

delivery_reference_numbers
- Type: Array
- Required: O
- Description: List of load and stop reference numbers associated with the delivery. These are secondary references used to identify the delivery and are alphanumeric fields. Note: if Core Track is used as the source of delivery data, these will correspond to the load and stop reference numbers associated with the load / stop
\n
direction
- Type: String
- Required: M
- Description: Direction of the trailer, can be \"Inbound\" or \"Outbound\"
\n
load_numbers
- Type: String
- Required: O
- Description: List of load numbers associated with the trailer. These correspond to the \"Bill of Lading\" value on the delivery object. Will only be populated if the trailer is full
\n
load_status
- Type: String
- Required: O
- Description: Load status associated with the trailer. This is often updated when the warehouse is finished loading/unloading the trailer. *See WMS API section for more information on load_status
\n
load_type
- Type: String
- Required: O
- Description: Additional descriptor that can be configured per load status. Used to help differentiate loads and allow for a general categorization of the freight on a trailer
\n
process_status
- Type: String
- Required: O
- Description: Process status of the trailer. See WMS API section for more information on process_status
\n

Carrier / Transaction Detail

carrier_name
- Type: String
- Required: M
- Description: Name of the carrier which owns the trailer
\n
comments
- Type: String
- Required: O
- Description: Comments left by the gate during check-in. If no comments are entered, field will pass as null
\n
gate_pass_number
- Type: Int(32)
- Required: M
- Description: Gate pass ID which is automatically generated when a trailer is checked into the yard
\n
is_brokered
- Type: Boolean
- Required: O
- Description: Indicates whether or not the load has been brokered. Default value is false
\n
scac
- Type: String
- Required: M
- Description: SCAC or carrier code of the company which owns the trailer
\n
tractor_carrier_name
- Type: String
- Required: O
- Description: Name of the carrier which owns the truck/tractor
\n
tractor_scac
- Type: String
- Required: O
- Description: SCAC or carrier code of the company which owns the truck/tractor
\n

Additional Attributes Detail

The following fields will only be present if custom attributes are configured on the trailer check-in form. Specifically, the array lists an object with the following fields. If custom attributes are not used by your company, then the additional_attributes array will be empty.

form
- Type: String
- Required: O
- Description: The data object which the attribute is created for. On the Gate Check-In webhook, this will be trailer
\n
label
- Type: String
- Required: O
- Description: Label users see for the field in the UI
\n
name
- Type: String
- Required: O
- Description: Field name stored on the Dynamic Yard back-end. Can be used to match to the field when processing the Gate Check-In webhook programmatically to avoid parsing spaces and special characters that might be used in the UI label (listed above)
\n
type
- Type: String
- Required: O
- Description: Data type of the custom attribute. Available types include: Text | Option | Toggle (yes/no)
\n
value
- Type: String/Boolean*
- Required: O
- Description: The actual value entered in the field. *For text type values, the field will be returned as a string. For boolean type values, it will be a boolean data type
\n

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c676f3a-e6d0-4fce-bc6d-10b583b6172d"},{"name":"Gate Check-Out","id":"2d4de0fd-5bee-452f-a2e1-eac5f44a11e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"additional_attributes\": [\n {\n \"form\": \"trailer\",\n \"label\": \"Building Number\",\n \"name\": \"building_number\",\n \"type\": \"Option\",\n \"value\": \"B8475\"\n }\n ],\n \"appointment_type\": \"Drop_and_Hook\",\n \"audit_trailer\": null,\n \"audit_trailer_notes\": null,\n \"carrier_name\": \"McClure / Prinzi\",\n \"comments\": null,\n \"delivery_ids\": [\n \"8BD5427B_D2F1\"\n ],\n \"delivery_info\": [\n {\n \"customer\": \"ABC Store\",\n \"delivery_id\": \"30808495_BCCC\"\n }\n ],\n \"delivery_reference_numbers\": [\n \"4858\",\n \"H9948\"\n ],\n \"direction\": \"Outbound\",\n \"equipment_type\": \"Container\",\n \"gate_pass_number\": 9840,\n \"is_brokered\": false,\n \"load_numbers\": [\n \"8BD5427B_D2F1\"\n ],\n \"load_status\": \"Full\",\n \"load_type\": \"Outbound Production\",\n \"location_name\": \"046\",\n \"location_parent_name\": \"Storage Yard\",\n \"location_type\": \"Spot\",\n \"message_type\": \"GATE_TRANSACTION\",\n \"out_of_service\": null,\n \"out_of_service_notes\": null,\n \"process_status\": \"Off_Site\",\n \"scac\": \"0010\",\n \"seal_number\": \"877849867\",\n \"seal_status\": \"Intact\",\n \"site_code\": \"SS03\",\n \"tractor_carrier_name\": \"McClure / Prinzi\",\n \"tractor_name\": \"847584\",\n \"tractor_scac\": \"0010\",\n \"trailer_arrival_time\": null,\n \"trailer_condition\": \"Clean\",\n \"trailer_damage\": null,\n \"trailer_damage_notes\": null,\n \"trailer_departure_time\": \"2022-02-01T01:30:50.512408\",\n \"trailer_id\": 2079,\n \"trailer_tag\": \"847588584\",\n \"trailer_number\": \"AA33469\",\n \"trailer_usage\": \"Over the Road\",\n \"transaction_type\": \"DEPARTURE\",\n \"turnaway_reason\": null\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when a trailer is checked out of a site. This is associated with the Check_Out trigger.

Field Definitions

Optional String field example when empty: \"turnaway_reason\": null
Optional Array field example when empty: \"load_numbers\": []

Custom Trailer Attributes

The additional_attributes array contains a list of custom attributes created on the trailer form and are configured in the Nomenclature setup. If your organization does not have a need for custom fields to be entered by users in Dynamic Yard, this array will be empty. Otherwise, the fields and their values will be listed.

Trailer / Equipment Detail

additional_attributes
- Type: Array
- Required: O
- Description: Array of additional/custom attributes created on the trailer. If no custom attributes are defined in the company setup, this will be an empty array. See the Custom Attributes section in the description for more information
\n
appointment_type
- Type: String
- Required: M
- Description: Type of check-in and is selected by the gate. Please view the check-in modal window for additional details for different types of check-in options. Valid values: Live | Drop_and_Hook | Inbound_Only | Outbound_Only | Check_in_Only
\n
audit_trailer
- Type: Boolean
- Required: O
- Description: Indicates whether the trailer needs to be audited. If not used, the field will pass as null
\n
audit_trailer_notes
- Type: String
- Required: O
- Description: Notes left about the trailer's audit status. If no notes are left, the field will pass as null
\n
equipment_type
- Type: String
- Required: M
- Description: The type of trailer (e.g. 53' Dry Van, Container, etc.). Values are configurable in the UI as customer master data
\n
location_name
- Type: String
- Required: O
- Description: Name of current location of the trailer. Will be either a parking spot name or dock door name. If the trailer has an \"Unassigned\" location then this will be null
\n
location_parent_name
- Type: String
- Required: O
- Description: Name of the dock or parking lot where the trailer is currently located. If the trailer is in a parking spot, this will be the parking lot name associated with that spot. If the trailer is in a dock door, this will be the dock name associated with that door. If the trailer has an \"Unassigned\" location then this will be null
\n
location_type
- Type: String
- Required: O
- Description: Type of the current location of the trailer. Will be either \"Spot\" or \"Door\". If the trailer has an \"Unassigned\" location then this will be null
\n
message_type
- Type: String
- Required: M
- Description: Type of webhook. Will always be GATE_TRANSACTION
\n
out_of_service
- Type: Boolean
- Required: M
- Description: true/false indicator as to whether the trailer is eligible for use
\n
out_of_service_notes
- Type: String
- Required: M
- Description: Notes left about the trailer's service status. If no notes left, field will pass as null
\n
seal_number
- Type: String
- Required: O
- Description: Seal number associated with the trailer
\n
seal_status
- Type: String
- Required: O
- Description: Seal status of the trailer (e.g. \"Intact\" or \"Broken\")
\n
site_code
- Type: String
- Required: M
- Description: Unique identifier for the site
\n
tractor_name
- Type: String
- Required: O
- Description: Truck/tractor number entered on the UI by the gate
\n
trailer_arrival_time
- Type: ISO8601 Date/Time
- Required: M
- Description: Arrival time of the trailer at the facility
\n
trailer_condition
- Type: ISO8601 Date/Time
- Required: O
- Description: Condition of the trailer (e.g. \"Clean\", \"Dirty\"). Values are configurable as master data
\n
trailer_damage
- Type: Boolean
- Required: O
- Description: Boolean flag indicating whether or not the trailer is damaged. If not checked, field will pass as \"null\"
\n
trailer_damage_notes
- Type: String
- Required: O
- Description: Notes left about the damage status of a trailer. If no notes are used, field will pass as null
\n
trailer_departure_time
- Type: ISO8601 Date/Time
- Required: M
- Description: Departure time of the trailer from the facility
\n
trailer_id
- Type: String
- Required: M
- Description: Unique trailer ID generated by Dynamic Yard. It is recommended to store this ID as it is used for other Dynamic Yard APIs
\n
trailer_number
- Type: String
- Required: M
- Description: Trailer number entered by the gate upon check-in
\n
trailer_tag
- Type: String
- Required: O
- Description: RFID tag associated with the trailer, or placed on the trailer by the gate. If RFID tags are not used, this field will be null
\n
trailer_usage
- Type: String
- Required: O
- Description: This is a custom label that can be used to identify how the trailer was used on site (dedicated fleet, storage, OTR, etc). This status is tied to the usage of the trailer, not the descriptor of the trailer
\n
transaction_type
- Type: String
- Required: M
- Description: Will be DEPARTURE for check-out events
\n
turnaway_reason
- Type: String
- Required: O
- Description: Will be null for trailers checking out of the yard
\n

Delivery / Shipment Detail

delivery_ids
- Type: Array
- Required: O
- Description: List of delivery IDs (shipments) associated with the trailer. These are listed on the delivery object. Will only be populated if the trailer is full
\n
delivery_info
- Type: Array of Objects
- Required: O
- Description: A list of objects showing the customer associated with each delivery. The object will contain two fields: customer and delivery_id to demonstrate the link between the two:
\n

\"delivery_info\": [\n        {\n            \"customer\": \"ABC Store\",\n            \"delivery_id\": \"30808495_BCCC\"\n        }\n    ]\n\n

delivery_reference_numbers
- Type: Array
- Required: O
- Description: List of load and stop reference numbers associated with the delivery. These are secondary references used to identify the delivery and are alphanumeric fields. Note: if Core Track is used as the source of delivery data, these will correspond to the load and stop reference numbers associated with the load / stop
\n
direction
- Type: String
- Required: M
- Description: Direction of the trailer, can be \"Inbound\" or \"Outbound\"
\n
load_numbers
- Type: String
- Required: O
- Description: List of load numbers associated with the trailer. These correspond to the \"Bill of Lading\" value on the delivery object. Will only be populated if the trailer is full
\n
load_status
- Type: String
- Required: O
- Description: Load status associated with the trailer. This is often updated when the warehouse is finished loading/unloading the trailer. *See WMS API section for more information on load_status
\n
load_type
- Type: String
- Required: O
- Description: Additional descriptor that can be configured per load status. Used to help differentiate loads and allow for a general categorization of the freight on a trailer
\n
process_status
- Type: String
- Required: O
- Description: Process status of the trailer. See WMS API section for more information on process_status
\n

Carrier / Transaction Detail

carrier_name
- Type: String
- Required: M
- Description: Name of the carrier which owns the trailer
\n
comments
- Type: String
- Required: O
- Description: Comments left by the gate during check-in. If no comments are entered, field will pass as null
\n
gate_pass_number
- Type: Int(32)
- Required: M
- Description: Gate pass ID which is automatically generated when a trailer is checked into the yard
\n
is_brokered
- Type: Boolean
- Required: O
- Description: Indicates whether or not the load has been brokered. Default value is false
\n
scac
- Type: String
- Required: M
- Description: SCAC or carrier code of the company which owns the trailer
\n
tractor_carrier_name
- Type: String
- Required: O
- Description: Name of the carrier which owns the truck/tractor
\n
tractor_scac
- Type: String
- Required: O
- Description: SCAC or carrier code of the company which owns the truck/tractor
\n

Additional Attributes Detail

form
- Type: String
- Required: O
- Description: The data object which the attribute is created for. On the Gate Check-In webhook, this will be trailer
\n
label
- Type: String
- Required: O
- Description: Label users see for the field in the UI
\n
name
- Type: String
- Required: O
- Description: Field name stored on the Dynamic Yard back-end. Can be used to match to the field when processing the Gate Check-In webhook programmatically to avoid parsing spaces and special characters that might be used in the UI label (listed above)
\n
type
- Type: String
- Required: O
- Description: Data type of the custom attribute. Available types include: Text | Option | Toggle (yes/no)
\n
value
- Type: String/Boolean*
- Required: O
- Description: The actual value entered in the field. *For text type values, the field will be returned as a string. For boolean type values, it will be a boolean data type
\n

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d4de0fd-5bee-452f-a2e1-eac5f44a11e1"},{"name":"Equipment Update","id":"c0bd9ca2-6a6c-4a1f-936c-dd1c1b76faec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"additional_attributes\": [\n {\n \"form\": \"trailer\",\n \"label\": \"Building Number\",\n \"name\": \"building_number\",\n \"type\": \"Option\",\n \"value\": \"B8475\"\n }\n ],\n \"audit_trailer\": true,\n \"audit_trailer_notes\": \"\",\n \"carrier_name\": \"McClure / Prinzi\",\n \"comments\": \"\",\n \"delivery_directions\": [\n \"Inbound\"\n ],\n \"delivery_ids\": [\n \"8BD5427B_D2F1\"\n ],\n \"equipment_type\": \"Container\",\n \"gate_pass_number\": 9839,\n \"load_numbers\": [\n \"8BD5427B_D2F1\"\n ],\n \"load_status\": \"Full\",\n \"location_name\": \"030\",\n \"location_parent_name\": \"Lot A\",\n \"location_type\": \"Spot\",\n \"message_type\": \"EQUIPMENT_CALLBACK\",\n \"out_of_service\": false,\n \"out_of_service_notes\": \"\",\n \"process_status\": \"Unload\",\n \"scac\": \"0010\",\n \"seal_number\": \"79874687\",\n \"seal_status\": \"Intact\",\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-02-01T01:01:02.023878\",\n \"trailer_condition\": \"Dirty\",\n \"trailer_damage\": true,\n \"trailer_damage_notes\": \"\",\n \"trailer_id\": 2803,\n \"trailer_number\": \"H84758\",\n \"updated_by\": \"test.user@fourkites.com\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when a trailer is updated while on site. This is associated with the Equipment_Update trigger. A list of actions which trigger an equipment update webhook are below:

Location change (either yard spot change or door change)
Move request status change
Trailer name updated
Trailer load status change
Trailer process status change
Trailer type change
Trailer carrier change
Trailer condition change

Field Definitions

Optional String field example when empty: \"updated_by\": null
Optional Array field example when empty: \"load_numbers\": []

Custom Trailer Attributes

Trailer / Equipment Detail

additional_attributes
- Type: Array
- Required: O
- Description: Array of additional/custom attributes created on the trailer. If no custom attributes are defined in the company setup, this will be an empty array. *See the Custom Attributes section in the description for more information
\n
audit_trailer
- Type: Boolean
- Required: O
- Description: Indicates whether the trailer needs to be audited. If not used, the field will pass as null
\n
audit_trailer_notes
- Type: String
- Required: O
- Description: Notes left about the trailer's audit status. If no notes are left, the field will pass as null
\n
comments
- Type: String
- Required: O
- Description: Comments left on the trailer. If no comments are left, the field will pass as null
\n
equipment_type
- Type: String
- Required: M
- Description: The type of trailer (e.g. 53' Dry Van, Container, etc.). Values are configurable in the UI as customer master data
\n
location_name
- Type: String
- Required: O
- Description: Name of current location of the trailer. Will be either a parking spot name or dock door name
\n
location_parent_name
- Type: String
- Required: O
- Description: Name of the dock or parking lot where the trailer is currently located. If the trailer is in a parking spot, this will be the parking lot name associated with that spot. If the trailer is in a dock door, this will be the dock name associated with that door. If the trailer has an \"Unassigned\" location then this will be null
\n
location_type
- Type: String
- Required: M
- Description: Type of the current location of the trailer. Will be either \"Spot\" or \"Door\"
\n
message_type
- Type: String
- Required: M
- Description: Type of webhook. Will always be EQUIPMENT_CALLBACK
\n
out_of_service
- Type: Boolean
- Required: M
- Description: true/false indicator as to whether the trailer is eligible for use
\n
out_of_service_notes
- Type: String
- Required: O
- Description: Notes left about the trailer's service status. If no notes left, field will pass as null
\n
seal_number
- Type: String
- Required: O
- Description: Seal number associated with the trailer
\n
seal_status
- Type: String
- Required: O
- Description: Seal status of the trailer (e.g. \"Intact\" or \"Broken\")
\n
site_code
- Type: String
- Required: M
- Description: Unique identifier for the site
\n
trailer_condition
- Type: String
- Required: O
- Description: Condition of the trailer (e.g. \"Clean\", \"Dirty\"). Values are configurable as master data
\n
trailer_damage
- Type: Boolean
- Required: O
- Description: Boolean flag indicating whether or not the trailer is damaged. If not checked, field will pass as null
\n
trailer_damage_notes
- Type: String
- Required: O
- Description: Notes left about the damage status of a trailer. If no notes are used, field will pass as null
\n
trailer_id
- Type: String
- Required: M
- Description: Unique trailer ID generated by Dynamic Yard. It is recommended to store this ID as it is used for other Dynamic Yard APIs
\n
trailer_number
- Type: String
- Required: M
- Description: Trailer number entered by the gate upon check-in
\n
timestamp
- Type: ISO8601 Date/Time
- Required: M
- Description: Timestamp of when the trailer was updated/edited. Will be in UTC
\n
updated_by
- Type: String
- Required: M
- Description: Username of the user who edited the trailer in Dynamic Yard. Will be null for updates done via the Trailer Update API
\n

Delivery / Shipment Detail

delivery_ids
- Type: Array
- Required: O
- Description: List of delivery IDs (shipments) associated with the trailer. These are listed on the delivery object. Will only be populated if the trailer is full
\n
delivery_directions
- Type: Array
- Required: M
- Description: Shows whether the trailer is inbound to, or outbound from the facility. Valid values: Inbound | Outbound
\n
load_numbers
- Type: String
- Required: O
- Description: List of load numbers associated with the trailer. These correspond to the \"Bill of Lading\" value on the delivery object. Will only be populated if the trailer is full
\n
load_status
- Type: String
- Required: M
- Description: Load status associated with the trailer. This is often updated when the warehouse is finished loading/unloading the trailer.
\n
process_status
- Type: String
- Required: O
- Description: Process status of the trailer. See WMS API section for more information on process_status
\n

Carrier / Transaction Detail

carrier_name
- Type: String
- Required: M
- Description: Name of the carrier which owns the trailer
\n
gate_pass_number
- Type: Int(32)
- Required: M
- Description: Gate pass ID which is automatically generated when a trailer is checked into the yard
\n
scac
- Type: String
- Required: M
- Description: SCAC or carrier code of the company which owns the trailer
\n

Additional Attributes Detail

form
- Type: String
- Required: O
- Description: The data object which the attribute is created for. On the Gate Check-In webhook, this will be trailer
\n
label
- Type: String
- Required: O
- Description: Label users see for the field in the UI
\n
name
- Type: String
- Required: O
- Description: Field name stored on the Dynamic Yard back-end. Can be used to match to the field when processing the Gate Check-In webhook programmatically to avoid parsing spaces and special characters that might be used in the UI label (listed above)
\n
type
- Type: String
- Required: O
- Description: Data type of the custom attribute. Available types include: Text | Option | Toggle (yes/no)
\n
value
- Type: String/Boolean*
- Required: O
- Description: The actual value entered in the field. *For text type values, the field will be returned as a string. For boolean type values, it will be a boolean data type
\n

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0bd9ca2-6a6c-4a1f-936c-dd1c1b76faec"},{"name":"Move Confirmation","id":"3441a99c-21a9-4e82-8757-e1e81b00a915","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"assignee\": {\n \"assignee_comments\": null,\n \"assignee_id\": 714,\n \"assignment_reason\": null,\n \"email_address\": \"jockey@shipper.com\",\n \"first_name\": \"Jockey\",\n \"last_name\": \"User\"\n },\n \"carrier_name\": \"McClure / Prinzi\",\n \"delivery_ids\": [\n \"8BD5427B_D2F1\"\n ],\n \"equipment_type\": \"Container\",\n \"from_location_name\": \"030\",\n \"from_location_type\": \"Spot\",\n \"load_numbers\": [\n \"8BD5427B_D2F1\"\n ],\n \"message_type\": \"MOVE_TASK_CALLBACK\",\n \"move_request_id\": 1665,\n \"priority\": \"Normal\",\n \"reject_reason\": null,\n \"rejected\": false,\n \"requested_carrier_name\": \"Test Carrier 4\",\n \"requested_from_location\": null,\n \"requested_from_location_type\": null,\n \"requested_scac\": \"ATCL\",\n \"requested_to_location\": \"Door 10\",\n \"requested_to_location_type\": \"Door\",\n \"requested_trailer_id\": 48350,\n \"requested_trailer_number\": \"F00CCB2\",\n \"requestor\": {\n \"email_address\": \"test.user@fourkites.com\",\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"requestor_comments\": null,\n \"requestor_id\": 646\n },\n \"scac\": \"0010\",\n \"site_code\": \"SS03\",\n \"status\": \"Logged\",\n \"timestamp\": \"2022-02-01T01:17:49.803687\",\n \"to_location_name\": \"Door 40\",\n \"to_location_type\": \"Door\",\n \"trailer_id\": 2803,\n \"trailer_number\": \"H84758\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when a move request is created or updated. This is associated with the Move_Request_Task_Update trigger.

Move Request Lifecycle

The following table outlines the statuses a move request can go through:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

UI Status	Webhook Status	Description
Created/Logged	Logged	The move request has been created and is logged in the spotter queue in Dynamic Yard
Assigned	Assigned	The move request has been assigned to an on-duty spotter driver
Started	Picked	The move request has been picked up by the spotter driver in the Dynamic Yard tablet
Hooked	Started	The spotter driver has hooked to the trailer
Unhooked/Completed	Completed	The move request has been completed and the trailer is now at the target destination (SPOT = door, PULL = yard)
Cancelled	Cancelled	The move request has been cancelled

If the objective is for the WMS to know when a trailer is at a door, or if it was just pulled from a door, you can use these statuses to understand the lifecycle of that move request:

* Arrival at the door is signified by the “Completed” status for a SPOT request on a trailer
* Departure from a door can be defined with the “Started” status of a PULL request from the door; a status of Started is indicated when the trailer is hooked, meaning that the door has been cleared even if the trailer has not been placed at the final destination in the yard

Field Definitions

* Optional String field example when empty: \"to_location_type\": null
* Optional Array field example when empty: \"load_numbers\": []

Move Request Detail

* move_request_id
* Type: Int(64)
* Required: M
* Description: Unique ID generated in Dynamic Yard with a move is created. This is useful if creating moves via API as it can be used to sync updates from the webhooks with a move generated from the WMS
* status
* Type: String
* Required: M
* Description: Current status of the move request. See above table for more information on move statuses and it's lifecycle
* priority
* Type: String
* Required: M
* Description: The priority status of the move. This can be set by the requestor when creating the move. Valid values include: \"Normal\" | \"Priority\"

Assignee Detail

The assignee fields reside under an object by the same name. These identify the yard jockey/spotter assigned to the move request. If no yard spotter has been assigned to the task yet, these fields will be null.

* assignee_comments
* Type: String
* Required: O
* Description: Comments left by the jockey/spotter on the task
* assignee_id
* Type: String
* Required: O
* Description: Unique ID for the spotter's profile in Dynamic Yard
* assignee_reason
* Type: String
* Required: O
* Description: Reason code for why the yard jockey/spotter was assigned to the task. This relates to auto-assignment reasons in Dynamic Yard
* email_address
* Type: String
* Required: O
* Description: Email address of the yard jockey/spotter
* first_name
* Type: String
* Required: O
* Description: First name of the yard jockey/spotter
* last_name
* Type: String
* Required: O
* Description: Last name of the yard jockey/spotter

Requestor Detail

The requestor fields reside under an object by the same name. These identify the requestor of the move. If moves are requested via API, these fields will be null.

* email_address
* Type: String
* Required: O
* Description: Email address of the user who created the move request
* first_name
* Type: String
* Required: O
* Description: First name of the user who created the move request
* last_name
* Type: String
* Required: O
* Description: Last name of the user who created the move request
* requestor_comments
* Type: String
* Required: O
* Description: Comments left by the creator of the move request
* requestor_id
* Type: String
* Required: O
* Description: Unique ID for the requestor's profile in Dynamic Yard

Trailer / Equipment Detail

* equipment_type
* Type: String
* Required: M
* Description: The type of trailer (e.g. 53' Dry Van, Container, etc.). Values are configurable in the UI as customer master data
* from_location_name
* Type: String
* Required: M
* Description: Name of the location the trailer is requested to be moved from. Will be either a parking spot name or dock door name (it's current location)
* from_location_type
* Type: String
* Required: M
* Description: Type of the location the trailer is requested to be moved from (it's current location)
* message_type
* Type: String
* Required: M
* Description: Type of webhook. Will always be MOVE_TASK_CALLBACK
* rejected
* Type: Boolean
* Required: M
* Description: Indicates whether the task has been rejected by the spotter. Valid values: true | false
* reject_reason
* Type: String
* Required: O
* Description: Reason selected by the spotter for rejecting the task. This will only be populated if the rejected field is true. Otherwise, this field will be null
* requested_carrier_name
* Type: String
* Required: M
* Description: Name of the carrier associated with the trailer
* requested_from_location
* Type: String
* Required: M
* Description: Original location that was requested to move the trailer from
* For SPOT requests, this will be the parking spot the trailer currently resides
* For PULL requests, this will be the dock door where the trailer currently resides
* requested_from_location_type
* Type: String
* Required: M
* Description: Original location type that was requested to move the trailer from
* For SPOT requests, this will be the parking lot the trailer currently resides
* For PULL requests, this will be the dock name where the trailer currently resides
* requested_scac
* Type: String
* Required: M
* Description: SCAC or code associated with the carrier
* requested_to_location
* Type: String
* Required: CM*
* Description: original location that was requested to move the trailer into. *This field will be conditionally present based upon the type of move:
* For SPOT requests, this will be the dock door
* For PULL requests with a specified location, this will be the parking spot
* For PULL requests without a specified location, this will be null
* requested_to_location_type
* Type: String
* Required: CM*
* Description: Type of location which was originally requested to have the trailer moved into.
* *This field will be conditionally present based upon the type of move:
* For SPOT requests, this will be the dock name
* For PULL requests with a specified location, this will be the parking lot name
* For PULL requests without a specified location, this will be null
* requested_trailer_number
* Type: String
* Required: M
* Description: The trailer number originally requested for the move. Note, if the spotter selects a different trailer, this original requested trailer will remain the same in subsequent webhooks
* requested_trailer_id
* Type: Int32
* Required: M
* Description: The trailer number originally requested for the move. Note, if the spotter selects a different trailer, this original requested trailer will remain the same in subsequent webhooks
* site_code
* Type: String
* Required: M
* Description: Unique identifier for the site
* to_location_name
* Type: String
* Required: M
* Description: Name of the location the trailer is requested to be moved to. Will be either a parking spot name or dock door name
* to_location_type
* Type: String
* Required: M
* Description: Type of the location the trailer is requested to be moved into
* trailer_id
* Type: String
* Required: M
* Description: Unique trailer ID generated by Dynamic Yard. It is recommended to store this ID as it is used for other Dynamic Yard APIs
* trailer_number
* Type: String
* Required: M
* Description: Trailer number entered by the gate upon check-in
* timestamp
* Type: ISO8601 Date/Time
* Required: M
* Description: Timestamp of when the move request was created/updated. Will be in UTC

Delivery / Shipment Detail

* delivery_ids
* Type: Array
* Required: O
* Description: List of delivery IDs (shipments) associated with the trailer. These are listed on the delivery object. Will only be populated if the trailer is full
* load_numbers
* Type: String
* Required: O
* Description: List of load numbers associated with the trailer. These correspond to the \"Bill of Lading\" value on the delivery object. Will only be populated if the trailer is full

Carrier / Transaction Detail

* carrier_name
* Type: String
* Required: M
* Description: Name of the carrier which owns the trailer
* scac
* Type: String
* Required: M
* Description: SCAC or carrier code of the company which owns the trailer

Additional Attributes Detail

* form
* Type: String
* Required: O
* Description: The data object which the attribute is created for. On the Gate Check-In webhook, this will be trailer
* label
* Type: String
* Required: O
* Description: Label users see for the field in the UI
* name
* Type: String
* Required: O
* Description: Field name stored on the Dynamic Yard back-end. Can be used to match to the field when processing the Gate Check-In webhook programmatically to avoid parsing spaces and special characters that might be used in the UI label (listed above)
* type
* Type: String
* Required: O
* Description: Data type of the custom attribute. Available types include: Text | Option | Toggle (yes/no)
* value
* Type: String/Boolean*
* Required: O
* Description: The actual value entered in the field. *For text type values, the field will be returned as a string. For boolean type values, it will be a boolean data type

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"3441a99c-21a9-4e82-8757-e1e81b00a915"}],"id":"e7a6a3fa-a76c-4c90-a8aa-2e4365040fd5","description":"

The following examples detail each Dynamic Yard webhook. Please review each sample and the field definitions to gain an understanding of when the message is triggered and what data points can return.

\n
Note: if your organization is not licensed to use Dynamic Yard, you may skip this section
\n

Trigger Events

The following events are supported to trigger webhooks from Dynamic Yard. Each event can be subscribed separately and to its own API URL. Additionally, multiple URL configurations can be subscribed to the same event (useful for sending a single event to multiple systems):

Check_In
Check_Out
Equipment_Update
Move_Request_Task_Update

\n","_postman_id":"e7a6a3fa-a76c-4c90-a8aa-2e4365040fd5"},{"name":"Appointment Manager","item":[{"name":"Appointment Confirmed","id":"00fa14a4-e60d-4c5d-a741-a66b86bd4c2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AppointmentTimeEnd\": \"2022-03-17T23:30:00.000Z\",\n \"AppointmentTimeStart\": \"2022-03-17T23:00:00.000Z\",\n \"Carrier\": \"Test Trucking\",\n \"LoadNumber\": \"83826F46\",\n \"MessageType\": \"APPOINTMENT_CONFIRMED\",\n \"PONumber\": [\n \t\"78584\"\n ],\n \"PlannedTime\": \"2022-03-17T14:30:00.000Z\",\n \"ReferenceNumber\": [\n \"YU8485\"\n ],\n \"Scac\": \"cc79\",\n \"Shipper\": \"test-company\",\n \"ShippingType\": \"Live\",\n \"StopName\": \"FourKites HQ\",\n \"StopSequence\": 1,\n \"StopType\": \"PickUp\",\n \"TimeStamp\": \"2022-03-07T13:15:25-06:00\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when an appointment is confirmed (scheduled) by a carrier at a facility in Appointment Manager. This is associated with the Appointment_Confirmed trigger.

Field Definitions

Optional String field example when empty: \"StopName\": null
Optional Array field example when empty: \"PONumber\": []

Trailer / Equipment Detail

AppointmentTimeStart
- Type: ISO8601 Date/Time
- Required: M
- Description: Start time of the appointment window
\n
AppointmentTimeEnd
- Type: ISO8601 Date/Time
- Required: M
- Description: End time of the appointment window
\n
Carrier
- Type: String
- Required: O
- Description: Name of the carrier associated with the appointment
\n
LoadNumber
- Type: String
- Required: M
- Description: Unique identifier for the load / shipment which the appointment is for
\n
MessageType
- Type: String
- Required: M
- Description: Type of webhook. Will always be APPOINTMENT_CONFIRMED
\n
PONumber
- Type: Array
- Required: O
- Description: List of PO Numbers associated with the appointment
\n
PlannedTime
- Type: ISO8601 Date/Time
- Required: M
- Description: Original planned time for the appointment. This is typically set when a load / shipment is created in the Core Track platform, or done manually when creating the appointment in Appointment Manager. This is meant to be confirmed / overridden by the carrier when scheduling the confirmed appointment
\n
ReferenceNumber
- Type: Array
- Required: O
- Description: List of reference numbers associated with the shipment. These are secondary identifiers which can be used to search or identify the load in FourKites
\n
Scac
- Type: String
- Required: O
- Description: SCAC associated with the carrier
\n
Shipper
- Type: String
- Required: M
- Description: Unique identifier for the shipper company in FourKites. This will be the same for all messages
\n
ShippingType
- Type: String
- Required: M
- Description: Denotes the type of shipment. Valid values: Live | Drop-Hook
\n
StopName
- Type: String
- Required: M
- Description: Name of the stop which will correlate with the facility the appointment is scheduled at
\n
StopSequence
- Type: Int32
- Required: O
- Description: The sequence of the stop in relation to other stops on the shipment. The presence of a non-null value at this field will depend on whether the stop's sequence is identified when creating the load
\n
StopType
- Type: String
- Required: M
- Description: Denotes the type of stop on the shipment. In FourKites, these can be either Pickup or Delivery, but they correspond to whether a shipment is an outbound (pickup) or inbound (delivery) at the facility
\n
TimeStamp
- Type: ISO8601 Date/Time
- Required: M
- Description: Time that the appointment was planned / created in Appointment Manager
\n

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"00fa14a4-e60d-4c5d-a741-a66b86bd4c2d"},{"name":"Appointment Rescheduled","id":"2c389421-d1f7-412f-b8cb-21f67b0729d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AppointmentTimeEnd\": \"2022-03-22T09:00:00.000Z\",\n \"AppointmentTimeStart\": \"2022-03-22T07:00:00.000Z\",\n \"Carrier\": \"Test Trucking\",\n \"LoadNumber\": \"83826F46\",\n \"MessageType\": \"APPOINTMENT_RESCHEDULED\",\n \"PONumber\": [\n \"8485968\"\n ],\n \"PlannedTime\": \"2022-03-20T05:00:00.000Z\",\n \"ReferenceNumber\": [\n \"92089745\",\n \"92474\"\n ],\n \"Scac\": \"cc79\",\n \"Shipper\": \"test-company\",\n \"ShippingType\": \"Live\",\n \"StopName\": \"FourKites Delivery Destination\",\n \"StopSequence\": 2,\n \"StopType\": \"Delivery\",\n \"TimeStamp\": \"2022-03-09T15:41:56-06:00\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when a scheduled appointment is rescheduled (updated) by a carrier at a facility in Appointment Manager. This is associated with the Appointment_Rescheduled trigger.

Field Definitions

Optional String field example when empty: \"StopName\": null
Optional Array field example when empty: \"PONumber\": []

Trailer / Equipment Detail

AppointmentTimeStart
- Type: ISO8601 Date/Time
- Required: M
- Description: Start time of the appointment window
\n
AppointmentTimeEnd
- Type: ISO8601 Date/Time
- Required: M
- Description: End time of the appointment window
\n
Carrier
- Type: String
- Required: O
- Description: Name of the carrier associated with the appointment
\n
LoadNumber
- Type: String
- Required: M
- Description: Unique identifier for the load / shipment which the appointment is for
\n
MessageType
- Type: String
- Required: M
- Description: Type of webhook. Will always be APPOINTMENT_RESCHEDULED
\n
PONumber
- Type: Array
- Required: O
- Description: List of PO Numbers associated with the appointment
\n
PlannedTime
- Type: ISO8601 Date/Time
- Required: M
- Description: Original planned time for the appointment. This is typically set when a load / shipment is created in the Core Track platform, or done manually when creating the appointment in Appointment Manager. This is meant to be confirmed / overridden by the carrier when scheduling the confirmed appointment
\n
ReferenceNumber
- Type: Array
- Required: O
- Description: List of reference numbers associated with the shipment. These are secondary identifiers which can be used to search or identify the load in FourKites
\n
Scac
- Type: String
- Required: O
- Description: SCAC associated with the carrier
\n
Shipper
- Type: String
- Required: M
- Description: Unique identifier for the shipper company in FourKites. This will be the same for all messages
\n
ShippingType
- Type: String
- Required: M
- Description: Denotes the type of shipment. Valid values: Live | Drop-Hook
\n
StopName
- Type: String
- Required: M
- Description: Name of the stop which will correlate with the facility the appointment is scheduled at
\n
StopSequence
- Type: Int32
- Required: O
- Description: The sequence of the stop in relation to other stops on the shipment. The presence of a non-null value at this field will depend on whether the stop's sequence is identified when creating the load
\n
StopType
- Type: String
- Required: M
- Description: Denotes the type of stop on the shipment. In FourKites, these can be either PickUp or Delivery, but they correspond to whether a shipment is an outbound (pickup) or inbound (delivery) at the facility
\n
TimeStamp
- Type: ISO8601 Date/Time
- Required: M
- Description: Time that the appointment was planned / created in Appointment Manager
\n

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c389421-d1f7-412f-b8cb-21f67b0729d0"},{"name":"Appointment Cancelled","id":"7533eff9-25d6-4c04-ba6b-cd84a7d06d13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AppointmentTimeEnd\": \"2022-02-14T23:30:00.000Z\",\n \"AppointmentTimeStart\": \"2022-02-14T23:00:00.000Z\",\n \"Carrier\": \"Test Trucking\",\n \"LoadNumber\": \"83826F46\",\n \"MessageType\": \"APPOINTMENT_CANCELLED\",\n \"PONumber\": [\n \t\"8485968\"\n ],\n \"PlannedTime\": \"2022-02-14T05:00:00.000Z\",\n \"ReferenceNumber\": [\n \t \"92089745\",\n \"92474\"\n ],\n \"Scac\": \"cc79\",\n \"Shipper\": \"test-company\",\n \"ShippingType\": \"Live\",\n \"StopName\": \"FourKites Delivery Destination\",\n \"StopSequence\": 2,\n \"StopType\": \"Delivery\",\n \"TimeStamp\": \"2022-02-10T15:22:16-05:00\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The following message is sent to a subscribed URL when a scheduled appointment is cancelled at a facility in Appointment Manager. This is associated with the Appointment_Rescheduled trigger.

Field Definitions

Optional String field example when empty: \"StopName\": null
Optional Array field example when empty: \"PONumber\": []

Trailer / Equipment Detail

AppointmentTimeStart
- Type: ISO8601 Date/Time
- Required: M
- Description: Start time of the appointment window
\n
AppointmentTimeEnd
- Type: ISO8601 Date/Time
- Required: M
- Description: End time of the appointment window
\n
Carrier
- Type: String
- Required: O
- Description: Name of the carrier associated with the appointment
\n
LoadNumber
- Type: String
- Required: M
- Description: Unique identifier for the load / shipment which the appointment is for
\n
MessageType
- Type: String
- Required: M
- Description: Type of webhook. Will always be APPOINTMENT_CANCELLED
\n
PONumber
- Type: Array
- Required: O
- Description: List of PO Numbers associated with the appointment
\n
PlannedTime
- Type: ISO8601 Date/Time
- Required: M
- Description: Original planned time for the appointment. This is typically set when a load / shipment is created in the Core Track platform, or done manually when creating the appointment in Appointment Manager. This is meant to be confirmed / overridden by the carrier when scheduling the confirmed appointment
\n
ReferenceNumber
- Type: Array
- Required: O
- Description: List of reference numbers associated with the shipment. These are secondary identifiers which can be used to search or identify the load in FourKites
\n
Scac
- Type: String
- Required: O
- Description: SCAC associated with the carrier
\n
Shipper
- Type: String
- Required: M
- Description: Unique identifier for the shipper company in FourKites. This will be the same for all messages
\n
ShippingType
- Type: String
- Required: M
- Description: Denotes the type of shipment. Valid values: Live | Drop-Hook
\n
StopName
- Type: String
- Required: M
- Description: Name of the stop which will correlate with the facility the appointment is scheduled at
\n
StopSequence
- Type: Int32
- Required: O
- Description: The sequence of the stop in relation to other stops on the shipment. The presence of a non-null value at this field will depend on whether the stop's sequence is identified when creating the load
\n
StopType
- Type: String
- Required: M
- Description: Denotes the type of stop on the shipment. In FourKites, these can be either PickUp or Delivery, but they correspond to whether a shipment is an outbound (pickup) or inbound (delivery) at the facility
\n
TimeStamp
- Type: ISO8601 Date/Time
- Required: M
- Description: Time that the appointment was planned / created in Appointment Manager
\n

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7533eff9-25d6-4c04-ba6b-cd84a7d06d13"}],"id":"918a8b2b-68a1-4744-8ac7-12441521b421","description":"

The following examples detail each Appointment Manager webhook. Please review each sample and the field definitions to gain an understanding of when the message is triggered and what data points can return.

\n
Note: if your organization is not licensed to use Appointment Manager, you may skip this section
\n

Trigger Events

The following events are supported to trigger webhooks from Appointment Manager. Each event can be subscribed separately and to its own API URL. Additionally, multiple URL configurations can be subscribed to the same event (useful for sending a single event to multiple systems):

Appointment_Confirmed
Appointment_Rescheduled
Appointment_Cancelled

\n","_postman_id":"918a8b2b-68a1-4744-8ac7-12441521b421"}],"id":"edb3c3ee-1a68-4518-8598-10e744f7dc05","description":"

The following webhooks can be subscribed to from the Dynamic Yard and Appointment Manager platforms. There are 2 folders containing different webhooks:

Dynamic Yard: contains webhooks which trigger from the Dynamic Yard application
Appointment Manager: contains webhooks which trigger from the Appointment Manager application

All webhooks are mutually exclusive, meaning that just one or all can be enabled.

\n
Note: If your organization is only using Dynamic Yard and not Appointment Manager, you may disregard the Appointment Manager section. Similarly, if your organization is only using the Appointment Manager product and not Dynamic Yard, the section for the latter webhooks may be disregarded
\n

If you would like to subscribe an API to receive Dynamic Yard webhooks from either application, please review the below details and reach out to your FourKites Dynamic Yard Delivery Consultant or Customer Success Manager to enable the messages. FourKites requires that your organization define an API endpoint using one of the below authentication frameworks in order to receive webhooks.

Authentication and Subscriptions

When subscribing to Dynamic Yard webhooks, 3 types of authentication can be used:

Basic
API Key / Auth Header (using keys or secrets inside HTTP headers)
Oauth2 (client_credentials flow)

The following information needs to be supplied to FourKites in order to subscribe an API to Dynamic Yard webhooks:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
URL	URL of the API listening to Dynamic Yard or Appointment Manager webhooks. When supplying FourKites with the URLs, please ensure you specify which URL should receive which events. The same URL can be used across all events if that is your organization's preference
Webhook Trigger Events	Specify the trigger event(s) you'd like to receive webhooks for, and supply the URL / authentication which should receive those events
Authentication Method	Authentication method used for the webhook configuration. Supported options include: • Basic Auth • API Key / Auth Header • Oauth2 (*see oauth2 section below)
Additional Headers	Any additional headers which may need to be passed in the request

*If using oauth2, FourKites will need to know the token URL, client_id, and client_secret associated with the oauth2 service

\n","_postman_id":"edb3c3ee-1a68-4518-8598-10e744f7dc05"},{"name":"Sample Workflows","item":[{"name":"Load Empty Trailer","item":[{"name":"Gate Check-In","id":"8333527e-9c11-4cf6-9cb9-01d25c8b6977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"88888\",\n \"trailer_id\": 2064,\n \"tractor_carrier_name\": null,\n \"tractor_scac\": null,\n \"tractor_name\": null,\n \"equipment_type\": null,\n \"direction\": \"Inbound\",\n \"turnaway_reason\": null,\n \"trailer_usage\": null,\n \"gate_pass_number\": 6140,\n \"trailer_arrival_time\": \"2022-01-17T21:24:49.443317\",\n \"trailer_departure_time\": null,\n \"delivery_ids\": [],\n \"load_numbers\": [],\n \"site_code\": \"SS03\",\n \"out_of_service\": null,\n \"process_status\": \"In_Gate\",\n \"load_status\": \"Empty\",\n \"load_type\": \"For Pickup\",\n \"trailer_condition\": null,\n \"is_brokered\": false,\n \"transaction_type\": \"ARRIVAL\",\n \"message_type\": \"GATE_TRANSACTION\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Trailer is checked into the yard by the gate. The Gate Check-In webhook is sent.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"8333527e-9c11-4cf6-9cb9-01d25c8b6977"},{"name":"Create Spot Task","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"8a3ce1f9-ac63-4338-9d17-e6cfb10aa6c1"}}],"id":"f13a5697-9c7e-474d-9649-91aad6cb914e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Door\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 09\",\n \"dock_name\": \"Rail Dock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

Spot task is created to move the trailer to an open dock door.

This step may not be necessary if the gate knows which door to assign the trailer into. In that case, the driver could take the trailer directly to that dock door, removing this step.

Separately, this API may not be necessary if spot tasks will be created manually in Dynamic Yard.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f13a5697-9c7e-474d-9649-91aad6cb914e"},{"name":"Move Confirmation - Spot Logged","id":"2be819c8-ffe4-496c-bf12-bce47e555a06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Logged\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

First, the status of Logged will be sent with the Move Confirmation webhook. This indicates that the move was successfully created.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2be819c8-ffe4-496c-bf12-bce47e555a06"},{"name":"Move Confirmation - Spot Picked","id":"1959b7a5-2d5a-4547-90a0-8a6323cc6614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:46:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Picked\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the move is assigned to an on-duty spotter, the status will change to Picked and another Move Confirmation webhook will be sent.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1959b7a5-2d5a-4547-90a0-8a6323cc6614"},{"name":"Move Confirmation - Spot Started","id":"ea77cc69-9589-4a75-9eaf-0bdbf2de92fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Started\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the spotter has hooked to the trailer, the status of Started will be sent with the Move Confirmation webhook.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea77cc69-9589-4a75-9eaf-0bdbf2de92fd"},{"name":"Move Confirmation - Spot Completed","id":"cb3f15a6-2b99-42be-8561-4e0f1912df76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Completed\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the trailer has bee moved to its final destination and the spotter unhooked, the status of Completed will be sent with the Move Confirmation webhook. This is the final status for the move.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb3f15a6-2b99-42be-8561-4e0f1912df76"},{"name":"Equipment Update - Location Updated (Door)","id":"06473f8d-aa52-4ad2-b86f-129145d3b3ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gate_pass_number\": 6006,\n \"carrier_name\": \"Other\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"equipment_type\": \"Container\",\n \"trailer_id\": 2011,\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-07T07:43:12.774090\",\n \"out_of_service\": null,\n \"updated_by\": \"test_user@fourkites.com\",\n \"location_name\": \"Door 09\",\n \"location_type\": \"Door\",\n \"load_status\": \"Empty\",\n \"process_status\": \"Load\",\n \"message_type\": \"EQUIPMENT_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Simultaneous to the move request being completed, an Equipment Update webhook will be sent indicating that the location of the trailer has changed.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"06473f8d-aa52-4ad2-b86f-129145d3b3ab"},{"name":"Update Trailer (Loaded)","id":"bfee6350-e2db-46a4-a161-b575424d051c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Loaded\",\n \"load_status\": \"Full\",\n \"delivery_names\": [\n \"{{delivery_id}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

After loading the empty trailer, an API call can be triggered from the WMS to update the status of the trailer to Full. This keeps Dynamic Yard in sync with the warehouse activities and readies the trailer to be moved from the door.

\n","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bfee6350-e2db-46a4-a161-b575424d051c"},{"name":"Equipment Update - Status Update","id":"5c4f189c-c576-4238-927d-0456af5ab53f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gate_pass_number\": 6006,\n \"carrier_name\": \"Other\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"load_numbers\": [\n \"U495848\"\n ],\n \"delivery_ids\": [\n \"U495848\"\n ],\n \"equipment_type\": \"Container\",\n \"trailer_id\": 2011,\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-07T07:43:12.774090\",\n \"out_of_service\": null,\n \"updated_by\": \"test_user@fourkites.com\",\n \"location_name\": \"Door 09\",\n \"location_type\": \"Door\",\n \"load_status\": \"Full\",\n \"process_status\": \"Loaded\",\n \"message_type\": \"EQUIPMENT_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

As soon as the trailer is updated to a new status, an Equipment Update webhook will send indicating that the status has changed. While this status may already be known by the external system, the same status changes can be initiated inside Dynamic Yard manually, so this webhook will continue to send to ensure that any external system is aware of the latest status.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c4f189c-c576-4238-927d-0456af5ab53f"},{"name":"Create Pull Task (no destination)","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"28656611-034a-49f9-ab89-52cd16ed7fe0"}}],"id":"9553ae31-4b8f-43bf-9704-680bf2517fc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"trailer_id\": {{trailer_id}},\n \"destination\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

Pull task is created to move the trailer from the dock door back into the yard. By not specifying a destination, Dynamic Yard assumes that the move is a pull request and will defer to the spotter to find a location in the yard.

Optionally, if the warehouse has a preference on a specific spot (uncommon), the specific parking spot can be send in this API call.

Separately, this API may not be necessary if pull tasks will be created manually in Dynamic Yard.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9553ae31-4b8f-43bf-9704-680bf2517fc2"},{"name":"Move Confirmation - Pull Logged","id":"08c7f032-e801-4081-b846-29692af2a664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"U495848\"\n ],\n \"delivery_ids\": [\n \"U495848\"\n ],\n \"site_code\": \"SITE\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"Door 09\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Logged\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

First, the status of Logged will be sent with the Move Confirmation webhook. This indicates that the move was successfully created.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"08c7f032-e801-4081-b846-29692af2a664"},{"name":"Move Confirmation - Pull Picked","id":"c77328fb-07ac-4a20-884a-0f3f64baf082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"U495848\"\n ],\n \"delivery_ids\": [\n \"U495848\"\n ],\n \"site_code\": \"SITE\",\n \"timestamp\": \"2022-01-22T19:45:00.000Z\",\n \"from_location_name\": \"Door 09\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Picked\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the move is assigned to an on-duty spotter, the status will change to Picked and another Move Confirmation webhook will be sent.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c77328fb-07ac-4a20-884a-0f3f64baf082"},{"name":"Move Confirmation - Pull Started","id":"1b217f59-bff0-4030-b1e7-70f7a34716f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"U495848\"\n ],\n \"delivery_ids\": [\n \"U495848\"\n ],\n \"site_code\": \"SITE\",\n \"timestamp\": \"2021-08-12T19:43:00.000Z\",\n \"from_location_name\": \"Door 09\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Started\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the spotter has hooked to the trailer, the status of Started will be sent with the Move Confirmation webhook. For pull requests, the warehouse can use this status to know when the door has been cleared.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b217f59-bff0-4030-b1e7-70f7a34716f1"},{"name":"Move Confirmation - Pull Completed","id":"a986aab5-ca82-42a6-b7ff-69c98ee1ba48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"U495848\"\n ],\n \"delivery_ids\": [\n \"U495848\"\n ],\n \"site_code\": \"SITE\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"Door 09\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Completed\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the trailer has bee moved to its final destination and the spotter unhooked, the status of Completed will be sent with the Move Confirmation webhook. This is the final status for the move.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a986aab5-ca82-42a6-b7ff-69c98ee1ba48"},{"name":"Equipment Update - Location Updated (Yard)","id":"a37ea59e-3760-4fdc-a156-b611979b341e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gate_pass_number\": 6006,\n \"carrier_name\": \"Other\",\n \"scac\": \"OTHR\",\n \"trailer_number\": \"225\",\n \"load_numbers\": [],\n \"delivery_ids\": [\n \"9547\"\n ],\n \"equipment_type\": \"53 FT Reefer\",\n \"trailer_id\": 2011,\n \"site_code\": \"EMU\",\n \"timestamp\": \"2022-01-07T07:43:12.774090\",\n \"out_of_service\": null,\n \"updated_by\": \"shag2@tyson.com\",\n \"location_name\": null,\n \"location_type\": null,\n \"load_status\": \"Full\",\n \"process_status\": \"In_Gate\",\n \"message_type\": \"EQUIPMENT_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Simultaneous to the pull request being completed, an Equipment Update webhook will be sent indicating that the trailer's location has changed.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a37ea59e-3760-4fdc-a156-b611979b341e"},{"name":"Gate Check-Out","id":"c05a2002-8615-4200-aaed-816ec4cce85e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"trailer_id\": 2046,\n \"tractor_carrier_name\": null,\n \"tractor_scac\": null,\n \"tractor_name\": \"7894\",\n \"equipment_type\": \"53 FT Reefer\",\n \"direction\": \"Outbound\",\n \"turnaway_reason\": null,\n \"trailer_usage\": \"New Trailer Designation\",\n \"gate_pass_number\": 6094,\n \"trailer_arrival_time\": null,\n \"trailer_departure_time\": \"2022-01-07T08:25:53.590919\",\n \"delivery_ids\": [\n \"U495848\"\n ],\n \"load_numbers\": [\n \"U495848\"\n ],\n \"site_code\": \"SS03\",\n \"out_of_service\": null,\n \"process_status\": \"Off_Site\",\n \"load_status\": \"Full\",\n \"load_type\": \"Outbound Loaded\",\n \"trailer_condition\": \"Clean\",\n \"is_brokered\": false,\n \"transaction_type\": \"DEPARTURE\",\n \"message_type\": \"GATE_TRANSACTION\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The last activity is to check the trailer out of the yard. As the gate checks the trailer out, the Gate Check-Out webhook will be sent confirming that the trailer has departed.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c05a2002-8615-4200-aaed-816ec4cce85e"}],"id":"1b104a6f-58ae-47c2-9407-e88a67fc35ce","description":"

This process flow outlines the usage of all available APIs and webhooks for a typically flow loading an outbound empty trailer. Depending upon APIs and integration points in scope, these calls may vary. Additionally, other user interactions in the yard (yard-to-yard moves, user updates, etc.) can generate additional webhooks which may not correlate exactly with WMS-triggered activity.

The following steps are detailed in this example:

Delivery is created for a pending outbound shipment
Empty trailer arrives at the yard and is placed at a spot in the yard
A move request is created by the WMS to spot the trailer to an open dock door
The move is acted upon and completed (trailer is placed at the door)
The trailer is loaded by the warehouse and is marked as \"Full\"
A move request is created by the WMS to pull the trailer from the door
The trailer is placed at an open spot in the yard and is marked as ready for pickup
The trailer is picked up and checked out of the yard

\n","_postman_id":"1b104a6f-58ae-47c2-9407-e88a67fc35ce"},{"name":"Unload Full Trailer","item":[{"name":"Gate Check-In","id":"7f783ce5-acf1-40a2-b454-04c9484b0a3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"88888\",\n \"trailer_id\": 2064,\n \"tractor_carrier_name\": null,\n \"tractor_scac\": \"0010\",\n \"tractor_name\": \"Y9495\",\n \"equipment_type\": \"Container\",\n \"direction\": \"Inbound\",\n \"turnaway_reason\": null,\n \"trailer_usage\": null,\n \"gate_pass_number\": 6145,\n \"trailer_arrival_time\": \"2022-01-17T21:24:49.443317\",\n \"trailer_departure_time\": null,\n \"delivery_ids\": [\n \"H848595\"\n ],\n \"load_numbers\": [\n \"H848595\"\n ],\n \"site_code\": \"SS03\",\n \"out_of_service\": null,\n \"process_status\": \"In_Gate\",\n \"load_status\": \"Full\",\n \"load_type\": \"For Pickup\",\n \"trailer_condition\": \"Clean\",\n \"is_brokered\": false,\n \"transaction_type\": \"ARRIVAL\",\n \"message_type\": \"GATE_TRANSACTION\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Trailer is checked into the yard by the gate. The Gate Check-In webhook is sent.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f783ce5-acf1-40a2-b454-04c9484b0a3c"},{"name":"Create Spot Task","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"41381e86-5c33-47a3-9467-be0339ebcba3"}}],"id":"6c25416c-0afd-4f13-91e6-506d25330883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"destination\": \"Door\",\n \"site_code\": \"{{site_code}}\",\n \"door_name\": \"Door 19\",\n \"dock_name\": \"Rail Dock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

Spot task is created to move the trailer to an open dock door.

This step may not be necessary if the gate knows which door to assign the trailer into. In that case, the driver could take the trailer directly to that dock door, removing this step.

Separately, this API may not be necessary if spot tasks will be created manually in Dynamic Yard.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c25416c-0afd-4f13-91e6-506d25330883"},{"name":"Move Confirmation - Spot Logged","id":"994290b5-7441-4a11-9e55-b15ed6509c04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"H848595\"\n ],\n \"delivery_ids\": [\n \"H848595\"\n ],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Logged\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

First, the status of Logged will be sent with the Move Confirmation webhook. This indicates that the move was successfully created.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"994290b5-7441-4a11-9e55-b15ed6509c04"},{"name":"Move Confirmation - Spot Picked","id":"09dbda6d-9c6f-469f-8958-b865696d364a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"H848595\"\n ],\n \"delivery_ids\": [\n \"H848595\"\n ],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Logged\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the move is assigned to an on-duty spotter, the status will change to Picked and another Move Confirmation webhook will be sent.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"09dbda6d-9c6f-469f-8958-b865696d364a"},{"name":"Move Confirmation - Spot Started","id":"2006ba4c-6b91-4e6a-b92b-c501eaaad54e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"H848595\"\n ],\n \"delivery_ids\": [\n \"H848595\"\n ],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Started\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the spotter has hooked to the trailer, the status of Started will be sent with the Move Confirmation webhook.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2006ba4c-6b91-4e6a-b92b-c501eaaad54e"},{"name":"Move Confirmation - Spot Completed","id":"764b5a7e-8e2e-4b2c-9f91-9bfbeaf70652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [\n \"H848595\"\n ],\n \"delivery_ids\": [\n \"H848595\"\n ],\n \"site_name\": \"SS03\",\n \"timestamp\": \"2022-01-22T19:43:00.000Z\",\n \"from_location_name\": \"SPOT94869\",\n \"from_location_type\": \"Yard\",\n \"to_location_name\": \"Door 09\",\n \"to_location_type\": \"Door\",\n \"status\": \"Completed\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the trailer has bee moved to its final destination and the spotter unhooked, the status of Completed will be sent with the Move Confirmation webhook. This is the final status for the move.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"764b5a7e-8e2e-4b2c-9f91-9bfbeaf70652"},{"name":"Equipment Update - Location Updated (Door)","id":"c2e57352-efa1-4bae-91e9-9ab66fc0f94f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gate_pass_number\": 6006,\n \"carrier_name\": \"Other\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"equipment_type\": \"Container\",\n \"trailer_id\": 2011,\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-07T07:43:12.774090\",\n \"out_of_service\": null,\n \"updated_by\": \"test_user@fourkites.com\",\n \"location_name\": \"Door 09\",\n \"location_type\": \"Door\",\n \"load_status\": \"Empty\",\n \"process_status\": \"Load\",\n \"message_type\": \"EQUIPMENT_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Simultaneous to the move request being completed, an Equipment Update webhook will be sent indicating that the location of the trailer has changed.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2e57352-efa1-4bae-91e9-9ab66fc0f94f"},{"name":"Update Trailer (Unloaded)","id":"102f6937-2871-4cff-9187-d85c80fe8df1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trailer_id\": {{trailer_id}},\n \"site_code\": \"{{site_code}}\",\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"delivery_names\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/trailers/","description":"

After unloading the inbound shipment from the trailer, an API call can be triggered from the WMS to update the status of the trailer to Empty. This keeps Dynamic Yard in sync with the warehouse activities and readies the trailer to be moved from the door.

Additionally, by specifying an empty array for delivery_names, Dynamic Yard will remove any shipments which were associated to the trailer when checked-in.

\n","urlObject":{"path":["wms","v1","trailers",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"102f6937-2871-4cff-9187-d85c80fe8df1"},{"name":"Equipment Update - Status Update","id":"0fdf4e52-d9d9-483d-b8d0-a3bcc79341f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gate_pass_number\": 6006,\n \"carrier_name\": \"Other\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"equipment_type\": \"Container\",\n \"trailer_id\": 2011,\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-07T07:43:12.774090\",\n \"out_of_service\": null,\n \"updated_by\": \"test_user@fourkites.com\",\n \"location_name\": \"Door 19\",\n \"location_type\": \"Door\",\n \"load_status\": \"Full\",\n \"process_status\": \"Loaded\",\n \"message_type\": \"EQUIPMENT_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fdf4e52-d9d9-483d-b8d0-a3bcc79341f6"},{"name":"Create Pull Task (no destination)","event":[{"listen":"test","script":{"exec":["pm.environment.set('move_request_id', responseBody.trim());"],"type":"text/javascript","id":"170f9c1f-f377-46bd-8c96-364a0d0605ed"}}],"id":"dea3744f-3ea7-4cee-bf5f-966126625e9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_code\": \"{{site_code}}\",\n \"trailer_id\": {{trailer_id}},\n \"destination\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{dynamic_yard_url}}/wms/v1/move_requests/","description":"

Optionally, if the warehouse has a preference on a specific spot (uncommon), the specific parking spot can be send in this API call.

Separately, this API may not be necessary if pull tasks will be created manually in Dynamic Yard.

\n","urlObject":{"path":["wms","v1","move_requests",""],"host":["{{dynamic_yard_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dea3744f-3ea7-4cee-bf5f-966126625e9b"},{"name":"Move Confirmation - Pull Logged","id":"5f92eeee-603f-411f-8c32-7eaf08788274","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-22T15:43:00.000Z\",\n \"from_location_name\": \"Door 19\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Logged\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

First, the status of Logged will be sent with the Move Confirmation webhook. This indicates that the move was successfully created.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f92eeee-603f-411f-8c32-7eaf08788274"},{"name":"Move Confirmation - Pull Picked","id":"81e508c1-2890-4d6e-b529-e0be1689c851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-22T15:43:00.000Z\",\n \"from_location_name\": \"Door 19\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Logged\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the move is assigned to an on-duty spotter, the status will change to Picked and another Move Confirmation webhook will be sent.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"81e508c1-2890-4d6e-b529-e0be1689c851"},{"name":"Move Confirmation - Pull Started","id":"f5e2c4dd-4bfd-48c3-a484-e06e964328d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-22T15:47:00.000Z\",\n \"from_location_name\": \"Door 19\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Started\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5e2c4dd-4bfd-48c3-a484-e06e964328d0"},{"name":"Move Confirmation - Pull Completed","id":"442f608f-3930-4dcc-bf21-e71151c23900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"equipment_type\": \"Container\",\n \"trailer_id\": 238575,\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-22T15:52:00.000Z\",\n \"from_location_name\": \"Door 19\",\n \"from_location_type\": \"Door\",\n \"to_location_name\": \"SPOT987\",\n \"to_location_type\": \"Yard\",\n \"status\": \"Completed\",\n \"message_type\": \"MOVE_TASK_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Once the trailer has bee moved to its final destination and the spotter unhooked, the status of Completed will be sent with the Move Confirmation webhook. This is the final status for the move.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"442f608f-3930-4dcc-bf21-e71151c23900"},{"name":"Equipment Update - Location Updated (Yard)","id":"1ff79233-25e2-4677-8576-5acc37f42594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gate_pass_number\": 6006,\n \"carrier_name\": \"Other\",\n \"scac\": \"OTHR\",\n \"trailer_number\": \"8888\",\n \"load_numbers\": [],\n \"delivery_ids\": [],\n \"equipment_type\": \"Container\",\n \"trailer_id\": 2011,\n \"site_code\": \"SS03\",\n \"timestamp\": \"2022-01-17T07:43:12.774090\",\n \"out_of_service\": null,\n \"updated_by\": \"fk_admin@fourkites.com\",\n \"location_name\": \"SPOT987\",\n \"location_type\": \"Yard\",\n \"load_status\": \"Empty\",\n \"process_status\": \"Unloaded\",\n \"message_type\": \"EQUIPMENT_CALLBACK\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

Simultaneous to the pull request being completed, an Equipment Update webhook will be sent indicating that the trailer's location has changed.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ff79233-25e2-4677-8576-5acc37f42594"},{"name":"Gate Check-Out","id":"110ec5ac-1a4a-4d43-b9e3-a53b39879168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"carrier_name\": \"Test Carrier\",\n \"scac\": \"0010\",\n \"trailer_number\": \"8888\",\n \"trailer_id\": 2046,\n \"tractor_carrier_name\": null,\n \"tractor_scac\": null,\n \"tractor_name\": \"7894\",\n \"equipment_type\": \"53 FT Reefer\",\n \"direction\": \"Outbound\",\n \"turnaway_reason\": null,\n \"trailer_usage\": \"New Trailer Designation\",\n \"gate_pass_number\": 6094,\n \"trailer_arrival_time\": null,\n \"trailer_departure_time\": \"2022-01-07T08:25:53.590919\",\n \"delivery_ids\": [],\n \"load_numbers\": [],\n \"site_code\": \"SS03\",\n \"out_of_service\": null,\n \"process_status\": \"Unloaded\",\n \"load_status\": \"Empty\",\n \"load_type\": \"Outbound Loaded\",\n \"trailer_condition\": \"Clean\",\n \"is_brokered\": false,\n \"transaction_type\": \"DEPARTURE\",\n \"message_type\": \"GATE_TRANSACTION\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000","description":"

The last activity is to check the trailer out of the yard. As the gate checks the trailer out, the Gate Check-Out webhook will be sent confirming that the trailer has departed.

\n","urlObject":{"protocol":"http","port":"3000","host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"110ec5ac-1a4a-4d43-b9e3-a53b39879168"}],"id":"be6ca0c5-4a50-4f6d-9555-9e6e098ec4b0","description":"

This process flow outlines the usage of all available APIs and webhooks for a typically flow unloading a full trailer. Depending upon APIs and integration points in scope, these calls may vary. Additionally, other user interactions in the yard (yard-to-yard moves, user updates, etc.) can generate additional webhooks which may not correlate exactly with WMS-triggered activity.

The following steps are detailed in this example:

Delivery is created for a pending inbound shipment
Full trailer arrives at the yard and is placed at a spot in the yard
A move request is created by the WMS to spot the trailer to an open dock door
The move is acted upon and completed (trailer is placed at the door)
The trailer is unloaded by the warehouse and is marked as \"Empty\"
A move request is created by the WMS to pull the trailer from the door
The trailer is placed at an open spot in the yard and is marked as ready for pickup
The trailer is picked up and checked out of the yard

\n","_postman_id":"be6ca0c5-4a50-4f6d-9555-9e6e098ec4b0"}],"id":"632eb2d2-e2c0-4807-82aa-af031d462938","description":"

The following collection of API calls details an example workflow of how the messages fit together as part of an end-to-end flow.

\n","_postman_id":"632eb2d2-e2c0-4807-82aa-af031d462938"}]}