{ "item": [ { "name": "Shipments", "description": "Track, cancel, and pull labels and PODs for your shipments", "item": [ { "id": "5073e348-c766-442c-8feb-349ad222176f", "name": "List my shipments", "request": { "name": "List my shipments", "description": {}, "url": { "path": [ "api", "v1", "customer", "shipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of SAME_DAY,OVERNIGHT,ECONOMY,ECONOMY_REGIONAL,BUDGET,INTERNATIONAL)", "type": "text/plain" }, "key": "serviceLevel", "value": "BUDGET" }, { "disabled": false, "description": { "content": " (This can only be one of DRAFT,CREATED,COLLECTION_ASSIGNED,COLLECTED,CHECKED_IN,AT_HUB,IN_TRANSIT,AT_DESTINATION_HUB,OUT_FOR_DELIVERY,DELIVERED,FAILED_DELIVERY,RETURNED_TO_HUB,REDELIVERY_SCHEDULED,RETURNED_TO_SENDER,LOST,CANCELLED,HELD)", "type": "text/plain" }, "key": "status", "value": "DRAFT" } ], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a470443d-042c-4336-8538-f82ffb449bc4", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "shipments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of SAME_DAY,OVERNIGHT,ECONOMY,ECONOMY_REGIONAL,BUDGET,INTERNATIONAL)", "type": "text/plain" }, "key": "serviceLevel", "value": "BUDGET" }, { "disabled": false, "description": { "content": " (This can only be one of DRAFT,CREATED,COLLECTION_ASSIGNED,COLLECTED,CHECKED_IN,AT_HUB,IN_TRANSIT,AT_DESTINATION_HUB,OUT_FOR_DELIVERY,DELIVERED,FAILED_DELIVERY,RETURNED_TO_HUB,REDELIVERY_SCHEDULED,RETURNED_TO_SENDER,LOST,CANCELLED,HELD)", "type": "text/plain" }, "key": "status", "value": "DRAFT" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8fdb050-b93e-447b-bcd7-bb12f0bd93e9", "name": "Get active shipment counts grouped by status", "request": { "name": "Get active shipment counts grouped by status", "description": {}, "url": { "path": [ "api", "v1", "customer", "shipments", "status-summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "17d7c7b9-9ffb-4ff8-bbf7-e387ef2c7484", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "shipments", "status-summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae245d2f-3a6e-40a6-914d-cb0ce9bf9d24", "name": "Get shipment detail + tracking timeline", "request": { "name": "Get shipment detail + tracking timeline", "description": {}, "url": { "path": [ "api", "v1", "customer", "shipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8b8a8697-6b9f-41e4-9bd5-354b1c090e34", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "shipments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ea4abe9-3205-4637-a0ce-c68760d255d0", "name": "Get POD signature URL for a delivered shipment", "request": { "name": "Get POD signature URL for a delivered shipment", "description": {}, "url": { "path": [ "api", "v1", "customer", "shipments", ":id", "pod" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ab4e00a5-80a2-4410-9bdb-00895e455e26", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "shipments", ":id", "pod" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24c9f331-a229-40e7-98f3-4b2fff37a60d", "name": "Download waybill label PDF (100×150 mm)", "request": { "name": "Download waybill label PDF (100×150 mm)", "description": {}, "url": { "path": [ "api", "v1", "customer", "shipments", ":id", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aaa1e09a-ad02-41f9-bd79-07494b0a83a6", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "shipments", ":id", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5e208e4-86da-46ff-a508-5961fd5b8228", "name": "Cancel a shipment (only allowed before collection)", "request": { "name": "Cancel a shipment (only allowed before collection)", "description": {}, "url": { "path": [ "api", "v1", "customer", "shipments", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8c971a00-c6bf-4ae0-9ae0-3bd36e3ea2d1", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "shipments", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Quotes & booking", "description": "Price a consignment and book it", "item": [ { "id": "1093bea1-82d9-47bf-a115-983354afada3", "name": "Get shipping quotes for all service levels", "request": { "name": "Get shipping quotes for all service levels", "description": {}, "url": { "path": [ "api", "v1", "customer", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"originSuburb\": \"\",\n \"originPostalCode\": \"\",\n \"destSuburb\": \"\",\n \"destPostalCode\": \"\",\n \"pieces\": [\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n },\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cfb8ce7d-dc9c-4a4c-8c6f-99e18d4843e5", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"originSuburb\": \"\",\n \"originPostalCode\": \"\",\n \"destSuburb\": \"\",\n \"destPostalCode\": \"\",\n \"pieces\": [\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n },\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84dff760-092e-4bf1-9502-2b00224c0b94", "name": "Submit a booking request", "request": { "name": "Submit a booking request", "description": {}, "url": { "path": [ "api", "v1", "customer", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceLevel\": \"ECONOMY_REGIONAL\",\n \"senderName\": \"\",\n \"senderStreet\": \"\",\n \"senderSuburb\": \"\",\n \"senderCity\": \"\",\n \"senderProvince\": \"\",\n \"senderPostalCode\": \"\",\n \"senderPhone\": \"\",\n \"recipientName\": \"\",\n \"recipientStreet\": \"\",\n \"recipientSuburb\": \"\",\n \"recipientCity\": \"\",\n \"recipientProvince\": \"\",\n \"recipientPostalCode\": \"\",\n \"recipientPhone\": \"\",\n \"pieces\": [\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n },\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n }\n ],\n \"senderCompany\": \"\",\n \"senderComplex\": \"\",\n \"senderEmail\": \"\",\n \"recipientCompany\": \"\",\n \"recipientComplex\": \"\",\n \"recipientEmail\": \"\",\n \"specialInstructions\": \"\",\n \"customerReference\": \"\",\n \"quotedCharge\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "58694f84-66e5-409e-98f4-d3d4511f1a75", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceLevel\": \"ECONOMY_REGIONAL\",\n \"senderName\": \"\",\n \"senderStreet\": \"\",\n \"senderSuburb\": \"\",\n \"senderCity\": \"\",\n \"senderProvince\": \"\",\n \"senderPostalCode\": \"\",\n \"senderPhone\": \"\",\n \"recipientName\": \"\",\n \"recipientStreet\": \"\",\n \"recipientSuburb\": \"\",\n \"recipientCity\": \"\",\n \"recipientProvince\": \"\",\n \"recipientPostalCode\": \"\",\n \"recipientPhone\": \"\",\n \"pieces\": [\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n },\n {\n \"actualWeightKg\": \"\",\n \"lengthCm\": \"\",\n \"widthCm\": \"\",\n \"heightCm\": \"\",\n \"declaredValue\": \"\"\n }\n ],\n \"senderCompany\": \"\",\n \"senderComplex\": \"\",\n \"senderEmail\": \"\",\n \"recipientCompany\": \"\",\n \"recipientComplex\": \"\",\n \"recipientEmail\": \"\",\n \"specialInstructions\": \"\",\n \"customerReference\": \"\",\n \"quotedCharge\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01cb2dc4-6a66-4c66-b2d9-d746e8c73b40", "name": "List my booking requests", "request": { "name": "List my booking requests", "description": {}, "url": { "path": [ "api", "v1", "customer", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4e85daca-581d-41da-94f6-0efb641a7f88", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "299cf4ed-dcb2-49e6-9309-25f116876b29", "name": "Initiate PayFast payment for a prepaid booking — returns redirect URL", "request": { "name": "Initiate PayFast payment for a prepaid booking — returns redirect URL", "description": {}, "url": { "path": [ "api", "v1", "customer", "bookings", ":referenceNumber", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referenceNumber", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fa751e72-5362-4557-9a78-15ec368786b9", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "bookings", ":referenceNumber", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referenceNumber" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Wallet & top-ups", "description": "Prepaid balance, ledger and PayFast top-ups", "item": [ { "id": "cde38b60-64f8-4e54-963a-5f5f508edda7", "name": "My account balance, available funds and low-balance flag", "request": { "name": "My account balance, available funds and low-balance flag", "description": {}, "url": { "path": [ "api", "v1", "customer", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "92851bb5-f6a5-451f-888b-229be23179f3", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9c0c9ff-60f7-462c-8298-718ae574d7be", "name": "My account statement — every top-up and charge, newest first", "request": { "name": "My account statement — every top-up and charge, newest first", "description": {}, "url": { "path": [ "api", "v1", "customer", "wallet", "ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "809df401-61e9-4077-b2cb-07818f14f3d0", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "wallet", "ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f430d0f5-298a-481d-b27c-24f6529210aa", "name": "Start a PayFast top-up — returns the redirect URL", "request": { "name": "Start a PayFast top-up — returns the redirect URL", "description": { "content": "The balance is credited when PayFast confirms the payment, not when the redirect happens.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "customer", "wallet", "topup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f45f6145-a7db-46ee-b418-0cb7df396265", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "wallet", "topup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Invoices & statements", "description": "Documents, PDFs and online payment", "item": [ { "id": "9dac5ac6-4d16-4403-af23-3b166f71310c", "name": "List my invoices", "request": { "name": "List my invoices", "description": {}, "url": { "path": [ "api", "v1", "customer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0233454c-28e9-4701-940b-ecbf48045631", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e5f1e23-0d2e-438a-a7dc-1682a7fa42ac", "name": "Get invoice detail", "request": { "name": "Get invoice detail", "description": {}, "url": { "path": [ "api", "v1", "customer", "invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "63a02879-5d96-4c29-869e-b2d39b71f50b", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9ac8d04-19e6-4c9f-bdbd-6470063d932d", "name": "Download invoice PDF", "request": { "name": "Download invoice PDF", "description": {}, "url": { "path": [ "api", "v1", "customer", "invoices", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6fa3bf81-49bf-4073-9947-e40fbc86c298", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "invoices", ":id", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55341f5b-1b52-4fde-a9f9-562f4bf6bdef", "name": "Initiate PayFast payment for an invoice — returns redirect URL", "request": { "name": "Initiate PayFast payment for an invoice — returns redirect URL", "description": {}, "url": { "path": [ "api", "v1", "customer", "invoices", ":id", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "360c4aa0-4a34-4f45-9452-0ecff2b71676", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "invoices", ":id", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73da08b8-fa79-4723-bb92-2365fdff4a14", "name": "Get credit note detail", "request": { "name": "Get credit note detail", "description": {}, "url": { "path": [ "api", "v1", "customer", "credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bdd1bc89-f98a-4d87-8b7e-6888434c0194", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "credit-notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27a4e5f0-745e-4232-986e-cffe358f80b4", "name": "Get account statement with age analysis", "request": { "name": "Get account statement with age analysis", "description": {}, "url": { "path": [ "api", "v1", "customer", "statement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f0a310dd-7f42-4dca-996a-2a6efe2804bd", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "statement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "006e4241-bad9-4e1f-aac5-980d148f9322", "name": "Initiate PayFast payment for the total outstanding statement balance", "request": { "name": "Initiate PayFast payment for the total outstanding statement balance", "description": {}, "url": { "path": [ "api", "v1", "customer", "statement", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "54e759dd-c0b5-460f-b35b-08c84f26aa27", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "statement", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47618c3b-a58f-4427-8b75-2f4a6870cd8c", "name": "Download account statement as PDF", "request": { "name": "Download account statement as PDF", "description": {}, "url": { "path": [ "api", "v1", "customer", "statement", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "28cf3918-91ee-4d51-8646-38bf72d3f327", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "statement", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Address book", "description": "Saved senders and recipients", "item": [ { "id": "58442d78-e7bc-4194-b984-f07b7620a9fe", "name": "List my saved addresses", "request": { "name": "List my saved addresses", "description": {}, "url": { "path": [ "api", "v1", "customer", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7dcf5c17-5ddc-497a-9497-e59112df61ea", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa434b9f-2a7d-4541-989a-0a0d1dd5550c", "name": "Add a saved address", "request": { "name": "Add a saved address", "description": {}, "url": { "path": [ "api", "v1", "customer", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b790926c-7bbe-4374-a632-f705aed10c60", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c6355c5-11bb-4ac2-a510-e7e6a32b8495", "name": "Update a saved address", "request": { "name": "Update a saved address", "description": {}, "url": { "path": [ "api", "v1", "customer", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "PATCH", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fa90fbd1-0e79-495d-ac16-28264f3f0044", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ed2d3a7-ac6b-4c23-8979-374d1effec9c", "name": "Delete a saved address", "request": { "name": "Delete a saved address", "description": {}, "url": { "path": [ "api", "v1", "customer", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "addd3ba3-25da-4917-9a41-e15e91e7477b", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account & users", "description": "Your profile, billing details, users and cost centres", "item": [ { "id": "9b5b76b2-01c6-49f8-b710-5768ed3f12d6", "name": "Get my profile and linked customer account", "request": { "name": "Get my profile and linked customer account", "description": {}, "url": { "path": [ "api", "v1", "customer", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "60ca10f9-fd4e-499c-86e0-62c29df944e0", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae45a495-67c4-4528-8181-82d544727e78", "name": "Update my profile (name, phone)", "request": { "name": "Update my profile (name, phone)", "description": {}, "url": { "path": [ "api", "v1", "customer", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d9f36b4d-ee59-4dba-979e-29d7f77e156d", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e84da111-7c0e-4855-a542-4fb8223e7d9f", "name": "Update billing details (address, VAT, billing contact) on the linked customer account", "request": { "name": "Update billing details (address, VAT, billing contact) on the linked customer account", "description": {}, "url": { "path": [ "api", "v1", "customer", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"vatNumber\": \"\",\n \"billingAddress\": \"\",\n \"billingCity\": \"\",\n \"billingProvince\": \"\",\n \"billingPostal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "69c2e0f6-0e11-42fb-8130-193967661a2a", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"vatNumber\": \"\",\n \"billingAddress\": \"\",\n \"billingCity\": \"\",\n \"billingProvince\": \"\",\n \"billingPostal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74fe55fc-dd4b-4c8a-8011-aabc105ca908", "name": "Change my password", "request": { "name": "Change my password", "description": {}, "url": { "path": [ "api", "v1", "customer", "me", "change-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b975ebe2-7c97-4e8d-a1e7-03fcacf3abc5", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "me", "change-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15448c34-570e-416e-afed-9d4546bd5b87", "name": "Get dashboard analytics (shipments chart + KPIs)", "request": { "name": "Get dashboard analytics (shipments chart + KPIs)", "description": {}, "url": { "path": [ "api", "v1", "customer", "analytics", "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "serviceLevel", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e45c8f26-f929-434a-aeff-4c6745758501", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "analytics", "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "serviceLevel", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ff11c22-5529-48a0-8e67-9a884ebec22e", "name": "List all portal users on this account", "request": { "name": "List all portal users on this account", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6d04f8a0-23aa-4e81-bc67-21c2b9235dc7", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14dbcf50-9e3b-4a00-bde4-8803e8fc5f09", "name": "Send a portal invite to a new user", "request": { "name": "Send a portal invite to a new user", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "240df4ef-fa25-41d0-a9ab-46b04d24805f", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8aa69c6c-e5d3-48d1-ac61-49d65e64ee7a", "name": "List pending invites for this account", "request": { "name": "List pending invites for this account", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "users", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9994efd4-2632-4d19-987f-5d2ce40f3785", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "users", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4dbe4618-43fc-4d7e-a070-25f9f2dab404", "name": "Revoke a pending invite", "request": { "name": "Revoke a pending invite", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "users", "invites", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a9867edc-c49e-409f-8acd-e5e31c1cd0c5", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "users", "invites", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2019cd4d-3bbf-4033-a070-a2b1a90fd4e2", "name": "Update a portal user role, permissions or cost centre", "request": { "name": "Update a portal user role, permissions or cost centre", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "PATCH", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e2fc1bd-f2ef-47ac-8834-0875414f4f4d", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb5ab41b-cf41-4e8f-acf6-b4e3e46a10e5", "name": "Remove a portal user from this account", "request": { "name": "Remove a portal user from this account", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3c8fce28-9514-4a47-a654-a7484e906cf7", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3671d7d5-0d19-4fa0-a869-b13c51050d2f", "name": "List cost centres for this account", "request": { "name": "List cost centres for this account", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "cost-centres" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7b03970-ee0e-4de3-8346-48bdb6e03bc0", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "cost-centres" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03d0443e-134b-4f71-ae60-b8b38e547a9b", "name": "Create a cost centre", "request": { "name": "Create a cost centre", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "cost-centres" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6405edc3-3939-4715-ab36-cf6bc6a49b0f", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "cost-centres" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "570afba1-65b5-4f5a-84f7-312c86771e8c", "name": "Update a cost centre", "request": { "name": "Update a cost centre", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "cost-centres", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "PATCH", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bbc1c572-dbfc-4f91-b7a1-b5322c7f0c5c", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "cost-centres", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d54cb79e-d055-404e-b3f3-b3cfa5004d9c", "name": "Delete or deactivate a cost centre", "request": { "name": "Delete or deactivate a cost centre", "description": {}, "url": { "path": [ "api", "v1", "customer", "account", "cost-centres", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "20860975-429f-4a24-b6ea-c2475b94cc4e", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "account", "cost-centres", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "API keys & webhooks", "description": "Manage integration credentials and event subscriptions", "item": [ { "id": "e9cb07cc-8045-43b5-9c0f-a5057863e473", "name": "List my API keys (masked)", "request": { "name": "List my API keys (masked)", "description": {}, "url": { "path": [ "api", "v1", "customer", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ab91b65-59c0-4f8d-aab1-5970f8fc41df", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15516119-2990-429c-8e48-4da4a5bb4d2a", "name": "Create an API key — returns raw key once", "request": { "name": "Create an API key — returns raw key once", "description": {}, "url": { "path": [ "api", "v1", "customer", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "317af9e9-5dd1-489b-b2ad-793a46640cee", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7efeb00a-21b7-4432-83cc-1bddb61c497f", "name": "Revoke an API key", "request": { "name": "Revoke an API key", "description": {}, "url": { "path": [ "api", "v1", "customer", "api-keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6019b61e-3c40-43b8-963b-f48d5c035e77", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "api-keys", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d86ac9e-47d4-41cf-986e-198acdf135cc", "name": "List my webhooks", "request": { "name": "List my webhooks", "description": {}, "url": { "path": [ "api", "v1", "customer", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2f0aa3d5-21fa-4471-90dd-23b0630d9046", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96effa63-d8d5-4ca9-a46f-34b8acd9261b", "name": "Create a webhook", "request": { "name": "Create a webhook", "description": {}, "url": { "path": [ "api", "v1", "customer", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ffb0540-941f-48af-883d-4faf7527c2c5", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eeb37920-7d6e-45ac-ae48-e52b6e3dfba1", "name": "Update a webhook (url, events, isActive)", "request": { "name": "Update a webhook (url, events, isActive)", "description": {}, "url": { "path": [ "api", "v1", "customer", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "PATCH", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "de59d4b8-9326-48c7-a065-5a9302306ccf", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8f7708e-8e33-4fc3-ad5a-3c75c148cd0c", "name": "Delete a webhook", "request": { "name": "Delete a webhook", "description": {}, "url": { "path": [ "api", "v1", "customer", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "35af9db0-1f0a-4312-9846-a508e4d17810", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c023630b-584b-4db8-b8b3-7cb18453ddb3", "name": "Get last 100 delivery attempts for a webhook", "request": { "name": "Get last 100 delivery attempts for a webhook", "description": {}, "url": { "path": [ "api", "v1", "customer", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4d5e28a5-4747-4f96-951e-0f87ce781086", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05300c4e-9bc0-40d8-bc9d-6512d7be1d27", "name": "Send a test event to a webhook", "request": { "name": "Send a test event to a webhook", "description": {}, "url": { "path": [ "api", "v1", "customer", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "365743bf-6baa-447b-bad5-ab5f9b06b9bc", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Portal settings", "description": "Branding, shipment defaults and notification preferences", "item": [ { "id": "a6e6c5f2-afbf-4882-b59f-1d0de1272835", "name": "Get portal general settings + logo URL", "request": { "name": "Get portal general settings + logo URL", "description": {}, "url": { "path": [ "api", "v1", "customer", "settings", "general" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "214965a6-91af-49b6-8042-f657d4b370fa", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "settings", "general" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73bb59f5-0b6f-47f1-80b2-56a6b840421b", "name": "Update portal general settings (toggles + custom label)", "request": { "name": "Update portal general settings (toggles + custom label)", "description": {}, "url": { "path": [ "api", "v1", "customer", "settings", "general" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"requireShipmentApproval\": \"\",\n \"autoAddAddresses\": \"\",\n \"hideCollectionDetails\": \"\",\n \"autoRemoveTrackingInfo\": \"\",\n \"customTrackingRefLabel\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ecf35c18-01ef-4f2b-b86e-4ae28b7713c7", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "settings", "general" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"requireShipmentApproval\": \"\",\n \"autoAddAddresses\": \"\",\n \"hideCollectionDetails\": \"\",\n \"autoRemoveTrackingInfo\": \"\",\n \"customTrackingRefLabel\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc4c77fc-1889-42f9-a034-0b933ab46ff0", "name": "Upload company logo (PNG/JPG/WebP, max 2 MB)", "request": { "name": "Upload company logo (PNG/JPG/WebP, max 2 MB)", "description": {}, "url": { "path": [ "api", "v1", "customer", "settings", "general", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e9e8a0a1-d999-4a38-b2f2-0a7d36b204c4", "name": "201", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "settings", "general", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b3d47e1-7aca-4517-aab2-ddca10ae64f5", "name": "Delete company logo", "request": { "name": "Delete company logo", "description": {}, "url": { "path": [ "api", "v1", "customer", "settings", "general", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "93d808b4-b09c-443d-8243-99749dee7a3c", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "settings", "general", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06b6b96e-8fc5-4a77-be29-4e2bbd9c34d0", "name": "Get portal shipment settings", "request": { "name": "Get portal shipment settings", "description": {}, "url": { "path": [ "api", "v1", "customer", "settings", "shipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d24622d7-0ea8-4f2e-ba35-57f19537d461", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "settings", "shipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db9346a4-cfc7-4599-a252-356e84f8eed3", "name": "Update portal shipment settings", "request": { "name": "Update portal shipment settings", "description": {}, "url": { "path": [ "api", "v1", "customer", "settings", "shipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "PATCH", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "616392f1-b2b0-4cc2-af13-fdc5ca778e17", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "settings", "shipments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "571e29cb-8cee-4120-b6a7-737c4a805806", "name": "Get my notification preferences", "request": { "name": "Get my notification preferences", "description": {}, "url": { "path": [ "api", "v1", "customer", "notification-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "226186cc-3c5f-4c2f-9c84-70aa3193ef97", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "notification-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3966fdee-36c7-469a-946d-37df563e01cd", "name": "Update my notification preferences", "request": { "name": "Update my notification preferences", "description": {}, "url": { "path": [ "api", "v1", "customer", "notification-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a9f55d16-f553-4184-a645-2def3a7e6d1b", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "notification-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Public (no key needed)", "description": "Unauthenticated tenant branding and invite endpoints", "item": [ { "id": "0a4661ba-94f8-4999-9f5d-364ef70e1b89", "name": "Get tenant branding config for the customer portal login screen", "request": { "name": "Get tenant branding config for the customer portal login screen", "description": {}, "url": { "path": [ "api", "v1", "public", ":tenantSlug", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tenantSlug", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0c40530b-9b80-4d4f-b780-e646a6d97616", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "public", ":tenantSlug", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tenantSlug" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "833c6566-5c4b-457d-b59e-0d83105231c1", "name": "Get invite details (public — for the accept invite page)", "request": { "name": "Get invite details (public — for the accept invite page)", "description": {}, "url": { "path": [ "api", "v1", "customer", "invite", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db5f480d-e832-4018-b0d5-cb6293ec5252", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "invite", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ef9978c-c240-4fa6-805c-6e7a83657d99", "name": "Accept an invite and create an account", "request": { "name": "Accept an invite and create an account", "description": {}, "url": { "path": [ "api", "v1", "customer", "invite", ":token", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "14b78b49-bd48-4f4f-8672-4fca35ccb59a", "name": "200", "originalRequest": { "url": { "path": [ "api", "v1", "customer", "invite", ":token", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.parcelops.co.za/api/v1" } ], "info": { "_postman_id": "5116bd36-07a7-40ce-92d5-77c97416103a", "name": "ParcelOps Customer API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The ParcelOps customer integration API: quote, book, track and pull documents for your own shipments, plus webhooks for live status pushes. Base URL: `https://api.parcelops.co.za/api/v1`.\n\n# Authentication\n\nAuthenticate every request with an API key sent as a Bearer token:\n\n```\nAuthorization: Bearer po_your_api_key\n```\n\nGenerate keys under **Integrations → API Keys** in your customer portal. A key acts as the customer account it belongs to — it sees that account's shipments, invoices and documents, and nothing else. Keys can be revoked there at any time.\n\n# Errors\n\nStandard HTTP status codes with a JSON body. `400` carries a descriptive validation message, `401` means a missing or revoked key, `403` means the key's account may not see that resource, `404` an unknown resource. Timestamps are ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).\n\n# Shipment statuses\n\nA shipment's `status` walks this lifecycle:\n\n| Status | Meaning |\n|---|---|\n| `CREATED` | Booked, not yet collected |\n| `COLLECTION_ASSIGNED` | A driver is assigned to collect |\n| `COLLECTED` | Picked up from the sender |\n| `CHECKED_IN` / `AT_HUB` | Received and scanned at a hub |\n| `IN_TRANSIT` | Moving between hubs on a manifest |\n| `AT_DESTINATION_HUB` | At the hub nearest the recipient |\n| `OUT_FOR_DELIVERY` | On a vehicle for final delivery |\n| `DELIVERED` | Delivered, POD captured |\n| `FAILED_DELIVERY` | An attempt failed (reason recorded) |\n| `REDELIVERY_SCHEDULED` | A new attempt is scheduled |\n| `RETURNED_TO_HUB` / `RETURNED_TO_SENDER` | Coming back |\n| `HELD` / `LOST` / `CANCELLED` | Exceptions |\n\n# Webhooks\n\nSubscribe under **Integrations → Webhooks** in the portal and ParcelOps POSTs events to your endpoint as they happen: `shipment.collected`, `shipment.out_for_delivery`, `shipment.delivered`, `shipment.failed_delivery`, `invoice.issued`, `invoice.paid`.\n\nEvery delivery is signed — `X-Parcelops-Signature` is `sha256=` keyed with your endpoint secret — and carries a unique `X-Parcelops-Delivery-Id` for deduplication. Respond 2xx within 15 seconds; failures retry five times with exponential backoff starting at one minute.\n\nContact Support:\n Name: ParcelOps\n Email: api@parcelops.co.za", "type": "text/plain" } } }