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
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
X-COREOS-ORIGIN-TOKEN
string
App requesting for the attributes.
BODY PARAMETERS
body
ContainerCreateRequest
*
Create new 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
﻿
﻿

PARAMETER	DESCRIPTION	TYPE	VALIDATION
`containerType`*	Container type defined using container type configuration APIs.	string	pattern: It should match a through z or A through Z, inclusive (range).minLength: 3 maxLength: 64Example: bag
`trackingDetails`	Field 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.	string	minLength: 3 maxLength: 64Example: Delhivery
ㅤ↳`trackingId`*		string	minLength: 1 maxLength: 128Example: 132121232423232
ㅤ↳`isPrimary`	It defines whether it is a primary tracking ID or not. If not defined we assume first tracking ID as primary tracking ID.	boolean	Default: false
`attributes`	A map to provide values for the attributes defined in Container-type configuration APIs.
`items`	List of items can be added into a container only if the container-type is a leaf.
ㅤ↳`name`*	Name of the item.	string	minLength: 3 maxLength: 128Example: pant/shirt
ㅤ↳`code`	Code of the item.	string	minLength: 3 maxLength: 128
ㅤ↳`cost`*	Cost of the item.
ㅤㅤ↳`unit`	Represents unit price of the item.
ㅤㅤㅤ↳`amount`	The value of the amount; accurate to three decimal places.	number
ㅤㅤㅤ↳`currency`	Currency of the price of the item.	string
ㅤㅤ↳`total`*	Represents total price of the item.
ㅤㅤㅤ↳`amount`	The value of the amount; accurate to three decimal places.	number
ㅤㅤㅤ↳`currency`	Currency of the price of the item.	string
ㅤ↳`quantity`
ㅤㅤ↳`value`	A number quantifying measurement.	integer
ㅤㅤ↳`unit`	Unit for measurement.	string	Enum: [cm, m, l, ml, nos, g, kg, mm]
`isHazmat`	Represents whether this container can contain hazardous materials or not.	boolean	Default: false
`isContainerizable`	Defines whether container can be put into other containers or not.	boolean	Default: true
`callback`	Represents callback URL, which can be to notify status(success/failed) of API.	object	{url: "string", meta: "string"}
*This is required.

HTTP Status Code Summary

Code	Description
202 - Accepted
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
503 - Server Error	Something went wrong.. (These are rare.)

Updated 24 Aug 2023

Did this page help you?

API to get list of orphan event codes (not associated with any reason code).

Fetch details of container