Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Introduction
Overview
Getting started with the OS1 Platform
Getting started with building Apps
Concepts
Working with Callbacks
Console UI Overview
Custom Code
Working with GraphQL
Custom Attributes Ownership
Attribute-Based Access Control (ABAC)
Data Listing and Query (DLQS) Search
Core API dev guides
Overview
Authentication And Authorization
Participant
Container
Dispatch
Orchestrator
Workflow
Secure Data Storage
File Management
State Machine
Entity
Notification
Motion Tracking System
Location
Platform Order Management
Address
Scheduler
Logistics Framework API Dev guides
Overview
LogisticsOrder API
User API
Facility API
Vehicle API
How-To Guides
Integrate Your Application with Console UI
Integrate with Participants
Integrate with Containers
Integrate with Users
Integrate with Vehicles
Integrate with Facilities
Integrate with Entities
Integrate with Dispatch
Integrate with Logistics Order
Integrate with Platform Order Management
Integrate with Location Service
Integrate with Orchestrator
GraphQl Schemas
GraphQL: Dispatch Queries
GraphQL: Order Queries
GraphQL: Workflow Queries
GraphQL: Container Queries
Platform SDKs
SDK Overview
Sample Apps
Vehicle Management App
Container App
Resources
FAQs
Glossary
Data Types Used in OS1
Development Guidelines
Entity, Event, and Reason Codes
Service/API Level Error Codes
Docs powered by Archbee
GraphQl Schemas
GraphQL: Order Queries

order

4min

Overview

OS1 Mobile App developers can use GraphQL queries to retrieve lists for orders using a single API enabling mobile app developers to build higher-performing mobile apps that can retrieve large lists of data in a single query. T

order

Retrieve order data within a Tenant with a given orderId.

Arguments

orderId: The unique ID of the order to search.

tenant(required): The Tenant name.

Fields

  • attributes: This field holds additional metadata about the order.
  • batchId: This field represents the ID of the batch in which the order was processed.
  • cancellationFailureReasonCode: This field represents the reason code for a failed cancellation request.
  • cancellationRequested: This field indicates whether a cancellation of the order was requested (Boolean).
  • cancellationRequestedBy: This field denotes the entity (user or system) that requested the cancellation.
  • cancellationRequestedOn: This field indicates the timestamp when the cancellation was requested.
  • cancellationStatus: This field represents the current status of the cancellation request.
  • cancellationStatusTimestamp: This field indicates the timestamp of the latest cancellation status update.
  • clientId: This field represents the ID of the client associated with the order.
  • clientName: This field represents the name of the client associated with the order.
  • clientOrderId: This field represents the ID assigned to the order by the client.
  • createdAt: This field represents the timestamp when the order was created.
  • createdBy: This field denotes the entity (user or system) that created the order.
  • domain: This field represents the domain in which the order exists.
  • id: Unique identifier of the order.
  • orderSchemaVersion: The version of the order schema.
  • workOrderFlowType: The flow type of the work order associated with the order.
  • updatedBy: The entity (user or system) that last updated the order.
  • updatedAt: Timestamp when the order was last updated.
  • type: The type of the order.
  • tenantId: ID of the tenant that owns the order.
  • subStatus: The sub-status of the order.
  • status: The status of the order.
  • shipmentFlow: Information about the shipment flow associated with the order.
  • readyToProcess: Indicator whether the order is ready to be processed (Boolean).

Objects

  • dropDetails: This object contains details about the drop-off location for the order. It includes:
    • contact: Contact person at the drop-off location.
    • location: Location details of the drop-off point, including:
      • address: The physical address of the drop-off location.
      • createdAt: Timestamp when the location details were created.
      • createdBy: The entity that created the location details.
      • description: Description or additional information about the location.
      • geolocation: GPS coordinates for the location.
      • locationId: Unique identifier for the location.
      • similarityId: Identifier linking similar locations.
      • tags: Any tags or labels associated with the location.
      • tenantId: ID of the tenant that owns the location details.
      • updatedAt: Timestamp when the location details were last updated.
      • updatedBy: The entity that last updated the location details.
    • workOrders: A list of work order objects associated with the order. Each work order object contains the following fields:
      • attributes : An arbitrary set of attributes associated with the work order.
      • cancellationFailureReasonCode : A code representing the reason for a failed cancellation, if applicable.
      • cancellationRequested: A flag indicating whether a cancellation was requested.
      • cancellationRequestedBy: The identifier of the entity that requested the cancellation.
      • cancellationRequestedOn: The timestamp when the cancellation was requested.
      • cancellationStatus: The current status of the cancellation.
      • cancellationStatusTimestamp: The timestamp of the last update to the cancellation status.
      • containers Information about the containers used in the work order.
      • createdAt: The timestamp when the work order was created.
      • createdBy: The identifier of the entity that created the work order.



Updated 03 Aug 2023
Did this page help you?
PREVIOUS
GraphQL: Order Queries
NEXT
orderList
Docs powered by Archbee
TABLE OF CONTENTS
Overview
order
Arguments
Fields
Objects
Docs powered by Archbee