Perform update operation on container in batches

1min

PUT
API to update Container in batch via JSON payload.
PARAMETERDESCRIPTIONTYPEVALIDATION
payloadArray of container update request.
ㅤ↳containerIdunique identifier of each container.string
ㅤ↳dataAttributes that define a container and can be modified after container creation.
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*Tracking ID.stringminLength: 1 maxLength: 128example: 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.booleandefault: false
ㅤ↳attributesA map to provide values for the attributes defined in Container-type configuration APIs.
ㅤ↳itemsList of items can be added into container only if container-type is a leaf.
 | ㅤㅤ↳`name`* | Name of the item. | string | **minLength**: 3 **maxLength**: 128<br>**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. | string | A valid URL |
| 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
CodeDescription
| **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.) |
Path Parameters
containerType
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
X-COREOS-ORIGIN-TOKEN
string
Body Parameters
body
ContainerUpdateBatchRequest
*
Description
update batch request for container type
payload
ContainerBatchUpdate[]
callback
BatchCallbackURL
Responses
202
Accepted
BatchSuccessResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
request
Request
401
Unauthorized
ErrorResponse
error
Error
request
Request
503
Server Error
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerType}/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": [
    {
      "containerId": ""
    }
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerType}/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": [
    {
      "containerId": ""
    }
  ]
}'
Responses
202
400
401
503
// Accepted 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Accepted 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

PARAMETER	DESCRIPTION	TYPE	VALIDATION
`payload`	Array of container update request.
ㅤ↳`containerId`	unique identifier of each container.	string
ㅤ↳`data`	Attributes that define a container and can be modified after container creation.
`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`*	Tracking ID.	string	minLength: 1 maxLength: 128example: 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 container only if container-type is a leaf.

Updated 24 Aug 2023

Did this page help you?

Create container in batches

Get the status of batch request