put https://delhivery.preprod.fxtrt.io/core/api/v2/containers/
API to update the attributes of container.
PARAMETER | DESCRIPTION | TYPE | VALIDATION |
---|---|---|---|
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 * | string | minLength: 1 maxLength: 128 Example: 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: 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] |
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.) |