Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
Container Service
Container State

Apply event on the container.

1min
PUT

This API will apply an event to an instance. If the event is transitionable, then the instance will transition to the particular state. Otherwise it will remain in the existing state.

PARAMETERDESCRIPTIONTYPEVALIDATION
name*Represents name of the event for state transition.stringminLength: 3 maxLength: 64
timestampRepresents the timestamp of the event occured.integer
propagatePropagate flag indicates whether these events need to propagate on child containers or not.booleanDefault: false
dataRepresents event data values, if any, for this event.
sourceRepresents the source which triggered the event. It can be an app, a user or some location from where the event was triggered.
ㅤ↳appId*Application ID which is responsible for calling this event.stringminLength: 1 maxLength: 64
ㅤ↳userIdUser ID which is responsible for calling this event.stringminLength: 1 maxLength: 64
ㅤ↳locIdLocationId of the event.string
callbackRepresents callback URL, which can be called to get any info about state change of a container and notify status(success/failed) of API.stringA valid URL.
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
503 - Server ErrorSomething went wrong.. (These are rare.)
PATH PARAMETERS
containerId
string
*
Unique id of Container
containerTypeName
string
*
Example: bag
A unique name to represent type of a container.
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique request id.
X-COREOS-TID
string
*
Example: delhivery1234
Tenant id
X-COREOS-ACCESS
string
*

Core-os access token

X-COREOS-CALLBACK-SECRET
string

Core-os access token

X-COREOS-USERINFO
string

Core-os user info

BODY PARAMETERS
body
ContainerStateUpdateRequest
*
Event for container state transition.
eventCode
EventCode
*
Event Code of the format:E-yyy. E - Prefix indicating that this is an event code. yyy - 3 digit event code string ranging from 001 to 999
reasonCode
ReasonCode
Reason Code of the format:R-nnnn R - Prefix indicating that this is a reason code nnnn - 4 digit reason code string ranging from 0001 to 9999
timestamp
integer
*
Represents the timestamp of the event occured.
propagate
boolean
propagate flag indicate whether these events need to propogate on child containers or not.
data
object
*
Represents event data values, if any, for this event
source
EventSource
*
Represents the source which triggered the event. It can be an app, a user or some location from where the event was triggered.
callback
object
RESPONSES
200
OK
ContainerStateResponse
data
ContainerState
request
Request
400
Bad Request
ErrorResponse
error
Error
Error Information
request
Request
401
Unauthorized
ErrorResponse
error
Error
Error Information
request
Request
404
Not Found
ErrorResponse
error
Error
Error Information
request
Request
503
Server Error
ErrorResponse
error
Error
Error Information
request
Request




Updated 24 Aug 2023
Did this page help you?
PREVIOUS
Get the current state of a container
NEXT
Add containers to a group
Docs powered by Archbee