{ "uuid": "74573cf8-5cb2-4256-98b1-f3e7dbffca7a", "lastMigration": 29, "name": "ChannelShipper & Royal Mail Public API", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "93f60037-0e5d-4a2e-baca-ce7f2528dec8", "documentation": "Create orders", "method": "post", "endpoint": "orders", "responses": [ { "uuid": "ec897f41-177c-4076-b945-4c36ccd0f94d", "body": "{\n \"createdOrders\": [\n {\n \"createdOn\": \"{{faker 'date.recent' 365}}\",\n \"label\": \"\",\n \"labelErrors\": [\n {\n \"message\": \"\"\n }\n ],\n \"manifestedOn\": \"{{faker 'date.recent' 365}}\",\n \"orderDate\": \"{{faker 'date.recent' 365}}\",\n \"orderIdentifier\": {{faker 'number.int' max=99999}},\n \"orderReference\": \"\",\n \"printedOn\": \"{{faker 'date.recent' 365}}\",\n \"shippedOn\": \"{{faker 'date.recent' 365}}\",\n \"trackingNumber\": \"\"\n }\n ],\n \"errorsCount\": {{faker 'number.int' max=99999}},\n \"failedOrders\": [\n {\n \"errors\": [\n {\n \"errorCode\": {{faker 'number.int' max=99999}},\n \"errorMessage\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"order\": {\n \"billing\": {\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"county\": \"\",\n \"fullName\": \"\",\n \"postcode\": \"\"\n },\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"currencyCode\": \"\",\n \"customsDutyCosts\": {{faker 'number.int' max=99999}},\n \"label\": {\n \"includeCN\": {{faker 'datatype.boolean'}},\n \"includeLabelInResponse\": {{faker 'datatype.boolean'}},\n \"includeReturnsLabel\": {{faker 'datatype.boolean'}}\n },\n \"orderDate\": \"{{faker 'date.recent' 365}}\",\n \"orderReference\": \"\",\n \"otherCosts\": {{faker 'number.int' max=99999}},\n \"packages\": [\n {\n \"contents\": [\n {\n \"SKU\": \"\",\n \"customsCode\": \"\",\n \"customsDeclarationCategory\": \"{{oneOf (array 'none' 'gift' 'commercialSample' 'documents' 'other' 'returnedGoods' 'saleOfGoods' 'mixedContent')}}\",\n \"customsDescription\": \"\",\n \"extendedCustomsDescription\": \"\",\n \"name\": \"\",\n \"originCountryCode\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"requiresExportLicence\": {{faker 'datatype.boolean'}},\n \"unitValue\": {{faker 'number.int' max=99999}},\n \"unitWeightInGrams\": {{faker 'number.int' max=99999}}\n }\n ],\n \"customPackageFormatIdentifier\": \"\",\n \"dimensions\": {\n \"depthInMms\": {{faker 'number.int' max=99999}},\n \"heightInMms\": {{faker 'number.int' max=99999}},\n \"widthInMms\": {{faker 'number.int' max=99999}}\n },\n \"packageFormatIdentifier\": \"{{oneOf (array 'undefined' 'letter' 'largeLetter' 'smallParcel' 'mediumParcel' 'parcel' 'documents' 'custom')}}\",\n \"weightInGrams\": {{faker 'number.int' max=99999}}\n }\n ],\n \"plannedDespatchDate\": \"{{faker 'date.recent' 365}}\",\n \"postageDetails\": {\n \"AIRNumber\": \"\",\n \"IOSSNumber\": \"\",\n \"commercialInvoiceDate\": \"{{faker 'date.recent' 365}}\",\n \"commercialInvoiceNumber\": \"\",\n \"consequentialLoss\": {{faker 'number.int' max=99999}},\n \"department\": \"\",\n \"guaranteedSaturdayDelivery\": {{faker 'datatype.boolean'}},\n \"isLocalCollect\": {{faker 'datatype.boolean'}},\n \"receiveEmailNotification\": {{faker 'datatype.boolean'}},\n \"receiveSmsNotification\": {{faker 'datatype.boolean'}},\n \"requestSignatureUponDelivery\": {{faker 'datatype.boolean'}},\n \"requiresExportLicense\": {{faker 'datatype.boolean'}},\n \"safePlace\": \"\",\n \"sendNotificationsTo\": \"{{oneOf (array 'sender' 'recipient' 'billing')}}\",\n \"serviceCode\": \"\",\n \"serviceRegisterCode\": \"\"\n },\n \"recipient\": {\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"county\": \"\",\n \"fullName\": \"\",\n \"postcode\": \"\"\n },\n \"addressBookReference\": \"\",\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"sender\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\",\n \"tradingName\": \"\"\n },\n \"shippingCostCharged\": {{faker 'number.int' max=99999}},\n \"specialInstructions\": \"\",\n \"subtotal\": {{faker 'number.int' max=99999}},\n \"tags\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"total\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"successCount\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Request Processed Successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "93e014ca-c957-44ad-85eb-03171b350464", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request (Request has missing or invalid parameters and cannot be parsed)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ea903f7c-3acc-4be9-88e7-1f633d00113b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "978b816d-0251-4f9f-9243-a5912e032a65", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a6e82242-f510-4837-8ead-2923fed5cd78", "documentation": "Retrieve orders", "method": "get", "endpoint": "orders/:orderIdentifiers", "responses": [ { "uuid": "71cf1d97-243f-4fd8-adbf-babd4dc099c8", "body": "[\n {\n \"createdOn\": \"{{faker 'date.recent' 365}}\",\n \"manifestedOn\": \"{{faker 'date.recent' 365}}\",\n \"orderDate\": \"{{faker 'date.recent' 365}}\",\n \"orderIdentifier\": {{faker 'number.int' max=99999}},\n \"orderReference\": \"\",\n \"printedOn\": \"{{faker 'date.recent' 365}}\",\n \"shippedOn\": \"{{faker 'date.recent' 365}}\",\n \"trackingNumber\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Return information about the orders", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bbbc967f-12c9-41e6-ae61-b8d04b8be405", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request (Request has missing or invalid parameters and cannot be parsed)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "788965b6-33b5-4246-b1db-bd66a6c156a4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "90dc965e-467b-42c0-83bb-2d707b8b1a9c", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "95adb991-6098-4e24-bf51-ca25c7d23d14", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34106d41-5518-4b68-9caa-284a7435b678", "documentation": "Retrieve orders details", "method": "get", "endpoint": "orders/:orderIdentifiers/full", "responses": [ { "uuid": "cf14511a-3276-4306-9db3-7e48f8ef5b3c", "body": "[\n {\n \"AIRNumber\": \"\",\n \"accountBatchNumber\": \"\",\n \"billingInfo\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"county\": \"\",\n \"emailAddress\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"postcode\": \"\",\n \"title\": \"\"\n },\n \"channel\": \"\",\n \"channelShippingMethod\": \"\",\n \"commercialInvoiceDate\": \"{{faker 'date.recent' 365}}\",\n \"commercialInvoiceNumber\": \"\",\n \"createdOn\": \"{{faker 'date.recent' 365}}\",\n \"currencyCode\": \"\",\n \"department\": \"\",\n \"despatchedByOtherCourierOn\": \"{{faker 'date.recent' 365}}\",\n \"manifestedOn\": \"{{faker 'date.recent' 365}}\",\n \"marketplaceTypeName\": \"\",\n \"orderDate\": \"{{faker 'date.recent' 365}}\",\n \"orderDiscount\": {{faker 'number.int' max=99999}},\n \"orderIdentifier\": {{faker 'number.int' max=99999}},\n \"orderLines\": [\n {\n \"SKU\": \"\",\n \"customsCode\": \"\",\n \"lineTotal\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"quantity\": {{faker 'number.int' max=99999}},\n \"unitValue\": {{faker 'number.int' max=99999}}\n }\n ],\n \"orderReference\": \"\",\n \"orderStatus\": \"\",\n \"packageSize\": \"\",\n \"pickerSpecialInstructions\": \"\",\n \"postageAppliedOn\": \"{{faker 'date.recent' 365}}\",\n \"printedOn\": \"{{faker 'date.recent' 365}}\",\n \"requiresExportLicense\": {{faker 'datatype.boolean'}},\n \"shippedOn\": \"{{faker 'date.recent' 365}}\",\n \"shippingCostCharged\": {{faker 'number.int' max=99999}},\n \"shippingDetails\": {\n \"deliveryService\": \"\",\n \"guaranteedSaturdayDelivery\": {{faker 'datatype.boolean'}},\n \"isLocalCollect\": {{faker 'datatype.boolean'}},\n \"receiveEmailNotification\": {{faker 'datatype.boolean'}},\n \"receiveSmsNotification\": {{faker 'datatype.boolean'}},\n \"requestSignatureUponDelivery\": {{faker 'datatype.boolean'}},\n \"serviceCode\": \"\",\n \"shippingCost\": {{faker 'number.int' max=99999}},\n \"shippingTrackingStatus\": \"\",\n \"trackingNumber\": \"\"\n },\n \"shippingInfo\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"county\": \"\",\n \"emailAddress\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"postcode\": \"\",\n \"title\": \"\"\n },\n \"specialInstructions\": \"\",\n \"subtotal\": {{faker 'number.int' max=99999}},\n \"tags\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"total\": {{faker 'number.int' max=99999}},\n \"tradingName\": \"\",\n \"weightInGrams\": {{faker 'number.int' max=99999}}\n }\n]", "latency": 0, "statusCode": 200, "label": "Return detailed information about the orders", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5c34c83d-1210-4969-9675-381b6ac71757", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request (Request has missing or invalid parameters and cannot be parsed)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b84d07bb-b1c1-4df8-b967-c1154a82cbd6", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5e19dec2-9eac-4d32-9231-12c39cb19ec4", "body": "", "latency": 0, "statusCode": 403, "label": "Forbidden (Feature not available)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "09132dc3-7b58-4e70-b9f5-bfe5c18a416a", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ad5022f7-22fd-4faf-b1de-152592f84eca", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "705c6a43-2139-4300-98a0-daa3456ab4bf", "documentation": "Return a single PDF file with generated label and/or associated document(s)", "method": "get", "endpoint": "orders/:orderIdentifiers/label", "responses": [ { "uuid": "5209b261-5ec3-4208-bfe3-d6521155c554", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Return the PDF file with labels", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f849c7b0-d8fe-4139-b315-d2f803da81b7", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request (Request has missing or invalid parameters and cannot be parsed)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "851654db-2201-4f0e-a029-f7d7ebe566e9", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a05aca3d-4fd8-48aa-88c6-40b4de982ffa", "body": "", "latency": 0, "statusCode": 403, "label": "Forbidden (Feature not available)", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "07102e62-b9e5-455a-ac1e-dd99530aabd7", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bd89e445-03d6-4cf1-aec9-b741e2d9a6c5", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a6b6e911-a208-4733-aefe-154925899c4d", "documentation": "Get API version details.", "method": "get", "endpoint": "version", "responses": [ { "uuid": "ddd48f9c-f079-492d-923b-1592ff1604fd", "body": "{\n \"build\": \"\",\n \"commit\": \"\",\n \"release\": \"\",\n \"releaseDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns details about the API version", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e12cd67b-c8c4-4af6-83cf-6a60f5685710", "body": "{\n \"code\": \"\",\n \"details\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "93f60037-0e5d-4a2e-baca-ce7f2528dec8" }, { "type": "route", "uuid": "a6e82242-f510-4837-8ead-2923fed5cd78" }, { "type": "route", "uuid": "34106d41-5518-4b68-9caa-284a7435b678" }, { "type": "route", "uuid": "705c6a43-2139-4300-98a0-daa3456ab4bf" }, { "type": "route", "uuid": "a6b6e911-a208-4733-aefe-154925899c4d" } ] }