The following how-to sections describe the steps necessary to create Orders using the Order API. The how-tos in this section use the example of creating a mobile device Order to illustrate the process.

Learn how to efficiently create orders using the Order API with this comprehensive document. Follow step-by-step instructions on defining order attributes, configuring the order state machine, creating an order, and adding work orders. Discover additional

How to: Cancel an Order

Integrate with Platform Order Management

clientID

How To: Platform Order Management

Platform

Overview

Getting started with the OS1 Platform

Getting started with building Apps

Introduction

Asynchronous Callbacks in OS1

Working with Callbacks

Console UI Overview

Custom Code

Working with GraphQL

Custom Attributes Ownership

Attribute-Based Access Control (ABAC)

Search Query Format

Data Listing and Query (DLQS) Search

Concepts

Authentication And Authorization

Participant

Container

Jobs and Objectives

Dispatch

Job Manager Plugin

Container Manager Plugin

Work Order Manager Plugin

Workflow Manager Plugin

Cancellation Manager Plugin

Orchestrator

Execution Task and Macro Payloads

Workflow

Secure Data Storage

File Management

State Machine

Entity

Notification

Integrate with Motion Tracking System (MTS) Service

Integrate MTS Geofences

Motion Tracking System

Country Data

Location

Platform Order Attributes and Lifecycle

Work Order Attributes and Lifecycle

Order Validation and Enrichment Plugins

Platform Order Management

Address

Scheduler

Core API dev guides

Predefined Logistics Order API Attributes

LogisticsOrder API Functionalities

LogisticsOrder API

Introduction to Users

Creating Users

User API

Property and Facility Attributes

Creating Property and Facility

Property and Facility Lifecycle

Facility API

Vehicle Attributes

Creating Vehicles

Vehicle Lifecycle

Vehicle API

Logistics Framework API Dev guides

How to: Integrate App with Console UI using React.JS

How to: Integrate App with Console UI using Vue.JS

Implementing Server Side Events (SSE)

Integrate Your Application with Console UI

How to: Create a Participant Type

How to: Define Participant Attributes

How to: Create a Participant Template

How to: Configure the state machine

How to: Create the Participant

How to: Change the Participant State

How to: Implement Custom Code in Participant Services

How To: Create & Update Participants In Batch

Integrate with Participants

How to: Create a Container type

How to: Create a Container

How to: Change the Container state

How to: Containerize a child Container

How to: Implement Custom Code in Container Services

How To: Bulk Containerize/Decontainerize

How To: Create & Update Containers In Batch

Integrate with Containers

How To: Create a User

How to: Change State of a User

How to: Retrieve State of a User

How to: Retrieve a Designation

How to: Find the User ID of a User

How to: Update a User

Integrate with Users

How to: Create a Vehicle

How to: Retrieve Vehicle Details

How to: Retrieve the State of a Vehicle

How to: Change State of a Vehicle

How to: Update a Vehicle

Integrate with Vehicles

How to: Create a Facility

How to: Retrieve Facility

How to: Retrieve the State of a Facility

How to: Change the State of a Facility

How to: Update a Facility

Integrate with Facilities

How to: Create an Entity Type

How to: Retrieve Entity Type

How to: Update Entity Type

How to: Retrieve Entity Type State

How to: Configure the State Machine for Entity type

How to: Update Entity Type State

How to: Create an Entity Template

How to: Retrieve Template

How to: Update Template

How to: Create the Entity

How to: Retrieve Entity

How to: Update Entity

How to: Retrieve Entity State

How to: Apply Event to an Entity

How to: Implement Custom Code in Entity Service

How To: Create & Update Entities In Batch

Integrate with Entities

How to: Manage Job Type

How to: Manage Job Workflow

How to: Manage Jobs

How to: Manage Dispatch Type

How to: Manage Dispatch

How to: Manage Mobile APIs

How to: Manage Ledger

How to: Implement Custom Code in Dispatch Service

Integrate with Dispatch

How to: Create Orders

How to: Get Order Details

Integrate with Logistics Order

How to: WorkOrder

How To: State Machine

How to: Use Plugin in Platform Order Management

How To: Location

How to: Country

Integrate with Location Service

How to Register a Plugin

How to Get Plugin

How to Update a Plugin

How to Create Plugin Workflow

How to Update Plugin Workflow

How to Get Plugin Workflow

How to Create New Execution Rules

How to Update Execution Rule

How to Get the Execution Rule

Integrate with Orchestrator

How-To Guides

dispatchAggregationV2

dispatchListV2

dispatchv2

jobAggregationV2

JobListV2

jobIdsListV2

jobsByReferenceV2

jobWorkflowAggregationV2

jobWorkflowListV2

GraphQL: Dispatch Queries

order

orderList

GraphQL: Order Queries

workflow

workflowAggregation

workflowDraft

workflowDraftList

workflowInstance

workflowInstanceList

workflowList

GraphQL: Workflow Queries

container

containerInstance

containerInstanceList

containers

GraphQL: Container Queries

GraphQl Schemas

AAA SDK

Dispatch SDK

MTS SDK

Workflow Designer SDK

SDK Overview

Platform SDKs

Vehicle Management App

Container App

Sample Apps

FAQs

Glossary

Data Types Used in OS1

App Development Guidelines

Soln Development Guidlines

Development Guidelines

Entity, Event, and Reason Codes

Service/API Level Error Codes

Resources