VTEX · Schema

DeliveryIdV2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
courierId string ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
warehouseId string ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
dockId string ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
courierName string Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
quantity integer Quantity of items.
kitItemDetails array
accountCarrierName string Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
View JSON Schema on GitHub

JSON Schema

vtex-deliveryidv2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeliveryIdV2",
  "title": "DeliveryIdV2",
  "required": [
    "courierId",
    "warehouseId",
    "dockId",
    "courierName",
    "quantity",
    "kitItemDetails",
    "accountCarrierName"
  ],
  "type": "object",
  "properties": {
    "courierId": {
      "type": "string",
      "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
      "example": "136769c"
    },
    "warehouseId": {
      "type": "string",
      "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).",
      "example": "w_156"
    },
    "dockId": {
      "type": "string",
      "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).",
      "example": "ld931"
    },
    "courierName": {
      "type": "string",
      "description": "Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
      "example": "Crossborder"
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of items.",
      "example": 1
    },
    "kitItemDetails": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.",
        "example": null,
        "nullable": true
      }
    },
    "accountCarrierName": {
      "type": "string",
      "nullable": true,
      "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).",
      "example": "vtexlog"
    }
  },
  "example": {
    "courierId": "1c083bf",
    "warehouseId": "1_1",
    "dockId": "1",
    "courierName": "Donkey",
    "quantity": 1,
    "kitItemDetails": [],
    "accountCarrierName": null
  }
}