{ "swagger": "2.0", "info": { "description": "\n\n-----------------\n## Error Codes\n\n **0001** - Unexpected Error\n\n**1000** - Service offline\n\n**1001** - User not found\n\n**1002** - Validation failed\n\n**1003** - Transaction failed\n\n**1004** - Card already exists\n\n**1005** - Already exists\n\n**1006** - Authentication failed\n\n**1007** - Invalid manifest\n\n**1008** - Login error\n\n**1009** - Permissions error\n\n**1010** - Old pin invalid\n\n**9001** - OneProfile error\n\n\n\n-----------------\n## Structure\nThe API needs to be invoked with the token in the Authorization header.\n### RestResponse\nEvery response is contained by an object called RestResponse. \n \n The results property is polymorphic and can be any of the following swagger data types: null, array, object, string, number, integer. The actual data type for results is defined on each API under the responses section \n```json\n{\n \"success\": true,\n \"message\": \"\",\n \"results\": {\n\t...\n},\n \"totalItems\": 1,\n \"responseCode\": \"0000\"\n}\n```\n\n\n\n\n#### PAGINATION\n\n\n\nCalling certain methods in this API can result in a huge result set being returned. We implemented pagination in this method for this reason. The method will by default return a maximum of 10 records. If you require more records to be returned, you can specify the pageSize in the endpoint. The pageSize can be set to a max of 100 (pageSize=100) due to the degradation of service. For example:\n```\n https://dev-ws02.pdws.co.za:8253/pepcollect/0.0.1/lookup/node/getNodesListFor3rdParty?pageSize=2\n```\n\n\nThere is also a parameter that allows you to set the start index of the result set (this parameter must also be set in the URL). So consider the above result set, but specifying that the start index is set to example 1. If start index is not populated it is defaulted to 0. So now that it is set to 1 you will notice that the result set below is starting with the second node from the result set above.\n```\n https://dev-ws02.pdws.co.za:8253/pepcollect/0.0.1/lookup/node/getNodesListFor3rdParty?pageSize=2&startIndex=1\n```\n", "version": "16.0.4", "title": "Parcel Management Module" }, "host": "172.24.184.133:8080", "basePath": "/ParcelManagementModule", "tags": [ { "name": "notifications-controller", "description": "Notifications Controller" }, { "name": "rest-controller", "description": "Rest Controller" }, { "name": "rest-controller-external", "description": "Rest Controller External" } ], "paths": { "/clearAllCache": { "get": { "tags": [ "PAXI" ], "summary": "Clears out all the cache in PMM", "operationId": "clearAllCacheUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/dropToken/deleteDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Delete Drop Token", "description": "Delete an existing `DropToken` record.", "operationId": "deleteDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to delete", "required": true, "schema": { "$ref": "#/definitions/DropTokenDeleteRequest" } } ], "responses": { "200": { "description": "Drop Token successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/generateDropTokens": { "post": { "tags": [ "DropToken" ], "summary": "Generate Drop Tokens", "description": "Generate specified number of `DropToken` objects.", "operationId": "generateDropTokensUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropTokens to Generate", "required": true, "schema": { "$ref": "#/definitions/DropTokenGenerationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/getActiveDropTokens": { "get": { "tags": [ "DropToken" ], "summary": "All Active Drop Tokens", "description": "Gets all active `DropToken` objects.", "operationId": "getActiveDropTokensUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/dropToken/getAllDropTokens": { "get": { "tags": [ "DropToken" ], "summary": "All Drop Tokens", "description": "Gets all `DropToken` objects.", "operationId": "getAllDropTokensUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/dropToken/getDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Drop Token", "description": "Gets the `DropToken` object for a specific DropToken.", "operationId": "getDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to search for", "required": true, "schema": { "$ref": "#/definitions/DropTokenRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/getDropTokenByCriteria": { "post": { "tags": [ "DropToken" ], "summary": "Drop Token", "description": "Gets all `DropToken` object for a specific criteria.", "operationId": "getDropTokenByCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to search for", "required": true, "schema": { "$ref": "#/definitions/DropTokenRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/insertDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Insert Drop Token", "description": "Insert a new `DropToken` record.", "operationId": "insertDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to insert", "required": true, "schema": { "$ref": "#/definitions/DropTokenInsertRequest" } } ], "responses": { "200": { "description": "Drop Token successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Drop Token Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/updateDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Update Drop Token", "description": "Update an existing `DropToken` record.", "operationId": "updateDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to update", "required": true, "schema": { "$ref": "#/definitions/DropTokenUpdateRequest" } } ], "responses": { "200": { "description": "Drop Token successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Drop Token does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/updateDropTokenForPOS": { "post": { "tags": [ "DropToken" ], "summary": "Update Drop Token For POS", "description": "Update an existing `DropToken` record.", "operationId": "updateDropTokenForPOSUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to update", "required": true, "schema": { "$ref": "#/definitions/DropTokenUpdateRequest" } } ], "responses": { "200": { "description": "Drop Token successfully updated", "schema": { "$ref": "#/definitions/DropTokenResponse" } }, "400": { "description": "Specified Drop Token does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/dropToken/validateDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Validate Drop Token", "description": "Validate a `DropToken`.", "operationId": "validateDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to validate", "required": true, "schema": { "$ref": "#/definitions/DropTokenValidationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenValidationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/jwt": { "get": { "tags": [ "PAXI" ], "summary": "JWT Test Method", "operationId": "checkJwtUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "X-JWT-Assertion", "in": "header", "description": "X-JWT-Assertion", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/LspServiceType/delete": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "delete an existing `LspServiceType` object.", "operationId": "deleteLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to be deleted", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/LspServiceType/getLspServiceType": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "Gets the `LspServiceType` object for a specific LspServiceType.", "operationId": "getLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to search for", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspServiceTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/LspServiceType/getLspServiceTypes": { "get": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "Gets all `LspServiceType`objects.", "operationId": "getLspServiceTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspServiceTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/LspServiceType/insert": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "Create a new `LspServiceType` object.", "operationId": "insertLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to insert", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/LspServiceType/update": { "post": { "tags": [ "LspServiceType" ], "summary": "LSP Service Type", "description": "update an existing `LspServiceType` object.", "operationId": "updateLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspServiceType to update", "required": true, "schema": { "$ref": "#/definitions/LspServiceTypeUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/OneProfile/addOneProfileUser": { "post": { "tags": [ "OneProfile" ], "summary": "OneProfile", "operationId": "addOneProfileUserUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/OneProfileInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OneProfileResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/delete": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "delete an existing `ProductTypeLspServiceType` object.", "operationId": "deleteProductTypeLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to be deleted", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/getProductTypeLspServiceType": { "get": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "Gets all `ProductTypeLspServiceType`objects.", "operationId": "getProductTypeLspServiceTypeUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/getProductTypeLspServiceTypeByCriteria": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "Gets all `ProductTypeLspServiceType` objects within the criteria", "operationId": "getProductTypeLspServiceTypeByCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to Search by", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLSPServiceTypeSearchRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/insert": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "Create a new `ProductTypeLspServiceType` object.", "operationId": "insertProductTypeLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to insert", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/ProductTypeLspServiceType/update": { "post": { "tags": [ "ProductTypeLspServiceType" ], "summary": "Product Type LSP Service Type", "description": "update an existing `ProductTypeLspServiceType` object.", "operationId": "updateProductTypeLspServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeLspServiceType to update", "required": true, "schema": { "$ref": "#/definitions/ProductTypeLspServiceTypeUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/delete": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Delete Booking Reject Reason", "description": "Delete an existing `BookingRejectReason` record.", "operationId": "deleteBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking reject reason to delete", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonDeleteRequest" } } ], "responses": { "200": { "description": "Booking reject reason successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/getBookingRejectReason": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Booking Reject Reason", "description": "Gets the `BookingRejectReason` object for a specific Booking Reject Reason.", "operationId": "getBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking reject reason to search for", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingRejectReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/getBookingRejectReasons": { "get": { "tags": [ "BookingRejectReason" ], "summary": "Get all booking reject reasons", "description": "Gets all `BookingRejectReason` objects.", "operationId": "getAllBookingRejectReasonsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingRejectReasonsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/bookingRejectReason/insert": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Insert Booking Reject Reason", "description": "Insert a new `BookingRejectReason` record.", "operationId": "insertBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking Reject Reason object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonInsertRequest" } } ], "responses": { "200": { "description": "Booking reject reason successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingRejectReasonDesc and userIdNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingRejectReason/update": { "post": { "tags": [ "BookingRejectReason" ], "summary": "Update Booking Reject Reason", "description": "Update an existing `BookingRejectReason` record.", "operationId": "updateBookingRejectReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking Reject Reason object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/BookingRejectReasonUpdateRequest" } } ], "responses": { "200": { "description": "Booking Reject Reason successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingRejectReasonIdNo and userIdNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingStatus/delete": { "post": { "tags": [ "BookingStatus" ], "summary": "Delete Booking Status", "description": "Delete an existing `BookingStatus` record.", "operationId": "deleteBookingStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking status to delete", "required": true, "schema": { "$ref": "#/definitions/BookingStatusDeleteRequest" } } ], "responses": { "200": { "description": "Booking status successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingStatus/getBookingStatus": { "post": { "tags": [ "BookingStatus" ], "summary": "Booking Status", "description": "Gets the `BookingStatus` object for a specific `BookingRejectReason`.", "operationId": "getBookingStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking status to search for", "required": true, "schema": { "$ref": "#/definitions/BookingStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingStatus/getBookingStatuses": { "get": { "tags": [ "BookingStatus" ], "summary": "Get all booking statuses", "description": "Gets all `BookingStatuses` objects.", "operationId": "getAllBookingStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingStatusesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/bookingStatus/insert": { "post": { "tags": [ "BookingStatus" ], "summary": "Insert Booking Status", "description": "Insert a new `BookingStatus` record.", "operationId": "insertBookingStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking status object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/BookingStatusInsertRequest" } } ], "responses": { "200": { "description": "Booking status successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingStatusDesc and userIdNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/bookingStatus/update": { "post": { "tags": [ "BookingStatus" ], "summary": "Update Booking Status", "description": "Update an existing `BookingStatus` record.", "operationId": "updateBookingStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking Status object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/BookingStatusUpdateRequest" } } ], "responses": { "200": { "description": "Booking Status successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingStatusIdNo and userIdNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/collectionPin/revealCustomerCollectionPin": { "post": { "tags": [ "CollectionPin" ], "summary": "CollectionPin", "operationId": "revealCustomerCollectionPinUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "X-JWT-Assertion", "in": "header", "description": "X-JWT-Assertion", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Details to identify collection pin", "required": true, "schema": { "$ref": "#/definitions/CollectionPinRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/communicationTemplate/createCommunicationTemplate": { "post": { "tags": [ "CommunicationTemplate" ], "summary": "CommunicationTemplate", "operationId": "createCommunicationTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/CommunicationTemplateInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommunicationTemplateRepsonse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/communicationTemplate/searchCommunicationTemplate": { "post": { "tags": [ "CommunicationTemplate" ], "summary": "CommunicationTemplate", "operationId": "searchCommunicationTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/PagingAndSortingData" } }, { "name": "messageSetIdNo", "in": "query", "description": "Auto increment number used to uniquely identify a Message Set", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommunicationTemplateListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/communicationTemplate/updateCommunicationTemplate": { "post": { "tags": [ "CommunicationTemplate" ], "summary": "CommunicationTemplate", "operationId": "updateCommunicationTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/CommunicationTemplateUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommunicationTemplateRepsonse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/company/delete": { "post": { "tags": [ "Company" ], "summary": "Delete Company", "description": "Delete an existing `Company` record.", "operationId": "deleteCompanyUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The company to delete", "required": true, "schema": { "$ref": "#/definitions/CompanyDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/company/getCompanies": { "get": { "tags": [ "Company" ], "summary": "Active Companies", "description": "Gets al active `Company` objects.", "operationId": "getAllCompaniesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetCompaniesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/company/getCompany": { "post": { "tags": [ "Company" ], "summary": "Company", "description": "Gets the `Company` object for a specific company.", "operationId": "getCompanyUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The company to search for", "required": true, "schema": { "$ref": "#/definitions/CompanyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetCompanyResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/company/insert": { "post": { "tags": [ "Company" ], "summary": "Insert Company", "description": "Insert a new `Company` record.", "operationId": "insertCompanyUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Company object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/CompanyInsertRequest" } } ], "responses": { "200": { "description": "Company successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Company Code and Company Name must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/company/update": { "post": { "tags": [ "Company" ], "summary": "Update Company", "description": "Update an existing `Company` record.", "operationId": "updateCompanyUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Company object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/CompanyUpdateRequest" } } ], "responses": { "200": { "description": "Company successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Company does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/country/delete": { "post": { "tags": [ "Country" ], "summary": "Delete Country", "description": "Delete an existing `Country` record.", "operationId": "deleteCountryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Country to delete", "required": true, "schema": { "$ref": "#/definitions/CountryDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/country/getCountries": { "get": { "tags": [ "Country" ], "summary": "All Countries", "description": "Gets all active `Country` objects.", "operationId": "getCountriesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountryListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/country/getCountry": { "post": { "tags": [ "Country" ], "summary": "Country", "description": "Gets a specific `Country`.", "operationId": "getCountryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Country to search for", "required": true, "schema": { "$ref": "#/definitions/CountryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountryResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/country/insert": { "post": { "tags": [ "Country" ], "summary": "Insert Country", "description": "Insert a new `Country` record.", "operationId": "insertCountryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Country object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/CountryInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/country/update": { "post": { "tags": [ "Country" ], "summary": "Update Country", "description": "Update an existing `Country` record.", "operationId": "updateCountryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Country object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/CountryInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerPaymentType/delete": { "post": { "tags": [ "CustomerPaymentType" ], "summary": "Customer Payment Type", "description": "CustomerPaymentType", "operationId": "deleteCustomerPaymentTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Payment Type Details", "required": true, "schema": { "$ref": "#/definitions/CustomerPaymentTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerPaymentType/getCustomerPaymentType": { "post": { "tags": [ "CustomerPaymentType" ], "summary": "Customer Payment Type", "description": "CustomerPaymentType", "operationId": "getCustomerPaymentTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Payment Type Details to search by", "required": true, "schema": { "$ref": "#/definitions/CustomerPaymentTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerPaymentTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerPaymentType/getCustomerPaymentTypes": { "get": { "tags": [ "CustomerPaymentType" ], "summary": "Customer Payment Type", "description": "CustomerPaymentType", "operationId": "getCustomerPaymentTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerPaymentTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/customerPaymentType/insert": { "post": { "tags": [ "CustomerPaymentType" ], "summary": "Customer Payment Type", "description": "CustomerPaymentType", "operationId": "insertCustomerPaymentTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Payment Type Details", "required": true, "schema": { "$ref": "#/definitions/CustomerPaymentTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerPaymentType/update": { "post": { "tags": [ "CustomerPaymentType" ], "summary": "Customer Payment Type", "description": "CustomerPaymentType", "operationId": "updateCustomerPaymentTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Payment Type Details", "required": true, "schema": { "$ref": "#/definitions/CustomerPaymentTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerRefStatus/delete": { "post": { "tags": [ "CustomerRefStatus" ], "summary": "Customer Reference Status", "description": "CustomerRefStatus", "operationId": "deleteCustomerRefStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Status Details", "required": true, "schema": { "$ref": "#/definitions/CustomerRefStatusDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerRefStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerRefStatus/getCustomerRefStatus": { "post": { "tags": [ "CustomerRefStatus" ], "summary": "Customer Reference Status", "description": "CustomerRefStatus", "operationId": "getCustomerRefStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Details to search by", "required": true, "schema": { "$ref": "#/definitions/CustomerRefStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerRefStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerRefStatus/getCustomerRefStatuses": { "get": { "tags": [ "CustomerRefStatus" ], "summary": "Customer Reference Status", "description": "CustomerRefStatus", "operationId": "getCustomerRefStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerRefStatusListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/customerRefStatus/insert": { "post": { "tags": [ "CustomerRefStatus" ], "summary": "Customer Reference Status", "description": "CustomerRefStatus", "operationId": "insertCustomerRefStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Status Details", "required": true, "schema": { "$ref": "#/definitions/CustomerRefStatusInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/customerRefStatus/update": { "post": { "tags": [ "CustomerRefStatus" ], "summary": "Customer Reference Status", "description": "CustomerRefStatus", "operationId": "updateCustomerRefStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Status Details", "required": true, "schema": { "$ref": "#/definitions/CustomerRefStatusInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/errorMessage/delete": { "post": { "tags": [ "ErrorMessage" ], "summary": "Delete Error Message", "description": "Delete an existing `ErrorMessage` record.", "operationId": "deleteErrorMessageUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Error Message to delete", "required": true, "schema": { "$ref": "#/definitions/ErrorMessageDeleteRequest" } } ], "responses": { "200": { "description": "Error Message successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/errorMessage/getErrorMessage": { "post": { "tags": [ "ErrorMessage" ], "summary": "Error Messages", "description": "Gets the `ErrorMessage` object for a specific error message.", "operationId": "getErrorMessageUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The error message to search for", "required": true, "schema": { "$ref": "#/definitions/ErrorMessageRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetErrorMessageResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/errorMessage/getErrorMessages": { "get": { "tags": [ "ErrorMessage" ], "summary": "Active Error Messages", "description": "Gets all active `ErrorMessage` objects.", "operationId": "getAllErrorMessagesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetErrorMessagesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/errorMessage/insert": { "post": { "tags": [ "ErrorMessage" ], "summary": "Insert Error Message", "description": "Insert a new `ErrorMessage` record.", "operationId": "insertErrorMessageUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ErrorMessage object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ErrorMessageInsertRequest" } } ], "responses": { "200": { "description": "Error Message successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Error Message Code and Error Message Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/errorMessage/update": { "post": { "tags": [ "ErrorMessage" ], "summary": "Update Error Message", "description": "Update an existing `ErrorMessage` record.", "operationId": "updateErrorMessageUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ErrorMessage object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ErrorMessageInsertRequest" } } ], "responses": { "200": { "description": "Error Message successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Error Message does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/location/delete": { "post": { "tags": [ "Location" ], "summary": "Delete Location", "description": "Delete an existing `Location` record.", "operationId": "deleteLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Location to delete", "required": true, "schema": { "$ref": "#/definitions/LocationRequest" } } ], "responses": { "200": { "description": "Location successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/location/getLocation": { "post": { "tags": [ "Location" ], "summary": "Location", "description": "Gets the `Location` object for a specific location.", "operationId": "getLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The location to search for", "required": true, "schema": { "$ref": "#/definitions/LocationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLocationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/location/getLocations": { "get": { "tags": [ "Location" ], "summary": "Active Locations", "description": "Gets all active `Location` objects.", "operationId": "getAllLocationsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLocationsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/location/insert": { "post": { "tags": [ "Location" ], "summary": "Insert Location", "description": "Insert a new `Location` record.", "operationId": "insertLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Location object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/LocationInsertRequest" } } ], "responses": { "200": { "description": "Location successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Location Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/location/update": { "post": { "tags": [ "Location" ], "summary": "update Location", "description": "updates a `Location` record.", "operationId": "updateLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Location object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/LocationInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationStatus/delete": { "post": { "tags": [ "LocationStatus" ], "summary": "Delete Location Status", "description": "Delete an existing `LocationStatus` record.", "operationId": "deleteLocationStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LocationStatus to delete", "required": true, "schema": { "$ref": "#/definitions/LocationStatusDeleteRequest" } } ], "responses": { "200": { "description": "Location Status successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationStatus/getLocationStatus": { "post": { "tags": [ "LocationStatus" ], "summary": "Location Status", "description": "Gets the `LocationStatus` object for a specific location status.", "operationId": "getLocationStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Location Status to search for", "required": true, "schema": { "$ref": "#/definitions/LocationStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLocationStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationStatus/getLocationStatuses": { "get": { "tags": [ "LocationStatus" ], "summary": "Active Location Statuses", "description": "Gets all active `LocationStatus` objects.", "operationId": "getAllLocationStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLocationStatusesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/locationStatus/insert": { "post": { "tags": [ "LocationStatus" ], "summary": "Insert Location Status", "description": "Insert a new `LocationStatus` record.", "operationId": "insertLocationStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LocationStatus object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/LocationStatusInsertRequest" } } ], "responses": { "200": { "description": "Location Status successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Location Status Id No and Location Status Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationStatus/update": { "post": { "tags": [ "LocationStatus" ], "summary": "Update Location Status", "description": "Update an existing `LocationStatus` record.", "operationId": "updateLocationStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LocationStatus object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/LocationStatusUpdateRequest" } } ], "responses": { "200": { "description": "Location Status successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Location Status does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationType/delete": { "post": { "tags": [ "LocationType" ], "summary": "Delete Location Type", "description": "Delete an existing `LocationType` record.", "operationId": "deleteLocationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LocationType to delete", "required": true, "schema": { "$ref": "#/definitions/LocationTypeDeleteRequest" } } ], "responses": { "200": { "description": "Location Type successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationType/getLocationType": { "post": { "tags": [ "LocationType" ], "summary": "Location Type", "description": "Gets the `LocationType` object for a specific location type.", "operationId": "getLocationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Location Type to search for", "required": true, "schema": { "$ref": "#/definitions/LocationTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLocationTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationType/getLocationTypes": { "get": { "tags": [ "LocationType" ], "summary": "Active Location Types", "description": "Gets all active `LocationType` objects.", "operationId": "getAllLocationTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLocationTypesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/locationType/insert": { "post": { "tags": [ "LocationType" ], "summary": "Insert Location Type", "description": "Insert a new `LocationType` record.", "operationId": "insertLocationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LocationType object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/LocationTypeInsertRequest" } } ], "responses": { "200": { "description": "Location Type successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Location Type Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/locationType/update": { "post": { "tags": [ "LocationType" ], "summary": "Update Location Type", "description": "Update an existing `LocationType` record.", "operationId": "updateLocationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LocationType object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/LocationTypeUpdateRequest" } } ], "responses": { "200": { "description": "Location Type successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Location Type does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/logisticsServiceProvider/delete": { "post": { "tags": [ "LogisticsServiceProvider" ], "summary": "Delete Logistics Service Provider", "description": "Delete an existing `LogisticsServiceProvider` record.", "operationId": "deleteLogisticsServiceProviderUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LogisticsServiceProvider to delete", "required": true, "schema": { "$ref": "#/definitions/LogisticsServiceProviderDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/logisticsServiceProvider/getLogisticsServiceProvider": { "post": { "tags": [ "LogisticsServiceProvider" ], "summary": "Logistics Service Provider", "description": "Gets the `LogisticsServiceProvider` object for a specific logistics service provider.", "operationId": "getLogisticsServiceProviderUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LogisticsServiceProvider to search for", "required": true, "schema": { "$ref": "#/definitions/LogisticsServiceProviderRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLogisticsServiceProviderResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/logisticsServiceProvider/getLogisticsServiceProviders": { "get": { "tags": [ "LogisticsServiceProvider" ], "summary": "Active Logistics Service Providers", "description": "Gets al active `LogisticsServiceProvider` objects.", "operationId": "getAllLogisticsServiceProvidersUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetLogisticsServiceProvidersResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/logisticsServiceProvider/insert": { "post": { "tags": [ "LogisticsServiceProvider" ], "summary": "Insert Logistics Service Provider", "description": "Insert a new `LogisticsServiceProvider` record.", "operationId": "insertLogisticsServiceProviderUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LogisticsServiceProvider object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/LogisticsServiceProviderInsertRequest" } } ], "responses": { "200": { "description": "Logistics Service Provider successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Logistics Service Provider Code and Logistics Service Provider Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/logisticsServiceProvider/update": { "post": { "tags": [ "LogisticsServiceProvider" ], "summary": "Update Logistics Service Provider", "description": "Update an existing `LogisticsServiceProvider` record.", "operationId": "updateLogisticsServiceProviderUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LogisticsServiceProvider object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/LogisticsServiceProviderInsertRequest" } } ], "responses": { "200": { "description": "Logistics Service Provider successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Logistics Service Provider does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/message/getBookingMessages": { "post": { "tags": [ "Alerts and instructions" ], "summary": "Booking Messages", "description": "Gets the `BookingMessage` object.", "operationId": "getBookingMessagesByNodeIdUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking message to search for at specific node", "required": true, "schema": { "$ref": "#/definitions/NodeMessageRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingMessagesByNodeIdResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageChannel/delete": { "post": { "tags": [ "MessageChannel" ], "summary": "MessageChannel", "operationId": "deleteMessageChannelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageChannelRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageChannel/getMessageChannel": { "post": { "tags": [ "MessageChannel" ], "summary": "MessageChannel", "operationId": "getMessageChannelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageChannelRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageChannelResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageChannel/getMessageChannels": { "get": { "tags": [ "MessageChannel" ], "summary": "MessageChannel", "operationId": "getMessageChannelsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageChannelListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageChannel/insert": { "post": { "tags": [ "MessageChannel" ], "summary": "MessageChannel", "operationId": "insertMessageChannelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageChannelRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageChannel/update": { "post": { "tags": [ "MessageChannel" ], "summary": "MessageChannel", "operationId": "updateMessageChannelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageChannelRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageRecipientType/delete": { "post": { "tags": [ "MessageRecipientType" ], "summary": "MessageRecipientType", "operationId": "deleteMessageRecipientTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageRecipientTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageRecipientType/getMessageRecipientType": { "post": { "tags": [ "MessageRecipientType" ], "summary": "MessageRecipientType", "operationId": "getMessageRecipientTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageRecipientTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageRecipientTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageRecipientType/getMessageRecipientTypes": { "get": { "tags": [ "MessageRecipientType" ], "summary": "MessageRecipientType", "operationId": "getMessageRecipientTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageRecipientTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageRecipientType/insert": { "post": { "tags": [ "MessageRecipientType" ], "summary": "MessageRecipientType", "operationId": "insertMessageRecipientTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageRecipientTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageRecipientType/update": { "post": { "tags": [ "MessageRecipientType" ], "summary": "MessageRecipientType", "operationId": "updateMessageRecipientTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageRecipientTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSet/delete": { "post": { "tags": [ "MessageSet" ], "summary": "MessageSet", "operationId": "deleteMessageSetUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSet/getMessageSet": { "post": { "tags": [ "MessageSet" ], "summary": "MessageSet", "operationId": "getMessageSetUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageSetResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSet/getMessageSets": { "get": { "tags": [ "MessageSet" ], "summary": "MessageSet", "operationId": "getMessageSetsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageSetListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageSet/insert": { "post": { "tags": [ "MessageSet" ], "summary": "MessageSet", "operationId": "insertMessageSetUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSet/update": { "post": { "tags": [ "MessageSet" ], "summary": "MessageSet", "operationId": "updateMessageSetUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSetMessageTemplate/delete": { "post": { "tags": [ "MessageSetMessageTemplate" ], "summary": "MessageSetMessageTemplate", "operationId": "deleteMessageSetMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetMessageTemplateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSetMessageTemplate/getMessageSetMessageTemplate": { "post": { "tags": [ "MessageSetMessageTemplate" ], "summary": "MessageSetMessageTemplate", "operationId": "getMessageSetMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetMessageTemplateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageSetMessageTemplateResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageSetMessageTemplate/getMessageSetMessageTemplates": { "get": { "tags": [ "MessageSetMessageTemplate" ], "summary": "MessageSetMessageTemplate", "operationId": "getMessageSetMessageTemplatesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessageSetMessageTemplateListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageSetMessageTemplate/insert": { "post": { "tags": [ "MessageSetMessageTemplate" ], "summary": "MessageSetMessageTemplate", "operationId": "insertMessageSetMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/MessageSetMessageTemplateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageTemplate/delete": { "post": { "tags": [ "MessageTemplate" ], "summary": "Delete Message Template", "description": "Delete an existing `MessageTemplate` record.", "operationId": "deleteMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Message Template to delete", "required": true, "schema": { "$ref": "#/definitions/MessageTemplateDeleteRequest" } } ], "responses": { "200": { "description": "Message Template successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageTemplate/getMessageTemplate": { "post": { "tags": [ "MessageTemplate" ], "summary": "Message Template", "description": "Gets the `MessageTemplate` object for a specific message template.", "operationId": "getMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "MessageTemplate to search for", "required": true, "schema": { "$ref": "#/definitions/MessageTemplateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMessageTemplateResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageTemplate/getMessageTemplateByCategory": { "post": { "tags": [ "MessageTemplate" ], "summary": "Message Template by Message Template Category", "description": "Gets the `MessageTemplate` object for a specific message template category.", "operationId": "getMessageTemplateByCategoryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "MessageTemplate to search for", "required": true, "schema": { "$ref": "#/definitions/MessageTemplateCategoryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMessageTemplateByCategoryResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageTemplate/getMessageTemplates": { "get": { "tags": [ "MessageTemplate" ], "summary": "Active Message Templates", "description": "Gets al active `MessageTemplate` objects.", "operationId": "getAllMessageTemplatesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMessageTemplatesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageTemplate/getMessageTemplatesForParcel/{parcelIdNo}": { "get": { "tags": [ "MessageTemplate" ], "summary": "Message Templates for Parcel", "description": "Get all associated Message Templates for a specific Parcel.", "operationId": "getMessageTemplatesAssociatedWithParcelUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "parcelIdNo", "in": "path", "description": "parcelIdNo", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMessageTemplatesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageTemplate/insert": { "post": { "tags": [ "MessageTemplate" ], "summary": "Insert Message Template", "description": "Insert a new `MessageTemplate` record.", "operationId": "insertMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "MessageTemplate object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/MessageTemplateInsertRequest" } } ], "responses": { "200": { "description": "Message Template successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Message Template Name must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageTemplate/update": { "post": { "tags": [ "MessageTemplate" ], "summary": "Update Message Template", "description": "Update an existing `MessageTemplate` record.", "operationId": "updateMessageTemplateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "MessageTemplate object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/MessageTemplateUpdateRequest" } } ], "responses": { "200": { "description": "Message Template successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Message Template does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/messageTemplateCategory/getMessageTemplateCategories": { "get": { "tags": [ "MessageTemplateCategory" ], "summary": "Active Message Template Categories", "description": "Gets all active `MessageTemplateCategory` objects.", "operationId": "getMessageTemplateCategoriesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMessageTemplateCategoriesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/messageTemplateCategory/getMessageTemplateCategory": { "post": { "tags": [ "MessageTemplateCategory" ], "summary": "Message Template Category", "description": "Gets the `MessageTemplateCategory` object for a specific message template category.", "operationId": "getMessageTemplateCategoryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "MessageTemplate to search for", "required": true, "schema": { "$ref": "#/definitions/MessageTemplateCategoryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMessageTemplateCategoryResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/delete": { "post": { "tags": [ "Node" ], "summary": "Delete Node", "description": "Delete an existing `Node` record.", "operationId": "deleteNodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node to delete", "required": true, "schema": { "$ref": "#/definitions/NodeDeleteRequest" } } ], "responses": { "200": { "description": "Node successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/getNode": { "post": { "tags": [ "Node" ], "summary": "Node", "description": "Gets the `Node` object for a specific node.", "operationId": "getNodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node to search for", "required": true, "schema": { "$ref": "#/definitions/NodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/getNodes": { "get": { "tags": [ "Node" ], "summary": "Active Nodes", "description": "Gets all active `Node` objects.\n\n\n", "operationId": "getAllNodesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/node/getNodesFiltered": { "post": { "tags": [ "Node" ], "summary": "Filtered Nodes", "description": "Gets filtered list of `Node` objects.", "operationId": "getNodesFilteredUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter criteria for nodes", "required": true, "schema": { "$ref": "#/definitions/NodeFilteredRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/getNodesFilteredLight": { "post": { "tags": [ "Node" ], "summary": "Filtered Nodes", "description": "Gets filtered list of `Node` objects.", "operationId": "getNodesFilteredLightUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter criteria for nodes", "required": true, "schema": { "$ref": "#/definitions/NodeFilteredLightRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodePojoLightListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/getNodesListFor3rdParty": { "post": { "tags": [ "Node" ], "summary": "Filtered Nodes", "description": "This API call can be used to get a filtered list of nodes. The parameters are all optional but either nodeCode or companyCode must be populated. For couriers and suppliers\n\n**productIdNo** - for Suppliers", "operationId": "getNodesListFor3rdPartyUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter criteria for nodes", "required": true, "schema": { "$ref": "#/definitions/NodesListFor3rdPartyRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodesListFor3rdPartyResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/insert": { "post": { "tags": [ "Node" ], "summary": "Insert Node", "description": "Insert a new `Node` record.", "operationId": "insertNodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeInsertRequest" } } ], "responses": { "200": { "description": "Node successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Code and Node Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/nearest": { "post": { "tags": [ "NearestNode" ], "summary": "NearestNode", "operationId": "getNearestNodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "nearestNodeRequest", "description": "nearestNodeRequest", "required": true, "schema": { "$ref": "#/definitions/NearestNodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NearestNodeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/node/update": { "post": { "tags": [ "Node" ], "summary": "Update Node", "description": "Update an existing `Node` record.", "operationId": "updateNodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeUpdateRequest" } } ], "responses": { "200": { "description": "Node successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeClassificationType/delete": { "post": { "tags": [ "NodeClassificationType" ], "summary": "NodeClassificationType", "operationId": "deleteNodeClassificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeClassificationTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeClassificationType/getNodeClassificationType": { "post": { "tags": [ "NodeClassificationType" ], "summary": "NodeClassificationType", "operationId": "getNodeClassificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeClassificationTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeClassificationTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeClassificationType/getNodeClassificationTypes": { "get": { "tags": [ "NodeClassificationType" ], "summary": "NodeClassificationType", "operationId": "getNodeClassificationTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeClassificationTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeClassificationType/insert": { "post": { "tags": [ "NodeClassificationType" ], "summary": "NodeClassificationType", "operationId": "insertNodeClassificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeClassificationTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeClassificationType/update": { "post": { "tags": [ "NodeClassificationType" ], "summary": "NodeClassificationType", "operationId": "updateNodeClassificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeClassificationTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeConcept/delete": { "post": { "tags": [ "NodeConcept" ], "summary": "Delete Node Concept", "description": "Delete an existing `NodeConcept` record.", "operationId": "deleteNodeConceptUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeConcept to delete", "required": true, "schema": { "$ref": "#/definitions/NodeConceptDeleteRequest" } } ], "responses": { "200": { "description": "Node Concept successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeConcept/getNodeConcept": { "post": { "tags": [ "NodeConcept" ], "summary": "Node Concept", "description": "Gets the `NodeConcept` object for a specific node concept.", "operationId": "getNodeConceptUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeConcept to search for", "required": true, "schema": { "$ref": "#/definitions/NodeConceptRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeConceptResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeConcept/getNodeConcepts": { "get": { "tags": [ "NodeConcept" ], "summary": "Active Node Concepts", "description": "Gets all active `NodeConcept` objects.", "operationId": "getAllNodeConceptsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeConceptsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeConcept/insert": { "post": { "tags": [ "NodeConcept" ], "summary": "Insert Node Concept", "description": "Insert a new `NodeConcept` record.", "operationId": "insertNodeConceptUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeConcept object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeConceptInsertRequest" } } ], "responses": { "200": { "description": "Node Concept successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Concept Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeConcept/update": { "post": { "tags": [ "NodeConcept" ], "summary": "Update Node Concept", "description": "Update an existing `NodeConcept` record.", "operationId": "updateNodeConceptUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeConcept object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeConceptUpdateRequest" } } ], "responses": { "200": { "description": "Node Concept successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node Concept does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroup/delete": { "post": { "tags": [ "NodeGroup" ], "summary": "Delete Node Group", "description": "Delete an existing `NodeGroup` record.", "operationId": "deleteNodeGroupUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeGroup to delete", "required": true, "schema": { "$ref": "#/definitions/NodeGroupDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroup/getNodeGroup": { "post": { "tags": [ "NodeGroup" ], "summary": "Node Group", "description": "Gets the `NodeGroup` object for a specific node group.", "operationId": "getNodeGroupUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeGroup to search for", "required": true, "schema": { "$ref": "#/definitions/NodeGroupRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeGroupResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroup/getNodeGroupByDesc": { "post": { "tags": [ "NodeGroup" ], "summary": "Node Group", "description": "Gets the `NodeGroup` object for a specific node group desc.", "operationId": "getNodeGroupByDescUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeGroup to search for", "required": true, "schema": { "$ref": "#/definitions/NodeGroupDescRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeGroupResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroup/getNodeGroups": { "get": { "tags": [ "NodeGroup" ], "summary": "Active Node Groups", "description": "Gets all active `NodeGroup` objects.", "operationId": "getAllNodeGroupsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeGroupsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeGroup/insert": { "post": { "tags": [ "NodeGroup" ], "summary": "Insert Node Group", "description": "Insert a new `NodeGroup` record.", "operationId": "insertNodeGroupUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeGroup object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeGroupInsertRequest" } } ], "responses": { "200": { "description": "Node Group successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Group Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroup/update": { "post": { "tags": [ "NodeGroup" ], "summary": "Update Node Group", "description": "Update an existing `NodeGroup` record.", "operationId": "updateNodeGroupUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeGroup object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeGroupUpdateRequest" } } ], "responses": { "200": { "description": "Node Group successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node Group does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroupNodeConcept/delete": { "post": { "tags": [ "NodeGroupNodeConcept" ], "summary": "Delete Node Group - Node Concept", "description": "Delete an existing `NodeGroupNodeConcept` record.", "operationId": "deleteNodeGroupNodeConceptUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node Group - Node Concept to delete", "required": true, "schema": { "$ref": "#/definitions/NodeGroupNodeConceptRequest" } } ], "responses": { "200": { "description": "Node Group - Node Concept combination successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeGroupNodeConcept/getNodeGroupNodeConcepts": { "get": { "tags": [ "NodeGroupNodeConcept" ], "summary": "Active Node Group - Node Concept Combinations", "description": "Gets all active `NodeGroupNodeConcept` objects.", "operationId": "getAllNodeGroupNodeConceptsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeGroupNodeConceptsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeGroupNodeConcept/insert": { "post": { "tags": [ "NodeGroupNodeConcept" ], "summary": "Insert Node Group - Node Concept Combination", "description": "Insert a new `NodeGroupNodeConcept` record.", "operationId": "insertNodeGroupNodeConceptUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeGroupNodeConcept object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeGroupNodeConceptRequest" } } ], "responses": { "200": { "description": "Node Group - Node Concept combination successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Group Id No and Node Concept Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/delete": { "post": { "tags": [ "NodeLocation" ], "summary": "Delete Node Location", "description": "Delete an existing NodeLocation record.", "operationId": "deleteNodeLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeLocation to delete", "required": true, "schema": { "$ref": "#/definitions/NodeLocationDeleteRequest" } } ], "responses": { "200": { "description": "Node Location successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getFilteredLocation": { "post": { "tags": [ "NodeLocation" ], "summary": "Filtered location records", "description": "Get filtered list of locations", "operationId": "getFilteredLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The node and logistics service provider to filter by", "required": true, "schema": { "$ref": "#/definitions/FilteredLocationPojo" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocation": { "post": { "tags": [ "NodeLocation" ], "summary": "Node Location", "description": "Gets the `NodeLocation` object for a specific node location.", "operationId": "getNodeLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeLocation to search for", "required": true, "schema": { "$ref": "#/definitions/NodeLocationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocationByCustomerRefCode": { "post": { "tags": [ "NodeLocation" ], "summary": "Active Locations within a specific node for put away of parcel", "operationId": "getNodeLocationByCustomerRefCodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The customer reference code to filter by", "required": true, "schema": { "$ref": "#/definitions/NodeLocationByCustomerRefCodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocationByNode": { "post": { "tags": [ "NodeLocation" ], "summary": "Active Locations within a specific node", "description": "Gets all active `NodeLocation` objects for a specific node.", "operationId": "getNodeLocationByNodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The node to filter by", "required": true, "schema": { "$ref": "#/definitions/NodeRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocationByNodeLSP": { "post": { "tags": [ "NodeLocation" ], "summary": "Active Locations within a specific node, for a specific logistics service provider", "operationId": "getNodeLocationByNodeLSPUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The node and logistics service provider to filter by", "required": true, "schema": { "$ref": "#/definitions/NodeLocationByNodeLSPRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocationByNodeLocationCode": { "post": { "tags": [ "NodeLocation" ], "summary": "Location within a specific node", "description": "Gets the `NodeLocation` object for a specific location at a specific node.", "operationId": "getNodeLocationByNodeLocationCodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The node and location to filter by", "required": true, "schema": { "$ref": "#/definitions/NodeLocationByNodeLocationCodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocationByNonCollectionParcel": { "post": { "tags": [ "NodeLocation" ], "summary": "Get Node Location by parcelIdNo/customerRefCode", "operationId": "getNodeLocationByNonCollectionParcelIdUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "currentNodeIdNo, customerRefCode or parcelIdNo to search NodeLocation by", "required": true, "schema": { "$ref": "#/definitions/NodeLocationByCustomerRefCodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/getNodeLocations": { "get": { "tags": [ "NodeLocation" ], "summary": "Active Node Locations", "description": "Gets all active `NodeLocation` objects.", "operationId": "getAllNodeLocationsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeLocationsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeLocation/insert": { "post": { "tags": [ "NodeLocation" ], "summary": "Insert Node Location", "description": "Insert a new `NodeLocation` record.", "operationId": "insertNodeLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeLocation object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeLocationInsertRequest" } } ], "responses": { "200": { "description": "Node Location successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Location Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/update": { "post": { "tags": [ "NodeLocation" ], "summary": "Update Node Location", "description": "Update an existing `NodeLocation` record.", "operationId": "updateNodeLocationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeLocation object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeLocationUpdateRequest" } } ], "responses": { "200": { "description": "Node Location successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node Location does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLocation/updateStatus": { "post": { "tags": [ "NodeLocation" ], "summary": "Update Node Location Status", "operationId": "updateNodeLocationStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeLocation object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeLocationStatusRequest" } } ], "responses": { "200": { "description": "Node Location successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node Location does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLspClassification/delete": { "post": { "tags": [ "NodeLspClassification" ], "summary": "NodeLspClassification", "operationId": "deleteNodeLspClassificationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeLspClassificationInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLspClassification/getNodeLspClassificationCriteria": { "post": { "tags": [ "NodeLspClassification" ], "summary": "NodeLspClassification", "operationId": "getNodeLspClassificationCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeLspClassificationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeLspClassificationListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLspClassification/getNodeLspClassifications": { "get": { "tags": [ "NodeLspClassification" ], "summary": "NodeLspClassification", "operationId": "getNodeLspClassificationsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NodeLspClassificationListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeLspClassification/insert": { "post": { "tags": [ "NodeLspClassification" ], "summary": "NodeLspClassification", "operationId": "insertNodeLspClassificationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeLspClassificationInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeLspClassification/update": { "post": { "tags": [ "NodeLspClassification" ], "summary": "NodeLspClassification", "operationId": "updateNodeLspClassificationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/NodeLspClassificationUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeStatus/delete": { "post": { "tags": [ "NodeStatus" ], "summary": "Delete Node Status", "description": "Delete an existing `NodeStatus` record.", "operationId": "deleteNodeStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeStatus to delete", "required": true, "schema": { "$ref": "#/definitions/NodeStatusDeleteRequest" } } ], "responses": { "200": { "description": "Node Status successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeStatus/getNodeStatus": { "post": { "tags": [ "NodeStatus" ], "summary": "Node Status", "description": "Gets the `NodeStatus` object for a specific node status.", "operationId": "getNodeStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node Status to search for", "required": true, "schema": { "$ref": "#/definitions/NodeStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeStatus/getNodeStatuses": { "get": { "tags": [ "NodeStatus" ], "summary": "Active Node Statuses", "description": "Gets all active `NodeStatus` objects.", "operationId": "getAllNodeStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeStatusesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeStatus/insert": { "post": { "tags": [ "NodeStatus" ], "summary": "Insert Node Status", "description": "Insert a new `NodeStatus` record.", "operationId": "insertNodeStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeStatus object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeStatusInsertRequest" } } ], "responses": { "200": { "description": "Node Status successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Status Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeStatus/update": { "post": { "tags": [ "NodeStatus" ], "summary": "Update Node Status", "description": "Update an existing `NodeStatus` record.", "operationId": "updateNodeStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeStatus object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeStatusUpdateRequest" } } ], "responses": { "200": { "description": "Node Status successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node Status does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeType/delete": { "post": { "tags": [ "NodeType" ], "summary": "Delete Node Type", "description": "Delete an existing `NodeType` record.", "operationId": "deleteNodeTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeType to delete", "required": true, "schema": { "$ref": "#/definitions/NodeTypeDeleteRequest" } } ], "responses": { "200": { "description": "Node Type successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeType/getNodeType": { "post": { "tags": [ "NodeType" ], "summary": "Node Type", "description": "Gets the `NodeType` object for a specific node type.", "operationId": "getNodeTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeType to search for", "required": true, "schema": { "$ref": "#/definitions/NodeTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeType/getNodeTypes": { "get": { "tags": [ "NodeType" ], "summary": "Active Node Types", "description": "Gets all active `NodeType` objects.", "operationId": "getAllNodeTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNodeTypesResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/nodeType/insert": { "post": { "tags": [ "NodeType" ], "summary": "Insert Node Type", "description": "Insert a new `NodeType` record.", "operationId": "insertNodeTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeType object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/NodeTypeInsertRequest" } } ], "responses": { "200": { "description": "Node Type successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Node Type Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/nodeType/update": { "post": { "tags": [ "NodeType" ], "summary": "Update Node Type", "description": "Update an existing NodeType record.", "operationId": "updateNodeTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeType object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/NodeTypeUpdateRequest" } } ], "responses": { "200": { "description": "Node Type successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Node Type does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/oneProfile/generateOneProfileGuidsFile": { "get": { "tags": [ "OneProfile" ], "summary": "One Profile", "description": "Creates a file and dump on an ftp server all the one profile guids for each parcel that is one day old", "operationId": "generateOneProfileGuidsFileUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/parcelEventType/delete": { "post": { "tags": [ "ParcelEventType" ], "summary": "Delete Parcel Event Type", "description": "Delete an existing `ParcelEventType` record.", "operationId": "deleteParcelEventTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEventType to delete", "required": true, "schema": { "$ref": "#/definitions/ParcelEventTypeDeleteRequest" } } ], "responses": { "200": { "description": "Parcel Event Type successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelEventType/getParcelEventType": { "post": { "tags": [ "ParcelEventType" ], "summary": "Parcel Event Type", "description": "Gets the `ParcelEventType` object for a specific parcel event type.", "operationId": "getParcelEventTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEventType to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelEventTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelEventTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelEventType/getParcelEventTypes": { "get": { "tags": [ "ParcelEventType" ], "summary": "Active Parcel Event Types", "description": "Gets all active `ParcelEventType` objects.", "operationId": "getAllParcelEventTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelEventTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/parcelEventType/insert": { "post": { "tags": [ "ParcelEventType" ], "summary": "Insert Parcel Event Type", "description": "Insert a new `ParcelEventType` record.", "operationId": "insertParcelEventTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEventType object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ParcelEventTypeInsertRequest" } } ], "responses": { "200": { "description": "Parcel Event Type successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Parcel Event Type Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelEventType/update": { "post": { "tags": [ "ParcelEventType" ], "summary": "Update Parcel Event Type", "description": "Update an existing `ParcelEventType` record.", "operationId": "updateParcelEventTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEventType object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ParcelEventTypeUpdateRequest" } } ], "responses": { "200": { "description": "Parcel Event Type successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Parcel Event Type does not exist" }, "401": { "description": "Parcel Event Type Description and/or Customer Visible Indicator must be entered" }, "402": { "description": "Invalid value for Customer Visible Indicator : Expected Y/N" }, "403": { "description": "UserIdNo must be entered" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelStatus/delete": { "post": { "tags": [ "ParcelStatus" ], "summary": "Delete Parcel Status", "description": "Delete an existing `ParcelStatus` record.", "operationId": "deleteParcelStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelStatus to delete", "required": true, "schema": { "$ref": "#/definitions/ParcelStatusDeleteRequest" } } ], "responses": { "200": { "description": "Parcel Status successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelStatus/getParcelStatus": { "post": { "tags": [ "ParcelStatus" ], "summary": "Parcel Status", "description": "Gets the `ParcelStatus` object for a specific parcel status.", "operationId": "getParcelStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelStatus to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelStatus/getParcelStatuses": { "get": { "tags": [ "ParcelStatus" ], "summary": "Active Parcel Statuses", "description": "Gets all active `ParcelStatus` objects.", "operationId": "getAllParcelStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelStatusListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/parcelStatus/insert": { "post": { "tags": [ "ParcelStatus" ], "summary": "Insert Parcel Status", "description": "Insert a new `ParcelStatus` record.", "operationId": "insertParcelStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelStatus object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ParcelStatusInsertRequest" } } ], "responses": { "200": { "description": "Parcel Status successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Parcel Status Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelStatus/update": { "post": { "tags": [ "ParcelStatus" ], "summary": "Update Parcel Status", "description": "Update an existing `ParcelStatus` record", "operationId": "updateParcelStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelStatus object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ParcelStatusUpdateRequest" } } ], "responses": { "200": { "description": "Parcel Status successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Parcel Status does not exist" }, "401": { "description": "UserIdNo must be entered" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelTerminationType/getParcelTerminationTypes": { "get": { "tags": [ "ParcelTerminationType" ], "summary": "Active Parcel Termination Types", "description": "Gets all `ParcelTerminationType` objects.", "operationId": "getAllParcelTerminationTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelTerminationTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/parcelTerminationType/insert": { "post": { "tags": [ "ParcelTerminationType" ], "summary": "Insert Parcel Termination Type", "description": "Insert a new `ParcelTerminationType` record.", "operationId": "insertParcelTerminationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel Termination Type to be inserted", "required": true, "schema": { "$ref": "#/definitions/ParcelTerminationTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/parcelTerminationType/update": { "post": { "tags": [ "ParcelTerminationType" ], "summary": "Update Parcel Termination Type", "description": "Update an existing `ParcelTerminationType` record.", "operationId": "updateParcelTerminationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel Termination Type to be updated", "required": true, "schema": { "$ref": "#/definitions/ParcelTerminationTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/product/delete": { "post": { "tags": [ "Product" ], "summary": "Delete Product", "description": "Delete an existing Product record", "operationId": "deleteProductUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Product to delete", "required": true, "schema": { "$ref": "#/definitions/ProductDeleteRequest" } } ], "responses": { "200": { "description": "Product successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/product/getProduct": { "post": { "tags": [ "Product" ], "summary": "Products", "description": "Gets the `Products` object for a specific product.", "operationId": "getProductUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Product to search for", "required": true, "schema": { "$ref": "#/definitions/ProductPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/product/getProductBySupplier": { "post": { "tags": [ "Product" ], "summary": "Products", "description": "This API call can be used to get a list of all products for a specific supplier. For suppliers", "operationId": "getProductBySupplierUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Product to search for", "required": true, "schema": { "$ref": "#/definitions/ProductBySupplierRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetProductBySupplierResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/product/getProducts": { "get": { "tags": [ "Product" ], "summary": "Active Products", "description": "Gets all active `Product` objects.", "operationId": "getAllProductsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/product/insert": { "post": { "tags": [ "Product" ], "summary": "Insert Products", "description": "Insert a new `Product` record.", "operationId": "insertProductUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Product object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ProductInsertRequest" } } ], "responses": { "200": { "description": "Product successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Product Type Id No and Supplier Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/product/update": { "post": { "tags": [ "Product" ], "summary": "Update Product", "description": "Update an existing `Product` record.", "operationId": "updateProductUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Product object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ProductUpdateRequest" } } ], "responses": { "200": { "description": "Product successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Product does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productType/delete": { "post": { "tags": [ "ProductType" ], "summary": "Delete Product Type", "description": "Delete an existing `ProductType` record.", "operationId": "deleteProductTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductType to delete", "required": true, "schema": { "$ref": "#/definitions/ProductTypeDeleteRequest" } } ], "responses": { "200": { "description": "Product Type successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productType/getProductType": { "post": { "tags": [ "ProductType" ], "summary": "Product Type", "description": "Gets the `ProductType` object for a specific product type.", "operationId": "getProductTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductType to search for", "required": true, "schema": { "$ref": "#/definitions/ProductTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productType/getProductTypeByIds": { "post": { "tags": [ "ProductType" ], "summary": "Product Type", "description": "Gets the `ProductType` object for a range of product types.", "operationId": "getProductTypeByIdsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypes to search for", "required": true, "schema": { "$ref": "#/definitions/ProductTypesRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productType/getProductTypes": { "get": { "tags": [ "ProductType" ], "summary": "Active Product Types", "description": "Gets all active `ProductType` objects.", "operationId": "getAllProductTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/productType/insert": { "post": { "tags": [ "ProductType" ], "summary": "Insert Product Type", "description": "Insert a new `ProductType` record.", "operationId": "insertProductTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductType object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ProductTypeInsertRequest" } } ], "responses": { "200": { "description": "Product Type successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Product Type Id No and Product Type Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productType/update": { "post": { "tags": [ "ProductType" ], "summary": "Update Product Type", "description": "Insert a new `ProductType` record.", "operationId": "updateProductTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductType object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ProductTypeUpdateRequest" } } ], "responses": { "200": { "description": "Product Type successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Product Type does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productTypeDropLablePrefix/delete": { "post": { "tags": [ "ProductTypeDropLable" ], "summary": "Product Type Drop Lable Prefix", "description": "delete an existing `ProductTypeDropLablePrefix` object.", "operationId": "deleteProductTypeDropLablePrefixUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeDropLablePrefix to be deleted", "required": true, "schema": { "$ref": "#/definitions/ProductTypeDropLablePrefixDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productTypeDropLablePrefix/getProductTypeDropLablePrefixs": { "get": { "tags": [ "ProductTypeDropLable" ], "summary": "Product Type Drop Lable Prefix", "description": "Gets all the active `ProductTypeDropLablePrefix` objects.", "operationId": "getProductTypeDropLablePrefixsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeDropLablePrefixListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/productTypeDropLablePrefix/getProductTypeDropLablePrefixsByCriteria": { "post": { "tags": [ "ProductTypeDropLable" ], "summary": "Product Type Drop Lable Prefix", "description": "Gets all `ProductTypeDropLablePrefix` objects within the criteria", "operationId": "getByProductTypeDropLableFrefixsCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ProductTypeDropLableFrefix to Search by", "required": true, "schema": { "$ref": "#/definitions/ProductTypeDropLablePrefixSearchRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductTypeDropLablePrefixListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/productTypeDropLablePrefix/insert": { "post": { "tags": [ "ProductTypeDropLable" ], "summary": "Product Type Drop Lable Prefix", "description": "Creates a new `ProductTypeDropLablePrefix` objects ", "operationId": "insertProductTypeDropLablePrefixUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Product Type Drop Lable Prefix to Create", "required": true, "schema": { "$ref": "#/definitions/ProductTypeDropLablePrefixInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/returnReason/delete": { "post": { "tags": [ "ReturnReason" ], "summary": "Delete Return Reason", "description": "Delete a new `ReturnReason` record.", "operationId": "deleteReturnReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ReturnReason object that needs to be deleted", "required": true, "schema": { "$ref": "#/definitions/ReturnReasonDeleteRequest" } } ], "responses": { "200": { "description": "Return Reason successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Return Reason Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/returnReason/getReturnReason": { "post": { "tags": [ "ReturnReason" ], "summary": "Return Reason", "description": "Gets the `ReturnReason` object for a specific Return Reason.", "operationId": "getReturnReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ReturnReason to search for", "required": true, "schema": { "$ref": "#/definitions/ReturnReasonRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ReturnReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/returnReason/getReturnReasons": { "get": { "tags": [ "ReturnReason" ], "summary": "Active Return Reasons", "description": "Gets all active `ReturnReason` objects.", "operationId": "getReturnReasonsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ReturnReasonListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/returnReason/insert": { "post": { "tags": [ "ReturnReason" ], "summary": "Insert Return Reason", "description": "Insert a new `ReturnReason` record.", "operationId": "insertReturnReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ReturnReason object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ReturnReasonInsertRequest" } } ], "responses": { "200": { "description": "Return Reason successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Return Reason Id No and Return Reason Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/returnReason/update": { "post": { "tags": [ "ReturnReason" ], "summary": "Update Return Reason", "description": "Update a new `ReturnReason` record.", "operationId": "updateReturnReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ReturnReason object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ReturnReasonUpdateRequest" } } ], "responses": { "200": { "description": "Return Reason successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Return Reason Id No and Return Reason Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/serviceType/delete": { "post": { "tags": [ "ServiceType" ], "summary": "Delete Service Type", "description": "Delete an existing `ServiceType` record.", "operationId": "deleteServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ServiceType to delete", "required": true, "schema": { "$ref": "#/definitions/ServiceTypeDeleteRequest" } } ], "responses": { "200": { "description": "Service Type successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/serviceType/getServiceType": { "post": { "tags": [ "ServiceType" ], "summary": "Service Type", "description": "Gets the `ServiceType` object for a specific service type.", "operationId": "getServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ServiceType to search for", "required": true, "schema": { "$ref": "#/definitions/ServiceTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServiceTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/serviceType/getServiceTypes": { "get": { "tags": [ "ServiceType" ], "summary": "Active Service Types", "description": "Gets all active `ServiceType` objects.", "operationId": "getAllServiceTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ServiceTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/serviceType/insert": { "post": { "tags": [ "ServiceType" ], "summary": "Insert Service Type", "description": "Insert a new `ServiceType` record.", "operationId": "insertServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ServiceType to insert", "required": true, "schema": { "$ref": "#/definitions/ServiceTypeInsertRequest" } } ], "responses": { "200": { "description": "Service Type successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Service Type Id No and Service Type Description must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/serviceType/update": { "post": { "tags": [ "ServiceType" ], "summary": "Update Service Type", "description": "Update an existing `ServiceType` record.", "operationId": "updateServiceTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ServiceType to update", "required": true, "schema": { "$ref": "#/definitions/ServiceTypeUpdateRequest" } } ], "responses": { "200": { "description": "Service Type successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Service Type does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/signatureRequirementType/getSignatureRequirementType": { "post": { "tags": [ "SignatureRequirementType" ], "summary": "Signature Requirement Type", "description": "Gets the `SignatureRequirementType` object for a specific signature requirement type.", "operationId": "getSignatureRequirementTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "SignatureRequirementType to search for", "required": true, "schema": { "$ref": "#/definitions/SignatureRequirementRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SignatureRequirementTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/signatureRequirementType/getSignatureRequirementTypes": { "get": { "tags": [ "SignatureRequirementType" ], "summary": "Active Signature Requirement Type", "description": "Gets all active `SignatureRequirementType` objects.", "operationId": "getAllSignatureRequirementTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SignatureRequirementTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/supplier/delete": { "post": { "tags": [ "Supplier" ], "summary": "Delete Supplier", "description": "Delete an existing `Supplier` record.", "operationId": "deleteSupplierUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Supplier to delete", "required": true, "schema": { "$ref": "#/definitions/SupplierDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/supplier/getSupplier": { "post": { "tags": [ "Supplier" ], "summary": "Supplier", "description": "Gets the `Supplier` object for a specific supplier.", "operationId": "getSupplierUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Supplier to search for", "required": true, "schema": { "$ref": "#/definitions/SupplierRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SupplierResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/supplier/getSuppliers": { "get": { "tags": [ "Supplier" ], "summary": "Active Suppliers", "description": "Gets al active `Supplier` objects.", "operationId": "getAllSuppliersUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SupplierListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/supplier/insert": { "post": { "tags": [ "Supplier" ], "summary": "Insert Supplier", "description": "Insert a new `Supplier` record.", "operationId": "insertSupplierUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Supplier to insert", "required": true, "schema": { "$ref": "#/definitions/SupplierInsertRequest" } } ], "responses": { "200": { "description": "Supplier successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Supplier Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/supplier/update": { "post": { "tags": [ "Supplier" ], "summary": "Update Supplier", "description": "Update a `Supplier` record.", "operationId": "updateSupplierUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Supplier to update", "required": true, "schema": { "$ref": "#/definitions/SupplierUpdateRequest" } } ], "responses": { "200": { "description": "Supplier successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Supplier does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenStatus/delete": { "post": { "tags": [ "TokenStatus" ], "summary": "Delete Token Status", "description": "Delete an existing `TokenStatus` record.", "operationId": "deleteTokenStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenStatus to delete", "required": true, "schema": { "$ref": "#/definitions/TokenStatusDeleteRequest" } } ], "responses": { "200": { "description": "Token Status successfully deleted", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenStatus/getAllActiveTokenStatuses": { "get": { "tags": [ "TokenStatus" ], "summary": "All Active Token Statuses", "description": "Gets all active `TokenStatus` objects.", "operationId": "getActiveTokenStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenStatusListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/tokenStatus/getAllTokenStatuses": { "get": { "tags": [ "TokenStatus" ], "summary": "All Token Statuses", "description": "Gets all `TokenStatus` objects.", "operationId": "getAllTokenStatusesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenStatusListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/tokenStatus/getTokenStatus": { "post": { "tags": [ "TokenStatus" ], "summary": "Token Status", "description": "Gets the `TokenStatus` object for a specific TokenStatus.", "operationId": "getTokenStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenStatus to search for", "required": true, "schema": { "$ref": "#/definitions/TokenStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenStatusResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenStatus/insert": { "post": { "tags": [ "TokenStatus" ], "summary": "Insert Token Status", "description": "Insert a new `TokenStatus` record.", "operationId": "insertTokenStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenStatus to insert", "required": true, "schema": { "$ref": "#/definitions/TokenStatusInsertRequest" } } ], "responses": { "200": { "description": "Token Status successfully inserted", "schema": { "$ref": "#/definitions/PmmResponse" } }, "400": { "description": "The value for Token Status Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenStatus/update": { "post": { "tags": [ "TokenStatus" ], "summary": "Update Token Status", "description": "Update an existing `TokenStatus` record.", "operationId": "updateTokenStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenStatus to update", "required": true, "schema": { "$ref": "#/definitions/TokenStatusUpdateRequest" } } ], "responses": { "200": { "description": "Token Status successfully updated", "schema": { "$ref": "#/definitions/PmmResponse" } }, "400": { "description": "Specified Token Status does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenType/delete": { "post": { "tags": [ "TokenType" ], "summary": "Delete Token Type", "description": "Delete an existing `TokenType` record.", "operationId": "deleteTokenTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenType to delete", "required": true, "schema": { "$ref": "#/definitions/TokenTypeDeleteRequest" } } ], "responses": { "200": { "description": "Token Type successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenType/getActiveTokenTypes": { "get": { "tags": [ "TokenType" ], "summary": "All Active Token Types", "description": "Gets all active `TokenType` objects.", "operationId": "getActiveTokenTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/tokenType/getAllTokenTypes": { "get": { "tags": [ "TokenType" ], "summary": "All Token Types", "description": "Gets all `TokenType` objects.", "operationId": "getAllTokenTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/tokenType/getTokenType": { "post": { "tags": [ "TokenType" ], "summary": "Token Type", "description": "Gets the `TokenType` object for a specific TokenType.", "operationId": "getTokenTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenType to search for", "required": true, "schema": { "$ref": "#/definitions/TokenTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenType/insert": { "post": { "tags": [ "TokenType" ], "summary": "Insert Token Type", "description": "Insert a new `TokenType` record.", "operationId": "insertTokenTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenType to insert", "required": true, "schema": { "$ref": "#/definitions/TokenTypeInsertRequest" } } ], "responses": { "200": { "description": "Token Type successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Token Type Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/tokenType/update": { "post": { "tags": [ "TokenType" ], "summary": "Update Token Type", "description": "Update an existing `TokenType` record.", "operationId": "updateTokenTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "TokenType to update", "required": true, "schema": { "$ref": "#/definitions/TokenTypeUpdateRequest" } } ], "responses": { "200": { "description": "Token Type successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Token Type does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/upldTran/getUpldTrn": { "post": { "tags": [ "UpldTrn" ], "summary": "UpldTrn", "operationId": "getUpldTrnUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Purchase order details to search by", "required": true, "schema": { "$ref": "#/definitions/UpldTrnRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpldTrnResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/upldTran/getUpldTrns": { "get": { "tags": [ "UpldTrn" ], "summary": "UpldTrn", "operationId": "getUpldTrnsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 }, { "name": "trnTypeIdNos", "in": "query", "description": "trnTypeIdNos", "required": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpldTrnListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/upldTran/getUpldTrnsByCriteria": { "post": { "tags": [ "UpldTrn" ], "summary": "UpldTrn", "operationId": "getUpldTrnByCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Purchase order details to search by", "required": true, "schema": { "$ref": "#/definitions/UpldTrnCriteriaRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpldTrnListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/upldTran/reQueueUpldTran": { "post": { "tags": [ "UpldTrn" ], "summary": "Re-queue Upld Trn", "description": "Re-queueing an existing `UpldTrn` record.", "operationId": "reQueueUpldTranUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Upld Trn to update", "required": true, "schema": { "$ref": "#/definitions/UpldTrnPojo" } } ], "responses": { "200": { "description": "Upld Trn successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Upld Trn does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/upldTran/update": { "post": { "tags": [ "UpldTrn" ], "summary": "Update Upld Trn", "description": "Update an existing `UpldTrn` record.", "operationId": "updateUpldTrnUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Upld Trn to update", "required": true, "schema": { "$ref": "#/definitions/UpldTrnPojo" } } ], "responses": { "200": { "description": "Upld Trn successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Upld Trn does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/writeOffReason/delete": { "post": { "tags": [ "WriteOffReason" ], "summary": "Delete Write Off Reason", "description": "Delete an existing `WriteOffReason` record.", "operationId": "deleteWriteOffReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "WriteOffReason to delete", "required": true, "schema": { "$ref": "#/definitions/WriteOffReasonDeleteRequest" } } ], "responses": { "200": { "description": "Write Off Reason successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/writeOffReason/getWriteOffReason": { "post": { "tags": [ "WriteOffReason" ], "summary": "Write Off Reason", "description": "Gets the `WriteOffReason` object for a specific write off reason.", "operationId": "getWriteOffReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "WriteOffReason to search for", "required": true, "schema": { "$ref": "#/definitions/WriteOffReasonRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WriteOffReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/writeOffReason/getWriteOffReasons": { "get": { "tags": [ "WriteOffReason" ], "summary": "Active Write Off Reasons", "description": "Gets al active `WriteOffReason` objects.", "operationId": "getAllWriteOffReasonsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WriteOffReasonListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/lookup/writeOffReason/insert": { "post": { "tags": [ "WriteOffReason" ], "summary": "Insert Write Off Reason", "description": "Insert a new `WriteOffReason` record.", "operationId": "insertWriteOffReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "WriteOffReason to insert", "required": true, "schema": { "$ref": "#/definitions/WriteOffReasonInsertRequest" } } ], "responses": { "200": { "description": "Write Off Reason successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Write Off Reason Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/lookup/writeOffReason/update": { "post": { "tags": [ "WriteOffReason" ], "summary": "Update Write Off Reason", "description": "Update an existing `WriteOffReason` record.", "operationId": "updateWriteOffReasonUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "WriteOffReason to update", "required": true, "schema": { "$ref": "#/definitions/WriteOffReasonUpdateRequest" } } ], "responses": { "200": { "description": "Write Off Reason successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Write Off Reason does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerification/getLspVerificationById": { "post": { "tags": [ "LspVerification" ], "summary": "Lsp Verification", "description": "Gets a single `LspVerification` object by its primary id", "operationId": "getLspVerificationByIdUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LSP Verification Code to search by", "required": true, "schema": { "$ref": "#/definitions/LSPVerificationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspVerificationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerification/getLspVerifications": { "get": { "tags": [ "LspVerification" ], "summary": "Lsp Verification", "description": "Gets all `LspVerification` objects", "operationId": "getLspVerificationsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspVerificationListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/LspVerification/insert": { "post": { "tags": [ "LspVerification" ], "summary": "Lsp Verification", "description": "Creates a new `LspVerification` objects ", "operationId": "insertLspVerificationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspVerification to Create", "required": true, "schema": { "$ref": "#/definitions/LspVerificationPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerification/update": { "post": { "tags": [ "LspVerification" ], "summary": "Lsp Verification", "description": "update an existing `LspVerification` object.", "operationId": "updateLspVerificationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspVerification to be updated", "required": true, "schema": { "$ref": "#/definitions/LspVerificationPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerificationType/delete": { "post": { "tags": [ "LspVerificationType" ], "summary": "Lsp Verification Type", "description": "delete an existing `LspVerificationType` object.", "operationId": "deleteLspVerificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspVerificationType to be delete", "required": true, "schema": { "$ref": "#/definitions/LspVerificationTypePojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerificationType/getLspVerificationTypeById": { "post": { "tags": [ "LspVerificationType" ], "summary": "Lsp Verification Type", "description": "Gets a single `LspVerificationType` object by its primary id", "operationId": "getLspVerificationTypeByIdUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LSP Verification Type to search by", "required": true, "schema": { "$ref": "#/definitions/LSPVerificationTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspVerificationTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerificationType/getLspVerificationTypes": { "get": { "tags": [ "LspVerificationType" ], "summary": "Lsp Verification Type", "description": "Gets all `LspVerificationType` objects", "operationId": "getLspVerificationTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LspVerificationTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/LspVerificationType/insert": { "post": { "tags": [ "LspVerificationType" ], "summary": "Lsp Verification Type", "description": "Creates a new `LspVerificationType` objects ", "operationId": "insertLspVerificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspVerificationType to Create", "required": true, "schema": { "$ref": "#/definitions/LspVerificationTypePojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/LspVerificationType/update": { "post": { "tags": [ "LspVerificationType" ], "summary": "Lsp Verification Type", "description": "update an existing `LspVerificationType` object.", "operationId": "updateLspVerificationTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "LspVerificationType to be updated", "required": true, "schema": { "$ref": "#/definitions/LspVerificationTypePojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/SystemNotifications/notifyCourierDeliverySequenceNo": { "get": { "tags": [ "SystemNotifications" ], "summary": "System Notifications", "description": "This will be all system notifications that will need to run", "operationId": "notifyCourierDeliverySequenceNoUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/SystemNotifications/notifyCourierPickupSequenceNo": { "get": { "tags": [ "SystemNotifications" ], "summary": "System Notifications", "description": "This will be all system notifications that will need to run", "operationId": "notifyCourierPickupSequenceNoUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/billingEntity/delete": { "post": { "tags": [ "BillingEntity" ], "summary": "Billing Entity", "description": "Deletes a `BillingEntity` object", "operationId": "deleteBillingEntityUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "BillingEntity to delete", "required": true, "schema": { "$ref": "#/definitions/BillingEntityDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/billingEntity/getBillingEntities": { "get": { "tags": [ "BillingEntity" ], "summary": "Billing Entity", "description": "Gets all `BillingEntity` objects", "operationId": "getBillingEntitiesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BillingEntityListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/billingEntity/getBillingEntity": { "post": { "tags": [ "BillingEntity" ], "summary": "Billing Entity", "description": "Gets a `BillingEntity` objects", "operationId": "getBillingEntityUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Billing Entity to search by", "required": true, "schema": { "$ref": "#/definitions/BillingEntityRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BillingEntityResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/billingEntity/insert": { "post": { "tags": [ "BillingEntity" ], "summary": "Billing Entity", "description": "Insert a `BillingEntity` object", "operationId": "insertBillingEntityUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "BillingEntity to Create", "required": true, "schema": { "$ref": "#/definitions/BillingEntityInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/billingEntity/update": { "post": { "tags": [ "BillingEntity" ], "summary": "Billing Entity", "description": "Updates a `BillingEntity` object", "operationId": "updateBillingEntityUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "BillingEntity to update", "required": true, "schema": { "$ref": "#/definitions/BillingEntityUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/booking/delete": { "post": { "tags": [ "Booking" ], "summary": "Delete Booking", "description": "Delete an existing `Booking` record.", "operationId": "deleteBookingUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking to delete", "required": true, "schema": { "$ref": "#/definitions/BookingUserRequest" } } ], "responses": { "200": { "description": "Booking successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/booking/getBooking": { "post": { "tags": [ "Booking" ], "summary": "Get booking.", "description": "Gets the `Booking` object for a specific booking.", "operationId": "getBookingUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The booking to search for", "required": true, "schema": { "$ref": "#/definitions/BookingNoRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/booking/getBookings": { "get": { "tags": [ "Booking" ], "summary": "Get all bookings", "description": "Gets all `Booking` objects.", "operationId": "getAllBookingsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBookingsResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/booking/insert": { "post": { "tags": [ "Booking" ], "summary": "Insert Booking", "description": "The courier must make a delivery announcement prior to loading, so that the Parcel Management Module can validate that the node is indeed capable of receiving the delivery and a trip is not wasted. Reasons for not being able to receive a delivery might be that a node is closed (permanently or temporarily due to flood / fire / revamp) or a device being stolen or broken and they are waiting for a replacement. There may only be one open booking per node, per courier. A node will not be able to receive a delivery from the courier if the courier didn't do the delivery announcement before arriving at the node. For the couriers.", "operationId": "insertBookingUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking object that needs to be inserted. For couriers", "required": true, "schema": { "$ref": "#/definitions/BookingInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BookingManifestResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/booking/insertEManifest": { "post": { "tags": [ "Booking" ], "summary": "Courier sends the electronic booking manifest", "description": "An e-manifest with a unique manifest number is required after the logistics service provider loaded the truck and after the delivery announcement has been done. The booking number received in the response of the delivery announcement API call must be used for the e-manifest. A node will not be able to receive a delivery from the logistics service provider if the logistics service provider didn�t do both the delivery announcement and e-manifest calls before arriving at the node.", "operationId": "insertEManifestUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Courier sends the electronic booking manifest. For couriers.", "required": true, "schema": { "$ref": "#/definitions/ElectronicManifestPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BookingManifestResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/booking/update": { "post": { "tags": [ "Booking" ], "summary": "Update Booking", "description": "Update an existing `Booking` record.", "operationId": "updateBookingUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Booking object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/BookingUpdateRequest" } } ], "responses": { "200": { "description": "Booking successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "BookingNo must be populated" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/cleanUp/cleanUpTestData": { "post": { "tags": [ "CleanUp" ], "summary": "Removes all parcels, events and tansactions", "description": "Removes all parcels, events and tansactions for a list of nodes or[/and] supplierCodes.", "operationId": "cleanUpTestDataAsyncUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/cleanUp/isCleanUpTestDataRunning": { "get": { "tags": [ "CleanUp" ], "summary": "Removes test data", "description": "Asynchronous test cleanup", "operationId": "cleanUpTestResetAsyncIsRunningUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/cleanUp/reset": { "get": { "tags": [ "CleanUp" ], "summary": "Removes test data", "description": "Asynchronous test cleanup reset", "operationId": "cleanUpTestResetAsyncUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/customerCollection/insertCustomerCollection": { "post": { "tags": [ "CustomerCollection" ], "summary": "CustomerCollection", "description": "Used to do a customerCollection", "operationId": "insertCustomerCollectionUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "customer details required for customer collection", "required": true, "schema": { "$ref": "#/definitions/CustomerCollectionInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerCollection/searchAndValidateCustomer": { "post": { "tags": [ "Validation" ], "summary": "Validate and searchs customer", "description": "Checks whether the supplied customer reference code is valid and searchs for customer", "operationId": "searchAndValidateCustomerUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code to validate", "required": true, "schema": { "$ref": "#/definitions/SearchAndValidateCustomerPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidCustomerSearchReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegister/getCustomerRefRegister": { "post": { "tags": [ "CustomerRefRegister" ], "summary": "Customer Reference Register", "description": "CustomerRefRegister", "operationId": "getCustomerRefRegisterUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Details to search by", "required": true, "schema": { "$ref": "#/definitions/CustomerRefRegisterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerRefRegisterResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegister/getCustomerRefRegisters": { "get": { "tags": [ "CustomerRefRegister" ], "summary": "Customer Reference Register", "description": "CustomerRefRegister", "operationId": "getCustomerRefRegistersUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerRefRegisterListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/customerRefRegister/getCustomerRefRegistersCriteria": { "post": { "tags": [ "CustomerRefRegister" ], "summary": "Customer Reference Register", "description": "CustomerRefRegister", "operationId": "getCustomerRefRegistersCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Details to search by", "required": true, "schema": { "$ref": "#/definitions/CustomerRefRegisterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerRefRegisterPojo" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegister/update": { "post": { "tags": [ "CustomerRefRegister" ], "summary": "Customer Reference Register", "description": "CustomerRefRegister", "operationId": "updateCustomerRefRegisterUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Ref Register Details to generate", "required": true, "schema": { "$ref": "#/definitions/CustomerRefRegisterUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegisterBatch/getBatchCustomerRefRegisters": { "get": { "tags": [ "CustomerRefRegisterBatch" ], "summary": "Customer Reference Register Batch", "description": "CustomerRefRegisterBatch", "operationId": "getBatchCustomerRefRegistersUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchCustomerRefCodesListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/customerRefRegisterBatch/getBatchCustomerRefRegistersCriteria": { "post": { "tags": [ "CustomerRefRegisterBatch" ], "summary": "Customer Reference Register Batch", "description": "CustomerRefRegisterBatch", "operationId": "getBatchCustomerRefRegistersCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Batch Details to search by", "required": true, "schema": { "$ref": "#/definitions/BatchCustomerRefRegisterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchCustomerRefCodesListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegisterBatch/getCustomerRefRegisterBatch": { "post": { "tags": [ "CustomerRefRegisterBatch" ], "summary": "Customer Reference Register Batch", "description": "CustomerRefRegisterBatch", "operationId": "getCustomerRefRegisterBatchUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Batch Details to search by", "required": true, "schema": { "$ref": "#/definitions/BatchCustomerRefRegisterRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchCustomerRefCodesResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegisterBatch/insert": { "post": { "tags": [ "CustomerRefRegisterBatch" ], "summary": "Customer Reference Register Batch", "operationId": "insertCustomerRefRegisterBatchUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Batch Details to search by", "required": true, "schema": { "$ref": "#/definitions/BatchCustomerRefCodesInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegisterBatch/scheduleCustomerRefRegisterBatch": { "post": { "tags": [ "CustomerRefRegisterBatch" ], "summary": "Customer Reference Register Batch", "operationId": "scheduleCustomerRefRegisterBatchUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/customerRefRegisterBatch/update": { "post": { "tags": [ "CustomerRefRegisterBatch" ], "summary": "Customer Reference Register Batch", "description": "CustomerRefRegisterBatch", "operationId": "updateCustomerRefRegisterBatchUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Reference Register Batch Details to search by", "required": true, "schema": { "$ref": "#/definitions/BatchCustomerRefRegisterUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/dropToken/authoriseDropToken": { "post": { "tags": [ "DropToken" ], "summary": "Authorise Drop Token", "description": "Authorise a `DropToken` request from POS.", "operationId": "authoriseDropTokenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to authorise", "required": true, "schema": { "$ref": "#/definitions/DropTokenAuthRequest" } } ], "responses": { "200": { "description": "Drop Token successfully inserted", "schema": { "$ref": "#/definitions/DropTokenResponse" } }, "400": { "description": "The value for Drop Token Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/dropToken/expireDropTokens": { "get": { "tags": [ "DropToken" ], "summary": "Expire drop tokens that have reached the end of their life", "description": "Used by daily cronjob to expire drop tokens that have reached the end of their life", "operationId": "expireDropTokensUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/dropToken/insert": { "post": { "tags": [ "DropToken" ], "summary": "Insert Drop Token", "description": "Insert a new `DropToken` record.", "operationId": "insertDropTokenUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to insert", "required": true, "schema": { "$ref": "#/definitions/DropTokenInsertRequestExternal" } } ], "responses": { "200": { "description": "Drop Token successfully inserted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "The value for Drop Token Code must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/dropToken/update": { "post": { "tags": [ "DropToken" ], "summary": "Update Drop Token", "description": "Update an existing `DropToken` record.", "operationId": "updateDropTokenUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "DropToken to update", "required": true, "schema": { "$ref": "#/definitions/DropTokenUpdateRequest" } } ], "responses": { "200": { "description": "Drop Token successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Drop Token does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/onebalance/getOneBalanceRecon": { "get": { "tags": [ "OneBalance" ], "summary": "One Balance Recon", "description": "Gets the OneBalance recon for the day.", "operationId": "getOneBalanceReconUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DropTokenModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/automaticParcelReturnRequest": { "get": { "tags": [ "Parcel" ], "summary": "Call is used to request parcels to be returned to the supplier.", "operationId": "automaticParcelReturnRequestUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelUpdateStatusResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/cancelNonCollectionReturn": { "post": { "tags": [ "Parcel" ], "summary": "Cancel Non-Collection Return", "description": "Cancels a non-collection return.", "operationId": "cancelNonCollectionReturnUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "parcelIdUserIdRequest", "description": "parcelIdUserIdRequest", "required": true, "schema": { "$ref": "#/definitions/ParcelIdUserIdRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CancelNonCollectionReturnPojo" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/delete": { "post": { "tags": [ "Parcel" ], "summary": "Delete Parcel", "description": "Delete an existing `Parcel` record.", "operationId": "deleteParcelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel to delete", "required": true, "schema": { "$ref": "#/definitions/ParcelDeleteRequest" } } ], "responses": { "200": { "description": "Parcel successfully deleted", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/expirecollections": { "post": { "tags": [ "Parcel" ], "summary": "Expire collections that are ready for collection state for too long", "description": "Used by daily cronjob to expire collections that are ready for collection for longer than the product allows", "operationId": "expireParcelCollectionsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getCounts": { "post": { "tags": [ "Alerts and instructions" ], "summary": "Get counts for messages and missing, non collected parcels", "description": "Get counts for messages and missing, non collected parcels.", "operationId": "getCountsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "The counts for a specific node", "required": true, "schema": { "$ref": "#/definitions/CurrentNodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetCountsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getMissingParcels": { "post": { "tags": [ "Alerts and instructions" ], "summary": "All Parcels Marked as Missing", "description": "Gets a list of `Parcel` objects that are marked as missing.", "operationId": "getAllMissingParcelsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter criteria to search for", "required": true, "schema": { "$ref": "#/definitions/NodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MissingParcelPojo" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getNonCollectionCancelParcels": { "post": { "tags": [ "Parcel" ], "summary": "Non-Collection Cancel Parcels", "operationId": "getNonCollectionCancelParcelsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "NodeIdNo to search by", "required": true, "schema": { "$ref": "#/definitions/CurrentNodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNonCollectionParcelsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getNonCollectionReturnParcels": { "post": { "tags": [ "Alerts and instructions" ], "summary": "All Parcels Non Collection Return", "description": "Gets a list of `Parcel` objects that are marked as Non Collection Return.", "operationId": "getNonCollectionReturnParcelsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter criteria to search for", "required": true, "schema": { "$ref": "#/definitions/CurrentNodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetNonCollectionParcelsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcel": { "post": { "tags": [ "Parcel" ], "summary": "Parcel", "description": "Gets the `Parcel` object for a specific parcel. ", "operationId": "getParcelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel Id, Customer reference code, Logistics service provider parcel code or Logistics service provider waybill code to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelRequest" } }, { "name": "excludeParcelStatuses", "in": "query", "description": "excludeParcelStatuses", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelBasic": { "post": { "tags": [ "Parcel" ], "summary": "Parcel", "description": "Gets the `Parcel` object for a specific parcel.", "operationId": "getParcelBasicUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "parcelPojo", "required": true, "schema": { "$ref": "#/definitions/ParcelRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelByDropTokenCode": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels for specific dropTokenCode", "description": "Gets all `Parcel` objects by dropTokenCode", "operationId": "getParcelByDropTokenCodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node and logistics service provider to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelDropTokenCodeSearchRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelByNodeLSP": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels for specific node and logistics service provider", "description": "Gets all `Parcel` objects currently at a specific node for a specific logistics service provider.", "operationId": "getParcelByNodeLSPUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node and logistics service provider to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelNodeLSPRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelExpirationCount": { "post": { "tags": [ "Parcel" ], "summary": "Parcel Expiration Count", "operationId": "getParcelExpirationCountUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "nodeIdNo to search by", "required": true, "schema": { "$ref": "#/definitions/NodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelFiltered": { "post": { "tags": [ "Parcel" ], "summary": "All Filtered Parcels", "description": "Gets a filtered list of `Parcel` objects.", "operationId": "getParcelFilteredUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter criteria to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelFilteredRequest" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelSms": { "post": { "tags": [ "Parcel" ], "summary": "Parcel SMS", "description": "Data needed to generate a Parcel sms.", "operationId": "getParcelSmsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelSmsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelSmsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcels/incompletePOD": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels with inclomplete POD", "description": "Gets all `Parcel` objects that have an incomplete POD", "operationId": "getParcelByIncompletePODUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Search criteria", "required": true, "schema": { "$ref": "#/definitions/GetParcelByIncompletePOD" } }, { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelPojo" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelsAwaitingCollection": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels ready for courier collection", "description": "Gets all `Parcel` objects in 'AWAITING COLLECTION' status, that has not yet had a reminder sms sent.", "operationId": "getParcelsAwaitingCollectionUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetParcelsAwaitingCollectionResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getParcelsAwaitingCollectionReminder": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels ready for courier collection", "description": "Gets all `Parcel` objects in 'AWAITING COLLECTION' status, that has had a reminder sms sent.", "operationId": "getParcelsAwaitingCollectionReminderUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetParcelsAwaitingCollectionReminderResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getParcelsAwaitingUpliftment": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels ready for courier collection", "description": "Gets all `Parcel` objects currently at a specific node for a specific logistics service provider in 'AWAITING UPLIFTMENT' status.", "operationId": "getParcelsAwaitingUpliftmentUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node and logistics service provider to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelAwaitingUpliftmentRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetParcelsAwaitingUpliftmentResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelsAwaitingUpliftmentSummary": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels ready for courier collection", "description": "Gets all `Parcel` objects currently at a specific node for a specific logistics service provider in 'AWAITING UPLIFTMENT' status.", "operationId": "getParcelsAwaitingUpliftmentSummaryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node and logistics service provider to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelAwaitingUpliftmentSummaryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CourierCollectionResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelsByStatusNodeBooking": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels for specific node and booking", "description": "Gets all `Parcel` objects currently at a specific node for a specific booking.", "operationId": "getParcelsByStatusNodeBookingUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node and logistics service provider to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelsStatusNodeBookingRequest" } } ], "responses": { "200": { "description": "Successfull response", "schema": { "$ref": "#/definitions/NodeBookingParcelListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getParcelsDeliveredByCourier": { "post": { "tags": [ "Parcel" ], "summary": "All Parcels delivered by the courier", "description": "Gets all `Parcel` objects currently at a specific node for a specific logistics service provider in 'DELIVERY TRIP' status.", "operationId": "getParcelsDeliveredByCourierUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node and logistics service provider to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelsDeliveredByCourierRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetParcelsDeliveredByCourierResult" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/getQueuedCorrectionParcels ": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels in 'QUEUED FOR CORRECTION' status", "description": "Gets all `Parcel` objects currently in 'QUEUED FOR CORRECTION' status.", "operationId": "getQueuedCorrectionParcelsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getQueuedPODParcels": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels in 'QUEUED POD' status", "operationId": "getQueuedPODParcelsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getQueuedParcels": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels in 'QUEUED FOR COURIER' status", "description": "Gets all `Parcel` objects currently in 'QUEUED FOR COURIER' status.", "operationId": "getQueuedParcelsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getQueuedParcelsErrorList": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels in some 'QUEUED' status", "description": "UnProcessedPaxiEvents that are in error state", "operationId": "getQueuedParcelsErrorListUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueuedParcelsListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getQueuedParcelsList": { "get": { "tags": [ "Parcel" ], "summary": "All Parcels in some 'QUEUED' status", "description": "Gets all `Parcel` objects currently in 'QUEUED' status.", "operationId": "getQueuedParcelsListUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueuedParcelsListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcel/getStorageLocationParcelCount": { "post": { "tags": [ "Parcel" ], "summary": "Storage Location Parcel Count", "operationId": "getStorageLocationParcelCountUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "nodeIdNo to search by", "required": true, "schema": { "$ref": "#/definitions/NodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetStorageLocationParcelCountResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/insert": { "post": { "tags": [ "Parcel" ], "summary": "Insert Parcel", "description": "Insert a new `Parcel` record.", "operationId": "insertParcelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel object to be inserted", "required": true, "schema": { "$ref": "#/definitions/ParcelInsertRequest" } } ], "responses": { "200": { "description": "Parcel successfully inserted", "schema": { "$ref": "#/definitions/InsertParcelResponse" } }, "400": { "description": "The value for Parcel Id No must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/miscClosure": { "post": { "tags": [ "Parcel" ], "summary": "MiscClosure", "description": "RAM MiscClosure.", "operationId": "miscClosureUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "miscClosure", "description": "miscClosure", "required": true, "schema": { "$ref": "#/definitions/MiscClosurePojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/parcelPreRegistration": { "post": { "tags": [ "Parcel" ], "summary": "Parcel pre-registration", "description": "Pre-registration of a parcel", "operationId": "parcelPreRegistrationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel details for pre-registration", "required": true, "schema": { "$ref": "#/definitions/ParcelPreInductionInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/parcelStatusUpdate": { "post": { "tags": [ "Parcel" ], "summary": "ParcelStatusUpdate", "operationId": "parcelStatusUpdateUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "statusUpate", "description": "statusUpate", "required": true, "schema": { "$ref": "#/definitions/UpdateParcelStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/requestParcelReturn": { "post": { "tags": [ "Parcel" ], "summary": "Call is used to request a specific parcel to be returned to the supplier.", "description": "This API call is used to request a specific parcel to be returned to the supplier. For suppliers", "operationId": "requestParcelReturnUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel Update", "required": true, "schema": { "$ref": "#/definitions/ParcelReturnRequest" } } ], "responses": { "200": { "description": "Parcel return request successfully processed", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/update": { "post": { "tags": [ "Parcel" ], "summary": "Update Parcel", "description": "This API call is used to update the destination node and receiving customer�s cellphone number. This should be used when the courier reroutes a parcel or if the cellphone number for the receiving customer needs to be updated.\n\n**destinationNodeCode** - for Couriers\n\n**productIdNo** - for Suppliers\n\n**lengthCm** - for Suppliers\n\n**widthCm** - for Suppliers\n\n**heightCm** - for Suppliers\n\n**weightKg** - for Suppliers\n\n**bexCostAmt** - for Suppliers\n\n**bexSellAmt** - for Suppliers\n\n**bincSellAmt** - for Suppliers", "operationId": "updateParcelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ParcelUpdateRequest" } } ], "responses": { "200": { "description": "Parcel successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Parcel does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCourierDropLabel": { "post": { "tags": [ "Validation" ], "summary": "Validate courier drop label barcode", "description": "Checks whether the supplied drop label barcode is valid.", "operationId": "validateCourierDropLabelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Drop label barcode to validate", "required": true, "schema": { "$ref": "#/definitions/ValidateCourierDropLabelPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidNodeReponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCustCodeForCustCollection": { "post": { "tags": [ "Validation" ], "summary": "Validate customer reference for Customer Collection", "description": "Checks whether the supplied customer reference code may be collected at the specific node.", "operationId": "validateCustRefOrCollectionPinForCustCollectionUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code and node to validate", "required": true, "schema": { "$ref": "#/definitions/CustRefForCustCollectionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidCustomerCollectionResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCustRefCodePutaway": { "post": { "tags": [ "Validation" ], "summary": "Validate customer reference for Put Away", "description": "Checks whether the supplied customer reference code may be put away at the specific node.", "operationId": "validateCustRefCodePutawayUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code and node to validate", "required": true, "schema": { "$ref": "#/definitions/CustRefCodePutawayRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidationReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCustRefForCustCollection": { "post": { "tags": [ "Validation" ], "summary": "Validate customer reference for Customer Collection", "description": "Checks whether the supplied customer reference code may be collected at the specific node.", "operationId": "validateCustRefOrCollectionPinForCustCollectionUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code and node to validate", "required": true, "schema": { "$ref": "#/definitions/CustRefForCustCollectionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidCustomerCollectionResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCustomerCode": { "post": { "tags": [ "Validation" ], "summary": "Validate customer collection pin", "description": "Checks whether the supplied customer reference code and customer collection pin matches up.", "operationId": "validateCustomerCodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code to validate", "required": true, "schema": { "$ref": "#/definitions/ValidateCustomerCode" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidationReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCustomerPin": { "post": { "tags": [ "Validation" ], "summary": "Validate customer collection pin", "description": "Checks whether the supplied customer reference code and customer collection pin matches up.", "operationId": "validateCustomerCodeUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code to validate", "required": true, "schema": { "$ref": "#/definitions/ValidateCustomerCode" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidationReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateCustomerReferenceCode": { "post": { "tags": [ "Validation" ], "summary": "Validate customer reference", "description": "Checks whether the supplied customer reference code is valid.", "operationId": "validateCustomerReferenceCodeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code to validate", "required": true, "schema": { "$ref": "#/definitions/CustomerReferenceCodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidationReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateDropLabel": { "post": { "tags": [ "Validation" ], "summary": "Validate drop label barcode", "description": "Checks whether the supplied drop label barcode is valid.", "operationId": "validateDropLabelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Drop label barcode to validate", "required": true, "schema": { "$ref": "#/definitions/CustomerReferenceCodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidateDropLabelResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateParcelEligibleForDelivery": { "post": { "tags": [ "Parcel" ], "summary": "Validate Parcel Eligible For Delivery", "description": "Validates Parcels eligible for delivery where the barcode matches a parcel record for either the customerRefCode, logServProvWaybillCode or logServProvParcelCode and the parcel is linked to the specified logistics service provider and destined for the specified node. The parcel may be in any parcel status other than the following:\n\nCOLLECTED \n\nLOST \n\nDELIVERED \n\nCANCELLED \n\nCLOSED \n\nAWAITING COLLECTION \n\nINCOMPLETE COLLECTION", "operationId": "validateParcelEligibleForDeliveryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Node, logistics service provider and eventReferenceCode to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelEligibleForDeliveryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelEligibleForDeliveryListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcel/validateParcelStatus": { "post": { "tags": [ "Validation" ], "summary": "Validate parcel status for Put Away", "description": "Checks whether the supplied customer reference code may be put away at the specific node and in is in the correct status.", "operationId": "validateParcelStatusUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer reference code, node and current parcel status to validate", "required": true, "schema": { "$ref": "#/definitions/ValidateParcelStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidationReasonResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/closeCollection": { "post": { "tags": [ "ParcelEvent" ], "summary": "Insert Parcel Events for Logistics Service Provider Collection", "description": "Insert new `ParcelEvent` record(s) for the Logistics Service Provider Collection process.", "operationId": "closeCollectionUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Logistics Service Provider Collection process data to be processed", "required": true, "schema": { "$ref": "#/definitions/ParcelEventCloseCollectionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CourierCollectionResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/closeDelivery": { "post": { "tags": [ "ParcelEvent" ], "summary": "Insert Parcel Events for Logistics Service Provider Delivery", "description": "Insert new `ParcelEvent` record(s) for the Logistics Service Provider Delivery process.", "operationId": "closeDeliveryUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Logistics Service Provider Delivery process data to be processed", "required": true, "schema": { "$ref": "#/definitions/CloseDeliveryRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloseDeliveryResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/delete": { "post": { "tags": [ "ParcelEvent" ], "summary": "Delete Parcel Event", "description": "Delete an existing `ParcelEvent` record.", "operationId": "deleteParcelEventUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEvent to delete", "required": true, "schema": { "$ref": "#/definitions/ParcelEventDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/deleteProcessedTransactions": { "get": { "tags": [ "ParcelEvent" ], "summary": "Transactions", "description": "Delete ProcessedPaxiEvents", "operationId": "deleteProcessedTransactionsUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcelEvent/deleteUnProcessedTransactions": { "get": { "tags": [ "ParcelEvent" ], "summary": "Transactions", "description": "Delete UnProcessedPaxiEvents", "operationId": "deleteUnProcessedTransactionsUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/parcelEvent/getCustomerDropInfo": { "post": { "tags": [ "ParcelEvent" ], "summary": "Gets customer drop information", "description": "Gets the customer drop information for a specific `Parcel` record.", "operationId": "getCustomerDropInfoUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEvent to search for", "required": true, "schema": { "$ref": "#/definitions/CustomerDropInfoRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerDropResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/getParcelEvent": { "post": { "tags": [ "ParcelEvent" ], "summary": "Parcel Event", "description": "Gets the `ParcelEvent` object for a specific Parcel Event.", "operationId": "getParcelEventUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEvent to search for", "required": true, "schema": { "$ref": "#/definitions/ParcelEventRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelEventResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/getParcelEventByParcel": { "post": { "tags": [ "ParcelEvent" ], "summary": "Parcel Events by Parcel", "description": "Gets the `ParcelEvent` records for a specific parcel.", "operationId": "getParcelEventByParcelUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel to filter by", "required": true, "schema": { "$ref": "#/definitions/ParcelEventIdRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ParcelEventListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/getUnprocessedPaxiEvents": { "post": { "tags": [ "ParcelEvent" ], "summary": "Transactions", "description": "UnProcessedPaxiEvents", "operationId": "getUnprocessedPaxiEventsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 }, { "in": "body", "name": "unProcessedPaxiEventsPojo", "description": "unProcessedPaxiEventsPojo", "required": true, "schema": { "$ref": "#/definitions/UnProcessedPaxiEventsPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetUnProcessedPaxiEventsResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/insert": { "post": { "tags": [ "ParcelEvent" ], "summary": "Insert Parcel Event", "description": "This API call is used to insert courier events in the Parcel Management Module. For couriers.", "operationId": "insertParcelEventUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEvent object that needs to be inserted", "required": true, "schema": { "$ref": "#/definitions/ParcelEventInsertRequest" } } ], "responses": { "200": { "description": "Parcel Event successfully inserted", "schema": { "$ref": "#/definitions/SingleIntegerResponse" } }, "400": { "description": "The value for Parcel Id No, Parcel Event Type Id No, Node Location Id No and Event Datetime must be unique" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/insertCustomerDrop": { "post": { "tags": [ "ParcelEvent" ], "summary": "insertCustomerDrop", "description": "This API will be used to perform the parcel insert and parcel event insert for a customer drop", "operationId": "insertCustomerDropUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Details to be used in the drop", "required": true, "schema": { "$ref": "#/definitions/CustomerDropInsertPojo" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerDropInsertResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/insertSupplierDrop": { "post": { "tags": [ "ParcelEvent" ], "summary": "Gets supplier drop information", "description": "This API call is used to do a supplier drop, to request the courier to collect the parcel from the supplier. For suppliers", "operationId": "insertSupplierDropUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Parcel Event to search for", "required": true, "schema": { "$ref": "#/definitions/SupplierDropPojo" } } ], "responses": { "200": { "description": "Supplier drop successfully processed", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/parcelEvent/update": { "post": { "tags": [ "ParcelEvent" ], "summary": "Update Parcel Event", "description": "Update an existing `ParcelEvent` record.", "operationId": "updateParcelEventUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "ParcelEvent object that needs to be updated", "required": true, "schema": { "$ref": "#/definitions/ParcelEventUpdateRequest" } } ], "responses": { "200": { "description": "Parcel Event successfully updated", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "400": { "description": "Specified Parcel Event does not exist" }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/paymentTermsType/delete": { "post": { "tags": [ "PaymentTermsType" ], "summary": "Payment Terms Type", "description": "Deletes a `PaymentTermsType` object", "operationId": "deletePaymentTermsTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "PaymentTermsType to delete", "required": true, "schema": { "$ref": "#/definitions/PaymentTermsTypeDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/paymentTermsType/getPaymentTermsType": { "post": { "tags": [ "PaymentTermsType" ], "summary": "Payment Terms Type", "description": "Gets a `PaymentTermsType` objects", "operationId": "getPaymentTermsTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Payment Terms Type to search by", "required": true, "schema": { "$ref": "#/definitions/PaymentTermsTypeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentTermsTypeResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/paymentTermsType/getPaymentTermsTypes": { "get": { "tags": [ "PaymentTermsType" ], "summary": "Payment Terms Type", "description": "Gets all `PaymentTermsType` objects", "operationId": "getPaymentTermsTypesUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentTermsTypeListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/paymentTermsType/insert": { "post": { "tags": [ "PaymentTermsType" ], "summary": "Payment Terms Type", "description": "Insert a `PaymentTermsType` object", "operationId": "insertPaymentTermsTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "PaymentTermsType to Create", "required": true, "schema": { "$ref": "#/definitions/PaymentTermsTypeInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/paymentTermsType/update": { "post": { "tags": [ "PaymentTermsType" ], "summary": "Payment Terms Type", "description": "Updates a `PaymentTermsType` object", "operationId": "updatePaymentTermsTypeUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "PaymentTermsType to update", "required": true, "schema": { "$ref": "#/definitions/PaymentTermsTypeUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/purchaseOrder/getPurchaseOrders": { "get": { "tags": [ "PurchaseOrder" ], "summary": "PurchaseOrder", "operationId": "getPurchaseOrdersUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "csvSortFieldnames", "in": "query", "description": "Comma seperated field names by which to priorotise the sort", "required": false, "type": "string", "x-example": "name,surname" }, { "name": "pageSize", "in": "query", "description": "Start item that you are requesting (default=10 & max=100)", "required": false, "type": "integer", "format": "int32", "x-example": 10 }, { "name": "sortAscending", "in": "query", "description": "Direction of sort (true=asc | false=desc)", "required": false, "type": "boolean", "x-example": true }, { "name": "startIndex", "in": "query", "description": "Index of first record to return (0 indexed)", "required": false, "type": "integer", "format": "int32", "x-example": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PurchaseOrderListResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/purchaseOrder/getPurchaseOrdersByCriteria": { "post": { "tags": [ "PurchaseOrder" ], "summary": "PurchaseOrder", "operationId": "getPurchaseOrdersByCriteriaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Purchase order details to search by", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PurchaseOrderListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/purchaseOrder/getPurchaseOrdersById": { "post": { "tags": [ "PurchaseOrder" ], "summary": "PurchaseOrder", "operationId": "getPurchaseOrdersByIdUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Purchase order details to search by", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderSearchRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PurchaseOrderListResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/purchaseOrder/insert": { "post": { "tags": [ "PurchaseOrder" ], "summary": "PurchaseOrder", "operationId": "insertPurchaseOrderUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Details to validate", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderInsertRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/purchaseOrder/update": { "post": { "tags": [ "PurchaseOrder" ], "summary": "PurchaseOrder", "operationId": "updatePurchaseOrderUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/pmm/systemNotifications/getQueueNonSelfServiceNotifications": { "get": { "tags": [ "SystemNotifications" ], "summary": "SystemNotifications", "description": "Runs in the background to monitor various system notifications ", "operationId": "getQueueNonSelfServiceNotificationsUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleIntegerResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/systemNotifications/getQueueSelfServiceLspNotifications": { "get": { "tags": [ "SystemNotifications" ], "summary": "SystemNotifications", "description": "Runs in the background to monitor various system notifications ", "operationId": "getQueueSelfServiceLspNotificationsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "lspCode", "in": "query", "description": "lspCode", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleIntegerResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/pmm/systemNotifications/getQueueSelfServiceSupplierNotifications": { "get": { "tags": [ "SystemNotifications" ], "summary": "SystemNotifications", "description": "Runs in the background to monitor various system notifications ", "operationId": "getQueueSelfServiceSupplierNotificationsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "supplierCode", "in": "query", "description": "supplierCode", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleIntegerResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/testSpringCache": { "get": { "tags": [ "PAXI" ], "summary": "Test the Spring Cache", "operationId": "testSpringCacheUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "name", "in": "query", "description": "name", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleStringResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/v": { "get": { "tags": [ "PAXI" ], "summary": "Get PAXI version", "operationId": "getPmmVersionUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/validation/validateCellPhone": { "post": { "tags": [ "Validation" ], "summary": "Cellphone number validation", "description": "Validation of a cell number", "operationId": "validateCellPhoneUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "body", "description": "Customer Details to validate", "required": true, "schema": { "$ref": "#/definitions/CellPhoneNumberValidationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CellPhoneNumberValidationResponse" } }, "405": { "description": "Invalid input" } }, "deprecated": false } }, "/version": { "get": { "tags": [ "PAXI" ], "summary": "Get PAXI version", "operationId": "getPmmVersionUsingGET_1", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PmmResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } } }, "definitions": { "AwaitingCollectionParcelPojo": { "type": "object", "properties": { "collectWindowEndDatetime": { "type": "string", "description": "The collection window end date" }, "collectionPin": { "type": "string", "example": 14890, "description": "The pin a customer needs to collect thier parcel" }, "collectionSmsDatetime": { "type": "string", "description": "The date the collection sms was sent" }, "companyName": { "type": "string", "example": "PEP", "description": "The name of the company" }, "customerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "customerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The customer reference code" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "finalReminderSmsDatetime": { "type": "string", "description": "The date the final reminder sms was sent" }, "lastInscanDatetime": { "type": "string", "description": "The date the collection sms was sent to the customer" }, "logServProvParcelCode": { "type": "string", "example": "P151200400", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": 80000764200, "description": "The logistics service provider's waybill number" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "noOfSmsRetryDays": { "type": "integer", "format": "int32", "example": 3, "description": "The number of days that a parcel has been in store when a reminder sms must be sent to the customer to collect the parcel" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "parcelIdNo": { "type": "integer", "example": 1, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description of the parcel status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "reminderSmsDatetime": { "type": "string", "description": "The date the reminder sms was sent" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "AwaitingCollectionParcelPojo" }, "AwaitingCollectionReminderParcelPojo": { "type": "object", "properties": { "collectWindowEndDatetime": { "type": "string", "description": "The collection window end date" }, "collectionPin": { "type": "string", "example": 14890, "description": "The pin a customer needs to collect thier parcel" }, "collectionSmsDatetime": { "type": "string", "description": "The date the collection sms was sent" }, "companyName": { "type": "string", "example": "PEP", "description": "The name of the company" }, "customerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "customerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The customer reference code" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "finalReminderSmsDatetime": { "type": "string", "description": "The date the final reminder sms was sent" }, "lastInscanDatetime": { "type": "string", "description": "The date the collection sms was sent to the customer" }, "logServProvParcelCode": { "type": "string", "example": "P151200400", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": 80000764200, "description": "The logistics service provider's waybill number" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "noOfDaysTillReturn": { "type": "integer", "format": "int32" }, "noOfSmsRetryDays": { "type": "integer", "format": "int32", "example": 3, "description": "The number of days that a parcel has been in store when a reminder sms must be sent to the customer to collect the parcel" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "parcelIdNo": { "type": "integer", "example": 1, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description of the parcel status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "reminderSmsDatetime": { "type": "string", "description": "The date the reminder sms was sent" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "AwaitingCollectionReminderParcelPojo" }, "AwaitingNodeLocationParcelPojo": { "type": "object", "properties": { "allowTrustedCollectionInd": { "type": "string", "example": "Y", "description": "Indicator to show if a trusted collection is allowed" }, "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node" }, "currentNodeLocationIdNo": { "type": "integer", "format": "int32", "example": 20, "description": "Unique identifier for the current node - location combination" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "parcels": { "type": "array", "items": { "$ref": "#/definitions/AwaitingParcelPojo" } } }, "title": "AwaitingNodeLocationParcelPojo" }, "AwaitingParcelPojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "logServProvCollectionCode": { "type": "string", "example": "CCN18051100928419", "description": "The logistics service provider's collection number (it could contain letters)" }, "logServProvParcelCode": { "type": "string", "example": "P151200400", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": 80000764200, "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "originNodeNodeTypeDesc": { "type": "string", "example": "STORE", "description": "The description of the origin node type" }, "parcelIdNo": { "type": "integer", "example": 1, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeDesc": { "type": "string", "example": "PARCEL", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "T_30947284", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "kmjyotbxgr", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "AwaitingParcelPojo" }, "BatchCustomerRefCodesInsertRequest": { "type": "object", "required": [ "amountOfCustomerRefCodes", "customerPaymentTypeIdNo", "customerRefStatusIdNo", "userIdNo" ], "properties": { "amountOfCustomerRefCodes": { "type": "integer", "format": "int32", "example": 50, "description": "This will idicate how many refCodes is to be generated" }, "commentDesc": { "type": "string", "description": "Any comments a user wishes to add to a customer reference" }, "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The description of the Customer Reference Status, for example UNUSED, ALLOCATED, CANCELLED, etc." }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BatchCustomerRefCodesInsertRequest" }, "BatchCustomerRefCodesListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/BatchCustomerRefCodesPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "BatchCustomerRefCodesListResponse" }, "BatchCustomerRefCodesPojo": { "type": "object", "required": [ "customerPaymentTypeIdNo", "customerRefRegisterBatchIdNo", "lspServiceTypeDesc", "lspServiceTypeIdNo", "userIdNo" ], "properties": { "amountOfCustomerRefCodes": { "type": "integer", "format": "int32", "example": 1000, "description": "This indicates the amount of customer ref codes that should be generated" }, "batchProcessedDatetime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date the batch was processed" }, "customerPaymentTypeDesc": { "type": "string", "description": "The description of the Customer Payment Type, for example SKU, TOKEN, etc." }, "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "customerRefRegisterBatchIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a specific batch of customer reference numbers in the customer_ref_register table" }, "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productDesc": { "type": "string", "example": "PAXI C2C SMALL BAG (TOKEN)", "description": "User-defined description for the product" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BatchCustomerRefCodesPojo" }, "BatchCustomerRefCodesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/BatchCustomerRefCodesPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "BatchCustomerRefCodesResponse" }, "BatchCustomerRefRegisterRequest": { "type": "object", "properties": { "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BatchCustomerRefRegisterRequest" }, "BatchCustomerRefRegisterUpdateRequest": { "type": "object", "required": [ "customerRefRegisterBatchIdNo", "userIdNo" ], "properties": { "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "customerRefRegisterBatchIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a specific batch of customer reference numbers in the customer_ref_register table" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BatchCustomerRefRegisterUpdateRequest" }, "BillingEntityDeleteRequest": { "type": "object", "properties": { "billingEntityDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Billing Entity" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Billing Entity" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BillingEntityDeleteRequest" }, "BillingEntityInsertRequest": { "type": "object", "properties": { "billingEntityDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Billing Entity" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BillingEntityInsertRequest" }, "BillingEntityListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/BillingEntityPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "BillingEntityListResponse" }, "BillingEntityModel": { "type": "object", "properties": { "billingEntityDesc": { "type": "string" }, "billingEntityIdNo": { "type": "integer", "format": "int32" }, "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "userIdNo": { "type": "integer" } }, "title": "BillingEntityModel" }, "BillingEntityPojo": { "type": "object", "properties": { "billingEntityDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Billing Entity" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Billing Entity" }, "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BillingEntityPojo" }, "BillingEntityRequest": { "type": "object", "properties": { "billingEntityDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Billing Entity" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Billing Entity" } }, "title": "BillingEntityRequest" }, "BillingEntityResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/BillingEntityPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "BillingEntityResponse" }, "BillingEntityUpdateRequest": { "type": "object", "properties": { "billingEntityDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Billing Entity" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Billing Entity" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BillingEntityUpdateRequest" }, "BookingInsertRequest": { "type": "object", "required": [ "logisticsServiceProviderName", "noOfParcels", "nodeCode", "plannedDeliveryDatetime", "userIdNo" ], "properties": { "logServProvDelManifestCode": { "type": "string", "example": "JNB1605250444", "description": "The logistics service provider's delivery manifest number." }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider (/courier)." }, "noOfParcels": { "type": "integer", "format": "int32", "example": 10, "description": "The number of parcels that will be delivered. This is just a planning estimate. It doesn't have to be 100%." }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node where the delivery will be made." }, "plannedDeliveryDatetime": { "type": "string", "example": "1997-07-16T19:20:30.45+02:00", "description": "The planned delivery date and time" }, "totalCubicMeter": { "type": "number", "format": "double", "example": 10, "description": "The total cubes (measured in meters) for all the parcels that will be delivered." }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record. " }, "weightKG": { "type": "number", "format": "double", "example": 0.5, "description": "Weight of the parcel measured in kg" } }, "title": "BookingInsertRequest" }, "BookingManifestPojo": { "type": "object", "properties": { "bookingNo": { "type": "integer", "format": "int32", "example": 99, "description": "The number that is returned when a delivery booking has been confirmed to take the parcels for that booking" }, "bookingRejectReasonDesc": { "type": "string", "example": "NODE INACTIVE", "description": "Description for the booking reject reason" }, "bookingStatusDesc": { "type": "string", "example": "APPROVED", "description": "Description for the booking status" } }, "title": "BookingManifestPojo" }, "BookingManifestResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/BookingManifestPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "BookingManifestResponse" }, "BookingNoRequest": { "type": "object", "properties": { "bookingNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" } }, "title": "BookingNoRequest" }, "BookingPojo": { "type": "object", "properties": { "bookingCreateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time the booking was created" }, "bookingNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" }, "bookingRejectReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking" }, "bookingStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking status" }, "logServProvDelManifestCode": { "type": "string", "example": "JNB1605250444", "description": "The logistic service provider delivert manifest code" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "noOfParcels": { "type": "integer", "format": "int32", "example": 10, "description": "The number of parcels in the booking" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 5, "description": "Unique identifier for the parcel's current status" }, "plannedDeliveryDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time of when the parcels will be delivered" }, "totalCubicMeter": { "type": "number", "format": "double", "example": 10, "description": "Total cubic metere of the parcels to be delivered" }, "weightKG": { "type": "number", "format": "double", "example": 0.5, "description": "Weight of the parcel measured in kg" } }, "title": "BookingPojo" }, "BookingRejectReasonDeleteRequest": { "type": "object", "properties": { "bookingRejectReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingRejectReasonDeleteRequest" }, "BookingRejectReasonInsertRequest": { "type": "object", "properties": { "bookingRejectReasonDesc": { "type": "string", "example": "NODE INACTIVE", "description": "Description for the booking reject reason" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingRejectReasonInsertRequest" }, "BookingRejectReasonPojo": { "type": "object", "properties": { "bookingRejectReasonDesc": { "type": "string", "example": "NODE INACTIVE", "description": "Description for the booking reject reason" }, "bookingRejectReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" } }, "title": "BookingRejectReasonPojo" }, "BookingRejectReasonRequest": { "type": "object", "properties": { "bookingRejectReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" } }, "title": "BookingRejectReasonRequest" }, "BookingRejectReasonUpdateRequest": { "type": "object", "properties": { "bookingRejectReasonDesc": { "type": "string", "example": "NODE INACTIVE", "description": "Description for the booking reject reason" }, "bookingRejectReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingRejectReasonUpdateRequest" }, "BookingStatusDeleteRequest": { "type": "object", "properties": { "bookingStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingStatusDeleteRequest" }, "BookingStatusInsertRequest": { "type": "object", "properties": { "bookingStatusDesc": { "type": "string", "example": "TEST STATUS", "description": "Description for the booking status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingStatusInsertRequest" }, "BookingStatusPojo": { "type": "object", "properties": { "bookingStatusDesc": { "type": "string", "example": "TEST STATUS", "description": "Description for the booking status" }, "bookingStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingStatusPojo" }, "BookingStatusRequest": { "type": "object", "properties": { "bookingStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking status" } }, "title": "BookingStatusRequest" }, "BookingStatusUpdateRequest": { "type": "object", "properties": { "bookingStatusDesc": { "type": "string", "example": "TEST STATUS", "description": "Description for the booking status" }, "bookingStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingStatusUpdateRequest" }, "BookingUpdateRequest": { "type": "object", "properties": { "bookingCreateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time the booking was created" }, "bookingNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" }, "bookingRejectReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking" }, "bookingStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking status" }, "logServProvDelManifestCode": { "type": "string", "example": "JNB1605250444", "description": "The logistic service provider delivert manifest code" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for logistics service provider" }, "noOfParcels": { "type": "integer", "format": "int32", "example": 10, "description": "The number of parcels in the booking" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "plannedDeliveryDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time of when the parcels will be delivered" }, "totalCubicMeter": { "type": "number", "format": "double", "example": 10, "description": "Total cubic metere of the parcels to be delivered" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingUpdateRequest" }, "BookingUserRequest": { "type": "object", "properties": { "bookingNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the booking reject reason" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "BookingUserRequest" }, "CancelNonCollectionReturnPojo": { "type": "object", "properties": { "isCancelSuccess": { "type": "boolean" }, "parcelIdNo": { "type": "integer" } }, "title": "CancelNonCollectionReturnPojo" }, "CellPhoneNumberValidationRequest": { "type": "object", "required": [ "customerCellPhone", "customerType", "nodeIdNo" ], "properties": { "customerCellPhone": { "type": "string", "example": "0838988766", "description": "The cellphone number to be validated" }, "customerType": { "type": "string", "example": "SENDER", "description": "The type of customer the number belongs to", "enum": [ "SENDER", "RECEIVER", "COLLECTOR" ] }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "The node the customer is using" } }, "title": "CellPhoneNumberValidationRequest" }, "CellPhoneNumberValidationResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ValidCellPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CellPhoneNumberValidationResponse" }, "CloseDeliveryRequest": { "type": "object", "properties": { "damagedParcels": { "type": "array", "items": { "$ref": "#/definitions/DamagedParcelsPojo" } }, "deviceGUID": { "type": "string", "example": "GUID46345645", "description": "Unique identifier for the device on which the event was captured" }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "eventUserIdNo": { "type": "integer", "example": 1, "description": "The user id of the user who captured the event" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "missingParcelIds": { "type": "array", "items": { "type": "integer" } }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the node" }, "scannedBarcodes": { "type": "array", "items": { "$ref": "#/definitions/ScannedBarcode" } }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CloseDeliveryRequest" }, "CloseDeliveryResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CloseDeliveryResultPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CloseDeliveryResponse" }, "CloseDeliveryResultPojo": { "type": "object", "properties": { "courierDeliveryCompletionNumber": { "type": "string" }, "totalStoreDeliveryParcels": { "type": "integer", "format": "int32" } }, "title": "CloseDeliveryResultPojo" }, "CollectionFlowTypeModel": { "type": "object", "properties": { "collectionFlowTypeDesc": { "type": "string" }, "collectionFlowTypeIdNo": { "type": "integer", "format": "int32" }, "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "userIdNo": { "type": "integer" } }, "title": "CollectionFlowTypeModel" }, "CollectionPinRequest": { "type": "object", "required": [ "customerRefCode", "supplierCode", "userIdNo" ], "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CollectionPinRequest" }, "CommunicationTemplateInsertRequest": { "type": "object", "required": [ "confirmationEventTypeIdNo", "messageChannelIdNo", "messageRecipientTypeIdNo", "messageTemplateDesc", "messageTemplateName", "triggerEventTypeIdNo" ], "properties": { "confirmationEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The event type that will be inserted after the comminication has been sent" }, "messageChannelIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Channel" }, "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message recipient type" }, "messageTemplateDesc": { "type": "string", "description": "The message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "triggerEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The event type that triggers this template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CommunicationTemplateInsertRequest" }, "CommunicationTemplateListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/CommunicationTemplatePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CommunicationTemplateListResponse" }, "CommunicationTemplatePojo": { "type": "object", "properties": { "confirmationEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "confirmationEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The event type that will be inserted after the comminication has been sent" }, "messageChannelDesc": { "type": "string", "example": "Counter to counter message channel", "description": "The description of the Message Channel" }, "messageChannelIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message channel" }, "messageRecipientTypeDesc": { "type": "string", "example": "SENDER", "description": "The description of the Message Recipient Type" }, "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message recipient type" }, "messageTemplateDesc": { "type": "string", "description": "The message template" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "triggerEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "triggerEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The event type that triggers this template" } }, "title": "CommunicationTemplatePojo" }, "CommunicationTemplateRepsonse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "result": { "$ref": "#/definitions/CommunicationTemplatePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CommunicationTemplateRepsonse" }, "CommunicationTemplateUpdateRequest": { "type": "object", "required": [ "confirmationEventTypeIdNo", "messageChannelIdNo", "messageRecipientTypeIdNo", "messageTemplateDesc", "messageTemplateIdNo", "messageTemplateName", "triggerEventTypeIdNo" ], "properties": { "confirmationEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The event type that will be inserted after the comminication has been sent" }, "messageChannelIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Channel" }, "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message recipient type" }, "messageTemplateDesc": { "type": "string", "description": "The message template" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "triggerEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The event type that triggers this template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CommunicationTemplateUpdateRequest" }, "CompanyDeleteRequest": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CompanyDeleteRequest" }, "CompanyInsertRequest": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CompanyInsertRequest" }, "CompanyModel": { "type": "object", "properties": { "companyCode": { "type": "string" }, "companyIdNo": { "type": "integer", "format": "int32" }, "companyName": { "type": "string" }, "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "userIdNo": { "type": "integer" } }, "title": "CompanyModel" }, "CompanyPojo": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CompanyPojo" }, "CompanyRequest": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" } }, "title": "CompanyRequest" }, "CompanyUpdateRequest": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CompanyUpdateRequest" }, "CountryDeleteRequest": { "type": "object", "properties": { "countryCode": { "type": "string", "example": "ZA", "description": "The ISO ALPHA-2 Code of the Country" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CountryDeleteRequest" }, "CountryInsertRequest": { "type": "object", "properties": { "countryCode": { "type": "string", "example": "ZA", "description": "The ISO ALPHA-2 Code of the Country" }, "countryName": { "type": "string", "example": "South Africa", "description": "The name of the country" }, "dialingCode": { "type": "string", "example": "+27", "description": "The international dialing code of the country" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CountryInsertRequest" }, "CountryListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/CountryPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CountryListResponse" }, "CountryPojo": { "type": "object", "properties": { "countryCode": { "type": "string", "example": "ZA", "description": "The ISO ALPHA-2 Code of the Country" }, "countryName": { "type": "string", "example": "South Africa", "description": "The name of the country" }, "dialingCode": { "type": "string", "example": "+27", "description": "The international dialing code of the country" }, "userIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CountryPojo" }, "CountryRequest": { "type": "object", "properties": { "countryCode": { "type": "string", "example": "ZA", "description": "The ISO ALPHA-2 Code of the Country" } }, "title": "CountryRequest" }, "CountryResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CountryPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CountryResponse" }, "CountsPojo": { "type": "object", "properties": { "incompleteCollectionCount": { "type": "integer", "format": "int64", "example": 2, "description": "The count of parcels for which the customer collection process hasn't been completed yet" }, "messageCount": { "type": "integer", "format": "int64", "example": 1, "description": "The count for all the waiting messages" }, "missingParcelCount": { "type": "integer", "format": "int64", "example": 1, "description": "The count for all the missing parcels" }, "nonCollectionCancelCount": { "type": "integer", "format": "int64", "example": 2, "description": "The count for all the non collected cancel parcels" }, "nonCollectionReturnCount": { "type": "integer", "format": "int64", "example": 4, "description": "The count for all the non collected parcels" } }, "title": "CountsPojo" }, "CourierCollectionPojo": { "type": "object", "properties": { "courierCollectionCompletionNumber": { "type": "string", "description": "This should only be generated & returned when there are no parcels for collection" }, "parcelCount": { "type": "integer", "format": "int64", "example": 5, "description": "Total parcels ready for collection for the supplied courier" } }, "title": "CourierCollectionPojo" }, "CourierCollectionResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CourierCollectionPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CourierCollectionResponse" }, "CurrentNodeRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the current node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node" } }, "title": "CurrentNodeRequest" }, "CustRefCodePutawayRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "overrideNotValidStatus": { "type": "boolean" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "CustRefCodePutawayRequest" }, "CustRefForCustCollectionRequest": { "type": "object", "properties": { "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "The unique identifier for the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustRefForCustCollectionRequest" }, "Customer": { "type": "object", "properties": { "contactNumber": { "type": "string" }, "firstName": { "type": "string" }, "guid": { "type": "string" }, "idCountry": { "type": "string" }, "idNumber": { "type": "string" }, "lastName": { "type": "string" }, "passportCountry": { "type": "string" }, "passportNumber": { "type": "string" }, "studentNumber": { "type": "string" } }, "title": "Customer" }, "CustomerCollectionInsertRequest": { "type": "object", "required": [ "collectionType", "nodeIdNo", "userIdNo" ], "properties": { "colCustomerCellPhone": { "type": "string", "example": "0824468750", "description": "The contact number of the user collecting the parcel" }, "colCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "collectionType": { "type": "string", "example": "STANDARD", "description": "The Type of collection the customer is performing", "enum": [ "STANDARD", "ALTERNATE" ] }, "customer": { "example": 2, "description": "Unique identifier for the service type", "$ref": "#/definitions/OneProfileCustomerPojo" }, "isParcelMissing": { "type": "boolean", "example": false, "description": "Idicates if the parcel is missing or not" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that last performed a transaction on the parcel" } }, "title": "CustomerCollectionInsertRequest" }, "CustomerCollectionParcelPojo": { "type": "object", "properties": { "alternateCollectionRequirements": { "$ref": "#/definitions/CustomerCollectionRequirementsPojo" }, "collectionPinRequiredInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide a pin for the parcel collection" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "logServProvParcelCode": { "type": "string", "example": "P151200434", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": 80000764200, "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "normalCollectionRequirements": { "$ref": "#/definitions/CustomerCollectionRequirementsPojo" }, "originNodeNodeTypeDesc": { "type": "string", "example": "STORE", "description": "The description of the node type where the parcel was originally received" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "CustomerCollectionParcelPojo" }, "CustomerCollectionRequirementsPojo": { "type": "object", "properties": { "identificationRequired": { "type": "boolean" }, "kycRequired": { "type": "boolean" }, "signatureRequirement": { "type": "string" } }, "title": "CustomerCollectionRequirementsPojo" }, "CustomerDropInfoRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" } }, "title": "CustomerDropInfoRequest" }, "CustomerDropInsertPojo": { "type": "object", "required": [ "customerRefCode", "nodeIdNo", "userIdNo" ], "properties": { "customer": { "description": "The customer details to create a oneProfile record", "$ref": "#/definitions/OneProfileCustomerPojo" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "dropTokenCode": { "type": "string", "description": "The token the customer will have to present when dropping off a return or a counter-to-counter parcel" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "otherDataRequiredValue": { "type": "string", "example": 123456, "description": "This will be a process specific other requirement that will be used to populate the field of `otherDataRequiredDesc`" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer receiving the parcel" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerDropInsertPojo" }, "CustomerDropInsertRequest": { "type": "object", "properties": { "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "CustomerDropInsertRequest" }, "CustomerDropInsertResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CustomerDropInsertRequest" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerDropInsertResponse" }, "CustomerDropParcelDetailsPojo": { "type": "object", "required": [ "customerRefCode", "productIdNo" ], "properties": { "customer": { "example": 2, "description": "Unique identifier for the service type", "$ref": "#/definitions/OneProfileCustomerDetailsPojo" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Customer Reference Status" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "destinationNodeName": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "destinationNodeProvince": { "type": "string", "example": "Western Province", "description": "Returns the province that the node is located in" }, "destinationNodeStatus": { "type": "string", "example": "ACTIVE", "description": "The description of the node status" }, "otherDataRequiredDesc": { "type": "string", "example": "Student Number", "description": "This will be a process specific other requirement that will be used as a dynamic lable name" }, "otherDataRequiredValue": { "type": "string", "example": 123456, "description": "This will be a process specific other requirement that will be used to populate the field of `otherDataRequiredDesc`" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "productDesc": { "type": "string", "example": "PAXI C2C SMALL BAG (TOKEN)", "description": "User-defined description for the product" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Issued by PAXI. A unique product identifier indicating the parcel type. For a list of allowed parceIdNo's please call /getProductBySupplier using your supplierCode. This parameter will limit the output to locations/nodes/stores where the product has been approved to be collected from." }, "supplierName": { "type": "string", "example": "Avon", "description": "The name of the supplier" } }, "title": "CustomerDropParcelDetailsPojo" }, "CustomerDropPojo": { "type": "object", "properties": { "accountNumber": { "type": "string", "example": "UNISA ASSIGNMENT", "description": "The accountNumber that will be billed for parcel/s been sent" }, "collectionDate": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "This is the date when the parcel will be collected for delivery" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company sending the parcels" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label" }, "deliveryDate": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "This is the date when the parcel was delivered" }, "errorMessge": { "type": "string", "example": 8, "description": "The error message for this parcel" }, "fromAddress1": { "type": "string", "example": "SHOP 1 OLD ACRE PLAZA", "description": "The name of the building/house where collection will take place" }, "fromAddress2": { "type": "string", "example": "CORNER VICTORIA", "description": "The house/building number where collection will take place" }, "fromAddress3": { "type": "string", "example": "WILSON STREET", "description": "The number of the unit within the building from which collection will take place" }, "fromAddress4": { "type": "string", "example": "WILSON STREET", "description": "The name of the street where collection will take" }, "fromAddress5": { "type": "string", "description": "From Address line 5" }, "fromAddress6": { "type": "string", "description": "From Address line 6" }, "fromAddressName": { "type": "string", "example": "PERSON NAME", "description": "The name of the person requesting parcel collection" }, "fromFax": { "type": "string", "example": "034 444 2888", "description": "The fax number of the collection requester" }, "fromPostalCode": { "type": "string", "example": 3000, "description": "The postal code of the collection area" }, "fromTelephone": { "type": "string", "example": 27342121923, "description": "The contact number of the collection requester" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "Height of the parcel measured in cm" }, "instructions": { "type": "string", "example": "UNISA ASSIGNMENT", "description": "Additional information regarding the parcel(s) been sent" }, "insuranceAmount": { "type": "integer", "format": "int32", "example": 0, "description": "The value of the insurance" }, "insuranceType": { "type": "integer", "format": "int32", "example": 0, "description": "This will depend on the client. Should insurance be taken out the client will be required to specify this" }, "lengthCm": { "type": "number", "format": "double", "example": 20, "description": "Length of the parcel measured in cm" }, "navigation": { "type": "string", "example": 1, "description": "The user id of the user that last updated the record" }, "noOfParcels": { "type": "integer", "format": "int32" }, "openTill": { "type": "string", "example": 1020, "description": "The operating hours of the company sending a parcel(s)" }, "parcelDescrption": { "type": "string", "example": "ASSIGNMENT", "description": "The description for the current parcel that will be sent" }, "readyTime": { "type": "string", "example": 900, "description": "This is the time when the parcels will be ready for collection" }, "security": { "type": "string", "example": "N", "description": "Is there a security where collection will take place?" }, "serviceType": { "type": "string", "example": "UNISA ASSIGNMENTS", "description": "The method that will be used to send parcel(s)" }, "toAddress1": { "type": "string", "example": "CVV Building room 2nd Floor", "description": "The name of the building/house where delivery will take place" }, "toAddress2": { "type": "string", "example": "1 Preller Street", "description": "The house/building number where delivery will take place" }, "toAddress3": { "type": "string", "example": "Muckleneuk", "description": "This is the number of the unit within the building where delivery will take place" }, "toAddress4": { "type": "string", "example": "Pretoria", "description": "The name of the street where delivery will take" }, "toAddress5": { "type": "string", "description": "To Address line 5" }, "toAddress6": { "type": "string", "description": "To Address line 6" }, "toAddressName": { "type": "string", "example": "PERSON NAME", "description": "The name of the person whom the parcel is been sent to" }, "toFax": { "type": "string", "example": "021 444 2981", "description": "The fax number of the collection recipient" }, "toPostalCode": { "type": "string", "example": 8000, "description": "The postal code of the collection area" }, "toTelephone": { "type": "string", "example": "021 429 2981", "description": "The contact number of the collection recipient" }, "wayBillNumber": { "type": "string", "example": "P6546564", "description": "The unique waybill number" }, "weightKg": { "type": "number", "format": "double", "example": 0.5, "description": "Weight of the parcel measured in kg" }, "widthCm": { "type": "number", "format": "double", "example": 20, "description": "The width measured in cm" } }, "title": "CustomerDropPojo" }, "CustomerDropResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CustomerDropPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerDropResponse" }, "CustomerPaymentTypeDeleteRequest": { "type": "object", "required": [ "customerPaymentTypeIdNo", "userIdNo" ], "properties": { "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerPaymentTypeDeleteRequest" }, "CustomerPaymentTypeInsertRequest": { "type": "object", "required": [ "isPepInterfaceRequired", "userIdNo" ], "properties": { "customerPaymentTypeDesc": { "type": "string", "description": "The description of the Customer Payment Type, for example SKU, TOKEN, etc." }, "isPepInterfaceRequired": { "type": "string", "description": "Indicates whether a sales interface record should be sent to PEP for customer drops done with this payment type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerPaymentTypeInsertRequest" }, "CustomerPaymentTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/CustomerPaymentTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerPaymentTypeListResponse" }, "CustomerPaymentTypePojo": { "type": "object", "required": [ "customerPaymentTypeIdNo", "lastUpdateDatetime", "userIdNo" ], "properties": { "customerPaymentTypeDesc": { "type": "string", "description": "The description of the Customer Payment Type, for example SKU, TOKEN, etc." }, "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "discontinueDatetime": { "type": "string", "description": "The date that the record was suspended" }, "isPepInterfaceRequired": { "type": "string", "description": "Indicates whether a sales interface record should be sent to PEP for customer drops done with this payment type" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerPaymentTypePojo" }, "CustomerPaymentTypeRequest": { "type": "object", "required": [ "customerPaymentTypeIdNo", "userIdNo" ], "properties": { "customerPaymentTypeDesc": { "type": "string", "description": "The description of the Customer Payment Type, for example SKU, TOKEN, etc." }, "customerPaymentTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The type of payment that is required" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerPaymentTypeRequest" }, "CustomerPaymentTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CustomerPaymentTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerPaymentTypeResponse" }, "CustomerRefRegisterListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/CustomerRefRegisterPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerRefRegisterListResponse" }, "CustomerRefRegisterPojo": { "type": "object", "required": [ "customerRefCode", "customerRefRegisterBatchIdNo", "customerRefStatusIdNo", "lastUpdateDatetime" ], "properties": { "commentDesc": { "type": "string", "description": "Any comments a user wishes to add to a customer reference" }, "customerRefCode": { "type": "string", "example": "D999999999999", "description": "The unique tracking number for the parcel. When PAXI bags are used this will be the Dxxxxxxxxxxxx number printed on the bag" }, "customerRefRegisterBatchIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Identifies the batch that this customer reference number is linked to " }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": "ALLOCATED", "description": "Identifies the current status of the specific customer reference number" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the last user that updated the record" } }, "title": "CustomerRefRegisterPojo" }, "CustomerRefRegisterRequest": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D999999999999", "description": "The unique tracking number for the parcel. When PAXI bags are used this will be the Dxxxxxxxxxxxx number printed on the bag" }, "customerRefRegisterBatchIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Identifies the batch that this customer reference number is linked to " }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Identifies the current status of the specific customer reference number" } }, "title": "CustomerRefRegisterRequest" }, "CustomerRefRegisterResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CustomerRefRegisterPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerRefRegisterResponse" }, "CustomerRefRegisterUpdateRequest": { "type": "object", "required": [ "customerRefCode", "userIdNo" ], "properties": { "commentDesc": { "type": "string", "description": "Any comments a user wishes to add to a customer reference" }, "customerRefCode": { "type": "string", "example": "D999999999999", "description": "The unique tracking number for the parcel. When PAXI bags are used this will be the Dxxxxxxxxxxxx number printed on the bag" }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "description": "Auto increment number used to uniquely identify a Customer Reference Status" }, "userIdNo": { "type": "integer", "description": "The user id of the last user that updated the record" } }, "title": "CustomerRefRegisterUpdateRequest" }, "CustomerRefStatusDeleteRequest": { "type": "object", "required": [ "customerRefStatusIdNo", "userIdNo" ], "properties": { "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Customer Reference Status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerRefStatusDeleteRequest" }, "CustomerRefStatusInsertRequest": { "type": "object", "required": [ "customerRefStatusDesc", "customerRefStatusIdNo", "userIdNo" ], "properties": { "customerRefStatusDesc": { "type": "string", "description": "The description of the Customer Reference Status, for example UNUSED, ALLOCATED, CANCELLED, etc." }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Customer Reference Status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerRefStatusInsertRequest" }, "CustomerRefStatusListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/CustomerRefStatusPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerRefStatusListResponse" }, "CustomerRefStatusPojo": { "type": "object", "required": [ "customerRefStatusDesc", "customerRefStatusIdNo", "lastUpdateDatetime", "userIdNo" ], "properties": { "customerRefStatusDesc": { "type": "string", "description": "The description of the Customer Reference Status, for example UNUSED, ALLOCATED, CANCELLED, etc." }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Customer Reference Status" }, "discontinueDatetime": { "type": "string", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerRefStatusPojo" }, "CustomerRefStatusRequest": { "type": "object", "properties": { "customerRefStatusDesc": { "type": "string", "description": "The description of the Customer Reference Status, for example UNUSED, ALLOCATED, CANCELLED, etc." }, "customerRefStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Customer Reference Status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "CustomerRefStatusRequest" }, "CustomerRefStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CustomerRefStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "CustomerRefStatusResponse" }, "CustomerReferenceCodeRequest": { "type": "object", "required": [ "customerRefCode" ], "properties": { "customerRefCode": { "type": "string", "description": "The unique tracking number for the parcel. When PAXI bags are used this will be the Dxxxxxxxxxxxx number printed on the bag" } }, "title": "CustomerReferenceCodeRequest" }, "DamagedParcelsPojo": { "type": "object", "properties": { "barcode": { "type": "string", "example": "D151123453", "description": "The scanned barcode" }, "damagedReason": { "type": "string", "example": "Fragile item sounds broken", "description": "This is te description of what is wrong with the parcel" }, "dateTimeScanned": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date and time the barcode was scanned" }, "parcelId": { "type": "integer" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "type": { "type": "string", "example": "SUCCESSFUL", "description": "Indicates whether the scan was successful or not. Can either be SUCCESSFUL or ERROR." } }, "title": "DamagedParcelsPojo" }, "DeliveredByCourierPojo": { "type": "object", "properties": { "parcels": { "type": "array", "items": { "$ref": "#/definitions/AwaitingParcelPojo" } }, "productTypeDesc": { "type": "string", "example": "ASSIGNMENT", "description": "The description of the product type" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "DeliveredByCourierPojo" }, "DropLabelValidationPojo": { "type": "object", "required": [ "customerRefCode", "reason", "valid" ], "properties": { "customerRefCode": { "type": "string" }, "processRequirements": { "$ref": "#/definitions/ProcessRequirementPojo" }, "reason": { "type": "string", "enum": [ "INVALID_PREFIX", "INVALID_LENGTH", "INVALID_CHECK_DIGIT", "ALREADY_IN_USE", "INVALID_DROP_LABEL", "DECOMMISSIONED", "TOKEN_SCANNED", "VALID" ] }, "valid": { "type": "boolean" } }, "title": "DropLabelValidationPojo" }, "DropTokenAuthRequest": { "type": "object", "required": [ "dropTokenCode" ], "properties": { "dropTokenCode": { "type": "string", "example": "T20581851354", "description": "Unique identifier for the Drop Token" }, "obTillNo": { "type": "integer", "format": "int32", "example": 10, "description": "The retailer till number as received from One Balance" }, "obTillTransactionNo": { "type": "integer", "format": "int32", "example": 84876, "description": "The retailer till number as received from One Balance" }, "obTransactionAmt": { "type": "number", "format": "double", "example": 200, "description": "The transaction amount as received from One Balance" }, "obTransactionDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date of the last transaction as received by One Balance" }, "obTransactionStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier in One Balance for transaction status" }, "obTransactionTenderTypeDesc": { "type": "string", "example": 1, "description": "The Transaction Tender Type as received from One Balance" }, "obTransactionUID": { "type": "string", "example": 20522540, "description": "Unique identifier for the transaction as reveived from One Balance" } }, "title": "DropTokenAuthRequest" }, "DropTokenDeleteRequest": { "type": "object", "properties": { "dropTokenCode": { "type": "string", "example": "T20581851354", "description": "Unique identifier for the Drop Token" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenDeleteRequest" }, "DropTokenGenerationRequest": { "type": "object", "required": [ "lspServiceTypeIdNo" ], "properties": { "bincSellAmt": { "type": "number", "format": "double", "example": 200, "description": "Sell amount including VAT" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "expireDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was expired" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "numberOfDropTokens": { "type": "integer", "format": "int32", "example": 1, "description": "The number of Drop Tokens to be created on demand" }, "originNodeCode": { "type": "string", "example": "P4340", "description": "The node where the drop token was created" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": "P4340", "description": "The node where the drop token was created" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type Id Number" }, "supplierCode": { "type": "string", "example": "PEP", "description": "Unique identifier for the Supplier Code" }, "supplierRefCode": { "type": "string", "description": "The supplier reference number. For returns, this will be the supplier return number." }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Status Id Number" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Type Id Number" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenGenerationRequest" }, "DropTokenInsertRequest": { "type": "object", "required": [ "lspServiceTypeIdNo" ], "properties": { "bincSellAmt": { "type": "number", "format": "double", "example": 200, "description": "Sell amount including VAT" }, "createDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was created" }, "customerCellphone": { "type": "string", "example": "0825549632", "description": "The preferred cellphone number of the customer" }, "customerCountryCode": { "type": "string", "description": "The country code where the customer resides in" }, "customerEmail": { "type": "string", "example": "example@example.com", "description": "The email address of the customer" }, "customerFirstName": { "type": "string", "example": "Jon", "description": "The firstname of the customer requesting the drop token" }, "customerIdNo": { "type": "string", "description": "The identification number of the customer requesting the drop token" }, "customerLastName": { "type": "string", "example": "Doe", "description": "The lastname of the customer requesting the drop token" }, "customerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in One Profile for the customer receiving the drop token" }, "destinationNodeCode": { "type": "string", "example": "P4340", "description": "Unique identifier for the Destination Node Code" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "expireDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was expired" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was last updated" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "obStoreIdNo": { "type": "integer", "format": "int32", "description": "The Store number sent through from OneBalance" }, "obTillNo": { "type": "integer", "format": "int32", "example": 10, "description": "The retailer till number as received from One Balance" }, "obTillTransactionNo": { "type": "integer", "format": "int32", "example": 84876, "description": "The retailer till number as received from One Balance" }, "obTransactionAmt": { "type": "number", "format": "double", "example": 200, "description": "The transaction amount as received from One Balance" }, "obTransactionDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date of the last transaction as received by One Balance" }, "obTransactionStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier in One Balance for transaction status" }, "obTransactionTenderTypeDesc": { "type": "string", "example": 1, "description": "The Transaction Tender Type as received from One Balance" }, "obTransactionUID": { "type": "string", "example": 20522540, "description": "Unique identifier for the transaction as reveived from One Balance" }, "originNodeCode": { "type": "string", "example": "P4340", "description": "The node where the drop token was created" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": "P4340", "description": "The node where the drop token was created" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type Id Number" }, "redeemDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was redeemed" }, "supplierCode": { "type": "string", "example": "PEP", "description": "Unique identifier for the Supplier Code" }, "supplierRefCode": { "type": "string", "description": "The supplier reference number. For returns, this will be the supplier return number." }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Status Id Number" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Type Id Number" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenInsertRequest" }, "DropTokenInsertRequestExternal": { "type": "object", "required": [ "lspServiceTypeIdNo" ], "properties": { "bincSellAmt": { "type": "number", "format": "double", "example": 200, "description": "Sell amount including VAT" }, "createDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was created" }, "customerCellphone": { "type": "string", "example": "0825549632", "description": "The preferred cellphone number of the customer" }, "customerEmail": { "type": "string", "example": "example@example.com", "description": "The email address of the customer" }, "customerFirstName": { "type": "string", "example": "Jon", "description": "The firstname of the customer requesting the drop token" }, "customerIdNo": { "type": "string", "description": "The identification number of the customer requesting the drop token" }, "customerLastName": { "type": "string", "example": "Doe", "description": "The lastname of the customer requesting the drop token" }, "customerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in One Profile for the customer receiving the drop token" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "expireDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was expired" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was last updated" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "originNodeCode": { "type": "string", "example": "P4340", "description": "The node where the drop token was created" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": "P4340", "description": "The node where the drop token was created" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type Id Number" }, "redeemDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was redeemed" }, "supplierCode": { "type": "string", "example": "PEP", "description": "Unique identifier for the Supplier Code" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "supplierRefCode": { "type": "string", "description": "The supplier reference number. For returns, this will be the supplier return number." }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Status Id Number" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Type Id Number" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenInsertRequestExternal" }, "DropTokenListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/DropTokenPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "DropTokenListResponse" }, "DropTokenModel": { "type": "object", "properties": { "bincSellAmt": { "type": "number", "format": "double" }, "createDateTime": { "type": "string", "format": "date-time" }, "customerCellphone": { "type": "string" }, "customerEmail": { "type": "string" }, "customerOneProfileGUID": { "type": "string" }, "destinationNode": { "$ref": "#/definitions/NodeModel" }, "dropTokenCode": { "type": "string" }, "expireDateTime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "lspServiceType": { "$ref": "#/definitions/LSPServiceTypeModel" }, "obReferenceCode": { "type": "string" }, "obStoreIdNo": { "type": "integer", "format": "int32" }, "obTillNo": { "type": "integer", "format": "int32" }, "obTillTransactionNo": { "type": "integer", "format": "int32" }, "obTransactionAmt": { "type": "number", "format": "double" }, "obTransactionDateTime": { "type": "string", "format": "date-time" }, "obTransactionStatusIdNo": { "type": "integer", "format": "int32" }, "obTransactionTenderTypeDesc": { "type": "string" }, "obTransactionUID": { "type": "string" }, "originNode": { "$ref": "#/definitions/NodeModel" }, "productType": { "$ref": "#/definitions/ProductTypeModel" }, "redeemDatetime": { "type": "string", "format": "date-time" }, "supplierCode": { "$ref": "#/definitions/SupplierModel" }, "supplierRefCode": { "type": "string" }, "tokenStatus": { "$ref": "#/definitions/TokenStatusModel" }, "tokenType": { "$ref": "#/definitions/TokenTypeModel" }, "userIdNo": { "type": "integer" } }, "title": "DropTokenModel" }, "DropTokenPojo": { "type": "object", "required": [ "lspServiceTypeDesc", "lspServiceTypeIdNo" ], "properties": { "bincSellAmt": { "type": "number", "format": "double", "example": 200, "description": "Sell amount including VAT" }, "createDateTime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date and time when the record was created" }, "customerCellphone": { "type": "string", "example": "0825549632", "description": "The preferred cellphone number of the customer" }, "customerEmail": { "type": "string", "example": "example@example.com", "description": "The email address of the customer" }, "customerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in One Profile for the customer receiving the drop token" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "destinationNodeName": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "dropTokenCode": { "type": "string", "example": "T20581851354", "description": "Unique identifier for the Drop Token" }, "expireDateTime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date and time when the voucher was expired" }, "lastUpdateDatetime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date and time when the record was last updated" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "obReferenceCode": { "type": "string", "description": "A reference code from One Balance" }, "obStoreIdNo": { "type": "integer", "format": "int32", "description": "The Store number sent through from OneBalance" }, "obTillNo": { "type": "integer", "format": "int32", "example": 10, "description": "The retailer till number as received from One Balance" }, "obTillTransactionNo": { "type": "integer", "format": "int32", "example": 84876, "description": "The retailer till number as received from One Balance" }, "obTransactionAmt": { "type": "number", "format": "double", "example": 200, "description": "The transaction amount as received from One Balance" }, "obTransactionDateTime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date of the last transaction as received by One Balance" }, "obTransactionStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier in One Balance for transaction status" }, "obTransactionTenderTypeDesc": { "type": "string", "example": 1, "description": "The Transaction Tender Type as received from One Balance" }, "obTransactionUID": { "type": "string", "example": 20522540, "description": "Unique identifier for the transaction as reveived from One Balance" }, "originNodeCode": { "type": "string", "example": "P4340", "description": "The node where the drop token was created" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The node where the drop token was created" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type" }, "redeemDatetime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date and time when the voucher was redeemed" }, "supplierCode": { "type": "string", "example": "PEP", "description": "Unique identifier for the Supplier Code" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "supplierRefCode": { "type": "string" }, "tokenStatusDesc": { "type": "string", "example": "PAID", "description": "The description of the token type" }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Status Id Number" }, "tokenTypeDesc": { "type": "string", "example": "PRE-AUTHORISED", "description": "The description of the token type" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Type Id Number" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenPojo" }, "DropTokenRequest": { "type": "object", "required": [ "lspServiceTypeIdNo" ], "properties": { "customerCellphone": { "type": "string", "example": "0825549632", "description": "The preferred cellphone number of the customer" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "dropTokenCode": { "type": "string", "example": "T151200024017", "description": "The token the customer will have to present when dropping off a return or a counter-to-counter parcel" }, "dropType": { "type": "string", "example": "CUSTOMER_RETURN', 'COUNTER_TO_COUNTER", "description": "The type of process that is being performed" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenRequest" }, "DropTokenResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/DropTokenPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "DropTokenResponse" }, "DropTokenUpdateRequest": { "type": "object", "required": [ "dropTokenCode" ], "properties": { "bincSellAmt": { "type": "number", "format": "double", "example": 200, "description": "Sell amount including VAT" }, "createDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was created" }, "customerCellphone": { "type": "string", "example": "0825549632", "description": "The preferred cellphone number of the customer" }, "customerEmail": { "type": "string", "example": "example@example.com", "description": "The email address of the customer" }, "customerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in One Profile for the customer receiving the drop token" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Destination Node Id Number" }, "dropTokenCode": { "type": "string", "example": "T20581851354", "description": "Unique identifier for the Drop Token" }, "expireDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was expired" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was last updated" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "obReferenceCode": { "type": "string", "description": "A reference code from One Balance" }, "obStoreIdNo": { "type": "integer", "format": "int32", "description": "The Store number sent through from OneBalance" }, "obTillNo": { "type": "integer", "format": "int32", "example": 10, "description": "The retailer till number as received from One Balance" }, "obTillTransactionNo": { "type": "integer", "format": "int32", "example": 84876, "description": "The retailer till number as received from One Balance" }, "obTransactionAmt": { "type": "number", "format": "double", "example": 200, "description": "The transaction amount as received from One Balance" }, "obTransactionDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date of the last transaction as received by One Balance" }, "obTransactionStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier in One Balance for transaction status" }, "obTransactionTenderTypeDesc": { "type": "string", "example": 1, "description": "The Transaction Tender Type as received from One Balance" }, "obTransactionUID": { "type": "string", "example": 20522540, "description": "Unique identifier for the transaction as reveived from One Balance" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": "P4340", "description": "The node where the drop token was created" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type Id Number" }, "redeemDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the voucher was redeemed" }, "supplierCode": { "type": "string", "example": "PEP", "description": "Unique identifier for the Supplier Code" }, "supplierRefCode": { "type": "string", "description": "The supplier reference number. For returns, this will be the supplier return number." }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Status Id Number" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Token Type Id Number" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "DropTokenUpdateRequest" }, "DropTokenValidationPojo": { "type": "object", "required": [ "reason", "valid" ], "properties": { "processRequirements": { "$ref": "#/definitions/ProcessRequirementPojo" }, "reason": { "type": "string", "enum": [ "INVALID_PREFIX", "INVALID_LENGTH", "INVALID_CHECK_DIGIT", "UNPAID_DROP_TOKEN", "INVALID_DROP_TOKEN", "EXPIRED", "DROP_LABEL_SCANNED", "REDEEMED", "INVALID_PRODUCT", "SUPPLIER_NOT_SPECIFIED", "PRODUCT_TYPE_REQUIRED", "PRODUCT_NOT_FOUND", "VALID" ] }, "valid": { "type": "boolean" } }, "title": "DropTokenValidationPojo" }, "DropTokenValidationRequest": { "type": "object", "required": [ "customerRefCode", "dropTokenCode" ], "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "dropTokenCode": { "type": "string", "example": "T151200024017", "description": "For PAXI parcels where payment was done using send tokens, the token number for a paid token must be provided to authorise the registration of the parcel." } }, "title": "DropTokenValidationRequest" }, "DropTokenValidationResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/DropTokenValidationPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "DropTokenValidationResponse" }, "ElectronicManifestPojo": { "type": "object", "required": [ "bookingNo", "customerRefCodeList", "logServProvDelManifestCode", "supplierName", "userIdNo" ], "properties": { "bookingNo": { "type": "integer", "format": "int32", "example": 1, "description": "The booking number provided to the logistics service provider after the delivery announcement was approved." }, "customerRefCodeList": { "type": "array", "example": "D151200024017, D160210041838", "description": "Array of the customer reference numbers that are going to be delivered for the specific supplier on this booking.", "items": { "type": "string" } }, "logServProvDelManifestCode": { "type": "string", "example": "XXMANIFEST123", "description": "The logistics service provider's delivery manifest number." }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier." }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record. *** The userIdNo to use will be supplied once integration development starts ***" } }, "title": "ElectronicManifestPojo" }, "ErrorMessageDeleteRequest": { "type": "object", "properties": { "errorMessageCode": { "type": "string", "example": "005", "description": "The 20 character code used for the new error message" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ErrorMessageDeleteRequest" }, "ErrorMessageInsertRequest": { "type": "object", "properties": { "errorMessageCode": { "type": "string", "example": "005", "description": "The 20 character code used for the new error message" }, "errorMessageDesc": { "type": "string", "example": "INVALID BARCODE", "description": "The name of the error message" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ErrorMessageInsertRequest" }, "ErrorMessagePojo": { "type": "object", "properties": { "errorMessageCode": { "type": "string", "example": "005", "description": "The 20 character code used for the new error message" }, "errorMessageDesc": { "type": "string", "example": "INVALID BARCODE", "description": "The name of the error message" }, "userIdNo": { "type": "integer" } }, "title": "ErrorMessagePojo" }, "ErrorMessageRequest": { "type": "object", "properties": { "errorMessageCode": { "type": "string", "example": "005", "description": "The 20 character code used for the new error message" } }, "title": "ErrorMessageRequest" }, "FilteredLocationPojo": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "PEP", "description": "The code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationStatusIdNo": { "type": "integer", "format": "int32" }, "nodeCode": { "type": "string", "example": "P8069", "description": "The code to identify the node" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node concept" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 4, "description": "Unique identifier for the node status" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node type" } }, "title": "FilteredLocationPojo" }, "GetBookingMessagesByNodeIdResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageTemplateResultPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingMessagesByNodeIdResponse" }, "GetBookingRejectReasonResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/BookingRejectReasonPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingRejectReasonResponse" }, "GetBookingRejectReasonsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/BookingRejectReasonPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingRejectReasonsResponse" }, "GetBookingResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/BookingPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingResponse" }, "GetBookingStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/BookingStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingStatusResponse" }, "GetBookingStatusesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/BookingStatusPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingStatusesResponse" }, "GetBookingsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/BookingPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetBookingsResponse" }, "GetCompaniesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/CompanyPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetCompaniesResponse" }, "GetCompanyResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CompanyPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetCompanyResponse" }, "GetCountsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/CountsPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetCountsResponse" }, "GetErrorMessageResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ErrorMessagePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetErrorMessageResponse" }, "GetErrorMessagesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ErrorMessagePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetErrorMessagesResponse" }, "GetLocationResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LocationPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLocationResponse" }, "GetLocationStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LocationStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLocationStatusResponse" }, "GetLocationStatusesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LocationStatusPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLocationStatusesResponse" }, "GetLocationTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LocationTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLocationTypeResponse" }, "GetLocationTypesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LocationTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLocationTypesResponse" }, "GetLocationsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LocationPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLocationsResponse" }, "GetLogisticsServiceProviderResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LogisticsServiceProviderPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLogisticsServiceProviderResponse" }, "GetLogisticsServiceProvidersResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LogisticsServiceProviderPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetLogisticsServiceProvidersResponse" }, "GetMessageTemplateByCategoryResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageTemplatePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetMessageTemplateByCategoryResponse" }, "GetMessageTemplateCategoriesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageTemplateCategoryPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetMessageTemplateCategoriesResponse" }, "GetMessageTemplateCategoryResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/MessageTemplateCategoryPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetMessageTemplateCategoryResponse" }, "GetMessageTemplateResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/MessageTemplatePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetMessageTemplateResponse" }, "GetMessageTemplatesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageTemplatePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetMessageTemplatesResponse" }, "GetNodeConceptResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodeConceptPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeConceptResponse" }, "GetNodeConceptsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeConceptPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeConceptsResponse" }, "GetNodeGroupNodeConceptsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeGroupNodeConceptPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeGroupNodeConceptsResponse" }, "GetNodeGroupResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodeGroupPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeGroupResponse" }, "GetNodeGroupsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeGroupPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeGroupsResponse" }, "GetNodeLocationResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodeLocationPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeLocationResponse" }, "GetNodeLocationsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeLocationPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeLocationsResponse" }, "GetNodeStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodeStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeStatusResponse" }, "GetNodeStatusesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeStatusPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeStatusesResponse" }, "GetNodeTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodeTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeTypeResponse" }, "GetNodeTypesResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodeTypesResponse" }, "GetNodesListFor3rdPartyResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodesListFor3rdPartyOutput" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNodesListFor3rdPartyResponse" }, "GetNonCollectionParcelsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NonCollectionParcelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetNonCollectionParcelsResponse" }, "GetParcelByIncompletePOD": { "type": "object", "properties": { "nodeCode": { "type": "string", "example": 2800, "description": "The code for the node where the parcel event occurred" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the node" } }, "title": "GetParcelByIncompletePOD" }, "GetParcelsAwaitingCollectionReminderResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/AwaitingCollectionReminderParcelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetParcelsAwaitingCollectionReminderResponse" }, "GetParcelsAwaitingCollectionResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/AwaitingCollectionParcelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetParcelsAwaitingCollectionResponse" }, "GetParcelsAwaitingUpliftmentResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/AwaitingNodeLocationParcelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetParcelsAwaitingUpliftmentResponse" }, "GetParcelsDeliveredByCourierResult": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/DeliveredByCourierPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetParcelsDeliveredByCourierResult" }, "GetProductBySupplierResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ProductSupplierPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetProductBySupplierResponse" }, "GetStorageLocationParcelCountResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeLocationStockCountPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetStorageLocationParcelCountResponse" }, "GetUnProcessedPaxiEventsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/UnprocessedParcelsPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "GetUnProcessedPaxiEventsResponse" }, "InsertParcelResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelIdRequest" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "InsertParcelResponse" }, "LSPServiceTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "lspServiceTypeDesc": { "type": "string" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "LSPServiceTypeModel" }, "LSPServiceTypePojo": { "type": "object", "required": [ "lastUpdateDatetime", "lspServiceTypeDesc", "lspServiceTypeIdNo" ], "properties": { "discontinueDatetime": { "type": "string", "format": "date-time", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "format": "date-time", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "userIdNo": { "type": "integer" } }, "title": "LSPServiceTypePojo" }, "LSPVerificationRequest": { "type": "object", "properties": { "courierCollectionCompletionNumber": { "type": "string", "description": "This should only be generated & returned when there are no parcels for collection" } }, "title": "LSPVerificationRequest" }, "LSPVerificationTypeRequest": { "type": "object", "properties": { "lspVerificationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Logistics Service Provider verification type" } }, "title": "LSPVerificationTypeRequest" }, "LocationInsertRequest": { "type": "object", "properties": { "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location type" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationInsertRequest" }, "LocationPojo": { "type": "object", "properties": { "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER LOCATION", "description": "The description of the type of the location at the specific node" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location type" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationPojo" }, "LocationRequest": { "type": "object", "properties": { "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationRequest" }, "LocationStatusDeleteRequest": { "type": "object", "properties": { "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationStatusDeleteRequest" }, "LocationStatusInsertRequest": { "type": "object", "properties": { "locationStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The description of the location status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationStatusInsertRequest" }, "LocationStatusPojo": { "type": "object", "properties": { "locationStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The description of the location status" }, "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationStatusPojo" }, "LocationStatusRequest": { "type": "object", "properties": { "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" } }, "title": "LocationStatusRequest" }, "LocationStatusUpdateRequest": { "type": "object", "properties": { "locationStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The description of the location status" }, "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationStatusUpdateRequest" }, "LocationTypeDeleteRequest": { "type": "object", "properties": { "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the location type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationTypeDeleteRequest" }, "LocationTypeInsertRequest": { "type": "object", "properties": { "locationTypeDesc": { "type": "string", "example": "CUSTOMER LOCATION", "description": "The description of the location type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationTypeInsertRequest" }, "LocationTypePojo": { "type": "object", "properties": { "locationTypeDesc": { "type": "string", "example": "CUSTOMER LOCATION", "description": "The description of the location type" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the location type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationTypePojo" }, "LocationTypeRequest": { "type": "object", "properties": { "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the location type" } }, "title": "LocationTypeRequest" }, "LocationTypeUpdateRequest": { "type": "object", "properties": { "locationTypeDesc": { "type": "string", "example": "CUSTOMER LOCATION", "description": "The description of the location type" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the location type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LocationTypeUpdateRequest" }, "LogisticsServiceProviderDeleteRequest": { "type": "object", "properties": { "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LogisticsServiceProviderDeleteRequest" }, "LogisticsServiceProviderInsertRequest": { "type": "object", "properties": { "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "noOfMaxDaysBeforeCollect": { "type": "integer", "format": "int32", "example": 1, "description": "The maximum number of days the before collection." }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LogisticsServiceProviderInsertRequest" }, "LogisticsServiceProviderModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "logisticsServiceProviderCode": { "type": "string" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32" }, "logisticsServiceProviderName": { "type": "string" }, "noOfMaxDaysBeforeCollect": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "LogisticsServiceProviderModel" }, "LogisticsServiceProviderPojo": { "type": "object", "properties": { "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "noOfMaxDaysBeforeCollect": { "type": "integer", "format": "int32", "example": 1, "description": "The maximum number of days the before collection." }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "LogisticsServiceProviderPojo" }, "LogisticsServiceProviderRequest": { "type": "object", "properties": { "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" } }, "title": "LogisticsServiceProviderRequest" }, "LspServiceTypeDeleteRequest": { "type": "object", "required": [ "lspServiceTypeDesc", "lspServiceTypeIdNo", "userIdNo" ], "properties": { "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "userIdNo": { "type": "integer", "example": 5, "description": "The identifier for the user that performs the insert" } }, "title": "LspServiceTypeDeleteRequest" }, "LspServiceTypeInsertRequest": { "type": "object", "required": [ "lspServiceTypeDesc", "userIdNo" ], "properties": { "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "userIdNo": { "type": "integer", "example": 5, "description": "The identifier for the user that performs the insert" } }, "title": "LspServiceTypeInsertRequest" }, "LspServiceTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LSPServiceTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "LspServiceTypeListResponse" }, "LspServiceTypeRequest": { "type": "object", "properties": { "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" } }, "title": "LspServiceTypeRequest" }, "LspServiceTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LSPServiceTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "LspServiceTypeResponse" }, "LspServiceTypeUpdateRequest": { "type": "object", "required": [ "lspServiceTypeDesc", "lspServiceTypeIdNo", "userIdNo" ], "properties": { "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "userIdNo": { "type": "integer", "example": 5, "description": "The identifier for the user performing the transaction" } }, "title": "LspServiceTypeUpdateRequest" }, "LspVerificationListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LspVerificationPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "LspVerificationListResponse" }, "LspVerificationPojo": { "type": "object", "properties": { "courierCollectionNumber": { "type": "string", "description": "The Collection number that was used to authorise the collection" }, "createDateTime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was created" }, "exceptions": { "type": "integer", "format": "int32", "example": 5, "description": "The amount of scans that had an exception case" }, "expectedNoOfParcels": { "type": "integer", "format": "int32", "example": 5, "description": "The expected number of parcels for the Logistics Service Provider pickup / delivery" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time when the record was last updated" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "lspVerificationCode": { "type": "string", "description": "The unique code used for the Logistics Service Provider verification" }, "lspVerificationTypeDesc": { "type": "string", "example": "COURIER DELIVERY", "description": "The description of the LSP verification type" }, "lspVerificationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Logistics Service Provider verification type" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "The node where the Logistics Service Provider event (pickup / delivery) took place" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "successfulScans": { "type": "integer", "format": "int32", "example": 5, "description": "The amount of scans that was successful" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "LspVerificationPojo" }, "LspVerificationResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LspVerificationPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "LspVerificationResponse" }, "LspVerificationTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/LspVerificationTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "LspVerificationTypeListResponse" }, "LspVerificationTypePojo": { "type": "object", "required": [ "lspVerificationTypeDesc" ], "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "lastUpdateDatetime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date and time when the record was last updated" }, "lspVerificationTypeDesc": { "type": "string", "description": "The description of the LSP verification type" }, "lspVerificationTypeIdNo": { "type": "integer", "format": "int32", "description": "Auto increment number used to uniquely identify a Logistics Service Provider verification type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "LspVerificationTypePojo" }, "LspVerificationTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/LspVerificationTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "LspVerificationTypeResponse" }, "MessageChannelListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageChannelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageChannelListResponse" }, "MessageChannelPojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "messageChannelDesc": { "type": "string", "example": "Counter to counter message channel", "description": "The description of the Message Channel" }, "messageChannelIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Channel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageChannelPojo" }, "MessageChannelRequest": { "type": "object", "properties": { "messageChannelDesc": { "type": "string", "example": "Counter to counter message channel", "description": "The description of the Message Channel" }, "messageChannelIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Channel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageChannelRequest" }, "MessageChannelResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "result": { "$ref": "#/definitions/MessageChannelPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageChannelResponse" }, "MessageRecipientTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageRecipientTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageRecipientTypeListResponse" }, "MessageRecipientTypePojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "messageRecipientTypeDesc": { "type": "string", "example": "SENDER", "description": "The description of the Message Recipient Type" }, "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Recipient Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageRecipientTypePojo" }, "MessageRecipientTypeRequest": { "type": "object", "properties": { "messageRecipientTypeDesc": { "type": "string", "example": "SENDER", "description": "The description of the Message Recipient Type" }, "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Recipient Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageRecipientTypeRequest" }, "MessageRecipientTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "result": { "$ref": "#/definitions/MessageRecipientTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageRecipientTypeResponse" }, "MessageSetListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageSetPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageSetListResponse" }, "MessageSetMessageTemplateListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/MessageSetMessageTemplatePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageSetMessageTemplateListResponse" }, "MessageSetMessageTemplatePojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "messageRecipientTypeDesc": { "type": "string", "example": "SENDER", "description": "The description of the message recipient type" }, "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message recipient type" }, "messageSetDesc": { "type": "string", "example": "GENERIC C2C SET", "description": "The description of the message set" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Set" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageSetMessageTemplatePojo" }, "MessageSetMessageTemplateRequest": { "type": "object", "properties": { "messageRecipientTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message recipient type" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Set" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageSetMessageTemplateRequest" }, "MessageSetMessageTemplateResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "result": { "$ref": "#/definitions/MessageSetMessageTemplatePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageSetMessageTemplateResponse" }, "MessageSetModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "messageSetDesc": { "type": "string" }, "messageSetIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "MessageSetModel" }, "MessageSetPojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "messageSetDesc": { "type": "string", "example": "GENERIC C2C SET", "description": "The description of the Message Channel" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Set" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageSetPojo" }, "MessageSetRequest": { "type": "object", "properties": { "messageSetDesc": { "type": "string", "example": "Counter to counter message channel", "description": "The description of the Message Channel" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Set" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageSetRequest" }, "MessageSetResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/MessageSetPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "MessageSetResponse" }, "MessageTemplateCategoryPojo": { "type": "object", "properties": { "messageTemplateCategoryDesc": { "type": "string", "example": "TEST CATEGORY", "description": "Unique identifier for the message template category dscription" }, "messageTemplateCategoryIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template category" }, "userIdNo": { "type": "integer" } }, "title": "MessageTemplateCategoryPojo" }, "MessageTemplateCategoryRequest": { "type": "object", "properties": { "messageTemplateCategoryIdNo": { "type": "integer", "format": "int32", "example": 1 } }, "title": "MessageTemplateCategoryRequest" }, "MessageTemplateDeleteRequest": { "type": "object", "properties": { "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageTemplateDeleteRequest" }, "MessageTemplateInsertRequest": { "type": "object", "properties": { "messageTemplateCategoryIdNo": { "type": "integer", "format": "int32", "example": 1 }, "messageTemplateDesc": { "type": "string", "description": "The message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageTemplateInsertRequest" }, "MessageTemplatePojo": { "type": "object", "properties": { "messageChannelIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message channel" }, "messageTemplateCategoryIdNo": { "type": "integer", "format": "int32", "example": 1 }, "messageTemplateDesc": { "type": "string", "description": "The message template" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "trnTypeIdNo": { "type": "integer", "format": "int32", "example": 1 }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageTemplatePojo" }, "MessageTemplateRequest": { "type": "object", "properties": { "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" } }, "title": "MessageTemplateRequest" }, "MessageTemplateResultPojo": { "type": "object", "properties": { "category": { "type": "string", "example": 1, "description": "The message category" }, "dateCreated": { "type": "string", "example": "2016-05-09T11:27:05.0000+02:00" }, "message": { "type": "string", "example": "THIS IS A TEST BOOKING", "description": "The booking message" }, "title": { "type": "string", "example": "Booking Message", "description": "The message title" } }, "title": "MessageTemplateResultPojo" }, "MessageTemplateUpdateRequest": { "type": "object", "properties": { "messageTemplateCategoryIdNo": { "type": "integer", "format": "int32", "example": 1 }, "messageTemplateDesc": { "type": "string", "description": "The message template" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "messageTemplateName": { "type": "string", "example": "CUST DROP", "description": "The name of the message template" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MessageTemplateUpdateRequest" }, "MiscClosurePojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "miscClosureType": { "type": "string", "example": "RETURN TO SENDER", "description": "RAM's MiscClosureType" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "MiscClosurePojo" }, "MissingParcelPojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationCountryCode": { "type": "string", "example": "ZA", "description": "The country code of the destination node" }, "destinationNoOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the destination node (to determine capacity)" }, "destinationNodeAddress1": { "type": "string", "example": "First Floor", "description": "Address line 1 for the destination node" }, "destinationNodeAddress2": { "type": "string", "example": "Bergzicht Building", "description": "Address line 2 for the destination node" }, "destinationNodeAddress3": { "type": "string", "example": "Tygerberg Office Park", "description": "Address line 3 for the destination node" }, "destinationNodeAddress4": { "type": "string", "example": "163 Uys Krige Drive", "description": "Address line 4 for the destination node" }, "destinationNodeAddress5": { "type": "string", "example": "Western Cape", "description": "Address line 5 for the destination node" }, "destinationNodeAddress6": { "type": "string", "example": "South Africa", "description": "Address line 6 for the destination node" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "destinationNodeName": { "type": "string", "example": "PEP 658", "description": "The name of the destination node for the parcel" }, "destinationNodeTelephone": { "type": "string", "example": "021 429 2981", "description": "Telephone number for the destination node" }, "destinationTradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the destination node" }, "lastParcelEventDatetime": { "type": "string", "example": "2016-02-07T16:13:09.0000+02:00", "description": "The date and time of the last event that occurred for the parcel" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "logServProvCollectionCode": { "type": "string", "example": "JNB1605250444", "description": "The logistics service provider's collection number" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The code for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "originCountryCode": { "type": "string", "example": "ZA", "description": "The country code of the origin node" }, "originNoOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the origin node (to determine capacity)" }, "originNodeAddress1": { "type": "string", "example": "First Floor", "description": "Address line 1 for the origin node" }, "originNodeAddress2": { "type": "string", "example": "Plattekloof House Building", "description": "Address line 2 for the origin node" }, "originNodeAddress3": { "type": "string", "example": "Tygerberg Office Park", "description": "Address line 3 for the origin node" }, "originNodeAddress4": { "type": "string", "example": "163 Uys Krige Drive", "description": "Address line 4 for the origin node" }, "originNodeAddress5": { "type": "string", "example": "Western Cape", "description": "Address line 5 for the origin node" }, "originNodeAddress6": { "type": "string", "example": "South Africa", "description": "Address line 6 for the origin node" }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel was originally received" }, "originNodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node where the parcel was originally received" }, "originNodeIdNo": { "type": "integer", "format": "int32", "description": "The unique identifier of the node where the parcel was originally received" }, "originNodeName": { "type": "string", "example": "PEP 771", "description": "The name of the node where the parcel was originally received" }, "originNodeNodeTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node type where the parcel was originally received" }, "originNodeTelephone": { "type": "string", "example": "021 429 2999", "description": "Telephone number for the origin node" }, "originTradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the origin node" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeDesc": { "type": "string", "example": "ASSIGNMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "rcvCustomerCellPhone": { "type": "string", "example": 833214552, "description": "The receiving customer's cellphone number" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "supplierCode": { "type": "string", "example": "PEP", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "MissingParcelPojo" }, "NearestNodeRequest": { "type": "object", "properties": { "address": { "type": "string" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "productCode": { "type": "string" }, "supplierCode": { "type": "string" } }, "title": "NearestNodeRequest" }, "NearestNodeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NearsetNodeResult" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NearestNodeResponse" }, "NearsetNodeResult": { "type": "object", "properties": { "distance": { "type": "number", "format": "double" }, "nodeCode": { "type": "string" }, "nodeShortName": { "type": "string" } }, "title": "NearsetNodeResult" }, "NodeBookingParcelListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeBookingParcelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodeBookingParcelListResponse" }, "NodeBookingParcelPojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "PN160614130632360", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "T_uNWkVxMZ", "description": "The cellphone number of the customer sending the parcel" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "NodeBookingParcelPojo" }, "NodeClassificationTypeDeleteRequest": { "type": "object", "required": [ "nodeClassificationTypeIdNo", "userIdNo" ], "properties": { "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "Auto increment number used to uniquely identify a Node Classification Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeClassificationTypeDeleteRequest" }, "NodeClassificationTypeInsertRequest": { "type": "object", "required": [ "nodeClassificationTypeDesc", "nodeClassificationTypeIdNo", "userIdNo" ], "properties": { "nodeClassificationTypeDesc": { "type": "string", "description": "The description of the Node Classification Type, e.g. MAIN, REGIONAL, etc." }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "Auto increment number used to uniquely identify a Node Classification Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeClassificationTypeInsertRequest" }, "NodeClassificationTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeClassificationTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodeClassificationTypeListResponse" }, "NodeClassificationTypePojo": { "type": "object", "required": [ "lastUpdateDatetime", "nodeClassificationTypeDesc", "nodeClassificationTypeIdNo", "userIdNo" ], "properties": { "discontinueDatetime": { "type": "string", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "nodeClassificationTypeDesc": { "type": "string", "description": "The description of the Node Classification Type, e.g. MAIN, REGIONAL, etc." }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "Auto increment number used to uniquely identify a Node Classification Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeClassificationTypePojo" }, "NodeClassificationTypeRequest": { "type": "object", "properties": { "nodeClassificationTypeDesc": { "type": "string", "description": "The description of the Node Classification Type, e.g. MAIN, REGIONAL, etc." }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "Auto increment number used to uniquely identify a Node Classification Type" } }, "title": "NodeClassificationTypeRequest" }, "NodeClassificationTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodeClassificationTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodeClassificationTypeResponse" }, "NodeConceptDeleteRequest": { "type": "object", "properties": { "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeConceptDeleteRequest" }, "NodeConceptInsertRequest": { "type": "object", "properties": { "nodeConceptDesc": { "type": "string", "example": "STORE", "description": "The description of the node concept" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeConceptInsertRequest" }, "NodeConceptModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "nodeConceptDesc": { "type": "string" }, "nodeConceptIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "NodeConceptModel" }, "NodeConceptPojo": { "type": "object", "properties": { "nodeConceptDesc": { "type": "string", "example": "STORE", "description": "The description of the node concept" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "userIdNo": { "type": "integer" } }, "title": "NodeConceptPojo" }, "NodeConceptRequest": { "type": "object", "properties": { "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" } }, "title": "NodeConceptRequest" }, "NodeConceptUpdateRequest": { "type": "object", "properties": { "nodeConceptDesc": { "type": "string", "example": "STORE", "description": "The description of the node concept" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeConceptUpdateRequest" }, "NodeDeleteRequest": { "type": "object", "properties": { "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeDeleteRequest" }, "NodeFilteredLightRequest": { "type": "object", "properties": { "activeNodesOnly": { "type": "boolean", "example": true, "description": "Boolean identifier for the node status true = activeNodes, i.e. stores that are trading and available to receive and dispense parcels. false = allNodes, including nodes not currently available due to being closed temporarily or permanently, or new stores that are not yet open" }, "nodeCode": { "type": "string", "example": "P9999", "description": "Issued by PAXI. The unique identifier for the location/node. If populated, ONLY this node's data will be returned. If left blank, ALL nodes matching the other filters will be returned." }, "productIdNo": { "type": "integer", "format": "int32", "example": 99, "description": "Issued by PAXI. A unique product identifier indicating the parcel type. For a list of allowed parceIdNo's please call /getProductBySupplier using your supplierCode. This parameter will limit the output to locations/nodes/stores where the product has been approved to be collected from" } }, "title": "NodeFilteredLightRequest" }, "NodeFilteredRequest": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "PEP", "description": "The code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeDesc": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "nodeIdNo": { "type": "array", "description": "Unique identifier for the node", "items": { "type": "integer", "format": "int32" } }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "nodeTypeIdNo": { "type": "array", "description": "Unique identifier for the node status", "items": { "type": "integer", "format": "int32" } }, "pilotModeInd": { "type": "string", "example": "Y", "description": "An indicator that identifies if a node is used for pilot mode" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" } }, "title": "NodeFilteredRequest" }, "NodeGroupDeleteRequest": { "type": "object", "properties": { "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node group" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeGroupDeleteRequest" }, "NodeGroupDescRequest": { "type": "object", "properties": { "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL", "description": "The description of the node group" } }, "title": "NodeGroupDescRequest" }, "NodeGroupInsertRequest": { "type": "object", "properties": { "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL", "description": "The description of the node group" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeGroupInsertRequest" }, "NodeGroupModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "nodeGroupDesc": { "type": "string" }, "nodeGroupIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "NodeGroupModel" }, "NodeGroupNodeConceptPojo": { "type": "object", "properties": { "nodeConceptDesc": { "type": "string", "example": "CELL", "description": "The description of the node concept" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL", "description": "The description of the node group" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "userIdNo": { "type": "integer" } }, "title": "NodeGroupNodeConceptPojo" }, "NodeGroupNodeConceptRequest": { "type": "object", "properties": { "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeGroupNodeConceptRequest" }, "NodeGroupPojo": { "type": "object", "properties": { "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL", "description": "The description of the node group" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node group" }, "userIdNo": { "type": "integer" } }, "title": "NodeGroupPojo" }, "NodeGroupRequest": { "type": "object", "properties": { "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node group" } }, "title": "NodeGroupRequest" }, "NodeGroupUpdateRequest": { "type": "object", "properties": { "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL", "description": "The description of the node group" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node group" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeGroupUpdateRequest" }, "NodeInsertRequest": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "MOGWASE SHOPPING CENTRE", "description": "Address line 1 of the node" }, "addressLine2": { "type": "string", "example": "SHOP 3", "description": "Address line 2 of the node" }, "addressLine3": { "type": "string", "example": "KAGISO DRIVE", "description": "Address line 3 of the node" }, "addressLine4": { "type": "string", "example": "Maroleng", "description": "Address line 4 of the node" }, "addressLine5": { "type": "string", "example": "Maroleng", "description": "Address line 5 of the node" }, "addressLine6": { "type": "string", "example": "North West Province", "description": "Address line 6 of the node" }, "companyCode": { "type": "string", "example": "PEP", "description": "The code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "countryCode": { "type": "string", "example": "ZA", "description": "The country the node is located in" }, "latitude": { "type": "string", "example": -25.273131, "description": "Latitude of where the node is located" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "longitude": { "type": "string", "example": 27.236045, "description": "Longitude of where the node is located" }, "noOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the node (to determine capacity)" }, "nodeCloseDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node closed" }, "nodeCloseDate_": { "type": "string", "format": "date-time" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node" }, "nodeDesc": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "nodeEmail": { "type": "string", "example": "s8031@field.pepstores.com", "description": "The node's email address" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeOpenDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node opened" }, "nodeOpenDate_": { "type": "string", "format": "date-time" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "nodeTelephone": { "type": "string", "example": "021 429 2999", "description": "The telephone number of the node" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "pilotModeInd": { "type": "string", "example": "Y", "description": "An indicator that identifies if a node is used for pilot mode" }, "postalCode": { "type": "string", "example": "0314", "description": "The postal code of the node" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "tradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeInsertRequest" }, "NodeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodeListResponse" }, "NodeLocationByCustomerRefCodeRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "NodeLocationByCustomerRefCodeRequest" }, "NodeLocationByNodeLSPRequest": { "type": "object", "properties": { "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" } }, "title": "NodeLocationByNodeLSPRequest" }, "NodeLocationByNodeLocationCodeRequest": { "type": "object", "properties": { "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" } }, "title": "NodeLocationByNodeLocationCodeRequest" }, "NodeLocationDeleteRequest": { "type": "object", "properties": { "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeLocationDeleteRequest" }, "NodeLocationInsertRequest": { "type": "object", "properties": { "allowTrustedCollectionInd": { "type": "string", "example": "Y", "description": "Indicates whether bulk collections can be performed from the current location the parcel is" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "The height measured in cm" }, "lengthCm": { "type": "number", "format": "double", "example": 50, "description": "Length of the parcel measured in cm" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location type" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "noOfMaxParcelsInLocation": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of parcels allowed in the location at the specific node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "secureLocationInd": { "type": "string", "example": "N", "description": "Indicator to show if the location at the specific node is secure" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "widthCm": { "type": "number", "format": "double", "example": 20, "description": "Width of the parcel measured in cm" } }, "title": "NodeLocationInsertRequest" }, "NodeLocationPojo": { "type": "object", "properties": { "allowTrustedCollectionInd": { "type": "string", "example": "Y", "description": "Indicates whether bulk collections can be performed from the current location the parcel is" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "The height measured in cm" }, "lengthCm": { "type": "number", "format": "double", "example": 50, "description": "Length of the parcel measured in cm" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The description of the location status" }, "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" }, "locationTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER LOCATION", "description": "The description of the type of the location at the specific node" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location type" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "noOfMaxParcelsInLocation": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of parcels allowed in the location at the specific node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "nodeName": { "type": "string", "example": "PEP 658", "description": "The name of the node" }, "secureLocationInd": { "type": "string", "example": "N", "description": "Indicator to show if the location at the specific node is secure" }, "widthCm": { "type": "number", "format": "double", "example": 20, "description": "Width of the parcel measured in cm" } }, "title": "NodeLocationPojo" }, "NodeLocationRequest": { "type": "object", "properties": { "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" } }, "title": "NodeLocationRequest" }, "NodeLocationStatusRequest": { "type": "object", "properties": { "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The description of the location status" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeLocationStatusRequest" }, "NodeLocationStockCountPojo": { "type": "object", "properties": { "category": { "type": "string" }, "parcelCount": { "type": "integer", "format": "int32" }, "shortCode": { "type": "string" } }, "title": "NodeLocationStockCountPojo" }, "NodeLocationUpdateRequest": { "type": "object", "properties": { "allowTrustedCollectionInd": { "type": "string", "example": "Y", "description": "Indicates whether bulk collections can be performed from the current location the parcel is" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "The height measured in cm" }, "lengthCm": { "type": "number", "format": "double", "example": 50, "description": "Length of the parcel measured in cm" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "locationStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The description of the location status" }, "locationStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location status" }, "locationTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the location type" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "noOfMaxParcelsInLocation": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of parcels allowed in the location at the specific node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "secureLocationInd": { "type": "string", "example": "N", "description": "Indicator to show if the location at the specific node is secure" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "widthCm": { "type": "number", "format": "double", "example": 20, "description": "Width of the parcel measured in cm" } }, "title": "NodeLocationUpdateRequest" }, "NodeLspClassificationInsertRequest": { "type": "object", "required": [ "logisticsServProviderIdNo", "nodeClassificationTypeIdNo", "nodeIdNo", "userIdNo" ], "properties": { "logisticsServProviderIdNo": { "type": "integer", "format": "int32", "description": "The Logistics Service Provider" }, "lspHubCode": { "type": "string", "description": "The logistics service provider hub that the specific node is linked to" }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "The Node Classification Type of the specific Node for the specific Logistics Service Provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "description": "The Node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeLspClassificationInsertRequest" }, "NodeLspClassificationListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodeLspClassificationPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodeLspClassificationListResponse" }, "NodeLspClassificationPojo": { "type": "object", "required": [ "lastUpdateDatetime", "logisticsServProviderIdNo", "nodeClassificationTypeIdNo", "nodeIdNo", "userIdNo" ], "properties": { "discontinueDatetime": { "type": "string", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "logisticsServProviderIdNo": { "type": "integer", "format": "int32", "description": "The Logistics Service Provider" }, "lspHubCode": { "type": "string", "description": "The logistics service provider hub that the specific node is linked to" }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "The Node Classification Type of the specific Node for the specific Logistics Service Provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "description": "The Node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeLspClassificationPojo" }, "NodeLspClassificationRequest": { "type": "object", "required": [ "userIdNo" ], "properties": { "logisticsServProviderIdNo": { "type": "integer", "format": "int32", "description": "The Logistics Service Provider" }, "lspHubCode": { "type": "string", "description": "The logistics service provider hub that the specific node is linked to" }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "The Node Classification Type of the specific Node for the specific Logistics Service Provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "description": "The Node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeLspClassificationRequest" }, "NodeLspClassificationUpdateRequest": { "type": "object", "required": [ "logisticsServProviderIdNo", "nodeClassificationTypeIdNo", "nodeIdNo", "userIdNo" ], "properties": { "logisticsServProviderIdNo": { "type": "integer", "format": "int32", "description": "The Logistics Service Provider" }, "lspHubCode": { "type": "string", "description": "The logistics service provider hub that the specific node is linked to" }, "nodeClassificationTypeIdNo": { "type": "integer", "format": "int32", "description": "The Node Classification Type of the specific Node for the specific Logistics Service Provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "description": "The Node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeLspClassificationUpdateRequest" }, "NodeMessageRequest": { "type": "object", "properties": { "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node" } }, "title": "NodeMessageRequest" }, "NodeModel": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "addressLine4": { "type": "string" }, "addressLine5": { "type": "string" }, "addressLine6": { "type": "string" }, "company": { "$ref": "#/definitions/CompanyModel" }, "countryCode": { "type": "string" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "latitude": { "type": "string" }, "logisticsServiceProvider": { "$ref": "#/definitions/LogisticsServiceProviderModel" }, "longitude": { "type": "string" }, "noOfMaxBoxes": { "type": "integer", "format": "int32" }, "nodeCloseDate": { "type": "string", "format": "date-time" }, "nodeCode": { "type": "string" }, "nodeConcept": { "$ref": "#/definitions/NodeConceptModel" }, "nodeContactName": { "type": "string" }, "nodeDesc": { "type": "string" }, "nodeEmail": { "type": "string" }, "nodeIdNo": { "type": "integer", "format": "int32" }, "nodeOpenDate": { "type": "string", "format": "date-time" }, "nodeShortName": { "type": "string" }, "nodeStatus": { "$ref": "#/definitions/NodeStatusModel" }, "nodeTelephone": { "type": "string" }, "nodeType": { "$ref": "#/definitions/NodeTypeModel" }, "pilotModeInd": { "type": "string" }, "postalCode": { "type": "string" }, "supplier": { "$ref": "#/definitions/SupplierModel" }, "tradingHoursJson": { "type": "string" }, "userIdNo": { "type": "integer" } }, "title": "NodeModel" }, "NodePojo": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "MOGWASE SHOPPING CENTRE", "description": "Address line 1 of the node" }, "addressLine2": { "type": "string", "example": "SHOP 3", "description": "Address line 2 of the node" }, "addressLine3": { "type": "string", "example": "KAGISO DRIVE", "description": "Address line 3 of the node" }, "addressLine4": { "type": "string", "example": "Maroleng", "description": "Address line 4 of the node" }, "addressLine5": { "type": "string", "example": "Maroleng", "description": "Address line 5 of the node" }, "addressLine6": { "type": "string", "example": "North West Province", "description": "Address line 6 of the node" }, "companyCode": { "type": "string", "example": "PEP", "description": "The code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company" }, "countryCode": { "type": "string", "example": "ZA", "description": "The country the node is located in" }, "latitude": { "type": "string", "example": -25.273131, "description": "Latitude of where the node is located" }, "logisticsServiceProvicerName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The code for the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "longitude": { "type": "string", "example": 27.236045, "description": "Longitude of where the node is located" }, "noOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the node (to determine capacity)" }, "nodeCloseDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node closed" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeConceptDesc": { "type": "string", "example": "STORE", "description": "The description of the node concept" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node" }, "nodeDesc": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "nodeEmail": { "type": "string", "example": "s8031@field.pepstores.com", "description": "The node's email address" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeName": { "type": "string", "example": "PEP MGWS", "description": "The name of the node" }, "nodeOpenDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node opened" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "nodeStatusDesc": { "type": "string", "example": "PLANNED", "description": "The description of the node status" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "nodeTelephone": { "type": "string", "example": "021 429 2999", "description": "The telephone number of the node" }, "nodeTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER HUB", "description": "The description of the node status" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "pilotModeInd": { "type": "string", "example": "Y", "description": "An indicator that identifies if a node is used for pilot mode" }, "postalCode": { "type": "string", "example": "0314", "description": "The postal code of the node" }, "productIdNo": { "type": "integer", "format": "int32" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "tradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodePojo" }, "NodePojoLight": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "SHOP X SAMPLE MALL", "description": "Returns the shop number and the building name" }, "addressLine2": { "type": "string", "example": "C/O EXAMPLE STREET", "description": "Returns the street address of the node" }, "addressLine3": { "type": "string", "example": "& DEMONSTRATION AVENUE", "description": "Returns a secondary street address if the node is located on a street corner" }, "addressLine4": { "type": "string", "example": "SAMPLEVILLE", "description": "Returns the suburb that the node is located in" }, "addressLine5": { "type": "string", "example": "SAMPLE TOWN", "description": "Returns the city or town that the node is located in" }, "addressLine6": { "type": "string", "example": "FREE STATE", "description": "Returns the province that the node is located in." }, "countryCode": { "type": "string", "example": "ZA", "description": "Returns the country code that the node is located in." }, "latitude": { "type": "string", "example": -29.465811, "description": "Latitude of where the node is located" }, "longitude": { "type": "string", "example": 24.504266, "description": "Longitude of where the node is located" }, "nodeCode": { "type": "string", "example": "P9999", "description": "The unique node/location/store identifier" }, "nodeConceptDesc": { "type": "string", "example": "PEP STORE", "description": "The store concept of the node, i.e. PEP STORE, PEP CELL, PEP HOME etc" }, "nodeOpenDate": { "type": "string", "example": "1970-01-01", "description": "The date the node opened" }, "nodeShortName": { "type": "string", "example": "PEP SAMPLE STORE SAMPLE TOWN", "description": "A name description of the node, limited to 30 characters" }, "nodeStatusDesc": { "type": "string", "example": "ACTIVE", "description": "The current status of the node, i.e. ACTIVE, CLOSED, HOLD, PLANNED etc." }, "nodeTypeDesc": { "type": "string", "example": "STORE", "description": "The type of node, i.e. STORE" }, "postalCode": { "type": "string", "example": 9999, "description": "The postal code of the node address" } }, "title": "NodePojoLight" }, "NodePojoLightListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/NodePojoLight" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodePojoLightListResponse" }, "NodeRequest": { "type": "object", "properties": { "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" } }, "title": "NodeRequest" }, "NodeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/NodePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "NodeResponse" }, "NodeStatusDeleteRequest": { "type": "object", "properties": { "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeStatusDeleteRequest" }, "NodeStatusInsertRequest": { "type": "object", "properties": { "nodeStatusDesc": { "type": "string", "example": "PLANNED", "description": "The description of the node status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeStatusInsertRequest" }, "NodeStatusModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "nodeStatusDesc": { "type": "string" }, "nodeStatusIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "NodeStatusModel" }, "NodeStatusPojo": { "type": "object", "properties": { "nodeStatusDesc": { "type": "string", "example": "PLANNED", "description": "The description of the node status" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "userIdNo": { "type": "integer" } }, "title": "NodeStatusPojo" }, "NodeStatusRequest": { "type": "object", "properties": { "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" } }, "title": "NodeStatusRequest" }, "NodeStatusUpdateRequest": { "type": "object", "properties": { "nodeStatusDesc": { "type": "string", "example": "PLANNED", "description": "The description of the node status" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeStatusUpdateRequest" }, "NodeTypeDeleteRequest": { "type": "object", "properties": { "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeTypeDeleteRequest" }, "NodeTypeInsertRequest": { "type": "object", "properties": { "nodeTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER HUB", "description": "The description of the node type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeTypeInsertRequest" }, "NodeTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "nodeTypeDesc": { "type": "string" }, "nodeTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "NodeTypeModel" }, "NodeTypePojo": { "type": "object", "properties": { "nodeTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER HUB", "description": "The description of the node type" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "userIdNo": { "type": "integer" } }, "title": "NodeTypePojo" }, "NodeTypeRequest": { "type": "object", "properties": { "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" } }, "title": "NodeTypeRequest" }, "NodeTypeUpdateRequest": { "type": "object", "properties": { "nodeTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER HUB", "description": "The description of the node type" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeTypeUpdateRequest" }, "NodeUpdateRequest": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "MOGWASE SHOPPING CENTRE", "description": "Address line 1 of the node" }, "addressLine2": { "type": "string", "example": "SHOP 3", "description": "Address line 2 of the node" }, "addressLine3": { "type": "string", "example": "KAGISO DRIVE", "description": "Address line 3 of the node" }, "addressLine4": { "type": "string", "example": "Maroleng", "description": "Address line 4 of the node" }, "addressLine5": { "type": "string", "example": "Maroleng", "description": "Address line 5 of the node" }, "addressLine6": { "type": "string", "example": "North West Province", "description": "Address line 6 of the node" }, "companyCode": { "type": "string", "example": "PEP", "description": "The code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "countryCode": { "type": "string", "example": "ZA", "description": "The country the node is located in" }, "latitude": { "type": "string", "example": -25.273131, "description": "Latitude of where the node is located" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "longitude": { "type": "string", "example": 27.236045, "description": "Longitude of where the node is located" }, "noOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the node (to determine capacity)" }, "nodeCloseDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node closed" }, "nodeCloseDate_": { "type": "string" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node" }, "nodeDesc": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "nodeEmail": { "type": "string", "example": "s8031@field.pepstores.com", "description": "The node's email address" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeOpenDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node opened" }, "nodeOpenDate_": { "type": "string" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "nodeTelephone": { "type": "string", "example": "021 429 2999", "description": "The telephone number of the node" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "pilotModeInd": { "type": "string", "example": "Y", "description": "An indicator that identifies if a node is used for pilot mode" }, "postalCode": { "type": "string", "example": "0314", "description": "The postal code of the node" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "tradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "NodeUpdateRequest" }, "NodesListFor3rdPartyOutput": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "MOGWASE SHOPPING CENTRE", "description": "Address line 1 of the node" }, "addressLine2": { "type": "string", "example": "SHOP 3", "description": "Address line 2 of the node" }, "addressLine3": { "type": "string", "example": "KAGISO DRIVE", "description": "Address line 3 of the node" }, "addressLine4": { "type": "string", "example": "Maroleng", "description": "Address line 4 of the node" }, "cityName": { "type": "string", "example": "BELLVILLE", "description": "The name of the city" }, "companyCode": { "type": "string", "example": "PEP", "description": "The code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company" }, "latitude": { "type": "string", "example": -25.273131, "description": "Latitude of where the node is located" }, "logisticsServiceProvicerName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The code for the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "longitude": { "type": "string", "example": 27.236045, "description": "Longitude of where the node is located" }, "nodeCloseDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node closed" }, "nodeCloseDate_": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node closed" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeConceptDesc": { "type": "string", "example": "STORE", "description": "The description of the node concept" }, "nodeConceptIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node concept" }, "nodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node" }, "nodeDesc": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "nodeEmail": { "type": "string", "example": "s8031@field.pepstores.com", "description": "The node's email address" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "nodeOpenDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node opened" }, "nodeOpenDate_": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the node opened" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "nodeStatusDesc": { "type": "string", "example": "PLANNED", "description": "The description of the node status" }, "nodeStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node status" }, "nodeTelephone": { "type": "string", "example": "021 429 2999", "description": "The telephone number of the node" }, "nodeTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER HUB", "description": "The description of the node status" }, "nodeTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node status" }, "pilotModeInd": { "type": "string", "example": "Y", "description": "An indicator that identifies if a node is used for pilot mode" }, "postalCode": { "type": "string", "example": "0314", "description": "The postal code of the node" }, "productIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique Identifier for the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "suburbIdNo": { "type": "integer", "format": "int32", "example": 454, "description": "Unique identifier for the suburb" }, "suburbName": { "type": "string", "example": "BELLVILLE", "description": "The name of the suburb" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "NodesListFor3rdPartyOutput" }, "NodesListFor3rdPartyRequest": { "type": "object", "properties": { "companyCode": { "type": "string", "example": "PEP", "description": "The company the node is linked to. If you require the data for all nodes for a specific company, for example PEP, you only need to populate this parameter in the API call." }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node. If you require the data for a specific node, you will call the API with this parameter as well as the companyCode parameter populated." }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "productIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product. /lookup/product/getProductBySupplier can be used to get a list of all available products." } }, "title": "NodesListFor3rdPartyRequest" }, "NonCollectionParcelPojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "forcedReturnInd": { "type": "string", "example": "N", "description": "The indictor which is set once a forced return must be done for that parcel" }, "lastParcelEventDatetime": { "type": "string", "example": "2016-02-07T16:13:09.0000+02:00", "description": "The date and time of the last event that occurred for the parcel" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "originNodeNodeTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node type where the parcel was originally received" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "NonCollectionParcelPojo" }, "OneProfileAddUserData": { "type": "object", "properties": { "error_description": { "type": "string" }, "guid": { "type": "string" }, "profile_user_id": { "type": "string" }, "status": { "type": "string" } }, "title": "OneProfileAddUserData" }, "OneProfileCustomerDetailsPojo": { "type": "object", "properties": { "rcvCustomerContactNumber": { "type": "string", "description": "The customers primary mobile number" }, "sendCustomerContactNumber": { "type": "string", "description": "The customers primary mobile number" }, "sendCustomerCountry": { "type": "string", "description": "The country the customer is from" }, "sendCustomerFirstName": { "type": "string", "description": "The customers first name" }, "sendCustomerGuid": { "type": "string", "description": "This is the oneProfile records primary identifier" }, "sendCustomerIdNumber": { "type": "string", "description": "The customer identification document number" }, "sendCustomerLastName": { "type": "string", "description": "The customers last name" }, "sendCustomerPassportCountry": { "type": "string", "description": "The country where the passport was issued" }, "sendCustomerPassportNumber": { "type": "string", "description": "The Passport Number of the customer" } }, "title": "OneProfileCustomerDetailsPojo" }, "OneProfileCustomerPojo": { "type": "object", "properties": { "customerCountry": { "type": "string", "description": "The country the customer is from" }, "customerFirstName": { "type": "string", "description": "The customers first name" }, "customerIdNumber": { "type": "string", "description": "The customer identification document number" }, "customerLastName": { "type": "string", "description": "The customers last name" }, "customerPassportCountry": { "type": "string", "description": "The country where the passport was issued" }, "customerPassportNumber": { "type": "string", "description": "The Passport Number of the customer" }, "scanType": { "type": "string", "description": "Indicator to specify what type if identification was used to create the one profile record", "enum": [ "ID", "PASSPORT" ] } }, "title": "OneProfileCustomerPojo" }, "OneProfileInsertRequest": { "type": "object", "properties": { "customerFirstName": { "type": "string", "description": "The customers first name" }, "customerIdCountry": { "type": "string", "description": "The country the customer is from" }, "customerIdNumber": { "type": "string", "description": "The customer identification document number" }, "customerLastName": { "type": "string", "description": "The customers last name" }, "customerPassportCountry": { "type": "string", "description": "The country where the passport was issued" }, "customerPassportNumber": { "type": "string", "description": "The Passport Number of the customer" } }, "title": "OneProfileInsertRequest" }, "OneProfileResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/OneProfileAddUserData" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "OneProfileResponse" }, "PagingAndSortingData": { "type": "object", "properties": { "csvSortFieldnames": { "type": "string", "example": "name,surname", "description": "Comma seperated field names by which to priorotise the sort" }, "pageSize": { "type": "integer", "format": "int32", "example": 10, "description": "Start item that you are requesting (default=10 & max=100)" }, "sortAscending": { "type": "boolean", "example": true, "description": "Direction of sort (true=asc | false=desc)" }, "startIndex": { "type": "integer", "format": "int32", "example": 1, "description": "Index of first record to return (0 indexed)" } }, "title": "PagingAndSortingData" }, "ParcelAwaitingUpliftmentRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2807, "description": "Unique identifier for the current node" }, "eventReferenceCode": { "type": "string", "example": "D999SN17039090053293", "description": "Reference code for the event" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "ParcelAwaitingUpliftmentRequest" }, "ParcelAwaitingUpliftmentSummaryRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2807, "description": "Unique identifier for the current node" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "ParcelAwaitingUpliftmentSummaryRequest" }, "ParcelDeleteRequest": { "type": "object", "properties": { "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelDeleteRequest" }, "ParcelDropTokenCodeSearchRequest": { "type": "object", "properties": { "dropTokenCode": { "type": "string", "example": 1, "description": "Unique identifier for the dropToken" } }, "title": "ParcelDropTokenCodeSearchRequest" }, "ParcelEligibleForDeliveryListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ParcelEligibleForDeliveryPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelEligibleForDeliveryListResponse" }, "ParcelEligibleForDeliveryPojo": { "type": "object", "properties": { "alternateCollectionRequirements": { "$ref": "#/definitions/CustomerCollectionRequirementsPojo" }, "colCustomerOneProfileGuid": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is collecting the parcel who is not the intended receiver" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeAddress1": { "type": "string", "example": "Address line 1 for the destination node", "description": "First Floor" }, "destinationNodeAddress2": { "type": "string", "example": "Bergzicht Building", "description": "Address line 2 for the destination node" }, "destinationNodeAddress3": { "type": "string", "example": "Tygerberg Office Park", "description": "Address line 3 for the destination node" }, "destinationNodeAddress4": { "type": "string", "example": "163 Uys Krige Drive", "description": "Address line 4 for the destination node" }, "destinationNodeAddress5": { "type": "string", "example": "Western Cape", "description": "Address line 5 for the destination node" }, "destinationNodeAddress6": { "type": "string", "example": "South Africa", "description": "Address line 6 for the destination node" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "destinationNodeName": { "type": "string", "example": "PEP 658", "description": "The name of the destination node for the parcel" }, "destinationNodeNodeTypeDesc": { "type": "string", "example": "STORE", "description": "The description of the node type where the parcel was destined to be delivered" }, "inductionDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the parcel was inducted" }, "intoNodeDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the parcel was received at the current node" }, "isRcvCustomerIsSupplier": { "type": "boolean" }, "isSendCustomerIsSupplier": { "type": "boolean" }, "lastParcelEventDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date and time of the last event that occurred for the parcel" }, "lastParcelEventTypeDesc": { "type": "string", "description": "The Description of the last event that occurred for the parcel" }, "lastParcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the last event that occurred for the parcel" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code of the location where the parcel is currently in" }, "locationTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER LOCATION", "description": "The description of the type of the location at the specific node" }, "logServProvCollectionCode": { "type": "string", "example": "JNB1605250444", "description": "The logistics service provider's collection number" }, "logServProvDelManifestCode": { "type": "string", "example": "JNB1605250444", "description": "The logistic service provider delivert manifest code" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "The unique identifier for the node" }, "normalCollectionRequirements": { "$ref": "#/definitions/CustomerCollectionRequirementsPojo" }, "originNodeAddress1": { "type": "string", "example": "First Floor", "description": "Address line 1 for the origin node" }, "originNodeAddress2": { "type": "string", "example": "Plattekloof House Building", "description": "Address line 2 for the origin node" }, "originNodeAddress3": { "type": "string", "example": "Tygerberg Office Park", "description": "Address line 3 for the origin node" }, "originNodeAddress4": { "type": "string", "example": "163 Uys Krige Drive", "description": "Address line 4 for the origin node" }, "originNodeAddress5": { "type": "string", "example": "Western Cape", "description": "Address line 5 for the origin node" }, "originNodeAddress6": { "type": "string", "example": "South Africa", "description": "Address line 6 for the origin node" }, "originNodeNodeTypeDesc": { "type": "string", "example": "STORE", "description": "The description of the origin node type" }, "parcelAge": { "type": "integer", "format": "int64", "example": 3, "description": "The total age of the parcel" }, "parcelDaysInNode": { "type": "integer", "format": "int64", "example": 2, "description": "The number of days the parcel has been at the current node" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeDesc": { "type": "string", "example": "PARCEL", "description": "Unique identifier for the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "rcvCustomerSupplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier, if the receiving customer is a supplier" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "sendCustomerSupplierName": { "type": "string", "description": "The name of the supplier, if the sending customer is a supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelEligibleForDeliveryPojo" }, "ParcelEligibleForDeliveryRequest": { "type": "object", "properties": { "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 2807, "description": "Unique identifier for the current node" }, "eventReferenceCode": { "type": "string", "example": "D999SN17039090053293", "description": "Reference code for the event" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" } }, "title": "ParcelEligibleForDeliveryRequest" }, "ParcelEventCloseCollectionRequest": { "type": "object", "properties": { "courierCollectionNumber": { "type": "string", "description": "Collection number used to validate collection against" }, "deviceGUID": { "type": "string", "example": "GUID46345645", "description": "Unique identifier for the device on which the event was captured" }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "eventUserIdNo": { "type": "integer", "example": 1, "description": "The user id of the user who captured the event" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "missingParcelIds": { "type": "array", "items": { "type": "integer" } }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the node" }, "scannedBarcodes": { "type": "array", "items": { "$ref": "#/definitions/ScannedBarcode" } }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelEventCloseCollectionRequest" }, "ParcelEventDeleteRequest": { "type": "object", "properties": { "eventDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time of the event" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" } }, "title": "ParcelEventDeleteRequest" }, "ParcelEventIdRequest": { "type": "object", "required": [ "parcelIdNo" ], "properties": { "isCustomerVisibleOnly": { "type": "boolean", "example": true, "description": "This indicates if events should use filter or not" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" } }, "title": "ParcelEventIdRequest" }, "ParcelEventInsertRequest": { "type": "object", "required": [ "nodeCode", "parcelEventTypeDesc", "userIdNo" ], "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "TThe reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label, for example D151200024017.For Unisa Assignments, this will be the number on the drop label." }, "deviceGUID": { "type": "string", "example": "GUID46345645", "description": "Unique identifier for the device on which the event was captured" }, "eventDatetime": { "type": "string", "example": "02-FEB-2016 14:30:00.000", "description": "The date and time the event was captured, in the format \"dd-MMM-yyyy HH:mm:ss.SSS\", e.g. \"02-FEB-2016 14:30:00.000\". If the date and time is not supplied, the system will automatically use the current date and time." }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "eventUserIdNo": { "type": "integer", "example": 1, "description": "The user id of the user who captured the event" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code of the location where the parcel is currently in" }, "logServProvParcelCode": { "type": "string" }, "logServProvWaybillCode": { "type": "string" }, "nodeCode": { "type": "string", "example": "P8026", "description": "The code for the node where the parcel event occurred. For couriers, we would like to receive the courier hub / branch code here." }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the node" }, "parcelEventTypeDesc": { "type": "string", "example": "HUB INSCAN", "description": "The description of the parcel event type. We would like to receive the following 4 parcel event types: HUB INSCAN, HUB OUTSCAN, POD, WRITE OFF, REROUTE. HUB INSCAN should be used for all inscan events at a courier hub / branch. HUB OUTSCAN should be used for all outscan events at a courier hub / branch. POD should be used when a parcel is delivered to its destination. WRITE OFF should be used when a parcel is written off during the debrief process. REROUTE should be used when a parcel is rerouted to a different destination." }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" }, "returnReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique id for return reason" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" }, "supplierName": { "type": "string" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record. *** The userIdNo to use will be supplied once integration development starts ***" }, "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason, if it is a write off event. Couriers should only use writeOffReasonIdNo 2 for write off events." } }, "title": "ParcelEventInsertRequest" }, "ParcelEventListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ParcelEventPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelEventListResponse" }, "ParcelEventPojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "damagedParcelIds": { "type": "array", "items": { "type": "integer" } }, "deviceGUID": { "type": "string", "example": "GUID46345645", "description": "Unique identifier for the device on which the event was captured" }, "eventDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time of the event" }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "eventReferenceCodes": { "type": "array", "items": { "type": "string" } }, "eventUserIdNo": { "type": "integer", "example": 1, "description": "The user id of the user who captured the event" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code of the location where the parcel is currently in" }, "logServProvParcelCode": { "type": "string" }, "logServProvWaybillCode": { "type": "string" }, "logisticsServiceProviderCode": { "type": "string" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "missingParcelIds": { "type": "array", "items": { "type": "integer" } }, "nodeCode": { "type": "string", "example": "P8026", "description": "The code to identify the node" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "nodeName": { "type": "string", "example": "PEP CAPE TOWN PLEIN ST", "description": "The name of the node" }, "nodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node" }, "overrideNotValidStatus": { "type": "boolean" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelEventTypeMessageTemplate": { "type": "string", "description": "Template for user friendly event type message" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" }, "returnReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique id for return reason" }, "scannedBarcodes": { "type": "array", "items": { "$ref": "#/definitions/ScannedBarcode" } }, "supplierName": { "type": "string" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "writeOffReasonDes": { "type": "string" }, "writeOffReasonDesc": { "type": "string", "example": "LOST IN NODE", "description": "The description of the write off reason" }, "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason" } }, "title": "ParcelEventPojo" }, "ParcelEventRequest": { "type": "object", "properties": { "eventDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time of the event" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" } }, "title": "ParcelEventRequest" }, "ParcelEventResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelEventPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelEventResponse" }, "ParcelEventTypeDeleteRequest": { "type": "object", "properties": { "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelEventTypeDeleteRequest" }, "ParcelEventTypeInsertRequest": { "type": "object", "properties": { "customerVisibleInd": { "type": "string", "example": "Y", "description": "Indicator to show if the parcel event type should be shown to customers when they do parcel trackings" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "parcelEventTypeGroupIdNo": { "type": "integer", "format": "int32" }, "parcelEventTypeMessageTemplate": { "type": "string", "description": "Template for user friendly event type message" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelEventTypeInsertRequest" }, "ParcelEventTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ParcelEventTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelEventTypeListResponse" }, "ParcelEventTypePojo": { "type": "object", "properties": { "customerVisibleInd": { "type": "string", "example": "Y", "description": "Indicator to show if the parcel event type should be shown to customers when they do parcel trackings" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "parcelEventTypeGroupIdNo": { "type": "integer", "format": "int32" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelEventTypeMessageTemplate": { "type": "string", "description": "Template for user friendly event type message" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelEventTypePojo" }, "ParcelEventTypeRequest": { "type": "object", "properties": { "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" } }, "title": "ParcelEventTypeRequest" }, "ParcelEventTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelEventTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelEventTypeResponse" }, "ParcelEventTypeUpdateRequest": { "type": "object", "properties": { "customerVisibleInd": { "type": "string", "example": "Y", "description": "Indicator to show if the parcel event type should be shown to customers when they do parcel trackings" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "parcelEventTypeGroupIdNo": { "type": "integer", "format": "int32" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelEventTypeMessageTemplate": { "type": "string", "description": "Template for user friendly event type message" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelEventTypeUpdateRequest" }, "ParcelEventUpdateRequest": { "type": "object", "properties": { "deviceGUID": { "type": "string", "example": "GUID46345645", "description": "Unique identifier for the device on which the event was captured" }, "eventDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date and time of the event" }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "eventUserIdNo": { "type": "integer", "example": 1, "description": "The user id of the user who captured the event" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code of the location where the parcel is currently in" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelIdNo": { "type": "integer", "example": 5784, "description": "Unique identifier for the parcel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason" } }, "title": "ParcelEventUpdateRequest" }, "ParcelFilteredRequest": { "type": "object", "properties": { "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "dropTokenCode": { "type": "string", "example": "T20581851354", "description": "Unique identifier for the Drop Token" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node where the parcel was originally received" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" } }, "title": "ParcelFilteredRequest" }, "ParcelIdRequest": { "type": "object", "properties": { "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "ParcelIdRequest" }, "ParcelIdUserIdRequest": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelIdUserIdRequest" }, "ParcelInsertRequest": { "type": "object", "properties": { "assignmentNo": { "type": "integer", "format": "int32", "example": 12345, "description": "The reference number for the assignment" }, "assignmentSubjectCode": { "type": "string", "example": "DS301", "description": "The code for the course that the assignment is fors" }, "bexCostAmt": { "type": "number", "format": "double", "example": 500, "description": "Cost amount excluding VAT" }, "bexSellAmt": { "type": "number", "format": "double", "example": 550, "description": "Sell amount excluding VAT" }, "bincSellAmt": { "type": "number", "format": "double", "example": 627, "description": "Sell amount including VAT" }, "colCustomerOneProfileGuid": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is collecting the parcel who is not the intended receiver" }, "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "commentDesc": { "type": "string", "example": "THIS A TEST PARCEL", "description": "Any comments a user wishes to add to a parcel" }, "currentNodeLocationIdNo": { "type": "integer", "format": "int32", "example": 20, "description": "Unique identifier for the current node - location combination" }, "customerDropDocumentIdNo": { "type": "integer", "example": 1, "description": "The unique identifier for the Customer Drop image document for the specific parcel in the FICA document repository" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "dropTokenCode": { "type": "string", "description": "The token the customer will have to present when dropping off a return or a counter-to-counter parcel" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "Height of the parcel measured in cm" }, "lastParcelEventDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date and time of the last event that occurred for the parcel" }, "lengthCm": { "type": "number", "format": "double", "example": 20, "description": "The length measured in cm" }, "logServProvCollectionCode": { "type": "string", "example": "JNB1605250444", "description": "The logistics service provider's collection number" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel was originally received" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node where the parcel was originally received" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "podDocumentIdNo": { "type": "integer", "example": 123456, "description": "The unique Id that links the POD photo for that parcel" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the service type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "weightKg": { "type": "number", "format": "double", "example": 50, "description": "Weight of the parcel measured in kg" }, "widthCm": { "type": "number", "format": "double", "example": 30, "description": "The width measured in cm" } }, "title": "ParcelInsertRequest" }, "ParcelListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ParcelPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelListResponse" }, "ParcelNodeLSPRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" } }, "title": "ParcelNodeLSPRequest" }, "ParcelPojo": { "type": "object", "properties": { "accountCode": { "type": "string" }, "allowTrustedCollectionInd": { "type": "string", "example": "Y", "description": "Indicator to show if a trusted collection is allowed" }, "alternateCollectionRequirements": { "$ref": "#/definitions/CustomerCollectionRequirementsPojo" }, "assignmentNo": { "type": "integer", "format": "int32", "example": 12345, "description": "The reference number for the assignment" }, "assignmentSubjectCode": { "type": "string", "example": "DS301", "description": "The code for the course that the assignment is for" }, "bexCostAmt": { "type": "number", "format": "double", "example": 500, "description": "Cost amount excluding VAT" }, "bexSellAmt": { "type": "number", "format": "double", "example": 550, "description": "Sell amount excluding VAT" }, "bincSellAmt": { "type": "number", "format": "double", "example": 627, "description": "Sell amount including VAT" }, "bookingNo": { "type": "integer", "format": "int32", "example": "NODE INACTIVE", "description": "Unique identifier for the booking" }, "colCustomerOneProfileGuid": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is collecting the parcel who is not the intended receiver" }, "collectWindowEndDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00" }, "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "collectionSmsDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date a sms was sent to inform the customer the the parcel is ready for collection" }, "collectionType": { "type": "string", "example": "STANDARD", "description": "The type of collection based on the parcelEventTypeIdNo" }, "collector": { "$ref": "#/definitions/Profile" }, "commentDesc": { "type": "string", "example": "THIS A TEST PARCEL", "description": "Any comments a user wishes to add to a parcel" }, "companyCode": { "type": "string", "example": "ACK", "description": "Three letter code to identify the company" }, "companyIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the company" }, "companyName": { "type": "string", "example": "ACKERMANS", "description": "The name of the company" }, "createdDate": { "type": "string" }, "currentCompanyName": { "type": "string", "example": "PEP", "description": "The name of the company node that the parcel is currently in" }, "currentNodeCode": { "type": "string", "example": "TS011", "description": "The code for the node where the parcel currently is" }, "currentNodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person of the node the parcel is currently in" }, "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "currentNodeLocationIdNo": { "type": "integer", "format": "int32", "example": 20, "description": "Unique identifier for the current node - location combination" }, "currentNodeNodeTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node type where the parcel is currently at" }, "currentNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node the parcel is currently in" }, "currentNodeTelephone": { "type": "string", "example": "021 429 2999", "description": "The telephone number of the node" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationCountryCode": { "type": "string", "example": "ZA", "description": "The country code of the destination node" }, "destinationNoOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the destination node (to determine capacity)" }, "destinationNodeAddress1": { "type": "string", "example": "First Floor", "description": "Address line 1 for the destination node" }, "destinationNodeAddress2": { "type": "string", "example": "Bergzicht Building", "description": "Address line 2 for the destination node" }, "destinationNodeAddress3": { "type": "string", "example": "Tygerberg Office Park", "description": "Address line 3 for the destination node" }, "destinationNodeAddress4": { "type": "string", "example": "163 Uys Krige Drive", "description": "Address line 4 for the destination node" }, "destinationNodeAddress5": { "type": "string", "example": "Western Cape", "description": "Address line 5 for the destination node" }, "destinationNodeAddress6": { "type": "string", "example": "South Africa", "description": "Address line 6 for the destination node" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeCompanyCode": { "type": "string" }, "destinationNodeCompanyIdNo": { "type": "integer", "format": "int32" }, "destinationNodeCompanyName": { "type": "string" }, "destinationNodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node where the parcel was destined to be delivered" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "destinationNodeName": { "type": "string", "example": "PEP 658", "description": "The name of the destination node for the parcel" }, "destinationNodeNodeTypeDesc": { "type": "string", "example": "STORE", "description": "The description of the node type where the parcel was destined to be delivered" }, "destinationNodeNodeTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node type where the parcel was destined to be delivered" }, "destinationNodePostalCode": { "type": "string", "example": 8000, "description": "The postal code of the destination node" }, "destinationNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node destination" }, "destinationNodeTelephone": { "type": "string", "example": "021 429 2981", "description": "Telephone number for the destination node" }, "destinationTradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the destination node" }, "dropTokenCode": { "type": "string", "example": "T20581851354", "description": "Unique identifier for the Drop Token" }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "finalReminderSmsDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date a final reminder sms was sent to inform the customer the the parcel is still waiting for collection this is sent after the reminder sms was sent and parcel was still not collected" }, "forcedReturnInd": { "type": "string", "example": "N", "description": "The indictor which is set once a forced return must be done for that parcel" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "Height of the parcel measured in cm" }, "inductionDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the parcel was inducted" }, "intoNodeDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the parcel was received at the current node" }, "isRcvCustomerIsSupplier": { "type": "boolean" }, "isSendCustomerIsSupplier": { "type": "boolean" }, "lastInscanDatetime": { "type": "string", "description": "The date the collection sms was sent to the customer" }, "lastParcelEventDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date and time of the last event that occurred for the parcel" }, "lastParcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the last event that occurred for the parcel" }, "lastParcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the last event that occurred for the parcel" }, "lengthCm": { "type": "number", "format": "double", "example": 20, "description": "The length measured in cm" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code of the location where the parcel is currently in" }, "locationTypeDesc": { "type": "string", "example": "LOGISTICS SERVICE PROVIDER LOCATION", "description": "The description of the type of the location at the specific node" }, "logServProvCollectionCode": { "type": "string", "example": "JNB1605250444", "description": "The logistics service provider's collection number" }, "logServProvDelManifestCode": { "type": "string", "example": "JNB1605250444", "description": "The logistic service provider delivert manifest code" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "The unique identifier for the node" }, "normalCollectionRequirements": { "$ref": "#/definitions/CustomerCollectionRequirementsPojo" }, "originCountryCode": { "type": "string", "example": "ZA", "description": "The country code of the origin node" }, "originNoOfMaxBoxes": { "type": "integer", "format": "int32", "example": 15, "description": "The maximum number of shoe boxes that could fit in the origin node (to determine capacity)" }, "originNodeAddress1": { "type": "string", "example": "First Floor", "description": "Address line 1 for the origin node" }, "originNodeAddress2": { "type": "string", "example": "Plattekloof House Building", "description": "Address line 2 for the origin node" }, "originNodeAddress3": { "type": "string", "example": "Tygerberg Office Park", "description": "Address line 3 for the origin node" }, "originNodeAddress4": { "type": "string", "example": "Address line 4 for the origin node", "description": "163 Uys Krige Drive" }, "originNodeAddress5": { "type": "string", "example": "Western Cape", "description": "Address line 5 for the origin node" }, "originNodeAddress6": { "type": "string", "example": "South Africa", "description": "Address line 6 for the origin node" }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel was originally received" }, "originNodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node where the parcel was originally received" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node where the parcel was originally received" }, "originNodeName": { "type": "string", "example": "PEP 771", "description": "The name of the node where the parcel was originally received" }, "originNodeNodeTypeDesc": { "type": "string", "example": "STORE", "description": "The description of the origin node type" }, "originNodeNodeTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node type where the parcel was originally received" }, "originNodePostalCode": { "type": "string", "example": 7945, "description": "The postal code of the origin node" }, "originNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The node short name for the node where the parcel was originally received" }, "originNodeTelephone": { "type": "string", "example": "021 429 2999", "description": "Telephone number for the origin node" }, "originTradingHoursJson": { "type": "string", "description": "JSON object containing the trading hours of the origin node" }, "overrideNotValidStatus": { "type": "boolean" }, "parcelAge": { "type": "integer", "format": "int64", "example": 3, "description": "The total age of the parcel" }, "parcelBookingNo": { "type": "integer", "format": "int32" }, "parcelDaysInNode": { "type": "integer", "format": "int64", "example": 2, "description": "The number of days the parcel has been at the current node" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "pepBranchNumber": { "type": "string", "description": "The PEP Branch number of the selected node, this will be the nodeCode without the 'P'" }, "podDocumentIdNo": { "type": "integer", "example": 123456, "description": "The unique Id that links the POD photo for that parcel" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeDesc": { "type": "string", "example": "PARCEL", "description": "Unique identifier for the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "rcvCustomerSupplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier, if the receiving customer is a supplier" }, "receiver": { "type": "string", "example": "Jon Doe", "description": "This is the name and surname of the person that will receive the parcel" }, "reminderSmsDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date a reminder sms was sent to inform the customer the the parcel is still waiting for collection this is sent after the collection sms was sent and parcel was still not collected" }, "secureLocationInd": { "type": "string", "example": "N", "description": "Indicator to show if the location the parcel is currently in is secure" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "sendCustomerSupplierName": { "type": "string", "description": "The name of the supplier, if the sending customer is a supplier" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the service type" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "weightKg": { "type": "number", "format": "double", "example": 50, "description": "Weight of the parcel measured in kg" }, "widthCm": { "type": "number", "format": "double", "example": 30, "description": "The width measured in cm" } }, "title": "ParcelPojo" }, "ParcelPreInductionInsertRequest": { "type": "object", "required": [ "customerRefCode", "userIdNo" ], "properties": { "customer": { "description": "The customer details to create a oneProfile record", "$ref": "#/definitions/OneProfileCustomerPojo" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "dropTokenCode": { "type": "string", "description": "The token the customer will have to present when dropping off a return or a counter-to-counter parcel" }, "otherDataRequiredValue": { "type": "string", "example": 123456, "description": "This will be a process specific other requirement that will be used to populate the field of `otherDataRequiredDesc`" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer receiving the parcel" }, "rcvFirstName": { "type": "string", "example": "Jon", "description": "This is the name of the person that will receive the parcel" }, "rcvLastName": { "type": "string", "example": "Doe", "description": "This is the surname of the person that will receive the parcel" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelPreInductionInsertRequest" }, "ParcelRequest": { "type": "object", "properties": { "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "excludeParcelStatuses": { "type": "string", "example": "CANCELLED, CLOSED", "description": "The parcelStatus that is to be excluded from the results" }, "fieldNames": { "type": "array", "items": { "type": "string" } }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierOrderNumber": { "type": "string" } }, "title": "ParcelRequest" }, "ParcelResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelResponse" }, "ParcelReturnRequest": { "type": "object", "required": [ "customerRefCode", "userIdNo" ], "properties": { "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record." } }, "title": "ParcelReturnRequest" }, "ParcelSmsPojo": { "type": "object", "properties": { "colCustomerOneProfileGuid": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is collecting the parcel who is not the intended receiver" }, "collectionDate": { "type": "string", "example": 5, "description": "The date the parcel was collected" }, "collectionDays": { "type": "integer", "format": "int32", "example": 5, "description": "The amount of days it will take for the courier to come and collect " }, "collectionEndDate": { "type": "string", "example": 5, "description": "The last date the parcel can be collected" }, "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "createDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the collection sms was sent to the customer." }, "customerCellphone": { "type": "string", "example": "0823365248", "description": "The cellphone number of the person receiving the sms" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeCountryCode": { "type": "string", "example": "ZA", "description": "The ISO ALPHA-2 Code of the destination Node Country Code" }, "destinationNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node destination" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "oneProfileGUID": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is " }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel was originally received" }, "originNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The node short name for the node where the parcel was originally received" }, "parcelFeeAmt": { "type": "number", "format": "double", "example": 100, "description": "The fee amount for the parcel" }, "productTypeDesc": { "type": "string", "example": "PARCEL", "description": "Unique identifier for the product type" }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "remainingDays": { "type": "integer", "format": "int32", "example": 5, "description": "The amount of days the customer still has to come and collect his/her parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "ParcelSmsPojo" }, "ParcelSmsRequest": { "type": "object", "properties": { "dropTokenCode": { "type": "string", "example": "T151200024017", "description": "The token the customer will have to present when dropping off a return or a counter-to-counter parcel" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "ParcelSmsRequest" }, "ParcelSmsResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelSmsPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelSmsResponse" }, "ParcelStatusDeleteRequest": { "type": "object", "properties": { "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelStatusDeleteRequest" }, "ParcelStatusInsertRequest": { "type": "object", "properties": { "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelStatusInsertRequest" }, "ParcelStatusListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ParcelStatusPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelStatusListResponse" }, "ParcelStatusPojo": { "type": "object", "properties": { "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "userIdNo": { "type": "integer" } }, "title": "ParcelStatusPojo" }, "ParcelStatusRequest": { "type": "object", "properties": { "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" } }, "title": "ParcelStatusRequest" }, "ParcelStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelStatusResponse" }, "ParcelStatusUpdateRequest": { "type": "object", "properties": { "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelStatusUpdateRequest" }, "ParcelTerminationTypeInsertRequest": { "type": "object", "properties": { "parcelTerminationTypeDesc": { "type": "string" }, "parcelTerminationTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelTerminationTypeInsertRequest" }, "ParcelTerminationTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ParcelTerminationTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelTerminationTypeListResponse" }, "ParcelTerminationTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "parcelTerminationTypeDesc": { "type": "string" }, "parcelTerminationTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "ParcelTerminationTypeModel" }, "ParcelTerminationTypePojo": { "type": "object", "properties": { "parcelTerminationTypeDesc": { "type": "string" }, "parcelTerminationTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelTerminationTypePojo" }, "ParcelUpdateRequest": { "type": "object", "required": [ "userIdNo" ], "properties": { "assignmentNo": { "type": "integer", "format": "int32", "example": 12345, "description": "The reference number for the assignment" }, "assignmentSubjectCode": { "type": "string", "example": "DS301", "description": "The code for the course that the assignment is fors" }, "bexCostAmt": { "type": "number", "format": "double", "example": 500, "description": "The cost amount of the parcel, excluding VAT" }, "bexSellAmt": { "type": "number", "format": "double", "example": 550, "description": "The sell amount of the parcel, excluding VAT" }, "bincSellAmt": { "type": "number", "format": "double", "example": 627, "description": "The sell amount of the parcel, including VAT" }, "bookingNo": { "type": "integer", "format": "int32", "example": "NODE INACTIVE", "description": "Unique identifier for the booking" }, "colCustomerOneProfileGuid": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is collecting the parcel who is not the intended receiver" }, "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "collectionSmsDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date a sms was sent to inform the customer the the parcel is ready for collection" }, "commentDesc": { "type": "string", "example": "THIS A TEST PARCEL", "description": "Any comments a user wishes to add to a parcel" }, "currentNodeLocationIdNo": { "type": "integer", "format": "int32", "example": 20, "description": "Unique identifier for the current node - location combination" }, "customerDropDocumentIdNo": { "type": "integer", "example": 1, "description": "The unique identifier for the Customer Drop image document for the specific parcel in the FICA document repository" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. " }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The new destination node that the courier will deliver the parcel to." }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "dropTokenCode": { "type": "string", "description": "The token the customer will have to present when dropping off a return or a counter-to-counter parcel" }, "finalReminderSmsDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date a final reminder sms was sent to inform the customer the the parcel is still waiting for collection this is sent after the reminder sms was sent and parcel was still not collected" }, "forcedReturnInd": { "type": "string", "example": "N", "description": "The indictor which is set once a forced return must be done for that parcel" }, "heightCm": { "type": "number", "format": "double", "example": 30, "description": "The height of the parcel, measured in cm." }, "lastInscanDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date the Parcel was last scanned in." }, "lengthCm": { "type": "number", "format": "double", "example": 20, "description": "The length of the parcel, measured in cm." }, "logServProvCollectionCode": { "type": "string", "example": "JNB1605250444", "description": "The logistics service provider's collection number" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210042374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "CND160210042374", "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider, if it is a logistics service provider location at the specific node" }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel was originally received" }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node where the parcel was originally received" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "podDocumentIdNo": { "type": "integer", "example": 123456, "description": "The unique Id that links the POD photo for that parcel" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product. Please call /getProductBySupplier to get a complete list of products, with their ID's." }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The new cellphone number to be used to contact the receiving customer." }, "rcvCustomerOneProfileGUID": { "type": "string", "example": "GUID876345", "description": "Unique identifier in OneProfile for the customer receiving the parcel" }, "reminderSmsDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date a reminder sms was sent to inform the customer the the parcel is still waiting for collection this is sent after the collection sms was sent and parcel was still not collected" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the service type" }, "supplierCode": { "type": "string", "example": 1, "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier." }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record. *** The userIdNo to use will be supplied once integration development starts ***" }, "weightKg": { "type": "number", "format": "double", "example": 50, "description": "The weight of the parcel, measured in kg." }, "widthCm": { "type": "number", "format": "double", "example": 30, "description": "The width of the parcel, measured in cm." } }, "title": "ParcelUpdateRequest" }, "ParcelUpdateStatusPojo": { "type": "object", "properties": { "customerRefCode": { "type": "array", "description": "The reference number for the customer for this parcel", "items": { "type": "string" } }, "totalUpdateCount": { "type": "integer", "format": "int32", "description": "This is the amount of parcels that was successfully processed" }, "unsuccessfulUpdateCount": { "type": "integer", "format": "int32", "description": "This is the amount of parcels that was successfully processed" } }, "title": "ParcelUpdateStatusPojo" }, "ParcelUpdateStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ParcelUpdateStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ParcelUpdateStatusResponse" }, "ParcelsDeliveredByCourierRequest": { "type": "object", "properties": { "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The name of the user performing the process." } }, "title": "ParcelsDeliveredByCourierRequest" }, "ParcelsStatusNodeBookingRequest": { "type": "object", "properties": { "logServProvDelManifestCode": { "type": "string", "example": "JNB1605250444", "description": "The logistic service provider delivert manifest code" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 5, "description": "Unique identifier for the parcel's current status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ParcelsStatusNodeBookingRequest" }, "PaymentTermsTypeDeleteRequest": { "type": "object", "properties": { "paymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "paymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Payment Terms Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "PaymentTermsTypeDeleteRequest" }, "PaymentTermsTypeInsertRequest": { "type": "object", "properties": { "paymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "PaymentTermsTypeInsertRequest" }, "PaymentTermsTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/PaymentTermsTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "PaymentTermsTypeListResponse" }, "PaymentTermsTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "paymentTermsTypeDesc": { "type": "string" }, "paymentTermsTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "PaymentTermsTypeModel" }, "PaymentTermsTypePojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date the record was discontinued" }, "paymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "paymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Payment Terms Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "PaymentTermsTypePojo" }, "PaymentTermsTypeRequest": { "type": "object", "properties": { "paymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "paymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Payment Terms Type" } }, "title": "PaymentTermsTypeRequest" }, "PaymentTermsTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/PaymentTermsTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "PaymentTermsTypeResponse" }, "PaymentTermsTypeUpdateRequest": { "type": "object", "properties": { "paymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "paymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Payment Terms Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "PaymentTermsTypeUpdateRequest" }, "PmmResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "PmmResponse" }, "ProcessRequirementPojo": { "type": "object", "required": [ "isCustomerDeclarationRequired", "isDestNodeRequired", "isDropTokenRequired", "isOtherDataRequired", "isReceiverCellPhoneRequired", "isSenderCellPhoneRequired", "isSenderDetailsRequired" ], "properties": { "isCustomerDeclarationRequired": { "type": "boolean" }, "isDestNodeRequired": { "type": "boolean" }, "isDropTokenRequired": { "type": "boolean" }, "isOtherDataRequired": { "type": "boolean" }, "isReceiverCellPhoneRequired": { "type": "boolean" }, "isSenderCellPhoneRequired": { "type": "boolean" }, "isSenderDetailsRequired": { "type": "boolean" }, "parcelDetails": { "$ref": "#/definitions/CustomerDropParcelDetailsPojo" } }, "title": "ProcessRequirementPojo" }, "ProductBySupplierRequest": { "type": "object", "properties": { "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "ProductBySupplierRequest" }, "ProductCollectionFlowModel": { "type": "object", "properties": { "allowAlternativeCustomerCollectionInd": { "type": "string" }, "collectionFlowType": { "$ref": "#/definitions/CollectionFlowTypeModel" }, "idRequiredForCollectInd": { "type": "string" }, "kycRequiredInd": { "type": "string" }, "productCollectionFlowPK": { "$ref": "#/definitions/ProductCollectionFlowPK" }, "signatureRequirementType": { "$ref": "#/definitions/SignatureRequirementTypeModel" }, "signatureRequirementTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "ProductCollectionFlowModel" }, "ProductCollectionFlowPK": { "type": "object", "properties": { "collectionFlowType": { "$ref": "#/definitions/CollectionFlowTypeModel" }, "product": { "$ref": "#/definitions/ProductModel" } }, "title": "ProductCollectionFlowPK" }, "ProductDeleteRequest": { "type": "object", "properties": { "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductDeleteRequest" }, "ProductInsertRequest": { "type": "object", "required": [ "altKycRequiredInd", "isCustomerDeclarationRequired", "isDestNodeRequired", "isOtherDataRequired", "isReceiverCellPhoneRequired", "isSenderCellPhoneRequired", "isSenderDetailsRequired", "kycRequiredInd" ], "properties": { "allowAlternativeCollectionInd": { "type": "string", "example": "N", "description": "Indicator to show whether this product may be collected by an alternative customer" }, "altAllowAlternativeCollectionInd": { "type": "string" }, "altIdRequiredForCollectInd": { "type": "string" }, "altKycRequiredInd": { "type": "string", "example": "Y", "description": "Indicator to show whether 'know your customer' is required for customer collections of this product with the alternate collection flow" }, "altSignatureRequirmentTypeIdNo": { "type": "integer", "format": "int32" }, "availableForCustReturnInd": { "type": "string", "example": "N", "description": "Indicates whether the product is available to be used for customer return parcels" }, "collectionPinRequiredInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide a pin for the parcel collection" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "idRequiredForCollectInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide their ID for the parcel collection" }, "isCustomerDeclarationRequired": { "type": "string", "example": "Y", "description": "Indicates whether a customer declaration is required for customer drops done for this product" }, "isDestNodeRequired": { "type": "string", "example": "Y", "description": "Indicates whether a destination node is required for customer drops done for this product" }, "isOtherDataRequired": { "type": "string", "example": "Y", "description": "Indicates whether other data is required for customer drops done for this product" }, "isReceiverCellPhoneRequired": { "type": "string", "example": "Y", "description": "Indicates whether a receiver cellphone number is required for customer drops done for this product" }, "isSenderCellPhoneRequired": { "type": "string", "example": "Y", "description": "Indicates whether a sender cellphone number is required for customer drops done for this product" }, "isSenderDetailsRequired": { "type": "string", "example": "Y", "description": "Indicates whether the details of the sender (ID, name, surname) is required for customer drops done for this product" }, "kycRequiredInd": { "type": "string", "example": "Y", "description": "Indicator to show whether 'know your customer' is required for customer collections of this product with the specific collection flow" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for logistics service provider" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Set" }, "noOfSmsRetryDays": { "type": "integer", "format": "int32", "example": 3, "description": "The number of days that a parcel has been in store when a reminder sms must be sent to the customer to collect the parcel" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "otherDataDesc": { "type": "string" }, "parcelFeeAmt": { "type": "number", "format": "double", "example": 100, "description": "The fee amount for the parcel" }, "parcelTerminationTypeIdNo": { "type": "integer", "format": "int32" }, "productDesc": { "type": "string", "example": "PAXI C2C SMALL BAG (TOKEN)", "description": "User-defined description for the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "secureLocationRequiredInd": { "type": "string", "example": "N", "description": "Indicator to show whether it is required for this product to be kept in a secure location" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a service type" }, "signatureRequirmentTypeIdNo": { "type": "integer", "format": "int32" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductInsertRequest" }, "ProductListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ProductPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ProductListResponse" }, "ProductModel": { "type": "object", "properties": { "availableForCustReturnInd": { "type": "string" }, "collectionPinRequiredInd": { "type": "string" }, "customerDeclarationRequiredInd": { "type": "string" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32" }, "destinationNodeRequiredInd": { "type": "string" }, "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "logisticsServiceProvider": { "$ref": "#/definitions/LogisticsServiceProviderModel" }, "messageSet": { "$ref": "#/definitions/MessageSetModel" }, "noOfSmsRetryDays": { "type": "integer", "format": "int32" }, "nodeGroup": { "$ref": "#/definitions/NodeGroupModel" }, "otherDataRequiredDesc": { "type": "string" }, "otherDataRequiredInd": { "type": "string" }, "parcelFeeAmt": { "type": "number", "format": "double" }, "parcelTerminationType": { "$ref": "#/definitions/ParcelTerminationTypeModel" }, "productCollectionFlows": { "type": "array", "items": { "$ref": "#/definitions/ProductCollectionFlowModel" } }, "productDesc": { "type": "string" }, "productIdNo": { "type": "integer", "format": "int32" }, "productType": { "$ref": "#/definitions/ProductTypeModel" }, "receiverCellphoneRequiredInd": { "type": "string" }, "secureLocationRequiredInd": { "type": "string" }, "senderCellphoneRequiredInd": { "type": "string" }, "senderDetailsRequiredInd": { "type": "string" }, "serviceType": { "$ref": "#/definitions/ServiceTypeModel" }, "skuNumber": { "type": "integer", "format": "int32" }, "supplier": { "$ref": "#/definitions/SupplierModel" }, "userIdNo": { "type": "integer" } }, "title": "ProductModel" }, "ProductPojo": { "type": "object", "required": [ "altKycRequiredInd", "isCustomerDeclarationRequired", "isDestNodeRequired", "isDropTokenRequired", "isOtherDataRequired", "isReceiverCellPhoneRequired", "isSenderCellPhoneRequired", "isSenderDetailsRequired", "kycRequiredInd" ], "properties": { "allowAlternativeCollectionInd": { "type": "string", "example": "N", "description": "Indicator to show whether this product may be collected by an alternative customer" }, "altAllowAlternativeCollectionInd": { "type": "string" }, "altIdRequiredForCollectInd": { "type": "string" }, "altKycRequiredInd": { "type": "string", "example": "Y", "description": "Indicator to show whether 'know your customer' is required for customer collections of this product with the alternate collection flow" }, "altSignatureRequirementTypeDesc": { "type": "string" }, "altSignatureRequirmentTypeIdNo": { "type": "integer", "format": "int32" }, "availableForCustReturnInd": { "type": "string", "example": "N", "description": "Indicates whether the product is available to be used for customer return parcels" }, "collectionPinRequiredInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide a pin for the parcel collection" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "idRequiredForCollectInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide their ID for the parcel collection" }, "isCustomerDeclarationRequired": { "type": "string" }, "isDestNodeRequired": { "type": "string" }, "isDropTokenRequired": { "type": "string" }, "isOtherDataRequired": { "type": "string" }, "isReceiverCellPhoneRequired": { "type": "string" }, "isSenderCellPhoneRequired": { "type": "string" }, "isSenderDetailsRequired": { "type": "string" }, "kycRequiredInd": { "type": "string", "example": "Y", "description": "Indicator to show whether 'know your customer' is required for customer collections of this product with the specific collection flow" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique Identifier for the message Set" }, "noOfSmsRetryDays": { "type": "integer", "format": "int32", "example": 3, "description": "The number of days that a parcel has been in store when a reminder sms must be sent to the customer to collect the parcel" }, "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL", "description": "The description of the node group" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "otherDataDesc": { "type": "string" }, "parcelFeeAmt": { "type": "number", "format": "double", "example": 100, "description": "The fee amount for the parcel" }, "parcelTerminationTypeDesc": { "type": "string" }, "parcelTerminationTypeIdNo": { "type": "integer", "format": "int32" }, "productDesc": { "type": "string", "example": "PAXI C2C SMALL BAG (TOKEN)", "description": "User-defined description for the product" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "secureLocationRequiredInd": { "type": "string", "example": "N", "description": "Indicator to show whether it is required for this product to be kept in a secure location" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a service type" }, "signatureRequirementTypeDesc": { "type": "string", "example": "TEST SIGNATURE", "description": "The description of the type of signature required for the person receiving the parcel" }, "signatureRequirmentTypeIdNo": { "type": "integer", "format": "int32" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductPojo" }, "ProductResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ProductPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ProductResponse" }, "ProductSupplierPojo": { "type": "object", "properties": { "allowAlternativeCollectionInd": { "type": "string", "example": "N", "description": "Indicator to show whether this product may be collected by an alternative customer" }, "logisticsServiceProviderCode": { "type": "string", "example": "SKY", "description": "The three character code used to identify the logistics service provider" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "nodeGroupDesc": { "type": "string", "example": "PEP EXCL CELL" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeDesc": { "type": "string", "example": "UNISA ASSIGNMENTS", "description": "The description of the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "secureLocationRequiredInd": { "type": "string", "example": "N", "description": "Indicator to show whether it is required for this product to be kept in a secure location" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" } }, "title": "ProductSupplierPojo" }, "ProductTypeDeleteRequest": { "type": "object", "properties": { "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeDeleteRequest" }, "ProductTypeDropLabelPrefixPojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time", "example": 1, "description": "The user id of the user that last updated the record" }, "dropLablePrefix": { "type": "string", "example": "D1", "description": "Allowable drop lable prefix" }, "lastUpdateDatetime": { "type": "string", "format": "date-time", "example": 1, "description": "The user id of the user that last updated the record" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeDropLabelPrefixPojo" }, "ProductTypeDropLablePrefixDeleteRequest": { "type": "object", "properties": { "dropLablePrefix": { "type": "string", "example": "D1", "description": "Allowable drop lable prefix" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeDropLablePrefixDeleteRequest" }, "ProductTypeDropLablePrefixInsertRequest": { "type": "object", "properties": { "dropLablePrefix": { "type": "string", "example": "D1", "description": "Allowable drop lable prefix" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeDropLablePrefixInsertRequest" }, "ProductTypeDropLablePrefixListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ProductTypeDropLabelPrefixPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ProductTypeDropLablePrefixListResponse" }, "ProductTypeDropLablePrefixSearchRequest": { "type": "object", "properties": { "dropLablePrefix": { "type": "string", "example": "D1", "description": "Allowable drop lable prefix" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeDropLablePrefixSearchRequest" }, "ProductTypeInsertRequest": { "type": "object", "properties": { "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeInsertRequest" }, "ProductTypeLSPServiceTypePojo": { "type": "object", "required": [ "effectiveStartDatetime", "lastUpdateDatetime", "logisticsServiceProviderIdNo", "lspServiceTypeIdNo", "productTypeIdNo", "serviceFeeAmt", "userIdNo" ], "properties": { "effectiveEndDatetime": { "type": "string", "example": "23-01-2018 12:00:00.000", "description": "The date that the record was ended" }, "effectiveStartDatetime": { "type": "string", "example": "23-01-2018 12:00:00.000", "description": "The date that the record was created" }, "lastUpdateDatetime": { "type": "string", "example": "23-01-2018 12:00:00.000", "description": "The date that the record was last updated" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "lspServiceTypeDesc": { "type": "string", "example": "BUDGET", "description": "The Name of the Logistics Service Provider Service Type" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type" }, "serviceFeeAmt": { "type": "number", "format": "double", "example": 53.9, "description": "The fee that is charged for the service" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeLSPServiceTypePojo" }, "ProductTypeLSPServiceTypeSearchRequest": { "type": "object", "properties": { "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type" } }, "title": "ProductTypeLSPServiceTypeSearchRequest" }, "ProductTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ProductTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ProductTypeListResponse" }, "ProductTypeLspServiceTypeDeleteRequest": { "type": "object", "required": [ "effectiveStartDatetime", "lspServiceTypeIdNo", "productTypeIdNo", "userIdNo" ], "properties": { "effectiveEndDatetime": { "type": "string", "description": "The date that the record was ended" }, "effectiveStartDatetime": { "type": "string", "description": "The date that the record was created" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeLspServiceTypeDeleteRequest" }, "ProductTypeLspServiceTypeInsertRequest": { "type": "object", "required": [ "effectiveEndDatetime", "effectiveStartDatetime", "logisticsServiceProviderIdNo", "lspServiceTypeIdNo", "productTypeIdNo", "serviceFeeAmt", "userIdNo" ], "properties": { "effectiveEndDatetime": { "type": "string", "example": "2018-01-24 11:26:22.0", "description": "The date that the record was ended" }, "effectiveStartDatetime": { "type": "string", "example": "2018-01-24 11:26:22.0", "description": "The date that the record was created" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type" }, "serviceFeeAmt": { "type": "number", "format": "double", "example": 53.9, "description": "The fee that is charged for the service" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeLspServiceTypeInsertRequest" }, "ProductTypeLspServiceTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ProductTypeLSPServiceTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ProductTypeLspServiceTypeListResponse" }, "ProductTypeLspServiceTypeUpdateRequest": { "type": "object", "required": [ "effectiveStartDatetime", "logisticsServiceProviderIdNo", "lspServiceTypeIdNo", "productTypeIdNo", "serviceFeeAmt", "userIdNo" ], "properties": { "effectiveEndDatetime": { "type": "string", "example": "2018-01-24 11:26:22.0", "description": "The date that the record was ended" }, "effectiveStartDatetime": { "type": "string", "example": "2018-01-24 11:26:22.0", "description": "The date that the record was created" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "lspServiceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Logistics Service Provider Service Type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the Product Type" }, "serviceFeeAmt": { "type": "number", "format": "double", "example": 53.9, "description": "The fee that is charged for the service" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeLspServiceTypeUpdateRequest" }, "ProductTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "productTypeDesc": { "type": "string" }, "productTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "ProductTypeModel" }, "ProductTypePojo": { "type": "object", "properties": { "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypePojo" }, "ProductTypeRequest": { "type": "object", "properties": { "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" } }, "title": "ProductTypeRequest" }, "ProductTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ProductTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ProductTypeResponse" }, "ProductTypeUpdateRequest": { "type": "object", "properties": { "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the product type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductTypeUpdateRequest" }, "ProductTypesRequest": { "type": "object", "properties": { "productTypeIdNo": { "type": "array", "description": "Unique identifier for the product types", "items": { "type": "integer", "format": "int32" } } }, "title": "ProductTypesRequest" }, "ProductUpdateRequest": { "type": "object", "required": [ "altKycRequiredInd", "kycRequiredInd" ], "properties": { "allowAlternativeCollectionInd": { "type": "string", "example": "N", "description": "Indicator to show whether this product may be collected by an alternative customer" }, "altAllowAlternativeCollectionInd": { "type": "string" }, "altIdRequiredForCollectInd": { "type": "string" }, "altKycRequiredInd": { "type": "string", "example": "Y", "description": "Indicator to show whether 'know your customer' is required for customer collections of this product with the alternate collection flow" }, "altSignatureRequirmentTypeIdNo": { "type": "integer", "format": "int32" }, "availableForCustReturnInd": { "type": "string", "example": "N", "description": "Indicates whether the product is available to be used for customer return parcels" }, "collectionPinRequiredInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide a pin for the parcel collection" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "idRequiredForCollectInd": { "type": "string", "example": "N", "description": "Indicator to say whether the person receiving the parcel is required to provide thier ID for the parcel collection" }, "isCustomerDeclarationRequired": { "type": "string", "example": "Y", "description": "Indicates whether a customer declaration is required for customer drops done for this product" }, "isDestNodeRequired": { "type": "string", "example": "Y", "description": "Indicates whether a destination node is required for customer drops done for this product" }, "isOtherDataRequired": { "type": "string", "example": "Y", "description": "Indicates whether other data is required for customer drops done for this product" }, "isReceiverCellPhoneRequired": { "type": "string", "example": "Y", "description": "Indicates whether a receiver cellphone number is required for customer drops done for this product" }, "isSenderCellPhoneRequired": { "type": "string", "example": "Y", "description": "Indicates whether a sender cellphone number is required for customer drops done for this product" }, "isSenderDetailsRequired": { "type": "string", "example": "Y", "description": "Indicates whether the details of the sender (ID, name, surname) is required for customer drops done for this product" }, "kycRequiredInd": { "type": "string", "example": "Y", "description": "Indicator to show whether 'know your customer' is required for customer collections of this product with the standard collection flow" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for logistics service provider" }, "messageSetIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a Message Set" }, "noOfSmsRetryDays": { "type": "integer", "format": "int32", "example": 3, "description": "The number of days that a parcel has been in store when a reminder sms must be sent to the customer to collect the parcel" }, "nodeGroupIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the node group" }, "otherDataDesc": { "type": "string" }, "parcelFeeAmt": { "type": "number", "format": "double", "example": 100, "description": "The fee amount for the parcel" }, "parcelTerminationTypeIdNo": { "type": "integer", "format": "int32" }, "productDesc": { "type": "string", "example": "PAXI C2C SMALL BAG (TOKEN)", "description": "User-defined description for the product" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeIdNo": { "type": "integer", "format": "int32", "example": 3, "description": "Unique identifier for the product type" }, "secureLocationRequiredInd": { "type": "string", "example": "N", "description": "Indicator to show whether it is required for this product to be kept in a secure location" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Auto increment number used to uniquely identify a service type" }, "signatureRequirmentTypeIdNo": { "type": "integer", "format": "int32" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ProductUpdateRequest" }, "Profile": { "type": "object", "properties": { "contactNumber": { "type": "string" }, "firstName": { "type": "string" }, "idCountry": { "type": "string" }, "idNumber": { "type": "string" }, "lastName": { "type": "string" }, "passportCountry": { "type": "string" }, "passportNumber": { "type": "string" } }, "title": "Profile" }, "PurchaseOrderInsertRequest": { "type": "object", "required": [ "orderCode", "supplierCode", "userIdNo" ], "properties": { "orderCode": { "type": "string", "example": "A454", "description": "The order number (which could contain characters) supplied by the supplier" }, "supplierCode": { "type": "string", "example": "PAX001", "description": "Code to uniquely identify the supplier" }, "totalOrderQty": { "type": "integer", "format": "int32", "example": "PAX001", "description": "The total number of parcels linked to the specific supplier order" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "PurchaseOrderInsertRequest" }, "PurchaseOrderListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/PurchaseOrderPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "PurchaseOrderListResponse" }, "PurchaseOrderPojo": { "type": "object", "required": [ "orderCode", "orderIdNo", "supplierCode" ], "properties": { "lastUpdateDatetime": { "type": "string", "example": "2017-01-01T11:26:22.0+02:00", "description": "The date and time when the record was last updated" }, "orderCode": { "type": "string", "example": "A454", "description": "The order number (which could contain characters) supplied by the supplier" }, "orderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "A unique identifier to identify a specific order by a specific supplier" }, "supplierCode": { "type": "string", "example": "PAX001", "description": "Code to uniquely identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "supplierShortName": { "type": "string", "description": "A short name for the supplier, to be used in sms messages" }, "totalOrderQty": { "type": "integer", "format": "int32", "example": "PAX001", "description": "The total number of parcels linked to the specific supplier order" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "PurchaseOrderPojo" }, "PurchaseOrderRequest": { "type": "object", "properties": { "orderCode": { "type": "string", "example": "A454", "description": "The order number (which could contain characters) supplied by the supplier" }, "supplierCode": { "type": "string", "example": "PAX001", "description": "Code to uniquely identify the supplier" } }, "title": "PurchaseOrderRequest" }, "PurchaseOrderSearchRequest": { "type": "object", "required": [ "orderIdNo" ], "properties": { "orderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "A unique identifier to identify a specific order by a specific supplier" } }, "title": "PurchaseOrderSearchRequest" }, "PurchaseOrderUpdateRequest": { "type": "object", "required": [ "orderCode", "orderIdNo", "supplierCode" ], "properties": { "orderCode": { "type": "string", "example": "A454", "description": "The order number (which could contain characters) supplied by the supplier" }, "orderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "A unique identifier to identify a specific order by a specific supplier" }, "supplierCode": { "type": "string", "example": "PAX001", "description": "Code to uniquely identify the supplier" }, "totalOrderQty": { "type": "integer", "format": "int32", "example": "PAX001", "description": "The total number of parcels linked to the specific supplier order" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user that will be performing the update" } }, "title": "PurchaseOrderUpdateRequest" }, "QueuedParcelsListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/QueuedParcelsPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "QueuedParcelsListResponse" }, "QueuedParcelsPojo": { "type": "object", "properties": { "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcels": { "type": "array", "items": { "$ref": "#/definitions/TrnParcelPojo" } }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "requestTypeDesc": { "type": "string", "example": "SUPPLIER DROP, COUNTER TO COUNTER NCR", "description": "This is a discription of the type of service" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The sender's mobile number" }, "setRcvCustomerCellPhone": { "type": "string" }, "thirdPartyInterfaceLogServProvName": { "type": "string", "example": "SKYNET", "description": "The name for the logistics service provider of the third party interface" }, "thirdPartyInterfaceName": { "type": "string", "example": "CounterCollection", "description": "The name for the third party interface" }, "thirdPartyInterfaceSupplierName": { "type": "string", "example": "ACK001", "description": "The name for the supplier of the third party interface" }, "thirdPartyTrnCode": { "type": "string", "example": "CN1", "description": "The third party transaction code" }, "trnTypeDesc": { "type": "string", "example": "COLLECTION REQUEST", "description": "Transaction type description for the parcel" } }, "title": "QueuedParcelsPojo" }, "ReturnReasonDeleteRequest": { "type": "object", "properties": { "returnReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique id for return reson" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ReturnReasonDeleteRequest" }, "ReturnReasonInsertRequest": { "type": "object", "properties": { "returnReasonDesc": { "type": "string", "example": "TEST RETURN REASON DESC", "description": "The description of the return reason" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ReturnReasonInsertRequest" }, "ReturnReasonListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ReturnReasonPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ReturnReasonListResponse" }, "ReturnReasonPojo": { "type": "object", "properties": { "returnReasonDesc": { "type": "string", "example": "TEST RETURN REASON DESC", "description": "The description of the return reason" }, "returnReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique id for return reson" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ReturnReasonPojo" }, "ReturnReasonRequest": { "type": "object", "properties": { "returnReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique id for return reson" } }, "title": "ReturnReasonRequest" }, "ReturnReasonResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ReturnReasonPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ReturnReasonResponse" }, "ReturnReasonUpdateRequest": { "type": "object", "properties": { "returnReasonDesc": { "type": "string", "example": "TEST RETURN REASON DESC", "description": "The description of the return reason" }, "returnReasonIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique id for return reson" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ReturnReasonUpdateRequest" }, "ScannedBarcode": { "type": "object", "properties": { "barcode": { "type": "string", "example": "D151123453", "description": "The scanned barcode" }, "dateTimeScanned": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date and time the barcode was scanned" }, "parcelId": { "type": "integer" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "type": { "type": "string", "example": "SUCCESSFUL", "description": "Indicates whether the scan was successful or not. Can either be SUCCESSFUL or ERROR." } }, "title": "ScannedBarcode" }, "SearchAndValidateCustomerPojo": { "type": "object", "properties": { "barcode": { "type": "string", "example": "D151123453", "description": "The scanned barcode" }, "collectionType": { "type": "string", "example": "STANDARD', 'ALTERNATE", "description": "The type of collection" }, "identificationCountry": { "type": "string", "example": "ZA", "description": "Unique identifier of the counrty" }, "identificationType": { "type": "string", "example": "PASSPORT", "description": "Unique identifier of the type identification the customer will be using" }, "nodeId": { "type": "integer", "format": "int32", "example": 2800, "description": "Unique identifier for the node" }, "parcelId": { "type": "integer", "example": 17190, "description": "Unique identifier for the parcel" }, "userId": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "SearchAndValidateCustomerPojo" }, "ServiceTypeDeleteRequest": { "type": "object", "properties": { "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the service type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ServiceTypeDeleteRequest" }, "ServiceTypeInsertRequest": { "type": "object", "properties": { "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ServiceTypeInsertRequest" }, "ServiceTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ServiceTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ServiceTypeListResponse" }, "ServiceTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "serviceTypeDesc": { "type": "string" }, "serviceTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "ServiceTypeModel" }, "ServiceTypePojo": { "type": "object", "properties": { "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the service type" }, "userIdNo": { "type": "integer" } }, "title": "ServiceTypePojo" }, "ServiceTypeRequest": { "type": "object", "properties": { "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the service type" } }, "title": "ServiceTypeRequest" }, "ServiceTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ServiceTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ServiceTypeResponse" }, "ServiceTypeUpdateRequest": { "type": "object", "properties": { "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "serviceTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the service type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ServiceTypeUpdateRequest" }, "SignatureRequirementRequest": { "type": "object", "properties": { "signatureRequirementTypeIdNo": { "type": "integer", "format": "int32" } }, "title": "SignatureRequirementRequest" }, "SignatureRequirementTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/SignatureRequirementTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "SignatureRequirementTypeListResponse" }, "SignatureRequirementTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "imageInd": { "type": "string" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "signatureRequirementTypeDesc": { "type": "string" }, "signatureRequirementTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "SignatureRequirementTypeModel" }, "SignatureRequirementTypePojo": { "type": "object", "properties": { "signatureRequirementTypeDesc": { "type": "string", "example": "TEST SIGNATURE", "description": "The description of the signature requirement type" }, "signatureRequirementTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "SignatureRequirementTypePojo" }, "SignatureRequirementTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/SignatureRequirementTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "SignatureRequirementTypeResponse" }, "SingleIntegerResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "integer" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "SingleIntegerResponse" }, "SingleStringResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "string" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "SingleStringResponse" }, "StringListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "type": "string" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "StringListResponse" }, "SupplierDeleteRequest": { "type": "object", "properties": { "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "SupplierDeleteRequest" }, "SupplierDropPojo": { "type": "object", "required": [ "customerRefCode", "destinationNodeCode", "originNodeCode", "rcvCustomerCellphone", "userIdNo" ], "properties": { "collectionPin": { "type": "integer", "format": "int32", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "customerProfileCode": { "type": "string", "example": 206099978, "description": "If the parcel is going to a student, this will be the student number for that student. If the parcel is going to a patient, this will be the patient number for that patient." }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel." }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the final node where the parcel we be at before collection by the customer" }, "destinationNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the destination node for the parcel" }, "eventDatetime": { "type": "string", "example": "02-FEB-2016 14:30:00", "description": "The date and time the event was captured, in the format \"DD-MMM-YYYY HH24:MM:SS\", e.g. \"02-FEB-2016 14:30:00\". If the date and time is not supplied, the system will automatically use the current date and time." }, "eventUserIdNo": { "type": "integer", "example": 1, "description": "The user id of the user who captured the event" }, "locationCode": { "type": "string", "example": "SKY01", "description": "The code to identify the location" }, "logServProvParcelCode": { "type": "string", "example": "P151200434", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": 80000764200, "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the logistics service provider" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider, e.g. SKYNET." }, "nodeCode": { "type": "string", "example": "TS011", "description": "The code for the node where the parcel event occurred" }, "orderPieceCount": { "type": "integer", "format": "int32", "example": 1, "description": "A counter indicating the parcel's position in the order, e.g. parcel 1 of 50" }, "orderPieceTotal": { "type": "integer", "format": "int32", "example": 10, "description": "The total number of parcels linked to the specific supplier order" }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel originated." }, "originNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node where the parcel was originally received" }, "overrideNotValidStatus": { "type": "boolean", "example": false, "description": "Indicates whether the status check should be overriden or not" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "podDocumentIdNo": { "type": "integer", "example": 1234567, "description": "The unique Id that links the POD photo for that parcel" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product. If the productIdNo is not supplied, a default product for the specific supplier will be allocated to the parcel. Please call /getProductBySupplier to get a complete list of products, with their ID's." }, "rcvCustomerCellphone": { "type": "string", "example": "083 898 8766", "description": "The receiving customer's cellphone number" }, "rcvCustomerCountryCode": { "type": "string", "example": "ZA", "description": "The receiving customer's country code" }, "rcvCustomerFirstName": { "type": "string", "example": "Peter", "description": "The receiving customer's first name" }, "rcvCustomerLastName": { "type": "string", "example": "Pan", "description": "The receiving customer's last name" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier, e.g. UNISA." }, "supplierOrderNumber": { "type": "string", "description": "The order number (which could contain characters) supplied by the supplier" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the last user that updated the record" } }, "title": "SupplierDropPojo" }, "SupplierInsertRequest": { "type": "object", "properties": { "allowAltCollectionFlowInd": { "type": "string", "example": "N" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Indicates who the billing entity is for the specific supplier" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerProfileCodeDisplayName": { "type": "string", "example": "Student Number" }, "defaultProductIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the default product for a particular supplier" }, "directSupplierInterfaceInd": { "type": "string", "example": "Y", "description": "The indicator for whether a supplier interfaces with our apis directly" }, "noOfDaysUntilTokenExpire": { "type": "integer", "format": "int32", "example": 7, "description": "The Number Of days to keep the drop token active" }, "parcelPaymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The payment type for normal parcels, e.g. PRE-PAID, POST PAID" }, "preferredNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The suppliers preferred node for returns not coming to their site or for the collection of PAXI consumables" }, "returnPaymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The payment type for returns, e.g. PRE-PAID, POST PAID" }, "siteCollectionAllowedInd": { "type": "string", "example": "Y", "description": "Indicates whether site collection is allowed by logistics service providers for the specific supplier" }, "siteDeliveryAllowedInd": { "type": "string", "example": "Y", "description": "Indicates whether site delivery is allowed by logistics service providers for the specific supplier" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "supplierShortName": { "type": "string", "description": "A short name for the supplier, to be used in sms messages" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "SupplierInsertRequest" }, "SupplierListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/SupplierPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "SupplierListResponse" }, "SupplierModel": { "type": "object", "properties": { "allowAlternativeCollectionFlowInd": { "type": "string" }, "billingEntity": { "$ref": "#/definitions/BillingEntityModel" }, "customerProfileCodeDisplayName": { "type": "string" }, "defaultProduct": { "$ref": "#/definitions/ProductModel" }, "directSupplierInterfaceInd": { "type": "string" }, "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "noOfDaysUntilTokenExpire": { "type": "integer", "format": "int32" }, "parcelPaymentTermsType": { "$ref": "#/definitions/PaymentTermsTypeModel" }, "preferredNode": { "$ref": "#/definitions/NodeModel" }, "returnPaymentTermsType": { "$ref": "#/definitions/PaymentTermsTypeModel" }, "siteCollectionAllowedInd": { "type": "string" }, "siteDeliveryAllowedInd": { "type": "string" }, "supplierCode": { "type": "string" }, "supplierName": { "type": "string" }, "supplierShortName": { "type": "string" }, "userIdNo": { "type": "integer" } }, "title": "SupplierModel" }, "SupplierPojo": { "type": "object", "properties": { "allowAltCollectionFlowInd": { "type": "string", "example": "N" }, "billingEntityDesc": { "type": "string", "description": "The description of the Billing Entity" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Indicates who the billing entity is for the specific supplier" }, "customerProfileCode": { "type": "string", "example": "b1234b1234b1234b1234", "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerProfileCodeDisplayName": { "type": "string", "example": "Student Number" }, "defaultProductIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the default product for a particular supplier" }, "directSupplierInterfaceInd": { "type": "string", "example": "Y", "description": "The indicator for whether a supplier interfaces with our apis directly" }, "isTestSupplier": { "type": "boolean", "example": true }, "noOfDaysUntilTokenExpire": { "type": "integer", "format": "int32", "example": 7, "description": "The Number Of days to keep the drop token active" }, "parcelPaymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "parcelPaymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The payment type for normal parcels, e.g. PRE-PAID, POST PAID" }, "preferredNodeCode": { "type": "string", "description": "Code to uniquely identify the node" }, "preferredNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The suppliers preferred node for returns not coming to their site or for the collection of PAXI consumables" }, "preferredNodeShortName": { "type": "string", "description": "The short name of the node to be used in messages" }, "returnPaymentTermsTypeDesc": { "type": "string", "example": "PRE-PAID", "description": "The description of the Payment Terms Type, e.g. PRE-PAID, POST PAID" }, "returnPaymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The payment type for returns, e.g. PRE-PAID, POST PAID" }, "siteCollectionAllowedInd": { "type": "string", "example": "Y", "description": "Indicates whether site collection is allowed by logistics service providers for the specific supplier" }, "siteDeliveryAllowedInd": { "type": "string", "example": "Y", "description": "Indicates whether site delivery is allowed by logistics service providers for the specific supplier" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "supplierShortName": { "type": "string", "description": "A short name for the supplier, to be used in sms messages" }, "userIdNo": { "type": "integer" } }, "title": "SupplierPojo" }, "SupplierRequest": { "type": "object", "properties": { "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" } }, "title": "SupplierRequest" }, "SupplierResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/SupplierPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "SupplierResponse" }, "SupplierUpdateRequest": { "type": "object", "properties": { "allowAltCollectionFlowInd": { "type": "string", "example": "N" }, "billingEntityIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Indicates who the billing entity is for the specific supplier" }, "customerProfileCodeDisplayName": { "type": "string", "example": "Student Number" }, "defaultProductIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the default product for a particular supplier" }, "directSupplierInterfaceInd": { "type": "string", "example": "Y", "description": "The indicator for whether a supplier interfaces with our apis directly" }, "noOfDaysUntilTokenExpire": { "type": "integer", "format": "int32", "example": 7, "description": "The Number Of days to keep the drop token active" }, "parcelPaymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The payment type for normal parcels, e.g. PRE-PAID, POST PAID" }, "preferredNodeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The suppliers preferred node for returns not coming to their site or for the collection of PAXI consumables" }, "returnPaymentTermsTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The payment type for returns, e.g. PRE-PAID, POST PAID" }, "siteCollectionAllowedInd": { "type": "string", "example": "Y", "description": "Indicates whether site collection is allowed by logistics service providers for the specific supplier" }, "siteDeliveryAllowedInd": { "type": "string", "example": "Y", "description": "Indicates whether site delivery is allowed by logistics service providers for the specific supplier" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "supplierShortName": { "type": "string", "description": "A short name for the supplier, to be used in sms messages" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "SupplierUpdateRequest" }, "TokenStatusDeleteRequest": { "type": "object", "properties": { "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the token status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "TokenStatusDeleteRequest" }, "TokenStatusInsertRequest": { "type": "object", "properties": { "tokenStatusDesc": { "type": "string", "example": "PAID", "description": "The description of the token status" }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "TokenStatusInsertRequest" }, "TokenStatusListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/TokenStatusPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "TokenStatusListResponse" }, "TokenStatusModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "tokenStatusDesc": { "type": "string" }, "tokenStatusIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "TokenStatusModel" }, "TokenStatusPojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "tokenStatusDesc": { "type": "string", "example": "PAID", "description": "The description of the token type" }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token status" }, "userIdNo": { "type": "integer" } }, "title": "TokenStatusPojo" }, "TokenStatusRequest": { "type": "object", "properties": { "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token status" } }, "title": "TokenStatusRequest" }, "TokenStatusResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/TokenStatusPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "TokenStatusResponse" }, "TokenStatusUpdateRequest": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "format": "date-time", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "tokenStatusDesc": { "type": "string", "example": "PAID", "description": "The description of the token status" }, "tokenStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token status" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "TokenStatusUpdateRequest" }, "TokenTypeDeleteRequest": { "type": "object", "properties": { "tokenTypeDesc": { "type": "string", "example": "PRE-AUTHORISED", "description": "The description of the token type" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the token type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "TokenTypeDeleteRequest" }, "TokenTypeInsertRequest": { "type": "object", "properties": { "tokenTypeDesc": { "type": "string", "example": "PRE-AUTHORISED", "description": "The description of the token type" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "TokenTypeInsertRequest" }, "TokenTypeListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/TokenTypePojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "TokenTypeListResponse" }, "TokenTypeModel": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time" }, "lastUpdateDatetime": { "type": "string", "format": "date-time" }, "tokenTypeDesc": { "type": "string" }, "tokenTypeIdNo": { "type": "integer", "format": "int32" }, "userIdNo": { "type": "integer" } }, "title": "TokenTypeModel" }, "TokenTypePojo": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "tokenTypeDesc": { "type": "string", "example": "PRE-AUTHORISED", "description": "The description of the token type" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token type" }, "userIdNo": { "type": "integer" } }, "title": "TokenTypePojo" }, "TokenTypeRequest": { "type": "object", "properties": { "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token type" } }, "title": "TokenTypeRequest" }, "TokenTypeResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/TokenTypePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "TokenTypeResponse" }, "TokenTypeUpdateRequest": { "type": "object", "properties": { "discontinueDatetime": { "type": "string", "format": "date-time", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was suspended" }, "lastUpdateDatetime": { "type": "string", "format": "date-time", "example": "2016-01-21T11:26:22.000+02:00", "description": "The date that the record was last updated" }, "tokenTypeDesc": { "type": "string", "example": "PRE-AUTHORISED", "description": "The description of the token type" }, "tokenTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for token type" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "TokenTypeUpdateRequest" }, "TrnParcelPojo": { "type": "object", "properties": { "accountCode": { "type": "string" }, "assignmentNo": { "type": "integer", "format": "int32", "example": 12345, "description": "The reference number for the assignment" }, "assignmentSubjectCode": { "type": "string", "example": "DS301", "description": "The code for the course that the assignment is for" }, "colCustomerOneProfileGuid": { "type": "string", "description": "The parcel collector's one profile GUID" }, "collectionDate": { "type": "string", "example": 5, "description": "The date the parcel was collected" }, "collectionDays": { "type": "integer", "format": "int32", "example": 5, "description": "The amount of days it will take for the courier to come and collect " }, "collectionEndDate": { "type": "string", "example": 5, "description": "The last date the parcel can be collected" }, "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "companyName": { "type": "string", "example": "PEP", "description": "The name of the company" }, "currentCompanyName": { "type": "string", "example": "PEP", "description": "The name of the company in which node the parcel is currently in" }, "currentNodeAddressLine1": { "type": "string", "example": "MOGWASE SHOPPING CENTRE", "description": "Address of the node" }, "currentNodeAddressLine2": { "type": "string", "example": "SHOP 3", "description": "Address of the node" }, "currentNodeAddressLine3": { "type": "string", "example": "KAGISO DRIVE", "description": "Address of the node" }, "currentNodeAddressLine4": { "type": "string", "example": "Maroleng", "description": "Address of the node" }, "currentNodeAddressLine5": { "type": "string", "example": "North West", "description": "Address of the node" }, "currentNodeAddressLine6": { "type": "string", "example": "South Africa", "description": "Address of the node" }, "currentNodeCode": { "type": "string", "example": "TS011", "description": "The code for the node where the parcel currently is" }, "currentNodeContactName": { "type": "string", "example": "STORE MANAGER", "description": "The name of the contact person at the node where the parcel currently is" }, "currentNodePostalCode": { "type": "string", "example": "0314", "description": "The postal code of the node" }, "currentNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node the parcel is currently in" }, "currentNodeTelephone": { "type": "string", "example": "021 429 2981", "description": "Telephone number for the node the parcel is currently in" }, "customerProfileCode": { "type": "string", "example": 206099978, "description": "The student number of the customer for this parcel if Unisa Assignments" }, "customerRefCode": { "type": "string", "example": "PN160614130632360", "description": "The reference number for the customer for this parcel" }, "defaultNoOfInStoreDays": { "type": "integer", "format": "int32", "example": 3, "description": "The defualt number of days that a parcel can be in store" }, "destinationNodeAddressLine1": { "type": "string", "example": "MOGWASE SHOPPING CENTRE", "description": "Address of the node" }, "destinationNodeAddressLine2": { "type": "string", "example": "SHOP 3", "description": "Address of the node" }, "destinationNodeAddressLine3": { "type": "string", "example": "KAGISO DRIVE", "description": "Address of the node" }, "destinationNodeAddressLine4": { "type": "string", "example": "Maroleng", "description": "Address of the node" }, "destinationNodeAddressLine5": { "type": "string", "example": "North West", "description": "Address of the node" }, "destinationNodeAddressLine6": { "type": "string", "example": "North West", "description": "Address of the node" }, "destinationNodeCode": { "type": "string", "example": "U0002", "description": "The code for the destination node for the parcel" }, "destinationNodeCompanyName": { "type": "string", "example": "PEP", "description": "The name of the destination company node" }, "destinationNodePostalCode": { "type": "string", "example": "0314", "description": "The postal code of the node" }, "destinationNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The short name of the node destination" }, "destinationNodeTelephone": { "type": "string", "example": "021 429 2981", "description": "Telephone number for the destination node" }, "errorDesc": { "type": "string", "example": "Test error", "description": "The error description if an error occured during the transaction" }, "logServProvParcelCode": { "type": "string", "example": "PCND160210041374", "description": "The logistics service provider's parcel number" }, "logServProvWaybillCode": { "type": "string", "example": "W15123454", "description": "The logistics service provider's waybill number" }, "logisticsServiceProviderName": { "type": "string", "example": "SKYNET", "description": "The name of the logistics service provider" }, "messageTemplateIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the message template" }, "nodeCode": { "type": "string", "example": "U0002", "description": "The code to identify the node" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "originNodeCode": { "type": "string", "example": "P6465", "description": "The code for the node where the parcel was originally received" }, "originNodeNodeTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier of the node type where the parcel was originally received" }, "originNodeShortName": { "type": "string", "example": "PEP MGWS", "description": "The node short name for the node where the parcel was originally received" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER DROP", "description": "The description of the parcel event type" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelFeeAmt": { "type": "number", "format": "double", "example": 100, "description": "The fee amount for the parcel" }, "parcelIdNo": { "type": "integer", "example": 1, "description": "Unique identifier for the parcel" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "pepBranchNumber": { "type": "string", "description": "The PEP Branch number of the selected node, this will be the nodeCode without the 'P'" }, "podDocumentIdNo": { "type": "integer", "example": 1234567890, "description": "The unique Id that links the POD photo for that parcel" }, "productIdNo": { "type": "integer", "format": "int32", "example": 55, "description": "Unique identifier for the product" }, "productTypeDesc": { "type": "string", "example": "ASSIGNMENT", "description": "The discription of the product" }, "rcvCustomerCellPhone": { "type": "string", "example": "083 898 8766", "description": "The cellphone number of the customer receiving the parcel" }, "receiver": { "type": "string", "example": "Jon Doe", "description": "This is the name and surname of the person that will receive the parcel" }, "remainingDays": { "type": "integer", "format": "int32", "example": 5, "description": "The amount of days the customer still has to come and collect his/her parcel" }, "requestTypeDesc": { "type": "string", "example": "SUPPLIER DROP, COUNTER TO COUNTER NCR", "description": "This is a discription of the type of service" }, "sendCustomerCellPhone": { "type": "string", "example": "083 898 8677", "description": "The cellphone number of the customer sending the parcel" }, "sendCustomerOneProfileGUID": { "type": "string", "example": "GUID64345", "description": "Unique identifier in OneProfile for the customer sending the parcel" }, "serviceTypeDesc": { "type": "string", "example": "COUNTER TO COUNTER", "description": "The description of the service type" }, "skuNumber": { "type": "integer", "format": "int32", "example": 491090, "description": "The SKU number for the specific product" }, "supplierCode": { "type": "string", "example": "UNI001", "description": "The code to identify the supplier" }, "supplierName": { "type": "string", "example": "UNISA", "description": "The name of the supplier" }, "upldTrnCreateDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The datetime stamp the transaction was created" }, "upldTrnIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "The unique identifier for the upld trn record" } }, "title": "TrnParcelPojo" }, "UnProcessedPaxiEventsPojo": { "type": "object", "properties": { "logisticsServiceProviderCode": { "type": "string", "example": "PKL", "description": "Issued by PAXI. The unique courier code issued by PAXI to courier partner" }, "supplierCode": { "type": "string", "example": "BL001", "description": "Issued by PAXI. The unique supplier code issued by PAXI on registration as a supplier partner." } }, "title": "UnProcessedPaxiEventsPojo" }, "UnprocessedParcelsPojo": { "type": "object", "properties": { "customerRefCode": { "type": "string", "example": "D123456789012", "description": "The PAXI reference number that will be communicated to the customer refering to the parcel. In the case of PAXI bags this is the Dxxxxxxxxxxxx number printed on the bags" }, "eventReferenceCode": { "type": "string", "example": 345234, "description": "Reference code for the event" }, "logServProvParcelCode": { "type": "string", "example": "P72918253928358_001", "description": "The parcel number allocated by the courier" }, "logServProvWaybillCode": { "type": "string", "example": "W72918253928358", "description": "The waybill number allocated by the courier" }, "logisticsServiceProviderName": { "type": "string", "example": "PEPKOR LOGISTICS", "description": "The name of the logistics service provider / courier" }, "nodeCode": { "type": "string", "example": "P9999", "description": "The node / store / location code where the event occurred" }, "parcelEventTypeDesc": { "type": "string", "example": "CUSTOMER COLLECTION", "description": "The description of the parcel event type; COURIER DELIVERY" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 10, "description": "The parcel event type code within the PAXI" }, "parcelEventTypeMessageTemplate": { "type": "string", "description": "Template for user friendly event type message" }, "podDocumentIdNo": { "type": "integer", "example": 1234567890, "description": "The unique Id that links the POD photo for that parcel" }, "productTypeDesc": { "type": "string", "example": "DOCUMENT", "description": "The description of the product type" }, "supplierCode": { "type": "string", "example": "XYZ00", "description": "The PAXI supplier code allocated to the supplier" }, "supplierName": { "type": "string", "example": "SAMPLE SUPPLIER", "description": "The name of the supplier linked to the supplier code" }, "upldTrnCreateDatetime": { "type": "string", "example": "1970-12-30T12:59:59.000+02:00", "description": "The datetime stamp that the tracking event occurred" }, "upldTrnIdNo": { "type": "integer", "format": "int32", "example": 987654, "description": "The unique indentifier for the tracking event record that has been created" } }, "title": "UnprocessedParcelsPojo" }, "UpdateParcelStatusRequest": { "type": "object", "properties": { "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "statusUpdateReason": { "type": "string", "example": "Updated from LOST to IN_TRANSIT", "description": "Free text reason for the update" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "UpdateParcelStatusRequest" }, "UpldTrnCriteriaRequest": { "type": "object", "properties": { "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "trnTypeIdNo": { "type": "integer", "format": "int32", "example": 4, "description": "Auto increment number used to uniquely identify a transaction type" }, "upldTrnIdNo": { "type": "integer", "format": "int32", "example": 4, "description": "The unique identifier for the upld trn record" } }, "title": "UpldTrnCriteriaRequest" }, "UpldTrnListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/UpldTrnPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "UpldTrnListResponse" }, "UpldTrnPojo": { "type": "object", "properties": { "createDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The datetime stamp the transaction was created" }, "errorDatetime": { "type": "string", "example": "2017-03-21T10:26:32.000+02:00", "description": "The date time stamp the error occured" }, "errorDesc": { "type": "string", "example": "Test error", "description": "The error description if an error occured during the transaction" }, "nodeLocationIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the node - location combination" }, "parcelEventTypeIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel event" }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" }, "trnTypeIdNo": { "type": "integer", "format": "int32", "example": 4, "description": "Auto increment number used to uniquely identify a transaction type" }, "upldDatetime": { "type": "string", "example": "2017-01-21T10:26:32.000+02:00", "description": "The date time stamp the transaction was uploaded" }, "upldTrnIdNo": { "type": "integer", "format": "int32", "example": 4, "description": "The unique identifier for the upld trn record" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "UpldTrnPojo" }, "UpldTrnRequest": { "type": "object", "properties": { "upldTrnIdNo": { "type": "integer", "format": "int32", "example": 4, "description": "The unique identifier for the upld trn record" } }, "title": "UpldTrnRequest" }, "UpldTrnResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "result": { "$ref": "#/definitions/UpldTrnPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "UpldTrnResponse" }, "ValidCellPojo": { "type": "object", "required": [ "reason", "valid" ], "properties": { "reason": { "type": "string", "enum": [ "cellphone number is valid", "Invalid cellphone number length", "cellphone number needs to start with a 0 and cannot contain text", "Cellphone number needs to be populated" ] }, "valid": { "type": "boolean" } }, "title": "ValidCellPojo" }, "ValidCustomerCollectionPojo": { "type": "object", "properties": { "colCustomerOneProfileGuid": { "type": "string", "example": "GUID64777", "description": "Unique identifier in OneProfile for the customer who is collecting the parcel who is not the intended receiver" }, "createdDate": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00" }, "customerCollectionParcel": { "$ref": "#/definitions/CustomerCollectionParcelPojo" }, "destNodeCode": { "type": "string", "example": "P8069", "description": "The code of the destination node" }, "nodeCode": { "type": "string", "example": "TS016", "description": "The code to identify the node" }, "nodeDesc": { "type": "string", "example": "PEP MOGWASE", "description": "The name of the node" }, "plannedDeliveryDatetime": { "type": "string", "example": "2017-02-21T11:26:32.000+02:00", "description": "The date and time of when the parcels will be delivered" }, "reason": { "type": "string" }, "receiver": { "type": "string", "example": "Jon Doe", "description": "This is the name and surname of the person that will receive the parcel" }, "supplierCode": { "type": "string", "example": 1, "description": "Code to identify the supplier" } }, "title": "ValidCustomerCollectionPojo" }, "ValidCustomerCollectionResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/ValidCustomerCollectionPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ValidCustomerCollectionResponse" }, "ValidCustomerSearchReasonPojo": { "type": "object", "properties": { "customer": { "$ref": "#/definitions/Customer" }, "parcelIdNo": { "type": "integer" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description of the parcel status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel's current status" }, "reason": { "type": "string" }, "valid": { "type": "boolean" } }, "title": "ValidCustomerSearchReasonPojo" }, "ValidCustomerSearchReasonResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ValidCustomerSearchReasonPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ValidCustomerSearchReasonResponse" }, "ValidNodePojo": { "type": "object", "properties": { "nodeCode": { "type": "string", "example": "U0002", "description": "The code for the node the parcel is in" }, "reason": { "type": "string" }, "valid": { "type": "boolean" } }, "title": "ValidNodePojo" }, "ValidNodeReponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ValidNodePojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ValidNodeReponse" }, "ValidReasonPojo": { "type": "object", "properties": { "parcelIdNo": { "type": "integer" }, "parcelStatusDesc": { "type": "string", "example": "AWAITING UPLIFTMENT", "description": "The description for the parcel's current status" }, "parcelStatusIdNo": { "type": "integer", "format": "int32", "example": 1, "description": "Unique identifier for the parcel status" }, "reason": { "type": "string" }, "valid": { "type": "boolean" } }, "title": "ValidReasonPojo" }, "ValidateCourierDropLabelPojo": { "type": "object", "properties": { "barcode": { "type": "string", "example": "D151123453", "description": "The scanned barcode" }, "logServProvDelManifestCode": { "type": "string", "example": "XXMANIFEST123", "description": "The logistic service provider delivert manifest code" }, "nodeIdNo": { "type": "integer", "format": "int32", "example": 2800, "description": "he unique identifier for the node" }, "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" } }, "title": "ValidateCourierDropLabelPojo" }, "ValidateCustomerCode": { "type": "object", "properties": { "collectionPin": { "type": "string", "example": 46415, "description": "The pin a customer needs to collect their parcel" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "ValidateCustomerCode" }, "ValidateDropLabelResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/DropLabelValidationPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ValidateDropLabelResponse" }, "ValidateParcelStatusRequest": { "type": "object", "properties": { "currentNodeIdNo": { "type": "integer", "format": "int32", "example": 2805, "description": "Unique identifier for the current node" }, "customerRefCode": { "type": "string", "example": "D151200024017", "description": "The reference number for the customer for this parcel. For Unisa Assignments, this will be the number on the drop label." }, "parcelIdNo": { "type": "integer", "example": 135, "description": "Unique identifier for the parcel" } }, "title": "ValidateParcelStatusRequest" }, "ValidationReasonResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/ValidReasonPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "ValidationReasonResponse" }, "WriteOffReasonDeleteRequest": { "type": "object", "properties": { "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason" } }, "title": "WriteOffReasonDeleteRequest" }, "WriteOffReasonInsertRequest": { "type": "object", "properties": { "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "writeOffReasonDesc": { "type": "string", "example": "LOST IN NODE", "description": "The description of the write off reason" } }, "title": "WriteOffReasonInsertRequest" }, "WriteOffReasonListResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/definitions/WriteOffReasonPojo" } }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "WriteOffReasonListResponse" }, "WriteOffReasonPojo": { "type": "object", "properties": { "userIdNo": { "type": "integer" }, "writeOffReasonDesc": { "type": "string", "example": "LOST IN NODE", "description": "The description of the write off reason" }, "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason" } }, "title": "WriteOffReasonPojo" }, "WriteOffReasonRequest": { "type": "object", "properties": { "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason" } }, "title": "WriteOffReasonRequest" }, "WriteOffReasonResponse": { "type": "object", "properties": { "filteredItems": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "responseCode": { "type": "string" }, "results": { "$ref": "#/definitions/WriteOffReasonPojo" }, "success": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" } }, "title": "WriteOffReasonResponse" }, "WriteOffReasonUpdateRequest": { "type": "object", "properties": { "userIdNo": { "type": "integer", "example": 1, "description": "The user id of the user that last updated the record" }, "writeOffReasonDesc": { "type": "string", "example": "LOST IN NODE", "description": "The description of the write off reason" }, "writeOffReasonIdNo": { "type": "integer", "format": "int32", "example": 2, "description": "Unique identifier for the write off reason" } }, "title": "WriteOffReasonUpdateRequest" } } }