{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateUpdateCarrierRequest",
"title": "Create/UpdateCarrierRequest",
"required": [
"id",
"slaType",
"name",
"scheduledDelivery",
"maxRangeDelivery",
"dayOfWeekForDelivery",
"dayOfWeekBlockeds",
"freightValue",
"factorCubicWeight",
"freightTableProcessStatus",
"freightTableValueError",
"modals",
"onlyItemsWithDefinedModal",
"deliveryOnWeekends",
"carrierSchedule",
"maxDimension",
"exclusiveToDeliveryPoints",
"minimunCubicWeight",
"isPolygon",
"numberOfItemsPerShipment"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slaType": {
"type": "string"
},
"name": {
"type": "string"
},
"scheduledDelivery": {
"type": "boolean"
},
"maxRangeDelivery": {
"type": "integer",
"format": "int32"
},
"dayOfWeekForDelivery": {
"type": "array",
"description": "Select the chosen days for delivery. Values for each day of the week are: 0 = sunday, 1 = monday, 2 = tuesday, 3 = wednesday, 4 = thursday, 5 = friday, 6 = saturday. Make sure to add the available hours for the chosen days, following the example.",
"nullable": true,
"items": {
"type": "object",
"required": [
"dayOfWeek",
"deliveryRanges"
],
"properties": {
"dayOfWeek": {
"type": "integer",
"description": "Day of the week, from `0` (sunday) to `6` (saturday).",
"example": 2
},
"deliveryRanges": {
"type": "array",
"description": "Reservation windows for scheduled delivery.",
"items": {
"type": "object",
"required": [
"startTime",
"endTime",
"listPrice"
],
"properties": {
"startTime": {
"type": "string",
"title": "startTime",
"description": "Start time for day of the week.",
"example": "11:00:00"
},
"endTime": {
"type": "string",
"description": "End time for day of the week.",
"example": "12:30:00"
},
"listPrice": {
"type": "number",
"description": "List price for day of the week.",
"example": 0
},
"deliveryCapacity": {
"type": "array",
"description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
"items": {
"type": "object",
"example": {
"capacityType": "ORDERS_QUANTITY",
"maxValue": 55
},
"required": [
"capacityType",
"maxValue"
],
"properties": {
"capacityType": {
"type": "string",
"description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
"example": "ORDERS_QUANTITY"
},
"maxValue": {
"type": "number",
"description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
"example": 0
}
}
}
}
}
}
}
}
}
},
"dayOfWeekBlockeds": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"freightValue": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"factorCubicWeight": {
"type": "string",
"nullable": true
},
"freightTableProcessStatus": {
"type": "integer",
"format": "int32"
},
"freightTableValueError": {
"type": "string",
"nullable": true
},
"modals": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"onlyItemsWithDefinedModal": {
"type": "boolean"
},
"deliveryOnWeekends": {
"type": "boolean"
},
"carrierSchedule": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"maxDimension": {
"title": "MaxDimension",
"required": [
"weight",
"height",
"width",
"length",
"maxSumDimension"
],
"type": "object",
"properties": {
"weight": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
},
"width": {
"type": "integer",
"format": "int32"
},
"length": {
"type": "integer",
"format": "int32"
},
"maxSumDimension": {
"type": "integer",
"format": "int32"
}
},
"example": {
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"maxSumDimension": 0
}
},
"exclusiveToDeliveryPoints": {
"type": "boolean"
},
"minimunCubicWeight": {
"type": "integer",
"format": "int32"
},
"isPolygon": {
"type": "boolean"
},
"numberOfItemsPerShipment": {
"type": "string",
"nullable": true
}
},
"example": {
"id": "13942e4",
"slaType": "Expressa",
"name": "Transportadora Expressa",
"scheduledDelivery": false,
"maxRangeDelivery": 0,
"dayOfWeekForDelivery": null,
"dayOfWeekBlockeds": [],
"freightValue": [],
"factorCubicWeight": null,
"freightTableProcessStatus": 1,
"freightTableValueError": null,
"modals": [],
"onlyItemsWithDefinedModal": false,
"deliveryOnWeekends": false,
"carrierSchedule": [],
"maxDimension": {
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"maxSumDimension": 0
},
"exclusiveToDeliveryPoints": false,
"minimunCubicWeight": 0,
"isPolygon": false,
"numberOfItemsPerShipment": null
}
}