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:
| 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: 16 minLength: 3 maxLength: 64 |
ㅤ↳not | List of container types not allowed as parent of this container type. | string | minItems: 1 maxItems: 16 minLength: 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.) |
Handling Callbacks
Learn about handling callbacks here