{
"openapi": "3.0.0",
"info": {
"title": "MAILSHIP - Mailstep Fulfilment API",
"version": "1",
"description": "# Introduction\n\nMailstage Business API is a web API for communication with the MAILSHIP system.\n\nProvides functionality for:\n- Uploading the catalog of goods\n- Checking the current status of warehouses\n- Uploading of goods orders\n- Checking the order processing status\n\nFunctions can be called for individual cases or in batches. In the case of larger data volumes, a batch approach is preferred.",
"x-logo": {
"url": "/api/logo.png",
"altText": "Logo"
}
},
"paths": {
"/api/admin/{id}/organisation/{orgId}": {
"put": {
"summary": "Add Admin to Organisation",
"description": "Add Admin to Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Admin"
]
},
"delete": {
"summary": "Remove Admin from Organisation",
"description": "Remove Admin from Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/{id}": {
"get": {
"summary": "Get Admin",
"description": "Find and return one specific Admin entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Admin.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Admin"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Admin"
]
},
"put": {
"summary": "Update Admin",
"description": "Update Admin entity to the database.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminUpdate",
"type": "string"
}
}
},
"description": "JSON of new User sent in Request body."
},
"responses": {
"200": {
"description": "Returns updated User.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Admin"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Admin"
]
},
"delete": {
"summary": "Delete Admin",
"description": "Permanently delete Admin. Admin will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/list": {
"post": {
"summary": "Get list of Admins",
"description": "Find and return set of Admin entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Admin"
]
}
},
"/api/admin": {
"post": {
"summary": "Create Admin",
"description": "Create and insert a new Admin entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Admin2",
"type": "string"
}
}
},
"description": "JSON of new Admin sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Admin.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Admin"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/activate/{id}": {
"put": {
"summary": "Activate Admin",
"description": "Set Admins flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/deactivate/{id}": {
"put": {
"summary": "Dectivate Admin",
"description": "Set Admins flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/activate": {
"put": {
"summary": "Activate multiple Admins",
"description": "Set flag 'active' of multiple Admins to true.",
"requestBody": {
"$ref": "#/components/requestBodies/AdminList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/deactivate": {
"put": {
"summary": "Deactivate multiple Admins",
"description": "Set flag 'active' of multiple Admins to false.",
"requestBody": {
"$ref": "#/components/requestBodies/AdminList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Admin"
]
}
},
"/api/admin/delete": {
"put": {
"summary": "Delete multiple Admins",
"description": "Permanently delete multiple Admins. Admins will be no longer available.",
"requestBody": {
"$ref": "#/components/requestBodies/AdminList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Admin"
]
}
},
"/api/audit": {
"post": {
"summary": "Get Audit Log",
"description": "Get Audit Log",
"requestBody": {
"$ref": "#/components/requestBodies/AuditRecordSearch"
},
"responses": {
"200": {
"description": "Returned list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Audit"
]
}
},
"/api/baselinker/eshop-setting/{eshopId}": {
"get": {
"summary": "Get BaseLinker Eshop configuration",
"description": "Find and return one specific Eshop setting for baselinker.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"name": "eshopId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Eshop.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSetting2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
},
"422": {
"description": "Returned when data of entity is corrupted."
}
},
"tags": [
"BaseLinker"
]
},
"post": {
"summary": "Create baselinker setting",
"description": "Find and return set of Wms entities based on search criteria.",
"parameters": [
{
"name": "eshopId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSetting",
"type": "string"
}
}
},
"description": "JSON of new BaseLinkerIntegration sent in Request body."
},
"responses": {
"200": {
"description": "Returns created or updated IntegrationSetting in Connector.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationSetting2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"BaseLinker"
]
}
},
"/api/byznys-user": {
"post": {
"summary": "Create Byznys User",
"description": "Create and insert a new Byznys User entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByznysUser",
"type": "string"
}
}
},
"description": "JSON of new Byznys User sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Byznys User.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByznysUser2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Byznys User"
]
}
},
"/api/byznys-user/list": {
"post": {
"summary": "Get list of Byznys Users",
"description": "Find and return set of Byznys User entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByznysUserListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results3"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Byznys User"
]
}
},
"/api/byznys-user/{id}": {
"delete": {
"summary": "Delete Byznys User",
"description": "Permanently delete Byznys User. Byznys User will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Byznys User"
]
}
},
"/api/carrier/{id}": {
"get": {
"summary": "Get Carrier",
"description": "Find and return one specific Carrier entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Carrier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Carrier"
]
},
"put": {
"summary": "Update Carrier",
"description": "Update Carrier entity to the database.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier3",
"type": "string"
}
}
},
"description": "JSON of updated Carrier sent in Request body."
},
"responses": {
"200": {
"description": "Returns updated Carrier.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier/code/{code}": {
"get": {
"summary": "Get Carrier by code",
"description": "Find and return one specific Carrier entity by CODE.",
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"description": "Unique code (number) of the entity.",
"schema": {
"type": "integer",
"pattern": "\\d+"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Carrier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier/list": {
"post": {
"summary": "Get list of Carriers",
"description": "Find and return set of Carrier entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results4"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier/{id}/organisation-add": {
"put": {
"summary": "Add multiple Organisations to Carrier",
"description": "Added Organisations will be allowed to use the Carrier.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/OrganisationList"
},
"responses": {
"204": {
"description": "No content on success"
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier/{id}/organisation-remove": {
"put": {
"summary": "Remove multiple Organisations from Carrier",
"description": "Removed Organisations will be no longer allowed to use the Carrier.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/OrganisationList"
},
"responses": {
"204": {
"description": "No content on success"
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier": {
"post": {
"summary": "Create Carrier",
"description": "Create and insert a new Carrier entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier2",
"type": "string"
}
}
},
"description": "JSON of new Carrier sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Carrier.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier/{carrierId}/image/upload": {
"post": {
"summary": "Upload Carrier Image (FORM)",
"description": "Carrier image upload.",
"parameters": [
{
"name": "carrierId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Carrier entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/postApiCarrier_carrierid_imageUpload"
},
"responses": {
"201": {
"description": "Returns Carrier entity.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Carrier"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier"
]
}
},
"/api/carrier-pickup-place/{id}": {
"get": {
"summary": "Get CarrierPickupPlace",
"description": "Find and return one specific CarrierPickupPlace entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of CarrierPickupPlace.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierPickupPlace"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Carrier Pickup Place"
]
},
"put": {
"summary": "Update CarrierPickupPlace",
"description": "Update CarrierPickupPlace entity to the database.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierPickupPlace3",
"type": "string"
}
}
},
"description": "JSON of updated CarrierPickupPlace sent in Request body."
},
"responses": {
"200": {
"description": "Returns updated CarrierPickupPlace.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierPickupPlace"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier Pickup Place"
]
}
},
"/api/carrier-pickup-place/list": {
"post": {
"summary": "Get list of CarrierPickupPlaces",
"description": "Find and return set of CarrierPickupPlace entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierPickupPlaceListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results5"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier Pickup Place"
]
}
},
"/api/carrier-pickup-place": {
"post": {
"summary": "Create CarrierPickupPlace",
"description": "Create and insert a new CarrierPickupPlace entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierPickupPlace2",
"type": "string"
}
}
},
"description": "JSON of new CarrierPickupPlace sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of CarrierPickupPlace.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierPickupPlace"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier Pickup Place"
]
}
},
"/api/carrier-service/{id}": {
"get": {
"summary": "Get CarrierService",
"description": "Find and return one specific CarrierService entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of CarrierService.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierService"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Carrier Service"
]
},
"put": {
"summary": "Update CarrierService",
"description": "Update CarrierService entity to the database.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierService3",
"type": "string"
}
}
},
"description": "JSON of updated CarrierService sent in Request body."
},
"responses": {
"200": {
"description": "Returns updated CarrierService.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierService"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier Service"
]
}
},
"/api/carrier-service/code/{code}": {
"get": {
"summary": "Get CarrierService by code",
"description": "Find and return one specific CarrierService entity by CODE.",
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"description": "Unique code (number) of the entity.",
"schema": {
"type": "integer",
"pattern": "\\d+"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of CarrierService.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierService"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Carrier Service"
]
}
},
"/api/carrier-service/list": {
"post": {
"summary": "Get list of CarrierServices",
"description": "Find and return set of CarrierService entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierServiceListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results6"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier Service"
]
}
},
"/api/carrier-service": {
"post": {
"summary": "Create CarrierService",
"description": "Create and insert a new CarrierService entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierService2",
"type": "string"
}
}
},
"description": "JSON of new CarrierService sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of CarrierService.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierService"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Carrier Service"
]
}
},
"/api/codetable/expedition-filtering/{orgId}/{eshopId}": {
"get": {
"summary": "Filters for expedition grid",
"description": "Filters for expedition grid.",
"parameters": [
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "eshopId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionCodetables"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Codetable"
]
}
},
"/api/codetable/expedition-filtering/{orgId}": {
"get": {
"summary": "Filters for expedition grid",
"description": "Filters for expedition grid.",
"parameters": [
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionCodetables"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Codetable"
]
}
},
"/api/codetable/expedition-filtering": {
"get": {
"summary": "Filters for expedition grid",
"description": "Filters for expedition grid.",
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionCodetables"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Codetable"
]
}
},
"/api/codetable/stock-movement-filtering/{orgId}/{eshopId}": {
"get": {
"summary": "Filters for stock movement grid",
"description": "Filters for stock movement grid.",
"parameters": [
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "eshopId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "([a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12})?"
}
}
],
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementCodetables"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Codetable"
]
}
},
"/api/codetable/stock-movement-filtering/{orgId}": {
"get": {
"summary": "Filters for stock movement grid",
"description": "Filters for stock movement grid.",
"parameters": [
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementCodetables"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Codetable"
]
}
},
"/api/codetable/stock-movement-filtering": {
"get": {
"summary": "Filters for stock movement grid",
"description": "Filters for stock movement grid.",
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementCodetables"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Codetable"
]
}
},
"/api/complaint-action/{complaintActionId}/attachment/upload": {
"post": {
"summary": "Upload ComplaintAction Attachment (FORM)",
"description": "ComplaintAction Attachment upload.",
"parameters": [
{
"name": "complaintActionId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the ComplaintAction entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"file"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Returns newly created entity of ComplaintAction Attachment.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint Action"
]
},
"put": {
"summary": "Upload ComplaintAction Attachment (JSON)",
"parameters": [
{
"name": "complaintActionId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the ComplaintAction entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment",
"type": "string"
}
}
},
"description": "JSON of new ComplaintAction Attachment sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of ComplaintAction Attachment.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint Action"
]
}
},
"/api/complaint-action/{complaintActionId}/attachment/{attachmentId}": {
"get": {
"summary": "Get ComplaintAction Attachment",
"description": "Find and return one specific ComplaintAction Attachment entity by ID.",
"parameters": [
{
"name": "complaintActionId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the ComplaintAction entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of ComplaintAction Attachment.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint Action"
]
},
"delete": {
"summary": "Delete ComplaintAction Attachment",
"description": "Permanently delete complaintAction Attachment. It will be no longer available.",
"parameters": [
{
"name": "complaintActionId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the ComplaintAction entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint Action"
]
}
},
"/api/complaint-action/list": {
"post": {
"summary": "Get list of ComplaintActions",
"description": "Find and return set of ComplaintAction entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintActionListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results7"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint Action"
]
}
},
"/api/complaint-action/{id}": {
"get": {
"summary": "Get ComplaintAction",
"description": "Find and return one specific ComplaintAction entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of ComplaintAction.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAction"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint Action"
]
},
"put": {
"summary": "Update ComplaintAction",
"description": "Update ComplaintAction entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAction3",
"type": "string"
}
}
},
"description": "JSON of new ComplaintAction sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of ComplaintAction.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAction"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint Action"
]
},
"delete": {
"summary": "Delete Complaint Action",
"description": "Update Complaint Action entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No Return."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint Action"
]
}
},
"/api/complaint-action": {
"post": {
"summary": "Create ComplaintAction",
"description": "Create and insert a new ComplaintAction entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAction2",
"type": "string"
}
}
},
"description": "JSON of new ComplaintAction sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of ComplaintAction.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAction"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint Action"
]
}
},
"/api/complaint/{complaintId}/attachment/{attachmentId}/file": {
"get": {
"summary": "Get Complaint Attachment file",
"parameters": [
{
"name": "complaintId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific Attachment file."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{complaintId}/attachment/upload": {
"post": {
"summary": "Upload Complaint Attachment (FORM)",
"description": "Complaint Attachment upload.",
"parameters": [
{
"name": "complaintId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Complaint entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplaintAttachment"
}
},
"description": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"file"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Returns newly created entity of Complaint Attachment.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint"
]
},
"put": {
"summary": "Upload Complaint Attachment (JSON)",
"parameters": [
{
"name": "complaintId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Complaint entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment",
"type": "string"
}
}
},
"description": "JSON of new Complaint Attachment sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Complaint Attachment.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{complaintId}/attachment/{attachmentId}": {
"get": {
"summary": "Get Complaint Attachment",
"description": "Find and return one specific Complaint Attachment entity by ID.",
"parameters": [
{
"name": "complaintId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Complaint entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Complaint Attachment.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintAttachment2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
},
"delete": {
"summary": "Delete Complaint Attachment",
"description": "Permanently delete complaint Attachment. It will be no longer available.",
"parameters": [
{
"name": "complaintId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Complaint entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/list": {
"post": {
"summary": "Get list of Complaints",
"description": "Find and return set of Complaint entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results8"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{id}": {
"get": {
"summary": "Get Complaint",
"description": "Find and return one specific Complaint entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Complaint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
},
"put": {
"summary": "Update Complaint",
"description": "Update Complaint entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Complaint3"
},
"responses": {
"200": {
"description": "Returns entity of Complaint.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint": {
"post": {
"summary": "Create Complaint",
"description": "Create and insert a new Complaint entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint2",
"type": "string"
}
}
},
"description": "JSON of new Complaint sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Complaint.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{id}/cancel": {
"put": {
"summary": "Cancel Complaint",
"description": "Update status of one specific Complaint entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Complaint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{id}/close": {
"put": {
"summary": "Close Complaint",
"description": "Update status of one specific Complaint entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Complaint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{id}/resolving": {
"put": {
"summary": "Set Complaint Resolving",
"description": "Update status of one specific Complaint entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Complaint3"
},
"responses": {
"200": {
"description": "Returned specific entity of Complaint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{id}/resolve/{resolution}": {
"put": {
"summary": "Resolve Complaint",
"description": "Update status of one specific Complaint entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "resolution",
"in": "path",
"required": true,
"description": "Resolution value",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint3",
"type": "string"
}
}
},
"description": "JSON of Complaint sent in Request body."
},
"responses": {
"200": {
"description": "Returned specific entity of Complaint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/{id}/waiting/{status}": {
"put": {
"summary": "Swiching waiting status of Complaint",
"description": "Update status of one specific Complaint entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "status",
"in": "path",
"required": true,
"description": "Waiting status value ('waiting_for_resolver', waiting_for_reporter, waiting_for_resolver_log, waiting_for_cs, waiting_for_ms, waiting_for_carrier)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Complaint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Complaint"
]
}
},
"/api/complaint/export.{type}": {
"post": {
"summary": "Export Complaints",
"description": "Find and export of Complaints entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Complaint"
]
}
},
"/api/country/{code}": {
"get": {
"summary": "Get Country",
"description": "Find and return one specific Country entity by ISO code.",
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"description": "ISO code. Example: `CZ`",
"schema": {
"type": "string",
"pattern": "[A-Z][A-Z]"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Country.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Country"
]
},
"put": {
"summary": "Update Country",
"description": "Update Country entity.",
"parameters": [
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[A-Z][A-Z]"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country3",
"type": "string"
}
}
},
"description": "JSON of new Country sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Country.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Country"
]
}
},
"/api/country/list": {
"post": {
"summary": "Get list of Countries",
"description": "Find and return set of Country entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results9"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Country"
]
}
},
"/api/country": {
"post": {
"summary": "Create Country",
"description": "Create and insert a new Country entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country2",
"type": "string"
}
}
},
"description": "JSON of new Country sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Country.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Country"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Country"
]
}
},
"/api/dashboard/expedition": {
"post": {
"summary": "Get number of Expeditions",
"description": "Find and return number of Expeditions based on time frame and status criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionWidget",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned number of Expeditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionWidgetResult"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Dashboard"
]
}
},
"/api/dashboard/expedition-multiple": {
"post": {
"summary": "Get count of expeditions",
"description": "Get count of Expeditions with specified status and time frame.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionMultipleWidget",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned number of return receipts.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionMultipleWidgetResult"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Dashboard"
]
}
},
"/api/dashboard/return-receipt": {
"post": {
"summary": "Get number of return receipts",
"description": "Find and return number of return receipts based on time frame.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnReceiptWidget",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned number of return receipts.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnReceiptWidgetResult"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Dashboard"
]
}
},
"/api/daily-report/stock-movement/count": {
"post": {
"summary": "Get Count of StockMovements",
"description": "Returns Count of Stock movements in specifed time frame and organisations.",
"requestBody": {
"$ref": "#/components/requestBodies/DailyReportRequest"
},
"responses": {
"200": {
"description": "Returned count of StockMovements.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementCountResult"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Daily report"
]
}
},
"/api/daily-report/stock-movement": {
"post": {
"summary": "Get StockMovements",
"description": "Returns Stock movements in specifed time frame and organisations.",
"requestBody": {
"$ref": "#/components/requestBodies/DailyReportRequest"
},
"responses": {
"200": {
"description": "Returned StockMovements.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovement"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Daily report"
]
}
},
"/api/daily-report/expedition-stock-movement/count": {
"post": {
"summary": "Get Count of Expedition StockMovements",
"description": "Returns Count of Expedition Stock movements in specifed time frame and organisations.",
"requestBody": {
"$ref": "#/components/requestBodies/DailyReportRequest"
},
"responses": {
"200": {
"description": "Returned count of StockMovements.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementCountResult"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Daily report"
]
}
},
"/api/daily-report/expedition-stock-movement": {
"post": {
"summary": "Get Expedition StockMovements",
"description": "Returns Expedition Stock movements in specifed time frame and organisations.",
"requestBody": {
"$ref": "#/components/requestBodies/DailyReportRequest"
},
"responses": {
"200": {
"description": "Returned StockMovements.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovement"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Daily report"
]
}
},
"/api/daily-report/product-stock": {
"post": {
"summary": "Get Product stock",
"description": "Return daily Product Stock in specifed time frame and organisations.",
"requestBody": {
"$ref": "#/components/requestBodies/DailyReportRequest"
},
"responses": {
"200": {
"description": "Returned Daily Stock Movements.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductStock"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Daily report"
]
}
},
"/api/daily-report/disassembly-stock-advices": {
"post": {
"summary": "Get Stock Advices",
"description": "Return stock advice from disassembly process by expedition order number.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisassemblyStockAdviceRequest",
"type": "string"
}
}
},
"description": "Order number from disassembly expedition for identifing disassembly stock advices"
},
"responses": {
"200": {
"description": "Returns Stock advices.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Daily report"
]
}
},
"/api/distribution-center/{id}": {
"get": {
"summary": "Get DistributionCenter",
"description": "Find and return one specific DistributionCenter entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of DistributionCenter.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenter"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Distribution Center"
]
},
"put": {
"summary": "Update DistributionCenter",
"description": "Update DistributionCenter entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenter3",
"type": "string"
}
}
},
"description": "JSON of updated DistributionCenter sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of DistributionCenter.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenter"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Distribution Center"
]
},
"delete": {
"summary": "Delete DistributionCenter",
"description": "Permanently delete DistributionCenter. DistributionCenter will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Distribution Center"
]
}
},
"/api/distribution-center/list": {
"post": {
"summary": "Get list of DistributionCenter",
"description": "Find and return set of DistributionCenter entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results10"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Distribution Center"
]
}
},
"/api/distribution-center": {
"post": {
"summary": "Create DistributionCenter",
"description": "Create and insert a new DistributionCenter entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenter2",
"type": "string"
}
}
},
"description": "JSON of new DistributionCenter sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of DistributionCenter.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenter"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Distribution Center"
]
}
},
"/api/distribution-center-organisation-login/{id}": {
"get": {
"summary": "Get DistributionCenterOrganisationLogin",
"description": "Find and return one specific DistributionCenterOrganisationLogin entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of DistributionCenterOrganisationLogin.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLogin"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Distribution Center Organisation Login"
]
},
"put": {
"summary": "Update DistributionCenterOrganisationLogin",
"description": "Update DistributionCenterOrganisationLogin entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLogin3",
"type": "string"
}
}
},
"description": "JSON of updated DistributionCenterOrganisationLogin sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of DistributionCenterOrganisationLogin.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLogin"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Distribution Center Organisation Login"
]
},
"delete": {
"summary": "Delete DistributionCenterOrganisationLogin",
"description": "Permanently delete DistributionCenterOrganisationLogin. DistributionCenterOrganisationLogin will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Distribution Center Organisation Login"
]
}
},
"/api/distribution-center-organisation-login/list": {
"post": {
"summary": "Get list of DistributionCenterOrganisationLogin",
"description": "Find and return set of DistributionCenterOrganisationLogin entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLoginListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results11"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Distribution Center Organisation Login"
]
}
},
"/api/distribution-center-organisation-login": {
"post": {
"summary": "Create DistributionCenterOrganisationLogin",
"description": "Create and insert a new DistributionCenterOrganisationLogin entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLogin2",
"type": "string"
}
}
},
"description": "JSON of new DistributionCenterOrganisationLogin sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of DistributionCenterOrganisationLogin.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLogin"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Distribution Center Organisation Login"
]
}
},
"/api/eshop/list": {
"post": {
"summary": "Get list of Eshop",
"description": "Find and return set of Eshop entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results12"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop": {
"post": {
"summary": "Create Eshop",
"description": "Create and insert a new Eshop entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Eshop",
"type": "string"
}
}
},
"description": "JSON of new Eshop sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Eshop.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Eshop2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/{id}": {
"get": {
"summary": "Get Eshop",
"description": "Find and return one specific Eshop entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Eshop.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Eshop2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
},
"put": {
"summary": "Update Eshop",
"description": "Update Eshop entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Eshop3",
"type": "string"
}
}
},
"description": "JSON of updated Eshop sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Eshop.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Eshop2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop"
]
},
"delete": {
"summary": "Delete Eshop",
"description": "Permanently delete Eshop. Eshop will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/{id}/warehouse/{warehouseId}": {
"put": {
"summary": "Add Warehouse to Eshop",
"description": "Add Warehouse to Eshop.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "warehouseId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
},
"delete": {
"summary": "Remove Warehouse from Eshop",
"description": "Remove Warehouse from Eshop.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "warehouseId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/activate/{id}": {
"put": {
"summary": "Activate Eshop",
"description": "Set Eshop flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/deactivate/{id}": {
"put": {
"summary": "Deactivate Eshop",
"description": "Set Eshop flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/send-products-to-wms/{id}": {
"put": {
"summary": "Sync Eshop to WMS",
"description": "Synchronize Eshop to WMS (products).",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/activate": {
"put": {
"summary": "Activate multiple Eshops",
"description": "Set flag 'active' of multiple Eshops to true.",
"requestBody": {
"$ref": "#/components/requestBodies/EshopList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/deactivate": {
"put": {
"summary": "Deactivate multiple Eshops",
"description": "Set flag 'active' of multiple Eshops to false.",
"requestBody": {
"$ref": "#/components/requestBodies/EshopList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop/delete": {
"put": {
"summary": "Delete multiple Eshops",
"description": "Permanently delete multiple Eshops. Eshops will be no longer available.",
"requestBody": {
"$ref": "#/components/requestBodies/EshopList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop"
]
}
},
"/api/eshop-webhook/{id}": {
"get": {
"summary": "Get EshopWebHook",
"description": "Find and return one specific EshopWebHook entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of EshopWebHook.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopWebHook"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Eshop Webhook"
]
},
"put": {
"summary": "Update EshopWebHook",
"description": "Update EshopWebHook entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopWebHook3",
"type": "string"
}
}
},
"description": "JSON of updated EshopWebHook sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of EshopWebHook.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopWebHook"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop Webhook"
]
},
"delete": {
"summary": "Delete EshopWebHook",
"description": "Permanently delete EshopWebHook. EshopWebHook will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Eshop Webhook"
]
}
},
"/api/eshop-webhook/list": {
"post": {
"summary": "Get list of EshopWebHook",
"description": "Find and return set of EshopWebHook entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopWebHookListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results13"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop Webhook"
]
}
},
"/api/eshop-webhook": {
"post": {
"summary": "Create EshopWebHook",
"description": "Create and insert a new EshopWebHook entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopWebHook2",
"type": "string"
}
}
},
"description": "JSON of new Eshop sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of EshopWebHook.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopWebHook"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Eshop Webhook"
]
}
},
"/api/exchange/list": {
"post": {
"summary": "Get list of Exchange",
"description": "Find and return set of Exchange entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExchangeListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results14"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Exchange"
]
}
},
"/api/exchange/process": {
"post": {
"summary": "Exchange CZK to another currency",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExchangeList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"responses": {
"200": {
"description": "Returned on successful exchange."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Exchange"
]
}
},
"/api/expedition/{id}": {
"get": {
"summary": "Get Expedition",
"description": "Find and return one specific Expedition entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Expedition.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
},
"put": {
"summary": "Update Expedition",
"description": "Update Expedition entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition2",
"type": "string"
}
}
},
"description": "JSON of updated Expedition sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Expedition.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/list": {
"post": {
"summary": "Get list of Expedition",
"description": "Find and return set of Expedition entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results15"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/send": {
"put": {
"summary": "Send multiple expeditions to WMS",
"description": "Send multipe expedition entities to WMS for processing.",
"requestBody": {
"$ref": "#/components/requestBodies/ExpeditionList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/process": {
"put": {
"summary": "Continue multiple expeditions to WMS",
"description": "Send multipe expedition entities to WMS for processing.",
"requestBody": {
"$ref": "#/components/requestBodies/ExpeditionList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/cancel": {
"put": {
"summary": "Cancel multiple expeditions",
"description": "Cancel multipe expedition entities.",
"requestBody": {
"$ref": "#/components/requestBodies/ExpeditionList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition": {
"post": {
"summary": "Create Expedition",
"description": "Create and insert a new Expedition entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition2",
"type": "string"
}
}
},
"description": "JSON of new Expedition sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Expedition.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/rebook": {
"patch": {
"summary": "Rebook Expedition",
"description": "Rebook Expedition entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returns entity of Expedition.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/unbook": {
"patch": {
"summary": "Unbook all from Expedition",
"description": "Unbook all from Expedition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returns entity of Expedition.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/invoice": {
"get": {
"summary": "Get Expedition Invoice",
"description": "Find and return Expedition Invoice by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific Expedition Invoice."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
},
"post": {
"summary": "Upload Expedition Invoice",
"description": "Upload Expedition Invoice.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string"
}
},
"required": [
"file"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Returns entity of Expedition.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
},
"delete": {
"summary": "Remove Expedition Invoice",
"description": "Delete Expedition Invoice by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No result on success."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/send": {
"put": {
"summary": "Send Expedition to WMS",
"description": "Send Expedition entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendOptions",
"type": "string"
}
}
},
"description": "JSON of flags/options."
},
"responses": {
"200": {
"description": "Returned specific entity of Expedition.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/process": {
"put": {
"summary": "Process Expedition to WMS",
"description": "Process Expedition entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Expedition.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/cancel": {
"put": {
"summary": "Cancel Expedition",
"description": "Cancel Expedition entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned when success."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/rollback": {
"put": {
"summary": "Rollback Expedition",
"description": "Rollback Expedition entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Expedition.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/delete": {
"put": {
"summary": "Delete Expedition",
"description": "Delete Expedition entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned when success."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/migrate": {
"post": {
"summary": "Migrate Expedition from old system",
"description": " MIGRATION ONLY! Create and insert a new Expedition entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition4",
"type": "string"
}
}
},
"description": "JSON of new Expedition sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Expedition.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/export.{type}": {
"post": {
"summary": "Export Expeditions",
"description": "Find and export of Expeditions entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
},
{
"name": "hideItems",
"in": "query",
"description": "Set value 1 to export only expedition data withoud items",
"schema": {
"type": "integer",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/template.{type}": {
"get": {
"summary": "Template for Expedition Import",
"description": "Return Excel or CSV template which could be used for expedition import.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
},
{
"name": "organisation_id",
"in": "query",
"description": "Organisation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "eshop_id",
"in": "query",
"description": "Eshop ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returned on success.",
"content": {
"application/csv": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.ms-excel": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/import": {
"post": {
"summary": "Import Expeditions",
"description": "Import Expeditions from CSV, XLS or XLSX.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No data on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition/{id}/audit": {
"post": {
"summary": "Get Audit Log",
"description": "Get Expedition Audit Log",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/AuditRecordSearch"
},
"responses": {
"200": {
"description": "Returned list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition"
]
}
},
"/api/expedition-item/list": {
"post": {
"summary": "Get list of ExpeditionItems",
"description": "Find and return set of ExpeditionItems entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionItemListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results16"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Expedition Item"
]
}
},
"/api/export-job/{id}": {
"get": {
"summary": "Get Export Job",
"description": "Find and return one specific Export Job entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Export Job"
]
}
},
"/api/export-job/{id}/file": {
"get": {
"summary": "Get Export Job File",
"description": "Find and return Export Job File by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific Expedition Invoice."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Export Job"
]
}
},
"/api/export-job/list": {
"post": {
"summary": "Get list of Export Jobs",
"description": "Find and return set of Export Job entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJobListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results17"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Export Job"
]
}
},
"/api/external-carrier-pickup-place/{id}": {
"get": {
"summary": "Get ExternalCarrierPickupPlace",
"description": "Find and return one specific ExternalCarrierPickupPlace entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of ExternalCarrierPickupPlace.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCarrierPickupPlace"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"External Carrier Pickup Place"
]
}
},
"/api/external-carrier-pickup-place/list": {
"post": {
"summary": "Get list of ExternalCarrierPickupPlaces",
"description": "Find and return set of CarrierPickupPlace entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCarrierPickupPlaceListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results18"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"External Carrier Pickup Place"
]
}
},
"/api/import/template-item.{type}": {
"get": {
"summary": "Template for Item Import",
"description": "Return Excel or CSV template which could be used for Item import.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
}
],
"responses": {
"200": {
"description": "Returned on success.",
"content": {
"application/csv": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.ms-excel": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"tags": [
"Import"
]
}
},
"/api/import/import-item": {
"post": {
"summary": "Import Items",
"description": "Import Items from CSV, XLS or XLSX.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"organiztion",
"file"
],
"properties": {
"organiztion": {
"description": "Identifier (UUID) of the organiztion. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"type": "text"
},
"file": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
},
"description": "Multipart request must include 2 parts. ID of organiztion and file. Example: \n --X-INSOMNIA-BOUNDARY--
"
},
"responses": {
"200": {
"description": "Returned model with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductItemResult"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Import"
]
}
},
"/api/inbound-receipt/list": {
"post": {
"summary": "Get list of Inbound Receipts",
"description": "Find and return set of Inbound Receipt entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundReceiptListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results19"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Inbound Receipt"
]
}
},
"/api/inbound-receipt/export.{type}": {
"post": {
"summary": "Export Inbound Receipts",
"description": "Find and export of Inbound Receipts entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls",
"ods"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundReceiptExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Inbound Receipt"
]
}
},
"/api/inbound-receipt/{id}": {
"get": {
"summary": "Get Inbound Receipt",
"description": "Find and return one specific Inbound Receipt entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Inbound Receipt.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundReceipt"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Inbound Receipt"
]
}
},
"/api/internal-stock-change/list": {
"post": {
"summary": "Get list of Internal Stock changes",
"description": "Find and return set of Internal Stock Change entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChangeListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results20"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Internal Stock Change"
]
}
},
"/api/internal-stock-change": {
"post": {
"summary": "Create InternalStockChange",
"description": "Create and insert a new InternalStockChange entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChange",
"type": "string"
}
}
},
"description": "JSON of new InternalStockChange sent in Request body."
},
"responses": {
"200": {
"description": "Returns the updated InternalStockChange entity.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChange2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Internal Stock Change"
]
}
},
"/api/internal-stock-change/{id}": {
"get": {
"summary": "Get Stock change",
"description": "Find and return one specific Stock change entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock change.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChange2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Internal Stock Change"
]
},
"put": {
"summary": "Update InternalStockChange",
"description": "Update an InternalStockChange entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChange3",
"type": "string"
}
}
},
"description": "JSON of an InternalStockChange sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of InternalStockChange.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChange2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Internal Stock Change"
]
}
},
"/api/internal-stock-change/cancel": {
"put": {
"summary": "Cancel multiple InternalStockChanges",
"description": "Cancel multipe InternalStockChange entities.",
"requestBody": {
"$ref": "#/components/requestBodies/InternalStockChangeList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Internal Stock Change"
]
}
},
"/api/internal-stock-change/process": {
"put": {
"summary": "Process multiple InternalStockChanges",
"description": "Process multipe InternalStockChange entities.",
"requestBody": {
"$ref": "#/components/requestBodies/InternalStockChangeList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Internal Stock Change"
]
}
},
"/api/login/admin": {
"post": {
"summary": "Login Admin",
"description": "Authenticate Admin and return object with JSON Web Token.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminLogin",
"type": "string"
}
}
},
"description": "JSON with login credencials in Request body."
},
"responses": {
"200": {
"description": "Returned JSON Web Token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Returned when authentication failed due to incorrect login or password."
},
"403": {
"description": "Returned when the account has been deactivated."
},
"410": {
"description": "Returned when the account is no longer available."
}
},
"tags": [
"Login"
]
}
},
"/api/login/user": {
"post": {
"summary": "Login User",
"description": "Authenticate User and return object with JSON Web Token. It's possible to login via email or phone number.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserLogin",
"type": "string"
}
}
},
"description": "JSON with login credencials in Request body."
},
"responses": {
"200": {
"description": "Returned JSON Web Token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Returned when authentication failed due to incorrect login or password."
},
"403": {
"description": "Returned when the account has been deactivated."
},
"410": {
"description": "Returned when the account is no longer available."
}
},
"tags": [
"Login"
]
}
},
"/api/me": {
"get": {
"summary": "Get Current User",
"description": "Return current User entity.",
"responses": {
"200": {
"description": "Returned specific entity of User.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"tags": [
"Me"
]
},
"put": {
"summary": "Update User",
"description": "Update User entity to the database.",
"requestBody": {
"$ref": "#/components/requestBodies/UserUpdate"
},
"responses": {
"200": {
"description": "Returns updated User.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Me"
]
}
},
"/api/missing-stock/list": {
"post": {
"summary": "Get list of Missing Stocks",
"description": "Find and return set of Missing Stocks entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MissingStockListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results21"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Missing Stock"
]
}
},
"/api/missing-stock/export.{type}": {
"post": {
"summary": "Export Missing Stocks",
"description": "Find and export of Missing Stock entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls",
"ods"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MissingStockExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Missing Stock"
]
}
},
"/api/missing-stock/{id}": {
"get": {
"summary": "Get Missing Stock",
"description": "Find and return one specific Missing Stock entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Missing Stock.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionItem"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Missing Stock"
]
}
},
"/api/notification/{id}": {
"get": {
"summary": "Get Notification",
"description": "Find and return one specific Notification entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier of the entity. Example: `oEjOGIABbGY_VJusbqWA`",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Notification.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Notification"
]
},
"put": {
"summary": "Update Notification",
"description": "Update Notification entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification2",
"type": "string"
}
}
},
"description": "JSON of new Notification sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Notification.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Notification"
]
}
},
"/api/notification/{organisationId}/subscribers": {
"get": {
"summary": "Get Notification Subscribes",
"description": "Find and return available users of organisation.",
"parameters": [
{
"name": "organisationId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returned user of organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results22"
}
}
}
},
"403": {
"description": "User dont have access to other organisation."
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Notification"
]
}
},
"/api/notification/list": {
"post": {
"summary": "Get list of Carriers",
"description": "Find and return set of Carrier entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results23"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Notification"
]
}
},
"/api/notification/count/{organisationId}/unseen": {
"get": {
"summary": "Count Notifications",
"description": "Find and return one specific Notification entity by ID.",
"parameters": [
{
"name": "organisationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned count of Notifications."
}
},
"tags": [
"Notification"
]
}
},
"/api/notification-setting/{id}": {
"get": {
"summary": "Get NotificationSetting",
"description": "Find and return one specific NotificationSetting entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of NotificationSetting.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSetting"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Notification Setting"
]
},
"put": {
"summary": "Update NotificationSetting",
"description": "Update NotificationSetting entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSetting2",
"type": "string"
}
}
},
"description": "JSON of updated NotificationSetting sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of NotificationSetting.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSetting"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Notification Setting"
]
},
"delete": {
"summary": "Delete NotificationSetting",
"description": "Delete NotificationSetting entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned when success."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Notification Setting"
]
}
},
"/api/notification-setting/list": {
"post": {
"summary": "Get list of NotificationSetting",
"description": "Find and return set of NotificationSetting entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSettingListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results24"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Notification Setting"
]
}
},
"/api/notification-setting": {
"post": {
"summary": "Create Product Stock NotificationSetting",
"description": "Create and insert a new NotificationSetting entity to the database.",
"responses": {
"201": {
"description": "Returns newly created entity of NotificationSetting.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSetting"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Notification Setting"
]
}
},
"/api/organisation/info/{registrationNumber}": {
"get": {
"summary": "Get Organisation from trade registry",
"description": "Find and return Organisation info from trade register.",
"parameters": [
{
"name": "registrationNumber",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[0-9]+"
}
}
],
"responses": {
"200": {
"description": "Returned Organisation info.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AresInfo"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/list": {
"post": {
"summary": "Get list of Organisations",
"description": "Find and return set of Organisation entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganisationListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results25"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}": {
"get": {
"summary": "Get Organisation",
"description": "Find and return one specific Organisation entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
},
"put": {
"summary": "Update Organisation",
"description": "Update Organisation entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation3",
"type": "string"
}
}
},
"description": "JSON of new Organisation sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Organisation.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
},
"delete": {
"summary": "Delete Organisation",
"description": "Permanently delete Organisation. Organisation will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/owner/{userId}": {
"put": {
"summary": "Add Owner to Organisation",
"description": "Add Owner to Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/user/{userId}": {
"put": {
"summary": "Add User to Organisation",
"description": "Add User to Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
},
"delete": {
"summary": "Remove User from Organisation",
"description": "Remove User from Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/admin/{adminId}": {
"put": {
"summary": "Add Admin to Organisation",
"description": "Add Admin to Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "adminId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
},
"delete": {
"summary": "Remove Admin from Organisation",
"description": "Remove Admin from Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "adminId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation": {
"post": {
"summary": "Create Organisation",
"description": "Create and insert a new Organisation entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation2",
"type": "string"
}
}
},
"description": "JSON of new Organisation sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Organisation.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/activate/{id}": {
"put": {
"summary": "Activate Organisation",
"description": "Set Organisations flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/deactivate/{id}": {
"put": {
"summary": "Dectivate Organisation",
"description": "Set Organisations flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/user-add": {
"put": {
"summary": "Add multiple Users to Organisation",
"description": "Add multiple Users to Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/UserList"
},
"responses": {
"200": {
"description": "Returned updated Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/user-remove": {
"put": {
"summary": "Remove multiple Users from Organisation",
"description": "Remove multiple Users from Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/UserList"
},
"responses": {
"200": {
"description": "Returned updated Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/activate": {
"put": {
"summary": "Activate multiple Organisations",
"description": "Set flag 'active' of multiple Organisations to true.",
"requestBody": {
"$ref": "#/components/requestBodies/OrganisationList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/deactivate": {
"put": {
"summary": "Deactivate multiple Organisations",
"description": "Set flag 'active' of multiple Organisations to false.",
"requestBody": {
"$ref": "#/components/requestBodies/OrganisationList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/delete": {
"put": {
"summary": "Delete multiple Organisations",
"description": "Permanently delete multiple Organisations. Organisations will be no longer available.",
"requestBody": {
"$ref": "#/components/requestBodies/OrganisationList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/carrier/{carrierId}": {
"put": {
"summary": "Add Carrier to Organisation",
"description": "Add Carrier to the list of allowed Carriers for the Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "carrierId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned updated Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
},
"delete": {
"summary": "Remove Carrier from Organisation",
"description": "Remove Carrier from the list of allowed Carriers for the Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "carrierId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned updated Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/carrier-add": {
"put": {
"summary": "Add multiple Carriers to Organisation",
"description": "Add multiple Carriers to the list of allowed Carriers for the Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CarrierList"
},
"responses": {
"200": {
"description": "Returned updated Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/carrier-remove": {
"put": {
"summary": "Remove multiple Carriers from Organisation",
"description": "Remove multiple Carriers from the list of allowed Carriers for the Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CarrierList"
},
"responses": {
"200": {
"description": "Returned updated Organisation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organisation"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/{id}/available-wmses": {
"get": {
"summary": "Get List of available Wmses",
"description": "Return list of Wmses available for specific Organisation entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Organisation.",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Wms"
},
"type": "array"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/enable-mailstage-product-to-all-eshops/{id}": {
"put": {
"summary": "When enabled, products created via Mailstage endpoint are linked to all eshops related to this Organisation.",
"description": "Set Organisations flag 'mailstageProductToAllEshops' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/organisation/disable-mailstage-product-to-all-eshops/{id}": {
"put": {
"summary": "When disabled, products created via Mailstage endpoint are linked only to Eshop related to Mailstage user account.",
"description": "Set Organisations flag 'mailstageProductToAllEshops' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Organisation"
]
}
},
"/api/outbound-receipt/list": {
"post": {
"summary": "Get list of Outbound Receipts",
"description": "Find and return set of Outbound Receipt entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundReceiptListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results26"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Outbound Receipt"
]
}
},
"/api/outbound-receipt/export.{type}": {
"post": {
"summary": "Export Inbound Receipts",
"description": "Find and export of Inbound Receipts entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls",
"ods"
]
}
},
{
"name": "hideItems",
"in": "query",
"description": "Set value 1 to export only outbound receipt data without items",
"schema": {
"type": "integer",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundReceiptExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Outbound Receipt"
]
}
},
"/api/outbound-receipt/{id}": {
"get": {
"summary": "Get Outbound Receipt",
"description": "Find and return one specific Outbound Receipt entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Outbound Receipt.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundReceipt"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Outbound Receipt"
]
}
},
"/api/partner/list": {
"post": {
"summary": "Get list of Partner",
"description": "Find and return set of Partner entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results27"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Partner"
]
}
},
"/api/partner/{id}": {
"get": {
"summary": "Get Partner",
"description": "Find and return one specific Partner entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Partner.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Partner"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Partner"
]
},
"put": {
"summary": "Update Partner",
"description": "Update Partner entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Partner3",
"type": "string"
}
}
},
"description": "JSON of updated Partner sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Partner.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Partner"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Partner"
]
},
"delete": {
"summary": "Delete Partner",
"description": "Permanently delete Partner. Partner will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Partner"
]
}
},
"/api/partner": {
"post": {
"summary": "Create Partner",
"description": "Create and insert a new Partner entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Partner2",
"type": "string"
}
}
},
"description": "JSON of new Partner sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Partner.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Partner"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Partner"
]
}
},
"/api/partner/activate/{id}": {
"put": {
"summary": "Activate Partner",
"description": "Set Partner flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Partner"
]
}
},
"/api/partner/deactivate/{id}": {
"put": {
"summary": "Deactivate Partner",
"description": "Set Partner flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Partner"
]
}
},
"/api/partner/activate": {
"put": {
"summary": "Activate multiple Partners",
"description": "Set flag 'active' of multiple Partners to true.",
"requestBody": {
"$ref": "#/components/requestBodies/PartnerList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Partner"
]
}
},
"/api/partner/deactivate": {
"put": {
"summary": "Deactivate multiple Partners",
"description": "Set flag 'active' of multiple Partners to false.",
"requestBody": {
"$ref": "#/components/requestBodies/PartnerList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Partner"
]
}
},
"/api/partner/delete": {
"put": {
"summary": "Delete multiple Partners",
"description": "Permanently delete multiple Partners. Partners will be no longer available.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerList",
"type": "string"
}
}
},
"description": "JSON with list of entities."
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Partner"
]
}
},
"/api/product/list": {
"post": {
"summary": "Get list of Products",
"description": "Find and return set of Product entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results28"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/{id}": {
"get": {
"summary": "Get Product",
"description": "Find and return one specific Product entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Product.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product"
]
},
"put": {
"summary": "Update Product",
"description": "Update Product entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product3",
"type": "string"
}
}
},
"description": "JSON of new Product sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Product.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
},
"delete": {
"summary": "Delete Product",
"description": "Permanently delete Product. Product will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product"
]
}
},
"/api/product": {
"post": {
"summary": "Create Product",
"description": "Create and insert a new Product entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product2",
"type": "string"
}
}
},
"description": "JSON of new Product sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Product.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/activate/{id}": {
"put": {
"summary": "Activate Product",
"description": "Set Product flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product"
]
}
},
"/api/product/deactivate/{id}": {
"put": {
"summary": "Dectivate Product",
"description": "Set Product flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product"
]
}
},
"/api/product/template.{type}": {
"get": {
"summary": "Template for Product Import",
"description": "Return Excel or CSV template which could be used for product import.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
}
],
"responses": {
"200": {
"description": "Returned on success.",
"content": {
"application/csv": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.ms-excel": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/import": {
"post": {
"summary": "Import Products",
"description": "Import products from CSV, XLS or XLSX.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"organisation": {
"type": "string",
"format": "uuid"
}
},
"required": [
"file",
"organisation"
]
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No data on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/activate": {
"put": {
"summary": "Activate multiple Products",
"description": "Set flag 'active' of multiple Products to true.",
"requestBody": {
"$ref": "#/components/requestBodies/ProductList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/deactivate": {
"put": {
"summary": "Deactivate multiple Products",
"description": "Set flag 'active' of multiple Products to false.",
"requestBody": {
"$ref": "#/components/requestBodies/ProductList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/delete": {
"put": {
"summary": "Delete multiple Products",
"description": "Permanently delete multiple Products. Products will be no longer available.",
"requestBody": {
"$ref": "#/components/requestBodies/ProductList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product/export.{type}": {
"post": {
"summary": "Export Products",
"description": "Find and export of Product entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product"
]
}
},
"/api/product-group/list": {
"post": {
"summary": "Get list of Product Groups",
"description": "Find and return set of Product Group entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductGroupListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results29"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Groups"
]
}
},
"/api/product-group": {
"post": {
"summary": "Create Product Group",
"description": "Create and insert a new Product Group entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductGroup",
"type": "string"
}
}
},
"description": "JSON of new ProductGroup sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Product Group.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductGroup2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Groups"
]
}
},
"/api/product-group/{id}": {
"put": {
"summary": "Update Product Group",
"description": "Update Product Group entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductGroup3",
"type": "string"
}
}
},
"description": "JSON of updated Product Group sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of ProductGroup.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductGroup2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Groups"
]
}
},
"/api/product/{productId}/image/upload": {
"post": {
"summary": "Upload Product Image (FORM)",
"description": "Product image upload.",
"parameters": [
{
"name": "productId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Product entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/postApiCarrier_carrierid_imageUpload"
},
"responses": {
"201": {
"description": "Returns newly created entity of Product Image.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductImage2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Image"
]
},
"put": {
"summary": "Upload Product Image (JSON)",
"description": "Product image upload.",
"parameters": [
{
"name": "productId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Product entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductImage",
"type": "string"
}
}
},
"description": "JSON of new Product Image sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Product Image.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductImage2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Image"
]
}
},
"/api/product/{productId}/image/{imageId}": {
"get": {
"summary": "Get Product Image",
"description": "Find and return one specific Product Image entity by ID.",
"parameters": [
{
"name": "productId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Product entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Product Image.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductImage2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product Image"
]
},
"delete": {
"summary": "Delete Product Image",
"description": "Permanently delete product image. It will be no longer available.",
"parameters": [
{
"name": "productId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the Product entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "imageId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product Image"
]
}
},
"/api/product-stock/list": {
"post": {
"summary": "Get list of Stock",
"description": "Find and return set of Product in stock based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductStockListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results30"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Stock"
]
}
},
"/api/product-stock/{id}": {
"get": {
"summary": "Get Product Stock",
"description": "Find and return one specific Product Stock entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Product Stock.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductStock2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Product Stock"
]
}
},
"/api/product-stock/export.{type}": {
"post": {
"summary": "Export Product Stocks",
"description": "Find and export of Product Stock entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls",
"ods"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductStockExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Product Stock"
]
}
},
"/api/report/stock-movement": {
"post": {
"summary": "Get report of Stock movements",
"description": "Find and return set of rows based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementReportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results31"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Report"
]
}
},
"/api/report/expedition": {
"post": {
"summary": "Get report of Expedition",
"description": "Find and return set of rows based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionReportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results32"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Report"
]
}
},
"/api/report/count-complaints": {
"post": {
"summary": "Get report of Complaint",
"description": "Find and return count of Complaints entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplaintReportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results33"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Report"
]
}
},
"/api/request-reset-password/admin": {
"post": {
"summary": "Request Reset Admin password",
"description": "Request Reset Admin password.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminResetPasswordRequest",
"type": "string"
}
}
},
"description": "JSON with login credencials in Request body."
},
"responses": {
"204": {
"description": "No value"
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Returned when the account has not been found."
},
"410": {
"description": "Returned when the account is no longer available."
}
},
"tags": [
"Login"
]
}
},
"/api/request-reset-password/user": {
"post": {
"summary": "Request Reset User password",
"description": "Request Reset User password.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResetPasswordRequest",
"type": "string"
}
}
},
"description": "JSON with login credencials in Request body."
},
"responses": {
"204": {
"description": "No value"
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Returned when the account has not been found."
},
"410": {
"description": "Returned when the account is no longer available."
}
},
"tags": [
"Login"
]
}
},
"/api/reservation/list": {
"post": {
"summary": "Get list of Reservations",
"description": "Find and return set of Reservations entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results34"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Reservation"
]
}
},
"/api/reservation/list/partially-delivered": {
"post": {
"summary": "Get list of partially delivered reservations",
"description": "Used for bubble with warning about unproccessed partially delivered reservations.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationNotificationCountSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned count with partially delivered reservations.",
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Reservation"
]
}
},
"/api/reservation/{id}": {
"get": {
"summary": "Get Reservation",
"description": "Find and return one specific Reservation entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Reservation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionItem2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Reservation"
]
}
},
"/api/reservation/{id}/unbook": {
"patch": {
"summary": "Unbook all from Expedition Item",
"description": "Unbook all from Expedition Item",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returns entity of Expedition Item.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionItem2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Reservation"
]
}
},
"/api/reservation/unbook": {
"put": {
"summary": "Unbook multiple reservations",
"description": "Unbook multiple reservations",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionItemList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Reservation"
]
}
},
"/api/reservation/{id}/move/{targetExpedition}": {
"patch": {
"summary": "Move Expedition Item to target Expedition",
"description": "Move Expedition Item to target Expedition. Moved Expedition Item (= Reservation) will gain new ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "targetExpedition",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful move."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Reservation"
]
}
},
"/api/reset-password/admin": {
"post": {
"summary": "Reset Admin password",
"description": "Reset Admin password and return JSON Web Token.",
"requestBody": {
"$ref": "#/components/requestBodies/ResetPassword"
},
"responses": {
"200": {
"description": "Returned JSON Web Token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPassword"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Returned when the account or token has not been found."
},
"410": {
"description": "Returned when the account is no longer available."
}
},
"tags": [
"Login"
]
}
},
"/api/reset-password/user": {
"post": {
"summary": "Reset User password",
"description": "Reset User password and return JSON Web Token.",
"requestBody": {
"$ref": "#/components/requestBodies/ResetPassword"
},
"responses": {
"200": {
"description": "Returned JSON Web Token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Returned when the account or token has not been found."
},
"410": {
"description": "Returned when the account is no longer available."
}
},
"tags": [
"Login"
]
}
},
"/api/return-receipt/list": {
"post": {
"summary": "Get list of Return Receipts",
"description": "Find and return set of Return Receipt entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnReceiptListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results35"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Return Receipt"
]
}
},
"/api/return-receipt/export.{type}": {
"post": {
"summary": "Export return receipts",
"description": "Find and export of return receipts entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls",
"ods"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnReceiptExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Return Receipt"
]
}
},
"/api/return-receipt/{id}": {
"get": {
"summary": "Get Return Receipt",
"description": "Find and return one specific Return Receipt entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Return Receipt.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundReceipt2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Return Receipt"
]
}
},
"/api/service/set-status/{expeditionId}/{requestedStatus}": {
"put": {
"summary": "Set Expedition status",
"description": "Set Expedition entity status by ID.",
"parameters": [
{
"name": "expeditionId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "requestedStatus",
"in": "path",
"required": true,
"description": "Status we want to set for this Expedition. Example: `on_hold`",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns updated entity of Expedition.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Expedition3"
}
}
}
},
"400": {
"description": "Returned when status cannot be updated into requested status."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Service"
]
}
},
"/api/stock-advice/list": {
"post": {
"summary": "Get list of Stock Advices",
"description": "Find and return set of Stock Advice entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results36"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/export.{type}": {
"post": {
"summary": "Export Stock Advices",
"description": "Find and export of Stock Advice entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/{id}": {
"get": {
"summary": "Get Stock Advice",
"description": "Find and return one specific Stock Advice entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock Advice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice"
]
},
"put": {
"summary": "Update Stock Advice",
"description": "Update Stock Advice entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/StockAdvice3"
},
"responses": {
"200": {
"description": "Returns entity of Stock Advice.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
},
"delete": {
"summary": "Delete Stock Advice",
"description": "Permanently delete Stock Advice. Stock Advice will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice": {
"post": {
"summary": "Create Stock Advice",
"description": "Create and insert a new Stock Advice entity to the database.",
"requestBody": {
"$ref": "#/components/requestBodies/StockAdvice3"
},
"responses": {
"201": {
"description": "Returns newly created entity of Stock Advice.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/status/{id}/{status}": {
"put": {
"summary": "Update Stock Advice status",
"description": "Update status of one specific Stock Advice entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "status",
"in": "path",
"required": true,
"description": "New status of Stock Advice",
"schema": {
"type": "string",
"enum": [
"on-hold",
"new"
]
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock Advice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice4"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/close/{id}": {
"put": {
"summary": "Close Stock Advice",
"description": "Close Stock Advice by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock Advice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice4"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/open/{id}": {
"put": {
"summary": "Open closed Stock Advice",
"description": "Open closed Stock Advice by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock Advice.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice4"
}
}
}
},
"400": {
"description": "Returned if status change is not possible."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/template-item.{type}": {
"get": {
"summary": "Template for Stock Advice Item Import",
"description": "Return Excel or CSV template which could be used for Stock Advice Item import.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
}
],
"responses": {
"200": {
"description": "Returned on success.",
"content": {
"application/csv": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.ms-excel": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/template.{type}": {
"get": {
"summary": "Template for Stock Advice Import",
"description": "Return Excel or CSV template which could be used for Stock Advice import.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
},
{
"name": "organisation_id",
"in": "query",
"description": "Organisation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returned on success.",
"content": {
"application/csv": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.ms-excel": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/import-item": {
"post": {
"summary": "Import Stock Advice Items",
"description": "Import Stock Advice Items from CSV, XLS or XLSX.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"stock_advice",
"file"
],
"properties": {
"stock_advice": {
"$ref": "#/components/schemas/StockAdvice5"
},
"file": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
},
"description": "Multipart request must include 2 parts. JSON of the Stock Advice and file. Example: \n --X-INSOMNIA-BOUNDARY--
"
},
"responses": {
"204": {
"description": "No data on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/import": {
"post": {
"summary": "Import Stock Advice",
"description": "Import Stock Advice from CSV, XLS or XLSX.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"organisation",
"file"
],
"properties": {
"organisation": {
"$ref": "#/components/schemas/Organisation"
},
"file": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
},
"description": "Multipart request must include 2 parts. JSON of the Organisation and file. Example: --X-INSOMNIA-BOUNDARY--
"
},
"responses": {
"204": {
"description": "No data on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/status/{status}": {
"put": {
"summary": "Set status of multiple StockAdvices",
"description": "Set status to multipe StockAdvice entities.",
"parameters": [
{
"name": "status",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/StockAdviceList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/cancel": {
"put": {
"summary": "Cancel multiple stock advices",
"description": "Cancel multipe StockAdvice entities.",
"requestBody": {
"$ref": "#/components/requestBodies/StockAdviceList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/{id}/audit": {
"post": {
"summary": "Get Audit Log",
"description": "Get Stock Advice Audit Log",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/AuditRecordSearch"
},
"responses": {
"200": {
"description": "Returned list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice/{id}/pairing": {
"post": {
"summary": "Pairing stock advice to expedition",
"description": "pairing stock advice to expedition",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceBookExpeditionUpdate",
"type": "string"
}
}
},
"description": "JSON of new Stock Advice sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Stock Advice.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice"
]
}
},
"/api/stock-advice-item/list": {
"post": {
"summary": "Get list of StockAdviceItems",
"description": "Find and return set of StockAdviceItem entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceItemListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results37"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice Item"
]
}
},
"/api/stock-advice-item": {
"post": {
"summary": "Create StockAdviceItem",
"description": "Create and insert a new StockAdviceItem entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceItem",
"type": "string"
}
}
},
"description": "JSON of new StockAdviceItem sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of StockAdviceItem.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceItem2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice Item"
]
}
},
"/api/stock-advice-item/{id}": {
"get": {
"summary": "Get StockAdviceItem",
"description": "Find and return one specific StockAdviceItem entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of StockAdviceItem.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceItem2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice Item"
]
},
"put": {
"summary": "Update StockAdviceItem",
"description": "Update StockAdviceItem entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceItem3",
"type": "string"
}
}
},
"description": "JSON of new StockAdviceItem sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of StockAdviceItem.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceItem2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Advice Item"
]
},
"delete": {
"summary": "Delete StockAdviceItem",
"description": "Permanently delete StockAdviceItem. StockAdviceItem will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Advice Item"
]
}
},
"/api/stock-change/list": {
"post": {
"summary": "Get list of Stock changes",
"description": "Find and return set of Stock change entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockChangeListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results38"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Change"
]
}
},
"/api/stock-change/{id}": {
"get": {
"summary": "Get Stock change",
"description": "Find and return one specific Stock change entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock change.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockChange"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Change"
]
}
},
"/api/stock-change/process": {
"put": {
"summary": "Process multiple stockChanges",
"description": "Send multipe stockChange entities to processing.",
"requestBody": {
"$ref": "#/components/requestBodies/StockChangeList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Change"
]
}
},
"/api/stock-change/cancel": {
"put": {
"summary": "Cancel multiple stockChanges",
"description": "Cancel multipe stockChange entities.",
"requestBody": {
"$ref": "#/components/requestBodies/StockChangeList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Change"
]
}
},
"/api/stock-movement/list": {
"post": {
"summary": "Get list of Stock Movements",
"description": "Find and return set of Stock Movement entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results39"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Movement"
]
}
},
"/api/stock-movement/{id}": {
"get": {
"summary": "Get Stock Movement",
"description": "Find and return one specific Stock Movement entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Stock Movement.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovement2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Stock Movement"
]
}
},
"/api/stock-movement/export.{type}": {
"post": {
"summary": "Export Stock Movements",
"description": "Find and export of Stock Movement entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls|ods",
"enum": [
"csv",
"xlsx",
"xls",
"ods"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Stock Movement"
]
}
},
"/api/supplier/list": {
"post": {
"summary": "Get list of Supplier",
"description": "Find and return set of Supplier entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results40"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier/{id}": {
"get": {
"summary": "Get Supplier",
"description": "Find and return one specific Supplier entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Supplier.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Supplier"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Supplier"
]
},
"put": {
"summary": "Update Supplier",
"description": "Update Supplier entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Supplier3",
"type": "string"
}
}
},
"description": "JSON of updated Supplier sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Supplier.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Supplier"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Supplier"
]
},
"delete": {
"summary": "Delete Supplier",
"description": "Permanently delete Supplier. Supplier will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier": {
"post": {
"summary": "Create Supplier",
"description": "Create and insert a new Supplier entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Supplier2",
"type": "string"
}
}
},
"description": "JSON of new Supplier sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Supplier.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Supplier"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier/activate/{id}": {
"put": {
"summary": "Activate Supplier",
"description": "Set Supplier flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier/deactivate/{id}": {
"put": {
"summary": "Deactivate Supplier",
"description": "Set Supplier flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier/activate": {
"put": {
"summary": "Activate multiple Suppliers",
"description": "Set flag 'active' of multiple Suppliers to true.",
"requestBody": {
"$ref": "#/components/requestBodies/SupplierList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier/deactivate": {
"put": {
"summary": "Deactivate multiple Suppliers",
"description": "Set flag 'active' of multiple Suppliers to false.",
"requestBody": {
"$ref": "#/components/requestBodies/SupplierList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Supplier"
]
}
},
"/api/supplier/delete": {
"put": {
"summary": "Delete multiple Suppliers",
"description": "Permanently delete multiple Suppliers. Suppliers will be no longer available.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierList",
"type": "string"
}
}
},
"description": "JSON with list of entities."
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Supplier"
]
}
},
"/api/refresh-token": {
"post": {
"summary": "Refresh Token",
"description": "Authenticate and return object with JSON Web Token.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshToken",
"type": "string"
}
}
},
"description": "JSON with login credencials in Request body."
},
"responses": {
"200": {
"description": "Returned JSON Web Token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Refresh Token"
]
}
},
"/api/transfer/{id}": {
"get": {
"summary": "Get Transfer",
"description": "Find and return one specific Transfer entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Transfer.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Transfer"
]
},
"put": {
"summary": "Update Transfer",
"description": "Update Transfer entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer3",
"type": "string"
}
}
},
"description": "JSON of updated Transfer sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Transfer.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
},
"patch": {
"summary": "Rebook Transfer",
"description": "Rebook Transfer entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returns entity of Transfer.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer/list": {
"post": {
"summary": "Get list of Transfer",
"description": "Find and return set of Transfer entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results41"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer/send": {
"put": {
"summary": "Send multiple transfers to WMS",
"description": "Send multipe transfer entities to WMS for processing.",
"requestBody": {
"$ref": "#/components/requestBodies/TransferList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer/cancel": {
"put": {
"summary": "Cancel multiple transfers",
"description": "Cancel multipe transfer entities.",
"requestBody": {
"$ref": "#/components/requestBodies/TransferList"
},
"responses": {
"200": {
"description": "Returned list with results on partial success.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MassActionResultList"
}
}
}
},
"204": {
"description": "Returned on success."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer": {
"post": {
"summary": "Create Transfer",
"description": "Create and insert a new Transfer entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer2",
"type": "string"
}
}
},
"description": "JSON of new Transfer sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Transfer.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer/{id}/send": {
"put": {
"summary": "Send Transfer to WMS",
"description": "Send Transfer entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Transfer.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer/{id}/cancel": {
"put": {
"summary": "Cancel Transfer",
"description": "Cancel Transfer entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Transfer.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transfer"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Transfer"
]
}
},
"/api/transfer/export.{type}": {
"post": {
"summary": "Export Transfer",
"description": "Find and export of Transfer entities based on search criteria.",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"description": "File type to generate",
"schema": {
"type": "string",
"pattern": "csv|xlsx|xls",
"enum": [
"csv",
"xlsx",
"xls"
]
}
},
{
"name": "hideItems",
"in": "query",
"description": "Set value 1 to export only Transfer entities data without items",
"schema": {
"type": "integer",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferListExportSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned specific entity of Job.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportJob"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Transfer"
]
}
},
"/api/user/{id}": {
"get": {
"summary": "Get User",
"description": "Find and return one specific User entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of User.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"User"
]
},
"put": {
"summary": "Update User",
"description": "Update User entity to the database.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/UserUpdate"
},
"responses": {
"200": {
"description": "Returns updated User.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
},
"delete": {
"summary": "Delete User",
"description": "Permanently delete User. User will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"User"
]
}
},
"/api/user/list": {
"post": {
"summary": "Get list of Users",
"description": "Find and return set of User entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results22"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/user/{id}/organisation/{orgId}": {
"put": {
"summary": "Add User to Organisation",
"description": "Add User to Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"User"
]
},
"delete": {
"summary": "Remove User from Organisation",
"description": "Remove User from Organisation.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "orgId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"User"
]
}
},
"/api/user": {
"post": {
"summary": "Create User",
"description": "Create and insert a new User entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User2",
"type": "string"
}
}
},
"description": "JSON of new User sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of User.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/user/create-by-organisation-owner": {
"post": {
"summary": "Create User by Organisation owner",
"description": "Create and insert a new User entity to the database and link it to organisation.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User3",
"type": "string"
}
}
},
"description": "JSON of new User sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of User.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/user/register": {
"post": {
"summary": "Register User",
"description": "Create regstration of new User. After the successful registration an activation email is sended.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User4",
"type": "string"
}
}
},
"description": "JSON of new User sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of User.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/user/activate/{id}": {
"put": {
"summary": "Activate User",
"description": "Set Users flag 'active' to true.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"User"
]
}
},
"/api/user/deactivate/{id}": {
"put": {
"summary": "Dectivate User",
"description": "Set Users flag 'active' to false.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful update."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"User"
]
}
},
"/api/user/activate": {
"put": {
"summary": "Activate multiple Users",
"description": "Set flag 'active' of multiple Users to true.",
"requestBody": {
"$ref": "#/components/requestBodies/UserList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/user/deactivate": {
"put": {
"summary": "Deactivate multiple Users",
"description": "Set flag 'active' of multiple Users to false.",
"requestBody": {
"$ref": "#/components/requestBodies/UserList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/user/delete": {
"put": {
"summary": "Delete multiple Users",
"description": "Permanently delete multiple Users. Users will be no longer available.",
"requestBody": {
"$ref": "#/components/requestBodies/UserList"
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"User"
]
}
},
"/api/warehouse/list": {
"post": {
"summary": "Get list of Warehouse",
"description": "Find and return set of Warehouse entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results42"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Warehouse"
]
}
},
"/api/warehouse/{id}": {
"get": {
"summary": "Get Warehouse",
"description": "Find and return one specific Warehouse entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Warehouse.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Warehouse"
]
},
"put": {
"summary": "Update Warehouse",
"description": "Update Warehouse entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse3",
"type": "string"
}
}
},
"description": "JSON of updated Warehouse sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Warehouse.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Warehouse"
]
},
"delete": {
"summary": "Delete Warehouse",
"description": "Permanently delete Warehouse. Warehouse will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Warehouse"
]
}
},
"/api/warehouse": {
"post": {
"summary": "Create Warehouse",
"description": "Create and insert a new Warehouse entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse2",
"type": "string"
}
}
},
"description": "JSON of new Warehouse sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Warehouse.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Warehouse"
]
}
},
"/api/warehouse/delete": {
"put": {
"summary": "Delete multiple Warehouses",
"description": "Permanently delete multiple Warehouses. Warehouses will be no longer available.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"responses": {
"204": {
"description": "Returned on successful update."
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Warehouse"
]
}
},
"/api/warehouse/{id}/wms/{wmsId}": {
"put": {
"summary": "Add WMS to Warehouse",
"description": "Add WMS to Warehouse.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "wmsId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Warehouse"
]
},
"delete": {
"summary": "Remove WMS from Warehouse",
"description": "Remove WMS from Warehouse.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
},
{
"name": "wmsId",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "No content on success"
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Warehouse"
]
}
},
"/api/warehouse/{id}/wms-add": {
"put": {
"summary": "Add multiple WMSes to Warehouse",
"description": "Add multiple WMSes to Warehouse.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/WmsList"
},
"responses": {
"200": {
"description": "Returned updated Warehouse.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Warehouse"
]
}
},
"/api/warehouse/{id}/wms-remove": {
"put": {
"summary": "Remove multiple WMSes from Warehouse",
"description": "Remove multiple WMSes from Warehouse.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/WmsList"
},
"responses": {
"200": {
"description": "Returned updated Warehouse.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Warehouse"
]
}
},
"/api/wms/{id}": {
"get": {
"summary": "Get Wms",
"description": "Find and return one specific Wms entity by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"format": "uuid",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"200": {
"description": "Returned specific entity of Wms.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wms2"
}
}
}
},
"404": {
"description": "Returned when no entity was found."
}
},
"tags": [
"Wms"
]
},
"put": {
"summary": "Update Wms",
"description": "Update Wms entity.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wms4",
"type": "string"
}
}
},
"description": "JSON of updated Wms sent in Request body."
},
"responses": {
"200": {
"description": "Returns entity of Wms.",
"headers": {
"Location": {
"description": "URL of the entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wms2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Wms"
]
},
"delete": {
"summary": "Delete Wms",
"description": "Permanently delete Wms. Wms will be no longer available.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Identifier (UUID) of the entity. Example: `529baf4b-b7f1-4ff4-827f-b05f52a1a22f`",
"schema": {
"type": "string",
"pattern": "[a-f\\d]{8}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{4}-[a-f\\d]{12}"
}
}
],
"responses": {
"204": {
"description": "Returned on successful delete."
},
"404": {
"description": "Returned when no entity was found."
},
"410": {
"description": "Returned when entity is no longer available."
}
},
"tags": [
"Wms"
]
}
},
"/api/wms/list": {
"post": {
"summary": "Get list of Wms",
"description": "Find and return set of Wms entities based on search criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WmsListSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"responses": {
"200": {
"description": "Returned list with results.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Results43"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Wms"
]
}
},
"/api/wms": {
"post": {
"summary": "Create Wms",
"description": "Create and insert a new Wms entity to the database.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wms3",
"type": "string"
}
}
},
"description": "JSON of new Wms sent in Request body."
},
"responses": {
"201": {
"description": "Returns newly created entity of Wms.",
"headers": {
"Location": {
"description": "URL of the new entity.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wms2"
}
}
}
},
"400": {
"description": "Returned when request contains invalid data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"Wms"
]
}
},
"/api/webhook/mailwise/product": {
"post": {
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/webhook/mailwise/dispatch": {
"post": {
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/webhook/mailwise/order": {
"post": {
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/webhook/mailwise/receipt": {
"post": {
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/webhook/mailwise/outbound-receipt": {
"post": {
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/webhook/mailwise/advance-ship-notice": {
"post": {
"responses": {
"default": {
"description": ""
}
}
}
}
},
"servers": [
{
"url": "http://app.mailship.eu/"
}
],
"components": {
"requestBodies": {
"Complaint3": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Complaint3",
"type": "string"
}
}
},
"description": "JSON of new Complaint sent in Request body."
},
"StockAdvice3": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdvice3",
"type": "string"
}
}
},
"description": "JSON of new Stock Advice sent in Request body."
},
"ResetPassword": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPassword",
"type": "string"
}
}
},
"description": "JSON with login credencials in Request body."
},
"InternalStockChangeList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalStockChangeList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"UserList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"StockChangeList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockChangeList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"postApiCarrier_carrierid_imageUpload": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"imageFile": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"imageFile"
]
}
}
},
"required": true
},
"SupplierList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"UserUpdate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserUpdate",
"type": "string"
}
}
},
"description": "JSON of new User sent in Request body."
},
"ExpeditionList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpeditionList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"AdminList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"EshopList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EshopList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"AuditRecordSearch": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditRecordSearch",
"type": "string"
}
}
},
"description": "JSON with search request details."
},
"OrganisationList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganisationList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"DailyReportRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DailyReportRequest",
"type": "string"
}
}
},
"description": "JSON with organisation ids, date and flag for ignoring reported field."
},
"CarrierList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"PartnerList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"ProductList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"StockAdviceList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockAdviceList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"TransferList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
},
"WmsList": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WmsList",
"type": "string"
}
}
},
"description": "JSON with list of entity identifiers."
}
},
"schemas": {
"Admin": {
"required": [
"location",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"location": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"roles": {
"description": "User roles.",
"example": [
"ROLE_SUPERVISOR"
],
"items": {
"type": "string"
},
"type": "array"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
},
"changedAt": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"AdminListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"email": {
"$ref": "#/components/schemas/StringCondition"
},
"location": {
"$ref": "#/components/schemas/StringCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"location\"` `\"firstName\"` `\"lastName\"` `\"email\"` `\"createdAt\"` `\"phone\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "firstName"
},
{
"field": "lastName"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"location\"` `\"roles\"` `\"organisations\"` `\"id\"` `\"firstName\"` `\"lastName\"` `\"email\"` `\"createdAt\"` `\"active\"` `\"phone\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"location",
"roles",
"organisations",
"id",
"firstName",
"lastName",
"email",
"createdAt",
"active",
"phone",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results": {
"properties": {
"results": {
"$ref": "#/components/schemas/Admin3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Error": {
"properties": {
"message": {
"description": "General description of issue.",
"example": "Invalid JSON data.",
"type": "string"
},
"messageTemplate": {
"description": "General description of issue.",
"example": "Invalid JSON data.",
"type": "string"
},
"detail": {
"description": "More detailed information.",
"type": "string"
},
"data": {
"description": "Some issues can provide additional 'key':'value' data.",
"type": "object"
},
"violations": {
"description": "Validation errors contains this list with details.",
"items": {
"properties": {
"message": {
"description": "Error title (e.g. *This value is not valid*).",
"example": "This value should not be blank.",
"type": "string"
},
"propertyPath": {
"description": "Path of field (e.g. *items[0].productCode*).",
"example": "firstName",
"type": "string"
},
"code": {
"description": "Error code.",
"example": "3b70573f-c259-4df7-89fd-ad0104c1b828",
"type": "string"
},
"parameters": {
"description": "Internal data regarding to current violation.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Admin2": {
"required": [
"location",
"firstName",
"lastName",
"email",
"password",
"active",
"phone"
],
"properties": {
"location": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"roles": {
"description": "User roles.",
"example": [
"ROLE_SUPERVISOR"
],
"items": {
"type": "string"
},
"type": "array"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"password": {
"description": "Password.",
"example": "A1b2c3D4",
"type": "string"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
}
},
"type": "object"
},
"AdminUpdate": {
"required": [
"location",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"location": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"roles": {
"description": "User roles.",
"example": [
"ROLE_SUPERVISOR"
],
"items": {
"type": "string"
},
"type": "array"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
},
"oldPassword": {
"description": "Old password.",
"example": "A1B2C3D4",
"type": "string",
"maxLength": 255
},
"newPassword": {
"description": "New password.",
"example": "D5E6F7G8",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"AdminList": {
"properties": {
"admins": {
"description": "Array with admin UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"AuditRecordSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/ConstantCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"client.ip": {
"$ref": "#/components/schemas/IpCondition"
},
"command.name": {
"$ref": "#/components/schemas/StringCondition"
},
"trace.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"timestamp": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"http.request.method": {
"$ref": "#/components/schemas/StringCondition"
},
"http.request.url": {
"$ref": "#/components/schemas/StringCondition"
},
"http.request.pathInfo": {
"$ref": "#/components/schemas/StringCondition"
},
"http.response.status_code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"error.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"error.message": {
"$ref": "#/components/schemas/StringCondition"
},
"error.type": {
"$ref": "#/components/schemas/StringCondition"
},
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.order.number": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"event.action": {
"$ref": "#/components/schemas/StringCondition"
},
"event.category": {
"$ref": "#/components/schemas/StringCondition"
},
"event.dataset": {
"$ref": "#/components/schemas/StringCondition"
},
"event.kind": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"stock.advice": {
"$ref": "#/components/schemas/UuidCondition"
},
"stock.advice.internal.id": {
"$ref": "#/components/schemas/StringCondition"
},
"stock.advice.wms.internal.id": {
"$ref": "#/components/schemas/StringCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.internal.sku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.reference.numbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.sku": {
"$ref": "#/components/schemas/StringCondition"
},
"inbound.receipt": {
"$ref": "#/components/schemas/UuidCondition"
},
"inbound.receipt.wms.internal.id": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"id\"` `\"organisation\"` `\"organisation.name\"` `\"client.ip\"` `\"command.name\"` `\"trace.id\"` `\"user\"` `\"timestamp\"` `\"http.request.method\"` `\"http.request.url\"` `\"http.request.pathInfo\"` `\"http.response.status_code\"` `\"error.code\"` `\"error.message\"` `\"error.type\"` `\"eshop\"` `\"eshop.name\"` `\"expedition\"` `\"expedition.order.number\"` `\"expedition.status\"` `\"event.action\"` `\"event.category\"` `\"event.dataset\"` `\"event.kind\"` `\"user.email\"` `\"wms\"` `\"wms.name\"` `\"warehouse\"` `\"warehouse.name\"` `\"stock.advice\"` `\"stock.advice.internal.id\"` `\"stock.advice.wms.internal.id\"` `\"product\"` `\"product.internal.sku\"` `\"product.name\"` `\"product.reference.numbers\"` `\"product.sku\"` `\"inbound.receipt\"` `\"inbound.receipt.wms.internal.id\"` `\"id\"` `\"timestamp\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "timestamp"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"Results2": {
"properties": {
"results": {
"$ref": "#/components/schemas/AuditRecord"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"IntegrationSetting": {
"properties": {
"token": {
"example": "2866529-9360105-USLT9ZXYGFRJXQ160JNKUQAWH545SYP5VQ2IVGG7G93RBG1KU80BEMZ52T6DDEM8",
"type": "string"
},
"organisation": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseMapping": {
"items": {
"$ref": "#/components/schemas/WarehouseMapping"
},
"type": "array"
},
"expeditionStatusMapping": {
"items": {
"$ref": "#/components/schemas/ExpeditionStatusMapping"
},
"type": "array"
}
},
"type": "object"
},
"IntegrationSetting2": {
"properties": {
"token": {
"example": "2866529-9360105-USLT9ZXYGFRJXQ160JNKUQAWH545SYP5VQ2IVGG7G93RBG1KU80BEMZ52T6DDEM8",
"type": "string"
},
"organisation": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseMapping": {
"items": {
"$ref": "#/components/schemas/WarehouseMapping2"
},
"type": "array"
},
"expeditionStatusMapping": {
"items": {
"$ref": "#/components/schemas/ExpeditionStatusMapping2"
},
"type": "array"
}
},
"type": "object"
},
"ByznysUser": {
"required": [
"username",
"eshop"
],
"properties": {
"username": {
"description": "User name.",
"example": "johndoe",
"type": "string"
},
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"ByznysUser2": {
"required": [
"username",
"eshop"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"username": {
"description": "User name.",
"example": "johndoe",
"type": "string"
},
"plainToken": {
"type": "string"
},
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"statusGetEndpointCalledAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ByznysUserListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"username": {
"$ref": "#/components/schemas/StringCondition"
},
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"username\"` `\"eshop\"` `\"statusGetEndpointCalledAt\"` `\"eshop.name\"` `\"eshop.integrationType\"` `\"eshop.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "username"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"username\"` `\"eshop\"` `\"statusGetEndpointCalledAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"username",
"eshop",
"statusGetEndpointCalledAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results3": {
"properties": {
"results": {
"$ref": "#/components/schemas/ByznysUser3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Carrier": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Carrier name.",
"example": "DHL",
"type": "string"
},
"code": {
"description": "Carrier unique code (number).",
"example": "100",
"type": "integer"
},
"createdAt": {
"example": "2020-05-27T00:00:00+00:00",
"type": "string",
"format": "date-time"
},
"services": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
},
"imageUploadedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"excludedExpeditionAddressValidations": {
"description": "Country codes according to the ISO 3166-1 alpha-2 for which epedition address validation is ignored.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"cod": {
"description": "Whether cash on delivery is available for this carrier, true/false.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"imageUrl": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"CarrierListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"services": {
"$ref": "#/components/schemas/UuidCondition"
},
"pickupPlaces": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisations": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisations.name": {
"$ref": "#/components/schemas/UuidCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"code\"` `\"createdAt\"` `\"imageUploadedAt\"` `\"cod\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"code\"` `\"createdAt\"` `\"services\"` `\"countriesOfOperation\"` `\"lockedForImport\"` `\"imageUploadedAt\"` `\"excludedExpeditionAddressValidations\"` `\"cod\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"code",
"createdAt",
"services",
"countriesOfOperation",
"lockedForImport",
"imageUploadedAt",
"excludedExpeditionAddressValidations",
"cod",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results4": {
"properties": {
"results": {
"$ref": "#/components/schemas/Carrier4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"OrganisationList": {
"properties": {
"organisations": {
"description": "Array with organisation UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"Carrier2": {
"properties": {
"name": {
"description": "Carrier name.",
"example": "DHL",
"type": "string"
},
"code": {
"description": "Carrier unique code (number).",
"example": "100",
"type": "integer"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
},
"image": {
"description": "Carrier logo.",
"example": "data:image/gif;base64,R0lGODdhAQABAIAAAP///////ywAAAAAAQABAAACAkQBADs=",
"type": "string"
},
"excludedExpeditionAddressValidations": {
"description": "Country codes according to the ISO 3166-1 alpha-2 for which epedition address validation is ignored.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Carrier3": {
"properties": {
"name": {
"description": "Carrier name.",
"example": "DHL",
"type": "string"
},
"code": {
"description": "Carrier unique code (number).",
"example": "100",
"type": "integer"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
},
"excludedExpeditionAddressValidations": {
"description": "Country codes according to the ISO 3166-1 alpha-2 for which epedition address validation is ignored.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CarrierPickupPlace": {
"required": [
"country",
"carrier"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Carrier pickup place name.",
"example": "Trafika",
"type": "string",
"maxLength": "255"
},
"code": {
"description": "Pickup place code.",
"example": "46101",
"type": "string"
},
"code2": {
"description": "Carrier pickup place code2.",
"example": "11",
"type": "integer"
},
"createdAt": {
"example": "2020-05-27T00:00:00+00:00",
"type": "string",
"format": "date-time"
},
"address": {
"type": "string",
"maxLength": "255"
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"status": {
"description": "Carrier pickup place status (NOT_ACTIVE, ACTIVE, OBSOLETE)",
"example": "0",
"type": "integer",
"enum": [
0,
1,
2
]
},
"lockedForImport": {
"type": "boolean"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "carrierService",
"type": "string",
"enum": [
"carrier_service",
"pickup_point_branch",
"carrier_service_with_points"
]
},
"externalPickupPlaces": {
"items": {
"$ref": "#/components/schemas/ExternalCarrierPickupPlace"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"CarrierPickupPlaceListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"code": {
"$ref": "#/components/schemas/StringCondition"
},
"address": {
"$ref": "#/components/schemas/StringCondition"
},
"country": {
"$ref": "#/components/schemas/StringCondition"
},
"status": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"code\"` `\"code2\"` `\"createdAt\"` `\"address\"` `\"status\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"code\"` `\"code2\"` `\"createdAt\"` `\"address\"` `\"country\"` `\"status\"` `\"carrier\"` `\"type\"` `\"externalPickupPlaces\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"code",
"code2",
"createdAt",
"address",
"country",
"status",
"carrier",
"type",
"externalPickupPlaces",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results5": {
"properties": {
"results": {
"$ref": "#/components/schemas/CarrierPickupPlace4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"CarrierPickupPlace2": {
"required": [
"country",
"carrier"
],
"properties": {
"name": {
"description": "Carrier pickup place name.",
"example": "Trafika",
"type": "string",
"maxLength": "255"
},
"code": {
"description": "Pickup place code.",
"example": "46101",
"type": "string"
},
"code2": {
"description": "Carrier pickup place code2.",
"example": "11",
"type": "integer"
},
"address": {
"type": "string",
"maxLength": "255"
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"status": {
"description": "Carrier pickup place status (NOT_ACTIVE, ACTIVE, OBSOLETE)",
"example": "0",
"type": "integer",
"enum": [
0,
1,
2
]
},
"lockedForImport": {
"type": "boolean"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"CarrierPickupPlace3": {
"required": [
"country"
],
"properties": {
"name": {
"description": "Carrier pickup place name.",
"example": "Trafika",
"type": "string",
"maxLength": "255"
},
"code2": {
"description": "Carrier pickup place code2.",
"example": "11",
"type": "integer"
},
"address": {
"type": "string",
"maxLength": "255"
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"status": {
"description": "Carrier pickup place status (NOT_ACTIVE, ACTIVE, OBSOLETE)",
"example": "0",
"type": "integer",
"enum": [
0,
1,
2
]
},
"lockedForImport": {
"type": "boolean"
}
},
"type": "object"
},
"CarrierService": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Name of carrier service.",
"example": "Balík do ruky",
"type": "string"
},
"code": {
"description": "Carrier service code.",
"example": 100,
"type": "integer"
},
"createdAt": {
"example": "2020-05-27T00:00:00+00:00",
"type": "string",
"format": "date-time"
},
"pickupPlaceIgnore": {
"description": "Pickup place ignore.",
"type": "boolean"
},
"pickupPlaceMandatory": {
"description": "Pickup place mandatory.",
"type": "boolean"
},
"emailMandatory": {
"description": "Email mandatory.",
"type": "boolean"
},
"phoneMandatory": {
"description": "Phone mandatory.",
"type": "boolean"
},
"legacyDispense": {
"description": "Legacy dispense.",
"type": "boolean"
},
"skipDeliveryStatus": {
"description": "Skip delivery status.",
"type": "boolean"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier_service operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"CarrierServiceListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"pickupPlaceMandatory": {
"$ref": "#/components/schemas/BooleanCondition"
},
"carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrier.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"code\"` `\"createdAt\"` `\"pickupPlaceIgnore\"` `\"pickupPlaceMandatory\"` `\"emailMandatory\"` `\"phoneMandatory\"` `\"legacyDispense\"` `\"skipDeliveryStatus\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"code\"` `\"createdAt\"` `\"pickupPlaceIgnore\"` `\"pickupPlaceMandatory\"` `\"emailMandatory\"` `\"phoneMandatory\"` `\"legacyDispense\"` `\"skipDeliveryStatus\"` `\"carrier\"` `\"countriesOfOperation\"` `\"lockedForImport\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"code",
"createdAt",
"pickupPlaceIgnore",
"pickupPlaceMandatory",
"emailMandatory",
"phoneMandatory",
"legacyDispense",
"skipDeliveryStatus",
"carrier",
"countriesOfOperation",
"lockedForImport",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results6": {
"properties": {
"results": {
"$ref": "#/components/schemas/CarrierService4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"CarrierService2": {
"properties": {
"name": {
"description": "Name of carrier service.",
"example": "Balík do ruky",
"type": "string"
},
"code": {
"description": "Carrier service code.",
"example": 100,
"type": "integer"
},
"pickupPlaceIgnore": {
"description": "Pickup place ignore.",
"type": "boolean"
},
"pickupPlaceMandatory": {
"description": "Pickup place mandatory.",
"type": "boolean"
},
"emailMandatory": {
"description": "Email mandatory.",
"type": "boolean"
},
"phoneMandatory": {
"description": "Phone mandatory.",
"type": "boolean"
},
"legacyDispense": {
"description": "Legacy dispense.",
"type": "boolean"
},
"skipDeliveryStatus": {
"description": "Skip delivery status.",
"type": "boolean"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier_service operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
}
},
"type": "object"
},
"CarrierService3": {
"properties": {
"name": {
"description": "Name of carrier service.",
"example": "Balík do ruky",
"type": "string"
},
"code": {
"description": "Carrier service code.",
"example": 100,
"type": "integer"
},
"pickupPlaceIgnore": {
"description": "Pickup place ignore.",
"type": "boolean"
},
"pickupPlaceMandatory": {
"description": "Pickup place mandatory.",
"type": "boolean"
},
"emailMandatory": {
"description": "Email mandatory.",
"type": "boolean"
},
"phoneMandatory": {
"description": "Phone mandatory.",
"type": "boolean"
},
"legacyDispense": {
"description": "Legacy dispense.",
"type": "boolean"
},
"skipDeliveryStatus": {
"description": "Skip delivery status.",
"type": "boolean"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier_service operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
}
},
"type": "object"
},
"ExpeditionCodetables": {
"properties": {
"countries": {
"items": {
"$ref": "#/components/schemas/Country4"
},
"type": "array"
},
"wmses": {
"items": {
"$ref": "#/components/schemas/Wms5"
},
"type": "array"
},
"warehouses": {
"items": {
"$ref": "#/components/schemas/Warehouse4"
},
"type": "array"
},
"carriers": {
"items": {
"$ref": "#/components/schemas/Carrier5"
},
"type": "array"
},
"carrierServices": {
"items": {
"$ref": "#/components/schemas/CarrierService5"
},
"type": "array"
}
},
"type": "object"
},
"StockMovementCodetables": {
"properties": {
"wmses": {
"items": {
"$ref": "#/components/schemas/Wms5"
},
"type": "array"
},
"warehouses": {
"items": {
"$ref": "#/components/schemas/Warehouse4"
},
"type": "array"
}
},
"type": "object"
},
"ComplaintAttachment": {
"required": [
"file"
],
"properties": {
"file": {
"$ref": "#/components/schemas/File"
},
"originalName": {
"description": "Original name.",
"type": "string"
},
"description": {
"description": "Description.",
"type": "string"
}
},
"type": "object"
},
"ComplaintAttachment2": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"complaint": {
"$ref": "#/components/schemas/Complaint"
},
"complaintAction": {
"$ref": "#/components/schemas/ComplaintAction"
},
"name": {
"type": "string"
},
"originalNameUpload": {
"type": "string"
},
"originalName": {
"example": "invoice.pdf",
"type": "string",
"format": "string"
},
"description": {
"description": "Description.",
"type": "string"
},
"mimeType": {
"type": "string"
},
"size": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"uploadedAt": {
"type": "string",
"format": "date-time"
},
"uploadedBy": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"url": {
"example": "/api/complaint-attachment/529baf4b-b7f1-4ff4-827f-b05f52a1a22f/url",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"ComplaintActionListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"note": {
"$ref": "#/components/schemas/StringCondition"
},
"newStatus": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateCondition"
},
"complaint": {
"$ref": "#/components/schemas/UuidCondition"
},
"complaint.status": {
"$ref": "#/components/schemas/StringCondition"
},
"complaint.type": {
"$ref": "#/components/schemas/StringCondition"
},
"complaint.reason": {
"$ref": "#/components/schemas/StringCondition"
},
"complaint.resolution": {
"$ref": "#/components/schemas/StringCondition"
},
"complaint.description": {
"$ref": "#/components/schemas/StringCondition"
},
"complaint.internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"complaint.createdAt": {
"$ref": "#/components/schemas/DateCondition"
},
"complaint.changedAt": {
"$ref": "#/components/schemas/DateCondition"
},
"createdBy": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdBy.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.email": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"type\"` `\"newStatus\"` `\"createdBy\"` `\"createdAt\"` `\"deleted\"` `\"internal\"` `\"changedAt\"` `\"createdBy.firstName\"` `\"createdBy.lastName\"` `\"createdBy.email\"` `\"createdBy.phone\"` `\"createdBy.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt",
"order": "DESC"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"complaint\"` `\"type\"` `\"newStatus\"` `\"createdBy\"` `\"createdAt\"` `\"deleted\"` `\"internal\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"complaint",
"type",
"newStatus",
"createdBy",
"createdAt",
"deleted",
"internal",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results7": {
"properties": {
"results": {
"$ref": "#/components/schemas/ComplaintAction4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ComplaintAction": {
"required": [
"type"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"complaint": {
"$ref": "#/components/schemas/Complaint"
},
"type": {
"example": "created",
"type": "string",
"enum": [
"workflow",
"comment"
]
},
"newStatus": {
"example": "created",
"type": "string",
"enum": [
"created",
"resolving",
"waiting_for_reporter",
"waiting_for_resolver",
"waiting_for_resolver_log",
"waiting_for_cs",
"waiting_for_ms",
"waiting_for_carrier",
"resolved",
"closed",
"canceled"
]
},
"note": {
"description": "Note.",
"example": "Note about the complaint.",
"type": "string",
"maxLength": 500
},
"createdBy": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"attachments": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"deleted": {
"example": "false",
"type": "boolean"
},
"internal": {
"example": "false",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ComplaintAction2": {
"properties": {
"complaint": {
"$ref": "#/components/schemas/Complaint2"
},
"note": {
"description": "Note.",
"example": "Note about the complaint.",
"type": "string",
"maxLength": 500
},
"internal": {
"example": "false",
"type": "boolean"
},
"wait": {
"description": "If true, it suspends actions.",
"example": "false",
"type": "boolean"
}
},
"type": "object"
},
"ComplaintAction3": {
"properties": {
"note": {
"description": "Note.",
"example": "Note about the complaint.",
"type": "string",
"maxLength": 500
},
"internal": {
"example": "false",
"type": "boolean"
},
"wait": {
"description": "If true, it suspends actions.",
"example": "false",
"type": "boolean"
}
},
"type": "object"
},
"ComplaintListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"reason": {
"$ref": "#/components/schemas/StringCondition"
},
"resolution": {
"$ref": "#/components/schemas/StringCondition"
},
"description": {
"$ref": "#/components/schemas/StringCondition"
},
"internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateCondition"
},
"createdBy": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdBy.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.email": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter": {
"$ref": "#/components/schemas/UuidCondition"
},
"reporter.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter.email": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver": {
"$ref": "#/components/schemas/UuidCondition"
},
"resolver.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver.email": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"id\"` `\"createdBy\"` `\"reporter\"` `\"resolver\"` `\"organisation\"` `\"expedition\"` `\"status\"` `\"type\"` `\"reason\"` `\"resolution\"` `\"internalId\"` `\"createdAt\"` `\"changedAt\"` `\"createdBy.firstName\"` `\"createdBy.lastName\"` `\"createdBy.email\"` `\"createdBy.phone\"` `\"createdBy.changedAt\"` `\"reporter.firstName\"` `\"reporter.lastName\"` `\"reporter.email\"` `\"reporter.phone\"` `\"reporter.changedAt\"` `\"resolver.firstName\"` `\"resolver.lastName\"` `\"resolver.email\"` `\"resolver.phone\"` `\"resolver.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"createdBy\"` `\"reporter\"` `\"resolver\"` `\"organisation\"` `\"expedition\"` `\"status\"` `\"type\"` `\"reason\"` `\"resolution\"` `\"internalId\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"createdBy",
"reporter",
"resolver",
"organisation",
"expedition",
"status",
"type",
"reason",
"resolution",
"internalId",
"createdAt",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results8": {
"properties": {
"results": {
"$ref": "#/components/schemas/Complaint4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Complaint": {
"required": [
"organisation",
"expedition",
"status",
"type",
"reason",
"internalId"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdBy": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"reporter": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"resolver": {
"description": "Uuid of Admin.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation to belongs this complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition for complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"status": {
"example": "created",
"type": "string",
"enum": [
"created",
"resolving",
"waiting_for_reporter",
"waiting_for_resolver",
"waiting_for_resolver_log",
"waiting_for_cs",
"waiting_for_ms",
"waiting_for_carrier",
"resolved",
"closed",
"canceled"
]
},
"type": {
"example": "created",
"type": "string",
"enum": [
"expedition"
]
},
"reason": {
"description": "Complaint reason.",
"example": "created",
"type": "string",
"enum": [
"undelivered",
"incomplete",
"damaged",
"late_delivery",
"other"
]
},
"resolution": {
"description": "Complaint resolution.",
"example": "created",
"type": "string",
"enum": [
"unproven",
"additional_goods",
"rejected_by_provider",
"rejected_by_carrier",
"redispatch",
"damaged_by_carrier",
"damaged_by_customer",
"product_unavailable",
"canceled",
"accepted_by_carrier",
"accepted_by_provider",
"wrong_product",
"lost_by_carrier",
"lost_by_provider"
]
},
"description": {
"description": "Description.",
"example": "Note about the complaint.",
"type": "string",
"maxLength": 500
},
"resolutionDetail": {
"description": "Complaint resolution detail.",
"example": "Detail of the complaint resolution.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal number.",
"example": "16213752_rekl",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"attachments": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"actions": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"currency": {
"description": "Currency used in this complaint.",
"example": "CZK",
"type": "string",
"maxLength": 3
},
"value": {
"description": "Value.",
"example": "Value of the complaint.",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Complaint2": {
"required": [
"organisation",
"expedition",
"type",
"reason",
"internalId"
],
"properties": {
"reporter": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation to belongs this complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition for complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "created",
"type": "string",
"enum": [
"expedition"
]
},
"reason": {
"description": "Complaint reason.",
"example": "created",
"type": "string",
"enum": [
"undelivered",
"incomplete",
"damaged",
"late_delivery",
"other"
]
},
"description": {
"description": "Description.",
"example": "Note about the complaint.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal number.",
"example": "16213752_rekl",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"currency": {
"description": "Currency used in this complaint.",
"example": "CZK",
"type": "string",
"maxLength": 3
},
"value": {
"description": "Value.",
"example": "Value of the complaint.",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"Complaint3": {
"required": [
"reason"
],
"properties": {
"reporter": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"resolver": {
"description": "Uuid of Admin.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"reason": {
"description": "Complaint reason.",
"example": "created",
"type": "string",
"enum": [
"undelivered",
"incomplete",
"damaged",
"late_delivery",
"other"
]
},
"description": {
"description": "Description.",
"example": "Note about the complaint.",
"type": "string",
"maxLength": 500
},
"resolutionDetail": {
"description": "Complaint resolution detail.",
"example": "Detail of the complaint resolution.",
"type": "string",
"maxLength": 500
},
"currency": {
"description": "Currency used in this complaint.",
"example": "CZK",
"type": "string",
"maxLength": 3
},
"value": {
"description": "Value.",
"example": "Value of the complaint.",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"ComplaintExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdBy": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdBy.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.email": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"createdBy.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"reporter": {
"$ref": "#/components/schemas/UuidCondition"
},
"reporter.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter.email": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"reporter.changedAt": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver": {
"$ref": "#/components/schemas/UuidCondition"
},
"resolver.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver.email": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"resolver.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation.registrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation.vatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation.code": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation.automaticExchangeEnabled": {
"$ref": "#/components/schemas/BooleanCondition"
},
"organisation.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredExpeditionDate": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.expeditedCompletely": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.packedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.sentAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.deliveredAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.waitBeforeProcessing": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.editBeforeProcessing": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.conversionDate": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"reason": {
"$ref": "#/components/schemas/StringCondition"
},
"resolution": {
"$ref": "#/components/schemas/StringCondition"
},
"description": {
"$ref": "#/components/schemas/StringCondition"
},
"resolutionDetail": {
"$ref": "#/components/schemas/StringCondition"
},
"internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"currency": {
"$ref": "#/components/schemas/StringCondition"
},
"value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"id\"` `\"createdBy\"` `\"reporter\"` `\"resolver\"` `\"organisation\"` `\"expedition\"` `\"status\"` `\"type\"` `\"reason\"` `\"resolution\"` `\"internalId\"` `\"createdAt\"` `\"changedAt\"` `\"createdBy.firstName\"` `\"createdBy.lastName\"` `\"createdBy.email\"` `\"createdBy.phone\"` `\"createdBy.changedAt\"` `\"reporter.firstName\"` `\"reporter.lastName\"` `\"reporter.email\"` `\"reporter.phone\"` `\"reporter.changedAt\"` `\"resolver.firstName\"` `\"resolver.lastName\"` `\"resolver.email\"` `\"resolver.phone\"` `\"resolver.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"ExportJob": {
"required": [
"type",
"status",
"name",
"fileType",
"filename"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "export",
"type": "string",
"enum": [
"export_expedition",
"export_missing_stock",
"export_product_stock",
"export_product",
"export_stock_advice",
"export_stock_movement",
"export_return_receipt",
"export_inbound_receipt",
"export_outbound_receipt",
"export_complaint",
"export_transfer_list"
]
},
"status": {
"example": "waiting",
"type": "string",
"enum": [
"waiting",
"running",
"finished",
"failed"
]
},
"name": {
"example": "export001",
"type": "string",
"maxLength": "64",
"minLength": "2"
},
"fileType": {
"example": "csv",
"type": "string",
"maxLength": "8",
"minLength": "2"
},
"filename": {
"example": "export001.csv",
"type": "string",
"maxLength": "64",
"minLength": "2"
},
"owner": {
"description": "Uuid of owner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"startedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"finishedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"expectedRecords": {
"example": "32000",
"type": "integer"
},
"processedRecords": {
"example": "32000",
"type": "integer"
},
"fileUrl": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"Country": {
"required": [
"code",
"name",
"currencyCode"
],
"properties": {
"code": {
"title": "Country code.",
"description": "Country code.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"name": {
"description": "Country name.",
"example": "Czech Republic",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"currencyCode": {
"description": "Country currency code.",
"example": "CZK",
"type": "string",
"maxLength": 3,
"minLength": 2
},
"currencyName": {
"description": "Country currency name.",
"example": "Czech crown",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"customsDeclaration": {
"description": "Customs declaration.",
"example": true,
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"CountryListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"code": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"code\"` `\"name\"` `\"currencyCode\"` `\"currencyName\"` `\"customsDeclaration\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "code"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"code\"` `\"name\"` `\"currencyCode\"` `\"currencyName\"` `\"customsDeclaration\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"code",
"name",
"currencyCode",
"currencyName",
"customsDeclaration",
"createdAt",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results9": {
"properties": {
"results": {
"$ref": "#/components/schemas/Country5"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Country2": {
"required": [
"code",
"name",
"currencyCode"
],
"properties": {
"code": {
"title": "Country code.",
"description": "Country code.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"name": {
"description": "Country name.",
"example": "Czech Republic",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"currencyCode": {
"description": "Country currency code.",
"example": "CZK",
"type": "string",
"maxLength": 3,
"minLength": 2
},
"currencyName": {
"description": "Country currency name.",
"example": "Czech crown",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"customsDeclaration": {
"description": "Customs declaration.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"Country3": {
"required": [
"name",
"currencyCode"
],
"properties": {
"name": {
"description": "Country name.",
"example": "Czech Republic",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"currencyCode": {
"description": "Country currency code.",
"example": "CZK",
"type": "string",
"maxLength": 3,
"minLength": 2
},
"currencyName": {
"description": "Country currency name.",
"example": "Czech crown",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"customsDeclaration": {
"description": "Customs declaration.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"ExpeditionWidget": {
"required": [
"status",
"timePeriod",
"measurement",
"value"
],
"properties": {
"status": {
"description": "Status of the expeditions we're counting",
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"timePeriod": {
"description": "This variable is used to specify filter for time period.",
"type": "string",
"enum": [
"is_in_the_last",
"older_than",
"is_in_this"
]
},
"measurement": {
"description": "This variable is used to specify the measuring unit.",
"type": "string",
"enum": [
"days",
"weeks",
"calendar_weeks",
"months",
"calendar_months",
"years",
"calendar_years"
]
},
"value": {
"description": "Value of the time range we're searching data in. If time period is is_in_this this value is not needed.",
"type": "integer",
"exclusiveMinimum": 0
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"ExpeditionWidgetResult": {
"properties": {
"numberOfExpeditions": {
"description": "Number of expeditions with specified status and timeframe",
"type": "integer"
}
},
"type": "object"
},
"ExpeditionMultipleWidget": {
"required": [
"statuses",
"timePeriod",
"measurement",
"value"
],
"properties": {
"statuses": {
"description": "Status of the expeditions we're counting",
"items": {
"type": "string"
},
"type": "array"
},
"timePeriod": {
"description": "This variable is used to specify filter for time period.",
"type": "string",
"enum": [
"is_in_the_last",
"older_than",
"is_in_this"
]
},
"measurement": {
"description": "This variable is used to specify the measuring unit.",
"type": "string",
"enum": [
"days",
"weeks",
"calendar_weeks",
"months",
"calendar_months",
"years",
"calendar_years"
]
},
"value": {
"description": "Value of the time range we're searching data in. If time period is is_in_this this value is not needed.",
"type": "integer",
"exclusiveMinimum": 0
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"ExpeditionMultipleWidgetResult": {
"properties": {
"values": {
"description": "Number of each type of expeditions with specified time frame and status.",
"items": {
"type": "integer"
},
"type": "array"
},
"sum": {
"description": "Sum of all expeditions with specified time frame.",
"type": "integer"
}
},
"type": "object"
},
"ReturnReceiptWidget": {
"required": [
"timePeriod",
"measurement",
"value"
],
"properties": {
"timePeriod": {
"description": "This variable is used to specify filter for time period.",
"type": "string",
"enum": [
"is_in_the_last",
"older_than",
"is_in_this"
]
},
"measurement": {
"description": "This variable is used to specify the measuring unit.",
"type": "string",
"enum": [
"days",
"weeks",
"calendar_weeks",
"months",
"calendar_months",
"years",
"calendar_years"
]
},
"value": {
"description": "Value of the time range we're searching data in. If time period is is_in_this this value is not needed.",
"type": "integer",
"exclusiveMinimum": 0
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"ReturnReceiptWidgetResult": {
"properties": {
"all": {
"description": "Number of all return receipts with specified timeframe",
"type": "integer"
},
"returned": {
"description": "Number of returned receipts with specified timeframe",
"type": "integer"
},
"returnedOpen": {
"description": "Number of returned open receipts with specified timeframe",
"type": "integer"
},
"returnedDamaged": {
"description": "Number of returned damaged receipts with specified timeframe",
"type": "integer"
},
"inventory": {
"description": "Number of inventory receipts with specified timeframe",
"type": "integer"
},
"new": {
"description": "Number of new receipts with specified timeframe",
"type": "integer"
}
},
"type": "object"
},
"DailyReportRequest": {
"required": [
"date"
],
"properties": {
"organisations": {
"description": "Array with organisation UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
},
"date": {
"description": "This value is used to search data from specified date",
"type": "string",
"format": "date-time"
},
"offset": {
"description": "Offset from where to begin.",
"type": "integer"
},
"maxResults": {
"description": "Number of max results to return.",
"type": "integer"
}
},
"type": "object"
},
"StockMovementCountResult": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"StockMovement": {
"required": [
"product",
"movementType",
"organisation",
"warehouse",
"wms"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movementType": {
"example": "IN",
"type": "string",
"enum": [
"in",
"out",
"book",
"unbook"
]
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"inboundReceipt": {
"description": "Uuid of Inbound Receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expeditionItem": {
"description": "Uuid of Expedition Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"transfer": {
"description": "Uuid of Transfer.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
},
"movedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ProductStock": {
"properties": {
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "5",
"type": "integer"
},
"booked": {
"example": "2",
"type": "integer"
},
"available": {
"example": "3",
"type": "integer"
},
"required": {
"description": "Number of products that are required to stock, in order to satisfy all expeditions and transfers (productStock.missing - productStock.available, only if the value is positive).",
"example": "6",
"type": "integer"
},
"incoming": {
"example": "10",
"type": "integer"
}
},
"type": "object"
},
"DisassemblyStockAdviceRequest": {
"required": [
"orderNumber"
],
"properties": {
"orderNumber": {
"description": "Disassembly expedition order number",
"type": "string"
}
},
"type": "object"
},
"StockAdvice": {
"required": [
"supplier",
"internalId"
],
"properties": {
"supplier": {
"description": "Uuid of Supplier that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"items": {
"items": {
"$ref": "#/components/schemas/StockAdviceItem4"
},
"type": "array",
"minItems": 1
},
"internalId": {
"description": "Internal ID.",
"example": "Internal number.",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"DistributionCenter": {
"required": [
"name",
"apiUrl",
"wmsUrl"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Distribution center name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"apiUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"wmsUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"wmses": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"DistributionCenterListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"apiUrl\"` `\"wmsUrl\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"apiUrl\"` `\"wmsUrl\"` `\"createdAt\"` `\"wmses\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"apiUrl",
"wmsUrl",
"createdAt",
"wmses",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results10": {
"properties": {
"results": {
"$ref": "#/components/schemas/DistributionCenter4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"DistributionCenter2": {
"required": [
"name",
"apiUrl",
"wmsUrl"
],
"properties": {
"name": {
"description": "Distribution center name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"apiUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"wmsUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
}
},
"type": "object"
},
"DistributionCenter3": {
"required": [
"name",
"apiUrl",
"wmsUrl"
],
"properties": {
"name": {
"description": "Distribution center name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"apiUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"wmsUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"wmses": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
}
},
"type": "object"
},
"DistributionCenterOrganisationLogin": {
"required": [
"organisation",
"loginName",
"type"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"loginName": {
"description": "Login name.",
"example": "inventi",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"type": {
"example": "mailstage",
"type": "string",
"enum": [
"mailstage",
"mailwise"
]
},
"syncIncoming": {
"description": "If true, it synchronizes the receipt of goods.",
"type": "boolean"
},
"syncOutgoing": {
"description": "If true, it synchronizes outgoing goods.",
"type": "boolean"
},
"syncInventoryChanges": {
"description": "If true, it synchronizes inventory changes.",
"type": "boolean"
},
"mailwiseMigrationAt": {
"description": "When was the migration from Mailstage to Mailwise. Expeditions created before this datetime will be processed via Mailstage when syncOutgoing is false and login type Mailstage, and will be processed as shipped in MW when syncOutgoing is true and login type Mailwise.",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"DistributionCenterOrganisationLoginListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"loginName": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"distributionCenter": {
"$ref": "#/components/schemas/UuidCondition"
},
"distributionCenter.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"organisation\"` `\"distributionCenter\"` `\"loginName\"` `\"createdAt\"` `\"type\"` `\"changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"distributionCenter.name\"` `\"distributionCenter.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "distributionCenter.name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"organisation\"` `\"distributionCenter\"` `\"loginName\"` `\"createdAt\"` `\"type\"` `\"syncIncoming\"` `\"syncOutgoing\"` `\"syncInventoryChanges\"` `\"mailwiseMigrationAt\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"organisation",
"distributionCenter",
"loginName",
"createdAt",
"type",
"syncIncoming",
"syncOutgoing",
"syncInventoryChanges",
"mailwiseMigrationAt",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results11": {
"properties": {
"results": {
"$ref": "#/components/schemas/DistributionCenterOrganisationLogin4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"DistributionCenterOrganisationLogin2": {
"required": [
"organisation",
"loginName",
"password",
"type"
],
"properties": {
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"loginName": {
"description": "Login name.",
"example": "inventi",
"type": "string"
},
"password": {
"description": "Password.",
"example": "password",
"type": "string"
},
"type": {
"example": "mailstage",
"type": "string",
"enum": [
"mailstage",
"mailwise"
]
},
"syncIncoming": {
"description": "If true, it synchronizes the receipt of goods.",
"type": "boolean"
},
"syncOutgoing": {
"description": "If true, it synchronizes outgoing goods.",
"type": "boolean"
},
"syncInventoryChanges": {
"description": "If true, it synchronizes inventory changes.",
"type": "boolean"
},
"mailwiseMigrationAt": {
"description": "When was the migration from Mailstage to Mailwise. Expeditions created before this datetime will be processed via Mailstage when syncOutgoing is false and login type Mailstage, and will be processed as shipped in MW when syncOutgoing is true and login type Mailwise.",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"DistributionCenterOrganisationLogin3": {
"required": [
"organisation",
"loginName",
"password"
],
"properties": {
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"loginName": {
"description": "Login name.",
"example": "inventi",
"type": "string"
},
"password": {
"description": "Password.",
"example": "password",
"type": "string"
},
"syncIncoming": {
"description": "If true, it synchronizes the receipt of goods.",
"type": "boolean"
},
"syncOutgoing": {
"description": "If true, it synchronizes outgoing goods.",
"type": "boolean"
},
"syncInventoryChanges": {
"description": "If true, it synchronizes inventory changes.",
"type": "boolean"
},
"mailwiseMigrationAt": {
"description": "When was the migration from Mailstage to Mailwise. Expeditions created before this datetime will be processed via Mailstage when syncOutgoing is false and login type Mailstage, and will be processed as shipped in MW when syncOutgoing is true and login type Mailwise.",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"EshopListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"defaultWarehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"createdAt\"` `\"integrationType\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"organisation\"` `\"defaultWarehouse\"` `\"warehouses\"` `\"active\"` `\"createdAt\"` `\"partners\"` `\"waitBeforeProcessing\"` `\"editBeforeProcessing\"` `\"integrationType\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"organisation",
"defaultWarehouse",
"warehouses",
"active",
"createdAt",
"partners",
"waitBeforeProcessing",
"editBeforeProcessing",
"integrationType",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results12": {
"properties": {
"results": {
"$ref": "#/components/schemas/Eshop4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Eshop": {
"required": [
"name",
"active",
"waitBeforeProcessing",
"editBeforeProcessing"
],
"properties": {
"name": {
"example": "E-shop - nábytek",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of organisation that owns this eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"defaultWarehouse": {
"description": "Uuid of default warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"active": {
"description": "If true, the Eshop is active.",
"type": "boolean"
},
"webHooks": {
"items": {
"$ref": "#/components/schemas/EshopWebHook2"
},
"type": "array"
},
"waitBeforeProcessing": {
"description": "If true, all expeditions waits in stock_ok status for approval.",
"example": false,
"type": "boolean"
},
"editBeforeProcessing": {
"description": "If true, all expeditions can be edited in stock_ok status before processing.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"Eshop2": {
"required": [
"name",
"active",
"waitBeforeProcessing",
"editBeforeProcessing"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"example": "E-shop - nábytek",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of organisation that owns this eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"defaultWarehouse": {
"description": "Uuid of default warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"warehouses": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"active": {
"description": "If true, the Eshop is active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"partners": {
"items": {
"$ref": "#/components/schemas/Partner"
},
"type": "array"
},
"webHooks": {
"items": {
"$ref": "#/components/schemas/EshopWebHook"
},
"type": "array"
},
"waitBeforeProcessing": {
"description": "If true, all expeditions waits in stock_ok status for approval.",
"example": false,
"type": "boolean"
},
"editBeforeProcessing": {
"description": "If true, all expeditions can be edited in stock_ok status before processing.",
"example": false,
"type": "boolean"
},
"integrationType": {
"example": "baselinker",
"type": "string",
"enum": [
"baselinker"
]
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Eshop3": {
"required": [
"name",
"active",
"waitBeforeProcessing",
"editBeforeProcessing"
],
"properties": {
"name": {
"example": "E-shop - nábytek",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of organisation that owns this eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"defaultWarehouse": {
"description": "Uuid of default warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"active": {
"description": "If true, the Eshop is active.",
"type": "boolean"
},
"partners": {
"items": {
"$ref": "#/components/schemas/Partner3"
},
"type": "array"
},
"webHooks": {
"items": {
"$ref": "#/components/schemas/EshopWebHook3"
},
"type": "array"
},
"waitBeforeProcessing": {
"description": "If true, all expeditions waits in stock_ok status for approval.",
"example": false,
"type": "boolean"
},
"editBeforeProcessing": {
"description": "If true, all expeditions can be edited in stock_ok status before processing.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"EshopList": {
"properties": {
"eshops": {
"description": "Array with eshop UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"EshopWebHook": {
"required": [
"eshop",
"event",
"destination",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"event": {
"type": "string",
"enum": [
"expedition_status_change",
"expedition_booked_change",
"product_stock_change",
"organization_change"
]
},
"destination": {
"description": "WebHook destination.",
"example": "https://webhook.site/161166f9-a6a0-4123-b53b-1f9be727f2f8",
"type": "string"
},
"active": {
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"authentication": {
"$ref": "#/components/schemas/WebhookCredencials"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"EshopWebHookListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"event": {
"$ref": "#/components/schemas/StringCondition"
},
"destination": {
"$ref": "#/components/schemas/StringCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"createdAt\"` `\"authentication\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"eshop\"` `\"event\"` `\"destination\"` `\"active\"` `\"createdAt\"` `\"authentication\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"eshop",
"event",
"destination",
"active",
"createdAt",
"authentication",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results13": {
"properties": {
"results": {
"$ref": "#/components/schemas/EshopWebHook4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"EshopWebHook2": {
"required": [
"eshop",
"event",
"destination",
"active"
],
"properties": {
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"event": {
"type": "string",
"enum": [
"expedition_status_change",
"expedition_booked_change",
"product_stock_change",
"organization_change"
]
},
"destination": {
"description": "WebHook destination.",
"example": "https://webhook.site/161166f9-a6a0-4123-b53b-1f9be727f2f8",
"type": "string"
},
"active": {
"type": "boolean"
},
"authentication": {
"$ref": "#/components/schemas/WebhookCredencials2"
}
},
"type": "object"
},
"EshopWebHook3": {
"required": [
"eshop",
"event",
"destination",
"active"
],
"properties": {
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"event": {
"type": "string",
"enum": [
"expedition_status_change",
"expedition_booked_change",
"product_stock_change",
"organization_change"
]
},
"destination": {
"description": "WebHook destination.",
"example": "https://webhook.site/161166f9-a6a0-4123-b53b-1f9be727f2f8",
"type": "string"
},
"active": {
"type": "boolean"
},
"authentication": {
"$ref": "#/components/schemas/WebhookCredencials3"
}
},
"type": "object"
},
"ExchangeListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"country": {
"$ref": "#/components/schemas/StringCondition"
},
"currency": {
"$ref": "#/components/schemas/StringCondition"
},
"amount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"code": {
"$ref": "#/components/schemas/StringCondition"
},
"rate": {
"$ref": "#/components/schemas/IntegerCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"createdAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"currency\"` `\"country\"` `\"code\"` `\"amount\"` `\"course\"` `\"createdAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"currency",
"country",
"code",
"amount",
"course",
"createdAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results14": {
"properties": {
"results": {
"$ref": "#/components/schemas/Exchange"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ExchangeList": {
"properties": {
"currency": {
"example": "USD",
"type": "string",
"enum": [
"CZK",
"AUD",
"BRL",
"BGN",
"CNY",
"DKK",
"EUR",
"PHP",
"HKD",
"HRK",
"INR",
"IDR",
"ISK",
"ILS",
"JPY",
"ZAR",
"CAD",
"KRW",
"HUF",
"MYR",
"MXN",
"XDR",
"NOK",
"NZD",
"PLN",
"RON",
"SGD",
"SEK",
"CHF",
"THB",
"TRY",
"USD",
"GBP"
]
},
"money": {
"example": "10.25",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"Expedition": {
"required": [
"eshop",
"warehouse",
"wms",
"orderNumber",
"carrier",
"carrierService",
"status",
"value",
"currency"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop to belongs this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"partner": {
"description": "Uuid of Partner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"orderNumber": {
"description": "Order number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"billingFirstName": {
"description": "Billing first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"billingLastName": {
"description": "Billing last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"billingDegree": {
"description": "Billing degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"billingCompany": {
"description": "Billing company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"billingStreet": {
"description": "Billing street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"billingHouseNr": {
"description": "Billing house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"billingZip": {
"description": "Billing zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"billingCity": {
"description": "Billing city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"billingCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"billingEmail": {
"description": "Billing email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": "60"
},
"billingPhone": {
"description": "Billing phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"billingRegistrationNumber": {
"description": "Billing registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32
},
"billingVatNumber": {
"description": "Billing Vat number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 32
},
"differentDeliveryAddress": {
"type": "boolean"
},
"deliveryFirstName": {
"description": "Delivery first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"deliveryLastName": {
"description": "Delivery last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"deliveryDegree": {
"description": "Delivery degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"deliveryCompany": {
"description": "Delivery company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"deliveryStreet": {
"description": "Delivery street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"deliveryHouseNr": {
"description": "Delivery house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"deliveryZip": {
"description": "Delivery zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"deliveryCity": {
"description": "Delivery city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"deliveryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"deliveryEmail": {
"description": "Delivery email.",
"example": "john.doe@example.com",
"type": "string"
},
"deliveryPhone": {
"description": "Delivery phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"requiredExpeditionDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"carrier": {
"description": "Uuid of Carrier.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierService": {
"description": "Uuid of CarrierService.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlace": {
"description": "Uuid of CarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlaceCode": {
"description": "Code of CarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"externalCarrierPickupPlace": {
"description": "Uuid of ExternalCarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"externalCarrierPickupPlaceCode": {
"description": "Code of ExternalCarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"carrierNote": {
"description": "Note for carrier",
"type": "string",
"maxLength": 4096
},
"trackingNumber": {
"description": "Tracking number.",
"example": "DR4057137142G",
"type": "string",
"maxLength": 255
},
"trackingUrl": {
"description": "Tracking Url.",
"example": "https://www.postaonline.cz/trackandtrace/-/zasilka/cislo?parcelNumbers=DR4057137142G",
"type": "string",
"maxLength": 255
},
"externalTrackingNumber": {
"description": "External tracking number.",
"example": "PBZDE014624523",
"type": "string",
"maxLength": 255
},
"packagesCount": {
"description": "Packages count.",
"type": "integer"
},
"status": {
"example": "new",
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"expeditedCompletely": {
"example": "true",
"type": "boolean"
},
"value": {
"description": "Value of the whole expedition.",
"example": "50.00",
"type": "number",
"format": "float",
"exclusiveMinimum": "0"
},
"currency": {
"description": "ISO currency code",
"example": "CZK",
"type": "string"
},
"fragile": {
"description": "Fragile",
"type": "boolean"
},
"cod": {
"description": "Cash on delivery, true/false",
"example": "true",
"type": "boolean"
},
"codValue": {
"description": "Cash on delivery value.",
"example": "5000",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
},
"codCurrency": {
"description": "ISO currency code.",
"example": "CZK",
"type": "string"
},
"codVariableSymbol": {
"description": "Cash on delivery variable symbol.",
"example": "0123456789",
"type": "string",
"maxLength": 32,
"pattern": "\\d+"
},
"customerGroup": {
"description": "Customer group.",
"example": "VIP",
"type": "string",
"maxLength": 255
},
"invoice": {
"description": "Invoice file info.",
"properties": {
"name": {
"description": "Internal file name.",
"type": "string"
},
"originalName": {
"description": "Original filename. Taken from upload file name.",
"example": "invoice.pdf",
"type": "string"
},
"mimeType": {
"description": "Mime type",
"example": "application/pdf",
"type": "string"
},
"size": {
"description": "File size.",
"example": "34567",
"type": "int"
}
},
"type": "object"
},
"eshopOrderDate": {
"description": "Eshop order date.",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExpeditionItem3"
},
"type": "array",
"minItems": 1
},
"audits": {
"items": {
"$ref": "#/components/schemas/ExpeditionStatusAudit"
},
"type": "array"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"errors": {
"description": "Validation errors contains this list with details.",
"items": {
"properties": {
"message": {
"description": "Error title (e.g. *This value is not valid*).",
"example": "This value should not be blank.",
"type": "string"
},
"propertyPath": {
"description": "Path of field (e.g. *items[0].productCode*).",
"example": "firstName",
"type": "string"
},
"code": {
"description": "Error code.",
"example": "3b70573f-c259-4df7-89fd-ad0104c1b828",
"type": "string"
},
"parameters": {
"description": "Internal data regarding to current violation.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"packedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"sentAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"deliveredAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"waitBeforeProcessing": {
"description": "Overrides eshop.waitBeforeProcessing value.",
"type": "boolean"
},
"editBeforeProcessing": {
"description": "Overrides eshop.editBeforeProcessing value.",
"type": "boolean"
},
"priority": {
"description": "Priority.",
"example": "5",
"type": "integer"
},
"ref1": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref2": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref3": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"foreignPrice": {
"$ref": "#/components/schemas/MsMoney"
},
"conversionDate": {
"description": "Conversion date",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"modifiedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"removedVirtualProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct"
},
"type": "array"
},
"ignoreAddressValidation": {
"description": "Whether delivery address validation should be ignored. Default false.",
"type": "boolean"
},
"addressValidationExecuted": {
"description": "Whether delivery address validation has been executed.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"invoiceUrl": {
"example": "/api/expedition/529baf4b-b7f1-4ff4-827f-b05f52a1a22f/invoice",
"type": "string",
"format": "uri"
},
"invoiceOriginalName": {
"example": "invoice.pdf",
"type": "string",
"format": "string"
},
"withComplaint": {
"example": "false",
"type": "bool"
}
},
"type": "object"
},
"ExpeditionListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"note": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"currency": {
"$ref": "#/components/schemas/StringCondition"
},
"fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"requiredExpeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"packedAt": {
"$ref": "#/components/schemas/DateCondition"
},
"deliveredAt": {
"$ref": "#/components/schemas/DateCondition"
},
"sentAt": {
"$ref": "#/components/schemas/DateCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"modifiedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"invoice.name": {
"$ref": "#/components/schemas/StringCondition"
},
"invoice.originalName": {
"$ref": "#/components/schemas/StringCondition"
},
"invoice.size": {
"$ref": "#/components/schemas/IntegerCondition"
},
"invoice.mimeType": {
"$ref": "#/components/schemas/StringCondition"
},
"carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expeditedCompletely": {
"$ref": "#/components/schemas/NullableBooleanCondition"
},
"withInvoice": {
"$ref": "#/components/schemas/BooleanCondition"
},
"withComplaint": {
"$ref": "#/components/schemas/BooleanCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"user\"` `\"eshop\"` `\"warehouse\"` `\"wms\"` `\"partner\"` `\"orderNumber\"` `\"billingFirstName\"` `\"billingLastName\"` `\"billingDegree\"` `\"billingCompany\"` `\"billingStreet\"` `\"billingHouseNr\"` `\"billingZip\"` `\"billingCity\"` `\"billingCountry\"` `\"billingEmail\"` `\"billingPhone\"` `\"billingRegistrationNumber\"` `\"billingVatNumber\"` `\"differentDeliveryAddress\"` `\"deliveryFirstName\"` `\"deliveryLastName\"` `\"deliveryDegree\"` `\"deliveryCompany\"` `\"deliveryStreet\"` `\"deliveryHouseNr\"` `\"deliveryZip\"` `\"deliveryCity\"` `\"deliveryCountry\"` `\"deliveryEmail\"` `\"deliveryPhone\"` `\"requiredExpeditionDate\"` `\"carrier\"` `\"carrierService\"` `\"carrierPickupPlace\"` `\"externalCarrierPickupPlace\"` `\"carrierNote\"` `\"trackingNumber\"` `\"trackingUrl\"` `\"externalTrackingNumber\"` `\"packagesCount\"` `\"status\"` `\"expeditedCompletely\"` `\"value\"` `\"currency\"` `\"fragile\"` `\"cod\"` `\"codValue\"` `\"codCurrency\"` `\"codVariableSymbol\"` `\"customerGroup\"` `\"eshopOrderDate\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"packedAt\"` `\"sentAt\"` `\"deliveredAt\"` `\"waitBeforeProcessing\"` `\"editBeforeProcessing\"` `\"priority\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"foreignPrice\"` `\"conversionDate\"` `\"modifiedAt\"` `\"removedVirtualProducts\"` `\"ignoreAddressValidation\"` `\"addressValidationExecuted\"` `\"changedAt\"` `\"user.dateOfBirth\"` `\"user.firstName\"` `\"user.lastName\"` `\"user.email\"` `\"user.phone\"` `\"user.changedAt\"` `\"eshop.name\"` `\"eshop.integrationType\"` `\"eshop.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"partner.code\"` `\"partner.name\"` `\"partner.companyName\"` `\"partner.firstName\"` `\"partner.lastName\"` `\"partner.email\"` `\"partner.registrationNumber\"` `\"partner.vatNumber\"` `\"partner.changedAt\"` `\"billingCountry.code\"` `\"billingCountry.name\"` `\"billingCountry.currencyCode\"` `\"billingCountry.currencyName\"` `\"billingCountry.customsDeclaration\"` `\"billingCountry.changedAt\"` `\"deliveryCountry.code\"` `\"deliveryCountry.name\"` `\"deliveryCountry.currencyCode\"` `\"deliveryCountry.currencyName\"` `\"deliveryCountry.customsDeclaration\"` `\"deliveryCountry.changedAt\"` `\"carrier.name\"` `\"carrier.code\"` `\"carrier.changedAt\"` `\"carrierService.name\"` `\"carrierService.code\"` `\"carrierService.pickupPlaceIgnore\"` `\"carrierService.pickupPlaceMandatory\"` `\"carrierService.emailMandatory\"` `\"carrierService.phoneMandatory\"` `\"carrierService.legacyDispense\"` `\"carrierService.skipDeliveryStatus\"` `\"carrierService.changedAt\"` `\"carrierPickupPlace.name\"` `\"carrierPickupPlace.code\"` `\"carrierPickupPlace.code2\"` `\"carrierPickupPlace.address\"` `\"carrierPickupPlace.status\"` `\"carrierPickupPlace.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"user\"` `\"eshop\"` `\"warehouse\"` `\"wms\"` `\"partner\"` `\"orderNumber\"` `\"note\"` `\"billingFirstName\"` `\"billingLastName\"` `\"billingDegree\"` `\"billingCompany\"` `\"billingStreet\"` `\"billingHouseNr\"` `\"billingZip\"` `\"billingCity\"` `\"billingCountry\"` `\"billingEmail\"` `\"billingPhone\"` `\"billingRegistrationNumber\"` `\"billingVatNumber\"` `\"differentDeliveryAddress\"` `\"deliveryFirstName\"` `\"deliveryLastName\"` `\"deliveryDegree\"` `\"deliveryCompany\"` `\"deliveryStreet\"` `\"deliveryHouseNr\"` `\"deliveryZip\"` `\"deliveryCity\"` `\"deliveryCountry\"` `\"deliveryEmail\"` `\"deliveryPhone\"` `\"requiredExpeditionDate\"` `\"carrier\"` `\"carrierService\"` `\"carrierPickupPlace\"` `\"externalCarrierPickupPlace\"` `\"carrierNote\"` `\"trackingNumber\"` `\"trackingUrl\"` `\"externalTrackingNumber\"` `\"packagesCount\"` `\"status\"` `\"expeditedCompletely\"` `\"value\"` `\"currency\"` `\"fragile\"` `\"cod\"` `\"codValue\"` `\"codCurrency\"` `\"codVariableSymbol\"` `\"customerGroup\"` `\"eshopOrderDate\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"packedAt\"` `\"sentAt\"` `\"deliveredAt\"` `\"waitBeforeProcessing\"` `\"editBeforeProcessing\"` `\"priority\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"foreignPrice\"` `\"conversionDate\"` `\"modifiedAt\"` `\"removedVirtualProducts\"` `\"ignoreAddressValidation\"` `\"addressValidationExecuted\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"user",
"eshop",
"warehouse",
"wms",
"partner",
"orderNumber",
"note",
"billingFirstName",
"billingLastName",
"billingDegree",
"billingCompany",
"billingStreet",
"billingHouseNr",
"billingZip",
"billingCity",
"billingCountry",
"billingEmail",
"billingPhone",
"billingRegistrationNumber",
"billingVatNumber",
"differentDeliveryAddress",
"deliveryFirstName",
"deliveryLastName",
"deliveryDegree",
"deliveryCompany",
"deliveryStreet",
"deliveryHouseNr",
"deliveryZip",
"deliveryCity",
"deliveryCountry",
"deliveryEmail",
"deliveryPhone",
"requiredExpeditionDate",
"carrier",
"carrierService",
"carrierPickupPlace",
"externalCarrierPickupPlace",
"carrierNote",
"trackingNumber",
"trackingUrl",
"externalTrackingNumber",
"packagesCount",
"status",
"expeditedCompletely",
"value",
"currency",
"fragile",
"cod",
"codValue",
"codCurrency",
"codVariableSymbol",
"customerGroup",
"eshopOrderDate",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"packedAt",
"sentAt",
"deliveredAt",
"waitBeforeProcessing",
"editBeforeProcessing",
"priority",
"ref1",
"ref2",
"ref3",
"foreignPrice",
"conversionDate",
"modifiedAt",
"removedVirtualProducts",
"ignoreAddressValidation",
"addressValidationExecuted",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results15": {
"properties": {
"results": {
"$ref": "#/components/schemas/Expedition5"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ExpeditionList": {
"properties": {
"expeditions": {
"description": "Array with expedition UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 250,
"minItems": 1
}
},
"type": "object"
},
"MassActionResultList": {
"properties": {
"results": {
"description": "Set of ids and fail reasons.",
"items": {
"$ref": "#/components/schemas/MassActionResult"
},
"type": "array"
}
},
"type": "object"
},
"Expedition2": {
"required": [
"eshop",
"warehouse",
"wms",
"orderNumber",
"carrier",
"carrierService",
"value",
"currency"
],
"properties": {
"eshop": {
"description": "Uuid of Eshop to belongs this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"partner": {
"description": "Uuid of Partner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"orderNumber": {
"description": "Order number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"billingFirstName": {
"description": "Billing first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"billingLastName": {
"description": "Billing last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"billingDegree": {
"description": "Billing degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"billingCompany": {
"description": "Billing company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"billingStreet": {
"description": "Billing street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"billingHouseNr": {
"description": "Billing house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"billingZip": {
"description": "Billing zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"billingCity": {
"description": "Billing city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"billingCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"billingEmail": {
"description": "Billing email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": "60"
},
"billingPhone": {
"description": "Billing phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"billingRegistrationNumber": {
"description": "Billing registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32
},
"billingVatNumber": {
"description": "Billing Vat number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 32
},
"deliveryFirstName": {
"description": "Delivery first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"deliveryLastName": {
"description": "Delivery last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"deliveryDegree": {
"description": "Delivery degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"deliveryCompany": {
"description": "Delivery company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"deliveryStreet": {
"description": "Delivery street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"deliveryHouseNr": {
"description": "Delivery house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"deliveryZip": {
"description": "Delivery zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"deliveryCity": {
"description": "Delivery city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"deliveryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"deliveryEmail": {
"description": "Delivery email.",
"example": "john.doe@example.com",
"type": "string"
},
"deliveryPhone": {
"description": "Delivery phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"requiredExpeditionDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"carrier": {
"description": "Uuid of Carrier.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierService": {
"description": "Uuid of CarrierService.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlace": {
"description": "Uuid of CarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlaceCode": {
"description": "Code of CarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"externalCarrierPickupPlace": {
"description": "Uuid of ExternalCarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"externalCarrierPickupPlaceCode": {
"description": "Code of ExternalCarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"carrierNote": {
"description": "Note for carrier",
"type": "string",
"maxLength": 4096
},
"trackingNumber": {
"description": "Tracking number.",
"example": "DR4057137142G",
"type": "string",
"maxLength": 255
},
"trackingUrl": {
"description": "Tracking Url.",
"example": "https://www.postaonline.cz/trackandtrace/-/zasilka/cislo?parcelNumbers=DR4057137142G",
"type": "string",
"maxLength": 255
},
"externalTrackingNumber": {
"description": "External tracking number.",
"example": "PBZDE014624523",
"type": "string",
"maxLength": 255
},
"packagesCount": {
"description": "Packages count.",
"type": "integer"
},
"value": {
"description": "Value of the whole expedition.",
"example": "50.00",
"type": "number",
"format": "float",
"exclusiveMinimum": "0"
},
"currency": {
"description": "ISO currency code",
"example": "CZK",
"type": "string"
},
"fragile": {
"description": "Fragile",
"type": "boolean"
},
"cod": {
"description": "Cash on delivery, true/false",
"example": "true",
"type": "boolean"
},
"codValue": {
"description": "Cash on delivery value.",
"example": "5000",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
},
"codCurrency": {
"description": "ISO currency code.",
"example": "CZK",
"type": "string"
},
"codVariableSymbol": {
"description": "Cash on delivery variable symbol.",
"example": "0123456789",
"type": "string",
"maxLength": 32,
"pattern": "\\d+"
},
"customerGroup": {
"description": "Customer group.",
"example": "VIP",
"type": "string",
"maxLength": 255
},
"eshopOrderDate": {
"description": "Eshop order date.",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExpeditionItem4"
},
"type": "array",
"minItems": 1
},
"waitBeforeProcessing": {
"description": "Overrides eshop.waitBeforeProcessing value.",
"type": "boolean"
},
"editBeforeProcessing": {
"description": "Overrides eshop.editBeforeProcessing value.",
"type": "boolean"
},
"priority": {
"description": "Priority.",
"example": "5",
"type": "integer"
},
"ref1": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref2": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref3": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
}
},
"type": "object"
},
"Expedition3": {
"required": [
"eshop",
"warehouse",
"wms",
"orderNumber",
"carrier",
"carrierService",
"status",
"value",
"currency"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop to belongs this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"partner": {
"description": "Uuid of Partner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"orderNumber": {
"description": "Order number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"billingFirstName": {
"description": "Billing first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"billingLastName": {
"description": "Billing last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"billingDegree": {
"description": "Billing degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"billingCompany": {
"description": "Billing company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"billingStreet": {
"description": "Billing street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"billingHouseNr": {
"description": "Billing house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"billingZip": {
"description": "Billing zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"billingCity": {
"description": "Billing city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"billingCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"billingEmail": {
"description": "Billing email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": "60"
},
"billingPhone": {
"description": "Billing phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"billingRegistrationNumber": {
"description": "Billing registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32
},
"billingVatNumber": {
"description": "Billing Vat number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 32
},
"differentDeliveryAddress": {
"type": "boolean"
},
"deliveryFirstName": {
"description": "Delivery first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"deliveryLastName": {
"description": "Delivery last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"deliveryDegree": {
"description": "Delivery degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"deliveryCompany": {
"description": "Delivery company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"deliveryStreet": {
"description": "Delivery street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"deliveryHouseNr": {
"description": "Delivery house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"deliveryZip": {
"description": "Delivery zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"deliveryCity": {
"description": "Delivery city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"deliveryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"deliveryEmail": {
"description": "Delivery email.",
"example": "john.doe@example.com",
"type": "string"
},
"deliveryPhone": {
"description": "Delivery phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"requiredExpeditionDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"carrier": {
"description": "Uuid of Carrier.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierService": {
"description": "Uuid of CarrierService.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlace": {
"description": "Uuid of CarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlaceCode": {
"description": "Code of CarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"externalCarrierPickupPlace": {
"description": "Uuid of ExternalCarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"externalCarrierPickupPlaceCode": {
"description": "Code of ExternalCarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"carrierNote": {
"description": "Note for carrier",
"type": "string",
"maxLength": 4096
},
"trackingNumber": {
"description": "Tracking number.",
"example": "DR4057137142G",
"type": "string",
"maxLength": 255
},
"trackingUrl": {
"description": "Tracking Url.",
"example": "https://www.postaonline.cz/trackandtrace/-/zasilka/cislo?parcelNumbers=DR4057137142G",
"type": "string",
"maxLength": 255
},
"externalTrackingNumber": {
"description": "External tracking number.",
"example": "PBZDE014624523",
"type": "string",
"maxLength": 255
},
"packagesCount": {
"description": "Packages count.",
"type": "integer"
},
"status": {
"example": "new",
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"expeditedCompletely": {
"example": "true",
"type": "boolean"
},
"value": {
"description": "Value of the whole expedition.",
"example": "50.00",
"type": "number",
"format": "float",
"exclusiveMinimum": "0"
},
"currency": {
"description": "ISO currency code",
"example": "CZK",
"type": "string"
},
"fragile": {
"description": "Fragile",
"type": "boolean"
},
"cod": {
"description": "Cash on delivery, true/false",
"example": "true",
"type": "boolean"
},
"codValue": {
"description": "Cash on delivery value.",
"example": "5000",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
},
"codCurrency": {
"description": "ISO currency code.",
"example": "CZK",
"type": "string"
},
"codVariableSymbol": {
"description": "Cash on delivery variable symbol.",
"example": "0123456789",
"type": "string",
"maxLength": 32,
"pattern": "\\d+"
},
"customerGroup": {
"description": "Customer group.",
"example": "VIP",
"type": "string",
"maxLength": 255
},
"invoice": {
"description": "Invoice file info.",
"properties": {
"name": {
"description": "Internal file name.",
"type": "string"
},
"originalName": {
"description": "Original filename. Taken from upload file name.",
"example": "invoice.pdf",
"type": "string"
},
"mimeType": {
"description": "Mime type",
"example": "application/pdf",
"type": "string"
},
"size": {
"description": "File size.",
"example": "34567",
"type": "int"
}
},
"type": "object"
},
"eshopOrderDate": {
"description": "Eshop order date.",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExpeditionItem5"
},
"type": "array",
"minItems": 1
},
"audits": {
"items": {
"$ref": "#/components/schemas/ExpeditionStatusAudit2"
},
"type": "array"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"errors": {
"description": "Validation errors contains this list with details.",
"items": {
"properties": {
"message": {
"description": "Error title (e.g. *This value is not valid*).",
"example": "This value should not be blank.",
"type": "string"
},
"propertyPath": {
"description": "Path of field (e.g. *items[0].productCode*).",
"example": "firstName",
"type": "string"
},
"code": {
"description": "Error code.",
"example": "3b70573f-c259-4df7-89fd-ad0104c1b828",
"type": "string"
},
"parameters": {
"description": "Internal data regarding to current violation.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"packedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"sentAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"deliveredAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"waitBeforeProcessing": {
"description": "Overrides eshop.waitBeforeProcessing value.",
"type": "boolean"
},
"editBeforeProcessing": {
"description": "Overrides eshop.editBeforeProcessing value.",
"type": "boolean"
},
"priority": {
"description": "Priority.",
"example": "5",
"type": "integer"
},
"ref1": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref2": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref3": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"foreignPrice": {
"$ref": "#/components/schemas/MsMoney2"
},
"conversionDate": {
"description": "Conversion date",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"modifiedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"removedVirtualProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct2"
},
"type": "array"
},
"ignoreAddressValidation": {
"description": "Whether delivery address validation should be ignored. Default false.",
"type": "boolean"
},
"addressValidationExecuted": {
"description": "Whether delivery address validation has been executed.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"invoiceUrl": {
"example": "/api/expedition/529baf4b-b7f1-4ff4-827f-b05f52a1a22f/invoice",
"type": "string",
"format": "uri"
},
"invoiceOriginalName": {
"example": "invoice.pdf",
"type": "string",
"format": "string"
},
"withComplaint": {
"example": "false",
"type": "bool"
}
},
"type": "object"
},
"SendOptions": {
"properties": {
"rebook": {
"type": "boolean"
}
},
"type": "object"
},
"Expedition4": {
"required": [
"eshop",
"warehouse",
"wms",
"orderNumber",
"carrier",
"carrierService",
"status",
"value",
"currency"
],
"properties": {
"eshop": {
"description": "Uuid of Eshop to belongs this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"partner": {
"description": "Uuid of Partner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"orderNumber": {
"description": "Order number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"billingFirstName": {
"description": "Billing first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"billingLastName": {
"description": "Billing last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"billingDegree": {
"description": "Billing degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"billingCompany": {
"description": "Billing company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"billingStreet": {
"description": "Billing street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"billingHouseNr": {
"description": "Billing house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"billingZip": {
"description": "Billing zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"billingCity": {
"description": "Billing city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"billingCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"billingEmail": {
"description": "Billing email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": "60"
},
"billingPhone": {
"description": "Billing phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"billingRegistrationNumber": {
"description": "Billing registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32
},
"billingVatNumber": {
"description": "Billing Vat number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 32
},
"differentDeliveryAddress": {
"type": "boolean"
},
"deliveryFirstName": {
"description": "Delivery first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"deliveryLastName": {
"description": "Delivery last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"deliveryDegree": {
"description": "Delivery degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"deliveryCompany": {
"description": "Delivery company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"deliveryStreet": {
"description": "Delivery street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"deliveryHouseNr": {
"description": "Delivery house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"deliveryZip": {
"description": "Delivery zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"deliveryCity": {
"description": "Delivery city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"deliveryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"deliveryEmail": {
"description": "Delivery email.",
"example": "john.doe@example.com",
"type": "string"
},
"deliveryPhone": {
"description": "Delivery phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"requiredExpeditionDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"carrier": {
"description": "Uuid of Carrier.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierService": {
"description": "Uuid of CarrierService.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlace": {
"description": "Uuid of CarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlaceCode": {
"description": "Code of CarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"externalCarrierPickupPlace": {
"description": "Uuid of ExternalCarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"externalCarrierPickupPlaceCode": {
"description": "Code of ExternalCarrierPickupPlace.",
"example": "AAA687",
"type": "string"
},
"carrierNote": {
"description": "Note for carrier",
"type": "string",
"maxLength": 4096
},
"trackingNumber": {
"description": "Tracking number.",
"example": "DR4057137142G",
"type": "string",
"maxLength": 255
},
"trackingUrl": {
"description": "Tracking Url.",
"example": "https://www.postaonline.cz/trackandtrace/-/zasilka/cislo?parcelNumbers=DR4057137142G",
"type": "string",
"maxLength": 255
},
"externalTrackingNumber": {
"description": "External tracking number.",
"example": "PBZDE014624523",
"type": "string",
"maxLength": 255
},
"packagesCount": {
"description": "Packages count.",
"type": "integer"
},
"status": {
"example": "new",
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"value": {
"description": "Value of the whole expedition.",
"example": "50.00",
"type": "number",
"format": "float",
"exclusiveMinimum": "0"
},
"currency": {
"description": "ISO currency code",
"example": "CZK",
"type": "string"
},
"fragile": {
"description": "Fragile",
"type": "boolean"
},
"cod": {
"description": "Cash on delivery, true/false",
"example": "true",
"type": "boolean"
},
"codValue": {
"description": "Cash on delivery value.",
"example": "5000",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
},
"codCurrency": {
"description": "ISO currency code.",
"example": "CZK",
"type": "string"
},
"codVariableSymbol": {
"description": "Cash on delivery variable symbol.",
"example": "0123456789",
"type": "string",
"maxLength": 32,
"pattern": "\\d+"
},
"customerGroup": {
"description": "Customer group.",
"example": "VIP",
"type": "string",
"maxLength": 255
},
"eshopOrderDate": {
"description": "Eshop order date.",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExpeditionItem6"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"ExpeditionExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"note": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"currency": {
"$ref": "#/components/schemas/StringCondition"
},
"fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"requiredExpeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"packedAt": {
"$ref": "#/components/schemas/DateCondition"
},
"deliveredAt": {
"$ref": "#/components/schemas/DateCondition"
},
"sentAt": {
"$ref": "#/components/schemas/DateCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"modifiedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"invoice.name": {
"$ref": "#/components/schemas/StringCondition"
},
"invoice.originalName": {
"$ref": "#/components/schemas/StringCondition"
},
"invoice.size": {
"$ref": "#/components/schemas/IntegerCondition"
},
"invoice.mimeType": {
"$ref": "#/components/schemas/StringCondition"
},
"carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expeditedCompletely": {
"$ref": "#/components/schemas/NullableBooleanCondition"
},
"withInvoice": {
"$ref": "#/components/schemas/BooleanCondition"
},
"withComplaint": {
"$ref": "#/components/schemas/BooleanCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"user\"` `\"eshop\"` `\"warehouse\"` `\"wms\"` `\"partner\"` `\"orderNumber\"` `\"billingFirstName\"` `\"billingLastName\"` `\"billingDegree\"` `\"billingCompany\"` `\"billingStreet\"` `\"billingHouseNr\"` `\"billingZip\"` `\"billingCity\"` `\"billingCountry\"` `\"billingEmail\"` `\"billingPhone\"` `\"billingRegistrationNumber\"` `\"billingVatNumber\"` `\"differentDeliveryAddress\"` `\"deliveryFirstName\"` `\"deliveryLastName\"` `\"deliveryDegree\"` `\"deliveryCompany\"` `\"deliveryStreet\"` `\"deliveryHouseNr\"` `\"deliveryZip\"` `\"deliveryCity\"` `\"deliveryCountry\"` `\"deliveryEmail\"` `\"deliveryPhone\"` `\"requiredExpeditionDate\"` `\"carrier\"` `\"carrierService\"` `\"carrierPickupPlace\"` `\"externalCarrierPickupPlace\"` `\"carrierNote\"` `\"trackingNumber\"` `\"trackingUrl\"` `\"externalTrackingNumber\"` `\"packagesCount\"` `\"status\"` `\"expeditedCompletely\"` `\"value\"` `\"currency\"` `\"fragile\"` `\"cod\"` `\"codValue\"` `\"codCurrency\"` `\"codVariableSymbol\"` `\"customerGroup\"` `\"eshopOrderDate\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"packedAt\"` `\"sentAt\"` `\"deliveredAt\"` `\"waitBeforeProcessing\"` `\"editBeforeProcessing\"` `\"priority\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"foreignPrice\"` `\"conversionDate\"` `\"modifiedAt\"` `\"removedVirtualProducts\"` `\"ignoreAddressValidation\"` `\"addressValidationExecuted\"` `\"changedAt\"` `\"user.dateOfBirth\"` `\"user.firstName\"` `\"user.lastName\"` `\"user.email\"` `\"user.phone\"` `\"user.changedAt\"` `\"eshop.name\"` `\"eshop.integrationType\"` `\"eshop.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"partner.code\"` `\"partner.name\"` `\"partner.companyName\"` `\"partner.firstName\"` `\"partner.lastName\"` `\"partner.email\"` `\"partner.registrationNumber\"` `\"partner.vatNumber\"` `\"partner.changedAt\"` `\"billingCountry.code\"` `\"billingCountry.name\"` `\"billingCountry.currencyCode\"` `\"billingCountry.currencyName\"` `\"billingCountry.customsDeclaration\"` `\"billingCountry.changedAt\"` `\"deliveryCountry.code\"` `\"deliveryCountry.name\"` `\"deliveryCountry.currencyCode\"` `\"deliveryCountry.currencyName\"` `\"deliveryCountry.customsDeclaration\"` `\"deliveryCountry.changedAt\"` `\"carrier.name\"` `\"carrier.code\"` `\"carrier.changedAt\"` `\"carrierService.name\"` `\"carrierService.code\"` `\"carrierService.pickupPlaceIgnore\"` `\"carrierService.pickupPlaceMandatory\"` `\"carrierService.emailMandatory\"` `\"carrierService.phoneMandatory\"` `\"carrierService.legacyDispense\"` `\"carrierService.skipDeliveryStatus\"` `\"carrierService.changedAt\"` `\"carrierPickupPlace.name\"` `\"carrierPickupPlace.code\"` `\"carrierPickupPlace.code2\"` `\"carrierPickupPlace.address\"` `\"carrierPickupPlace.status\"` `\"carrierPickupPlace.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"ExpeditionItemListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"booked": {
"$ref": "#/components/schemas/IntegerCondition"
},
"position": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missing": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedited": {
"$ref": "#/components/schemas/IntegerCondition"
},
"lot": {
"$ref": "#/components/schemas/StringCondition"
},
"ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"ref3": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product\"` `\"expedition\"` `\"position\"` `\"expedited\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"` `\"lifo\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "position"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"product\"` `\"expedition\"` `\"position\"` `\"bookStockAdvices\"` `\"expedited\"` `\"id\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"` `\"lifo\"` `\"ref1\"` `\"ref2\"` `\"ref3\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"product",
"expedition",
"position",
"bookStockAdvices",
"expedited",
"id",
"quantity",
"booked",
"missing",
"lot",
"assignedLot",
"lifo",
"ref1",
"ref2",
"ref3"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results16": {
"properties": {
"results": {
"$ref": "#/components/schemas/ExpeditionItem7"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ExportJobListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"owner": {
"$ref": "#/components/schemas/UuidCondition"
},
"owner.email": {
"$ref": "#/components/schemas/StringCondition"
},
"owner.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"startedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"finishedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"id\"` `\"type\"` `\"status\"` `\"name\"` `\"fileType\"` `\"filename\"` `\"owner\"` `\"createdAt\"` `\"startedAt\"` `\"finishedAt\"` `\"expectedRecords\"` `\"processedRecords\"` `\"owner.firstName\"` `\"owner.lastName\"` `\"owner.email\"` `\"owner.phone\"` `\"owner.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"type\"` `\"status\"` `\"name\"` `\"fileType\"` `\"filename\"` `\"owner\"` `\"createdAt\"` `\"startedAt\"` `\"finishedAt\"` `\"expectedRecords\"` `\"processedRecords\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"type",
"status",
"name",
"fileType",
"filename",
"owner",
"createdAt",
"startedAt",
"finishedAt",
"expectedRecords",
"processedRecords"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results17": {
"properties": {
"results": {
"$ref": "#/components/schemas/ExportJob2"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ExternalCarrierPickupPlace": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"code": {
"type": "string"
},
"street": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/Country"
},
"carrierPickupPlace": {
"$ref": "#/components/schemas/CarrierPickupPlace"
}
},
"type": "object"
},
"ExternalCarrierPickupPlaceListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"code": {
"$ref": "#/components/schemas/StringCondition"
},
"street": {
"$ref": "#/components/schemas/StringCondition"
},
"country": {
"$ref": "#/components/schemas/StringCondition"
},
"carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "There are no sort fields available.",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "street"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"code\"` `\"street\"` `\"streetNumber\"` `\"city\"` `\"zip\"` `\"country\"` `\"carrierPickupPlace\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"code",
"street",
"streetNumber",
"city",
"zip",
"country",
"carrierPickupPlace"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results18": {
"properties": {
"results": {
"$ref": "#/components/schemas/ExternalCarrierPickupPlace2"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ProductItemResult": {
"properties": {
"ProductItem": {
"$ref": "#/components/schemas/ProductItem"
}
},
"type": "object"
},
"InboundReceiptListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"stockAdvice.expectedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"stockAdvice.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"stockAdvice.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.status": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.inputType": {
"$ref": "#/components/schemas/BooleanCondition"
},
"stockAdvice.wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.supplier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.lot": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movements.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"movements.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"stockAdvice\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"note\"` `\"returnedParcelNumber\"` `\"complete\"` `\"stockAdvice.packagingUnit\"` `\"stockAdvice.countOfUnits\"` `\"stockAdvice.status\"` `\"stockAdvice.note\"` `\"stockAdvice.internalId\"` `\"stockAdvice.wmsInternalId\"` `\"stockAdvice.mailwiseInternalId\"` `\"stockAdvice.expectedAt\"` `\"stockAdvice.createdAt\"` `\"stockAdvice.countOfItems\"` `\"stockAdvice.countOfSku\"` `\"stockAdvice.sumOfQuantity\"` `\"stockAdvice.sumOfSuppliedQuantity\"` `\"stockAdvice.ref1\"` `\"stockAdvice.ref2\"` `\"stockAdvice.ref3\"` `\"stockAdvice.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"stockAdvice\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"stockAdvice",
"wms",
"organisation",
"warehouse",
"wmsInternalId",
"receivedAt",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results19": {
"properties": {
"results": {
"$ref": "#/components/schemas/InboundReceipt3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"InboundReceiptExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"stockAdvice.expectedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"stockAdvice.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"stockAdvice.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.status": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.inputType": {
"$ref": "#/components/schemas/BooleanCondition"
},
"stockAdvice.wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.supplier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.lot": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movements.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"movements.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"stockAdvice\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"note\"` `\"returnedParcelNumber\"` `\"complete\"` `\"stockAdvice.packagingUnit\"` `\"stockAdvice.countOfUnits\"` `\"stockAdvice.status\"` `\"stockAdvice.note\"` `\"stockAdvice.internalId\"` `\"stockAdvice.wmsInternalId\"` `\"stockAdvice.mailwiseInternalId\"` `\"stockAdvice.expectedAt\"` `\"stockAdvice.createdAt\"` `\"stockAdvice.countOfItems\"` `\"stockAdvice.countOfSku\"` `\"stockAdvice.sumOfQuantity\"` `\"stockAdvice.sumOfSuppliedQuantity\"` `\"stockAdvice.ref1\"` `\"stockAdvice.ref2\"` `\"stockAdvice.ref3\"` `\"stockAdvice.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"InboundReceipt": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockAdvice": {
"description": "Uuid of Stock Advice to belongs this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movements": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"processed",
"failed"
]
}
},
"type": "object"
},
"InternalStockChangeListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"wms",
"organisation",
"warehouse",
"receivedAt",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status",
"type"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results20": {
"properties": {
"results": {
"$ref": "#/components/schemas/InternalStockChange4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"InternalStockChange": {
"required": [
"name",
"wms",
"organisation",
"warehouse",
"type"
],
"properties": {
"name": {
"description": "Unique descriptive name of a stock change.",
"example": "_529b-af4b/2022",
"type": "string",
"maxLength": 255,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"items": {
"items": {
"$ref": "#/components/schemas/InternalStockChangeItem"
},
"type": "array",
"minItems": 1
},
"type": {
"example": "new",
"type": "string",
"enum": [
"in",
"out"
]
}
},
"type": "object"
},
"InternalStockChange2": {
"required": [
"name",
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status",
"type"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Unique descriptive name of a stock change.",
"example": "_529b-af4b/2022",
"type": "string",
"maxLength": 255,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"items": {
"items": {
"$ref": "#/components/schemas/InternalStockChangeItem2"
},
"type": "array",
"minItems": 1
},
"movements": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"waiting_for_goods",
"ready",
"processed",
"failed",
"canceled"
]
},
"type": {
"example": "new",
"type": "string",
"enum": [
"in",
"out"
]
}
},
"type": "object"
},
"InternalStockChange3": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Unique descriptive name of a stock change.",
"example": "_529b-af4b/2022",
"type": "string",
"maxLength": 255,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"items": {
"items": {
"$ref": "#/components/schemas/InternalStockChangeItem3"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"InternalStockChangeList": {
"properties": {
"internalStockChanges": {
"description": "Array with stockChange UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 250,
"minItems": 1
}
},
"type": "object"
},
"AdminLogin": {
"required": [
"login",
"password"
],
"properties": {
"login": {
"description": "Administrators email address.",
"example": "john.doe@example.com",
"type": "string"
},
"password": {
"description": "Administrator password.",
"example": "A1B2C3D4",
"type": "string"
}
},
"type": "object"
},
"Token": {
"properties": {
"token": {
"description": "Serialized JSON web token.",
"example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEyMzQ1Njc4LWFiY2QtMTIzNC1hYmNkLTEyMzM0NTY3ODlhYiIsInR5cGUiOiJhZG1pbiIsImV4cGlyZSI6MTU5MzgyODIyMn0.PlscuLItHb4oRvHBiLO5k1o-O1YzdExp0nlcmmZvQ3k",
"type": "string"
},
"exp": {
"description": "Unix timestamp representing the date and time of token expiration.",
"example": 1590922425,
"type": "integer"
}
},
"type": "object"
},
"UserLogin": {
"required": [
"login",
"password"
],
"properties": {
"login": {
"description": "Users email address or phone number.",
"example": "john.doe@example.com",
"type": "string"
},
"password": {
"description": "User password.",
"example": "A1B2C3D4",
"type": "string"
}
},
"type": "object"
},
"User": {
"required": [
"dateOfBirth",
"addressLine1",
"addressLine2",
"addressLine3",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"dateOfBirth": {
"description": "Date of birth.",
"example": "1970-07-12",
"type": "string",
"format": "date",
"maximum": "-18 years"
},
"sex": {
"description": "sex",
"example": "male",
"type": "string",
"enum": [
"male",
"female",
null
]
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"photoUploadedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"preferredLanguage": {
"description": "Preferred language.",
"example": "en",
"type": "string",
"enum": [
"cs",
"sk",
"en",
"ru",
"it",
"es"
]
},
"createdBy": {
"description": "Uuid of User that created this User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"ownedOrganisations": {
"description": "Array with owned organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
},
"changedAt": {
"type": "string",
"format": "date-time"
},
"photo": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
},
"photoList": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"UserUpdate": {
"required": [
"dateOfBirth",
"addressLine1",
"addressLine2",
"addressLine3",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"dateOfBirth": {
"description": "Date of birth.",
"example": "1970-07-12",
"type": "string",
"format": "date",
"maximum": "-18 years"
},
"sex": {
"description": "sex",
"example": "male",
"type": "string",
"enum": [
"male",
"female",
null
]
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"photo": {
"description": "Photo.",
"example": "data:image/gif;base64,R0lGODdhAQABAIAAAP///////ywAAAAAAQABAAACAkQBADs=",
"type": "string"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"preferredLanguage": {
"description": "Preferred language.",
"example": "en",
"type": "string",
"enum": [
"cs",
"sk",
"en",
"ru",
"it",
"es"
]
},
"ownedOrganisations": {
"description": "Array with owned organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
},
"oldPassword": {
"example": "A1B2C3D4",
"type": "string",
"maxLength": 255
},
"newPassword": {
"description": "New password.",
"example": "D5E6F7G8",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"MissingStockListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"booked": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missing": {
"$ref": "#/components/schemas/IntegerCondition"
},
"lot": {
"$ref": "#/components/schemas/StringCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.weight": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.height": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.width": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.length": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.packagingType": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition.wms.name\"` `\"expedition.warehouse.name\"` `\"expedition.eshop.name\"` `\"product\"` `\"expedition\"` `\"id\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "expedition.createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"product\"` `\"expedition\"` `\"bookStockAdvices\"` `\"id\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"product",
"expedition",
"bookStockAdvices",
"id",
"quantity",
"booked",
"missing",
"lot",
"assignedLot"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results21": {
"properties": {
"results": {
"$ref": "#/components/schemas/ExpeditionItem8"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"MissingStockExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"booked": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missing": {
"$ref": "#/components/schemas/IntegerCondition"
},
"lot": {
"$ref": "#/components/schemas/StringCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.weight": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.height": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.width": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.length": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.packagingType": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition.wms.name\"` `\"expedition.warehouse.name\"` `\"expedition.eshop.name\"` `\"product\"` `\"expedition\"` `\"id\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "expedition.createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"ExpeditionItem": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
}
},
"type": "object"
},
"Notification": {
"properties": {
"id": {
"example": "oEjOGIABbGY_VJusbqWA",
"type": "string"
},
"type": {
"example": "keyword",
"type": "string"
},
"content": {
"example": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit.",
"type": "string"
},
"seen": {
"description": "Filtr seen / unseen",
"example": true,
"type": "boolean"
},
"flag": {
"description": "Flag true / false",
"example": true,
"type": "boolean"
},
"createdAt": {
"example": "2022-04-12T10:25:11+02:00",
"type": "string",
"format": "date-time"
},
"entityId": {
"description": "Uuid of entity which is related to notification",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string"
},
"userId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisationId": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"Results22": {
"properties": {
"results": {
"$ref": "#/components/schemas/User5"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Notification2": {
"properties": {
"seen": {
"description": "Filtr seen / unseen",
"example": true,
"type": "boolean"
},
"flag": {
"description": "Flag true / false",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"NotificationListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"seen": {
"$ref": "#/components/schemas/BooleanCondition"
},
"flag": {
"$ref": "#/components/schemas/BooleanCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"seen\"` `\"flag\"` `\"createdAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt",
"order": "DESC"
},
{
"field": "flag",
"order": "DESC"
},
{
"field": "seen",
"order": "DESC"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"type\"` `\"content\"` `\"seen\"` `\"flag\"` `\"createdAt\"` `\"entityId\"` `\"userId\"` `\"organisationId\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"type",
"content",
"seen",
"flag",
"createdAt",
"entityId",
"userId",
"organisationId"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results23": {
"properties": {
"results": {
"$ref": "#/components/schemas/Notification3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"NotificationSetting": {
"required": [
"type",
"organisation"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "product_stock",
"type": "string",
"enum": [
"stock_advice",
"complaint",
"product_stock",
"inbound_receipt"
]
},
"email": {
"description": "Emailová adresa.",
"type": "string"
},
"sendToEmail": {
"type": "boolean"
},
"sendToMs": {
"type": "boolean"
},
"createdBy": {
"description": "Uuid of User that enter this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"threshold": {
"$ref": "#/components/schemas/Threshold"
},
"createdAt": {
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"notificationSent": {
"type": "boolean"
},
"subscribers": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
}
},
"type": "object"
},
"NotificationSettingListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"email": {
"$ref": "#/components/schemas/StringCondition"
},
"sendToEmail": {
"$ref": "#/components/schemas/BooleanCondition"
},
"sendToMs": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdBy": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"type\"` `\"email\"` `\"sendToEmail\"` `\"sendToMs\"` `\"createdAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"type\"` `\"email\"` `\"sendToEmail\"` `\"sendToMs\"` `\"createdBy\"` `\"organisation\"` `\"threshold\"` `\"createdAt\"` `\"notificationSent\"` `\"subscribers\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"type",
"email",
"sendToEmail",
"sendToMs",
"createdBy",
"organisation",
"threshold",
"createdAt",
"notificationSent",
"subscribers"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results24": {
"properties": {
"results": {
"$ref": "#/components/schemas/NotificationSetting3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"NotificationSetting2": {
"type": "object"
},
"AresInfo": {
"properties": {
"name": {
"example": "Example ltd.",
"type": "string"
},
"registrationNumber": {
"example": "12345678",
"type": "string"
},
"vatNumber": {
"example": "CZ12345678",
"type": "string"
},
"addressLine1": {
"example": "Street 1",
"type": "string"
},
"addressLine2": {
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"example": "Czech Republic",
"type": "string"
},
"systemId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
}
},
"type": "object"
},
"OrganisationListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"registrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"vatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"primaryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"owners": {
"$ref": "#/components/schemas/UuidCondition"
},
"countriesOfOperation": {
"$ref": "#/components/schemas/StringCondition"
},
"users": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"carriers": {
"$ref": "#/components/schemas/UuidCondition"
},
"carriers.name": {
"$ref": "#/components/schemas/StringCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"registrationNumber\"` `\"vatNumber\"` `\"addressLine1\"` `\"addressLine2\"` `\"addressLine3\"` `\"primaryCountry\"` `\"code\"` `\"automaticExchangeEnabled\"` `\"ignoreAddressValidation\"` `\"changedAt\"` `\"primaryCountry.code\"` `\"primaryCountry.name\"` `\"primaryCountry.currencyCode\"` `\"primaryCountry.currencyName\"` `\"primaryCountry.customsDeclaration\"` `\"primaryCountry.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"registrationNumber\"` `\"vatNumber\"` `\"addressLine1\"` `\"addressLine2\"` `\"addressLine3\"` `\"primaryCountry\"` `\"owner\"` `\"owners\"` `\"active\"` `\"createdAt\"` `\"wmses\"` `\"suppliers\"` `\"code\"` `\"automaticExchangeEnabled\"` `\"ignoreAddressValidation\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"registrationNumber",
"vatNumber",
"addressLine1",
"addressLine2",
"addressLine3",
"primaryCountry",
"owner",
"owners",
"active",
"createdAt",
"wmses",
"suppliers",
"code",
"automaticExchangeEnabled",
"ignoreAddressValidation",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results25": {
"properties": {
"results": {
"$ref": "#/components/schemas/Organisation4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Organisation": {
"required": [
"name",
"registrationNumber",
"vatNumber",
"primaryCountry",
"active",
"mailstageProductToAllEshops",
"automaticExchangeEnabled"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Organisation name.",
"example": "Inventi",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"vatNumber": {
"description": "VAT number",
"example": "CZ12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string"
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"primaryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"owner": {
"description": "Uuid of User that owns this organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"owners": {
"description": "Uuid of Users that own this organisation.",
"example": "[529baf4b-b7f1-4ff4-827f-b05f52a1a22f, f1ae1656-9a65-11ec-b909-0242ac120002]",
"items": {
"type": "uuid"
},
"type": "array"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where organisation operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"users": {
"description": "Array with users UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"admins": {
"description": "Array with admins UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"eshops": {
"description": "Array with eshops UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"warehouses": {
"description": "Array with warehouse UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"wmses": {
"description": "Array with wmses UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"carriers": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"suppliers": {
"description": "Array with suppliers UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"code": {
"description": "Organisation code.",
"example": "ZZ",
"type": "string",
"maxLength": 32
},
"mailstageProductToAllEshops": {
"description": "If true, product is linked to all eshops when it's created via Mailstage endpoint.",
"example": false,
"type": "boolean"
},
"automaticExchangeEnabled": {
"description": "If true, the value of the shipment is automatically recalculated.",
"example": false,
"type": "boolean"
},
"ignoreAddressValidation": {
"description": "Whether expedition delivery address validation should be ignored. Default false.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Organisation2": {
"required": [
"name",
"registrationNumber",
"vatNumber",
"primaryCountry",
"active",
"automaticExchangeEnabled"
],
"properties": {
"name": {
"description": "Organisation name.",
"example": "Inventi",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"vatNumber": {
"description": "VAT number",
"example": "CZ12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string"
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"primaryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"owner": {
"description": "Uuid of User that owns this organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"owners": {
"description": "Uuid of Users that own this organisation.",
"example": "[529baf4b-b7f1-4ff4-827f-b05f52a1a22f, f1ae1656-9a65-11ec-b909-0242ac120002]",
"items": {
"type": "uuid"
},
"type": "array"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where organisation operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"users": {
"description": "Array with users UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"admins": {
"description": "Array with admins UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"code": {
"description": "Organisation code.",
"example": "ZZ",
"type": "string",
"maxLength": 32
},
"automaticExchangeEnabled": {
"description": "If true, the value of the shipment is automatically recalculated.",
"example": false,
"type": "boolean"
},
"ignoreAddressValidation": {
"description": "Whether expedition delivery address validation should be ignored. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"Organisation3": {
"required": [
"name",
"registrationNumber",
"vatNumber",
"primaryCountry",
"active",
"automaticExchangeEnabled"
],
"properties": {
"name": {
"description": "Organisation name.",
"example": "Inventi",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"vatNumber": {
"description": "VAT number",
"example": "CZ12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string"
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"primaryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"owner": {
"description": "Uuid of User that owns this organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"owners": {
"description": "Uuid of Users that own this organisation.",
"example": "[529baf4b-b7f1-4ff4-827f-b05f52a1a22f, f1ae1656-9a65-11ec-b909-0242ac120002]",
"items": {
"type": "uuid"
},
"type": "array"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where organisation operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"users": {
"description": "Array with users UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"admins": {
"description": "Array with admins UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"eshops": {
"description": "Array with eshops UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"warehouses": {
"description": "Array with warehouse UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"wmses": {
"description": "Array with wmses UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"suppliers": {
"description": "Array with suppliers UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"code": {
"description": "Organisation code.",
"example": "ZZ",
"type": "string",
"maxLength": 32
},
"automaticExchangeEnabled": {
"description": "If true, the value of the shipment is automatically recalculated.",
"example": false,
"type": "boolean"
},
"ignoreAddressValidation": {
"description": "Whether expedition delivery address validation should be ignored. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"UserList": {
"properties": {
"users": {
"description": "Array with user UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"CarrierList": {
"properties": {
"carriers": {
"description": "Array with carrier UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"Wms": {
"required": [
"name"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Wms name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
}
},
"type": "object"
},
"OutboundReceiptListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.lot": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movements.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"issuedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"expedition\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"issuedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"expedition",
"wms",
"organisation",
"warehouse",
"wmsInternalId",
"issuedAt",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results26": {
"properties": {
"results": {
"$ref": "#/components/schemas/OutboundReceipt2"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"OutboundReceiptExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.lot": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movements.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"issuedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"OutboundReceipt": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition to belongs this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movements": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"issuedAt": {
"description": "Issued date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"processed",
"failed"
]
}
},
"type": "object"
},
"PartnerListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"companyName": {
"$ref": "#/components/schemas/StringCondition"
},
"firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"street": {
"$ref": "#/components/schemas/StringCondition"
},
"houseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"city": {
"$ref": "#/components/schemas/StringCondition"
},
"zip": {
"$ref": "#/components/schemas/StringCondition"
},
"country": {
"$ref": "#/components/schemas/StringCondition"
},
"phone": {
"$ref": "#/components/schemas/StringCondition"
},
"email": {
"$ref": "#/components/schemas/StringCondition"
},
"registrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"vatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"code\"` `\"name\"` `\"companyName\"` `\"firstName\"` `\"lastName\"` `\"street\"` `\"houseNr\"` `\"city\"` `\"zip\"` `\"country\"` `\"phone\"` `\"email\"` `\"registrationNumber\"` `\"vatNumber\"` `\"createdAt\"` `\"changedAt\"` `\"country.code\"` `\"country.name\"` `\"country.currencyCode\"` `\"country.currencyName\"` `\"country.customsDeclaration\"` `\"country.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"eshop\"` `\"code\"` `\"name\"` `\"companyName\"` `\"firstName\"` `\"lastName\"` `\"degree\"` `\"degree2\"` `\"street\"` `\"houseNr\"` `\"city\"` `\"zip\"` `\"country\"` `\"phone\"` `\"email\"` `\"registrationNumber\"` `\"vatNumber\"` `\"note\"` `\"active\"` `\"createdAt\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"eshop",
"code",
"name",
"companyName",
"firstName",
"lastName",
"degree",
"degree2",
"street",
"houseNr",
"city",
"zip",
"country",
"phone",
"email",
"registrationNumber",
"vatNumber",
"note",
"active",
"createdAt",
"ref1",
"ref2",
"ref3",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results27": {
"properties": {
"results": {
"$ref": "#/components/schemas/Partner4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Partner": {
"required": [
"eshop",
"name",
"street",
"city",
"zip",
"country",
"phone",
"email",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop to whom partner belongs to.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"code": {
"description": "This value is unique identifier used by older Mailstage API (addr_id).",
"example": 1,
"type": "integer",
"minimum": 0
},
"name": {
"description": "Partner name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Title.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number.",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City.",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": 20,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Partner2": {
"required": [
"eshop",
"name",
"street",
"city",
"zip",
"country",
"phone",
"email",
"active"
],
"properties": {
"eshop": {
"description": "Uuid of Eshop to whom partner belongs to.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"code": {
"description": "This value is unique identifier used by older Mailstage API (addr_id).",
"example": 1,
"type": "integer",
"minimum": 0
},
"name": {
"description": "Partner name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Title.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number.",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City.",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": 20,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"Partner3": {
"required": [
"eshop",
"name",
"street",
"city",
"zip",
"country",
"phone",
"email",
"active"
],
"properties": {
"eshop": {
"description": "Uuid of Eshop to whom partner belongs to.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"code": {
"description": "This value is unique identifier used by older Mailstage API (addr_id).",
"example": 1,
"type": "integer",
"minimum": 0
},
"name": {
"description": "Partner name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Title.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number.",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City.",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": 20,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"PartnerList": {
"properties": {
"partners": {
"description": "Array with partner UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"ProductListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"weight": {
"$ref": "#/components/schemas/IntegerCondition"
},
"height": {
"$ref": "#/components/schemas/IntegerCondition"
},
"width": {
"$ref": "#/components/schemas/IntegerCondition"
},
"length": {
"$ref": "#/components/schemas/IntegerCondition"
},
"referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"packagingType": {
"$ref": "#/components/schemas/StringCondition"
},
"workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshops.name": {
"$ref": "#/components/schemas/StringCondition"
},
"productGroup.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"productSku\"` `\"internalSku\"` `\"productGroup\"` `\"name\"` `\"description\"` `\"weight\"` `\"height\"` `\"width\"` `\"length\"` `\"referenceNumbers\"` `\"packagingType\"` `\"workAroundSnIn\"` `\"workAroundEanSticker\"` `\"workAroundWarrantyInf\"` `\"workAroundLot\"` `\"createdAt\"` `\"countryOfOrigin\"` `\"hsCode\"` `\"type\"` `\"childrenProducts\"` `\"changedAt\"` `\"productGroup.name\"` `\"productGroup.changedAt\"` `\"countryOfOrigin.code\"` `\"countryOfOrigin.name\"` `\"countryOfOrigin.currencyCode\"` `\"countryOfOrigin.currencyName\"` `\"countryOfOrigin.customsDeclaration\"` `\"countryOfOrigin.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"eshops\"` `\"productSku\"` `\"internalSku\"` `\"organisation\"` `\"productGroup\"` `\"name\"` `\"description\"` `\"images\"` `\"intImages\"` `\"weight\"` `\"height\"` `\"width\"` `\"length\"` `\"intWeight\"` `\"intHeight\"` `\"intWidth\"` `\"intLength\"` `\"referenceNumbers\"` `\"packagingType\"` `\"workAroundSnIn\"` `\"workAroundEanSticker\"` `\"workAroundWarrantyInf\"` `\"workAroundLot\"` `\"active\"` `\"createdAt\"` `\"countryOfOrigin\"` `\"hsCode\"` `\"type\"` `\"childrenProducts\"` `\"category\"` `\"changedAt\"` `\"inStock\"` `\"booked\"` `\"quantityToStock\"` `\"available\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"eshops",
"productSku",
"internalSku",
"organisation",
"productGroup",
"name",
"description",
"images",
"intImages",
"weight",
"height",
"width",
"length",
"intWeight",
"intHeight",
"intWidth",
"intLength",
"referenceNumbers",
"packagingType",
"workAroundSnIn",
"workAroundEanSticker",
"workAroundWarrantyInf",
"workAroundLot",
"active",
"createdAt",
"countryOfOrigin",
"hsCode",
"type",
"childrenProducts",
"category",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results28": {
"properties": {
"results": {
"$ref": "#/components/schemas/Product4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Product": {
"required": [
"eshops",
"productSku",
"internalSku",
"organisation",
"name",
"packagingType",
"workAroundSnIn",
"workAroundEanSticker",
"workAroundWarrantyInf",
"workAroundLot",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshops": {
"description": "Uuid of eshops.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"productSku": {
"description": "Poduct SKU.",
"example": "123",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"internalSku": {
"description": "Internal SKU.",
"example": "456",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"productGroup": {
"description": "Uuid of ProductGroup.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Product name.",
"example": "Mikrovlnná trouba 526",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"description": {
"description": "Product description.",
"example": "Volně stojící ikrovlnná trouba s příkonem 3kW",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"images": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"intImages": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"weight": {
"description": "Weight in grams.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 10000000,
"exclusiveMinimum": 0
},
"height": {
"description": "Weight in milimeters.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"width": {
"description": "Width in milimeters.",
"example": "400",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"length": {
"description": "Length in milimeters.",
"example": "1000",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"intWeight": {
"description": "Weight in grams from Mailwise.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 10000000
},
"intHeight": {
"description": "Weight in milimeters from Mailwise.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 20000
},
"intWidth": {
"description": "Width in milimeters from Mailwise.",
"example": "400",
"type": "integer",
"exclusiveMaximum": 20000
},
"intLength": {
"description": "Length in milimeters from Mailwise.",
"example": "1000",
"type": "integer",
"exclusiveMaximum": 20000
},
"referenceNumbers": {
"description": "Array with reference numbers. When null/empty, productSku is used instead.",
"example": [
"123",
"456"
],
"items": {
"type": "string"
},
"type": "array"
},
"packagingType": {
"description": "Packaging type.",
"example": "A",
"type": "string"
},
"workAroundSnIn": {
"type": "boolean"
},
"workAroundEanSticker": {
"type": "boolean"
},
"workAroundWarrantyInf": {
"type": "boolean"
},
"workAroundLot": {
"type": "boolean"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countryOfOrigin": {
"description": "Country of origin code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"hsCode": {
"description": "HS code.",
"example": "HS123456",
"type": "string"
},
"type": {
"description": "Product type.",
"example": "bundle",
"type": "string",
"enum": [
"virtual",
"physical",
"bundle"
]
},
"childrenProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct2"
},
"type": "array"
},
"category": {
"description": "Category.",
"example": "dangerous_substances",
"type": "string",
"enum": [
"dangerous_substances"
]
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Product2": {
"required": [
"eshops",
"productSku",
"internalSku",
"organisation",
"name",
"packagingType",
"workAroundSnIn",
"workAroundEanSticker",
"workAroundWarrantyInf",
"workAroundLot",
"active"
],
"properties": {
"eshops": {
"description": "Uuid of eshops.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"productSku": {
"description": "Poduct SKU.",
"example": "123",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"internalSku": {
"description": "Internal SKU.",
"example": "456",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"productGroup": {
"description": "Uuid of ProductGroup.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Product name.",
"example": "Mikrovlnná trouba 526",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"description": {
"description": "Product description.",
"example": "Volně stojící ikrovlnná trouba s příkonem 3kW",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"weight": {
"description": "Weight in grams.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 10000000,
"exclusiveMinimum": 0
},
"height": {
"description": "Weight in milimeters.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"width": {
"description": "Width in milimeters.",
"example": "400",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"length": {
"description": "Length in milimeters.",
"example": "1000",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"referenceNumbers": {
"description": "Array with reference numbers. When null/empty, productSku is used instead.",
"example": [
"123",
"456"
],
"items": {
"type": "string"
},
"type": "array"
},
"packagingType": {
"description": "Packaging type.",
"example": "A",
"type": "string"
},
"workAroundSnIn": {
"type": "boolean"
},
"workAroundEanSticker": {
"type": "boolean"
},
"workAroundWarrantyInf": {
"type": "boolean"
},
"workAroundLot": {
"type": "boolean"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"countryOfOrigin": {
"description": "Country of origin code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"hsCode": {
"description": "HS code.",
"example": "HS123456",
"type": "string"
},
"type": {
"description": "Product type.",
"example": "bundle",
"type": "string",
"enum": [
"virtual",
"physical",
"bundle"
]
},
"childrenProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct3"
},
"type": "array"
},
"category": {
"description": "Category.",
"example": "dangerous_substances",
"type": "string",
"enum": [
"dangerous_substances"
]
}
},
"type": "object"
},
"Product3": {
"required": [
"eshops",
"productSku",
"internalSku",
"organisation",
"name",
"packagingType",
"workAroundSnIn",
"workAroundEanSticker",
"workAroundWarrantyInf",
"workAroundLot",
"active"
],
"properties": {
"eshops": {
"description": "Uuid of eshops.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"productSku": {
"description": "Poduct SKU.",
"example": "123",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"internalSku": {
"description": "Internal SKU.",
"example": "456",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"productGroup": {
"description": "Uuid of ProductGroup.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Product name.",
"example": "Mikrovlnná trouba 526",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"description": {
"description": "Product description.",
"example": "Volně stojící ikrovlnná trouba s příkonem 3kW",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"weight": {
"description": "Weight in grams.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 10000000,
"exclusiveMinimum": 0
},
"height": {
"description": "Weight in milimeters.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"width": {
"description": "Width in milimeters.",
"example": "400",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"length": {
"description": "Length in milimeters.",
"example": "1000",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"referenceNumbers": {
"description": "Array with reference numbers. When null/empty, productSku is used instead.",
"example": [
"123",
"456"
],
"items": {
"type": "string"
},
"type": "array"
},
"packagingType": {
"description": "Packaging type.",
"example": "A",
"type": "string"
},
"workAroundSnIn": {
"type": "boolean"
},
"workAroundEanSticker": {
"type": "boolean"
},
"workAroundWarrantyInf": {
"type": "boolean"
},
"workAroundLot": {
"type": "boolean"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"countryOfOrigin": {
"description": "Country of origin code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"hsCode": {
"description": "HS code.",
"example": "HS123456",
"type": "string"
},
"type": {
"description": "Product type.",
"example": "bundle",
"type": "string",
"enum": [
"virtual",
"physical",
"bundle"
]
},
"childrenProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct4"
},
"type": "array"
},
"category": {
"description": "Category.",
"example": "dangerous_substances",
"type": "string",
"enum": [
"dangerous_substances"
]
}
},
"type": "object"
},
"ProductList": {
"properties": {
"products": {
"description": "Array with product UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"ProductExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"weight": {
"$ref": "#/components/schemas/IntegerCondition"
},
"height": {
"$ref": "#/components/schemas/IntegerCondition"
},
"width": {
"$ref": "#/components/schemas/IntegerCondition"
},
"length": {
"$ref": "#/components/schemas/IntegerCondition"
},
"referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"packagingType": {
"$ref": "#/components/schemas/StringCondition"
},
"workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshops.name": {
"$ref": "#/components/schemas/StringCondition"
},
"productGroup.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"productSku\"` `\"internalSku\"` `\"productGroup\"` `\"name\"` `\"description\"` `\"weight\"` `\"height\"` `\"width\"` `\"length\"` `\"referenceNumbers\"` `\"packagingType\"` `\"workAroundSnIn\"` `\"workAroundEanSticker\"` `\"workAroundWarrantyInf\"` `\"workAroundLot\"` `\"createdAt\"` `\"countryOfOrigin\"` `\"hsCode\"` `\"type\"` `\"childrenProducts\"` `\"changedAt\"` `\"productGroup.name\"` `\"productGroup.changedAt\"` `\"countryOfOrigin.code\"` `\"countryOfOrigin.name\"` `\"countryOfOrigin.currencyCode\"` `\"countryOfOrigin.currencyName\"` `\"countryOfOrigin.customsDeclaration\"` `\"countryOfOrigin.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"ProductGroupListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"organisation\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"organisation",
"createdAt",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results29": {
"properties": {
"results": {
"$ref": "#/components/schemas/ProductGroup4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ProductGroup": {
"required": [
"name",
"organisation"
],
"properties": {
"name": {
"description": "Product group name.",
"example": "Books",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"ProductGroup2": {
"required": [
"name",
"organisation"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Product group name.",
"example": "Books",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ProductGroup3": {
"required": [
"name",
"organisation"
],
"properties": {
"name": {
"description": "Product group name.",
"example": "Books",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"ProductImage": {
"required": [
"imageFile"
],
"properties": {
"imageFile": {
"$ref": "#/components/schemas/File"
},
"originalName": {
"type": "string"
},
"description": {
"type": "string"
}
},
"type": "object"
},
"ProductImage2": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"originalName": {
"type": "string"
},
"description": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"size": {
"type": "integer"
},
"dimensions": {
"items": {
"type": "string"
},
"type": "array"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"uploadedAt": {
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"url": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
},
"urlSmall": {
"example": "https://app.mailship.eu/static/media/logo_black.png/googlelogo/1x/googlelogo_color_272x92dp.png",
"type": "string",
"format": "uri"
},
"urlMedium": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
},
"urlLarge": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"ProductStockListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.type": {
"$ref": "#/components/schemas/StringCondition"
},
"product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"booked": {
"$ref": "#/components/schemas/IntegerCondition"
},
"bookedAtExpeditions": {
"$ref": "#/components/schemas/IntegerCondition"
},
"bookedAtTransfers": {
"$ref": "#/components/schemas/IntegerCondition"
},
"available": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missing": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missingAtExpeditions": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missingAtTransfers": {
"$ref": "#/components/schemas/IntegerCondition"
},
"required": {
"$ref": "#/components/schemas/IntegerCondition"
},
"incoming": {
"$ref": "#/components/schemas/IntegerCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product\"` `\"warehouse\"` `\"wms\"` `\"quantity\"` `\"booked\"` `\"bookedAtExpeditions\"` `\"virtualBookedAtExpeditions\"` `\"bookedAtTransfers\"` `\"bookedAtStockChanges\"` `\"available\"` `\"missing\"` `\"missingAtExpeditions\"` `\"missingAtTransfers\"` `\"missingAtStockChanges\"` `\"bookedAtInternalStockChanges\"` `\"missingAtInternalStockChanges\"` `\"required\"` `\"incoming\"` `\"createdAt\"` `\"changedAt\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "product.name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"product\"` `\"warehouse\"` `\"wms\"` `\"quantity\"` `\"booked\"` `\"bookedAtExpeditions\"` `\"virtualBookedAtExpeditions\"` `\"bookedAtTransfers\"` `\"bookedAtStockChanges\"` `\"available\"` `\"missing\"` `\"missingAtExpeditions\"` `\"missingAtTransfers\"` `\"missingAtStockChanges\"` `\"bookedAtInternalStockChanges\"` `\"missingAtInternalStockChanges\"` `\"required\"` `\"incoming\"` `\"createdAt\"` `\"lots\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"product",
"warehouse",
"wms",
"quantity",
"booked",
"bookedAtExpeditions",
"virtualBookedAtExpeditions",
"bookedAtTransfers",
"bookedAtStockChanges",
"available",
"missing",
"missingAtExpeditions",
"missingAtTransfers",
"missingAtStockChanges",
"bookedAtInternalStockChanges",
"missingAtInternalStockChanges",
"required",
"incoming",
"createdAt",
"lots",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results30": {
"properties": {
"results": {
"$ref": "#/components/schemas/ProductStock3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ProductStock2": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "5",
"type": "integer"
},
"booked": {
"example": "2",
"type": "integer"
},
"bookedAtExpeditions": {
"example": "2",
"type": "integer"
},
"virtualBookedAtExpeditions": {
"example": "2",
"type": "integer"
},
"bookedAtTransfers": {
"example": "2",
"type": "integer"
},
"bookedAtStockChanges": {
"example": "2",
"type": "integer"
},
"available": {
"example": "3",
"type": "integer"
},
"missing": {
"description": "Total number of missing products on items.",
"example": "9",
"type": "integer"
},
"missingAtExpeditions": {
"description": "Total number of missing products on ExpeditionItem (expeditionItem.quantity - expeditionItem.booked).",
"example": "9",
"type": "integer"
},
"missingAtTransfers": {
"description": "Total number of missing products on TransferItem (transferItem.quantity - transferItem.booked).",
"example": "9",
"type": "integer"
},
"missingAtStockChanges": {
"description": "Total number of missing products on StockChangeItem (quantity - booked).",
"example": "9",
"type": "integer"
},
"bookedAtInternalStockChanges": {
"example": 9,
"type": "integer"
},
"missingAtInternalStockChanges": {
"description": "Total number of missing products on InternalStockChangeItem (quantity - booked).",
"example": 9,
"type": "integer"
},
"required": {
"description": "Number of products that are required to stock, in order to satisfy all expeditions and transfers (productStock.missing - productStock.available, only if the value is positive).",
"example": "6",
"type": "integer"
},
"incoming": {
"example": "10",
"type": "integer"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"lots": {
"items": {
"$ref": "#/components/schemas/ProductStockLot"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ProductStockExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.type": {
"$ref": "#/components/schemas/StringCondition"
},
"product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"booked": {
"$ref": "#/components/schemas/IntegerCondition"
},
"bookedAtExpeditions": {
"$ref": "#/components/schemas/IntegerCondition"
},
"bookedAtTransfers": {
"$ref": "#/components/schemas/IntegerCondition"
},
"available": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missing": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missingAtExpeditions": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missingAtTransfers": {
"$ref": "#/components/schemas/IntegerCondition"
},
"required": {
"$ref": "#/components/schemas/IntegerCondition"
},
"incoming": {
"$ref": "#/components/schemas/IntegerCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product\"` `\"warehouse\"` `\"wms\"` `\"quantity\"` `\"booked\"` `\"bookedAtExpeditions\"` `\"virtualBookedAtExpeditions\"` `\"bookedAtTransfers\"` `\"bookedAtStockChanges\"` `\"available\"` `\"missing\"` `\"missingAtExpeditions\"` `\"missingAtTransfers\"` `\"missingAtStockChanges\"` `\"bookedAtInternalStockChanges\"` `\"missingAtInternalStockChanges\"` `\"required\"` `\"incoming\"` `\"createdAt\"` `\"changedAt\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "product.name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"StockMovementReportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"count": {
"$ref": "#/components/schemas/IntegerCondition"
},
"movedAt": {
"$ref": "#/components/schemas/DateCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product.name\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product\"` `\"organisation\"` `\"movementType\"` `\"quantity\"` `\"count\"` `\"warehouse\"` `\"wms\"` `\"ean\"` `\"serialNumber\"` `\"lot\"` `\"warranty\"` `\"movedMonth\"` `\"movedWeek\"` `\"movedDate\"` `\"movedDateHour\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": []
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"product\"` `\"organisation\"` `\"movementType\"` `\"quantity\"` `\"count\"` `\"warehouse\"` `\"wms\"` `\"ean\"` `\"serialNumber\"` `\"lot\"` `\"warranty\"` `\"movedMonth\"` `\"movedWeek\"` `\"movedDate\"` `\"movedDateHour\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"product",
"organisation",
"movementType",
"quantity",
"count",
"warehouse",
"wms",
"ean",
"serialNumber",
"lot",
"warranty",
"movedMonth",
"movedWeek",
"movedDate",
"movedDateHour"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results31": {
"properties": {
"results": {
"$ref": "#/components/schemas/StockMovementReport"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ExpeditionReportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"count": {
"$ref": "#/components/schemas/IntegerCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"delivered": {
"$ref": "#/components/schemas/BooleanCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateCondition"
},
"packedAt": {
"$ref": "#/components/schemas/DateCondition"
},
"sentAt": {
"$ref": "#/components/schemas/DateCondition"
},
"deliveredAt": {
"$ref": "#/components/schemas/DateCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product.name\"` `\"product.productSku\"` `\"product.internalSku\"` `\"organisation\"` `\"status\"` `\"delivered\"` `\"count\"` `\"warehouse\"` `\"eshop\"` `\"wms\"` `\"createdMonth\"` `\"createdWeek\"` `\"createdDate\"` `\"createdDateHour\"` `\"packedMonth\"` `\"packedWeek\"` `\"packedDate\"` `\"packedDateHour\"` `\"sentMonth\"` `\"sentWeek\"` `\"sentDate\"` `\"sentDateHour\"` `\"deliveredMonth\"` `\"deliveredWeek\"` `\"deliveredDate\"` `\"deliveredDateHour\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": []
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"organisation\"` `\"status\"` `\"delivered\"` `\"count\"` `\"warehouse\"` `\"eshop\"` `\"wms\"` `\"createdMonth\"` `\"createdWeek\"` `\"createdDate\"` `\"createdDateHour\"` `\"packedMonth\"` `\"packedWeek\"` `\"packedDate\"` `\"packedDateHour\"` `\"sentMonth\"` `\"sentWeek\"` `\"sentDate\"` `\"sentDateHour\"` `\"deliveredMonth\"` `\"deliveredWeek\"` `\"deliveredDate\"` `\"deliveredDateHour\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"organisation",
"status",
"delivered",
"count",
"warehouse",
"eshop",
"wms",
"createdMonth",
"createdWeek",
"createdDate",
"createdDateHour",
"packedMonth",
"packedWeek",
"packedDate",
"packedDateHour",
"sentMonth",
"sentWeek",
"sentDate",
"sentDateHour",
"deliveredMonth",
"deliveredWeek",
"deliveredDate",
"deliveredDateHour"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results32": {
"properties": {
"results": {
"$ref": "#/components/schemas/ExpeditionReport"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ComplaintReportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"status": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"status\"` `\"count\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": []
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"status\"` `\"count\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"status",
"count"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results33": {
"properties": {
"results": {
"$ref": "#/components/schemas/ComplaintReport"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"AdminResetPasswordRequest": {
"required": [
"email"
],
"properties": {
"email": {
"description": "Email address.",
"example": "john.doe@example.com",
"type": "string",
"format": "email"
}
},
"type": "object"
},
"UserResetPasswordRequest": {
"required": [
"email",
"phone"
],
"properties": {
"email": {
"description": "Email address.",
"example": "john.doe@example.com",
"type": "string",
"format": "email"
},
"phone": {
"description": "Phone number.",
"example": "+420 737123456",
"type": "string",
"format": "phone"
}
},
"type": "object"
},
"ReservationListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"booked": {
"$ref": "#/components/schemas/IntegerCondition"
},
"missing": {
"$ref": "#/components/schemas/IntegerCondition"
},
"lot": {
"$ref": "#/components/schemas/StringCondition"
},
"assignedLot": {
"$ref": "#/components/schemas/StringCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.weight": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.height": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.width": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.length": {
"$ref": "#/components/schemas/IntegerCondition"
},
"product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.packagingType": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition.wms.name\"` `\"expedition.warehouse.name\"` `\"expedition.eshop.name\"` `\"product\"` `\"expedition\"` `\"id\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "expedition.createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"product\"` `\"expedition\"` `\"bookStockAdvices\"` `\"id\"` `\"quantity\"` `\"booked\"` `\"missing\"` `\"lot\"` `\"assignedLot\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"product",
"expedition",
"bookStockAdvices",
"id",
"quantity",
"booked",
"missing",
"lot",
"assignedLot"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results34": {
"properties": {
"results": {
"$ref": "#/components/schemas/ExpeditionItem9"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ReservationNotificationCountSearch": {
"properties": {
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
}
},
"type": "object"
},
"ExpeditionItem2": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
}
},
"type": "object"
},
"ExpeditionItemList": {
"properties": {
"expeditionItems": {
"description": "Array with expedition item UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 250,
"minItems": 1
}
},
"type": "object"
},
"ResetPassword": {
"required": [
"token",
"newPassword"
],
"properties": {
"token": {
"description": "Token. Usually received by email",
"example": "dG9rZW4K",
"type": "string"
},
"newPassword": {
"description": "New password.",
"example": "A1B2C3D4",
"type": "string"
}
},
"type": "object"
},
"ReturnReceiptListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"complete": {
"$ref": "#/components/schemas/BooleanCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.lot": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movements.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"movements.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"note\"` `\"returnedParcelNumber\"` `\"complete\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"expedition\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"note\"` `\"returnedParcelNumber\"` `\"complete\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"expedition",
"wms",
"organisation",
"warehouse",
"wmsInternalId",
"receivedAt",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status",
"type",
"note",
"returnedParcelNumber",
"complete"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results35": {
"properties": {
"results": {
"$ref": "#/components/schemas/InboundReceipt4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"ReturnReceiptExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"complete": {
"$ref": "#/components/schemas/BooleanCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.note": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierNote": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.trackingUrl": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.externalTrackingNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.packagesCount": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.currency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.fragile": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.cod": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.codValue": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.codCurrency": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.codVariableSymbol": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.customerGroup": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.expeditionDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.eshopOrderDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingRegistrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.billingVatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.differentDeliveryAddress": {
"$ref": "#/components/schemas/BooleanCondition"
},
"expedition.deliveryFirstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryLastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryDegree": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCompany": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryStreet": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryHouseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryZip": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCity": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryCountry.code": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryEmail": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.deliveryPhone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrier.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierService": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierService.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierService.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.carrierPickupPlace.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.carrierPickupPlace.code": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.carrierPickupPlace.address": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.eshop.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.eshop.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.lot": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movements.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"movements.product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"movements.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"expedition\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"note\"` `\"returnedParcelNumber\"` `\"complete\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"InboundReceipt2": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition to belongs this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movements": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"processed",
"failed"
]
},
"type": {
"example": "new",
"type": "string",
"enum": [
"inventory",
"returned",
"returned_open",
"returned_damaged"
]
},
"note": {
"example": "Note about the return receipt.",
"type": "string",
"maxLength": 500
},
"returnedParcelNumber": {
"description": "Identifier about the returned parcel number.",
"type": "string",
"maxLength": 256
},
"complete": {
"description": "true - complete return, false - partial return",
"example": "true",
"type": "boolean"
}
},
"type": "object"
},
"StockAdviceListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expectedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfSuppliedQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"manualInput": {
"$ref": "#/components/schemas/BooleanCondition"
},
"internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"note": {
"$ref": "#/components/schemas/StringCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"supplier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier.companyName": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier.email": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"items.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"items.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"user\"` `\"organisation\"` `\"warehouse\"` `\"wms\"` `\"supplier\"` `\"packagingUnit\"` `\"countOfUnits\"` `\"status\"` `\"manualInput\"` `\"note\"` `\"internalId\"` `\"wmsInternalId\"` `\"mailwiseInternalId\"` `\"expectedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"sumOfSuppliedQuantity\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"changedAt\"` `\"user.dateOfBirth\"` `\"user.firstName\"` `\"user.lastName\"` `\"user.email\"` `\"user.phone\"` `\"user.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"supplier.name\"` `\"supplier.companyName\"` `\"supplier.firstName\"` `\"supplier.lastName\"` `\"supplier.email\"` `\"supplier.registrationNumber\"` `\"supplier.vatNumber\"` `\"supplier.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"user\"` `\"organisation\"` `\"warehouse\"` `\"wms\"` `\"supplier\"` `\"packagingUnit\"` `\"countOfUnits\"` `\"status\"` `\"manualInput\"` `\"note\"` `\"internalId\"` `\"wmsInternalId\"` `\"mailwiseInternalId\"` `\"expectedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"sumOfSuppliedQuantity\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"user",
"organisation",
"warehouse",
"wms",
"supplier",
"packagingUnit",
"countOfUnits",
"status",
"manualInput",
"note",
"internalId",
"wmsInternalId",
"mailwiseInternalId",
"expectedAt",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"sumOfSuppliedQuantity",
"ref1",
"ref2",
"ref3",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results36": {
"properties": {
"results": {
"$ref": "#/components/schemas/StockAdvice6"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"StockAdviceExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expectedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfSuppliedQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"manualInput": {
"$ref": "#/components/schemas/BooleanCondition"
},
"internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"note": {
"$ref": "#/components/schemas/StringCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"supplier.name": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier.companyName": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"supplier.email": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.id": {
"$ref": "#/components/schemas/UuidCondition"
},
"items.product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"items.product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"items.product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"user\"` `\"organisation\"` `\"warehouse\"` `\"wms\"` `\"supplier\"` `\"packagingUnit\"` `\"countOfUnits\"` `\"status\"` `\"manualInput\"` `\"note\"` `\"internalId\"` `\"wmsInternalId\"` `\"mailwiseInternalId\"` `\"expectedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"sumOfSuppliedQuantity\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"changedAt\"` `\"user.dateOfBirth\"` `\"user.firstName\"` `\"user.lastName\"` `\"user.email\"` `\"user.phone\"` `\"user.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"supplier.name\"` `\"supplier.companyName\"` `\"supplier.firstName\"` `\"supplier.lastName\"` `\"supplier.email\"` `\"supplier.registrationNumber\"` `\"supplier.vatNumber\"` `\"supplier.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"StockAdvice2": {
"required": [
"organisation",
"warehouse",
"wms",
"supplier",
"status",
"internalId",
"expectedAt"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"supplier": {
"description": "Uuid of Supplier that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"packagingUnit": {
"description": "Packaging unit.",
"example": "pallet",
"type": "string",
"enum": [
"pallet",
"package"
]
},
"countOfUnits": {
"description": "Count of units.",
"example": "5",
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"description": "Status.",
"example": "new",
"type": "string",
"enum": [
"on_hold",
"new",
"waiting",
"in_progress",
"finished",
"partially_finished",
"canceled",
"incorrect",
"closed"
]
},
"manualInput": {
"description": "true - manual input, false - import",
"example": "true",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/StockAdviceItem5"
},
"type": "array",
"minItems": 1
},
"note": {
"description": "Note.",
"example": "Note about the stock advice.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal ID.",
"example": "Internal number.",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"mailwiseInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"expectedAt": {
"description": "Expected date and time of arrival",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"sumOfSuppliedQuantity": {
"example": "5",
"type": "integer"
},
"errors": {
"description": "Validation errors contains this list with details.",
"items": {
"properties": {
"message": {
"description": "Error title (e.g. *This value is not valid*).",
"example": "This value should not be blank.",
"type": "string"
},
"propertyPath": {
"description": "Path of field (e.g. *items[0].productCode*).",
"example": "firstName",
"type": "string"
},
"code": {
"description": "Error code.",
"example": "3b70573f-c259-4df7-89fd-ad0104c1b828",
"type": "string"
},
"parameters": {
"description": "Internal data regarding to current violation.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"StockAdvice3": {
"required": [
"organisation",
"warehouse",
"wms",
"supplier",
"internalId",
"expectedAt"
],
"properties": {
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"supplier": {
"description": "Uuid of Supplier that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"packagingUnit": {
"description": "Packaging unit.",
"example": "pallet",
"type": "string",
"enum": [
"pallet",
"package"
]
},
"countOfUnits": {
"description": "Count of units.",
"example": "5",
"type": "integer",
"exclusiveMinimum": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/StockAdviceItem6"
},
"type": "array",
"minItems": 1
},
"note": {
"description": "Note.",
"example": "Note about the stock advice.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal ID.",
"example": "Internal number.",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"expectedAt": {
"description": "Expected date and time of arrival",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"StockAdvice4": {
"required": [
"organisation",
"warehouse",
"wms",
"supplier",
"status",
"internalId",
"expectedAt"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"supplier": {
"description": "Uuid of Supplier that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"packagingUnit": {
"description": "Packaging unit.",
"example": "pallet",
"type": "string",
"enum": [
"pallet",
"package"
]
},
"countOfUnits": {
"description": "Count of units.",
"example": "5",
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"description": "Status.",
"example": "new",
"type": "string",
"enum": [
"on_hold",
"new",
"waiting",
"in_progress",
"finished",
"partially_finished",
"canceled",
"incorrect",
"closed"
]
},
"manualInput": {
"description": "true - manual input, false - import",
"example": "true",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/StockAdviceItem2"
},
"type": "array",
"minItems": 1
},
"note": {
"description": "Note.",
"example": "Note about the stock advice.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal ID.",
"example": "Internal number.",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"mailwiseInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"expectedAt": {
"description": "Expected date and time of arrival",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"sumOfSuppliedQuantity": {
"example": "5",
"type": "integer"
},
"errors": {
"description": "Validation errors contains this list with details.",
"items": {
"properties": {
"message": {
"description": "Error title (e.g. *This value is not valid*).",
"example": "This value should not be blank.",
"type": "string"
},
"propertyPath": {
"description": "Path of field (e.g. *items[0].productCode*).",
"example": "firstName",
"type": "string"
},
"code": {
"description": "Error code.",
"example": "3b70573f-c259-4df7-89fd-ad0104c1b828",
"type": "string"
},
"parameters": {
"description": "Internal data regarding to current violation.",
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"StockAdvice5": {
"required": [
"organisation",
"warehouse",
"wms",
"supplier",
"internalId",
"expectedAt"
],
"properties": {
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"supplier": {
"description": "Uuid of Supplier that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"packagingUnit": {
"description": "Packaging unit.",
"example": "pallet",
"type": "string",
"enum": [
"pallet",
"package"
]
},
"countOfUnits": {
"description": "Count of units.",
"example": "5",
"type": "integer",
"exclusiveMinimum": 0
},
"note": {
"description": "Note.",
"example": "Note about the stock advice.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal ID.",
"example": "Internal number.",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"expectedAt": {
"description": "Expected date and time of arrival",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"StockAdviceList": {
"properties": {
"stockAdvices": {
"description": "Array with stockAdvice UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 1000,
"minItems": 1
}
},
"type": "object"
},
"StockAdviceBookExpeditionUpdate": {
"required": [
"stockAdviceItem",
"items"
],
"properties": {
"stockAdviceItem": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"items": {
"description": "Set of expedition and quantity pair.",
"items": {
"$ref": "#/components/schemas/StockAdviceBookExpeditionItem"
},
"type": "array"
}
},
"type": "object"
},
"StockAdviceItemListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.sumOfSuppliedQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"stockAdvice.status": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"stockAdvice.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"stockAdvice.supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.referenceNumbers": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"suppliedQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"stockAdvice\"` `\"blocked\"` `\"position\"` `\"product\"` `\"quantity\"` `\"suppliedQuantity\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"stockAdvice.packagingUnit\"` `\"stockAdvice.countOfUnits\"` `\"stockAdvice.status\"` `\"stockAdvice.note\"` `\"stockAdvice.internalId\"` `\"stockAdvice.wmsInternalId\"` `\"stockAdvice.mailwiseInternalId\"` `\"stockAdvice.expectedAt\"` `\"stockAdvice.createdAt\"` `\"stockAdvice.countOfItems\"` `\"stockAdvice.countOfSku\"` `\"stockAdvice.sumOfQuantity\"` `\"stockAdvice.sumOfSuppliedQuantity\"` `\"stockAdvice.ref1\"` `\"stockAdvice.ref2\"` `\"stockAdvice.ref3\"` `\"stockAdvice.changedAt\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "position"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"stockAdvice\"` `\"bookStockAdvices\"` `\"blocked\"` `\"position\"` `\"product\"` `\"quantity\"` `\"suppliedQuantity\"` `\"ref1\"` `\"ref2\"` `\"ref3\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"stockAdvice",
"bookStockAdvices",
"blocked",
"position",
"product",
"quantity",
"suppliedQuantity",
"ref1",
"ref2",
"ref3"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results37": {
"properties": {
"results": {
"$ref": "#/components/schemas/StockAdviceItem7"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"StockAdviceItem": {
"required": [
"stockAdvice",
"product",
"quantity"
],
"properties": {
"stockAdvice": {
"description": "Uuid of Stock Advice that has the item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"StockAdviceItem2": {
"required": [
"stockAdvice",
"product",
"quantity"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockAdvice": {
"description": "Uuid of Stock Advice that has the item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice"
},
"type": "array"
},
"blocked": {
"example": "4",
"type": "integer",
"minimum": 0
},
"position": {
"example": "2",
"type": "integer"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"suppliedQuantity": {
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"StockAdviceItem3": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"StockChangeListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"type": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouse.customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"` `\"wms.name\"` `\"wms.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"wms\"` `\"organisation\"` `\"warehouse\"` `\"wmsInternalId\"` `\"receivedAt\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"status\"` `\"type\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"wms",
"organisation",
"warehouse",
"wmsInternalId",
"receivedAt",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status",
"type"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results38": {
"properties": {
"results": {
"$ref": "#/components/schemas/StockChange2"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"StockChange": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"items": {
"items": {
"$ref": "#/components/schemas/StockChangeItem"
},
"type": "array",
"minItems": 1
},
"movements": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"waiting_for_goods",
"ready",
"processed",
"failed",
"canceled"
]
},
"type": {
"example": "new",
"type": "string",
"enum": [
"in",
"out"
]
}
},
"type": "object"
},
"StockChangeList": {
"properties": {
"stockChanges": {
"description": "Array with stockChange UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 250,
"minItems": 1
}
},
"type": "object"
},
"StockMovementListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movementType": {
"$ref": "#/components/schemas/StringCondition"
},
"movementSubType": {
"$ref": "#/components/schemas/StringCondition"
},
"ean": {
"$ref": "#/components/schemas/StringCondition"
},
"serialNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"lot": {
"$ref": "#/components/schemas/StringCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warranty": {
"$ref": "#/components/schemas/DateCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"movedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt": {
"$ref": "#/components/schemas/UuidCondition"
},
"inboundReceipt.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.status": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.type": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice": {
"$ref": "#/components/schemas/UuidCondition"
},
"inboundReceipt.stockAdvice.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.stockAdvice.expectedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.stockAdvice.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.stockAdvice.countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.sumOfSuppliedQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.status": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.manualInput": {
"$ref": "#/components/schemas/BooleanCondition"
},
"inboundReceipt.stockAdvice.internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.note": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"inboundReceipt.stockAdvice.supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product\"` `\"movementType\"` `\"movementSubType\"` `\"organisation\"` `\"warehouse\"` `\"wms\"` `\"inboundReceipt\"` `\"outboundReceipt\"` `\"expedition\"` `\"expeditionItem\"` `\"stockChange\"` `\"stockChangeItem\"` `\"internalStockChange\"` `\"internalStockChangeItem\"` `\"transfer\"` `\"transferItem\"` `\"ean\"` `\"serialNumber\"` `\"quantity\"` `\"lot\"` `\"lotDate\"` `\"warranty\"` `\"createdAt\"` `\"movedAt\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"` `\"expeditionItem.position\"` `\"expeditionItem.expedited\"` `\"expeditionItem.quantity\"` `\"expeditionItem.booked\"` `\"expeditionItem.missing\"` `\"expeditionItem.lot\"` `\"expeditionItem.assignedLot\"` `\"expeditionItem.lifo\"` `\"expeditionItem.ref1\"` `\"expeditionItem.ref2\"` `\"expeditionItem.ref3\"` `\"stockChange.wmsInternalId\"` `\"stockChange.receivedAt\"` `\"stockChange.createdAt\"` `\"stockChange.countOfItems\"` `\"stockChange.countOfSku\"` `\"stockChange.sumOfQuantity\"` `\"stockChange.status\"` `\"stockChange.type\"` `\"stockChangeItem.position\"` `\"stockChangeItem.expedited\"` `\"stockChangeItem.quantity\"` `\"stockChangeItem.booked\"` `\"stockChangeItem.missing\"` `\"stockChangeItem.lot\"` `\"stockChangeItem.assignedLot\"` `\"stockChangeItem.lifo\"` `\"stockChangeItem.ref1\"` `\"stockChangeItem.ref2\"` `\"stockChangeItem.ref3\"` `\"internalStockChange.receivedAt\"` `\"internalStockChange.createdAt\"` `\"internalStockChange.countOfItems\"` `\"internalStockChange.countOfSku\"` `\"internalStockChange.sumOfQuantity\"` `\"internalStockChange.status\"` `\"internalStockChange.type\"` `\"internalStockChangeItem.position\"` `\"internalStockChangeItem.quantity\"` `\"internalStockChangeItem.booked\"` `\"internalStockChangeItem.missing\"` `\"internalStockChangeItem.lot\"` `\"internalStockChangeItem.assignedLot\"` `\"internalStockChangeItem.lifo\"` `\"internalStockChangeItem.ref1\"` `\"internalStockChangeItem.ref2\"` `\"internalStockChangeItem.ref3\"` `\"transfer.internalNumber\"` `\"transfer.requiredTransferDate\"` `\"transfer.type\"` `\"transfer.status\"` `\"transfer.createdAt\"` `\"transfer.countOfItems\"` `\"transfer.countOfSku\"` `\"transfer.sumOfQuantity\"` `\"transfer.changedAt\"` `\"transferItem.position\"` `\"transferItem.quantity\"` `\"transferItem.booked\"` `\"transferItem.missing\"` `\"transferItem.lot\"` `\"transferItem.assignedLot\"` `\"transferItem.lifo\"` `\"transferItem.ref1\"` `\"transferItem.ref2\"` `\"transferItem.ref3\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"product\"` `\"movementType\"` `\"movementSubType\"` `\"organisation\"` `\"warehouse\"` `\"wms\"` `\"inboundReceipt\"` `\"outboundReceipt\"` `\"expedition\"` `\"expeditionItem\"` `\"stockChange\"` `\"stockChangeItem\"` `\"internalStockChange\"` `\"internalStockChangeItem\"` `\"transfer\"` `\"transferItem\"` `\"ean\"` `\"serialNumber\"` `\"quantity\"` `\"lot\"` `\"lotDate\"` `\"warranty\"` `\"createdAt\"` `\"movedAt\"` `\"reported\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"product",
"movementType",
"movementSubType",
"organisation",
"warehouse",
"wms",
"inboundReceipt",
"outboundReceipt",
"expedition",
"expeditionItem",
"stockChange",
"stockChangeItem",
"internalStockChange",
"internalStockChangeItem",
"transfer",
"transferItem",
"ean",
"serialNumber",
"quantity",
"lot",
"lotDate",
"warranty",
"createdAt",
"movedAt",
"reported"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results39": {
"properties": {
"results": {
"$ref": "#/components/schemas/StockMovement3"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"StockMovement2": {
"required": [
"product",
"movementType",
"organisation",
"warehouse",
"wms"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movementType": {
"example": "IN",
"type": "string",
"enum": [
"in",
"out",
"book",
"unbook"
]
},
"movementSubType": {
"example": "new",
"type": "string",
"enum": [
"inventory",
"virtual_transfer",
"new",
"returned",
"returned_open",
"returned_damaged",
"completion",
"other",
"production"
]
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"inboundReceipt": {
"description": "Uuid of Inbound Receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"outboundReceipt": {
"description": "Uuid of Outbound Receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expeditionItem": {
"description": "Uuid of Expedition Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockChange": {
"description": "Uuid of StockChange.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockChangeItem": {
"description": "Uuid of StockChange Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalStockChange": {
"description": "Uuid of StockChange.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalStockChangeItem": {
"description": "Uuid of StockChange Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"transfer": {
"description": "Uuid of Transfer.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"transferItem": {
"description": "Uuid of Transfer Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"ean": {
"example": "7501031311309",
"type": "string"
},
"serialNumber": {
"example": "XN23213232424",
"type": "string",
"maxLength": 255
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
},
"lot": {
"example": "BN20200626",
"type": "string",
"maxLength": 255
},
"warranty": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"movedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"reported": {
"type": "boolean"
}
},
"type": "object"
},
"StockMovementExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"movementType": {
"$ref": "#/components/schemas/StringCondition"
},
"movementSubType": {
"$ref": "#/components/schemas/StringCondition"
},
"ean": {
"$ref": "#/components/schemas/StringCondition"
},
"serialNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"lot": {
"$ref": "#/components/schemas/StringCondition"
},
"quantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"warranty": {
"$ref": "#/components/schemas/DateCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"movedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"product": {
"$ref": "#/components/schemas/UuidCondition"
},
"product.name": {
"$ref": "#/components/schemas/StringCondition"
},
"product.productSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.internalSku": {
"$ref": "#/components/schemas/StringCondition"
},
"product.workAroundSnIn": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundEanSticker": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundWarrantyInf": {
"$ref": "#/components/schemas/BooleanCondition"
},
"product.workAroundLot": {
"$ref": "#/components/schemas/BooleanCondition"
},
"warehouse": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouse.name": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt": {
"$ref": "#/components/schemas/UuidCondition"
},
"inboundReceipt.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.receivedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.status": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.type": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice": {
"$ref": "#/components/schemas/UuidCondition"
},
"inboundReceipt.stockAdvice.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.stockAdvice.expectedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.stockAdvice.changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"inboundReceipt.stockAdvice.countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.sumOfSuppliedQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.packagingUnit": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.countOfUnits": {
"$ref": "#/components/schemas/IntegerCondition"
},
"inboundReceipt.stockAdvice.status": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.manualInput": {
"$ref": "#/components/schemas/BooleanCondition"
},
"inboundReceipt.stockAdvice.internalId": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.wmsInternalId": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.note": {
"$ref": "#/components/schemas/StringCondition"
},
"inboundReceipt.stockAdvice.user": {
"$ref": "#/components/schemas/UuidCondition"
},
"inboundReceipt.stockAdvice.supplier": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wms": {
"$ref": "#/components/schemas/UuidCondition"
},
"wms.name": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition": {
"$ref": "#/components/schemas/UuidCondition"
},
"expedition.status": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.orderNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.requiredDeliveryDate": {
"$ref": "#/components/schemas/DateCondition"
},
"expedition.email": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.value": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"expedition.priority": {
"$ref": "#/components/schemas/IntegerCondition"
},
"expedition.ref1": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref2": {
"$ref": "#/components/schemas/StringCondition"
},
"expedition.ref3": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"product\"` `\"movementType\"` `\"movementSubType\"` `\"organisation\"` `\"warehouse\"` `\"wms\"` `\"inboundReceipt\"` `\"outboundReceipt\"` `\"expedition\"` `\"expeditionItem\"` `\"stockChange\"` `\"stockChangeItem\"` `\"internalStockChange\"` `\"internalStockChangeItem\"` `\"transfer\"` `\"transferItem\"` `\"ean\"` `\"serialNumber\"` `\"quantity\"` `\"lot\"` `\"lotDate\"` `\"warranty\"` `\"createdAt\"` `\"movedAt\"` `\"product.productSku\"` `\"product.internalSku\"` `\"product.name\"` `\"product.referenceNumbers\"` `\"product.hsCode\"` `\"product.type\"` `\"product.childrenProducts\"` `\"product.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouse.name\"` `\"warehouse.customId\"` `\"warehouse.changedAt\"` `\"wms.name\"` `\"wms.changedAt\"` `\"expedition.orderNumber\"` `\"expedition.billingFirstName\"` `\"expedition.billingLastName\"` `\"expedition.billingDegree\"` `\"expedition.billingCompany\"` `\"expedition.billingStreet\"` `\"expedition.billingHouseNr\"` `\"expedition.billingZip\"` `\"expedition.billingCity\"` `\"expedition.billingEmail\"` `\"expedition.billingPhone\"` `\"expedition.billingRegistrationNumber\"` `\"expedition.billingVatNumber\"` `\"expedition.differentDeliveryAddress\"` `\"expedition.deliveryFirstName\"` `\"expedition.deliveryLastName\"` `\"expedition.deliveryDegree\"` `\"expedition.deliveryCompany\"` `\"expedition.deliveryStreet\"` `\"expedition.deliveryHouseNr\"` `\"expedition.deliveryZip\"` `\"expedition.deliveryCity\"` `\"expedition.deliveryEmail\"` `\"expedition.deliveryPhone\"` `\"expedition.requiredExpeditionDate\"` `\"expedition.carrierNote\"` `\"expedition.trackingNumber\"` `\"expedition.trackingUrl\"` `\"expedition.externalTrackingNumber\"` `\"expedition.packagesCount\"` `\"expedition.status\"` `\"expedition.expeditedCompletely\"` `\"expedition.value\"` `\"expedition.currency\"` `\"expedition.fragile\"` `\"expedition.cod\"` `\"expedition.codValue\"` `\"expedition.codCurrency\"` `\"expedition.codVariableSymbol\"` `\"expedition.customerGroup\"` `\"expedition.eshopOrderDate\"` `\"expedition.createdAt\"` `\"expedition.countOfItems\"` `\"expedition.countOfSku\"` `\"expedition.sumOfQuantity\"` `\"expedition.packedAt\"` `\"expedition.sentAt\"` `\"expedition.deliveredAt\"` `\"expedition.waitBeforeProcessing\"` `\"expedition.editBeforeProcessing\"` `\"expedition.priority\"` `\"expedition.ref1\"` `\"expedition.ref2\"` `\"expedition.ref3\"` `\"expedition.foreignPrice\"` `\"expedition.conversionDate\"` `\"expedition.modifiedAt\"` `\"expedition.removedVirtualProducts\"` `\"expedition.ignoreAddressValidation\"` `\"expedition.addressValidationExecuted\"` `\"expedition.changedAt\"` `\"expeditionItem.position\"` `\"expeditionItem.expedited\"` `\"expeditionItem.quantity\"` `\"expeditionItem.booked\"` `\"expeditionItem.missing\"` `\"expeditionItem.lot\"` `\"expeditionItem.assignedLot\"` `\"expeditionItem.lifo\"` `\"expeditionItem.ref1\"` `\"expeditionItem.ref2\"` `\"expeditionItem.ref3\"` `\"stockChange.wmsInternalId\"` `\"stockChange.receivedAt\"` `\"stockChange.createdAt\"` `\"stockChange.countOfItems\"` `\"stockChange.countOfSku\"` `\"stockChange.sumOfQuantity\"` `\"stockChange.status\"` `\"stockChange.type\"` `\"stockChangeItem.position\"` `\"stockChangeItem.expedited\"` `\"stockChangeItem.quantity\"` `\"stockChangeItem.booked\"` `\"stockChangeItem.missing\"` `\"stockChangeItem.lot\"` `\"stockChangeItem.assignedLot\"` `\"stockChangeItem.lifo\"` `\"stockChangeItem.ref1\"` `\"stockChangeItem.ref2\"` `\"stockChangeItem.ref3\"` `\"internalStockChange.receivedAt\"` `\"internalStockChange.createdAt\"` `\"internalStockChange.countOfItems\"` `\"internalStockChange.countOfSku\"` `\"internalStockChange.sumOfQuantity\"` `\"internalStockChange.status\"` `\"internalStockChange.type\"` `\"internalStockChangeItem.position\"` `\"internalStockChangeItem.quantity\"` `\"internalStockChangeItem.booked\"` `\"internalStockChangeItem.missing\"` `\"internalStockChangeItem.lot\"` `\"internalStockChangeItem.assignedLot\"` `\"internalStockChangeItem.lifo\"` `\"internalStockChangeItem.ref1\"` `\"internalStockChangeItem.ref2\"` `\"internalStockChangeItem.ref3\"` `\"transfer.internalNumber\"` `\"transfer.requiredTransferDate\"` `\"transfer.type\"` `\"transfer.status\"` `\"transfer.createdAt\"` `\"transfer.countOfItems\"` `\"transfer.countOfSku\"` `\"transfer.sumOfQuantity\"` `\"transfer.changedAt\"` `\"transferItem.position\"` `\"transferItem.quantity\"` `\"transferItem.booked\"` `\"transferItem.missing\"` `\"transferItem.lot\"` `\"transferItem.assignedLot\"` `\"transferItem.lifo\"` `\"transferItem.ref1\"` `\"transferItem.ref2\"` `\"transferItem.ref3\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"SupplierListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"companyName": {
"$ref": "#/components/schemas/StringCondition"
},
"firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"street": {
"$ref": "#/components/schemas/StringCondition"
},
"houseNr": {
"$ref": "#/components/schemas/StringCondition"
},
"city": {
"$ref": "#/components/schemas/StringCondition"
},
"zip": {
"$ref": "#/components/schemas/StringCondition"
},
"country": {
"$ref": "#/components/schemas/StringCondition"
},
"phone": {
"$ref": "#/components/schemas/StringCondition"
},
"email": {
"$ref": "#/components/schemas/StringCondition"
},
"registrationNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"vatNumber": {
"$ref": "#/components/schemas/StringCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"organisation\"` `\"name\"` `\"companyName\"` `\"firstName\"` `\"lastName\"` `\"street\"` `\"houseNr\"` `\"city\"` `\"zip\"` `\"country\"` `\"phone\"` `\"email\"` `\"registrationNumber\"` `\"vatNumber\"` `\"createdAt\"` `\"changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"organisation\"` `\"name\"` `\"companyName\"` `\"firstName\"` `\"lastName\"` `\"degree\"` `\"degree2\"` `\"street\"` `\"houseNr\"` `\"city\"` `\"zip\"` `\"country\"` `\"phone\"` `\"email\"` `\"registrationNumber\"` `\"vatNumber\"` `\"note\"` `\"active\"` `\"createdAt\"` `\"ref1\"` `\"ref2\"` `\"ref3\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"organisation",
"name",
"companyName",
"firstName",
"lastName",
"degree",
"degree2",
"street",
"houseNr",
"city",
"zip",
"country",
"phone",
"email",
"registrationNumber",
"vatNumber",
"note",
"active",
"createdAt",
"ref1",
"ref2",
"ref3",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results40": {
"properties": {
"results": {
"$ref": "#/components/schemas/Supplier4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Supplier": {
"required": [
"organisation",
"name",
"companyName",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Supplier name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Supplier company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Degree.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 1
},
"phone": {
"description": "Phone number",
"example": "+420 123456789",
"type": "string",
"maxLength": 35,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note.",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Supplier2": {
"required": [
"organisation",
"name",
"companyName",
"active"
],
"properties": {
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Supplier name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Supplier company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Degree.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 1
},
"phone": {
"description": "Phone number",
"example": "+420 123456789",
"type": "string",
"maxLength": 35,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note.",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"Supplier3": {
"required": [
"organisation",
"name",
"companyName",
"active"
],
"properties": {
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Supplier name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Supplier company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Degree.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 1
},
"phone": {
"description": "Phone number",
"example": "+420 123456789",
"type": "string",
"maxLength": 35,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note.",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"SupplierList": {
"properties": {
"suppliers": {
"description": "Array with supplier UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"RefreshToken": {
"required": [
"refreshToken"
],
"properties": {
"refreshToken": {
"description": "Refresh token.",
"example": "9efd6555f7a8eb18e3bbc680fd25ffbfbfcbda45bceee9e3c0a2bd6ee055396a",
"type": "string"
}
},
"type": "object"
},
"Transfer": {
"required": [
"organisation",
"warehouseFrom",
"warehouseTo",
"wmsFrom",
"wmsTo",
"internalNumber",
"type",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this transfer.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseFrom": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseTo": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsFrom": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsTo": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalNumber": {
"description": "Internal number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"requiredTransferDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"type": {
"description": "Type.",
"example": "new",
"type": "string",
"enum": [
"virtual"
]
},
"status": {
"example": "new",
"type": "string",
"enum": [
"created",
"waiting_for_goods",
"finished",
"canceled"
]
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"items": {
"items": {
"$ref": "#/components/schemas/TransferItem"
},
"type": "array",
"minItems": 1
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"TransferListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouseFrom": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouseFrom.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouseTo": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouseTo.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wmsFrom": {
"$ref": "#/components/schemas/UuidCondition"
},
"wmsFrom.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"user\"` `\"organisation\"` `\"warehouseFrom\"` `\"warehouseTo\"` `\"wmsFrom\"` `\"wmsTo\"` `\"internalNumber\"` `\"requiredTransferDate\"` `\"type\"` `\"status\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"changedAt\"` `\"user.dateOfBirth\"` `\"user.firstName\"` `\"user.lastName\"` `\"user.email\"` `\"user.phone\"` `\"user.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouseFrom.name\"` `\"warehouseFrom.customId\"` `\"warehouseFrom.changedAt\"` `\"warehouseTo.name\"` `\"warehouseTo.customId\"` `\"warehouseTo.changedAt\"` `\"wmsFrom.name\"` `\"wmsFrom.changedAt\"` `\"wmsTo.name\"` `\"wmsTo.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"user\"` `\"organisation\"` `\"warehouseFrom\"` `\"warehouseTo\"` `\"wmsFrom\"` `\"wmsTo\"` `\"internalNumber\"` `\"note\"` `\"requiredTransferDate\"` `\"type\"` `\"status\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"user",
"organisation",
"warehouseFrom",
"warehouseTo",
"wmsFrom",
"wmsTo",
"internalNumber",
"note",
"requiredTransferDate",
"type",
"status",
"createdAt",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results41": {
"properties": {
"results": {
"$ref": "#/components/schemas/Transfer4"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"TransferList": {
"properties": {
"transfers": {
"description": "Array with transfer UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 1000,
"minItems": 1
}
},
"type": "object"
},
"Transfer2": {
"required": [
"organisation",
"warehouseFrom",
"warehouseTo",
"wmsFrom",
"wmsTo",
"internalNumber",
"type"
],
"properties": {
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseFrom": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseTo": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsFrom": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsTo": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalNumber": {
"description": "Internal number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"requiredTransferDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"type": {
"description": "Type.",
"example": "new",
"type": "string",
"enum": [
"virtual"
]
},
"items": {
"items": {
"$ref": "#/components/schemas/TransferItem2"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"Transfer3": {
"required": [
"organisation",
"warehouseFrom",
"warehouseTo",
"wmsFrom",
"wmsTo",
"internalNumber",
"type"
],
"properties": {
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseFrom": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseTo": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsFrom": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsTo": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalNumber": {
"description": "Internal number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"requiredTransferDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"type": {
"description": "Type.",
"example": "new",
"type": "string",
"enum": [
"virtual"
]
},
"items": {
"items": {
"$ref": "#/components/schemas/TransferItem3"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"TransferListExportSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"status": {
"$ref": "#/components/schemas/StringCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"changedAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"countOfItems": {
"$ref": "#/components/schemas/IntegerCondition"
},
"countOfSku": {
"$ref": "#/components/schemas/IntegerCondition"
},
"sumOfQuantity": {
"$ref": "#/components/schemas/IntegerCondition"
},
"user": {
"$ref": "#/components/schemas/UuidCondition"
},
"user.firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"user.email": {
"$ref": "#/components/schemas/StringCondition"
},
"user.phone": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouseFrom": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouseFrom.name": {
"$ref": "#/components/schemas/StringCondition"
},
"warehouseTo": {
"$ref": "#/components/schemas/UuidCondition"
},
"warehouseTo.name": {
"$ref": "#/components/schemas/StringCondition"
},
"wmsFrom": {
"$ref": "#/components/schemas/UuidCondition"
},
"wmsFrom.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"user\"` `\"organisation\"` `\"warehouseFrom\"` `\"warehouseTo\"` `\"wmsFrom\"` `\"wmsTo\"` `\"internalNumber\"` `\"requiredTransferDate\"` `\"type\"` `\"status\"` `\"createdAt\"` `\"countOfItems\"` `\"countOfSku\"` `\"sumOfQuantity\"` `\"changedAt\"` `\"user.dateOfBirth\"` `\"user.firstName\"` `\"user.lastName\"` `\"user.email\"` `\"user.phone\"` `\"user.changedAt\"` `\"organisation.name\"` `\"organisation.registrationNumber\"` `\"organisation.vatNumber\"` `\"organisation.code\"` `\"organisation.automaticExchangeEnabled\"` `\"organisation.ignoreAddressValidation\"` `\"organisation.changedAt\"` `\"warehouseFrom.name\"` `\"warehouseFrom.customId\"` `\"warehouseFrom.changedAt\"` `\"warehouseTo.name\"` `\"warehouseTo.customId\"` `\"warehouseTo.changedAt\"` `\"wmsFrom.name\"` `\"wmsFrom.changedAt\"` `\"wmsTo.name\"` `\"wmsTo.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "createdAt"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
}
},
"type": "object"
},
"UserListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"firstName": {
"$ref": "#/components/schemas/StringCondition"
},
"lastName": {
"$ref": "#/components/schemas/StringCondition"
},
"email": {
"$ref": "#/components/schemas/StringCondition"
},
"phone": {
"$ref": "#/components/schemas/StringCondition"
},
"active": {
"$ref": "#/components/schemas/BooleanCondition"
},
"organisations": {
"$ref": "#/components/schemas/UuidCondition"
},
"createdAt": {
"$ref": "#/components/schemas/DateTimeCondition"
},
"sex": {
"$ref": "#/components/schemas/StringCondition"
},
"dateOfBirth": {
"$ref": "#/components/schemas/DateCondition"
},
"fullName": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"dateOfBirth\"` `\"photoUploadedAt\"` `\"createdBy\"` `\"firstName\"` `\"lastName\"` `\"email\"` `\"createdAt\"` `\"phone\"` `\"changedAt\"` `\"createdBy.dateOfBirth\"` `\"createdBy.firstName\"` `\"createdBy.lastName\"` `\"createdBy.email\"` `\"createdBy.phone\"` `\"createdBy.changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "lastName"
},
{
"field": "firstName"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"dateOfBirth\"` `\"sex\"` `\"addressLine1\"` `\"addressLine2\"` `\"addressLine3\"` `\"photoUploadedAt\"` `\"organisations\"` `\"preferredLanguage\"` `\"createdBy\"` `\"ownedOrganisations\"` `\"id\"` `\"firstName\"` `\"lastName\"` `\"email\"` `\"createdAt\"` `\"active\"` `\"phone\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"dateOfBirth",
"sex",
"addressLine1",
"addressLine2",
"addressLine3",
"photoUploadedAt",
"organisations",
"preferredLanguage",
"createdBy",
"ownedOrganisations",
"id",
"firstName",
"lastName",
"email",
"createdAt",
"active",
"phone",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"User2": {
"required": [
"dateOfBirth",
"addressLine1",
"addressLine2",
"addressLine3",
"firstName",
"lastName",
"email",
"password",
"active",
"phone"
],
"properties": {
"dateOfBirth": {
"description": "Date of birth.",
"example": "1970-07-12",
"type": "string",
"format": "date",
"maximum": "-18 years"
},
"sex": {
"description": "sex",
"example": "male",
"type": "string",
"enum": [
"male",
"female",
null
]
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"photo": {
"description": "Photo.",
"example": "data:image/gif;base64,R0lGODdhAQABAIAAAP///////ywAAAAAAQABAAACAkQBADs=",
"type": "string"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"preferredLanguage": {
"description": "Preferred language.",
"example": "en",
"type": "string",
"enum": [
"cs",
"sk",
"en",
"ru",
"it",
"es"
]
},
"ownedOrganisations": {
"description": "Array with owned organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"password": {
"description": "Password.",
"example": "A1b2c3D4",
"type": "string"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
}
},
"type": "object"
},
"User3": {
"required": [
"dateOfBirth",
"addressLine1",
"addressLine2",
"addressLine3",
"firstName",
"lastName",
"email",
"password",
"active",
"phone"
],
"properties": {
"dateOfBirth": {
"description": "Date of birth.",
"example": "1970-07-12",
"type": "string",
"format": "date",
"maximum": "-18 years"
},
"sex": {
"description": "sex",
"example": "male",
"type": "string",
"enum": [
"male",
"female",
null
]
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"photo": {
"description": "Photo.",
"example": "data:image/gif;base64,R0lGODdhAQABAIAAAP///////ywAAAAAAQABAAACAkQBADs=",
"type": "string"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"preferredLanguage": {
"description": "Preferred language.",
"example": "en",
"type": "string",
"enum": [
"cs",
"sk",
"en",
"ru",
"it",
"es"
]
},
"ownedOrganisations": {
"description": "Array with owned organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"password": {
"description": "Password.",
"example": "A1b2c3D4",
"type": "string"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
}
},
"type": "object"
},
"User4": {
"required": [
"dateOfBirth",
"addressLine1",
"addressLine2",
"addressLine3",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"dateOfBirth": {
"description": "Date of birth.",
"example": "1970-07-12",
"type": "string",
"format": "date",
"maximum": "-18 years"
},
"sex": {
"description": "sex",
"example": "male",
"type": "string",
"enum": [
"male",
"female",
null
]
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"photo": {
"description": "Photo.",
"example": "data:image/gif;base64,R0lGODdhAQABAIAAAP///////ywAAAAAAQABAAACAkQBADs=",
"type": "string"
},
"preferredLanguage": {
"description": "Preferred language.",
"example": "en",
"type": "string",
"enum": [
"cs",
"sk",
"en",
"ru",
"it",
"es"
]
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
}
},
"type": "object"
},
"WarehouseListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"organisation.name": {
"$ref": "#/components/schemas/StringCondition"
},
"eshops": {
"$ref": "#/components/schemas/UuidCondition"
},
"eshops.name": {
"$ref": "#/components/schemas/StringCondition"
},
"customId": {
"$ref": "#/components/schemas/StringCondition"
},
"wmses": {
"$ref": "#/components/schemas/UuidCondition"
},
"wmses.name": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"customId\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"customId\"` `\"wmses\"` `\"defaultWms\"` `\"createdAt\"` `\"organisation\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"customId",
"wmses",
"defaultWms",
"createdAt",
"organisation",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results42": {
"properties": {
"results": {
"$ref": "#/components/schemas/Warehouse5"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Warehouse": {
"required": [
"name",
"organisation"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Warehouse name.",
"example": "Sklad - Praha",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"customId": {
"description": "Custom ID.",
"example": "S01",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"wms": {
"description": "Array with Wms UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"defaultWms": {
"description": "Uuid of default Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"organisation": {
"description": "Uuid of organisation that owns this warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Warehouse2": {
"required": [
"name",
"organisation"
],
"properties": {
"name": {
"description": "Warehouse name.",
"example": "Sklad - Praha",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"customId": {
"description": "Custom ID.",
"example": "S01",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"wms": {
"description": "Array with Wms UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"defaultWms": {
"description": "Uuid of default Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"organisation": {
"description": "Uuid of organisation that owns this warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"Warehouse3": {
"required": [
"name",
"organisation"
],
"properties": {
"name": {
"description": "Warehouse name.",
"example": "Sklad - Praha",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"customId": {
"description": "Custom ID.",
"example": "S01",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"wms": {
"description": "Array with Wms UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"defaultWms": {
"description": "Uuid of default Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"organisation": {
"description": "Uuid of organisation that owns this warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"WarehouseList": {
"properties": {
"warehouses": {
"description": "Array with warehouse UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"WmsList": {
"properties": {
"wmses": {
"description": "Array with wms UUID identifiers.",
"example": [
"529baf4b-b7f1-4ff4-827f-b05f52a1a22f"
],
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"minItems": 1
}
},
"type": "object"
},
"Wms2": {
"required": [
"name",
"organisation",
"distributionCenter",
"storeKey",
"internalId"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Wms name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"storeKey": {
"description": "Identifier.",
"example": "ABC123",
"type": "string"
},
"internalId": {
"description": "Identifier.",
"example": "11ecb7ac-7a2c-4c7b-aba8-6be241ceba7f",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"warehouses": {
"description": "Array with warehouse UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"WmsListSearch": {
"properties": {
"criteria": {
"description": "Set of conditions to get specific records.",
"properties": {
"id": {
"$ref": "#/components/schemas/UuidCondition"
},
"name": {
"$ref": "#/components/schemas/StringCondition"
},
"organisation": {
"$ref": "#/components/schemas/UuidCondition"
},
"storeKey": {
"$ref": "#/components/schemas/StringCondition"
}
},
"type": "object"
},
"extra": {
"description": "Set of extra conditions for reservations, need to be refactored.",
"properties": {
"partiallyDelivered": {
"type": "boolean"
}
},
"type": "object"
},
"sort": {
"description": "Available fields to sort: `\"name\"` `\"storeKey\"` `\"internalId\"` `\"createdAt\"` `\"changedAt\"`",
"items": {
"$ref": "#/components/schemas/Sort"
},
"type": "array",
"default": [
{
"field": "name"
}
]
},
"limit": {
"description": "Maximum count of returned records.",
"example": 100,
"type": "integer",
"default": 1000,
"maximum": 1000,
"minimum": 1,
"exclusiveMinimum": 0
},
"offset": {
"description": "Offset from the first matching record.",
"example": 200,
"type": "integer",
"default": 0,
"minimum": 0
},
"select": {
"description": "Available fields to select: `\"id\"` `\"name\"` `\"organisation\"` `\"distributionCenter\"` `\"storeKey\"` `\"internalId\"` `\"createdAt\"` `\"warehouses\"` `\"changedAt\"`",
"items": {
"type": "string"
},
"type": "array",
"default": [
"id",
"name",
"organisation",
"distributionCenter",
"storeKey",
"internalId",
"createdAt",
"warehouses",
"changedAt"
]
},
"nested": {
"description": "Returs nested objects instead of flat reference IDs.",
"example": true,
"type": "boolean",
"default": false
}
},
"type": "object"
},
"Results43": {
"properties": {
"results": {
"$ref": "#/components/schemas/Wms6"
},
"paging": {
"description": "Data useful for pagination.",
"properties": {
"returned": {
"description": "Number of returned entities.",
"example": 10,
"type": "integer"
},
"from": {
"description": "Position from first result (include).",
"example": 5,
"type": "integer"
},
"to": {
"description": "Position to last result (exclude).",
"example": 15,
"type": "integer"
},
"total": {
"description": "Total number of possible entities that match criteria.",
"example": 30,
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"Wms3": {
"required": [
"name",
"organisation",
"distributionCenter",
"storeKey",
"internalId"
],
"properties": {
"name": {
"description": "Wms name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"storeKey": {
"description": "Identifier.",
"example": "ABC123",
"type": "string"
},
"internalId": {
"description": "Identifier.",
"example": "11ecb7ac-7a2c-4c7b-aba8-6be241ceba7f",
"type": "string"
}
},
"type": "object"
},
"Wms4": {
"required": [
"name",
"storeKey",
"internalId"
],
"properties": {
"name": {
"description": "Wms name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"storeKey": {
"description": "Identifier.",
"example": "ABC123",
"type": "string"
},
"internalId": {
"description": "Identifier.",
"example": "11ecb7ac-7a2c-4c7b-aba8-6be241ceba7f",
"type": "string"
},
"warehouses": {
"description": "Array with warehouse UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
}
},
"type": "object"
},
"Sort": {
"properties": {
"field": {
"description": "Name of field to sort",
"type": "string"
},
"order": {
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
}
},
"type": "object"
},
"UuidCondition": {
"properties": {
"eq": {
"description": "Equal (i.e. match to uuid).",
"type": "string"
},
"neq": {
"description": "Not equal (i.e. exclude uuid)",
"type": "string"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"in": {
"description": "In array (i.e. all matches of uuids in array)",
"items": {
"type": "string"
},
"type": "array"
},
"nin": {
"description": "Not in array (i.e. exclude all matched uuids from array)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"StringCondition": {
"properties": {
"eq": {
"description": "Equal (i.e. full match to string).",
"type": "string"
},
"neq": {
"description": "Not equal (i.e. exclude string)",
"type": "string"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"like": {
"description": "Like (i.e. substring match)",
"type": "string"
},
"notLike": {
"description": "Not Like (i.e. substring not-match)",
"type": "string"
},
"in": {
"description": "In array (i.e. all matches of strings in array)",
"items": {
"type": "string"
},
"type": "array"
},
"nin": {
"description": "Not in array (i.e. exclude all matched strings from array)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BooleanCondition": {
"required": [
"flag"
],
"properties": {
"flag": {
"description": "Has same value (true/false)",
"type": "boolean"
}
},
"type": "object"
},
"DateTimeCondition": {
"properties": {
"eq": {
"description": "Equal to.",
"type": "string",
"format": "date-time"
},
"neq": {
"description": "Not Equal to.",
"type": "string",
"format": "date-time"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"gt": {
"description": "Greater than (i.e. strictly after).",
"type": "string",
"format": "date-time"
},
"gte": {
"description": "Greater than or equal (i.e. after)",
"type": "string",
"format": "date-time"
},
"lt": {
"description": "Less than (i.e. strictly before).",
"type": "string",
"format": "date-time"
},
"lte": {
"description": "Less than or equal (i.e. before)",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Admin3": {
"required": [
"location",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"location": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"roles": {
"description": "User roles.",
"example": [
"ROLE_SUPERVISOR"
],
"items": {
"type": "string"
},
"type": "array"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
},
"changedAt": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ConstantCondition": {
"properties": {
"eq": {
"description": "Equal (i.e. full match to string).",
"type": "string"
},
"neq": {
"description": "Not equal (i.e. exclude string)",
"type": "string"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"in": {
"description": "In array (i.e. all matches of strings in array)",
"items": {
"type": "string"
},
"type": "array"
},
"nin": {
"description": "Not in array (i.e. exclude all matched strings from array)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IpCondition": {
"properties": {
"eq": {
"description": "Equal (i.e. full match to string).",
"type": "string"
},
"neq": {
"description": "Not equal (i.e. exclude string)",
"type": "string"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"in": {
"description": "In array (i.e. all matches of strings in array)",
"items": {
"type": "string"
},
"type": "array"
},
"nin": {
"description": "Not in array (i.e. exclude all matched strings from array)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IntegerCondition": {
"properties": {
"eq": {
"description": "Equal to.",
"type": "integer"
},
"neq": {
"description": "Not Equal to.",
"type": "integer"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"gt": {
"description": "Greater than (i.e. strictly after).",
"type": "integer"
},
"gte": {
"description": "Greater than or equal (i.e. after)",
"type": "integer"
},
"lt": {
"description": "Less than (i.e. strictly before).",
"type": "integer"
},
"lte": {
"description": "Less than or equal (i.e. before)",
"type": "integer"
}
},
"type": "object"
},
"AuditRecord": {
"properties": {
"id": {
"description": "Record ID.",
"example": "-eVs2HYBpVCD-WknkjPg",
"type": "string"
},
"timestamp": {
"example": "2021-01-06T16:59:22.426+01:00",
"type": "string",
"format": "date-time"
},
"content": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"WarehouseMapping": {
"properties": {
"mailShipWarehouse": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"baseLinkerWarehouse": {
"example": "123456",
"type": "string"
}
},
"type": "object"
},
"ExpeditionStatusMapping": {
"required": [
"mailShipExpeditionStatus",
"baseLinkerOrderStatusId"
],
"properties": {
"mailShipExpeditionStatus": {
"$ref": "#/components/schemas/ExpeditionStatus"
},
"baseLinkerOrderStatusId": {
"example": "123456",
"type": "integer"
}
},
"type": "object"
},
"WarehouseMapping2": {
"properties": {
"mailShipWarehouse": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"baseLinkerWarehouse": {
"example": "123456",
"type": "string"
}
},
"type": "object"
},
"ExpeditionStatusMapping2": {
"required": [
"mailShipExpeditionStatus",
"baseLinkerOrderStatusId"
],
"properties": {
"mailShipExpeditionStatus": {
"$ref": "#/components/schemas/ExpeditionStatus2"
},
"baseLinkerOrderStatusId": {
"example": "123456",
"type": "integer"
}
},
"type": "object"
},
"ByznysUser3": {
"required": [
"username",
"eshop"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"username": {
"description": "User name.",
"example": "johndoe",
"type": "string"
},
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"statusGetEndpointCalledAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Carrier4": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Carrier name.",
"example": "DHL",
"type": "string"
},
"code": {
"description": "Carrier unique code (number).",
"example": "100",
"type": "integer"
},
"createdAt": {
"example": "2020-05-27T00:00:00+00:00",
"type": "string",
"format": "date-time"
},
"services": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
},
"imageUploadedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"excludedExpeditionAddressValidations": {
"description": "Country codes according to the ISO 3166-1 alpha-2 for which epedition address validation is ignored.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"cod": {
"description": "Whether cash on delivery is available for this carrier, true/false.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"imageUrl": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"CarrierPickupPlace4": {
"required": [
"country",
"carrier"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Carrier pickup place name.",
"example": "Trafika",
"type": "string",
"maxLength": "255"
},
"code": {
"description": "Pickup place code.",
"example": "46101",
"type": "string"
},
"code2": {
"description": "Carrier pickup place code2.",
"example": "11",
"type": "integer"
},
"createdAt": {
"example": "2020-05-27T00:00:00+00:00",
"type": "string",
"format": "date-time"
},
"address": {
"type": "string",
"maxLength": "255"
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"status": {
"description": "Carrier pickup place status (NOT_ACTIVE, ACTIVE, OBSOLETE)",
"example": "0",
"type": "integer",
"enum": [
0,
1,
2
]
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "carrierService",
"type": "string",
"enum": [
"carrier_service",
"pickup_point_branch",
"carrier_service_with_points"
]
},
"externalPickupPlaces": {
"items": {
"$ref": "#/components/schemas/ExternalCarrierPickupPlace2"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"CarrierService4": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Name of carrier service.",
"example": "Balík do ruky",
"type": "string"
},
"code": {
"description": "Carrier service code.",
"example": 100,
"type": "integer"
},
"createdAt": {
"example": "2020-05-27T00:00:00+00:00",
"type": "string",
"format": "date-time"
},
"pickupPlaceIgnore": {
"description": "Pickup place ignore.",
"type": "boolean"
},
"pickupPlaceMandatory": {
"description": "Pickup place mandatory.",
"type": "boolean"
},
"emailMandatory": {
"description": "Email mandatory.",
"type": "boolean"
},
"phoneMandatory": {
"description": "Phone mandatory.",
"type": "boolean"
},
"legacyDispense": {
"description": "Legacy dispense.",
"type": "boolean"
},
"skipDeliveryStatus": {
"description": "Skip delivery status.",
"type": "boolean"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"countriesOfOperation": {
"title": "This method is made for normalizer which is not able to find addCountryOfOperation or removeCountryOfOperation\naccording to name of property countriesOfOperation.",
"description": "Country codes according to the ISO 3166-1 alpha-2 where carrier_service operates.",
"example": [
"DE",
"PL"
],
"items": {
"type": "string"
},
"type": "array"
},
"lockedForImport": {
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Country4": {
"required": [
"code",
"name"
],
"properties": {
"code": {
"title": "Country code.",
"description": "Country code.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"name": {
"description": "Country name.",
"example": "Czech Republic",
"type": "string",
"maxLength": 255,
"minLength": 2
}
},
"type": "object"
},
"Wms5": {
"required": [
"name"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Wms name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
}
},
"type": "object"
},
"Warehouse4": {
"required": [
"name"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Warehouse name.",
"example": "Sklad - Praha",
"type": "string",
"maxLength": "255",
"minLength": "2"
}
},
"type": "object"
},
"Carrier5": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Carrier name.",
"example": "DHL",
"type": "string"
}
},
"type": "object"
},
"CarrierService5": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Name of carrier service.",
"example": "Balík do ruky",
"type": "string"
},
"carrier": {
"description": "Uuid of Carrier that this service belongs.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"File": {
"type": "object"
},
"DateCondition": {
"properties": {
"eq": {
"description": "Equal to.",
"type": "string",
"format": "date"
},
"neq": {
"description": "Not Equal to.",
"type": "string",
"format": "date"
},
"null": {
"description": "Is null",
"type": "boolean"
},
"gt": {
"description": "Greater than (i.e. strictly after).",
"type": "string",
"format": "date"
},
"gte": {
"description": "Greater than or equal (i.e. after)",
"type": "string",
"format": "date"
},
"lt": {
"description": "Less than (i.e. strictly before).",
"type": "string",
"format": "date"
},
"lte": {
"description": "Less than or equal (i.e. before)",
"type": "string",
"format": "date"
}
},
"type": "object"
},
"ComplaintAction4": {
"required": [
"type"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"complaint": {
"$ref": "#/components/schemas/Complaint5"
},
"type": {
"example": "created",
"type": "string",
"enum": [
"workflow",
"comment"
]
},
"newStatus": {
"example": "created",
"type": "string",
"enum": [
"created",
"resolving",
"waiting_for_reporter",
"waiting_for_resolver",
"waiting_for_resolver_log",
"waiting_for_cs",
"waiting_for_ms",
"waiting_for_carrier",
"resolved",
"closed",
"canceled"
]
},
"previousStatus": {
"example": "created",
"type": "string",
"enum": [
"created",
"resolving",
"waiting_for_reporter",
"waiting_for_resolver",
"waiting_for_resolver_log",
"waiting_for_cs",
"waiting_for_ms",
"waiting_for_carrier",
"resolved",
"closed",
"canceled"
]
},
"createdBy": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"deleted": {
"example": "false",
"type": "boolean"
},
"internal": {
"example": "false",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Complaint4": {
"required": [
"organisation",
"expedition",
"status",
"type",
"reason",
"internalId"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdBy": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"reporter": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"resolver": {
"description": "Uuid of Admin.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation to belongs this complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition for complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"status": {
"example": "created",
"type": "string",
"enum": [
"created",
"resolving",
"waiting_for_reporter",
"waiting_for_resolver",
"waiting_for_resolver_log",
"waiting_for_cs",
"waiting_for_ms",
"waiting_for_carrier",
"resolved",
"closed",
"canceled"
]
},
"type": {
"example": "created",
"type": "string",
"enum": [
"expedition"
]
},
"reason": {
"description": "Complaint reason.",
"example": "created",
"type": "string",
"enum": [
"undelivered",
"incomplete",
"damaged",
"late_delivery",
"other"
]
},
"resolution": {
"description": "Complaint resolution.",
"example": "created",
"type": "string",
"enum": [
"unproven",
"additional_goods",
"rejected_by_provider",
"rejected_by_carrier",
"redispatch",
"damaged_by_carrier",
"damaged_by_customer",
"product_unavailable",
"canceled",
"accepted_by_carrier",
"accepted_by_provider",
"wrong_product",
"lost_by_carrier",
"lost_by_provider"
]
},
"internalId": {
"description": "Internal number.",
"example": "16213752_rekl",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Country5": {
"required": [
"code",
"name",
"currencyCode"
],
"properties": {
"code": {
"title": "Country code.",
"description": "Country code.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"name": {
"description": "Country name.",
"example": "Czech Republic",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"currencyCode": {
"description": "Country currency code.",
"example": "CZK",
"type": "string",
"maxLength": 3,
"minLength": 2
},
"currencyName": {
"description": "Country currency name.",
"example": "Czech crown",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"customsDeclaration": {
"description": "Customs declaration.",
"example": true,
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"StockAdviceItem4": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"DistributionCenter4": {
"required": [
"name",
"apiUrl",
"wmsUrl"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Distribution center name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"apiUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"wmsUrl": {
"description": "Unique udentifier of link between Organisation and Wms via store_id.",
"example": "ABC123",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"wmses": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"DistributionCenterOrganisationLogin4": {
"required": [
"organisation",
"loginName",
"type"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"loginName": {
"description": "Login name.",
"example": "inventi",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"type": {
"example": "mailstage",
"type": "string",
"enum": [
"mailstage",
"mailwise"
]
},
"syncIncoming": {
"description": "If true, it synchronizes the receipt of goods.",
"type": "boolean"
},
"syncOutgoing": {
"description": "If true, it synchronizes outgoing goods.",
"type": "boolean"
},
"syncInventoryChanges": {
"description": "If true, it synchronizes inventory changes.",
"type": "boolean"
},
"mailwiseMigrationAt": {
"description": "When was the migration from Mailstage to Mailwise. Expeditions created before this datetime will be processed via Mailstage when syncOutgoing is false and login type Mailstage, and will be processed as shipped in MW when syncOutgoing is true and login type Mailwise.",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Eshop4": {
"required": [
"name",
"active",
"waitBeforeProcessing",
"editBeforeProcessing"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"example": "E-shop - nábytek",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of organisation that owns this eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"defaultWarehouse": {
"description": "Uuid of default warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"warehouses": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"active": {
"description": "If true, the Eshop is active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"partners": {
"items": {
"$ref": "#/components/schemas/Partner4"
},
"type": "array"
},
"waitBeforeProcessing": {
"description": "If true, all expeditions waits in stock_ok status for approval.",
"example": false,
"type": "boolean"
},
"editBeforeProcessing": {
"description": "If true, all expeditions can be edited in stock_ok status before processing.",
"example": false,
"type": "boolean"
},
"integrationType": {
"example": "baselinker",
"type": "string",
"enum": [
"baselinker"
]
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"WebhookCredencials": {
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"base_auth",
"oauth2"
]
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"token": {
"type": "string"
}
},
"type": "object"
},
"EshopWebHook4": {
"required": [
"eshop",
"event",
"destination",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"event": {
"type": "string",
"enum": [
"expedition_status_change",
"expedition_booked_change",
"product_stock_change",
"organization_change"
]
},
"destination": {
"description": "WebHook destination.",
"example": "https://webhook.site/161166f9-a6a0-4123-b53b-1f9be727f2f8",
"type": "string"
},
"active": {
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"authentication": {
"$ref": "#/components/schemas/WebhookCredencials4"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"WebhookCredencials2": {
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"base_auth",
"oauth2"
]
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"token": {
"type": "string"
}
},
"type": "object"
},
"WebhookCredencials3": {
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"base_auth",
"oauth2"
]
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"token": {
"type": "string"
}
},
"type": "object"
},
"Exchange": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"currency": {
"type": "string"
},
"country": {
"type": "string"
},
"code": {
"type": "string"
},
"amount": {
"type": "integer"
},
"course": {
"type": "string"
},
"createdAt": {
"example": "2020-05-25",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ExpeditionItem3": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"position": {
"example": "2",
"type": "integer"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice2"
},
"type": "array"
},
"expedited": {
"example": "4",
"type": "integer",
"minimum": 0
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"ExpeditionStatusAudit": {
"required": [
"statusTo"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"statusTo": {
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"updatedBy": {
"description": "Uuid of account that updated this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"MsMoney": {
"properties": {
"amount": {
"type": "number",
"format": "float"
},
"currency": {
"type": "string"
}
},
"type": "object"
},
"ChildProduct": {
"properties": {
"productId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"quantity": {
"type": "integer"
}
},
"type": "object"
},
"NullableBooleanCondition": {
"properties": {
"flag": {
"description": "Has same value (true/false)",
"type": "boolean"
},
"null": {
"description": "Is null",
"type": "boolean"
}
},
"type": "object"
},
"Expedition5": {
"required": [
"eshop",
"warehouse",
"wms",
"orderNumber",
"carrier",
"carrierService",
"status",
"value",
"currency"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop to belongs this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"partner": {
"description": "Uuid of Partner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"orderNumber": {
"description": "Order number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"billingFirstName": {
"description": "Billing first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"billingLastName": {
"description": "Billing last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"billingDegree": {
"description": "Billing degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"billingCompany": {
"description": "Billing company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"billingStreet": {
"description": "Billing street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"billingHouseNr": {
"description": "Billing house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"billingZip": {
"description": "Billing zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"billingCity": {
"description": "Billing city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"billingCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"billingEmail": {
"description": "Billing email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": "60"
},
"billingPhone": {
"description": "Billing phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"billingRegistrationNumber": {
"description": "Billing registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32
},
"billingVatNumber": {
"description": "Billing Vat number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 32
},
"differentDeliveryAddress": {
"type": "boolean"
},
"deliveryFirstName": {
"description": "Delivery first name.",
"example": "John",
"type": "string",
"maxLength": 255
},
"deliveryLastName": {
"description": "Delivery last name.",
"example": "Doe",
"type": "string",
"maxLength": 255
},
"deliveryDegree": {
"description": "Delivery degree.",
"example": "Doc.",
"type": "string",
"maxLength": 64
},
"deliveryCompany": {
"description": "Delivery company.",
"example": "Mail Step a. s.",
"type": "string",
"maxLength": 255
},
"deliveryStreet": {
"description": "Delivery street.",
"example": "Street",
"type": "string",
"maxLength": 255
},
"deliveryHouseNr": {
"description": "Delivery house number.",
"example": "315/2a",
"type": "string",
"maxLength": 10
},
"deliveryZip": {
"description": "Delivery zip.",
"example": "15012",
"type": "string",
"maxLength": 10
},
"deliveryCity": {
"description": "Delivery city.",
"example": "City",
"type": "string",
"maxLength": 40
},
"deliveryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"deliveryEmail": {
"description": "Delivery email.",
"example": "john.doe@example.com",
"type": "string"
},
"deliveryPhone": {
"description": "Delivery phone.",
"example": "+420 123456789",
"type": "string",
"maxLength": 35
},
"requiredExpeditionDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"carrier": {
"description": "Uuid of Carrier.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierService": {
"description": "Uuid of CarrierService.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierPickupPlace": {
"description": "Uuid of CarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"externalCarrierPickupPlace": {
"description": "Uuid of ExternalCarrierPickupPlace.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"carrierNote": {
"description": "Note for carrier",
"type": "string",
"maxLength": 4096
},
"trackingNumber": {
"description": "Tracking number.",
"example": "DR4057137142G",
"type": "string",
"maxLength": 255
},
"trackingUrl": {
"description": "Tracking Url.",
"example": "https://www.postaonline.cz/trackandtrace/-/zasilka/cislo?parcelNumbers=DR4057137142G",
"type": "string",
"maxLength": 255
},
"externalTrackingNumber": {
"description": "External tracking number.",
"example": "PBZDE014624523",
"type": "string",
"maxLength": 255
},
"packagesCount": {
"description": "Packages count.",
"type": "integer"
},
"status": {
"example": "new",
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"expeditedCompletely": {
"example": "true",
"type": "boolean"
},
"value": {
"description": "Value of the whole expedition.",
"example": "50.00",
"type": "number",
"format": "float",
"exclusiveMinimum": "0"
},
"currency": {
"description": "ISO currency code",
"example": "CZK",
"type": "string"
},
"fragile": {
"description": "Fragile",
"type": "boolean"
},
"cod": {
"description": "Cash on delivery, true/false",
"example": "true",
"type": "boolean"
},
"codValue": {
"description": "Cash on delivery value.",
"example": "5000",
"type": "number",
"format": "float",
"exclusiveMinimum": 0
},
"codCurrency": {
"description": "ISO currency code.",
"example": "CZK",
"type": "string"
},
"codVariableSymbol": {
"description": "Cash on delivery variable symbol.",
"example": "0123456789",
"type": "string",
"maxLength": 32,
"pattern": "\\d+"
},
"customerGroup": {
"description": "Customer group.",
"example": "VIP",
"type": "string",
"maxLength": 255
},
"eshopOrderDate": {
"description": "Eshop order date.",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"packedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"sentAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"deliveredAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"waitBeforeProcessing": {
"description": "Overrides eshop.waitBeforeProcessing value.",
"type": "boolean"
},
"editBeforeProcessing": {
"description": "Overrides eshop.editBeforeProcessing value.",
"type": "boolean"
},
"priority": {
"description": "Priority.",
"example": "5",
"type": "integer"
},
"ref1": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref2": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"ref3": {
"description": "Reference.",
"example": "REFX123",
"type": "string"
},
"foreignPrice": {
"$ref": "#/components/schemas/MsMoney3"
},
"conversionDate": {
"description": "Conversion date",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"modifiedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"removedVirtualProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct5"
},
"type": "array"
},
"ignoreAddressValidation": {
"description": "Whether delivery address validation should be ignored. Default false.",
"type": "boolean"
},
"addressValidationExecuted": {
"description": "Whether delivery address validation has been executed.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"invoiceUrl": {
"example": "/api/expedition/529baf4b-b7f1-4ff4-827f-b05f52a1a22f/invoice",
"type": "string",
"format": "uri"
},
"invoiceOriginalName": {
"example": "invoice.pdf",
"type": "string",
"format": "string"
},
"withComplaint": {
"example": "false",
"type": "bool"
}
},
"type": "object"
},
"MassActionResult": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"reason": {
"example": "Failed.",
"type": "string"
}
},
"type": "object"
},
"ExpeditionItem4": {
"required": [
"product"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice3"
},
"type": "array"
}
},
"type": "object"
},
"ExpeditionItem5": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"position": {
"example": "2",
"type": "integer"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice"
},
"type": "array"
},
"expedited": {
"example": "4",
"type": "integer",
"minimum": 0
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"ExpeditionStatusAudit2": {
"required": [
"statusTo"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"statusTo": {
"type": "string",
"enum": [
"on_hold",
"incorrect",
"stock_ok",
"waiting_for_goods",
"awaiting_processing",
"take_out",
"completion",
"waiting_for_the_carrier",
"carrier_picked_up",
"delivered",
"probably_delivered",
"returned",
"ready_to_takeover",
"returning",
"waiting_for_cancel",
"canceled"
]
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"updatedBy": {
"description": "Uuid of account that updated this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"MsMoney2": {
"properties": {
"amount": {
"type": "number",
"format": "float"
},
"currency": {
"type": "string"
}
},
"type": "object"
},
"ChildProduct2": {
"properties": {
"productId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"quantity": {
"type": "integer"
}
},
"type": "object"
},
"ExpeditionItem6": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice4"
},
"type": "array"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"ExpeditionItem7": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"position": {
"example": "2",
"type": "integer"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice5"
},
"type": "array"
},
"expedited": {
"example": "4",
"type": "integer",
"minimum": 0
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"ExportJob2": {
"required": [
"type",
"status",
"name",
"fileType",
"filename"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "export",
"type": "string",
"enum": [
"export_expedition",
"export_missing_stock",
"export_product_stock",
"export_product",
"export_stock_advice",
"export_stock_movement",
"export_return_receipt",
"export_inbound_receipt",
"export_outbound_receipt",
"export_complaint",
"export_transfer_list"
]
},
"status": {
"example": "waiting",
"type": "string",
"enum": [
"waiting",
"running",
"finished",
"failed"
]
},
"name": {
"example": "export001",
"type": "string",
"maxLength": "64",
"minLength": "2"
},
"fileType": {
"example": "csv",
"type": "string",
"maxLength": "8",
"minLength": "2"
},
"filename": {
"example": "export001.csv",
"type": "string",
"maxLength": "64",
"minLength": "2"
},
"owner": {
"description": "Uuid of owner.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"startedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"finishedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"expectedRecords": {
"example": "32000",
"type": "integer"
},
"processedRecords": {
"example": "32000",
"type": "integer"
},
"fileUrl": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"ExternalCarrierPickupPlace2": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"code": {
"type": "string"
},
"street": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"zip": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/Country5"
},
"carrierPickupPlace": {
"$ref": "#/components/schemas/CarrierPickupPlace4"
}
},
"type": "object"
},
"ProductItem": {
"properties": {
"id": {
"description": "Uuid of product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "4",
"type": "integer"
}
},
"type": "object"
},
"InboundReceipt3": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockAdvice": {
"description": "Uuid of Stock Advice to belongs this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"processed",
"failed"
]
}
},
"type": "object"
},
"InternalStockChange4": {
"required": [
"name",
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status",
"type"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Unique descriptive name of a stock change.",
"example": "_529b-af4b/2022",
"type": "string",
"maxLength": 255,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"waiting_for_goods",
"ready",
"processed",
"failed",
"canceled"
]
},
"type": {
"example": "new",
"type": "string",
"enum": [
"in",
"out"
]
}
},
"type": "object"
},
"InternalStockChangeItem": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"book": {
"description": "Forces to book specific amount of products. Cannot be higher than quantity. Null means same amount as quantity.",
"example": 4,
"type": "integer",
"minimum": 0
}
},
"type": "object"
},
"InternalStockChangeItem2": {
"required": [
"product",
"internalStockChange",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalStockChange": {
"description": "Uuid of StockChange that belongs to stockChange item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"position": {
"example": "2",
"type": "integer"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"InternalStockChangeItem3": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"book": {
"description": "Forces to book specific amount of products. Cannot be higher than quantity. Null means same amount as quantity.",
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"ExpeditionItem8": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice6"
},
"type": "array"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"expeditionWarehouse.name": {
"example": "Virtual Warehouse Name",
"type": "string",
"format": "string"
}
},
"type": "object"
},
"User5": {
"required": [
"dateOfBirth",
"addressLine1",
"addressLine2",
"addressLine3",
"firstName",
"lastName",
"email",
"active",
"phone"
],
"properties": {
"dateOfBirth": {
"description": "Date of birth.",
"example": "1970-07-12",
"type": "string",
"format": "date",
"maximum": "-18 years"
},
"sex": {
"description": "sex",
"example": "male",
"type": "string",
"enum": [
"male",
"female",
null
]
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"photoUploadedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"organisations": {
"description": "Array with organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"preferredLanguage": {
"description": "Preferred language.",
"example": "en",
"type": "string",
"enum": [
"cs",
"sk",
"en",
"ru",
"it",
"es"
]
},
"createdBy": {
"description": "Uuid of User that created this User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"ownedOrganisations": {
"description": "Array with owned organisation UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"active": {
"description": "If true, the user is active.",
"type": "boolean"
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": "35",
"minLength": "2"
},
"changedAt": {
"type": "string",
"format": "date-time"
},
"photo": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
},
"photoList": {
"example": "https://app.mailship.eu/static/media/logo_black.png",
"type": "string",
"format": "uri"
}
},
"type": "object"
},
"Notification3": {
"properties": {
"id": {
"example": "oEjOGIABbGY_VJusbqWA",
"type": "string"
},
"type": {
"example": "keyword",
"type": "string"
},
"content": {
"example": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit.",
"type": "string"
},
"seen": {
"description": "Filtr seen / unseen",
"example": true,
"type": "boolean"
},
"flag": {
"description": "Flag true / false",
"example": true,
"type": "boolean"
},
"createdAt": {
"example": "2022-04-12T10:25:11+02:00",
"type": "string",
"format": "date-time"
},
"entityId": {
"description": "Uuid of entity which is related to notification",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string"
},
"userId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisationId": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
}
},
"type": "object"
},
"Threshold": {
"required": [
"type"
],
"properties": {
"type": {
"example": "product_stock",
"type": "string",
"enum": [
"product",
"productGroup",
"stockAdviceStatus",
"complaintStatus"
]
}
},
"type": "object"
},
"NotificationSetting3": {
"required": [
"type",
"organisation"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": {
"example": "product_stock",
"type": "string",
"enum": [
"stock_advice",
"complaint",
"product_stock",
"inbound_receipt"
]
},
"email": {
"description": "Emailová adresa.",
"type": "string"
},
"sendToEmail": {
"type": "boolean"
},
"sendToMs": {
"type": "boolean"
},
"createdBy": {
"description": "Uuid of User that enter this expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"threshold": {
"$ref": "#/components/schemas/Threshold2"
},
"createdAt": {
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"notificationSent": {
"type": "boolean"
},
"subscribers": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
}
},
"type": "object"
},
"Organisation4": {
"required": [
"name",
"registrationNumber",
"vatNumber",
"primaryCountry",
"active",
"automaticExchangeEnabled"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Organisation name.",
"example": "Inventi",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"vatNumber": {
"description": "VAT number",
"example": "CZ12345678",
"type": "string",
"maxLength": 32,
"minLength": 2
},
"addressLine1": {
"description": "Address line 1.",
"example": "Street 1",
"type": "string"
},
"addressLine2": {
"description": "Address line 2.",
"example": "123 56 Town",
"type": "string"
},
"addressLine3": {
"description": "Address line 3.",
"example": "Czech Republic",
"type": "string"
},
"primaryCountry": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"owner": {
"description": "Uuid of User that owns this organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"owners": {
"description": "Uuid of Users that own this organisation.",
"example": "[529baf4b-b7f1-4ff4-827f-b05f52a1a22f, f1ae1656-9a65-11ec-b909-0242ac120002]",
"items": {
"type": "uuid"
},
"type": "array"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"wmses": {
"description": "Array with wmses UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"suppliers": {
"description": "Array with suppliers UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"code": {
"description": "Organisation code.",
"example": "ZZ",
"type": "string",
"maxLength": 32
},
"automaticExchangeEnabled": {
"description": "If true, the value of the shipment is automatically recalculated.",
"example": false,
"type": "boolean"
},
"ignoreAddressValidation": {
"description": "Whether expedition delivery address validation should be ignored. Default false.",
"type": "boolean"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"OutboundReceipt2": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition to belongs this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"issuedAt": {
"description": "Issued date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"processed",
"failed"
]
}
},
"type": "object"
},
"Partner4": {
"required": [
"eshop",
"name",
"street",
"city",
"zip",
"country",
"phone",
"email",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop to whom partner belongs to.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"code": {
"description": "This value is unique identifier used by older Mailstage API (addr_id).",
"example": 1,
"type": "integer",
"minimum": 0
},
"name": {
"description": "Partner name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Title.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number.",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City.",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"phone": {
"description": "Phone number.",
"example": "+420 123456789",
"type": "string",
"maxLength": 20,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Product4": {
"required": [
"eshops",
"productSku",
"internalSku",
"organisation",
"name",
"packagingType",
"workAroundSnIn",
"workAroundEanSticker",
"workAroundWarrantyInf",
"workAroundLot",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshops": {
"description": "Uuid of eshops.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"productSku": {
"description": "Poduct SKU.",
"example": "123",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"internalSku": {
"description": "Internal SKU.",
"example": "456",
"type": "string",
"pattern": "((?![^[:print:]]).)*"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"productGroup": {
"description": "Uuid of ProductGroup.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Product name.",
"example": "Mikrovlnná trouba 526",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"description": {
"description": "Product description.",
"example": "Volně stojící ikrovlnná trouba s příkonem 3kW",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"images": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"intImages": {
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"weight": {
"description": "Weight in grams.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 10000000,
"exclusiveMinimum": 0
},
"height": {
"description": "Weight in milimeters.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"width": {
"description": "Width in milimeters.",
"example": "400",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"length": {
"description": "Length in milimeters.",
"example": "1000",
"type": "integer",
"exclusiveMaximum": 20000,
"exclusiveMinimum": 0
},
"intWeight": {
"description": "Weight in grams from Mailwise.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 10000000
},
"intHeight": {
"description": "Weight in milimeters from Mailwise.",
"example": "50",
"type": "integer",
"exclusiveMaximum": 20000
},
"intWidth": {
"description": "Width in milimeters from Mailwise.",
"example": "400",
"type": "integer",
"exclusiveMaximum": 20000
},
"intLength": {
"description": "Length in milimeters from Mailwise.",
"example": "1000",
"type": "integer",
"exclusiveMaximum": 20000
},
"referenceNumbers": {
"description": "Array with reference numbers. When null/empty, productSku is used instead.",
"example": [
"123",
"456"
],
"items": {
"type": "string"
},
"type": "array"
},
"packagingType": {
"description": "Packaging type.",
"example": "A",
"type": "string"
},
"workAroundSnIn": {
"type": "boolean"
},
"workAroundEanSticker": {
"type": "boolean"
},
"workAroundWarrantyInf": {
"type": "boolean"
},
"workAroundLot": {
"type": "boolean"
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countryOfOrigin": {
"description": "Country of origin code according to the ISO 3166-1 alpha-2.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 2
},
"hsCode": {
"description": "HS code.",
"example": "HS123456",
"type": "string"
},
"type": {
"description": "Product type.",
"example": "bundle",
"type": "string",
"enum": [
"virtual",
"physical",
"bundle"
]
},
"childrenProducts": {
"items": {
"$ref": "#/components/schemas/ChildProduct5"
},
"type": "array"
},
"category": {
"description": "Category.",
"example": "dangerous_substances",
"type": "string",
"enum": [
"dangerous_substances"
]
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ChildProduct3": {
"properties": {
"productId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"quantity": {
"type": "integer"
}
},
"type": "object"
},
"ChildProduct4": {
"properties": {
"productId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"quantity": {
"type": "integer"
}
},
"type": "object"
},
"ProductGroup4": {
"required": [
"name",
"organisation"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Product group name.",
"example": "Books",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ProductStock3": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "5",
"type": "integer"
},
"booked": {
"example": "2",
"type": "integer"
},
"bookedAtExpeditions": {
"example": "2",
"type": "integer"
},
"virtualBookedAtExpeditions": {
"example": "2",
"type": "integer"
},
"bookedAtTransfers": {
"example": "2",
"type": "integer"
},
"bookedAtStockChanges": {
"example": "2",
"type": "integer"
},
"available": {
"example": "3",
"type": "integer"
},
"missing": {
"description": "Total number of missing products on items.",
"example": "9",
"type": "integer"
},
"missingAtExpeditions": {
"description": "Total number of missing products on ExpeditionItem (expeditionItem.quantity - expeditionItem.booked).",
"example": "9",
"type": "integer"
},
"missingAtTransfers": {
"description": "Total number of missing products on TransferItem (transferItem.quantity - transferItem.booked).",
"example": "9",
"type": "integer"
},
"missingAtStockChanges": {
"description": "Total number of missing products on StockChangeItem (quantity - booked).",
"example": "9",
"type": "integer"
},
"bookedAtInternalStockChanges": {
"example": 9,
"type": "integer"
},
"missingAtInternalStockChanges": {
"description": "Total number of missing products on InternalStockChangeItem (quantity - booked).",
"example": 9,
"type": "integer"
},
"required": {
"description": "Number of products that are required to stock, in order to satisfy all expeditions and transfers (productStock.missing - productStock.available, only if the value is positive).",
"example": "6",
"type": "integer"
},
"incoming": {
"example": "10",
"type": "integer"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"lots": {
"items": {
"$ref": "#/components/schemas/ProductStockLot2"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"productProductGroup.id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"format": "string"
},
"productProductGroup.name": {
"example": "Group name",
"type": "string",
"format": "string"
}
},
"type": "object"
},
"ProductStockLot": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"lot": {
"description": "Product Stock Lot.",
"example": "21-01",
"type": "string"
},
"date": {
"description": "Date of Product Stock Lot.",
"example": "2021-01-01",
"type": "string",
"format": "date"
},
"quantity": {
"example": "5",
"type": "integer"
},
"booked": {
"example": "2",
"type": "integer"
},
"available": {
"example": "3",
"type": "integer"
},
"missing": {
"description": "Total number of missing products on ExpeditionItem (expeditionItem.quantity - expeditionItem.booked).",
"example": "9",
"type": "integer"
},
"required": {
"description": "Number of products that are required to stock, in order to satisfy all expeditions (productStock.missing - productStock.available, only if the value is positive).",
"example": "6",
"type": "integer"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"StockMovementReport": {
"properties": {
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movementType": {
"example": "IN",
"type": "string"
},
"quantity": {
"example": "10",
"type": "integer"
},
"count": {
"example": "10",
"type": "integer"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"ean": {
"example": "7501031311309",
"type": "string"
},
"serialNumber": {
"example": "XN23213232424",
"type": "string"
},
"lot": {
"example": "BN20200626",
"type": "string"
},
"warranty": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"movedMonth": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"movedWeek": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"movedDate": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"movedDateHour": {
"example": "2020-12-31 23:00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ExpeditionReport": {
"properties": {
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"status": {
"example": "delivered",
"type": "string"
},
"delivered": {
"example": "true",
"type": "boolean"
},
"count": {
"example": "10",
"type": "integer"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"eshop": {
"description": "Uuid of Eshop.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdMonth": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"createdWeek": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"createdDate": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"createdDateHour": {
"example": "2020-12-31 23:00:00",
"type": "string",
"format": "date-time"
},
"packedMonth": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"packedWeek": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"packedDate": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"packedDateHour": {
"example": "2020-12-31 23:00:00",
"type": "string",
"format": "date-time"
},
"sentMonth": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"sentWeek": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"sentDate": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"sentDateHour": {
"example": "2020-12-31 23:00:00",
"type": "string",
"format": "date-time"
},
"deliveredMonth": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"deliveredWeek": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"deliveredDate": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"deliveredDateHour": {
"example": "2020-12-31 23:00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ComplaintReport": {
"properties": {
"status": {
"example": "waiting_for_resolver",
"type": "string"
},
"count": {
"example": "10",
"type": "integer"
}
},
"type": "object"
},
"ExpeditionItem9": {
"required": [
"product",
"expedition",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition that belongs to expedition item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice7"
},
"type": "array"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"expeditionWarehouse.name": {
"example": "Lakatošová a.s. - Sklad Hlavni",
"type": "string",
"format": "string"
},
"expeditionWarehouse.id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"format": "string"
},
"expeditionWms.name": {
"example": "Lakatošová a.s. - Sklad Hlavni",
"type": "string",
"format": "string"
},
"expeditionWms.id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"format": "string"
}
},
"type": "object"
},
"InboundReceipt4": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition to belongs this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"processed",
"failed"
]
},
"type": {
"example": "new",
"type": "string",
"enum": [
"inventory",
"returned",
"returned_open",
"returned_damaged"
]
},
"note": {
"example": "Note about the return receipt.",
"type": "string",
"maxLength": 500
},
"returnedParcelNumber": {
"description": "Identifier about the returned parcel number.",
"type": "string",
"maxLength": 256
},
"complete": {
"description": "true - complete return, false - partial return",
"example": "true",
"type": "boolean"
}
},
"type": "object"
},
"StockAdvice6": {
"required": [
"organisation",
"warehouse",
"wms",
"supplier",
"status",
"internalId",
"expectedAt"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of warehouse that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of Wms that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"supplier": {
"description": "Uuid of Supplier that belongs to this advice.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"packagingUnit": {
"description": "Packaging unit.",
"example": "pallet",
"type": "string",
"enum": [
"pallet",
"package"
]
},
"countOfUnits": {
"description": "Count of units.",
"example": "5",
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"description": "Status.",
"example": "new",
"type": "string",
"enum": [
"on_hold",
"new",
"waiting",
"in_progress",
"finished",
"partially_finished",
"canceled",
"incorrect",
"closed"
]
},
"manualInput": {
"description": "true - manual input, false - import",
"example": "true",
"type": "boolean"
},
"note": {
"description": "Note.",
"example": "Note about the stock advice.",
"type": "string",
"maxLength": 500
},
"internalId": {
"description": "Internal ID.",
"example": "Internal number.",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"mailwiseInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"expectedAt": {
"description": "Expected date and time of arrival",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"sumOfSuppliedQuantity": {
"example": "5",
"type": "integer"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"StockAdviceItem5": {
"required": [
"stockAdvice",
"product",
"quantity"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockAdvice": {
"description": "Uuid of Stock Advice that has the item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice8"
},
"type": "array"
},
"blocked": {
"example": "4",
"type": "integer",
"minimum": 0
},
"position": {
"example": "2",
"type": "integer"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"suppliedQuantity": {
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"StockAdviceItem6": {
"required": [
"product",
"quantity"
],
"properties": {
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice9"
},
"type": "array"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"StockAdviceBookExpeditionItem": {
"required": [
"expeditionItem",
"quantity"
],
"properties": {
"expeditionItem": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"StockAdviceItem7": {
"required": [
"stockAdvice",
"product",
"quantity"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockAdvice": {
"description": "Uuid of Stock Advice that has the item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"bookStockAdvices": {
"items": {
"$ref": "#/components/schemas/BookStockAdvice10"
},
"type": "array"
},
"blocked": {
"example": "4",
"type": "integer",
"minimum": 0
},
"position": {
"example": "2",
"type": "integer"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"description": "Quantity.",
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"suppliedQuantity": {
"example": "4",
"type": "integer",
"exclusiveMinimum": 0
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"BookStockAdvice": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"StockChange2": {
"required": [
"wms",
"organisation",
"warehouse",
"countOfItems",
"countOfSku",
"sumOfQuantity",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse that belongs to this receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsInternalId": {
"example": "WMS Internal number.",
"type": "string",
"maxLength": 64
},
"receivedAt": {
"description": "Receipt date and time",
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer",
"minimum": 0
},
"countOfSku": {
"example": "5",
"type": "integer",
"minimum": 0
},
"sumOfQuantity": {
"example": "5",
"type": "integer",
"minimum": 0
},
"status": {
"example": "processed",
"type": "string",
"enum": [
"new",
"waiting_for_goods",
"ready",
"processed",
"failed",
"canceled"
]
},
"type": {
"example": "new",
"type": "string",
"enum": [
"in",
"out"
]
}
},
"type": "object"
},
"StockChangeItem": {
"required": [
"product",
"stockChange",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockChange": {
"description": "Uuid of StockChange that belongs to stockChange item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"position": {
"example": "2",
"type": "integer"
},
"expedited": {
"example": "4",
"type": "integer",
"minimum": 0
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"StockMovement3": {
"required": [
"product",
"movementType",
"organisation",
"warehouse",
"wms"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"product": {
"description": "Uuid of Product.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"movementType": {
"example": "IN",
"type": "string",
"enum": [
"in",
"out",
"book",
"unbook"
]
},
"movementSubType": {
"example": "new",
"type": "string",
"enum": [
"inventory",
"virtual_transfer",
"new",
"returned",
"returned_open",
"returned_damaged",
"completion",
"other",
"production"
]
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouse": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wms": {
"description": "Uuid of WMS.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"inboundReceipt": {
"description": "Uuid of Inbound Receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"outboundReceipt": {
"description": "Uuid of Outbound Receipt.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expeditionItem": {
"description": "Uuid of Expedition Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockChange": {
"description": "Uuid of StockChange.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"stockChangeItem": {
"description": "Uuid of StockChange Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalStockChange": {
"description": "Uuid of StockChange.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalStockChangeItem": {
"description": "Uuid of StockChange Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"transfer": {
"description": "Uuid of Transfer.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"transferItem": {
"description": "Uuid of Transfer Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"ean": {
"example": "7501031311309",
"type": "string"
},
"serialNumber": {
"example": "XN23213232424",
"type": "string",
"maxLength": 255
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
},
"lot": {
"example": "BN20200626",
"type": "string",
"maxLength": 255
},
"lotDate": {
"description": "Lot Date.",
"example": "2021-01-01",
"type": "string",
"format": "date"
},
"warranty": {
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"movedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"reported": {
"type": "boolean"
},
"productProductGroup.id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"format": "string"
},
"productProductGroup.name": {
"example": "Group name",
"type": "string",
"format": "string"
}
},
"type": "object"
},
"Supplier4": {
"required": [
"organisation",
"name",
"companyName",
"active"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Supplier name.",
"example": "Velkoobchod Skříně s.r.o.",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"companyName": {
"description": "Supplier company name.",
"example": "Skříně s.r.o.",
"type": "string",
"maxLength": "60",
"minLength": "2"
},
"firstName": {
"description": "First name.",
"example": "John",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"lastName": {
"description": "Last name.",
"example": "Doe",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"degree": {
"description": "Degree.",
"example": "Ing.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"degree2": {
"description": "Degree 2.",
"example": "CSc.",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"street": {
"description": "Street.",
"example": "Street",
"type": "string",
"maxLength": 30,
"minLength": 2
},
"houseNr": {
"description": "House number",
"example": "315/2a",
"type": "string",
"maxLength": 10,
"minLength": 1
},
"city": {
"description": "City",
"example": "City",
"type": "string",
"maxLength": 40,
"minLength": 2
},
"zip": {
"description": "Zip.",
"example": "15012",
"type": "string",
"maxLength": 10,
"minLength": 2
},
"country": {
"description": "Country.",
"example": "CZ",
"type": "string",
"maxLength": 2,
"minLength": 1
},
"phone": {
"description": "Phone number",
"example": "+420 123456789",
"type": "string",
"maxLength": 35,
"minLength": 2
},
"email": {
"description": "Email.",
"example": "john.doe@example.com",
"type": "string",
"maxLength": 60,
"minLength": 2
},
"registrationNumber": {
"description": "Registration number.",
"example": "12345678",
"type": "string",
"maxLength": 14,
"minLength": 2
},
"vatNumber": {
"description": "VAT number.",
"example": "CZ12345678",
"type": "string",
"maxLength": 16,
"minLength": 2
},
"note": {
"description": "Note.",
"example": "This is the text of the note. bla bla",
"type": "string",
"maxLength": 255,
"minLength": 2
},
"active": {
"description": "Active.",
"type": "boolean"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"ref1": {
"description": "Reference 1.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref2": {
"description": "Reference 2.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"ref3": {
"description": "Reference 3.",
"example": "REFX123",
"type": "string",
"maxLength": 255
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"TransferItem": {
"required": [
"product",
"transfer",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"transfer": {
"description": "Uuid of Transfer that belongs to transfer item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"position": {
"example": "2",
"type": "integer"
},
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"booked": {
"example": 4,
"type": "integer",
"minimum": 0
},
"missing": {
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"assignedLot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"Transfer4": {
"required": [
"organisation",
"warehouseFrom",
"warehouseTo",
"wmsFrom",
"wmsTo",
"internalNumber",
"type",
"status"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"user": {
"description": "Uuid of User that enter this transfer.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseFrom": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"warehouseTo": {
"description": "Uuid of Warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsFrom": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"wmsTo": {
"description": "Uuid of Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"internalNumber": {
"description": "Internal number.",
"example": "E123456",
"type": "string",
"maxLength": 32,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]+"
},
"note": {
"description": "Note.",
"example": "Handle with care.",
"type": "string",
"maxLength": "4096"
},
"requiredTransferDate": {
"description": "Required date of delivery",
"example": "2020-05-25",
"type": "string",
"format": "date"
},
"type": {
"description": "Type.",
"example": "new",
"type": "string",
"enum": [
"virtual"
]
},
"status": {
"example": "new",
"type": "string",
"enum": [
"created",
"waiting_for_goods",
"finished",
"canceled"
]
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"countOfItems": {
"example": "5",
"type": "integer"
},
"countOfSku": {
"example": "5",
"type": "integer"
},
"sumOfQuantity": {
"example": "5",
"type": "integer"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"TransferItem2": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"book": {
"description": "Forces to book specific amount of products. Cannot be higher than quantity. Null means same amount as quantity.",
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"TransferItem3": {
"required": [
"product",
"quantity"
],
"properties": {
"product": {
"description": "Uuid of Inbound that belongs to inbound item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": 4,
"type": "integer",
"exclusiveMinimum": 0
},
"book": {
"description": "Forces to book specific amount of products. Cannot be higher than quantity. Null means same amount as quantity.",
"example": 4,
"type": "integer",
"minimum": 0
},
"lot": {
"type": "string",
"maxLength": 20
},
"lifo": {
"type": "boolean"
},
"ref1": {
"type": "string",
"maxLength": 255
},
"ref2": {
"type": "string",
"maxLength": 255
},
"ref3": {
"type": "string",
"maxLength": 255
}
},
"type": "object"
},
"Warehouse5": {
"required": [
"name",
"organisation"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Warehouse name.",
"example": "Sklad - Praha",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"customId": {
"description": "Custom ID.",
"example": "S01",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"wms": {
"description": "Array with Wms UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"defaultWms": {
"description": "Uuid of default Wms.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid",
"enum": []
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"organisation": {
"description": "Uuid of organisation that owns this warehouse.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"Wms6": {
"required": [
"name",
"organisation",
"distributionCenter",
"storeKey",
"internalId"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"name": {
"description": "Wms name.",
"example": "WMS wh1",
"type": "string",
"maxLength": "255",
"minLength": "2"
},
"organisation": {
"description": "Uuid of Organisation.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"distributionCenter": {
"description": "Uuid of Distribution Center.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"storeKey": {
"description": "Identifier.",
"example": "ABC123",
"type": "string"
},
"internalId": {
"description": "Identifier.",
"example": "11ecb7ac-7a2c-4c7b-aba8-6be241ceba7f",
"type": "string"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"warehouses": {
"description": "Array with warehouse UUID identifiers.",
"items": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"type": "array"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ExpeditionStatus": {
"type": "object"
},
"ExpeditionStatus2": {
"type": "object"
},
"Complaint5": {
"required": [
"organisation",
"expedition",
"status",
"type",
"reason",
"internalId"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdBy": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"reporter": {
"description": "Uuid of User.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"resolver": {
"description": "Uuid of Admin.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"organisation": {
"description": "Uuid of Organisation to belongs this complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"expedition": {
"description": "Uuid of Expedition for complaint.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"status": {
"example": "created",
"type": "string",
"enum": [
"created",
"resolving",
"waiting_for_reporter",
"waiting_for_resolver",
"waiting_for_resolver_log",
"waiting_for_cs",
"waiting_for_ms",
"waiting_for_carrier",
"resolved",
"closed",
"canceled"
]
},
"type": {
"example": "created",
"type": "string",
"enum": [
"expedition"
]
},
"reason": {
"description": "Complaint reason.",
"example": "created",
"type": "string",
"enum": [
"undelivered",
"incomplete",
"damaged",
"late_delivery",
"other"
]
},
"resolution": {
"description": "Complaint resolution.",
"example": "created",
"type": "string",
"enum": [
"unproven",
"additional_goods",
"rejected_by_provider",
"rejected_by_carrier",
"redispatch",
"damaged_by_carrier",
"damaged_by_customer",
"product_unavailable",
"canceled",
"accepted_by_carrier",
"accepted_by_provider",
"wrong_product",
"lost_by_carrier",
"lost_by_provider"
]
},
"internalId": {
"description": "Internal number.",
"example": "16213752_rekl",
"type": "string",
"maxLength": 64,
"pattern": "[A-Za-z0-9][A-Za-z_0-9/-]*"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"WebhookCredencials4": {
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"base_auth",
"oauth2"
]
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"token": {
"type": "string"
}
},
"type": "object"
},
"BookStockAdvice2": {
"required": [
"stockAdviceItem"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"stockAdviceItem": {
"description": "Uuid of Stock Advice Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"MsMoney3": {
"properties": {
"amount": {
"type": "number",
"format": "float"
},
"currency": {
"type": "string"
}
},
"type": "object"
},
"ChildProduct5": {
"properties": {
"productId": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"quantity": {
"type": "integer"
}
},
"type": "object"
},
"BookStockAdvice3": {
"required": [
"stockAdviceItem"
],
"properties": {
"stockAdviceItem": {
"description": "Uuid of Stock Advice Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"BookStockAdvice4": {
"type": "object"
},
"BookStockAdvice5": {
"required": [
"stockAdviceItem"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"stockAdviceItem": {
"description": "Uuid of Stock Advice Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"BookStockAdvice6": {
"type": "object"
},
"Threshold2": {
"required": [
"type"
],
"properties": {
"type": {
"example": "product_stock",
"type": "string",
"enum": [
"product",
"productGroup",
"stockAdviceStatus",
"complaintStatus"
]
}
},
"type": "object"
},
"ProductStockLot2": {
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "string",
"format": "uuid"
},
"lot": {
"description": "Product Stock Lot.",
"example": "21-01",
"type": "string"
},
"date": {
"description": "Date of Product Stock Lot.",
"example": "2021-01-01",
"type": "string",
"format": "date"
},
"quantity": {
"example": "5",
"type": "integer"
},
"booked": {
"example": "2",
"type": "integer"
},
"available": {
"example": "3",
"type": "integer"
},
"missing": {
"description": "Total number of missing products on ExpeditionItem (expeditionItem.quantity - expeditionItem.booked).",
"example": "9",
"type": "integer"
},
"required": {
"description": "Number of products that are required to stock, in order to satisfy all expeditions (productStock.missing - productStock.available, only if the value is positive).",
"example": "6",
"type": "integer"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"changedAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"BookStockAdvice7": {
"type": "object"
},
"BookStockAdvice8": {
"required": [
"expeditionItem"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"expeditionItem": {
"description": "Uuid of Expedition Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"BookStockAdvice9": {
"required": [
"expeditionItem"
],
"properties": {
"expeditionItem": {
"description": "Uuid of Expedition Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
},
"BookStockAdvice10": {
"required": [
"expeditionItem"
],
"properties": {
"id": {
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"createdAt": {
"example": "2020-05-25T13:36:05+00:00",
"type": "string",
"format": "date-time"
},
"expeditionItem": {
"description": "Uuid of Expedition Item.",
"example": "529baf4b-b7f1-4ff4-827f-b05f52a1a22f",
"type": "uuid"
},
"quantity": {
"example": "10",
"type": "integer",
"exclusiveMinimum": 0
}
},
"type": "object"
}
}
}
}