VTEX · Schema

CreateReservationRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
salesChannel string
lockId string
autorizationExpirationTTL string
deliveryItemOptions array
View JSON Schema on GitHub

JSON Schema

vtex-createreservationrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateReservationRequest",
  "title": "CreateReservationRequest",
  "required": [
    "salesChannel",
    "lockId",
    "autorizationExpirationTTL",
    "deliveryItemOptions"
  ],
  "type": "object",
  "properties": {
    "salesChannel": {
      "type": "string"
    },
    "lockId": {
      "type": "string",
      "nullable": true
    },
    "autorizationExpirationTTL": {
      "type": "string"
    },
    "deliveryItemOptions": {
      "type": "array",
      "items": {
        "title": "DeliveryItemOption",
        "required": [
          "item",
          "slaType",
          "slaTypeName",
          "listPrice",
          "promotionalPrice",
          "transitTime",
          "dockTime",
          "timeToDockPlusDockTime",
          "aditionalTimeBlockedDays",
          "totalTime",
          "deliveryWindows",
          "wareHouseId",
          "dockId",
          "location"
        ],
        "type": "object",
        "properties": {
          "item": {
            "title": "Item",
            "required": [
              "id",
              "groupItemId",
              "kitItem",
              "quantity",
              "price",
              "additionalHandlingTime",
              "dimension"
            ],
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "groupItemId": {
                "type": "string",
                "nullable": true
              },
              "kitItem": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": ""
              },
              "quantity": {
                "type": "integer",
                "format": "int32"
              },
              "price": {
                "type": "integer",
                "format": "int32"
              },
              "additionalHandlingTime": {
                "type": "string"
              },
              "dimension": {
                "title": "Dimension",
                "required": [
                  "weight",
                  "height",
                  "width",
                  "length"
                ],
                "type": "object",
                "properties": {
                  "weight": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "height": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "width": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "length": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "example": {
                  "weight": 150,
                  "height": 1,
                  "width": 1,
                  "length": 1
                }
              }
            },
            "example": {
              "id": "2390059",
              "groupItemId": null,
              "kitItem": [],
              "quantity": 1,
              "price": 0,
              "additionalHandlingTime": "00:00:00",
              "dimension": {
                "weight": 150,
                "height": 1,
                "width": 1,
                "length": 1
              }
            }
          },
          "slaType": {
            "type": "string"
          },
          "slaTypeName": {
            "type": "string"
          },
          "listPrice": {
            "type": "number"
          },
          "promotionalPrice": {
            "type": "number"
          },
          "transitTime": {
            "type": "string"
          },
          "dockTime": {
            "type": "string"
          },
          "timeToDockPlusDockTime": {
            "type": "string"
          },
          "aditionalTimeBlockedDays": {
            "type": "string"
          },
          "totalTime": {
            "type": "string"
          },
          "deliveryWindows": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": ""
          },
          "wareHouseId": {
            "type": "string",
            "nullable": true
          },
          "dockId": {
            "type": "string"
          },
          "location": {
            "title": "Location",
            "required": [
              "zipCode",
              "country",
              "inStore"
            ],
            "type": "object",
            "properties": {
              "zipCode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              },
              "inStore": {
                "title": "InStore",
                "required": [
                  "IsCheckedIn",
                  "StoreId"
                ],
                "type": "object",
                "properties": {
                  "IsCheckedIn": {
                    "type": "boolean"
                  },
                  "StoreId": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "example": {
                  "IsCheckedIn": false,
                  "StoreId": null
                }
              }
            },
            "example": {
              "zipCode": "22220070",
              "country": "BRA",
              "inStore": {
                "IsCheckedIn": false,
                "StoreId": null
              }
            }
          }
        },
        "example": {
          "item": {
            "id": "2390059",
            "groupItemId": null,
            "kitItem": [],
            "quantity": 1,
            "price": 0,
            "additionalHandlingTime": "00:00:00",
            "dimension": {
              "weight": 150,
              "height": 1,
              "width": 1,
              "length": 1
            }
          },
          "slaType": "Expressa",
          "slaTypeName": "Expressa",
          "listPrice": 10.5,
          "promotionalPrice": 10.5,
          "transitTime": "2.00:00:00",
          "dockTime": "00:00:00",
          "timeToDockPlusDockTime": "1.00:00:00",
          "aditionalTimeBlockedDays": "00:00:00",
          "totalTime": "3.00:00:00",
          "deliveryWindows": [],
          "wareHouseId": null,
          "dockId": "1a8bce3",
          "location": {
            "zipCode": "22220070",
            "country": "BRA",
            "inStore": {
              "IsCheckedIn": false,
              "StoreId": null
            }
          }
        }
      },
      "description": ""
    }
  },
  "example": {
    "salesChannel": "1",
    "lockId": null,
    "autorizationExpirationTTL": "00:10:00",
    "deliveryItemOptions": [
      {
        "item": {
          "id": "2390059",
          "groupItemId": null,
          "kitItem": [],
          "quantity": 1,
          "price": 0,
          "additionalHandlingTime": "00:00:00",
          "dimension": {
            "weight": 150,
            "height": 1,
            "width": 1,
            "length": 1
          }
        },
        "slaType": "Expressa",
        "slaTypeName": "Expressa",
        "listPrice": 10.5,
        "promotionalPrice": 10.5,
        "transitTime": "2.00:00:00",
        "dockTime": "00:00:00",
        "timeToDockPlusDockTime": "1.00:00:00",
        "aditionalTimeBlockedDays": "00:00:00",
        "totalTime": "3.00:00:00",
        "deliveryWindows": [],
        "wareHouseId": null,
        "dockId": "1a8bce3",
        "location": {
          "zipCode": "22220070",
          "country": "BRA",
          "inStore": {
            "IsCheckedIn": false,
            "StoreId": null
          }
        }
      }
    ]
  }
}