VTEX · Schema

DeliveryIds

List of delivery IDs, used for orders where the marketplace is responsible for the fulfillment of the order, including keeping inventory at a warehouse as well as the delivery.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
warehouseId string String with the ID of the warehouse used for marketplace fulfillment. Required when `isFob` = `true` and `isMarketplaceFulfillment` = `true`.
View JSON Schema on GitHub

JSON Schema

vtex-deliveryids-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeliveryIds",
  "title": "DeliveryIds",
  "description": "List of delivery IDs, used for orders where the marketplace is responsible for the fulfillment of the order, including keeping inventory at a warehouse as well as the delivery.",
  "required": [
    "warehouseId"
  ],
  "type": "object",
  "properties": {
    "warehouseId": {
      "type": "string",
      "description": "String with the ID of the warehouse used for marketplace fulfillment. Required when `isFob` = `true` and `isMarketplaceFulfillment` = `true`.",
      "example": "AR1"
    }
  },
  "example": {
    "warehouseId": "AR1"
  }
}