OpenAPI 3
The document below describes our REST API in terms of the OpenAPI version 3 standard.
{
"openapi": "3.0.1",
"info": {
"title": "IMS API",
"version": "2020-06-26T09:39:21Z"
},
"servers": [
{
"url": "https://api.thetis-ims.com/{basePath}",
"variables": {
"basePath": {
"default": "/prod"
}
}
}
],
"paths": {
"/inboundShipments": {
"get": {
"parameters": [
{
"name": "onlyWithRequisition",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryHorizon",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoGoodsReceipt",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyExpectedToday",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "firstRow",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "requisitionNumber",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoRequisition",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "invoiceNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "supplierAddressMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoCostVarianceList",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryNoteNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumRows",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "inboundShipmentNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "dateGoodsReceiptCreated",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "supplierNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryAddressMatch",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
},
"400": {
"description": "400 response",
"content": {}
},
"404": {
"description": "404 response",
"content": {}
},
"500": {
"description": "500 response",
"content": {}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/events/{id}/messages": {
"post": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full",
"api/consigment"
]
},
{
"api_key": []
}
]
}
},
"/productGroups": {
"get": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full",
"api/purchasing"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full",
"api/purchasing"
]
},
{
"api_key": []
}
]
}
},
"/sellers": {
"get": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/customers/{id}/{attribute}": {
"put": {
"parameters": [
{
"name": "attribute",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/documents/{id}/inventoryPostings": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/accounting",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/suppliers": {
"get": {
"parameters": [
{
"name": "supplierNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "addressMatch",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/globalTradeItems/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full",
"api/forecasting"
]
},
{
"api_key": []
}
]
},
"patch": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/customers": {
"get": {
"description": "Get a collection of customers",
"parameters": [
{
"name": "globalLocationNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "addressMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "customerNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/returnShipments/{id}/{attribute}": {
"put": {
"parameters": [
{
"name": "attribute",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipments/{id}/{attribute}": {
"put": {
"parameters": [
{
"name": "attribute",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/documents": {
"get": {
"parameters": [
{
"name": "onlyCancelled",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "workStatus",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "documentType",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "notSeenByConnection",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "documentNumber",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "notSeenByConnectionName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/returnShipments/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/full",
"api/sales"
]
},
{
"api_key": []
}
]
},
"delete": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/full",
"api/sales"
]
},
{
"api_key": []
}
]
}
},
"/shipmentLines": {
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipments/{id}/deliveryNote": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/customers/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
},
"400": {
"description": "400 response",
"content": {}
},
"404": {
"description": "404 response",
"content": {}
},
"500": {
"description": "500 response",
"content": {}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/documents/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/accounting",
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipmentLines/{id}/{attribute}": {
"put": {
"parameters": [
{
"name": "attribute",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}
}
},
"/globalTradeItems": {
"get": {
"parameters": [
{
"name": "onlyMoreThanOneLocation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "stockKeepingUnitMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "businessItemNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyChosenProductGroups",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyActive",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "locationNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "itemCategoryNameMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productGroupNameMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "sizeMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxEstimatedSalesWeeks",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "materialMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumRows",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "inboundShipmentNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "supplierNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productNameMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyHasNotDrawnItems",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumItemsSaleable",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "packagingTypeMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "seasonMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "descriptionMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "hazardClassMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "chosenProductGroups",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "brandMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyMissing",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "firstRow",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "colorMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyReorderingAllowed",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "suppliersItemNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "globalTradeItemNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyStockLevelBelowAverage",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyDueForReordering",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "minNumItemsSaleable",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full",
"api/purchasing",
"api/forecasting"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/products/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
},
"patch": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/inboundShipments/{id}/inventoryTransactions": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchase",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipmentLines/{id}": {
"delete": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/full",
"api/sales"
]
},
{
"api_key": []
}
]
}
},
"/returnShipments": {
"get": {
"parameters": [
{
"name": "customerNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumRows",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoReturnReceipt",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "returnShipmentNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "firstRow",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipments/{id}/inventoryTransactions": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchase",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/documents/{id}/seenByConnection": {
"post": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/inboundShipments/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
},
"delete": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/locations": {
"get": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/products": {
"get": {
"parameters": [
{
"name": "activeSubstanceNameMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "season",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "chosenProductGroups",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "brand",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyChosenProductGroups",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productNameMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "productGroupNameMatch",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/products/{id}/{attribute}": {
"put": {
"parameters": [
{
"name": "attribute",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/globalTradeItems/{id}/{attribute}": {
"put": {
"parameters": [
{
"name": "attribute",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/suppliers/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/purchasing",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipments/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full",
"api/consignment"
]
},
{
"api_key": []
}
]
},
"delete": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
},
"/shipments": {
"get": {
"parameters": [
{
"name": "zoneNameMatchAll",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNotCancelled",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "customerNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoWave",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumItems",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "stockKeepingUnitMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "pickingListNumber",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "zoneNameMatchAny",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "postalCodeMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "shippingMode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyPartlyDelivered",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyOnHold",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "itemCategoryNameMatchAny",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "ourReferenceMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNotLockedByOthers",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyInProcess",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoDeliveryNote",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "carriersShipmentNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyShowOnMobile",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "wave",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "minNumLines",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumRows",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNotOnHold",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "yearDeliveryNoteCreated",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyLocked",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryNoteNumber",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumLinesItemsNotAvailable",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxNumLines",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryDate",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "shippingStatus",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "minNumLinesItemsNotAvailable",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveredWithinCommonTimeInterval",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "globalTradeItemNumber",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryHorizonInDays",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyNoPickingList",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "shipmentNumberMatch",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "firstRow",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "minNumItems",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "minWeight",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "itemCategoryNameMatchAll",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxWeight",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "monthDeliveryNoteCreated",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "minVolume",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxVolume",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "onlyPackingFinished",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "dateDeliveryNoteCreated",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "deliveryAddressMatch",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/purchasing",
"api/consignment",
"api/full"
]
},
{
"api_key": []
}
]
},
"post": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Cognito": [
"api/sales",
"api/full"
]
},
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"Empty": {
"title": "Empty Schema",
"type": "object"
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
},
"Cognito": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-amazon-apigateway-authtype": "cognito_user_pools"
}
}
}
}