VTEX · Schema
DeliveryId
Information about delivery IDs.
CommerceE-CommerceRetailMarketplacePayments
Properties
| Name | Type | Description |
|---|---|---|
| courierId | string | [Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID. |
| courierName | string | Carrier's name. |
| dockId | string | ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj). |
| quantity | integer | Quantity of items. |
| warehouseId | string | ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). |
| accountCarrierName | string | Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE). |
| kitItemDetails | array | Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DeliveryId",
"title": "DeliveryId",
"description": "Information about delivery IDs.",
"required": [
"courierId",
"courierName",
"dockId",
"quantity",
"warehouseId",
"accountCarrierName",
"kitItemDetails"
],
"type": "object",
"properties": {
"courierId": {
"type": "string",
"description": "[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID."
},
"courierName": {
"type": "string",
"description": "Carrier's name."
},
"dockId": {
"type": "string",
"description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj)."
},
"quantity": {
"type": "integer",
"description": "Quantity of items."
},
"warehouseId": {
"type": "string",
"description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)."
},
"accountCarrierName": {
"type": "string",
"description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)."
},
"kitItemDetails": {
"type": "array",
"description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"example": {
"courierId": "197a56f",
"courierName": "Todos os CEPS",
"dockId": "1",
"quantity": 1,
"warehouseId": "1_1",
"accountCarrierName": "recorrenciaqa",
"kitItemDetails": []
}
}