# Models

## The ActualDeliveryWindows object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"ActualDeliveryWindows":{"title":"Collection of actual delivery windows","type":"array","items":{"$ref":"#/components/schemas/ActualDeliveryWindow"}},"ActualDeliveryWindow":{"title":"Actual delivery window","description":"Delivery window is a range of times when the shipment can be delivered to the customers.","type":"object","properties":{"id":{"description":"Delivery window’s unique identifier.","type":"string"},"deliveryDate":{"description":"Delivery date compliant with the ISO 8601 standard.","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/TimeRange"},"deliveryCycle":{"description":"Delivery cycle.","type":"string"},"zoneId":{"description":"Delivery zone’s unique identifier.","type":"string"},"deliveryMethod":{"description":"Delivery method name.","type":"string"},"cutOffTime":{"description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. Date is compliant with the ISO 8601 standard.","type":"string"},"slotId":{"description":"Delivery time slot's unique identifier.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetaData"}},"required":["deliveryDate"]},"TimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"startTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"endTime":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["startTime","endTime"]},"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The Patch object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Patch":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","description":"Indicates an operation which should be done. Available operations: `add`, `remove` and `replace`"},"path":{"type":"string","description":"Indicates a path for which the value should be applied. For example: `/shippingMethod`, `/cutOffTime/day`"},"value":{"description":"Indicates a value that should be changed or added. The value can be of a primitive type, like string, number, boolean or it can be an object or an array.","oneOf":[{"type":"string"},{"type":"object"}]}}}}}}}
```

## The ActualDeliveryWindow object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"ActualDeliveryWindow":{"title":"Actual delivery window","description":"Delivery window is a range of times when the shipment can be delivered to the customers.","type":"object","properties":{"id":{"description":"Delivery window’s unique identifier.","type":"string"},"deliveryDate":{"description":"Delivery date compliant with the ISO 8601 standard.","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/TimeRange"},"deliveryCycle":{"description":"Delivery cycle.","type":"string"},"zoneId":{"description":"Delivery zone’s unique identifier.","type":"string"},"deliveryMethod":{"description":"Delivery method name.","type":"string"},"cutOffTime":{"description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. Date is compliant with the ISO 8601 standard.","type":"string"},"slotId":{"description":"Delivery time slot's unique identifier.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetaData"}},"required":["deliveryDate"]},"TimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"startTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"endTime":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["startTime","endTime"]},"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The BasicDeliveryTime object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"BasicDeliveryTime":{"title":"Delivery Time","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time ID: Autogenerated (if not provided in request) or User-Defined"},"name":{"type":"string","description":"Optional name for Delivery Time"},"siteCode":{"type":"string","description":"Site code for which the Delivery Time is assigned"},"isDeliveryDay":{"type":"boolean","description":"`true` indicates that the Delivery Time holds delivery date information, whereas `false` represents that the Delivery Time configuration has disabled delivery for a specific date or time period."},"zoneId":{"type":"string","description":"ID of the delivery zone for which the Delivery Time is valid"},"day":{"$ref":"#/components/schemas/DeliveryDay"},"slots":{"type":"array","description":"This attribute holds information about the established timeslots and cut-off times that are set up for a specific Delivery Time","items":{"$ref":"#/components/schemas/SlotCreation"}},"isForAllZones":{"type":"boolean","description":"Flag which indicates if the non-delivery time is defined for the same day, period or weekday for all zones of the site"},"timeZoneId":{"type":"string","description":"Id of the time zone for which the Delivery Time should be created (e.g. Europe/Warsaw)."},"deliveryDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time."}},"required":["siteCode","isDeliveryDay","day","timeZoneId"]},"DeliveryDay":{"title":"Delivery Day","type":"object","description":"This attribute holds the time configuration for which the Delivery Time is valid. Only a single attribute can be set at any given moment.","properties":{"weekday":{"description":"Enum containing names of weekdays, possible values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`","type":"string"},"singleDate":{"type":"string","description":"Date for which the delivery time is valid, compliant with the ISO 8601 standard. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z)."},"datePeriod":{"type":"object","description":"Date period for which the Delivery Time is valid. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z).","properties":{"dateFrom":{"type":"string","description":"Date from which the delivery time is valid, compliant with the ISO 8601 standard."},"dateTo":{"type":"string","description":"Date to which the delivery time is valid, compliant with the ISO 8601 standard."}},"required":["dateFrom","dateTo"]}}},"SlotCreation":{"title":"Slot","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time Slot ID: Autogenerated (if not provided in request) or User-Defined"},"shippingMethod":{"description":"Selected shipping method which is available for the Delivery Time in the given Time Slot","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/DeliveryTimeRange"},"cutOffTime":{"$ref":"#/components/schemas/CutOffTIme"},"capacity":{"type":"integer","description":"A capacity determines how many orders the given Delivery Time Slot can handle"}},"required":["shippingMethod","deliveryTimeRange","cutOffTime","capacity"]},"DeliveryTimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"timeFrom":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"timeTo":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["timeFrom","timeTo"]},"CutOffTIme":{"title":"Cut-Off Time","description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. This attribute is key in determining the end of a time window for certain operations and helps maintain efficiency in the delivery process.","type":"object","properties":{"time":{"type":"string","description":"The cut-off time refers to the deadline by which an order must be placed to be eligible for same-day processing and shipping. Date is compliant with the ISO 8601 standard, but only time is taking into account."},"cutOffDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time. Property is only available for delivery times of weekday type."},"deliveryCycleName":{"type":"string","description":"An optional suffix that is added to delivery cycle name"}},"required":["time"]}}}}
```

## The DeliveryTime object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"DeliveryTime":{"title":"Delivery Time","description":"","type":"object","allOf":[{"$ref":"#/components/schemas/BasicDeliveryTime"},{"properties":{"metadata":{"$ref":"#/components/schemas/MetaData"}}}]},"BasicDeliveryTime":{"title":"Delivery Time","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time ID: Autogenerated (if not provided in request) or User-Defined"},"name":{"type":"string","description":"Optional name for Delivery Time"},"siteCode":{"type":"string","description":"Site code for which the Delivery Time is assigned"},"isDeliveryDay":{"type":"boolean","description":"`true` indicates that the Delivery Time holds delivery date information, whereas `false` represents that the Delivery Time configuration has disabled delivery for a specific date or time period."},"zoneId":{"type":"string","description":"ID of the delivery zone for which the Delivery Time is valid"},"day":{"$ref":"#/components/schemas/DeliveryDay"},"slots":{"type":"array","description":"This attribute holds information about the established timeslots and cut-off times that are set up for a specific Delivery Time","items":{"$ref":"#/components/schemas/SlotCreation"}},"isForAllZones":{"type":"boolean","description":"Flag which indicates if the non-delivery time is defined for the same day, period or weekday for all zones of the site"},"timeZoneId":{"type":"string","description":"Id of the time zone for which the Delivery Time should be created (e.g. Europe/Warsaw)."},"deliveryDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time."}},"required":["siteCode","isDeliveryDay","day","timeZoneId"]},"DeliveryDay":{"title":"Delivery Day","type":"object","description":"This attribute holds the time configuration for which the Delivery Time is valid. Only a single attribute can be set at any given moment.","properties":{"weekday":{"description":"Enum containing names of weekdays, possible values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`","type":"string"},"singleDate":{"type":"string","description":"Date for which the delivery time is valid, compliant with the ISO 8601 standard. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z)."},"datePeriod":{"type":"object","description":"Date period for which the Delivery Time is valid. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z).","properties":{"dateFrom":{"type":"string","description":"Date from which the delivery time is valid, compliant with the ISO 8601 standard."},"dateTo":{"type":"string","description":"Date to which the delivery time is valid, compliant with the ISO 8601 standard."}},"required":["dateFrom","dateTo"]}}},"SlotCreation":{"title":"Slot","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time Slot ID: Autogenerated (if not provided in request) or User-Defined"},"shippingMethod":{"description":"Selected shipping method which is available for the Delivery Time in the given Time Slot","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/DeliveryTimeRange"},"cutOffTime":{"$ref":"#/components/schemas/CutOffTIme"},"capacity":{"type":"integer","description":"A capacity determines how many orders the given Delivery Time Slot can handle"}},"required":["shippingMethod","deliveryTimeRange","cutOffTime","capacity"]},"DeliveryTimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"timeFrom":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"timeTo":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["timeFrom","timeTo"]},"CutOffTIme":{"title":"Cut-Off Time","description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. This attribute is key in determining the end of a time window for certain operations and helps maintain efficiency in the delivery process.","type":"object","properties":{"time":{"type":"string","description":"The cut-off time refers to the deadline by which an order must be placed to be eligible for same-day processing and shipping. Date is compliant with the ISO 8601 standard, but only time is taking into account."},"cutOffDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time. Property is only available for delivery times of weekday type."},"deliveryCycleName":{"type":"string","description":"An optional suffix that is added to delivery cycle name"}},"required":["time"]},"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The UpdateDeliveryTime object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"UpdateDeliveryTime":{"title":"Delivery Time","description":"","type":"object","allOf":[{"$ref":"#/components/schemas/BasicDeliveryTime"},{"properties":{"metadata":{"type":"object","description":"metadata of the document","properties":{"version":{"type":"number","description":"version of the document"}},"required":["version"]}}}]},"BasicDeliveryTime":{"title":"Delivery Time","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time ID: Autogenerated (if not provided in request) or User-Defined"},"name":{"type":"string","description":"Optional name for Delivery Time"},"siteCode":{"type":"string","description":"Site code for which the Delivery Time is assigned"},"isDeliveryDay":{"type":"boolean","description":"`true` indicates that the Delivery Time holds delivery date information, whereas `false` represents that the Delivery Time configuration has disabled delivery for a specific date or time period."},"zoneId":{"type":"string","description":"ID of the delivery zone for which the Delivery Time is valid"},"day":{"$ref":"#/components/schemas/DeliveryDay"},"slots":{"type":"array","description":"This attribute holds information about the established timeslots and cut-off times that are set up for a specific Delivery Time","items":{"$ref":"#/components/schemas/SlotCreation"}},"isForAllZones":{"type":"boolean","description":"Flag which indicates if the non-delivery time is defined for the same day, period or weekday for all zones of the site"},"timeZoneId":{"type":"string","description":"Id of the time zone for which the Delivery Time should be created (e.g. Europe/Warsaw)."},"deliveryDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time."}},"required":["siteCode","isDeliveryDay","day","timeZoneId"]},"DeliveryDay":{"title":"Delivery Day","type":"object","description":"This attribute holds the time configuration for which the Delivery Time is valid. Only a single attribute can be set at any given moment.","properties":{"weekday":{"description":"Enum containing names of weekdays, possible values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`","type":"string"},"singleDate":{"type":"string","description":"Date for which the delivery time is valid, compliant with the ISO 8601 standard. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z)."},"datePeriod":{"type":"object","description":"Date period for which the Delivery Time is valid. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z).","properties":{"dateFrom":{"type":"string","description":"Date from which the delivery time is valid, compliant with the ISO 8601 standard."},"dateTo":{"type":"string","description":"Date to which the delivery time is valid, compliant with the ISO 8601 standard."}},"required":["dateFrom","dateTo"]}}},"SlotCreation":{"title":"Slot","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time Slot ID: Autogenerated (if not provided in request) or User-Defined"},"shippingMethod":{"description":"Selected shipping method which is available for the Delivery Time in the given Time Slot","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/DeliveryTimeRange"},"cutOffTime":{"$ref":"#/components/schemas/CutOffTIme"},"capacity":{"type":"integer","description":"A capacity determines how many orders the given Delivery Time Slot can handle"}},"required":["shippingMethod","deliveryTimeRange","cutOffTime","capacity"]},"DeliveryTimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"timeFrom":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"timeTo":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["timeFrom","timeTo"]},"CutOffTIme":{"title":"Cut-Off Time","description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. This attribute is key in determining the end of a time window for certain operations and helps maintain efficiency in the delivery process.","type":"object","properties":{"time":{"type":"string","description":"The cut-off time refers to the deadline by which an order must be placed to be eligible for same-day processing and shipping. Date is compliant with the ISO 8601 standard, but only time is taking into account."},"cutOffDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time. Property is only available for delivery times of weekday type."},"deliveryCycleName":{"type":"string","description":"An optional suffix that is added to delivery cycle name"}},"required":["time"]}}}}
```

## The SlotCreation object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"SlotCreation":{"title":"Slot","description":"","type":"object","properties":{"id":{"type":"string","description":"Delivery Time Slot ID: Autogenerated (if not provided in request) or User-Defined"},"shippingMethod":{"description":"Selected shipping method which is available for the Delivery Time in the given Time Slot","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/DeliveryTimeRange"},"cutOffTime":{"$ref":"#/components/schemas/CutOffTIme"},"capacity":{"type":"integer","description":"A capacity determines how many orders the given Delivery Time Slot can handle"}},"required":["shippingMethod","deliveryTimeRange","cutOffTime","capacity"]},"DeliveryTimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"timeFrom":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"timeTo":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["timeFrom","timeTo"]},"CutOffTIme":{"title":"Cut-Off Time","description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. This attribute is key in determining the end of a time window for certain operations and helps maintain efficiency in the delivery process.","type":"object","properties":{"time":{"type":"string","description":"The cut-off time refers to the deadline by which an order must be placed to be eligible for same-day processing and shipping. Date is compliant with the ISO 8601 standard, but only time is taking into account."},"cutOffDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time. Property is only available for delivery times of weekday type."},"deliveryCycleName":{"type":"string","description":"An optional suffix that is added to delivery cycle name"}},"required":["time"]}}}}
```

## The DeliveryCycle object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"DeliveryCycle":{"title":"Delivery Cycle","type":"object","description":"Object which encapsulates all the fields needed to generate delivery cycle.","properties":{"deliveryTimeId":{"type":"string","description":"A unique identifier for the overall delivery time period or range."},"slotId":{"type":"string","description":"A unique identifier that represents a specific delivery slot within the delivery time."},"deliveryDate":{"type":"string","description":"The selected delivery date."}},"required":["deliveryTimeId","slotId","deliveryDate"]}}}}
```

## The DeliveryDay object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"DeliveryDay":{"title":"Delivery Day","type":"object","description":"This attribute holds the time configuration for which the Delivery Time is valid. Only a single attribute can be set at any given moment.","properties":{"weekday":{"description":"Enum containing names of weekdays, possible values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`","type":"string"},"singleDate":{"type":"string","description":"Date for which the delivery time is valid, compliant with the ISO 8601 standard. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z)."},"datePeriod":{"type":"object","description":"Date period for which the Delivery Time is valid. Dates should be provided at 12:00:00 local time and send in ISO 8601 standard (e.g. For Europe/Warsaw timezone, the 10:00 should be sent - 2023-06-12T10:00:00.000Z).","properties":{"dateFrom":{"type":"string","description":"Date from which the delivery time is valid, compliant with the ISO 8601 standard."},"dateTo":{"type":"string","description":"Date to which the delivery time is valid, compliant with the ISO 8601 standard."}},"required":["dateFrom","dateTo"]}}}}}}
```

## The CutOffTIme object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"CutOffTIme":{"title":"Cut-Off Time","description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. This attribute is key in determining the end of a time window for certain operations and helps maintain efficiency in the delivery process.","type":"object","properties":{"time":{"type":"string","description":"The cut-off time refers to the deadline by which an order must be placed to be eligible for same-day processing and shipping. Date is compliant with the ISO 8601 standard, but only time is taking into account."},"cutOffDayShift":{"type":"integer","minimum":0,"default":0,"description":"Indicates in how many days the order has been delivered when the order has been completed before cut-off time. Property is only available for delivery times of weekday type."},"deliveryCycleName":{"type":"string","description":"An optional suffix that is added to delivery cycle name"}},"required":["time"]}}}}
```

## The TimeRange object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"TimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"startTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"endTime":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["startTime","endTime"]}}}}
```

## The DeliveryTimeRange object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"DeliveryTimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"timeFrom":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"timeTo":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["timeFrom","timeTo"]}}}}
```

## The MetaData object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The Sites object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Sites":{"title":"Collection of sites.","type":"array","items":{"$ref":"#/components/schemas/Site"},"description":""},"Site":{"title":"Site","description":"A site is a specific virtual or real shop.","type":"object","properties":{"id":{"description":"Site unique identifier.","type":"string"},"defaultZoneId":{"description":"Default shippingzone’s unique identifier. A shipping zone is an area where shipments can be delivered.","type":"string"},"zones":{"type":"array","items":{"$ref":"#/components/schemas/ZoneWithActualDeliveryWindows"}},"metadata":{"$ref":"#/components/schemas/MetaData"}}},"ZoneWithActualDeliveryWindows":{"type":"object","allOf":[{"$ref":"#/components/schemas/Zone"},{"type":"object","properties":{"actualDeliveryWindows":{"$ref":"#/components/schemas/ActualDeliveryWindows"}}}]},"Zone":{"title":"Zone","description":"The zone is an area where shipments can be delivered.","type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"default":{"description":"Flag indicating whether the zone is the default delivery zone for the site.","type":"boolean"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"shipTo":{"$ref":"#/components/schemas/ShipTo"},"methods":{"$ref":"#/components/schemas/Methods"}},"required":["id","name","shipTo"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"ShipTo":{"title":"ShipTo","description":"Collection of shipping destinations","type":"array","items":{"$ref":"#/components/schemas/ShipToItem"}},"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]},"Methods":{"title":"Collection of shipping methods","type":"array","items":{"$ref":"#/components/schemas/Method"}},"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]},"ActualDeliveryWindows":{"title":"Collection of actual delivery windows","type":"array","items":{"$ref":"#/components/schemas/ActualDeliveryWindow"}},"ActualDeliveryWindow":{"title":"Actual delivery window","description":"Delivery window is a range of times when the shipment can be delivered to the customers.","type":"object","properties":{"id":{"description":"Delivery window’s unique identifier.","type":"string"},"deliveryDate":{"description":"Delivery date compliant with the ISO 8601 standard.","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/TimeRange"},"deliveryCycle":{"description":"Delivery cycle.","type":"string"},"zoneId":{"description":"Delivery zone’s unique identifier.","type":"string"},"deliveryMethod":{"description":"Delivery method name.","type":"string"},"cutOffTime":{"description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. Date is compliant with the ISO 8601 standard.","type":"string"},"slotId":{"description":"Delivery time slot's unique identifier.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetaData"}},"required":["deliveryDate"]},"TimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"startTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"endTime":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["startTime","endTime"]},"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The Site object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Site":{"title":"Site","description":"A site is a specific virtual or real shop.","type":"object","properties":{"id":{"description":"Site unique identifier.","type":"string"},"defaultZoneId":{"description":"Default shippingzone’s unique identifier. A shipping zone is an area where shipments can be delivered.","type":"string"},"zones":{"type":"array","items":{"$ref":"#/components/schemas/ZoneWithActualDeliveryWindows"}},"metadata":{"$ref":"#/components/schemas/MetaData"}}},"ZoneWithActualDeliveryWindows":{"type":"object","allOf":[{"$ref":"#/components/schemas/Zone"},{"type":"object","properties":{"actualDeliveryWindows":{"$ref":"#/components/schemas/ActualDeliveryWindows"}}}]},"Zone":{"title":"Zone","description":"The zone is an area where shipments can be delivered.","type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"default":{"description":"Flag indicating whether the zone is the default delivery zone for the site.","type":"boolean"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"shipTo":{"$ref":"#/components/schemas/ShipTo"},"methods":{"$ref":"#/components/schemas/Methods"}},"required":["id","name","shipTo"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"ShipTo":{"title":"ShipTo","description":"Collection of shipping destinations","type":"array","items":{"$ref":"#/components/schemas/ShipToItem"}},"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]},"Methods":{"title":"Collection of shipping methods","type":"array","items":{"$ref":"#/components/schemas/Method"}},"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]},"ActualDeliveryWindows":{"title":"Collection of actual delivery windows","type":"array","items":{"$ref":"#/components/schemas/ActualDeliveryWindow"}},"ActualDeliveryWindow":{"title":"Actual delivery window","description":"Delivery window is a range of times when the shipment can be delivered to the customers.","type":"object","properties":{"id":{"description":"Delivery window’s unique identifier.","type":"string"},"deliveryDate":{"description":"Delivery date compliant with the ISO 8601 standard.","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/TimeRange"},"deliveryCycle":{"description":"Delivery cycle.","type":"string"},"zoneId":{"description":"Delivery zone’s unique identifier.","type":"string"},"deliveryMethod":{"description":"Delivery method name.","type":"string"},"cutOffTime":{"description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. Date is compliant with the ISO 8601 standard.","type":"string"},"slotId":{"description":"Delivery time slot's unique identifier.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetaData"}},"required":["deliveryDate"]},"TimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"startTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"endTime":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["startTime","endTime"]},"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The Zones object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Zones":{"title":"Collection of zones","type":"array","items":{"$ref":"#/components/schemas/Zone"}},"Zone":{"title":"Zone","description":"The zone is an area where shipments can be delivered.","type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"default":{"description":"Flag indicating whether the zone is the default delivery zone for the site.","type":"boolean"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"shipTo":{"$ref":"#/components/schemas/ShipTo"},"methods":{"$ref":"#/components/schemas/Methods"}},"required":["id","name","shipTo"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"ShipTo":{"title":"ShipTo","description":"Collection of shipping destinations","type":"array","items":{"$ref":"#/components/schemas/ShipToItem"}},"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]},"Methods":{"title":"Collection of shipping methods","type":"array","items":{"$ref":"#/components/schemas/Method"}},"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]}}}}
```

## The Zone object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Zone":{"title":"Zone","description":"The zone is an area where shipments can be delivered.","type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"default":{"description":"Flag indicating whether the zone is the default delivery zone for the site.","type":"boolean"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"shipTo":{"$ref":"#/components/schemas/ShipTo"},"methods":{"$ref":"#/components/schemas/Methods"}},"required":["id","name","shipTo"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"ShipTo":{"title":"ShipTo","description":"Collection of shipping destinations","type":"array","items":{"$ref":"#/components/schemas/ShipToItem"}},"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]},"Methods":{"title":"Collection of shipping methods","type":"array","items":{"$ref":"#/components/schemas/Method"}},"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]}}}}
```

## The ZoneWithActualDeliveryWindows object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"ZoneWithActualDeliveryWindows":{"type":"object","allOf":[{"$ref":"#/components/schemas/Zone"},{"type":"object","properties":{"actualDeliveryWindows":{"$ref":"#/components/schemas/ActualDeliveryWindows"}}}]},"Zone":{"title":"Zone","description":"The zone is an area where shipments can be delivered.","type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"default":{"description":"Flag indicating whether the zone is the default delivery zone for the site.","type":"boolean"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"shipTo":{"$ref":"#/components/schemas/ShipTo"},"methods":{"$ref":"#/components/schemas/Methods"}},"required":["id","name","shipTo"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"ShipTo":{"title":"ShipTo","description":"Collection of shipping destinations","type":"array","items":{"$ref":"#/components/schemas/ShipToItem"}},"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]},"Methods":{"title":"Collection of shipping methods","type":"array","items":{"$ref":"#/components/schemas/Method"}},"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]},"ActualDeliveryWindows":{"title":"Collection of actual delivery windows","type":"array","items":{"$ref":"#/components/schemas/ActualDeliveryWindow"}},"ActualDeliveryWindow":{"title":"Actual delivery window","description":"Delivery window is a range of times when the shipment can be delivered to the customers.","type":"object","properties":{"id":{"description":"Delivery window’s unique identifier.","type":"string"},"deliveryDate":{"description":"Delivery date compliant with the ISO 8601 standard.","type":"string"},"deliveryTimeRange":{"$ref":"#/components/schemas/TimeRange"},"deliveryCycle":{"description":"Delivery cycle.","type":"string"},"zoneId":{"description":"Delivery zone’s unique identifier.","type":"string"},"deliveryMethod":{"description":"Delivery method name.","type":"string"},"cutOffTime":{"description":"This denotes the latest point in time by which an action (such as an order or request) must be completed for a specific Delivery Time. Date is compliant with the ISO 8601 standard.","type":"string"},"slotId":{"description":"Delivery time slot's unique identifier.","type":"string"},"metadata":{"$ref":"#/components/schemas/MetaData"}},"required":["deliveryDate"]},"TimeRange":{"title":"Time range","description":"A `from` to `to` time range for which the object is valid","type":"object","properties":{"startTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time from which the object is valid, provided in local time (e.g. 10:00)"},"endTime":{"pattern":"^(2[0-4]|[01]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Time to which the object is valid, provided in local time (e.g. 10:00)."}},"required":["startTime","endTime"]},"MetaData":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 format.","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?$"},"version":{"minimum":1,"type":"integer"}}}}}}
```

## The ResourceCreatedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"ResourceCreatedResponse":{"title":"Resource created","description":"Link to created resource with unique resource identifier.","type":"object","properties":{"id":{"type":"string","description":"Created resource’s unique identifier."}}}}}}
```

## The Methods object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Methods":{"title":"Collection of shipping methods","type":"array","items":{"$ref":"#/components/schemas/Method"}},"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]}}}}
```

## The Method object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Method":{"title":"Shipping method","description":"Shipping methods define the types of deliveries and properties such as delivery fees.","type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"maxOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"active":{"description":"Flag indicating whether the shipping method is active.","type":"boolean"},"fees":{"$ref":"#/components/schemas/Fees"},"shippingTaxCode":{"description":"Shipping method's tax code.","type":"string"},"shippingGroupId":{"description":"Shipping groups unique identifier.","type":"string"}},"required":["id","name","fees"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]},"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]}}}}
```

## The Fees object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Fees":{"title":"Collection of fees","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The Fee object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Fee":{"title":"Fee","description":"Fee is a shipping cost for a given shipping method and parameters.","type":"object","properties":{"cost":{"$ref":"#/components/schemas/MonetaryAmount"},"minOrderValue":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingGroupId":{"description":"Shipping group unique identifier.","type":"string"}},"required":["cost","minOrderValue"]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The MonetaryAmount object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The FindSiteRequest object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"FindSiteRequest":{"title":"Find site request payload","description":"Payload with parameters for price finding.","type":"object","properties":{"postalCode":{"type":"string","description":"Postal code containing numbers and/or letters."},"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."}},"required":["postalCode"]}}}}
```

## The ShipTo object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"ShipTo":{"title":"ShipTo","description":"Collection of shipping destinations","type":"array","items":{"$ref":"#/components/schemas/ShipToItem"}},"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]}}}}
```

## The ShipToItem object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"ShipToItem":{"title":"shipToItem","description":"Shipping destination containing country and postal code.","type":"object","properties":{"country":{"type":"string","description":"ISO2 or ISO3 formatted country code."},"postalCode":{"type":"string","description":"PostalCode containing numbers and/or letters. Can be incomplete and followed by single '*' to match all the postalCodes starting with the same numbers/letters."}},"required":["country"]}}}}
```

## The QuotePayload object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"QuotePayload":{"title":"Quote request payload","description":"Example of payload for shipping cost calculation.","type":"object","properties":{"customerId":{"description":"Customer unique identifier.","type":"string"},"cartTotal":{"description":"Total amount for the given cart.","type":"object","required":["amount","currency"],"properties":{"amount":{"description":"Amount in specified currency.","type":"number","minimum":0},"currency":{"type":"string","description":"Three-letter currency code, compliant with the ISO 4217 standard.","pattern":"[A-Z]{3}"}}},"shipFromAddress":{"$ref":"#/components/schemas/Address"},"shipToAddress":{"$ref":"#/components/schemas/Address"}},"required":["cartTotal","shipToAddress"]},"Address":{"title":"Address","description":"Address of billing or delivery that contains customer or company name and location including street, street number, zipcode, and country.","type":"object","properties":{"street":{"description":"Name of the street.","type":"string"},"streetNumber":{"type":"string"},"extraLine1":{"type":"string"},"extraLine2":{"type":"string"},"extraLine3":{"type":"string"},"extraLine4":{"type":"string"},"zipCode":{"maxLength":9,"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"}},"required":["zipCode","country"]}}}}
```

## The QuoteSlot object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"QuoteSlot":{"title":"Quote slot request schema","description":"Example of payload for shipping cost calculation.","type":"object","properties":{"customerId":{"description":"Customer unique identifier.","type":"string"},"cartTotal":{"description":"Total amount for the given cart.","type":"object","required":["amount","currency"],"properties":{"amount":{"description":"Amount in specified currency.","type":"number","minimum":0},"currency":{"type":"string","description":"Three-letter currency code, compliant with the ISO 4217 standard.","pattern":"[A-Z]{3}"}}},"shipFromAddress":{"$ref":"#/components/schemas/Address"},"shipToAddress":{"$ref":"#/components/schemas/Address"},"slotId":{"type":"string","description":"The `slotId`` which the quote should be calculated for."},"deliveryWindowId":{"type":"string","description":"The delivery window id which the slot with selected shipping method exists for."}},"required":["cartTotal","slotId","deliveryWindowId"]},"Address":{"title":"Address","description":"Address of billing or delivery that contains customer or company name and location including street, street number, zipcode, and country.","type":"object","properties":{"street":{"description":"Name of the street.","type":"string"},"streetNumber":{"type":"string"},"extraLine1":{"type":"string"},"extraLine2":{"type":"string"},"extraLine3":{"type":"string"},"extraLine4":{"type":"string"},"zipCode":{"maxLength":9,"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"}},"required":["zipCode","country"]}}}}
```

## The Address object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Address":{"title":"Address","description":"Address of billing or delivery that contains customer or company name and location including street, street number, zipcode, and country.","type":"object","properties":{"street":{"description":"Name of the street.","type":"string"},"streetNumber":{"type":"string"},"extraLine1":{"type":"string"},"extraLine2":{"type":"string"},"extraLine3":{"type":"string"},"extraLine4":{"type":"string"},"zipCode":{"maxLength":9,"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"}},"required":["zipCode","country"]}}}}
```

## The QuoteResponse object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"QuoteResponse":{"title":"Quote response","description":"Example quote response which contains a list of fees for various methods and delivery zone.","type":"array","items":{"$ref":"#/components/schemas/QuoteResponseItem"}},"QuoteResponseItem":{"title":"Quote response item","type":"object","description":"Example quote response which contains fee for specific method and zone.","properties":{"zone":{"type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"}}},"methods":{"type":"array","items":{"$ref":"#/components/schemas/QuoteResponseMethods"}}}},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"QuoteResponseMethods":{"title":"Quote response shipping methods","type":"object","description":"Example quote response which contains fee for specific method.","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"fee":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingTaxCode":{"type":"string"}}},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The QuoteResponseItem object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"QuoteResponseItem":{"title":"Quote response item","type":"object","description":"Example quote response which contains fee for specific method and zone.","properties":{"zone":{"type":"object","properties":{"id":{"description":"Delivery zone's unique identifier.","type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"}}},"methods":{"type":"array","items":{"$ref":"#/components/schemas/QuoteResponseMethods"}}}},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"QuoteResponseMethods":{"title":"Quote response shipping methods","type":"object","description":"Example quote response which contains fee for specific method.","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"fee":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingTaxCode":{"type":"string"}}},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The QuoteResponseMethods object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"QuoteResponseMethods":{"title":"Quote response shipping methods","type":"object","description":"Example quote response which contains fee for specific method.","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedValue"},"fee":{"$ref":"#/components/schemas/MonetaryAmount"},"shippingTaxCode":{"type":"string"}}},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The LocalizedValue object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]}}}}
```

## The MinimumFee object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"MinimumFee":{"title":"Minimum fee","type":"object","description":"Minimum available delivery fee for given parameters.","properties":{"fee":{"$ref":"#/components/schemas/MonetaryAmount"}}},"MonetaryAmount":{"title":"Monetary amount","description":"Amount of money in a given currency.","type":"object","properties":{"currency":{"description":"Three-letter currency code, compliant with the ISO 4217 standard.","type":"string"},"amount":{"type":"number","minimum":0,"description":"Amount in specified currency."}},"required":["currency","amount"]}}}}
```

## The Group object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"Group":{"title":"Group","type":"object","description":"Shipping groups can be used for customer grouping with use customer group relations.","properties":{"id":{"description":"Delivery group unique identifier.","type":"string"},"description":{"$ref":"#/components/schemas/LocalizedValue"}},"required":["id"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]}}}}
```

## The GroupList object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"GroupList":{"title":"Collection of groups","description":"Collection of shipping groups.","type":"array","items":{"$ref":"#/components/schemas/Group"}},"Group":{"title":"Group","type":"object","description":"Shipping groups can be used for customer grouping with use customer group relations.","properties":{"id":{"description":"Delivery group unique identifier.","type":"string"},"description":{"$ref":"#/components/schemas/LocalizedValue"}},"required":["id"]},"LocalizedValue":{"oneOf":[{"type":"string","description":"String value in the specified language."},{"type":"object","additionalProperties":{"type":"string"},"description":"Map of translations in form of language:translation pairs.\nThe keys (languages) should be ISO language codes."}]}}}}
```

## The CGRelation object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"CGRelation":{"title":"Customer-group relation","description":"Customer-group relation allows to assign user for specific group.","type":"object","properties":{"customerId":{"description":"Customer unique identifier.","type":"string"},"groupId":{"description":"Group's unique identifier.","type":"string"}}}}}}
```

## The CGRelationList object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"CGRelationList":{"title":"Collection of customer-group relation","type":"array","items":{"$ref":"#/components/schemas/CGRelation"}},"CGRelation":{"title":"Customer-group relation","description":"Customer-group relation allows to assign user for specific group.","type":"object","properties":{"customerId":{"description":"Customer unique identifier.","type":"string"},"groupId":{"description":"Group's unique identifier.","type":"string"}}}}}}
```

## The DeliveryWindowValidationDto object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"DeliveryWindowValidationDto":{"title":"DeliveryWindowValidationDto","type":"object","properties":{"deliveryWindowId":{"type":"string","description":"The selected delivery window"},"deliveryDate":{"type":"string","description":"The selected delivery date"},"slotId":{"type":"string","description":"The slot that was selected for the delivery."}},"required":["deliveryWindowId","deliveryDate"]}}}}
```

## The errorMessage object

```json
{"openapi":"3.0.0","info":{"title":"Shipping Service","version":"0.0.1"},"components":{"schemas":{"errorMessage":{"title":"error","description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"moreInfo":{"type":"string","description":"link to documentation to investigate further and finding support"},"errorCode":{"type":"string","description":"The error code which specify the problem"},"details":{"description":"list of problems causing this error","type":"array","items":{"title":"errorDetail","description":"schema for specific error cause","anyOf":[{"type":"string"},{"type":"object","properties":{"field":{"description":"a bean notation expression specifying the element in request data causing the error, eg shipTo[0].country, this can be empty if violation was not field specific","type":"string"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.","type":"string"},"message":{"description":"descriptive error detail message for debugging","type":"string"},"moreInfo":{"type":"string","description":"link to documentation to investigate further and finding support for error detail"}}}]}}},"required":["status","type"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.emporix.io/api-references/api-guides/delivery-and-shipping/shipping-1/api-reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.