VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
itemId string
quantity integer
availabilityQuantity integer
salesChannel string
slaType string
slaTypeName string
freightTableName string
freightTableId string
listPrice number
transitTime string
dockTime string
timeToDockPlusDockTime string
aditionalTimeBlockedDays string
totalTime string
deliveryWindows array
wareHouseId string
dockId string
location object
deliveryOnWeekends boolean
carrierSchedule array
restrictedFreight string
coordinates string
pickupStoreInfo string
View JSON Schema on GitHub

JSON Schema

vtex-listreservationbywarehouseandsku-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListReservationByWarehouseAndSKU",
  "title": "",
  "required": [
    "itemId",
    "quantity",
    "availabilityQuantity",
    "salesChannel",
    "slaType",
    "slaTypeName",
    "freightTableName",
    "freightTableId",
    "listPrice",
    "transitTime",
    "dockTime",
    "timeToDockPlusDockTime",
    "aditionalTimeBlockedDays",
    "totalTime",
    "deliveryWindows",
    "wareHouseId",
    "dockId",
    "location",
    "deliveryOnWeekends",
    "carrierSchedule",
    "restrictedFreight",
    "coordinates",
    "pickupStoreInfo"
  ],
  "type": "object",
  "properties": {
    "itemId": {
      "type": "string"
    },
    "quantity": {
      "type": "integer",
      "format": "int32"
    },
    "availabilityQuantity": {
      "type": "integer",
      "format": "int32"
    },
    "salesChannel": {
      "type": "string"
    },
    "slaType": {
      "type": "string"
    },
    "slaTypeName": {
      "type": "string"
    },
    "freightTableName": {
      "type": "string"
    },
    "freightTableId": {
      "type": "string"
    },
    "listPrice": {
      "type": "number"
    },
    "transitTime": {
      "type": "string"
    },
    "dockTime": {
      "type": "string"
    },
    "timeToDockPlusDockTime": {
      "type": "string"
    },
    "aditionalTimeBlockedDays": {
      "type": "string"
    },
    "totalTime": {
      "type": "string"
    },
    "deliveryWindows": {
      "type": "array",
      "items": {
        "title": "DeliveryWindow",
        "type": "object",
        "properties": {
          "startDateUtc": {
            "type": "string"
          },
          "endDateUtc": {
            "type": "string"
          },
          "listPrice": {
            "type": "number"
          }
        },
        "example": {
          "startDateUtc": "2016-04-20T08:00:00+00:00",
          "endDateUtc": "2016-04-20T12:00:00+00:00",
          "listPrice": 10
        }
      },
      "description": ""
    },
    "wareHouseId": {
      "type": "string"
    },
    "dockId": {
      "type": "string"
    },
    "location": {
      "title": "Location1",
      "required": [
        "zipCode",
        "country",
        "deliveryPointId",
        "point",
        "inStore"
      ],
      "type": "object",
      "properties": {
        "zipCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "deliveryPointId": {
          "type": "string",
          "nullable": true
        },
        "point": {
          "type": "string",
          "nullable": true
        },
        "inStore": {
          "title": "InStore1",
          "required": [
            "IsCheckedIn",
            "StoreId"
          ],
          "type": "object",
          "properties": {
            "IsCheckedIn": {
              "type": "boolean"
            },
            "StoreId": {
              "type": "string"
            }
          },
          "example": {
            "IsCheckedIn": false,
            "StoreId": "180082"
          }
        }
      },
      "example": {
        "zipCode": "22220070",
        "country": "BRA",
        "deliveryPointId": null,
        "point": null,
        "inStore": {
          "IsCheckedIn": false,
          "StoreId": "180082"
        }
      }
    },
    "deliveryOnWeekends": {
      "type": "boolean"
    },
    "carrierSchedule": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "restrictedFreight": {
      "type": "string",
      "nullable": true
    },
    "coordinates": {
      "type": "string",
      "nullable": true
    },
    "pickupStoreInfo": {
      "type": "string",
      "nullable": true
    }
  },
  "example": {
    "itemId": "2389945",
    "quantity": 1,
    "availabilityQuantity": 500,
    "salesChannel": "1",
    "slaType": "Entrega Agendada",
    "slaTypeName": "Entrega Agendada",
    "freightTableName": "Entrega Agendada",
    "freightTableId": "teste1",
    "listPrice": 5.25,
    "transitTime": "2.00:00:00",
    "dockTime": "00:00:00",
    "timeToDockPlusDockTime": "1.00:00:00",
    "aditionalTimeBlockedDays": "00:00:00",
    "totalTime": "3.00:00:00",
    "deliveryWindows": [
      {
        "startDateUtc": "2016-04-20T08:00:00+00:00",
        "endDateUtc": "2016-04-20T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-20T12:01:00+00:00",
        "endDateUtc": "2016-04-20T18:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-21T08:00:00+00:00",
        "endDateUtc": "2016-04-21T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-21T12:01:00+00:00",
        "endDateUtc": "2016-04-21T18:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-22T08:00:00+00:00",
        "endDateUtc": "2016-04-22T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-22T12:01:00+00:00",
        "endDateUtc": "2016-04-22T18:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-23T08:00:00+00:00",
        "endDateUtc": "2016-04-23T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-23T12:01:00+00:00",
        "endDateUtc": "2016-04-23T18:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-24T08:00:00+00:00",
        "endDateUtc": "2016-04-24T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-24T12:01:00+00:00",
        "endDateUtc": "2016-04-24T18:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-25T08:00:00+00:00",
        "endDateUtc": "2016-04-25T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-25T12:01:00+00:00",
        "endDateUtc": "2016-04-25T18:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-26T08:00:00+00:00",
        "endDateUtc": "2016-04-26T12:00:00+00:00",
        "listPrice": 10
      },
      {
        "startDateUtc": "2016-04-26T12:01:00+00:00",
        "endDateUtc": "2016-04-26T18:00:00+00:00",
        "listPrice": 10
      }
    ],
    "wareHouseId": "1937054",
    "dockId": "1_1_1",
    "location": {
      "zipCode": "22220070",
      "country": "BRA",
      "deliveryPointId": null,
      "point": null,
      "inStore": {
        "IsCheckedIn": false,
        "StoreId": "180082"
      }
    },
    "deliveryOnWeekends": false,
    "carrierSchedule": [],
    "restrictedFreight": null,
    "coordinates": null,
    "pickupStoreInfo": null
  }
}