API to create Container in batch via JSON payload for a container type.
| PARAMETER | DESCRIPTION | TYPE | VALIDATION |
| - | - | - | - |
| payload
| Array of container creation request. | | maxItems: 1024 minItems: 1 |
| ㅤ↳refID
| Reference ID received for each container create request. | string |
| 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: 64
example: Delhivery |
| ㅤㅤ↳trackingId
| Tracking ID. | string | minLength: 1 maxLength: 128
example: 132121232423232 |
| ㅤㅤ↳isPrimary
| It defines whether it is a primary tracking ID or not. If none of the tracking details is set as primary we assume first tracking ID as a 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: 128
example: 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 containers 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: {}} |
This is required.
HTTP Status Code Summary
Code | Description |
---|---|
202 - Accepted | Everything worked as expected. |
400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 - Unauthorized | No valid API key provided. |
503 - Server Errors | Something went wrong on our end. (These are rare.) |