VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
LastUpdateDateUtc string
SalesChannel string
LockId string
ReservationDateUtc string
MaximumConfirmationDateUtc string
Status integer
SlaRequest array
PickupPointItemOptions string
CanceledDateUtc string
AuthorizedDateUtc string
ConfirmedDateUtc string
Errors array
IsSucess boolean
View JSON Schema on GitHub

JSON Schema

vtex-createreservation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateReservation",
  "title": "",
  "required": [
    "LastUpdateDateUtc",
    "SalesChannel",
    "LockId",
    "ReservationDateUtc",
    "MaximumConfirmationDateUtc",
    "Status",
    "SlaRequest",
    "PickupPointItemOptions",
    "CanceledDateUtc",
    "AuthorizedDateUtc",
    "ConfirmedDateUtc",
    "Errors",
    "IsSucess"
  ],
  "type": "object",
  "properties": {
    "LastUpdateDateUtc": {
      "type": "string"
    },
    "SalesChannel": {
      "type": "string"
    },
    "LockId": {
      "type": "string"
    },
    "ReservationDateUtc": {
      "type": "string"
    },
    "MaximumConfirmationDateUtc": {
      "type": "string"
    },
    "Status": {
      "type": "integer",
      "format": "int32"
    },
    "SlaRequest": {
      "type": "array",
      "items": {
        "title": "SlaRequest",
        "required": [
          "item",
          "slaType",
          "slaTypeName",
          "freightTableName",
          "freightTableId",
          "listPrice",
          "promotionalPrice",
          "transitTime",
          "dockTime",
          "timeToDockPlusDockTime",
          "totalTime",
          "deliveryWindows",
          "wareHouseId",
          "dockId",
          "wmsEndPoint",
          "location",
          "pickupStoreInfo"
        ],
        "type": "object",
        "properties": {
          "item": {
            "title": "Item1",
            "required": [
              "id",
              "groupItemId",
              "quantity",
              "price",
              "modal",
              "additionalHandlingTime",
              "dimension",
              "kitItem",
              "unlimitedQuantity"
            ],
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "groupItemId": {
                "type": "string",
                "nullable": true
              },
              "quantity": {
                "type": "integer",
                "format": "int32"
              },
              "price": {
                "type": "number"
              },
              "modal": {
                "type": "string",
                "nullable": true
              },
              "additionalHandlingTime": {
                "type": "string"
              },
              "dimension": {
                "title": "Dimension1",
                "required": [
                  "weight",
                  "height",
                  "width",
                  "length",
                  "maxSumDimension"
                ],
                "type": "object",
                "properties": {
                  "weight": {
                    "type": "number"
                  },
                  "height": {
                    "type": "number"
                  },
                  "width": {
                    "type": "number"
                  },
                  "length": {
                    "type": "number"
                  },
                  "maxSumDimension": {
                    "type": "number"
                  }
                },
                "example": {
                  "weight": 800,
                  "height": 10,
                  "width": 12,
                  "length": 35,
                  "maxSumDimension": 0
                }
              },
              "kitItem": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": ""
              },
              "unlimitedQuantity": {
                "type": "boolean"
              }
            },
            "example": {
              "id": "2390059",
              "groupItemId": null,
              "quantity": 1,
              "price": 0,
              "modal": null,
              "additionalHandlingTime": "00:00:00",
              "dimension": {
                "weight": 800,
                "height": 10,
                "width": 12,
                "length": 35,
                "maxSumDimension": 0
              },
              "kitItem": [],
              "unlimitedQuantity": false
            }
          },
          "slaType": {
            "type": "string"
          },
          "slaTypeName": {
            "type": "string"
          },
          "freightTableName": {
            "type": "string"
          },
          "freightTableId": {
            "type": "string"
          },
          "listPrice": {
            "type": "number"
          },
          "promotionalPrice": {
            "type": "number"
          },
          "transitTime": {
            "type": "string"
          },
          "dockTime": {
            "type": "string"
          },
          "timeToDockPlusDockTime": {
            "type": "string"
          },
          "totalTime": {
            "type": "string"
          },
          "deliveryWindows": {
            "type": "string",
            "nullable": true
          },
          "wareHouseId": {
            "type": "string"
          },
          "dockId": {
            "type": "string"
          },
          "wmsEndPoint": {
            "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"
              }
            }
          },
          "pickupStoreInfo": {
            "type": "string",
            "nullable": true
          }
        },
        "example": {
          "item": {
            "id": "2390059",
            "groupItemId": null,
            "quantity": 1,
            "price": 0,
            "modal": null,
            "additionalHandlingTime": "00:00:00",
            "dimension": {
              "weight": 800,
              "height": 10,
              "width": 12,
              "length": 35,
              "maxSumDimension": 0
            },
            "kitItem": [],
            "unlimitedQuantity": false
          },
          "slaType": "Normal",
          "slaTypeName": "Normal",
          "freightTableName": "Correios PAC",
          "freightTableId": "11cc4b6",
          "listPrice": 10.5,
          "promotionalPrice": 10.5,
          "transitTime": "2.00:00:00",
          "dockTime": "00:00:00",
          "timeToDockPlusDockTime": "1.00:00:00",
          "totalTime": "3.00:00:00",
          "deliveryWindows": null,
          "wareHouseId": "1937054",
          "dockId": "1_1_1",
          "wmsEndPoint": "",
          "location": {
            "zipCode": "22220070",
            "country": "BRA",
            "deliveryPointId": null,
            "point": null,
            "inStore": {
              "IsCheckedIn": false,
              "StoreId": "180082"
            }
          },
          "pickupStoreInfo": null
        }
      },
      "description": ""
    },
    "PickupPointItemOptions": {
      "type": "string",
      "nullable": true
    },
    "CanceledDateUtc": {
      "type": "string"
    },
    "AuthorizedDateUtc": {
      "type": "string"
    },
    "ConfirmedDateUtc": {
      "type": "string"
    },
    "Errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "IsSucess": {
      "type": "boolean"
    }
  },
  "example": {
    "LastUpdateDateUtc": "2016-04-15T19:59:20.0397988+00:00",
    "SalesChannel": "2",
    "LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
    "ReservationDateUtc": "2016-04-15T19:59:20.0397988+00:00",
    "MaximumConfirmationDateUtc": "2016-04-15T20:09:20.0397988+00:00",
    "Status": 1,
    "SlaRequest": [
      {
        "item": {
          "id": "2390059",
          "groupItemId": null,
          "quantity": 1,
          "price": 0,
          "modal": null,
          "additionalHandlingTime": "00:00:00",
          "dimension": {
            "weight": 800,
            "height": 10,
            "width": 12,
            "length": 35,
            "maxSumDimension": 0
          },
          "kitItem": [],
          "unlimitedQuantity": false
        },
        "slaType": "Normal",
        "slaTypeName": "Normal",
        "freightTableName": "Correios PAC",
        "freightTableId": "11cc4b6",
        "listPrice": 10.5,
        "promotionalPrice": 10.5,
        "transitTime": "2.00:00:00",
        "dockTime": "00:00:00",
        "timeToDockPlusDockTime": "1.00:00:00",
        "totalTime": "3.00:00:00",
        "deliveryWindows": null,
        "wareHouseId": "1937054",
        "dockId": "1_1_1",
        "wmsEndPoint": "",
        "location": {
          "zipCode": "22220070",
          "country": "BRA",
          "deliveryPointId": null,
          "point": null,
          "inStore": {
            "IsCheckedIn": false,
            "StoreId": "180082"
          }
        },
        "pickupStoreInfo": null
      }
    ],
    "PickupPointItemOptions": null,
    "CanceledDateUtc": "0001-01-01T00:00:00+00:00",
    "AuthorizedDateUtc": "2016-04-15T19:59:20.0397988+00:00",
    "ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
    "Errors": [],
    "IsSucess": true
  }
}