{ "openapi": "3.1.0", "info": { "title": "THG Fulfil", "description": "THG Fulfil", "version": "1" }, "servers": [ { "url": "/api" } ], "paths": { "/{owner}/v1/inventory-item/{inventory_item}/approval-status": { "get": { "tags": [ "inventory item" ], "summary": "Get approval status", "operationId": "v1-Operation.GET-_owner_/v1/inventory-item/_inventory_item_/approval-status", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "inventory_item", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ValidStatusModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/inventory-item/{inventory_item}/approval-status/_values": { "get": { "tags": [ "inventory item" ], "summary": "Available statuses for approval status ", "operationId": "v1-Operation.GET-_owner_/v1/inventory-item/_inventory_item_/approval-status/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "inventory_item", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/inventory-item": { "get": { "tags": [ "inventory item" ], "summary": "Get all inventory item", "operationId": "v1-Operation.GET_ALL-_owner_/v1/inventory-item", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_InventoryItemModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "post": { "tags": [ "inventory item" ], "summary": "Create inventory item", "operationId": "v1-Operation.CREATE-_owner_/v1/inventory-item", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryItemModel" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_InventoryItemModel_" } } } }, "400": { "description": "Bad request. Data not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "415": { "description": "Media type is unsupported. All APIs, unless specified otherwise, only support JSON payloads." }, "413": { "description": "Payload exceeds maximum payload size of 256 kilobytes." }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/inventory-item/{inventory_item}": { "get": { "tags": [ "inventory item" ], "summary": "Get inventory item", "operationId": "v1-Operation.GET-_owner_/v1/inventory-item/_inventory_item_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "inventory_item", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_InventoryItemModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "delete": { "tags": [ "inventory item" ], "summary": "Delete inventory item", "operationId": "v1-Operation.DELETE-_owner_/v1/inventory-item/_inventory_item_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "inventory_item", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_InventoryItemModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/pre-advice/{pre_advice}/pre-advice-approval": { "get": { "tags": [ "pre advice" ], "summary": "Get pre advice approval", "operationId": "v1-Operation.GET-_owner_/v1/pre-advice/_pre_advice_/pre-advice-approval", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "pre_advice", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_PreAdviceApprovedModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/pre-advice/{pre_advice}/pre-advice-approval/_values": { "get": { "tags": [ "pre advice" ], "summary": "Available statuses for pre advice approval ", "operationId": "v1-Operation.GET-_owner_/v1/pre-advice/_pre_advice_/pre-advice-approval/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "pre_advice", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/pre-advice": { "get": { "tags": [ "pre advice" ], "summary": "Get all pre advice", "operationId": "v1-Operation.GET_ALL-_owner_/v1/pre-advice", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_PreAdviceModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "post": { "tags": [ "pre advice" ], "summary": "Create pre advice", "operationId": "v1-Operation.CREATE-_owner_/v1/pre-advice", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreAdviceModel" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_PreAdviceModel_" } } } }, "400": { "description": "Bad request. Data not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "415": { "description": "Media type is unsupported. All APIs, unless specified otherwise, only support JSON payloads." }, "413": { "description": "Payload exceeds maximum payload size of 256 kilobytes." }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/pre-advice/{pre_advice}": { "get": { "tags": [ "pre advice" ], "summary": "Get pre advice", "operationId": "v1-Operation.GET-_owner_/v1/pre-advice/_pre_advice_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "pre_advice", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_PreAdviceModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "delete": { "tags": [ "pre advice" ], "summary": "Delete pre advice", "operationId": "v1-Operation.DELETE-_owner_/v1/pre-advice/_pre_advice_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "pre_advice", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_PreAdviceModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}/progress": { "get": { "tags": [ "asn" ], "summary": "Get progress", "operationId": "v1-Operation.GET-_owner_/v1/asn/_asn_/progress", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ASNProgressModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}/progress/_values": { "get": { "tags": [ "asn" ], "summary": "Available statuses for progress ", "operationId": "v1-Operation.GET-_owner_/v1/asn/_asn_/progress/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}/approval": { "get": { "tags": [ "asn" ], "summary": "Get approval", "operationId": "v1-Operation.GET-_owner_/v1/asn/_asn_/approval", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ASNApprovalModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}/approval/_values": { "get": { "tags": [ "asn" ], "summary": "Available statuses for approval ", "operationId": "v1-Operation.GET-_owner_/v1/asn/_asn_/approval/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}/grn/{grn}": { "get": { "tags": [ "asn" ], "summary": "Get grn", "operationId": "v1-Operation.GET-_owner_/v1/asn/_asn_/grn/_grn_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "grn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_GoodsReceivedNoteModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}/grn": { "get": { "tags": [ "asn" ], "summary": "Get all grn", "operationId": "v1-Operation.GET_ALL-_owner_/v1/asn/_asn_/grn", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_GoodsReceivedNoteModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn": { "get": { "tags": [ "asn" ], "summary": "Get all asn", "operationId": "v1-Operation.GET_ALL-_owner_/v1/asn", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_AdvanceShippingNotificationModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "post": { "tags": [ "asn" ], "summary": "Create asn", "operationId": "v1-Operation.CREATE-_owner_/v1/asn", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvanceShippingNotificationModel" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_AdvanceShippingNotificationModel_" } } } }, "400": { "description": "Bad request. Data not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "415": { "description": "Media type is unsupported. All APIs, unless specified otherwise, only support JSON payloads." }, "413": { "description": "Payload exceeds maximum payload size of 256 kilobytes." }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/asn/{asn}": { "get": { "tags": [ "asn" ], "summary": "Get asn", "operationId": "v1-Operation.GET-_owner_/v1/asn/_asn_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_AdvanceShippingNotificationModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "delete": { "tags": [ "asn" ], "summary": "Delete asn", "operationId": "v1-Operation.DELETE-_owner_/v1/asn/_asn_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "asn", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_AdvanceShippingNotificationModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/stock-movement/{stock_movement}": { "get": { "tags": [ "stock movement" ], "summary": "Get stock movement", "operationId": "v1-Operation.GET-_owner_/v1/stock-movement/_stock_movement_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "stock_movement", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_StockMovementModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/stock-movement": { "get": { "tags": [ "stock movement" ], "summary": "Get all stock movement", "operationId": "v1-Operation.GET_ALL-_owner_/v1/stock-movement", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_StockMovementModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/stock-adjustment/{stock_adjustment}": { "get": { "tags": [ "stock adjustment" ], "summary": "Get stock adjustment", "operationId": "v1-Operation.GET-_owner_/v1/stock-adjustment/_stock_adjustment_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "stock_adjustment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_StockAdjustmentModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/stock-adjustment": { "get": { "tags": [ "stock adjustment" ], "summary": "Get all stock adjustment", "operationId": "v1-Operation.GET_ALL-_owner_/v1/stock-adjustment", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_StockAdjustmentModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/approval-status": { "get": { "tags": [ "shipment" ], "summary": "Get approval status", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/approval-status", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ShipmentApprovalStatusModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/approval-status/_values": { "get": { "tags": [ "shipment" ], "summary": "Available statuses for approval status ", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/approval-status/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/progress-status": { "get": { "tags": [ "shipment" ], "summary": "Get progress status", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/progress-status", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/progress-status/_values": { "get": { "tags": [ "shipment" ], "summary": "Available statuses for progress status ", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/progress-status/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/shipment-complete/{shipment_complete}": { "get": { "tags": [ "shipment" ], "summary": "Get shipment complete", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/shipment-complete/_shipment_complete_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment_complete", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ShipmentCompleteModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/shipment-complete": { "get": { "tags": [ "shipment" ], "summary": "Get all shipment complete", "operationId": "v1-Operation.GET_ALL-_owner_/v1/shipment/_shipment_/shipment-complete", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_ShipmentCompleteModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/courier-allocation/{courier_allocation}": { "get": { "tags": [ "shipment" ], "summary": "Get courier allocation", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/courier-allocation/_courier_allocation_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "courier_allocation", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_CourierAllocationModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/courier-allocation": { "get": { "tags": [ "shipment" ], "summary": "Get all courier allocation", "operationId": "v1-Operation.GET_ALL-_owner_/v1/shipment/_shipment_/courier-allocation", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_CourierAllocationModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/tracking/{tracking}": { "get": { "tags": [ "shipment" ], "summary": "Get tracking", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/tracking/_tracking_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "tracking", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_TrackingModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/tracking": { "get": { "tags": [ "shipment" ], "summary": "Get all tracking", "operationId": "v1-Operation.GET_ALL-_owner_/v1/shipment/_shipment_/tracking", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_TrackingModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/return-shipment-receipt/{return_shipment_receipt}": { "get": { "tags": [ "shipment" ], "summary": "Get return shipment receipt", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_/return-shipment-receipt/_return_shipment_receipt_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment_receipt", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ReturnShipmentReceiptModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}/return-shipment-receipt": { "get": { "tags": [ "shipment" ], "summary": "Get all return shipment receipt", "operationId": "v1-Operation.GET_ALL-_owner_/v1/shipment/_shipment_/return-shipment-receipt", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_ReturnShipmentReceiptModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment": { "get": { "tags": [ "shipment" ], "summary": "Get all shipment", "operationId": "v1-Operation.GET_ALL-_owner_/v1/shipment", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_ShipmentModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "post": { "tags": [ "shipment" ], "summary": "Create shipment", "operationId": "v1-Operation.CREATE-_owner_/v1/shipment", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentModel" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ShipmentModel_" } } } }, "400": { "description": "Bad request. Data not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "415": { "description": "Media type is unsupported. All APIs, unless specified otherwise, only support JSON payloads." }, "413": { "description": "Payload exceeds maximum payload size of 256 kilobytes." }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/shipment/{shipment}": { "get": { "tags": [ "shipment" ], "summary": "Get shipment", "operationId": "v1-Operation.GET-_owner_/v1/shipment/_shipment_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ShipmentModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "delete": { "tags": [ "shipment" ], "summary": "Delete shipment", "operationId": "v1-Operation.DELETE-_owner_/v1/shipment/_shipment_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ShipmentModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}/approval-status": { "get": { "tags": [ "return shipment" ], "summary": "Get approval status", "operationId": "v1-Operation.GET-_owner_/v1/return-shipment/_return_shipment_/approval-status", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}/approval-status/_values": { "get": { "tags": [ "return shipment" ], "summary": "Available statuses for approval status ", "operationId": "v1-Operation.GET-_owner_/v1/return-shipment/_return_shipment_/approval-status/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}/progress-status": { "get": { "tags": [ "return shipment" ], "summary": "Get progress status", "operationId": "v1-Operation.GET-_owner_/v1/return-shipment/_return_shipment_/progress-status", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}/progress-status/_values": { "get": { "tags": [ "return shipment" ], "summary": "Available statuses for progress status ", "operationId": "v1-Operation.GET-_owner_/v1/return-shipment/_return_shipment_/progress-status/_values", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_List_ExampleStatus__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}/return-shipment-receipt/{return_shipment_receipt}": { "get": { "tags": [ "return shipment" ], "summary": "Get return shipment receipt", "operationId": "v1-Operation.GET-_owner_/v1/return-shipment/_return_shipment_/return-shipment-receipt/_return_shipment_receipt_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment_receipt", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ReturnShipmentReceiptModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}/return-shipment-receipt": { "get": { "tags": [ "return shipment" ], "summary": "Get all return shipment receipt", "operationId": "v1-Operation.GET_ALL-_owner_/v1/return-shipment/_return_shipment_/return-shipment-receipt", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_ReturnShipmentReceiptModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment": { "get": { "tags": [ "return shipment" ], "summary": "Get all return shipment", "operationId": "v1-Operation.GET_ALL-_owner_/v1/return-shipment", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiDataDocument_List_ReturnShipmentModel__" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "post": { "tags": [ "return shipment" ], "summary": "Create return shipment", "operationId": "v1-Operation.CREATE-_owner_/v1/return-shipment", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnShipmentModel" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ReturnShipmentModel_" } } } }, "400": { "description": "Bad request. Data not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "415": { "description": "Media type is unsupported. All APIs, unless specified otherwise, only support JSON payloads." }, "413": { "description": "Payload exceeds maximum payload size of 256 kilobytes." }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } }, "/{owner}/v1/return-shipment/{return_shipment}": { "get": { "tags": [ "return shipment" ], "summary": "Get return shipment", "operationId": "v1-Operation.GET-_owner_/v1/return-shipment/_return_shipment_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ReturnShipmentModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false }, "delete": { "tags": [ "return shipment" ], "summary": "Delete return shipment", "operationId": "v1-Operation.DELETE-_owner_/v1/return-shipment/_return_shipment_", "parameters": [ { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "owner", "in": "path", "allowEmptyValue": false, "allowReserved": false }, { "required": true, "deprecated": false, "schema": { "type": "string" }, "name": "return_shipment", "in": "path", "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDocument_ReturnShipmentModel_" } } } }, "401": { "description": "Unauthorized access, credentials are invalid." }, "404": { "description": "Not found" }, "403": { "description": "Forbidden access, this is returned when you do not have sufficient permissions to access the resource" }, "429": { "description": "Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again." }, "500": { "description": "Unexpected internal error, could not process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "503": { "description": "The API is currently unavailable, please try again later" }, "504": { "description": "A request timed out while processing, please try again; if it persists try reducing the payload size." } }, "deprecated": false } } }, "components": { "schemas": { "ASNApprovalModel": { "properties": { "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "ASNApprovalModel" }, "ASNProgressModel": { "properties": { "progressMessage": { "type": "string", "title": "Progressmessage", "description": "A message indicating the current progress of the ASN." } }, "type": "object", "required": [ "progressMessage" ], "title": "ASNProgressModel" }, "Address": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Address name (optional)", "examples": [ "John" ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyname", "description": "Name of the company that made the order", "examples": [ "Tech Solutions" ] }, "addressLine1": { "type": "string", "maxLength": 256, "title": "Addressline1", "description": "First line of the address, including the house name or number", "examples": [ "Apt 101" ] }, "addressLine2": { "type": "string", "maxLength": 256, "title": "Addressline2", "description": "Second line of the address, including the street address", "examples": [ "123 Elm St" ] }, "city": { "type": "string", "maxLength": 256, "title": "City", "description": "City of the address", "examples": [ "London", "New York" ] }, "state": { "type": "string", "maxLength": 256, "title": "State", "description": "State or region of the address", "examples": [ "California", "Texas" ] }, "countryCode": { "type": "string", "maxLength": 2, "title": "Countrycode", "description": "Country code of the address in ISO 3166-1 alpha-2 format", "examples": [ "GB" ] }, "postcode": { "type": "string", "maxLength": 256, "title": "Postcode", "description": "Postal code of the address", "examples": [ "90210", "M3 4AG" ] }, "emailAddress": { "type": "string", "maxLength": 256, "title": "Emailaddress", "description": "Email address of the customer", "examples": [ "john.doe@example.com", "jane.smith@company.org" ] }, "phoneNumber": { "type": "string", "maxLength": 16, "title": "Phonenumber", "description": "Phone number of the customer", "examples": [ "+14155552671", "+442071838750", "+551155256325" ] }, "citizenId": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Citizenid", "description": "Citizen ID or identification number of the customer. Mandatory for certain countries, depending on local regulations.", "examples": [ "11010519491231002X", "330102198607058628" ] } }, "type": "object", "required": [ "addressLine1", "addressLine2", "city", "state", "countryCode", "postcode", "emailAddress", "phoneNumber" ], "title": "Address" }, "AdvanceShippingNotificationModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference for the ASN", "examples": [ "ASN-001" ] }, "deliveryReference": { "type": "string", "title": "Deliveryreference", "description": " From the pre-advice acknowledge", "examples": [ "11-111111-111", "DEL-REF-11" ] }, "deliveryPartnersReference": { "type": "string", "title": "Deliverypartnersreference", "description": "The courier or transporters reference", "examples": [ "DPR-001" ] }, "contents": { "items": { "$ref": "#/components/schemas/LogisticsUnit" }, "type": "array", "title": "Contents", "description": "A list of logistics units included in this shipment" }, "deliveryVehicle": { "allOf": [ { "$ref": "#/components/schemas/DeliveryVehicle" } ], "description": "Details about the delivery vehicle transporting the ASN" } }, "type": "object", "required": [ "deliveryReference", "deliveryPartnersReference", "contents", "deliveryVehicle" ], "title": "AdvanceShippingNotificationModel" }, "Barcode": { "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/BarcodeType" } ], "examples": [ "ean" ] }, "barcode": { "type": "string", "title": "Barcode", "examples": [ "12345678" ] } }, "type": "object", "required": [ "type", "barcode" ], "title": "Barcode" }, "BarcodeType": { "type": "string", "enum": [ "codabar", "code128", "code39", "ean", "ean13", "ean13-guard", "ean14", "ean8", "ean8-guard", "gs1", "gs1_128", "gtin", "isbn", "isbn10", "isbn13", "issn", "itf", "jan", "nw-7", "pzn", "upc", "upca" ], "title": "BarcodeType" }, "CompleteShipmentLine": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to the shipment line", "examples": [ "SHIPLINE123", "SHIPLINE456" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "condition": { "allOf": [ { "$ref": "#/components/schemas/StockCondition" } ], "description": "Condition of the stock being shipped", "examples": [ "GOOD", "DAMAGED" ] }, "expectedQuantity": { "type": "integer", "title": "Expectedquantity", "description": "The quantity of items that were requested to be dispatched", "examples": [ 3 ] }, "dispatchedQuantity": { "type": "integer", "title": "Dispatchedquantity", "description": "The quantity of items that have been dispatched", "examples": [ 3 ] }, "batchNumber": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Batchnumber", "description": "Batch number associated with the items dispatched", "examples": [ "BATCH12345", "BATCH67890" ] }, "expiryDate": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ], "title": "Expirydate", "description": "Expiry date of the items dispatched", "examples": [ "2027-12-26" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "title": "Serialnumber", "description": "The serial number captured at dispatch time (if requested)", "examples": [ "SN1234567890", "SN9876543210" ] } }, "type": "object", "required": [ "inventoryItem", "condition", "expectedQuantity", "dispatchedQuantity" ], "title": "CompleteShipmentLine" }, "CourierAllocationModel": { "properties": { "courierService": { "allOf": [ { "$ref": "#/components/schemas/CourierService" } ], "description": "Details of the courier service used", "examples": [ { "name": "UPS", "service": "Express International Shipping" } ] }, "tracking": { "allOf": [ { "$ref": "#/components/schemas/TrackingNumber" } ], "description": "Tracking information for the shipment", "examples": [ { "number": "1Z999AA10123456784", "url": "https://www.ups.com/track?tracknum=1Z999AA10123456784" } ] }, "shippingLabelBarcode": { "type": "string", "maxLength": 256, "title": "Shippinglabelbarcode", "description": "The barcode printed on the shipping label", "examples": [ "THGFUL32400" ] }, "expectedDispatchDate": { "type": "string", "format": "date-time", "title": "Expecteddispatchdate", "description": "Date when the shipment is expected to be dispatched", "examples": [ "2024-12-01T14:00:00.000Z" ] } }, "type": "object", "required": [ "courierService", "tracking", "shippingLabelBarcode", "expectedDispatchDate" ], "title": "CourierAllocationModel" }, "CourierService": { "properties": { "name": { "type": "string", "maxLength": 256, "title": "Name", "description": "Name of the courier service", "examples": [ "DHL", "FedEx", "UPS" ] }, "service": { "type": "string", "maxLength": 256, "title": "Service", "description": "Type of service offered by the courier (e.g., standard, express)", "examples": [ "Standard", "Express", "Overnight" ] } }, "type": "object", "required": [ "name", "service" ], "title": "CourierService" }, "CustomsInformation": { "properties": { "shippingCharge": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Shippingcharge", "description": "Gross value of the charge of shipping the products", "default": "0", "examples": [ "12.99", "50.00" ] }, "shippingTax": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Shippingtax", "description": "Amount of tax applied to the shipping charge", "default": "0", "examples": [ "2.50", "10.00" ] }, "incoterms": { "anyOf": [ { "$ref": "#/components/schemas/Incoterms" }, { "type": "null" } ], "description": "Incoterms for the shipment", "default": "DAP", "examples": [ "DAP", "CFR" ] }, "contentDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contentdescription", "description": "Description of the contents in the shipment", "examples": [ "Electronics including smartphones, laptops, and accessories", "Clothing items: jackets, shirts, and trousers" ] }, "orderCurrency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL" ], "maxLength": 3, "minLength": 3, "title": "Ordercurrency", "description": "Currency used for the order following ISO 4217 currency codes", "examples": [ "GBP" ] }, "replacement": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Replacement", "description": "Indicates if this order is a replacement", "default": false, "examples": [ true, false ] } }, "type": "object", "required": [ "orderCurrency" ], "title": "CustomsInformation" }, "DataDocument": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument" }, "DataDocument_ASNApprovalModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ASNApprovalModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ASNApprovalModel_" }, "DataDocument_ASNProgressModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ASNProgressModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ASNProgressModel_" }, "DataDocument_AdvanceShippingNotificationModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_AdvanceShippingNotificationModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_AdvanceShippingNotificationModel_" }, "DataDocument_CourierAllocationModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_CourierAllocationModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_CourierAllocationModel_" }, "DataDocument_GoodsReceivedNoteModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_GoodsReceivedNoteModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_GoodsReceivedNoteModel_" }, "DataDocument_InventoryItemModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_InventoryItemModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_InventoryItemModel_" }, "DataDocument_List_ExampleStatus__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_List_ExampleStatus__" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_List_ExampleStatus__" }, "DataDocument_PreAdviceApprovedModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_PreAdviceApprovedModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_PreAdviceApprovedModel_" }, "DataDocument_PreAdviceModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_PreAdviceModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_PreAdviceModel_" }, "DataDocument_ReturnShipmentModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ReturnShipmentModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ReturnShipmentModel_" }, "DataDocument_ReturnShipmentReceiptModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ReturnShipmentReceiptModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ReturnShipmentReceiptModel_" }, "DataDocument_ShipmentApprovalStatusModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ShipmentApprovalStatusModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ShipmentApprovalStatusModel_" }, "DataDocument_ShipmentCompleteModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ShipmentCompleteModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ShipmentCompleteModel_" }, "DataDocument_ShipmentModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ShipmentModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ShipmentModel_" }, "DataDocument_StockAdjustmentModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_StockAdjustmentModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_StockAdjustmentModel_" }, "DataDocument_StockMovementModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_StockMovementModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_StockMovementModel_" }, "DataDocument_TrackingModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_TrackingModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_TrackingModel_" }, "DataDocument_ValidStatusModel_": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "allOf": [ { "$ref": "#/components/schemas/Resource_ValidStatusModel_" } ], "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "DataDocument_ValidStatusModel_" }, "DeliveryIssue": { "properties": { "issueReference": { "type": "string", "title": "Issuereference", "description": "Warehouse Identifier for this incident", "examples": [ "ISSUE-123" ] }, "issueType": { "allOf": [ { "$ref": "#/components/schemas/DeliveryIssueType" } ], "description": "Type of issue reported for delivery", "examples": [ "UNEXPECTED_DELIVERY" ] }, "issueDescription": { "anyOf": [ { "type": "string", "maxLength": 300, "description": "A short description of the issue" }, { "type": "null" } ], "title": "Issuedescription", "description": "A short description of the issue reported for the delivery", "examples": [ "Redline delivery" ] }, "photos": { "items": { "type": "string", "format": "reference" }, "type": "array", "title": "Photos", "description": "List of image URL, if available" } }, "type": "object", "required": [ "issueReference", "issueType" ], "title": "DeliveryIssue" }, "DeliveryIssueType": { "type": "string", "enum": [ "UNEXPECTED_DELIVERY", "MISSING_OR_INCORRECT_PAPERWORK", "INCORRECT_LABELING", "VEHICLE_UNSAFE", "DRIVER_ISSUE", "HEALTH_AND_SAFETY" ], "title": "DeliveryIssueType" }, "DeliveryVehicle": { "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/DeliveryVehicleType" } ], "description": "The type of delivery vehicle", "examples": [ "CURTAIN" ] }, "registrationNumber": { "type": "string", "maxLength": 16, "title": "Registrationnumber", "description": "The vehicle's registration number", "examples": [ "AA25AAA" ] }, "driverName": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Drivername", "description": "The driver's name, if available" }, "haulierName": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Hauliername", "description": "The name of the haulier company, if available" } }, "type": "object", "required": [ "type", "registrationNumber" ], "title": "DeliveryVehicle" }, "DeliveryVehicleType": { "type": "string", "enum": [ "CURTAIN", "REAR", "VAN" ], "title": "DeliveryVehicleType" }, "Dimensions": { "properties": { "height": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Height", "description": "shipping height of an inventory item", "examples": [ 1.3 ] }, "width": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Width", "description": "shipping width of the inventory item", "examples": [ 1.3 ] }, "depth": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Depth", "description": "shipping depth of the inventory item", "examples": [ 1.3 ] }, "mass": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Mass", "description": "shipping mass of the inventory item", "examples": [ 1.3 ] } }, "type": "object", "required": [ "height", "width", "depth", "mass" ], "title": "Dimensions" }, "Error": { "properties": { "id": { "type": "string", "title": "ID", "description": "A unique identifier for this particular occurrence of the problem" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ErrorLinks" } ], "title": "Links", "description": "Links explaining the error" }, "status": { "type": "string", "title": "Status Code", "description": "The HTTP status code applicable to this problem" }, "code": { "type": "string", "title": "Error Code", "description": "An application-specific error code" }, "title": { "type": "string", "title": "Title", "description": "A summary of the problem" }, "detail": { "type": "string", "title": "Description", "description": "Explanation specific to this occurrence of the problem" }, "source": { "allOf": [ { "$ref": "#/components/schemas/Source" } ], "title": "Source", "description": "References to the primary source of the error" }, "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} } }, "type": "object", "title": "Error" }, "ErrorDocument": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "errors": { "items": { "$ref": "#/components/schemas/Error" }, "type": "array", "title": "Errors", "description": "An array of error objects" } }, "type": "object", "title": "ErrorDocument" }, "ErrorLinks": { "properties": { "about": { "type": "string", "title": "About", "description": "A link that leads to further details about this particular occurrence of the problem." }, "type": { "type": "string", "title": "Type", "description": "A link that identifies the type of error that this particular error is an instance of." } }, "type": "object", "title": "ErrorLinks" }, "ExampleStatus": { "type": "string", "enum": [ "STATUS_1", "STATUS_2", "STATUS_3" ], "title": "ExampleStatus" }, "GoodsReceivedNoteModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to the ASN", "examples": [ "ASN0003" ] }, "asn": { "type": "string", "format": "reference", "title": "Asn", "description": "A unique reference to the ASN that this GRN is associated with", "examples": [ "thg:asn:provider@987654321" ] }, "stockReceipted": { "allOf": [ { "$ref": "#/components/schemas/StockReceipt" } ], "description": "Details of the stock that has been received" }, "deliveryIssues": { "items": { "$ref": "#/components/schemas/DeliveryIssue" }, "type": "array", "title": "Deliveryissues", "description": "A list of issues encountered during the delivery process" }, "logisticsUnitIssues": { "items": { "$ref": "#/components/schemas/LogisticsUnitIssue" }, "type": "array", "title": "Logisticsunitissues", "description": "A list of issues related to logistics units" }, "stockIssues": { "items": { "$ref": "#/components/schemas/StockIssue" }, "type": "array", "title": "Stockissues", "description": "A list of issues encountered with specific stock items" }, "unidentifiedStockIssues": { "items": { "$ref": "#/components/schemas/UnidentifiedStockIssue" }, "type": "array", "title": "Unidentifiedstockissues", "description": "A list of inventory items that were unidentified at the time of processing" }, "createdAt": { "type": "string", "format": "date-time", "title": "Createdat", "description": "The timestamp indicating when this GRN was created, in ISO 8601 zulu format.", "examples": [ "2024-02-15T12:34:56.789Z" ] } }, "type": "object", "required": [ "asn", "stockReceipted", "deliveryIssues", "logisticsUnitIssues", "stockIssues", "unidentifiedStockIssues", "createdAt" ], "title": "GoodsReceivedNoteModel" }, "Incoterms": { "type": "string", "enum": [ "EXW", "FCA", "FAS", "FOB", "CFR", "CIF", "CPT", "CIP", "DPU", "DAP", "DDP" ], "title": "Incoterms" }, "InventoryItemModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "SKU for the inventory item", "examples": [ "12345" ] }, "title": { "type": "string", "title": "Title", "description": "name of inventory item", "examples": [ "cd" ] }, "defaultCountryOfOrigin": { "anyOf": [ { "type": "string", "pattern": "^\\w{2}$" }, { "type": "null" } ], "title": "Defaultcountryoforigin", "description": "Origin country for the inventory item in ISO 3166-1 (Alpha 2)", "examples": [ "GB" ] }, "harmonizedSystemCode": { "anyOf": [ { "type": "string", "maxLength": 12, "minLength": 12 }, { "type": "null" } ], "title": "Harmonizedsystemcode", "description": "A code for international trade. This must be string of digits of length 12. trade.gov - hsCodes", "examples": [ "999999999999" ] }, "hazmatCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hazmatcode", "description": "The UN Number for identifying hazardous material", "examples": [ "3811" ] }, "barcodes": { "items": { "$ref": "#/components/schemas/Barcode" }, "type": "array", "title": "Barcodes", "description": "The barcodes that can be physically attached to the item", "examples": [ { "barcode": "1234", "type": "codabar" } ] }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/Dimensions" } ], "description": "The dimensions of the item in supply chain. i.e. Boxed dimensions", "examples": [ { "depth": "1.3", "height": "1.3", "mass": "1.3", "width": "1.3" } ] }, "batchControlled": { "type": "boolean", "title": "Batchcontrolled", "description": "Boolean Flag to denote if a product is batch controlled or not", "examples": [ true, false ] }, "description": { "type": "string", "title": "Description", "description": "A textual description of the inventory item" }, "type": { "type": "string", "title": "Type", "description": "The type or category of the inventory item" }, "serialNumberControlled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Serialnumbercontrolled", "description": "Specifies whether the serial number needs to be recorded for this item", "default": false, "examples": [ true, false ] } }, "type": "object", "required": [ "title", "barcodes", "dimensions", "batchControlled", "description", "type" ], "title": "InventoryItemModel" }, "Links": { "properties": { "self": { "type": "string", "title": "Self Link", "description": "Link to the current resource." }, "related": { "type": "string", "title": "Related Link", "description": "Link of a related resource." }, "describedBy": { "type": "string", "title": "Self Link", "description": "Link to API documentation for that resource." } }, "type": "object", "required": [ "self" ], "title": "Links" }, "LogisticsUnit": { "properties": { "reference": { "type": "string", "title": "Reference", "description": "SSCC or some other box, pallet reference agreed with the warehouse", "examples": [ "11111111111111" ] }, "logisticsUnits": { "items": { "title": "LogisticsUnit", "description": "LogisticsUnit", "$ref": "#/components/schemas/__LogisticsUnit" }, "type": "array", "title": "Logisticsunits", "description": "A list of logistics units placed on in this logistic unit" }, "inventoryItems": { "items": { "$ref": "#/components/schemas/LogisticsUnitContent" }, "type": "array", "title": "Inventoryitems", "description": "A list of items placed on in this logistic unit" }, "referenceType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitReferenceType" } ], "description": "The type of reference used for identifying the logistics unit", "examples": [ "SSCC" ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitType" } ], "description": "The type of logistics unit, such as a PALLET or CARTON", "examples": [ "PALLET" ] } }, "type": "object", "required": [ "reference", "logisticsUnits", "inventoryItems", "referenceType", "type" ], "title": "LogisticsUnit" }, "LogisticsUnitContent": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to this logistic unit content", "examples": [ "PROD12345", "LUC001" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "quantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Quantity", "description": "The quantity of this item in the logistics unit", "examples": [ 5 ] }, "condition": { "anyOf": [ { "$ref": "#/components/schemas/StockCondition" }, { "type": "null" } ], "description": "The condition of the inventory item (e.g., GOOD, DAMAGED, EXPIRED). Defaults to GOOD", "default": "GOOD", "examples": [ "GOOD" ] }, "batchNumber": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Batchnumber", "description": "The batch number associated with this logistic unit content, if applicable", "examples": [ "BATCH123" ] }, "batchExpiry": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ], "title": "Batchexpiry", "description": "The expiry date of the batch, if applicable", "examples": [ "2027-12-01" ] } }, "type": "object", "required": [ "inventoryItem", "quantity" ], "title": "LogisticsUnitContent" }, "LogisticsUnitIssue": { "properties": { "issueReference": { "type": "string", "title": "Issuereference", "description": "Warehouse Identifier for this incident" }, "reference": { "type": "string", "title": "Reference", "description": " SSCC or some other box, pallet reference agreed with the warehouse" }, "referenceType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitReferenceType" } ], "description": "The type of reference used for identifying the logistics unit", "examples": [ "SSCC" ] }, "issueType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitIssueType" } ], "description": "The type of issue reported on the logistics unit", "examples": [ "INCORRECT_LABELING" ] }, "issueDescription": { "anyOf": [ { "type": "string", "maxLength": 300, "description": "A short description of the issue" }, { "type": "null" } ], "title": "Issuedescription", "description": "A short description of the issue reported for logistic units for the delivery", "examples": [ "Missing manifest" ] }, "photos": { "items": { "type": "string", "format": "reference" }, "type": "array", "title": "Photos", "description": "List of image URL, if available" } }, "type": "object", "required": [ "issueReference", "reference", "referenceType", "issueType" ], "title": "LogisticsUnitIssue" }, "LogisticsUnitIssueType": { "type": "string", "enum": [ "OTHER", "MISSING_OR_INCORRECT_PAPERWORK", "INCORRECT_LABELING", "HEALTH_AND_SAFETY", "VEHICLE_UNSAFE" ], "title": "LogisticsUnitIssueType" }, "LogisticsUnitReferenceType": { "type": "string", "enum": [ "SSCC", "DELIVERY_REFERENCE", "OTHER" ], "title": "LogisticsUnitReferenceType" }, "LogisticsUnitType": { "type": "string", "enum": [ "PALLET", "CARTON" ], "title": "LogisticsUnitType" }, "MultiDataDocument_List_AdvanceShippingNotificationModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_AdvanceShippingNotificationModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_AdvanceShippingNotificationModel__" }, "MultiDataDocument_List_CourierAllocationModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_CourierAllocationModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_CourierAllocationModel__" }, "MultiDataDocument_List_GoodsReceivedNoteModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_GoodsReceivedNoteModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_GoodsReceivedNoteModel__" }, "MultiDataDocument_List_InventoryItemModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_InventoryItemModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_InventoryItemModel__" }, "MultiDataDocument_List_PreAdviceModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_PreAdviceModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_PreAdviceModel__" }, "MultiDataDocument_List_ReturnShipmentModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_ReturnShipmentModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_ReturnShipmentModel__" }, "MultiDataDocument_List_ReturnShipmentReceiptModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_ReturnShipmentReceiptModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_ReturnShipmentReceiptModel__" }, "MultiDataDocument_List_ShipmentCompleteModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_ShipmentCompleteModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_ShipmentCompleteModel__" }, "MultiDataDocument_List_ShipmentModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_ShipmentModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_ShipmentModel__" }, "MultiDataDocument_List_StockAdjustmentModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_StockAdjustmentModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_StockAdjustmentModel__" }, "MultiDataDocument_List_StockMovementModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_StockMovementModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_StockMovementModel__" }, "MultiDataDocument_List_TrackingModel__": { "properties": { "meta": { "type": "object", "title": "Metadata", "description": "A meta object that contains non-standard meta-information", "default": {} }, "data": { "items": { "$ref": "#/components/schemas/Resource_List_TrackingModel__" }, "type": "array", "title": "Data", "description": "The document's 'primary data'." }, "links": { "allOf": [ { "$ref": "#/components/schemas/PaginatedLinks" } ], "title": "Links", "description": "A links object related to the primary data" } }, "type": "object", "title": "MultiDataDocument_List_TrackingModel__" }, "OrderInformation": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to the customer order to which this shipment belongs", "examples": [ "ORD12345", "REF67890" ] } }, "type": "object", "title": "OrderInformation" }, "PaginatedLinks": { "properties": { "self": { "type": "string", "title": "Self Link", "description": "Link to the current resource." }, "related": { "type": "string", "title": "Related Link", "description": "Link of a related resource." }, "next": { "type": "string", "title": "Next Link", "description": "Link of the next page." }, "prev": { "type": "string", "title": "Previous Link", "description": "Link of the previous page." }, "first": { "type": "string", "title": "First Link", "description": "Link of the first page." }, "describedBy": { "type": "string", "title": "Self Link", "description": "Link to API documentation for that resource." } }, "type": "object", "required": [ "self" ], "title": "PaginatedLinks" }, "PreAdviceApprovedModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to this pre-advice", "examples": [ "REF-12345" ] }, "deliveryReference": { "type": "string", "title": "Deliveryreference", "description": "The reference identifier to be used on the ASN" }, "expectedDeliveryDate": { "type": "string", "format": "date-time", "title": "Expecteddeliverydate", "description": "The expected arrival date of the delivery in ISO 8601 Zulu format", "examples": [ "2024-12-01T14:00:00.000Z" ] } }, "type": "object", "required": [ "deliveryReference", "expectedDeliveryDate" ], "title": "PreAdviceApprovedModel" }, "PreAdviceDelivery": { "properties": { "estimatedNumberOfLogisticsUnits": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Estimatednumberoflogisticsunits", "description": "Estimated number of logistics units in the delivery, must be a positive non-zero", "examples": [ 5 ] }, "logisticsUnitType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitType" } ], "description": "Type of logistics unit being delivered", "examples": [ "PALLET" ] }, "requestedDeliveryDate": { "type": "string", "format": "date-time", "title": "Requesteddeliverydate", "description": "Date and time when the delivery is requested, in ISO 8601 Zulu format", "examples": [ "2024-12-01T14:00:00.000Z" ] }, "deliveryType": { "allOf": [ { "$ref": "#/components/schemas/configs__goods_in__preadvice__DeliveryType" } ], "description": "Mode of delivery, such as FREIGHT or COURIER.", "examples": [ "FREIGHT" ] } }, "type": "object", "required": [ "estimatedNumberOfLogisticsUnits", "logisticsUnitType", "requestedDeliveryDate", "deliveryType" ], "title": "PreAdviceDelivery" }, "PreAdviceItem": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to the pre advice item", "examples": [ "PRO1234", "INV-123" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "advisedQuantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Advisedquantity", "description": "The quantity of this item", "examples": [ 5 ] }, "advisedCondition": { "anyOf": [ { "$ref": "#/components/schemas/StockCondition" }, { "type": "null" } ], "description": "The condition of the inventory item (e.g., GOOD, DAMAGED, EXPIRED). Defaults to GOOD", "default": "GOOD", "examples": [ "GOOD" ] } }, "type": "object", "required": [ "inventoryItem", "advisedQuantity" ], "title": "PreAdviceItem" }, "PreAdviceModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to this pre-advice", "examples": [ "REF-12345" ] }, "delivery": { "allOf": [ { "$ref": "#/components/schemas/PreAdviceDelivery" } ], "description": "Details of the this pre-advice delivery" }, "inventoryItems": { "items": { "$ref": "#/components/schemas/PreAdviceItem" }, "type": "array", "minItems": 1, "title": "Inventoryitems", "description": "List of inventory items included in the pre-advice, must contain at least one item" } }, "type": "object", "required": [ "delivery", "inventoryItems" ], "title": "PreAdviceModel" }, "ReceivedLogisticsUnit": { "properties": { "reference": { "type": "string", "title": "Reference", "description": "SSCC or some other box, pallet reference agreed with the warehouse", "examples": [ "11111111111111" ] }, "inventoryItems": { "items": { "$ref": "#/components/schemas/ReceivedLogisticsUnitContent" }, "type": "array", "title": "Inventoryitems", "description": "List of items received on this logistic unit" }, "logisticsUnits": { "items": { "title": "ReceivedLogisticsUnit", "description": "ReceivedLogisticsUnit", "$ref": "#/components/schemas/__ReceivedLogisticsUnit" }, "type": "array", "title": "Logisticsunits", "description": "List of logistic units received on this logistic unit" }, "referenceType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitReferenceType" } ], "description": "The type of reference used for identifying the logistics unit", "examples": [ "SSCC" ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitType" } ], "description": "The type of logistics unit, such as a PALLET or CARTON", "examples": [ "PALLET" ] } }, "type": "object", "required": [ "reference", "inventoryItems", "logisticsUnits", "referenceType", "type" ], "title": "ReceivedLogisticsUnit" }, "ReceivedLogisticsUnitContent": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to this logistic unit content" }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@123456789" ] }, "expectedQuantity": { "type": "integer", "title": "Expectedquantity", "description": "The quantity expected in the delivery", "examples": [ 10 ] }, "receivedQuantity": { "type": "integer", "title": "Receivedquantity", "description": "The quantity received in the delivery", "examples": [ 10 ] }, "receivedBatch": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Receivedbatch", "description": "Batch number of the received goods, if applicable", "examples": [ "BATCH001" ] }, "receivedBatchExpiry": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ], "title": "Receivedbatchexpiry", "description": "Expiry date of the received batch, if applicable", "examples": [ "2028-01-01" ] }, "condition": { "allOf": [ { "$ref": "#/components/schemas/StockCondition" } ], "description": "The condition of the inventory item received", "examples": [ "GOOD" ] } }, "type": "object", "required": [ "inventoryItem", "expectedQuantity", "receivedQuantity", "condition" ], "title": "ReceivedLogisticsUnitContent" }, "Resource": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource" }, "Resource_ASNApprovalModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ASNApprovalModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ASNApprovalModel_" }, "Resource_ASNProgressModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ASNProgressModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ASNProgressModel_" }, "Resource_AdvanceShippingNotificationModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/AdvanceShippingNotificationModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_AdvanceShippingNotificationModel_" }, "Resource_CourierAllocationModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/CourierAllocationModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_CourierAllocationModel_" }, "Resource_GoodsReceivedNoteModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/GoodsReceivedNoteModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_GoodsReceivedNoteModel_" }, "Resource_InventoryItemModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/InventoryItemModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_InventoryItemModel_" }, "Resource_List_AdvanceShippingNotificationModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/AdvanceShippingNotificationModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_AdvanceShippingNotificationModel__" }, "Resource_List_CourierAllocationModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/CourierAllocationModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_CourierAllocationModel__" }, "Resource_List_ExampleStatus__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/ExampleStatus" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_ExampleStatus__" }, "Resource_List_GoodsReceivedNoteModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/GoodsReceivedNoteModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_GoodsReceivedNoteModel__" }, "Resource_List_InventoryItemModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/InventoryItemModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_InventoryItemModel__" }, "Resource_List_PreAdviceModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/PreAdviceModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_PreAdviceModel__" }, "Resource_List_ReturnShipmentModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/ReturnShipmentModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_ReturnShipmentModel__" }, "Resource_List_ReturnShipmentReceiptModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/ReturnShipmentReceiptModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_ReturnShipmentReceiptModel__" }, "Resource_List_ShipmentCompleteModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/ShipmentCompleteModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_ShipmentCompleteModel__" }, "Resource_List_ShipmentModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/ShipmentModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_ShipmentModel__" }, "Resource_List_StockAdjustmentModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/StockAdjustmentModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_StockAdjustmentModel__" }, "Resource_List_StockMovementModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/StockMovementModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_StockMovementModel__" }, "Resource_List_TrackingModel__": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "items": { "$ref": "#/components/schemas/TrackingModel" }, "type": "array", "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_List_TrackingModel__" }, "Resource_PreAdviceApprovedModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/PreAdviceApprovedModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_PreAdviceApprovedModel_" }, "Resource_PreAdviceModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/PreAdviceModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_PreAdviceModel_" }, "Resource_ReturnShipmentModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ReturnShipmentModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ReturnShipmentModel_" }, "Resource_ReturnShipmentReceiptModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ReturnShipmentReceiptModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ReturnShipmentReceiptModel_" }, "Resource_ShipmentApprovalStatusModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ShipmentApprovalStatusModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ShipmentApprovalStatusModel_" }, "Resource_ShipmentCompleteModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ShipmentCompleteModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ShipmentCompleteModel_" }, "Resource_ShipmentModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ShipmentModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ShipmentModel_" }, "Resource_StockAdjustmentModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/StockAdjustmentModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_StockAdjustmentModel_" }, "Resource_StockMovementModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/StockMovementModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_StockMovementModel_" }, "Resource_TrackingModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/TrackingModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_TrackingModel_" }, "Resource_ValidStatusModel_": { "properties": { "id": { "type": "string", "title": "Entity ID", "description": "Unique ID of the Entity" }, "type": { "type": "string", "title": "Entity Type", "description": "Type of entity" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of the API" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/ValidStatusModel" } ], "title": "Entity Data", "description": "This contains a data blob of the entity, this is where the main payload of data is" }, "links": { "allOf": [ { "$ref": "#/components/schemas/Links" } ], "title": "Links", "description": "Links to any relevant information or entities" }, "meta": { "type": "object", "title": "Metadata", "description": "Additional information about the entity which isn't provided in the main data blob", "default": {} } }, "type": "object", "required": [ "id", "type" ], "title": "Resource_ValidStatusModel_" }, "ReturnShipmentLineModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to the return shipment line", "examples": [ "20410467" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "quantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Quantity", "description": "The number of units of this item being returned", "examples": [ 1 ] }, "dispose": { "type": "boolean", "title": "Dispose", "description": "Indicates whether the returned item should be disposed", "examples": [ true, false ] } }, "type": "object", "required": [ "inventoryItem", "quantity", "dispose" ], "title": "ReturnShipmentLineModel" }, "ReturnShipmentModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference for this return", "examples": [ "20410467" ] }, "returnShippingLabelBarcode": { "type": "string", "maxLength": 36, "title": "Returnshippinglabelbarcode", "description": "The unique identifier encoded as barcode on the outside of the parcel", "examples": [ "RS123" ] }, "returnItems": { "items": { "$ref": "#/components/schemas/ReturnShipmentLineModel" }, "type": "array", "title": "Returnitems", "description": "The list of items being returned", "examples": [ [ { "consumerReference": "10530476", "dispose": true, "inventoryItem": "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb", "quantity": 1 }, { "consumerReference": "12854140", "dispose": false, "inventoryItem": "thg:inventory:owner@1e927dab-945b-4036-a61e-c5afc82d9cec", "quantity": 2 } ] ] } }, "type": "object", "required": [ "returnShippingLabelBarcode", "returnItems" ], "title": "ReturnShipmentModel" }, "ReturnShipmentReceiptLineModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to the return shipment line", "examples": [ "10530476" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "quantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Quantity", "description": "The number of units of this item that were returned", "examples": [ 1 ] }, "condition": { "allOf": [ { "$ref": "#/components/schemas/ReturnShipmentStockCondition" } ], "description": "The condition of the item upon receipt at the warehouse", "examples": [ "GOOD", "DAMAGED" ] } }, "type": "object", "required": [ "inventoryItem", "quantity", "condition" ], "title": "ReturnShipmentReceiptLineModel" }, "ReturnShipmentReceiptModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference for this return, provided at the return shipment creation", "examples": [ "20410467" ] }, "items": { "items": { "$ref": "#/components/schemas/ReturnShipmentReceiptLineModel" }, "type": "array", "title": "Items", "description": "List of items that were returned", "examples": [ [ { "condition": "DAMAGED", "consumerReference": "10530476", "inventoryItem": "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb", "quantity": 1 }, { "condition": "GOOD", "consumerReference": "12854140", "inventoryItem": "thg:inventory:owner@1e927dab-945b-4036-a61e-c5afc82d9cec", "quantity": 2 } ] ] } }, "type": "object", "required": [ "items" ], "title": "ReturnShipmentReceiptModel" }, "ReturnShipmentStockCondition": { "type": "string", "enum": [ "GOOD", "DAMAGED" ], "title": "ReturnShipmentStockCondition" }, "ShipmentApprovalStatusModel": { "properties": { "courierAllocation": { "type": "string", "format": "reference", "title": "Courierallocation", "description": "Reference for the courier allocation created for this shipment", "examples": [ "thg:courierallocation:owner@d1e6e204-596f-40e8-82ce-d5d4f514293f" ] } }, "type": "object", "required": [ "courierAllocation" ], "title": "ShipmentApprovalStatusModel" }, "ShipmentBehaviour": { "properties": { "fillOrKill": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fillorkill", "description": "Indicates whether the shipment is fulfilled in its entirety", "default": false, "examples": [ true, false ] } }, "type": "object", "title": "ShipmentBehaviour" }, "ShipmentCompleteModel": { "properties": { "consumerOrderReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerorderreference", "description": "Consumer's reference for the completed shipment's order provided at shipment creation", "examples": [ "ORDER9876", "ORDER1234" ] }, "consumerShipmentReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumershipmentreference", "description": "Consumer's reference for the completed shipment provided at shipment creation", "examples": [ "SHIP12345", "SHIP67890" ] }, "inventoryItems": { "items": { "$ref": "#/components/schemas/CompleteShipmentLine" }, "type": "array", "title": "Inventoryitems", "description": "List of items that were dispatched", "examples": [ [ { "batchNumber": "W431743636", "condition": "GOOD", "consumerReference": "10530476", "dispatchedQuantity": 10, "expectedQuantity": 10, "expiryDate": "2026-05-01", "inventoryItem": "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb", "serialNumber": "1234-5678-90AB-CDEF" }, { "batchNumber": null, "condition": "GOOD", "consumerReference": "10974165", "dispatchedQuantity": 5, "expectedQuantity": 7, "expiryDate": null, "inventoryItem": "thg:inventory:owner@1e927dab-945b-4036-a61e-c5afc82d9cec", "serialNumber": null } ] ] }, "courierAllocation": { "type": "string", "format": "reference", "title": "Courierallocation", "description": "Reference identifier for the courier allocation of the shipment", "examples": [ "thg:courierallocation:owner@d1e6e204-596f-40e8-82ce-d5d4f514293f" ] }, "dispatchDate": { "type": "string", "format": "date-time", "title": "Dispatchdate", "description": "Date when the shipment was dispatched", "examples": [ "2024-12-01T14:00:00.000Z" ] } }, "type": "object", "required": [ "inventoryItems", "courierAllocation", "dispatchDate" ], "title": "ShipmentCompleteModel" }, "ShipmentLine": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference of the shipment line", "examples": [ "PROD12345", "INV78910" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "quantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Quantity", "description": "The quantity of this item being shipped", "examples": [ 5 ] }, "condition": { "anyOf": [ { "$ref": "#/components/schemas/StockCondition" }, { "type": "null" } ], "description": "Condition of the stock being shipped", "default": "GOOD", "examples": [ "GOOD" ] }, "unitValue": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Unitvalue", "description": "Gross price of a single unit of this item", "examples": [ "3" ] } }, "type": "object", "required": [ "inventoryItem", "quantity", "unitValue" ], "title": "ShipmentLine" }, "ShipmentModel": { "properties": { "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference for this shipment", "examples": [ "SHIP12345", "REF78901" ] }, "deliveryAddress": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Delivery address for the shipment", "examples": [ { "addressLine1": "Apt 101", "addressLine2": "123 Elm St", "citizenId": "11010519491231002X", "city": "Los Angeles", "companyName": "Tech Solutions", "countryCode": "US", "emailAddress": "john.doe@example.com", "name": "John", "phoneNumber": "+14155552671", "postcode": "90210", "state": "California" } ] }, "orderInformation": { "anyOf": [ { "$ref": "#/components/schemas/OrderInformation" }, { "type": "null" } ], "description": "Information related to the order being shipped", "examples": [ { "consumerReference": "ORD12345" } ] }, "customsInformation": { "allOf": [ { "$ref": "#/components/schemas/CustomsInformation" } ], "description": "Customs information for the shipment", "examples": [ { "contentDescription": "Electronics including smartphones, laptops, and accessories", "incoterms": "DAP", "orderCurrency": "GBP", "replacement": true, "shippingCharge": "12.199999999999999289457264239899814128875732421875", "shippingTax": "2.5" } ] }, "inventoryItems": { "items": { "$ref": "#/components/schemas/ShipmentLine" }, "type": "array", "title": "Inventoryitems", "description": "List of items in the shipment", "examples": [ [ { "condition": "GOOD", "consumerReference": "10530476", "inventoryItem": "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb", "quantity": 1, "unitValue": "3" }, { "condition": "GOOD", "consumerReference": "12854140", "inventoryItem": "thg:inventory:owner@1e927dab-945b-4036-a61e-c5afc82d9cec", "quantity": 2, "unitValue": "4" } ] ] }, "shipmentBehaviour": { "allOf": [ { "$ref": "#/components/schemas/ShipmentBehaviour" } ], "description": "Behaviour settings for the shipment", "examples": [ { "fillOrKill": true } ] }, "shipmentType": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentType" }, { "type": "null" } ], "description": "Type of the shipment", "default": "B2C", "examples": [ "B2C", "B2B" ] }, "deliveryType": { "allOf": [ { "$ref": "#/components/schemas/configs__dispatch__dispatch_api__DeliveryType" } ], "description": "Delivery type of the shipment", "examples": [ "UK_STANDARD", "CLICK_AND_COLLECT_UK_STANDARD" ] } }, "type": "object", "required": [ "deliveryAddress", "customsInformation", "inventoryItems", "shipmentBehaviour", "deliveryType" ], "title": "ShipmentModel" }, "ShipmentType": { "type": "string", "enum": [ "B2B", "B2C", "RTS", "IWT" ], "title": "ShipmentType" }, "Source": { "properties": { "pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pointer", "description": "This is an address to where in the body the error occurred. This uses dot notation for the address." }, "parameter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parameter", "description": "When an error occurs due to a parameter value the key is referenced here." }, "header": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Header", "description": "When an error occurs due to a header value the key is referenced here." } }, "type": "object", "title": "Source" }, "StockAdjustmentModel": { "properties": { "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem" }, "warehouseReference": { "type": "string", "maxLength": 20, "title": "Warehousereference", "description": "A reference for this stock adjustment", "examples": [ "VGREx1290fe" ] }, "condition": { "$ref": "#/components/schemas/StockCondition" }, "occurredAt": { "type": "string", "format": "date-time", "title": "Occurredat" }, "quantity": { "type": "integer", "title": "Quantity" } }, "type": "object", "required": [ "inventoryItem", "warehouseReference", "condition", "occurredAt", "quantity" ], "title": "StockAdjustmentModel" }, "StockCondition": { "type": "string", "enum": [ "GOOD", "DAMAGED", "HELD", "TRANSFER" ], "title": "StockCondition" }, "StockEventCauseType": { "type": "string", "enum": [ "EXPECTED_RETURN", "COURIER_RETURN", "RECEIPT", "DISPATCH", "STOCK_ADJ", "CORRECTION" ], "title": "StockEventCauseType" }, "StockIssue": { "properties": { "issueReference": { "type": "string", "title": "Issuereference", "description": "Warehouse Identifier for this incident", "examples": [ "ISSUE-789" ] }, "consumerReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerreference", "description": "Consumer's reference to this logistic unit content on ASN", "examples": [ "PROD12345", "LUC001" ] }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem", "description": "Reference to the inventory item", "examples": [ "thg:inventory:owner@4489a5ce-0c25-4a5e-84c5-b5211c0d36bb" ] }, "receivedBatchNumber": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Receivedbatchnumber", "description": "The batch number associated with received logistic unit, if applicable", "examples": [ "BATCH123" ] }, "receivedBatchExpiry": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ], "title": "Receivedbatchexpiry", "description": "The expiry date of the batch, if applicable", "examples": [ "2027-12-01" ] }, "issueQuantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Issuequantity", "description": "The quantity of this item in the received logistics unit", "examples": [ 51 ] }, "issueType": { "allOf": [ { "$ref": "#/components/schemas/StockIssueType" } ], "description": "The type of issue reported on this item in the received logistics unit", "examples": [ "PRODUCT_NOT_AS_DESCRIBED" ] }, "issueDescription": { "anyOf": [ { "type": "string", "maxLength": 300, "description": "A short description of the issue" }, { "type": "null" } ], "title": "Issuedescription", "description": "A short description of the issue reported for inventory item for the delivery", "examples": [ "Product label description does not match" ] }, "photos": { "items": { "type": "string", "format": "reference" }, "type": "array", "title": "Photos", "description": "List of image URL, if available" } }, "type": "object", "required": [ "issueReference", "inventoryItem", "issueQuantity", "issueType" ], "title": "StockIssue" }, "StockIssueType": { "type": "string", "enum": [ "HEALTH_AND_SAFETY", "PRODUCT_NOT_AS_DESCRIBED", "UNSUITABLE_PACKAGING", "MISSING_OR_INVALID_BATCH_EXPIRY_INFORMATION", "OTHER", "DAMAGED_GOODS", "INCORRECT_LABELING", "MISSING_OR_INCORRECT_PAPERWORK" ], "title": "StockIssueType" }, "StockMovementModel": { "properties": { "consumerInventoryItemReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumerinventoryitemreference", "description": "SKU for the inventory item", "examples": [ "12345" ] }, "stockEventCauseType": { "$ref": "#/components/schemas/StockEventCauseType" }, "inventoryItem": { "type": "string", "format": "reference", "title": "Inventoryitem" }, "cause": { "type": "string", "format": "reference", "title": "Cause" }, "condition": { "$ref": "#/components/schemas/StockCondition" }, "quantity": { "type": "integer", "title": "Quantity" }, "occurredAt": { "type": "string", "format": "date-time", "title": "Occurredat" } }, "type": "object", "required": [ "stockEventCauseType", "inventoryItem", "cause", "condition", "quantity", "occurredAt" ], "title": "StockMovementModel" }, "StockReceipt": { "properties": { "contents": { "items": { "$ref": "#/components/schemas/ReceivedLogisticsUnit" }, "type": "array", "title": "Contents", "description": "List of received logistic unit on this delivery" } }, "type": "object", "required": [ "contents" ], "title": "StockReceipt" }, "TrackingEvent": { "properties": { "eventDate": { "type": "string", "format": "date-time", "title": "Eventdate", "description": "Timestamp in ISO 8601 Zulu format indicating when the event was created by the courier provider", "examples": [ "2024-12-01T14:00:00.000Z" ] }, "courierMessage": { "type": "string", "maxLength": 255, "title": "Couriermessage", "description": "Detailed message received from the courier, this may include the customer's name", "examples": [ "I155", "I101" ] }, "trackingStatus": { "type": "string", "maxLength": 255, "title": "Trackingstatus", "description": "A concise message representing the shipment's current status, formatted as an ENUM", "examples": [ "In transit", "Arrival at Hub" ] }, "description": { "type": "string", "maxLength": 255, "title": "Description", "description": "A detailed, human-readable description of the tracking status", "examples": [ "The shipment is in transit", "The shipment has arrived at the carrier's hub" ] } }, "type": "object", "required": [ "eventDate", "courierMessage", "trackingStatus", "description" ], "title": "TrackingEvent" }, "TrackingModel": { "properties": { "trackingNumber": { "type": "string", "title": "Trackingnumber" }, "activelyTracking": { "type": "boolean", "title": "Activelytracking", "description": "Whether the order is still in transit or not confirmed delivered", "examples": [ true, false ] }, "terminalState": { "type": "boolean", "title": "Terminalstate", "description": "Delivered/returned/lost = true, meaning we no longer fetch tracking", "examples": [ true, false ] }, "event": { "allOf": [ { "$ref": "#/components/schemas/TrackingEvent" } ], "description": "Unique shipment update for its tracking progression. this could be, shipmentDataReceived->inTransit->OutForDelivery->Delivered", "examples": [ { "courierMessage": "I155", "description": "The shipment is in transit", "eventDate": "2024-12-01T14:00:00Z", "trackingStatus": "In transit" }, { "courierMessage": "I101", "description": "The shipment has arrived at the Carriers Hub", "eventDate": "2024-12-02T14:00:00Z", "trackingStatus": "Arrival at Hub" } ] } }, "type": "object", "required": [ "activelyTracking", "terminalState", "event" ], "title": "TrackingModel" }, "TrackingNumber": { "properties": { "number": { "type": "string", "maxLength": 256, "title": "Number", "description": "Tracking number for the shipment", "examples": [ "1Z999AA10123456784", "ABC123456789" ] }, "url": { "type": "string", "maxLength": 256, "title": "Url", "description": "URL for tracking the shipment", "examples": [ "https://www.courier.com/track/1Z999AA10123456784", "https://www.fedex.com/tracking/ABC123456789" ] } }, "type": "object", "required": [ "number", "url" ], "title": "TrackingNumber" }, "UnidentifiedStockIssue": { "properties": { "issueReference": { "type": "string", "title": "Issuereference", "description": "Warehouse Identifier for this incident" }, "barcode": { "type": "string", "maxLength": 20, "title": "Barcode", "description": "The barcode on the product that cannot be identified" }, "issueQuantity": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Issuequantity", "description": "The quantity of this unidentified inventory item for the delivery", "examples": [ 5 ] }, "issueType": { "allOf": [ { "$ref": "#/components/schemas/UnidentifiedStockIssueType" } ], "description": "The type of issue reported for unidentified inventory item for the delivery", "examples": [ "INCORRECT_LABELING" ] }, "issueDescription": { "anyOf": [ { "type": "string", "maxLength": 300, "description": "A short description of the issue" }, { "type": "null" } ], "title": "Issuedescription", "description": "A short description of the issue reported for unidentified inventory item for the delivery", "examples": [ "Unlabeled item found in ASN" ] }, "photos": { "items": { "type": "string", "format": "reference" }, "type": "array", "title": "Photos", "description": "List of image URL, if available" } }, "type": "object", "required": [ "issueReference", "barcode", "issueQuantity", "issueType" ], "title": "UnidentifiedStockIssue" }, "UnidentifiedStockIssueType": { "type": "string", "enum": [ "HEALTH_AND_SAFETY", "UNSUITABLE_PACKAGING", "OTHER", "INCORRECT_LABELING", "UNIDENTIFIED_PRODUCT", "MISSING_OR_INCORRECT_PAPERWORK" ], "title": "UnidentifiedStockIssueType" }, "ValidStatusModel": { "properties": { "message": { "type": "string", "maxLength": 300, "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "ValidStatusModel" }, "configs__dispatch__dispatch_api__DeliveryType": { "type": "string", "enum": [ "UK_STANDARD", "UK_NEXT_DAY", "INTERNATIONAL_TRACKED", "WORLD_WIDE_EXPRESS", "CLICK_AND_COLLECT_UK_STANDARD", "CLICK_AND_COLLECT_INTERNATIONAL_STANDARD" ], "title": "DeliveryType" }, "configs__goods_in__preadvice__DeliveryType": { "type": "string", "enum": [ "FREIGHT", "COURIER" ], "title": "DeliveryType" }, "__LogisticsUnit": { "properties": { "reference": { "type": "string", "title": "Reference", "description": "SSCC or some other box, pallet reference agreed with the warehouse", "examples": [ "11111111111111" ] }, "logisticsUnits": { "items": { "title": "LogisticsUnit", "description": "LogisticsUnit", "type": "object" }, "type": "array", "title": "Logisticsunits", "description": "A list of logistics units placed on in this logistic unit" }, "inventoryItems": { "items": { "$ref": "#/components/schemas/LogisticsUnitContent" }, "type": "array", "title": "Inventoryitems", "description": "A list of items placed on in this logistic unit" }, "referenceType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitReferenceType" } ], "description": "The type of reference used for identifying the logistics unit", "examples": [ "SSCC" ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitType" } ], "description": "The type of logistics unit, such as a PALLET or CARTON", "examples": [ "PALLET" ] } }, "type": "object", "required": [ "reference", "logisticsUnits", "inventoryItems", "referenceType", "type" ], "title": "LogisticsUnit" }, "__ReceivedLogisticsUnit": { "properties": { "reference": { "type": "string", "title": "Reference", "description": "SSCC or some other box, pallet reference agreed with the warehouse", "examples": [ "11111111111111" ] }, "inventoryItems": { "items": { "$ref": "#/components/schemas/ReceivedLogisticsUnitContent" }, "type": "array", "title": "Inventoryitems", "description": "List of items received on this logistic unit" }, "logisticsUnits": { "items": { "title": "ReceivedLogisticsUnit", "description": "ReceivedLogisticsUnit", "type": "object" }, "type": "array", "title": "Logisticsunits", "description": "List of logistic units received on this logistic unit" }, "referenceType": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitReferenceType" } ], "description": "The type of reference used for identifying the logistics unit", "examples": [ "SSCC" ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/LogisticsUnitType" } ], "description": "The type of logistics unit, such as a PALLET or CARTON", "examples": [ "PALLET" ] } }, "type": "object", "required": [ "reference", "inventoryItems", "logisticsUnits", "referenceType", "type" ], "title": "ReceivedLogisticsUnit" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "BearerAuth": [] } ] }