{ "openapi": "3.0.1", "info": { "title": "CPL", "description": "**Changelog**\r\n\r\n* 2024-08-22 - SPRJ-13791 - validace PRTE / PRBC externích čísel - nelze použít najednou\r\n - /shipment/batch\r\n\r\n* 2024-07-01 - SPRJ-13838 - přidání\r\n - /customer/address\r\n\r\n* 2023-11-23 - SPRJ-12703 - CPL - /shipment - timestamp\r\n - /shipment - Rozšíření výstupu o LastUpdateDate.\r\n\r\n* 2023-07-13 - SPRJ-11888 - přidání\r\n - /codelist/status - číselník statusů\r\n\r\n* 2023-07-13 - SPRJ-11953 - přidání\r\n - /order/cancel - storno objednávky\r\n", "version": "v1" }, "paths": { "/accessPoint": { "get": { "tags": [ "AccessPoint" ], "summary": "Seznam výdejních míst", "parameters": [ { "name": "AccessPointCode", "in": "query", "description": "Kód Výdejního místa", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "description": "kód země viz. /codelist/country", "schema": { "type": "string" } }, { "name": "ZipCode", "in": "query", "description": "PSČ", "schema": { "type": "string" } }, { "name": "City", "in": "query", "description": "Město", "schema": { "type": "string" } }, { "name": "AccessPointTypes", "in": "query", "description": "Typ výdejního místa", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.ConstMyApi2AccessPointType" } } }, { "name": "Radius", "in": "query", "description": "Rádius (km)", "schema": { "type": "integer", "format": "int32" } }, { "name": "Latitude", "in": "query", "description": "GPS souřanice", "schema": { "type": "number", "format": "double" } }, { "name": "Longitude", "in": "query", "description": "GPS souřanice", "schema": { "type": "number", "format": "double" } }, { "name": "TribalServicePoint", "in": "query", "description": "Kmenové výdejní místo", "schema": { "type": "boolean" } }, { "name": "ActiveCardPayment", "in": "query", "description": "Možnost platby kartou", "schema": { "type": "boolean" } }, { "name": "ActiveCashPayment", "in": "query", "description": "Možnost platby v hotovosti", "schema": { "type": "boolean" } }, { "name": "PickupEnabled", "in": "query", "description": "Možnost podání zásilky", "schema": { "type": "boolean" } }, { "name": "Sizes", "in": "query", "description": "Maximální hodnoty velikosti balíku: S,M,L,XL", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "405": { "description": "MethodNotAllowed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/addressWhisper": { "get": { "tags": [ "AddressWhisper" ], "summary": "Našeptávač adres", "parameters": [ { "name": "Street", "in": "query", "description": "Street", "schema": { "type": "string" } }, { "name": "ZipCode", "in": "query", "description": "Zip code", "schema": { "type": "string" } }, { "name": "City", "in": "query", "description": "City", "schema": { "type": "string" } }, { "name": "CalledFrom", "in": "query", "description": "Whispering from street / zip code / city text box", "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AddressWhisper.CalledFrom" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AddressWhisper.AddressWhispModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AddressWhisper.AddressWhispModel" } } } } }, "304": { "description": "Not Modified", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "405": { "description": "MethodNotAllowed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/ageCheck": { "get": { "tags": [ "Codelist" ], "summary": "Číselník pro službu kontrola věku příjemce", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.AgeCheckTypeModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.AgeCheckTypeModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/product": { "get": { "tags": [ "Codelist" ], "summary": "Číselník produktů", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentProductType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentProductType" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/externalNumber": { "get": { "tags": [ "Codelist" ], "summary": "Číselník typu externích čísel", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentExternalNumberTypeModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentExternalNumberTypeModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/country": { "get": { "tags": [ "Codelist" ], "summary": "Číselník zemí + povolení COD", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.CountryModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.CountryModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/currency": { "get": { "tags": [ "Codelist" ], "summary": "Číselník povolených měn", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.CurrencyModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.CurrencyModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/service": { "get": { "tags": [ "Codelist" ], "summary": "Metoda pro získání poskytovaných služeb k zásilkám. Vyskytuje se u shipment/batch nebo /shipment", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentServiceModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentServiceModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/servicePriceLimit": { "get": { "tags": [ "Codelist" ], "summary": "Metoda pro získání minimálních a maximálních hodnot u služeb", "parameters": [ { "name": "Service", "in": "query", "description": "Service code", "schema": { "type": "string" } }, { "name": "Currency", "in": "query", "description": "Currency code", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "description": "Country code", "schema": { "type": "string" } }, { "name": "Product", "in": "query", "description": "Product code", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ServicePriceLimitModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ServicePriceLimitModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/shipmentPhase": { "get": { "tags": [ "Codelist" ], "summary": "Fáze zásilky", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentPhaseModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ShipmentPhaseModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/status": { "get": { "tags": [ "Codelist" ], "summary": "Statusy zásilky /shipment", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.StatusModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.StatusModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/validationMessage": { "get": { "tags": [ "Codelist" ], "summary": "Chybové hlášení.", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ValidationMessageModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ValidationMessageModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/codelist/proofOfIdentityType": { "get": { "tags": [ "Codelist" ], "summary": "Typy osobních dokladů", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ProofOfIdentityTypeModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.ProofOfIdentityTypeModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/customer": { "get": { "tags": [ "Customer" ], "summary": "Informace k zákazníkovi – povolené měny", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Customer.CustomerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Customer.CustomerModel" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/customer/address": { "get": { "tags": [ "Customer" ], "summary": "Zákazníkovy adresy", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Customer.AddressModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Customer.AddressModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/data/{dataGuid}": { "get": { "tags": [ "Data" ], "summary": "Metoda pro stažení štítku.", "operationId": "GetData", "parameters": [ { "name": "dataGuid", "in": "path", "description": "The requested data reference", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/info": { "get": { "tags": [ "Info" ], "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.InfoModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.InfoModel" } } } }, "304": { "description": "Not Modified", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/order": { "get": { "tags": [ "Order" ], "summary": "Sledování stavu objednávek", "parameters": [ { "name": "ShipmentNumbers", "in": "query", "description": "Číslo/čísla balíků", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "CustomerReferences", "in": "query", "description": "Reference odesílatele", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "OrderReferences", "in": "query", "description": "Reference objednávky", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "OrderNumbers", "in": "query", "description": "Číslo objednávky", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "OrderIds", "in": "query", "description": "ID objednávky", "schema": { "maxItems": 50, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "DateFrom", "in": "query", "description": "Datum od", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "description": "Datum do", "schema": { "type": "string", "format": "date-time" } }, { "name": "SendDate", "in": "query", "description": "Datum odeslání", "schema": { "type": "string", "format": "date-time" } }, { "name": "ProductType", "in": "query", "description": "Typ produktu", "schema": { "type": "string" } }, { "name": "OrderStates", "in": "query", "description": "Stav objednávky", "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Enum.OrderStates" } }, { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Order.OrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Order.OrderModel" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/order/batch": { "post": { "tags": [ "OrderBatch" ], "summary": "Slouží k vytvoření objednávky. Odpověď je v header (Location)", "operationId": "CreateOrders", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "requestBody": { "description": "The request data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "Location": { "description": "Newly created entity location", "schema": { "type": "string" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/order/batch/{batchId}": { "get": { "tags": [ "OrderBatch" ], "summary": "BatchId z předchozí metody. Odpovědí je informace o úspěšném vygenerování objednávky.", "operationId": "GetOrderBatch", "parameters": [ { "name": "batchId", "in": "path", "description": "The batch id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.OrderBatchResultModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.OrderBatchResultModel" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/order/cancel": { "post": { "tags": [ "OrderEvent" ], "summary": "Zrušení objednání svozu nebo balíku z libovolné adresy", "parameters": [ { "name": "customerReference", "in": "query", "description": "Reference odesílatele", "schema": { "type": "string" } }, { "name": "orderReference", "in": "query", "description": "Reference objednávky", "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "requestBody": { "description": "Event detail", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/shipment": { "get": { "tags": [ "Shipment" ], "summary": "Slouží k získání informací (trackingu) k zásilce", "parameters": [ { "name": "ShipmentNumbers", "in": "query", "description": "ShipmentNumbers", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "InvoiceNumbers", "in": "query", "description": "InvoiceNumbers", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "CustomerReferences", "in": "query", "description": "CustomerReferences", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "VariableSymbols", "in": "query", "description": "VariableSymbols", "schema": { "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "DateFrom", "in": "query", "description": "DateFrom", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "description": "DateTo", "schema": { "type": "string", "format": "date-time" } }, { "name": "ShipmentStates", "in": "query", "description": "ShipmentStates", "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentStates" } }, { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/shipment/batch": { "post": { "tags": [ "ShipmentBatch" ], "summary": "Slouží k vytvoření zásilky. Odpověď je v header (Location)", "operationId": "CreateShipments", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "requestBody": { "description": "The request data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } }, "shipments": [ { "referenceId": "27c92d31-2a18-4fc3-a388-bee64edfdafb", "productType": "BUSS", "sender": { "street": "Novoveská 1262/95", "city": "Ostrava", "zipCode": "70900", "country": "CZ", "phone": "+420777888999", "email": "sender@email.cz" }, "recipient": { "street": "Františka a Anny Ryšových 1168", "city": "Ostrava-Svinov", "zipCode": "72100", "country": "CZ", "phone": "+420666777888", "email": "recipient@email.cz" } } ], "shipmentsOrderBy": "ShipmentNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } }, "shipments": [ { "referenceId": "27c92d31-2a18-4fc3-a388-bee64edfdafb", "productType": "BUSS", "sender": { "street": "Novoveská 1262/95", "city": "Ostrava", "zipCode": "70900", "country": "CZ", "phone": "+420777888999", "email": "sender@email.cz" }, "recipient": { "street": "Františka a Anny Ryšových 1168", "city": "Ostrava-Svinov", "zipCode": "72100", "country": "CZ", "phone": "+420666777888", "email": "recipient@email.cz" } } ], "shipmentsOrderBy": "ShipmentNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } }, "shipments": [ { "referenceId": "27c92d31-2a18-4fc3-a388-bee64edfdafb", "productType": "BUSS", "sender": { "street": "Novoveská 1262/95", "city": "Ostrava", "zipCode": "70900", "country": "CZ", "phone": "+420777888999", "email": "sender@email.cz" }, "recipient": { "street": "Františka a Anny Ryšových 1168", "city": "Ostrava-Svinov", "zipCode": "72100", "country": "CZ", "phone": "+420666777888", "email": "recipient@email.cz" } } ], "shipmentsOrderBy": "ShipmentNumber" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } }, "shipments": [ { "referenceId": "27c92d31-2a18-4fc3-a388-bee64edfdafb", "productType": "BUSS", "sender": { "street": "Novoveská 1262/95", "city": "Ostrava", "zipCode": "70900", "country": "CZ", "phone": "+420777888999", "email": "sender@email.cz" }, "recipient": { "street": "Františka a Anny Ryšových 1168", "city": "Ostrava-Svinov", "zipCode": "72100", "country": "CZ", "phone": "+420666777888", "email": "recipient@email.cz" } } ], "shipmentsOrderBy": "ShipmentNumber" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "Location": { "description": "Newly created entity location", "schema": { "type": "string" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/shipment/batch/{batchId}": { "put": { "tags": [ "ShipmentBatch" ], "summary": "Slouží k úpravě sady zásilek", "operationId": "UpdateShipmentBatch", "parameters": [ { "name": "batchId", "in": "path", "description": "The batch id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "requestBody": { "description": "The request data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel" }, "example": { "labelSettings": { "format": "Pdf", "completeLabelSettings": { "isCompleteLabelRequested": true, "pageSize": "A4" } } } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } }, "get": { "tags": [ "ShipmentBatch" ], "summary": "Slouží k získání stavu importu zásilky", "operationId": "GetShipmentBatch", "parameters": [ { "name": "batchId", "in": "path", "description": "The batch id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } }, { "name": "OrderBy", "in": "query", "description": "Sort items by defined fields. For multiple sorting use field names separated by comma. Use \"-\" to descendant order (eg.: OrderBy=field1,-field2).\r\nOrderable fields: **ShipmentNumber, ReferenceId**, see also schema **Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.OrderBy.enum**", "schema": { "anyOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.OrderBy.enum" }, { "type": "string" } ] } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentBatchResultModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentBatchResultModel" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/shipment/batch/{batchId}/label": { "get": { "tags": [ "ShipmentBatch" ], "summary": "BatchId z předchozí metody. Odpovědí je URL (hromadné nebo k jednotlivému balíku) pro stažení vygenerované etikety.", "operationId": "GetShipmentBatchLabel", "parameters": [ { "name": "batchId", "in": "path", "description": "The batch id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "PageSize", "in": "query", "description": "PageSize", "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstPageSize" } }, { "name": "Position", "in": "query", "description": "Position", "schema": { "maximum": 4, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The limit", "required": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The offset", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } }, { "name": "OrderBy", "in": "query", "description": "Sort items by defined fields. For multiple sorting use field names separated by comma. Use \"-\" to descendant order (eg.: OrderBy=field1,-field2).\r\nOrderable fields: **ShipmentNumber, ReferenceId**, see also schema **Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum**", "schema": { "anyOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum" }, { "type": "string" } ] } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } }, "content": { "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "404": { "description": "NotFound", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/shipment/{shipmentNumber}/cancel": { "post": { "tags": [ "ShipmentEvent" ], "summary": "Možnost stornovat balík, pokud nebyl fyzicky poslán", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/shipment/{shipmentNumber}/redirect": { "post": { "tags": [ "ShipmentEvent" ], "summary": "Možnost doplnit informace k balíku", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } }, "/versionInformation": { "get": { "tags": [ "VersionInformation" ], "summary": "Metoda slouží k získávání novinek, informací, plánované odstávky a další důležité informace vztahující se k (nejen) CPL.", "parameters": [ { "name": "Limit", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language specification, default language: cs-CZ", "schema": { "$ref": "#/components/schemas/AcceptLanguageSchema" } }, { "name": "X-Correlation-ID", "in": "header", "description": "Correlation Id of request", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, { "name": "X-LogLevel", "in": "header", "description": "The forced log level", "schema": { "$ref": "#/components/schemas/XLogLevelSchema" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Correlation-ID": { "description": "Correlation Id of request otherwise id of response", "schema": { "$ref": "#/components/schemas/XCorrelationIdSchema" } }, "X-Paging-Total-Items-Count": { "description": "Total items in result", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Offset": { "description": "Paging offset", "schema": { "$ref": "#/components/schemas/XPagingSchema" } }, "X-Paging-Limit": { "description": "Page size", "schema": { "$ref": "#/components/schemas/XPagingSchema" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Dto.VersionInformation.VersionInformationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Dto.VersionInformation.VersionInformationDto" } } } } }, "400": { "description": "BadRequest", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "500": { "description": "InternalServerError", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } }, "503": { "description": "ServiceUnavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel" } } } } } } } }, "components": { "schemas": { "AcceptLanguageSchema": { "type": "string", "description": "Accept-Language header schema" }, "EmptyNullableObject": { "description": "Injected nullable object", "nullable": true }, "Eps.Api.Infrastructure.WebApi.Model.InfoModel": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "time": { "type": "string", "format": "date-time" }, "node": { "type": "string", "nullable": true }, "application": { "type": "string", "nullable": true }, "startTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Eps.Api.Infrastructure.WebApi.Model.ProblemJsonBasicModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "Eps.Api.MyApi2.Business.Dto.VersionInformation.VersionInformationDto": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "informationType": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "version": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Eps.Api.MyApi2.Business.Enums.ConstImportState": { "enum": [ "Accepted", "InProcess", "Complete", "Error" ], "type": "string" }, "Eps.Api.MyApi2.Business.Enums.ConstPageSize": { "enum": [ "Default", "A4" ], "type": "string" }, "Eps.Api.MyApi2.Business.Enums.ConstRelationType": { "enum": [ "ShipmentSet", "DocumentBack", "Dormant" ], "type": "string" }, "Eps.Api.MyApi2.Business.Enums.ConstReturnChannel": { "enum": [ "None", "Email", "Ftp" ], "type": "string" }, "Eps.Api.MyApi2.Web.Constants.ConstLabelFormat": { "enum": [ "Zpl", "Pdf", "Jpeg", "Png", "Svg" ], "type": "string", "description": "Label format" }, "Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.OrderBy.enum": { "enum": [ "ShipmentNumber", "ReferenceId" ], "type": "string" }, "Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum": { "enum": [ "ShipmentNumber", "ReferenceId" ], "type": "string" }, "Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointCapacitySettingModel": { "type": "object", "properties": { "size": { "type": "string", "description": "Size", "nullable": true }, "capacity": { "type": "integer", "description": "Capacity", "format": "int32", "nullable": true }, "length": { "type": "integer", "description": "Length", "format": "int32" }, "height": { "type": "integer", "description": "Height", "format": "int32" }, "width": { "type": "integer", "description": "Width", "format": "int32" } }, "additionalProperties": false, "description": "AccessPointCapacitySettingModel" }, "Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointModel": { "type": "object", "properties": { "accessPointCode": { "type": "string", "description": "AccessPointCode", "nullable": true }, "accessPointType": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.ConstMyApi2AccessPointType" }, "name": { "type": "string", "description": "Name", "nullable": true }, "name2": { "type": "string", "description": "Name2", "nullable": true }, "street": { "type": "string", "description": "Street", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "country": { "type": "string", "description": "Country", "nullable": true }, "zipCode": { "type": "string", "description": "ZipCode", "nullable": true }, "phone": { "type": "string", "description": "Phone", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true }, "tribalServicePoint": { "type": "boolean", "description": "Tribal service point" }, "activeCardPayment": { "type": "boolean", "description": "ActiveCardPayment" }, "activeCashPayment": { "type": "boolean", "description": "Active cash payment" }, "pickupEnabled": { "type": "boolean", "description": "Pickup enabled" }, "dimensionForced": { "type": "boolean", "description": "Dimension forced" }, "workHours": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointWorkHourModel" }, "description": "WorkHours", "nullable": true }, "accessPointNote": { "type": "string", "description": "AccessPointNote", "nullable": true }, "gps": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.CoordinatesModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "capacitySettings": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointCapacitySettingModel" }, "description": "CapacitySettings", "nullable": true } }, "additionalProperties": false, "description": "AccessPointModel" }, "Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointWorkHourModel": { "type": "object", "properties": { "weekDay": { "type": "integer", "description": "Access point work hour week day (1 - Sunday, 7 - Saturday)", "format": "int32" }, "dayPart": { "type": "integer", "description": "Access point work hour day part (0 - morning, 1 - afternoon)", "format": "int32" }, "openFrom": { "type": "string", "description": "Access point work hour open from", "format": "date-span" }, "openTo": { "type": "string", "description": "Access point work hour open to", "format": "date-span" } }, "additionalProperties": false, "description": "AccessPointWorkHourModel" }, "Eps.Api.MyApi2.Web.Models.AccessPoint.ConstMyApi2AccessPointType": { "enum": [ "None", "ParcelShop", "ParcelBox", "AlzaBox" ], "type": "string", "description": "Access point type" }, "Eps.Api.MyApi2.Web.Models.AccessPoint.CoordinatesModel": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude", "format": "double", "nullable": true }, "longitude": { "type": "number", "description": "Longitude", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A model for displaying / forwarding GPS coordinates" }, "Eps.Api.MyApi2.Web.Models.AddressWhisper.AddressWhispModel": { "type": "object", "properties": { "city": { "type": "string", "description": "City", "nullable": true }, "place": { "type": "string", "description": "Place", "nullable": true }, "street": { "type": "string", "description": "Street", "nullable": true }, "houseNumber": { "type": "string", "description": "House number", "nullable": true }, "referenceNumber": { "type": "string", "description": "Reference number", "nullable": true }, "referenceNumberChar": { "type": "string", "description": "Reference number char", "nullable": true }, "evidenceNumber": { "type": "boolean", "description": "Mark if house number is subtype of evidence number" }, "zipCode": { "type": "string", "description": "Zip code", "nullable": true }, "admCode": { "type": "string", "description": "ADM code", "nullable": true }, "valid": { "type": "boolean", "description": "Valid adress", "readOnly": true }, "fullStreet": { "type": "string", "description": "Street address with details", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Address whisp model" }, "Eps.Api.MyApi2.Web.Models.AddressWhisper.CalledFrom": { "enum": [ "Street", "ZipCode", "City" ], "type": "string", "description": "Called from UI control" }, "Eps.Api.MyApi2.Web.Models.Codelist.AgeCheckTypeModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true } }, "additionalProperties": false, "description": "AgeCheckTypeModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.CountryModel": { "type": "object", "properties": { "cashOnDelivery": { "type": "boolean", "description": "Cash on delivery allowed" }, "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true } }, "additionalProperties": false, "description": "Country model" }, "Eps.Api.MyApi2.Web.Models.Codelist.CurrencyModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true } }, "additionalProperties": false, "description": "CurrencyModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.ProofOfIdentityTypeModel": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of identity type", "nullable": true }, "code": { "type": "string", "description": "Code of identity type", "nullable": true } }, "additionalProperties": false, "description": "ProofOfIdentityTypeModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.ServicePriceLimitModel": { "type": "object", "properties": { "service": { "type": "string", "description": "Service code", "nullable": true }, "currency": { "type": "string", "description": "Currency code", "nullable": true }, "country": { "type": "string", "description": "Country code", "nullable": true }, "product": { "type": "string", "description": "Product code", "nullable": true }, "minPrice": { "type": "number", "description": "MinPrice", "format": "double" }, "maxPrice": { "type": "number", "description": "MaxPrice", "format": "double" } }, "additionalProperties": false, "description": "ServicePriceLimitModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.ShipmentExternalNumberTypeModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true }, "allowInput": { "type": "boolean", "description": "AllowInput" } }, "additionalProperties": false, "description": "ShipmentExternalNumberTypeModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.ShipmentPhaseModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true } }, "additionalProperties": false, "description": "ShipmentPhaseModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.ShipmentProductType": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true } }, "additionalProperties": false, "description": "ShipmentProductType" }, "Eps.Api.MyApi2.Web.Models.Codelist.ShipmentServiceModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true }, "allowInput": { "type": "boolean", "description": "AllowInput" } }, "additionalProperties": false, "description": "ShipmentServiceModel" }, "Eps.Api.MyApi2.Web.Models.Codelist.StatusModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true } }, "additionalProperties": false, "description": "Status model" }, "Eps.Api.MyApi2.Web.Models.Codelist.ValidationMessageModel": { "type": "object", "properties": { "message": { "type": "string", "description": "Gets or sets the message.", "nullable": true } }, "additionalProperties": false, "description": "ValidationMessageModel" }, "Eps.Api.MyApi2.Web.Models.Customer.AccountModel": { "required": [ "country", "currency" ], "type": "object", "properties": { "bankCode": { "maxLength": 4, "type": "string", "description": "Bank code", "nullable": true }, "country": { "minLength": 2, "type": "string", "description": "Country" }, "currency": { "minLength": 3, "type": "string", "description": "Currency" }, "swift": { "maxLength": 50, "type": "string", "description": "Swift", "nullable": true } }, "additionalProperties": false, "description": "Account model" }, "Eps.Api.MyApi2.Web.Models.Customer.AddressModel": { "type": "object", "properties": { "code": { "type": "string", "description": "Address type code", "nullable": true }, "name": { "type": "string", "description": "Name", "nullable": true }, "name2": { "type": "string", "description": "Name2", "nullable": true }, "street": { "type": "string", "description": "Street", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "zipCode": { "type": "string", "description": "Zip code", "nullable": true }, "country": { "type": "string", "description": "Country code", "nullable": true }, "default": { "type": "boolean", "description": "Default address" } }, "additionalProperties": false, "description": "Customer address model" }, "Eps.Api.MyApi2.Web.Models.Customer.CustomerModel": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Customer.AccountModel" }, "description": "Accounts", "nullable": true } }, "additionalProperties": false, "description": "Customer model" }, "Eps.Api.MyApi2.Web.Models.Enum.OrderStates": { "enum": [ "None", "Created", "PickedUp", "NotPickedUp", "Canceled" ], "type": "string" }, "Eps.Api.MyApi2.Web.Models.Enum.OrderType": { "enum": [ "CollectionOrder", "TransportOrder" ], "type": "string", "description": "Order type" }, "Eps.Api.MyApi2.Web.Models.Order.OrderModel": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number", "nullable": true }, "orderState": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Enum.OrderStates" }, "referenceId": { "type": "string", "description": "Reference Id", "nullable": true }, "shipmentCount": { "type": "integer", "description": "Count of shipments", "format": "int32" }, "realShipmentCount": { "type": "integer", "description": "Real count of shipments", "format": "int32" }, "email": { "type": "string", "description": "Email", "nullable": true }, "note": { "type": "string", "description": "Note", "nullable": true }, "customerReference": { "type": "string", "description": "Customer reference", "nullable": true }, "productType": { "type": "string", "description": "Typ produktu", "nullable": true }, "sendDate": { "type": "string", "description": "Datum vyzvednutí zadané objednatelem", "format": "date-time", "nullable": true }, "realCollectionDate": { "type": "string", "description": "Skutečné datum vyzvednutí", "format": "date-time", "nullable": true }, "deliveryDateTime": { "type": "string", "description": "Datum doručení", "format": "date-time", "nullable": true }, "sender": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Order.SenderAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "recipient": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Order.RecipientAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "shipmentNumbers": { "type": "array", "items": { "type": "string" }, "description": "Zásilky na objednávce", "nullable": true } }, "additionalProperties": false, "description": "OrderModel" }, "Eps.Api.MyApi2.Web.Models.Order.RecipientAddressModel": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "nullable": true }, "name2": { "type": "string", "description": "Name2", "nullable": true }, "street": { "type": "string", "description": "Street", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "zipCode": { "type": "string", "description": "ZipCode", "nullable": true }, "country": { "type": "string", "description": "Country", "nullable": true }, "contact": { "type": "string", "description": "Contact", "nullable": true }, "phone": { "type": "string", "description": "Phone", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true } }, "additionalProperties": false, "description": "RecipientAddressModel" }, "Eps.Api.MyApi2.Web.Models.Order.SenderAddressModel": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "nullable": true }, "name2": { "type": "string", "description": "Name2", "nullable": true }, "street": { "type": "string", "description": "Street", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "zipCode": { "type": "string", "description": "ZipCode", "nullable": true }, "country": { "type": "string", "description": "Country", "nullable": true }, "contact": { "type": "string", "description": "Contact", "nullable": true }, "phone": { "type": "string", "description": "Phone", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true } }, "additionalProperties": false, "description": "SenderAddressModel" }, "Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel": { "required": [ "orders" ], "type": "object", "properties": { "orders": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.OrderModel" }, "description": "Objednávky" } }, "additionalProperties": false, "description": "Create order batch model" }, "Eps.Api.MyApi2.Web.Models.OrderBatch.OrderBatchResultModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.OrderResultItemModel" }, "description": "Items", "nullable": true } }, "additionalProperties": false, "description": "Order batch result model" }, "Eps.Api.MyApi2.Web.Models.OrderBatch.OrderModel": { "required": [ "orderType", "referenceId", "sendDate", "shipmentCount" ], "type": "object", "properties": { "orderType": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Enum.OrderType" }, "referenceId": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Jedinečná reference!" }, "shipmentCount": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Počet balíků Max: 50 Délka: 2", "format": "int32" }, "email": { "maxLength": 100, "type": "string", "description": "Notifikační email pro objednavatele Délka: 2", "nullable": true }, "note": { "maxLength": 300, "type": "string", "description": "Poznámka Délka 50", "nullable": true }, "customerReference": { "maxLength": 40, "type": "string", "description": "Zákaznická reference. Délka: 9,2", "nullable": true }, "sendDate": { "type": "string", "description": "Datum odeslání Délka: 9,2", "format": "date-time" }, "sendTimeFrom": { "type": "string", "description": "Čas odeslání od", "format": "date-span", "nullable": true }, "sendTimeTo": { "type": "string", "description": "Čas odeslání do", "format": "date-span", "nullable": true }, "productType": { "type": "string", "description": "BUSS / IMPO Délka: 4", "nullable": true }, "sender": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.SenderAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "recipient": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.OrderBatch.RecipientAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "Order model" }, "Eps.Api.MyApi2.Web.Models.OrderBatch.OrderResultItemModel": { "required": [ "importState", "referenceId" ], "type": "object", "properties": { "referenceId": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Reference id" }, "importState": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstImportState" }, "errorMessage": { "type": "string", "description": "Error message", "nullable": true }, "errorCode": { "type": "string", "description": "Error code", "nullable": true } }, "additionalProperties": false, "description": "Order result item model" }, "Eps.Api.MyApi2.Web.Models.OrderBatch.RecipientAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 250, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 250, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 50", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku Délka 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 100, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "Recipient address model" }, "Eps.Api.MyApi2.Web.Models.OrderBatch.SenderAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 250, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 250, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 50", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku Délka 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 100, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "Sender address model" }, "Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel": { "type": "object", "properties": { "note": { "type": "string", "description": "Note", "nullable": true } }, "additionalProperties": false, "description": "Cancel order event model" }, "Eps.Api.MyApi2.Web.Models.Shipment.AccessPointFeatureModel": { "type": "object", "properties": { "accessPointDaysInStorage": { "type": "integer", "description": "Number of days at the access point.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Access point feature model." }, "Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel": { "type": "object", "properties": { "type": { "type": "string", "description": "Type", "nullable": true }, "reference": { "type": "string", "description": "Reference", "nullable": true } }, "additionalProperties": false, "description": "AdditionalParameterModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.BackShipmentFeatureModel": { "type": "object", "properties": { "backDate": { "type": "string", "description": "Back date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "BackShipmentFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.DormantShipmentFeatureModel": { "type": "object", "properties": { "dormantShipmentNumber": { "type": "string", "description": "DormantShipmentNumber", "nullable": true }, "dormantShipmentNumberActive": { "type": "boolean", "description": "DormantShipmentNumberActive", "nullable": true } }, "additionalProperties": false, "description": "DormantShipmentFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel": { "type": "object", "properties": { "externalNumber": { "type": "string", "description": "ExternalNumber", "nullable": true }, "code": { "type": "string", "description": "Code", "nullable": true } }, "additionalProperties": false, "description": "ExternalNumberModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel": { "type": "object", "properties": { "additionalParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel" }, "description": "AdditionalParameters", "nullable": true }, "code": { "type": "string", "description": "Code", "nullable": true }, "price": { "type": "number", "description": "Price", "format": "double", "nullable": true }, "priceCurrency": { "type": "string", "description": "PriceCurrency", "nullable": true } }, "additionalProperties": false, "description": "ServiceModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "nullable": true }, "name2": { "type": "string", "description": "Name2", "nullable": true }, "street": { "type": "string", "description": "Street", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "zipCode": { "type": "string", "description": "ZipCode", "nullable": true }, "country": { "type": "string", "description": "Country", "nullable": true }, "contact": { "type": "string", "description": "Contact", "nullable": true }, "phone": { "type": "string", "description": "Phone", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true } }, "additionalProperties": false, "description": "AddressBaseModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentDeliveryFeatureModel": { "type": "object", "properties": { "loadDate": { "type": "string", "description": "Date of loading shipment for delivery.", "format": "date-time", "nullable": true }, "delivDate": { "type": "string", "description": "Delivery date", "format": "date-time", "nullable": true }, "delivPerson": { "type": "string", "description": "Delivery person", "nullable": true }, "notDelivDate": { "type": "string", "description": "Not delivery date", "format": "date-time", "nullable": true }, "outDepDate": { "type": "string", "description": "Out dep date", "format": "date-time", "nullable": true }, "hubDate": { "type": "string", "description": "Hub date", "format": "date-time", "nullable": true }, "deliveryToAccessPoint": { "type": "boolean", "description": "DeliveryToAccessPoint" } }, "additionalProperties": false, "description": "ShipmentDeliveryFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel": { "type": "object", "properties": { "shipmentNumber": { "type": "string", "description": "ShipmentNumber", "nullable": true }, "productType": { "type": "string", "description": "ProductType", "nullable": true }, "note": { "type": "string", "description": "Note", "nullable": true }, "depot": { "type": "string", "description": "Depot", "nullable": true }, "integratorId": { "type": "integer", "description": "IntegratorId", "format": "int32", "nullable": true }, "lastUpdateDate": { "type": "string", "description": "Last update date", "format": "date-time", "nullable": true }, "shipmentSet": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentSetFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "sender": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "recipient": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "specificDelivery": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.SpecificDeliveryFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "externalNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel" }, "description": "ExternalNumbers", "nullable": true }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel" }, "description": "Services", "nullable": true }, "trackAndTrace": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "shipmentWeightInfo": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentWeightFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "paymentInfo": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentPaymentFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "deliveryFeature": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentDeliveryFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "backShipmentFeature": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.BackShipmentFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "dormantShipmentFeature": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.DormantShipmentFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "accessPointFeature": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.AccessPointFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "ShipmentModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentPaymentFeatureModel": { "type": "object", "properties": { "paidByCard": { "type": "boolean" }, "codPaidDate": { "type": "string", "format": "date-time", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "bankAccount": { "type": "string", "nullable": true }, "bankCode": { "type": "string", "nullable": true }, "codBankStatementDate": { "type": "string", "format": "date-time", "nullable": true }, "codCurrency": { "type": "string", "nullable": true }, "codPaymentAccDate": { "type": "string", "format": "date-time", "nullable": true }, "codPrice": { "type": "number", "format": "double", "nullable": true }, "codVariableSymbol": { "type": "string", "nullable": true }, "specificSymbol": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "ShipmentPaymentFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentSetFeatureModel": { "type": "object", "properties": { "masterShipmentNumber": { "type": "string", "description": "MasterShipmentNumber", "nullable": true }, "shipmentsInSet": { "type": "integer", "description": "ShipmentsInSet", "format": "int32" }, "shipmentInSetNumber": { "type": "integer", "description": "ShipmentInSetNumber", "format": "int32" } }, "additionalProperties": false, "description": "ShipmentSetFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentStates": { "enum": [ "None", "Undelivered", "Delivered", "PickedUpFromSender", "DeliveredToPickupPoint", "OutForDelivery", "NotDelivered", "CodPaidDate", "BackToSender", "Rejected", "DataShipment", "Active", "Canceled", "Dormant" ], "type": "string", "description": "ShipmentStates" }, "Eps.Api.MyApi2.Web.Models.Shipment.ShipmentWeightFeatureModel": { "type": "object", "properties": { "weight": { "type": "number", "description": "Gets or sets the weight.", "format": "double", "nullable": true }, "weighedDate": { "type": "string", "description": "Weighed date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "ShipmentWeightFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.SpecificDeliveryFeatureModel": { "type": "object", "properties": { "specificDeliveryDate": { "type": "string", "description": "SpecificDeliveryDate", "format": "date-time", "nullable": true }, "specificDeliveryTimeFrom": { "type": "string", "description": "SpecificDeliveryTimeFrom", "format": "date-span", "nullable": true }, "specificDeliveryTimeTo": { "type": "string", "description": "SpecificDeliveryTimeTo", "format": "date-span", "nullable": true }, "specificTakeDate": { "type": "string", "description": "SpecificTakeDate", "format": "date-time", "nullable": true }, "specificTakeTimeFrom": { "type": "string", "description": "SpecificTakeTimeFrom", "format": "date-span", "nullable": true }, "specificTakeTimeTo": { "type": "string", "description": "SpecificTakeTimeTo", "format": "date-span", "nullable": true }, "accessPointCode": { "type": "string", "description": "ParcelShopCode", "nullable": true } }, "additionalProperties": false, "description": "SpecificDeliveryFeatureModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel": { "type": "object", "properties": { "statusId": { "type": "integer", "description": "Status id", "format": "int32" }, "code": { "type": "string", "description": "Event code", "nullable": true }, "phase": { "type": "string", "description": "Event phase", "nullable": true }, "group": { "type": "string", "description": "Event group", "nullable": true }, "eventDate": { "type": "string", "description": "Event date", "format": "date-time" }, "name": { "type": "string", "description": "Status name from codelist", "nullable": true }, "gpsLatitude": { "type": "number", "description": "Latitude", "format": "double", "nullable": true }, "gpsLongitude": { "type": "number", "description": "Longitude", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "TrackAndTraceItemModel" }, "Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceModel": { "type": "object", "properties": { "externalShipmentId": { "type": "string", "description": "External shipment Id", "nullable": true }, "partnerUrl": { "type": "string", "description": "Partner track and trace URL", "nullable": true }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel" }, "description": "Track and trace events", "nullable": true } }, "additionalProperties": false, "description": "Track and trace" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.BackAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 50, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 60", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku - /codelist/country Délka: 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 50, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "BackAddressModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.CashOnDeliveryFeatureModel": { "required": [ "codCurrency", "codPrice", "codVarSym" ], "type": "object", "properties": { "iban": { "type": "string", "description": "IBAN Délka: 50", "nullable": true }, "swift": { "type": "string", "description": "Swift Délka: 50", "nullable": true }, "specSymbol": { "maxLength": 6, "type": "string", "description": "Specifický symbol Délka: 6", "nullable": true }, "account": { "type": "string", "description": "Číslo bankovního účtu Délka: 10", "nullable": true }, "accountPre": { "type": "string", "description": "Před číslo bankovního účtu Délka: 10", "nullable": true }, "bankCode": { "type": "string", "description": "Kód banky Délka: 4", "nullable": true }, "codPrice": { "minimum": 0, "type": "number", "description": "Částka dobírky.\r\n1. Pokud je CodPrice vyplněné, pak musí být vyplněno i CodCurrency. Délka: 12.4\r\n2. Částka nesmí být záporná.\r\n3. max limity - /codelist/servicePriceLimit", "format": "double" }, "codCurrency": { "minLength": 1, "type": "string", "description": "Měna dobírky, povolené měny - /codelist/currency Délka: 3" }, "codVarSym": { "maxLength": 10, "minLength": 1, "pattern": "^\\d+", "type": "string", "description": "Variabilní symbol dobírky. POUZE čísla Délka: 30" } }, "additionalProperties": false, "description": "CashOnDeliveryFeatureModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelModel": { "type": "object", "properties": { "labelUrls": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "LabelUrls", "nullable": true } }, "additionalProperties": false, "description": "CompleteLabelModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelSettingsModel": { "type": "object", "properties": { "isCompleteLabelRequested": { "type": "boolean", "description": "IsCompleteLabelRequested" }, "pageSize": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstPageSize" }, "position": { "maximum": 4, "minimum": 1, "type": "integer", "description": "Position", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "CompleteLabelSettingsModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel": { "required": [ "shipments" ], "type": "object", "properties": { "returnChannel": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "labelSettings": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "shipments": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentModel" }, "description": "Zásilky" }, "shipmentsOrderBy": { "type": "string", "description": "Order by", "nullable": true } }, "additionalProperties": false, "description": "CreateShipmentBatchModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.DirectInjectionFeatureModel": { "type": "object", "properties": { "directAddressing": { "type": "boolean", "description": "true / false" }, "gatewayZipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10", "nullable": true }, "gatewayCity": { "maxLength": 35, "minLength": 1, "type": "string", "description": "Město Délka: 35", "nullable": true }, "country": { "minLength": 1, "type": "string", "description": "Země Délka: 2", "nullable": true } }, "additionalProperties": false, "description": "DirectInjectionFeatureModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantExternalNumberModel": { "required": [ "code", "externalNumber" ], "type": "object", "properties": { "externalNumber": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Externí číslo zásilky Délka: 50" }, "code": { "minLength": 1, "type": "string", "description": "Kód typu externího čísla podle číselníku codelist/externalNumber Délka: 4" } }, "additionalProperties": false, "description": "DormantExternalNumberModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantRecipientAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 50, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 60", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku - /codelist/country Délka: 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 50, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "DormantRecipientAddressModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantServiceModel": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Kód služby - /codelist/service Délka: 4" } }, "additionalProperties": false, "description": "DormantServiceModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantShipmentModel": { "type": "object", "properties": { "shipmentNumber": { "type": "string", "description": "Číslo zásilky", "nullable": true }, "note": { "type": "string", "description": "Poznámka Délka: 300", "nullable": true }, "recipient": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantRecipientAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "externalNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantExternalNumberModel" }, "description": "Externí čísla", "nullable": true }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantServiceModel" }, "description": "Služby", "nullable": true }, "weighedShipmentInfo": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantWeighedShipmentFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "DormantShipmentModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantWeighedShipmentFeatureModel": { "type": "object", "properties": { "weight": { "minimum": 0, "type": "number", "description": "Váha zásilky deklarovaná odesílatelem. Délka: 9,2", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "DormantWeighedShipmentFeatureModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel": { "required": [ "code", "externalNumber" ], "type": "object", "properties": { "externalNumber": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Externí číslo zásilky Délka: 50" }, "code": { "minLength": 1, "type": "string", "description": "Kód typu externího čísla podle číselníku codelist/externalNumber Délka: 4" } }, "additionalProperties": false, "description": "ExternalNumberModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel": { "required": [ "insuranceCurrency", "insurancePrice" ], "type": "object", "properties": { "insurancePrice": { "minimum": 0, "type": "number", "description": "Částka připojištění. Max limity - /codelist/servicePriceLimit Délka: 12,4", "format": "double" }, "insuranceCurrency": { "minLength": 1, "type": "string", "description": "Připojištění může být pouze v rámci naší národní měny – CZK Délka: 3" } }, "additionalProperties": false, "description": "InsuranceFeatureModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelServiceModel": { "type": "object", "properties": { "labelless": { "type": "boolean", "description": "true / false" } }, "additionalProperties": false, "description": "LabelServiceModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Constants.ConstLabelFormat" }, "dpi": { "maximum": 1200, "minimum": 203, "type": "integer", "description": "Volba DPI pro ZPL", "format": "int32", "nullable": true }, "completeLabelSettings": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelSettingsModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "LabelSettingsModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.RecipientAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 50, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 60", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku - /codelist/country Délka: 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 50, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "RecipientAddressModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel": { "type": "object", "properties": { "type": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstReturnChannel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "address": { "maxLength": 100, "type": "string", "description": "Pokud je vybrán Type = Email, pak zde vyplňovat email příjemce etikety Délka: 100", "nullable": true } }, "additionalProperties": false, "description": "ReturnChannelModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 50, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 60", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku - /codelist/country Délka: 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 50, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "SenderAddressModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderMaskAddressModel": { "required": [ "country", "zipCode" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string", "description": "Název firmy / jméno Délka: 50", "nullable": true }, "name2": { "maxLength": 50, "type": "string", "description": "Dodatek (Název firmy / jméno) Délka: 50", "nullable": true }, "street": { "maxLength": 60, "type": "string", "description": "Ulice Délka: 60", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Město Délka: 50", "nullable": true }, "zipCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "PSČ Délka: 10" }, "country": { "minLength": 1, "type": "string", "description": "Kód země podle číselníku - /codelist/country Délka: 2" }, "contact": { "maxLength": 50, "type": "string", "description": "Kontaktní osoba. Délka: 50", "nullable": true }, "phone": { "maxLength": 30, "type": "string", "description": "Telefon Délka: 30", "nullable": true }, "email": { "maxLength": 50, "type": "string", "description": "Email Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "SenderMaskAddressModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ServiceModel": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Kód služby - /codelist/service Délka: 4" } }, "additionalProperties": false, "description": "ServiceModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentBatchResultModel": { "type": "object", "properties": { "completeLabel": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultItemModel" }, "description": "Items", "nullable": true } }, "additionalProperties": false, "description": "ShipmentBatchResultModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentModel": { "required": [ "productType", "recipient", "referenceId" ], "type": "object", "properties": { "referenceId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Jedinečná reference!" }, "shipmentNumber": { "type": "string", "description": "Číslo zásilky", "nullable": true }, "productType": { "minLength": 1, "type": "string", "description": "Typ produktu" }, "note": { "type": "string", "description": "Poznámka Délka: 300", "nullable": true }, "depot": { "type": "string", "description": "Nepoužívat. Délka: 2", "nullable": true }, "ageCheck": { "type": "string", "description": "Služba kontrola věku (15,18+)", "nullable": true }, "integratorId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "ID integrátora – pouze pro typ: integrátor", "format": "int32", "nullable": true }, "shipmentSet": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "backAddress": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.BackAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "sender": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "senderMask": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderMaskAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "recipient": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.RecipientAddressModel" }, "specificDelivery": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.SpecificDeliveryFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "cashOnDelivery": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CashOnDeliveryFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "insurance": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "externalNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel" }, "description": "Externí čísla", "nullable": true }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ServiceModel" }, "description": "Služby", "nullable": true }, "dormant": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantShipmentModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "shipmentRouting": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentRoutingModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "directInjection": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DirectInjectionFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "labelService": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelServiceModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "ShipmentModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultChildItemModel": { "type": "object", "properties": { "shipmentNumber": { "type": "string", "description": "Shipment number", "nullable": true }, "insuranceCurrency": { "type": "string", "description": "Insurance currency", "nullable": true }, "insurancePrice": { "type": "number", "description": "Insurance price", "format": "double", "nullable": true }, "labelUrl": { "type": "string", "description": "Label uri", "format": "uri", "nullable": true }, "importState": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstImportState" }, "errorMessage": { "type": "string", "description": "Error message", "nullable": true }, "errorCode": { "type": "string", "description": "Error code", "nullable": true }, "relationType": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstRelationType" } }, "additionalProperties": false, "description": "Shipment result child item model" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultItemModel": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "Reference Id", "nullable": true }, "shipmentNumber": { "type": "string", "description": "Shipment number", "nullable": true }, "insuranceCurrency": { "type": "string", "description": "Insurance currency", "nullable": true }, "insurancePrice": { "type": "number", "description": "Insurance price", "format": "double", "nullable": true }, "labelUrl": { "type": "string", "description": "Label uri", "format": "uri", "nullable": true }, "importState": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstImportState" }, "errorMessage": { "type": "string", "description": "Error message", "nullable": true }, "errorCode": { "type": "string", "description": "Error code", "nullable": true }, "relatedItems": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultChildItemModel" }, "description": "Related items", "nullable": true } }, "additionalProperties": false, "description": "Shipment result item model" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentRoutingModel": { "type": "object", "properties": { "inputRouteCode": { "pattern": "^(([0-9]){5})$", "type": "string", "description": "Nepoužívá se Délka: 5", "nullable": true } }, "additionalProperties": false, "description": "ShipmentRoutingModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetFeatureModel": { "required": [ "numberOfShipments" ], "type": "object", "properties": { "numberOfShipments": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Počet balíků na adresu - Max 50", "format": "int32" }, "shipmentSetItems": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetItemModel" }, "description": "Shipment set items", "nullable": true } }, "additionalProperties": false, "description": "Shipment set" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetItemModel": { "type": "object", "properties": { "shipmentNumber": { "type": "string", "description": "Číslo zásilky", "nullable": true }, "weighedShipmentInfo": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.WeighedShipmentFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "externalNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel" }, "description": "Externí číslo pro každý balík zvlášť", "nullable": true }, "insurance": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "Shipment set item" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.SpecificDeliveryFeatureModel": { "type": "object", "properties": { "specificDeliveryDate": { "type": "string", "description": "SpecificDeliveryDate", "format": "date-time", "nullable": true }, "specificDeliveryTimeFrom": { "type": "string", "description": "SpecificDeliveryTimeFrom", "format": "date-time", "nullable": true }, "specificDeliveryTimeTo": { "type": "string", "description": "SpecificDeliveryTimeTo", "format": "date-time", "nullable": true }, "specificTakeDate": { "type": "string", "description": "SpecificTakeDate", "format": "date-time", "nullable": true }, "parcelShopCode": { "type": "string", "description": "Kód výdejního místa Délka: 50", "nullable": true } }, "additionalProperties": false, "description": "SpecificDeliveryFeatureModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel": { "required": [ "labelSettings" ], "type": "object", "properties": { "returnChannel": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] }, "labelSettings": { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel" } }, "additionalProperties": false, "description": "UpdateShipmentBatchModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentBatch.WeighedShipmentFeatureModel": { "type": "object", "properties": { "weight": { "minimum": 0, "type": "number", "description": "Váha zásilky deklarovaná odesílatelem. Délka: 9,2", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "WeighedShipmentFeatureModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectRecipientAddressModel": { "type": "object", "properties": { "contact": { "type": "string", "description": "Contact", "nullable": true }, "phone": { "type": "string", "description": "Phone", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true } }, "additionalProperties": false, "description": "RedirectRecipientAddressModel" }, "Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel": { "type": "object", "properties": { "address": { "oneOf": [ { "$ref": "#/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectRecipientAddressModel" }, { "$ref": "#/components/schemas/EmptyNullableObject" } ] } }, "additionalProperties": false, "description": "RedirectShipmentEventModel" }, "XCorrelationIdSchema": { "type": "string", "description": "X-Correlation-ID header schema" }, "XLogLevelSchema": { "enum": [ "Trace", "Debug", "Information", "Warning", "Error", "Critical" ], "type": "string", "description": "X-LogLevel header schema" }, "XPagingSchema": { "type": "integer", "description": "X-Paging header schema" } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [] } ] }