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

Update attribute of Container

1min
PUT

API to update the attributes of container.

PARAMETERDESCRIPTIONTYPEVALIDATION
trackingDetailsField to represent tracking ID (such as AWB) for a container which is usually pasted on the container and used for scanning it. There can be multiple tracking IDs for a container, owned by different operators and hence it will be stored as a list.
ㅤ↳operatorField to specify the owner of the tracking ID.stringminLength: 3 maxLength: 64Example: Delhivery
ㅤ↳trackingId*stringminLength: 1 maxLength: 128Example: 132121232423232
ㅤ↳isPrimaryIt defines whether it is a primary tracking id or not. If not defined we assume first tracking id as primary tracking id.booleanDefault: false
attributesA map to provide values for the attributes defined in Container-type configuration APIs.
itemsList of items can be added into a container only if the container-type is a leaf.
ㅤ↳name*Name of the item.stringminLength: 3 maxLength: 128Example: pant/shirt
ㅤ↳codeCode of the item.stringminLength: 3 maxLength: 128
ㅤ↳cost*Cost of the item.
ㅤㅤ↳unitRepresents unit price of the item.
ㅤㅤㅤ↳amountThe value of the amount; accurate to three decimal places.number
ㅤㅤㅤ↳currencyCurrency of the price of the item.string
ㅤㅤ↳total*Represents total price of the item.
ㅤㅤㅤ↳amountThe value of the amount; accurate to three decimal places.number
ㅤㅤㅤ↳currencyCurrency of the price of the item.string
ㅤ↳quantity
ㅤㅤ↳valueA number quantifying measurement.integer
ㅤㅤ↳unitUnit for measurement.stringEnum: [cm, m, l, ml, nos, g, kg, mm]
callbackRepresents callback URL, which can be to notify status(success/failed) of API.object{url: "string", meta: "string"}
*This is required.
HTTP Status Code Summary
CodeDescription
202 - Accepted
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
503 - Server ErrorSomething went wrong.. (These are rare.)
PATH PARAMETERS
containerId
string
*
Example: container:9c9b1138-7cdd-11eb-9439-0242ac130002
Unique id of 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

X-COREOS-ORIGIN-TOKEN
string
App requesting for the attributes.
BODY PARAMETERS
body
ContainerUpdateRequest
*
Update container
name
string
*
Example: pant/shirt
Name of the item.
code
string
Code of the item.
cost
cost
*
cost of the item.
quantity
quantity
RESPONSES
202
Accepted
SuccessResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
Error Information
request
Request
401
Unauthorized
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
Fetch details of container
NEXT
Fetch container details based on the filters passed.
Docs powered by Archbee