Integrate with Dispatch

The following how-to sections describe the steps necessary to create and manage Dispatch using the Dispatch API.

Prerequisites

• An account on the OS1 Platform and a Platform Tenant. For more information, see Getting started with the OS1 Platform.
• Credentials for an App on the OS1 Platform. For more information, see Getting started building Apps.
• An access token. For more information about creating an access token for testing purposes, see Postman Collection or How to use the API 'Try It' feature.
• A mechanism to call the endpoints. For testing purposes, you can use our Postman Collection or the “Try It!” feature in our API Documentation.
• You should have a Participant created to add to a Dispatch.

To create a Dispatch, you must:

• Create a Job Type.
• Create a Job Workflow.
• Create Job Attributes.
• Create a Job.
• Create a Dispatch Type.
• Create Dispatch Attributes.
• Create a Dispatch.
• Add Job to a Dispatch.
• Add Participant to a Dispatch.

Additionally, you can:

• Retrieve existing Job Types.
• Retrieve Job Workflow by Job Workflow ID.
• Update Job Workflow status.
• Update a Job.
• Retrieve Job Attributes.
• Retrieve existing Jobs.
• Update the status and sub-status of Jobs.
• Retrieve existing Dispatch Types.
• Update the status and sub-status of a Dispatch.
• Remove the Job from a Dispatch.
• Remove Participant from a Dispatch.
• Retrieve attribute configuration of a Dispatch.
• Update Execution Task status.
• Update Execution Workflow status.
• Apply CustodyIn Scan.
• Apply CustodyOut Scan.