Create a new container type

1min

POST
A container can be a bag or box or pallet etc. These different type of containers are known as container-types. Important: 
- Container types once created cannot be deleted. 
- Once the Container type is created, its name and isLeaf property cannot be changed.

Asynchronous API for creating a new Container Type by specifying the following parameters in the request body:
PARAMETERDESCRIPTIONTYPEVALIDATION
name*A unique name that represents a container of this container type.stringpattern: It should match a through z or A through Z, inclusive (range).minLength: 3 maxLength: 64
isLeafDefines whether this container-type will have actual physical items or not. Such types of containers are termed as leaf containers.booleandefault: false
allowedParentRules defining the allowed container types as parent of a container type.
ㅤ↳oneOfList of container types allowed as parent of this container type.stringminItems: 1 maxItems: 16minLength: 3 maxLength: 64
ㅤ↳notList of container types not allowed as parent of this container type.stringminItems: 1 maxItems: 16minLength: 3 maxLength: 64
callbackRepresents callback URL, which can be to notify status(success/failed) of API.object{url: "string", meta: {}}
*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.
404 - Not FoundThe requested resource doesn't exist.
503 - Server ErrorSomething went wrong. (These are rare.)
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
ContainerTypeCreateRequest
*
Description
Create new container type
name
string
*
isLeaf
boolean
allowedParent
ContainerTypeAllowedParent
Responses
202
Accepted
SuccessResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
request
Request
401
Unauthorized
ErrorResponse
error
Error
request
Request
404
Not Found
ErrorResponse
error
Error
request
Request
503
Server Error
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/container-types' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{}}'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/container-types' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"body":{}}'
Responses
202
400
401
404
503
// Accepted 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Accepted 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

PARAMETER	DESCRIPTION	TYPE	VALIDATION
`name`*	A unique name that represents a container of this container type.	string	pattern: It should match a through z or A through Z, inclusive (range).minLength: 3 maxLength: 64
`isLeaf`	Defines whether this container-type will have actual physical items or not. Such types of containers are termed as leaf containers.	boolean	default: false
`allowedParent`	Rules defining the allowed container types as parent of a container type.
ㅤ↳`oneOf`	List of container types allowed as parent of this container type.	string	minItems: 1 maxItems: 16minLength: 3 maxLength: 64
ㅤ↳`not`	List of container types not allowed as parent of this container type.	string	minItems: 1 maxItems: 16minLength: 3 maxLength: 64
`callback`	Represents callback URL, which can be to notify status(success/failed) of API.	object	{url: "string", meta: {}}
*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.
404 - Not Found	The requested resource doesn't exist.
503 - Server Error	Something went wrong. (These are rare.)

Updated 24 Aug 2023

Did this page help you?

Onboard a tenant

Fetch container type details based on the filters passed