Container Service
Container

Create a container

1min
POST

API to create a new container of a particular containerType(given in request):

PARAMETERDESCRIPTIONTYPEVALIDATION
containerType*Container type defined using container type configuration APIs.stringpattern: It should match a through z or A through Z, inclusive (range).minLength: 3 maxLength: 64Example: bag
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.
ㅤ↳operator*Field 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]
isHazmatRepresents whether this container can contain hazardous materials or not.booleanDefault: false
isContainerizableDefines whether container can be put into other containers or not.booleanDefault: true
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
*
Header Parameters
X-COREOS-REQUEST-ID
*
X-COREOS-TID
*
X-COREOS-ACCESS
*
X-COREOS-CALLBACK-SECRET
X-COREOS-USERINFO
X-COREOS-ORIGIN-TOKEN
Body Parameters
body
*
Description
Create new container
name
*
code
cost
*
quantity
Responses
202
Accepted
data
request
400
Bad Request
error
request
401
Unauthorized
error
request
503
Server Error
error
request
Curl
JS
Ruby
Python
Responses
202
400
401
503