{"info":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","description":"

Scope

\n

The Drayup API is designed to streamline booking processes, enhance the functionality of third party applications and improve the overall user experience of these applications.

\n

This API provides efficient booking management, comprehensive yard location and equipment information, and access to booking invoices. Developers can therefore provide a more efficient user experience for their applications by optimizing their booking processes using this documentation.

\n

Getting Started

\n

In order to take full advantage of the Drayup API, users must follow these essential steps:

\n

Account Creation

\n

Start by creating an account through drayup.com. This account will serve as your gateway to access the features and functionality of the API.

\n\n\n

Access Token

\n

After creating your account, you will need to obtain an access token. This token acts as a secure key that grants your application permission to interact with the API. Detailed instructions on how to obtain and manage access tokens can be found in our API Settings section.

\n

Payment Information

\n

To facilitate seamless booking and payment processes, you must add your credit card information from the My Account page. This will ensure that you can successfully complete transactions and take full advantage of our services.

\n\n\n

By following these steps, you'll be well prepared to integrate the Drayup API into your application and make the most of its capabilities.

\n

API Settings

\n\n\n\n\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Scope","slug":"scope"},{"content":"Getting Started","slug":"getting-started"},{"content":"API Settings","slug":"api-settings"}],"owner":"25666392","collectionId":"5e73153a-e708-40d1-9b6a-f3183299ecd8","publishedId":"2sA3rxru6F","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"d02a48"},"publishDate":"2024-09-28T21:48:36.000Z"},"item":[{"name":"Locations","item":[{"name":"Get location list","event":[{"listen":"test","script":{"id":"62e3ce80-32d3-4702-9b86-236d53b0cb50","exec":["\r","pm.test(\"Response status code is 200\", function () {\r"," pm.expect(pm.response.code).to.equal(200);\r","});\r","\r","\r","pm.test(\"Response content type is application/json\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\r","});\r","\r","pm.test(\"Each object in the 'data' array has the required fields - key and name\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('array').that.is.not.empty;\r","\r"," responseData.forEach(function(location) {\r"," pm.expect(location).to.be.an('object');\r"," pm.expect(location).to.have.property('key');\r"," pm.expect(location).to.have.property('name');\r"," });\r","});\r","\r","\r","pm.test(\"Key and name fields are non-empty strings\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('array').that.is.not.empty;\r"," responseData.forEach(function(item) {\r"," pm.expect(item.key).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Key should not be empty\");\r"," pm.expect(item.name).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Name should not be empty\");\r"," });\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"1690ac4e-55f5-4169-ae62-fae07c350c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://drayup.com/api/v1/locations","description":"

Description

\n

This API endpoint allows users to retrieve a list of available locations.

\n","urlObject":{"path":["locations"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4c52024b-b3dd-4caf-a83d-02e3a847e2a4","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"729"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:44:15 GMT"},{"key":"ETag","value":"\"87g5joqcz9k9\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"key\": \"MjQ3OTl8MTV8MzE0MDh8MjM2\",\n \"city\": \"Garden City\"\n }\n ]\n}"}],"_postman_id":"1690ac4e-55f5-4169-ae62-fae07c350c89"},{"name":"Get equipments by location key","event":[{"listen":"test","script":{"id":"fe5f9bff-47f8-4945-95a4-a14df465dec0","exec":["pm.test(\"Response status code is 200\", function() {\r"," pm.expect(pm.response.code).to.equal(200);\r","});\r","\r","\r","pm.test(\"Response has the required fields - id and name\", function() {\r"," const responseData = pm.response.json();\r","\r"," pm.expect(responseData).to.be.an('array');\r"," responseData.forEach(function(item) {\r"," pm.expect(item).to.have.property('id');\r"," pm.expect(item).to.have.property('name');\r"," });\r","});\r","\r","\r","pm.test(\"ID is a non-negative integer\", function() {\r"," const responseData = pm.response.json();\r","\r"," pm.expect(responseData).to.be.an('array');\r"," responseData.forEach(function(item) {\r"," pm.expect(item.id).to.be.a('number').and.to.be.at.least(0, \"ID should be a non-negative integer\");\r"," });\r","});\r","\r","\r","pm.test(\"Name is a non-empty string\", function() {\r"," const responseData = pm.response.json();\r","\r"," pm.expect(responseData).to.be.an('array');\r"," responseData.forEach(function(item) {\r"," pm.expect(item.name).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Name should not be empty\");\r"," });\r","});\r","\r","\r","pm.test(\"Content-Type header is application/json\", function() {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"1786b1d5-89cd-4d38-a522-e330eafb4952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://drayup.com/api/v1/locations/:locationKey/equipments","description":"

Description

\n

This API endpoint allows users to retrieve a list of equipment for a specific location, identified by the locationKey parameter.

\n

Notes

\n\n","urlObject":{"path":["locations",":locationKey","equipments"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(required) Unique identifier of the location for which you want to retrieve equipment

\n","type":"text/plain"},"type":"any","value":"","key":"locationKey"}]}},"response":[{"id":"cc9fe56c-9f27-481a-a929-8c190954eb7a","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/locations/:locationKey/equipments","host":["https://drayup.com/api/v1"],"path":["locations",":locationKey","equipments"],"variable":[{"key":"locationKey","value":"","description":"(required) Unique identifier of the location for which you want to retrieve equipment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"499"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:45:29 GMT"},{"key":"ETag","value":"\"qlapyepnvadv\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"equipments\": [\n {\n \"id\": 1,\n \"name\": \"Container/Chassis 20'/40'/45'\"\n },\n {\n \"id\": 2,\n \"name\": \"Container/Chassis 45'\"\n },\n {\n \"id\": 3,\n \"name\": \"Container/Chassis 53'\"\n }\n ],\n \"totalResults\": 3\n}"},{"id":"a506a06f-b5bc-43f4-88a0-974d09ac8d7f","name":"422 Unprocessable Entity","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/locations/:locationKey/equipments","host":["https://drayup.com/api/v1"],"path":["locations",":locationKey","equipments"],"variable":[{"key":"locationKey","value":"","description":"(required) Unique identifier of the location for which you want to retrieve equipment"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"219"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:46:41 GMT"},{"key":"ETag","value":"\"1txi0sx1xl63\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"Validation Error\",\n \"status\": 422,\n \"errors\": [\n {\n \"code\": \"LocationKey\",\n \"description\": \"Invalid location key. It must be one of valid location key.\",\n \"type\": 1\n }\n ]\n}"}],"_postman_id":"1786b1d5-89cd-4d38-a522-e330eafb4952"}],"id":"4749aa48-8e2f-43f7-9069-58639be85e9c","_postman_id":"4749aa48-8e2f-43f7-9069-58639be85e9c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}},{"name":"Yards","item":[{"name":"Get yard list","event":[{"listen":"test","script":{"id":"782109d3-cf43-40ca-9fff-7f3a27966dc1","exec":["\r","pm.test(\"Response status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","\r","pm.test(\"ID is a non-negative integer\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData.data).to.be.an('array');\r"," responseData.data.forEach(function(yard) {\r"," pm.expect(yard.id).to.be.a('number').and.to.be.at.least(0);\r"," });\r","});\r","\r","\r","pm.test(\"Latitude and Longitude are within valid ranges\", function () {\r"," const responseData = pm.response.json().data;\r"," \r"," responseData.forEach(function(yard) {\r"," pm.expect(yard.lat).to.be.within(-90, 90);\r"," pm.expect(yard.lng).to.be.within(-180, 180);\r"," });\r","});\r","\r","\r","pm.test(\"Data array is present and contains at least one element\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData.data).to.exist.and.to.be.an('array').that.is.not.empty;\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"2ab50bc1-e4dc-4c12-83d6-afc558215a41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://drayup.com/api/v1/yards","description":"

Description

\n

This API endpoint allows users to retrieve a list of yards.

\n","urlObject":{"path":["yards"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"508761fc-cca7-48e2-9dc9-32163e4e5aab","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/yards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:47:59 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"\"sqeovqbbps1zr\""},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"yards\": [\n {\n \"id\": 1,\n \"name\": \"Telfair\",\n \"location\": \"Garden City, GA, 31408, US\",\n \"address\": \"2811 Us Highway 80 West Savannah\",\n \"zipCode\": \"31408\",\n \"city\": \"Garden City\",\n \"state\": \"Georgia\",\n \"lat\": 32.09108118,\n \"lng\": -81.186706502\n }\n ]\n}"}],"_postman_id":"2ab50bc1-e4dc-4c12-83d6-afc558215a41"}],"id":"bfa3fdd8-ed68-475b-b0d3-a289e34f2b4e","_postman_id":"bfa3fdd8-ed68-475b-b0d3-a289e34f2b4e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}},{"name":"Profile","item":[{"name":"Get payment method list","event":[{"listen":"test","script":{"id":"7c3cce07-e481-4326-9e23-ec7a1a77d722","exec":["\r","pm.test(\"Response status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","\r","pm.test(\"Type is a non-empty string\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('array');\r"," responseData.forEach(function(item) {\r"," pm.expect(item.type).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Type should be a non-empty string\");\r"," });\r","});\r","\r","\r","pm.test(\"Brand is a non-empty string\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('array');\r"," responseData.forEach(function(paymentMethod) {\r"," pm.expect(paymentMethod.brand).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Brand should not be empty\");\r"," });\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"2598d90f-a0d9-45b5-9474-d37c52c72fad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/profiles/payment-methods","description":"

Description

\n

This API endpoint allows users to retrieve the payment methods they have added to their user profile.

\n

Notes

\n\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["profiles","payment-methods"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4f5f559f-4251-40fd-b0e8-13a4d4d816fb","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/profiles/payment-methods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"234"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:48:55 GMT"},{"key":"ETag","value":"\"med837rm216i\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethods\": [\n {\n \"id\": 12,\n \"type\": \"Credit Card\",\n \"expireDate\": \"2026-12-01T00:00:00\",\n \"brand\": \"discover\",\n \"last4\": \"9424\"\n }\n ],\n \"totalResults\": 1\n}"},{"id":"382a5d74-5b44-48d9-b8f3-5ff2ffd8e6be","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/profiles/payment-methods"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:04:59 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"}],"_postman_id":"2598d90f-a0d9-45b5-9474-d37c52c72fad"}],"id":"9856743b-53bd-40a9-93e6-3c8739604551","_postman_id":"9856743b-53bd-40a9-93e6-3c8739604551","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}},{"name":"Bookings","item":[{"name":"Get booking list","event":[{"listen":"test","script":{"id":"1154a08e-e505-4c67-87f7-a5d733884515","exec":["\r","pm.test(\"Response status code is 200\", function () {\r"," pm.expect(pm.response.code).to.equal(200);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"4623b321-ddeb-4b65-a149-b3321c9a4e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings","description":"

Description

\n

This API endpoint allows users to retrieve a list of previously created bookings for any yard.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • The isActive, itemsPerPage, page and search parameters are optional and can be utilized for filtering and pagination purposes.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings"],"host":["https://drayup.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

(optional, default: true) Filter bookings based on their active status.

\n","type":"text/plain"},"key":"isActive","value":""},{"disabled":true,"description":{"content":"

(optional, default: 5) Number of items to be displayed per page.

\n","type":"text/plain"},"key":"itemsPerPage","value":""},{"disabled":true,"description":{"content":"

(optional, default: 1) Page number for pagination.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

(optional, default: null) Search term to filter bookings.

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"f95829d6-5bb4-49c4-baff-d5fe4e1720a2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings","host":["https://drayup.com/api/v1"],"path":["bookings"],"query":[{"key":"isActive","value":"","description":"(optional, default: true) Filter bookings based on their active status.","disabled":true},{"key":"itemsPerPage","value":"","description":"(optional, default: 5) Number of items to be displayed per page.","disabled":true},{"key":"page","value":"","description":"(optional, default: 1) Page number for pagination.","disabled":true},{"key":"search","value":"","description":"(optional, default: null) Search term to filter bookings.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"905"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:50:19 GMT"},{"key":"ETag","value":"\"bvjwviv6o2p5\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"bookings\": [\n {\n \"id\": 1,\n \"code\": \"24300002\",\n \"checkIn\": \"2024-07-26T00:00:00\",\n \"checkOut\": \"2024-07-29T00:00:00\",\n \"nextPaymentDate\": \"0001-01-01T00:00:00\",\n \"type\": \"One-Time\",\n \"status\": \"Confirmed\",\n \"equipmentType\": \"Container/Chassis 20'/40'/45'\",\n \"paymentMethod\": {\n \"brand\": \"discover\",\n \"last4\": \"9424\"\n },\n \"paymentStatus\": \"Confirmed\",\n \"space\": 2,\n \"usedSpace\": 0,\n \"invoiceTerm\": 1,\n \"isPinCodeUsed\": false,\n \"createdDate\": \"2024-07-23T08:28:15.6708045\",\n \"yard\": {\n \"id\": 1,\n \"name\": \"Telfair\"\n }\n }\n ],\n \"totalResults\": 1\n}"},{"id":"f113abf6-cbc0-4e40-bc9b-e8c97fcf4f68","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings","host":["https://drayup.com/api/v1"],"path":["bookings"],"query":[{"key":"isActive","value":"","description":"(optional, default: true) Filter bookings based on their active status.","disabled":true},{"key":"itemsPerPage","value":"","description":"(optional, default: 5) Number of items to be displayed per page.","disabled":true},{"key":"page","value":"","description":"(optional, default: 1) Page number for pagination.","disabled":true},{"key":"search","value":"","description":"(optional, default: null) Search term to filter bookings.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"264"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:50:45 GMT"},{"key":"ETag","value":"\"61wql6megc7c\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"Bad Request\",\n \"status\": 400,\n \"detail\": \"2 request error(s) occurred.\",\n \"errors\": [\n {\n \"key\": \"page\",\n \"errorMessage\": \"The value '' is invalid.\"\n },\n {\n \"key\": \"isActive\",\n \"errorMessage\": \"The value '' is invalid.\"\n }\n ]\n}"},{"id":"24d50067-c170-4e7c-95c2-b96aa14338ac","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings","host":["https://drayup.com/api/v1"],"path":["bookings"],"query":[{"key":"isActive","value":"","description":"(optional, default: true) Filter bookings based on their active status.","disabled":true},{"key":"itemsPerPage","value":"","description":"(optional, default: 5) Number of items to be displayed per page.","disabled":true},{"key":"page","value":"","description":"(optional, default: 1) Page number for pagination.","disabled":true},{"key":"search","value":"","description":"(optional, default: null) Search term to filter bookings.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:06:08 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"}],"_postman_id":"4623b321-ddeb-4b65-a149-b3321c9a4e12"},{"name":"Get booking by code","id":"39ef79f7-d7bb-45dd-9090-96ccc4113798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings/:bookingCode","description":"

Description

\n

This API endpoint enables users to retrieve a specific booking, identified by the :bookingCode parameter.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Please be advised that a valid :bookingCode is required in the URL to retrieve the booking details for a specific booking.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings",":bookingCode"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"bookingCode"}]}},"response":[{"id":"5d6dd518-5821-49e2-b3c3-e622eab4d75f","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode"],"variable":[{"key":"bookingCode","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"451"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:52:58 GMT"},{"key":"ETag","value":"\"14j73glbqc3cj\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"booking\": {\n \"id\": 1,\n \"code\": \"24300002\",\n \"checkIn\": \"2024-07-26T00:00:00\",\n \"checkOut\": \"2024-07-29T00:00:00\",\n \"nextPaymentDate\": \"0001-01-01T00:00:00\",\n \"type\": \"One-Time\",\n \"status\": \"Confirmed\",\n \"equipmentType\": \"Container/Chassis 20'/40'/45'\",\n \"paymentMethod\": {\n \"brand\": \"discover\",\n \"last4\": \"9424\"\n },\n \"paymentStatus\": \"Confirmed\",\n \"space\": 2,\n \"usedSpace\": 0,\n \"invoiceTerm\": 1,\n \"isPinCodeUsed\": false,\n \"createdDate\": \"2024-07-23T08:28:15.6708045\",\n \"yard\": {\n \"id\": 1,\n \"name\": \"Telfair\"\n }\n }\n}"},{"id":"64ab63cd-0d38-4702-929f-8f55eed9a054","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:06:37 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"},{"id":"7cd6bf29-8bf3-474d-a41b-1d9090822a29","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode"],"variable":[{"key":"bookingCode","value":"24300003"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"188"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:58:00 GMT"},{"key":"ETag","value":"\"10uisqmmhqb58\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"errors\": [\n {\n \"code\": \"BookingNotFound\",\n \"description\": \"Booking code 24300003 not found\",\n \"type\": 2\n }\n ]\n}"},{"id":"46c6d446-c2c1-4f5d-b11a-2af22e57f1fe","name":"422 Unprocessable Entity","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"194"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:52:32 GMT"},{"key":"ETag","value":"\"16r2uu5hukb5e\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"Validation Error\",\n \"status\": 422,\n \"errors\": [\n {\n \"code\": \"BookingCode\",\n \"description\": \"Booking number should be 8 digits.\",\n \"type\": 1\n }\n ]\n}"}],"_postman_id":"39ef79f7-d7bb-45dd-9090-96ccc4113798"},{"name":"Get booking's equipment list","id":"2ab95505-942c-4471-83f3-52f97eb2ffd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings/:bookingCode/equipments","description":"

Description

\n

This API endpoint allows users to retrieve the equipment list associated with a specific booking, identified by the :bookingCode parameter.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Please be advised that a valid :bookingCode is required in the URL to retrieve the equipment list for a specific booking.

    \n
    • \n

  • The search and status parameters are optional and can be used for filtering.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings",":bookingCode","equipments"],"host":["https://drayup.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

(optional) Search term to filter equipments.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

(optional) Filter equipments based on their status.

\n","type":"text/plain"},"key":"status","value":""}],"variable":[{"type":"any","value":"","key":"bookingCode"}]}},"response":[{"id":"ab6072da-77fb-481e-a4c7-6b515fbfd30f","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/equipments","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","equipments"],"query":[{"key":"search","value":"","description":"(optional) Search term to filter equipments.","disabled":true},{"key":"status","value":"","description":"(optional) Filter equipments based on their status.","disabled":true}],"variable":[{"key":"bookingCode","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:07:41 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"},{"id":"3506dacb-65a6-482f-bb28-352c1b53ff55","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/equipments","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","equipments"],"query":[{"key":"search","value":"","description":"(optional) Search term to filter equipments.","disabled":true},{"key":"status","value":"","description":"(optional) Filter equipments based on their status.","disabled":true}],"variable":[{"key":"bookingCode","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"225"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 13:57:05 GMT"},{"key":"ETag","value":"\"ylkz0pmgnv69\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"errors\": [\n {\n \"code\": \"EquipmentsNotFound\",\n \"description\": \"No booking equipments found for the given booking number 24300002\",\n \"type\": 2\n }\n ]\n}"}],"_postman_id":"2ab95505-942c-4471-83f3-52f97eb2ffd6"},{"name":"Get booking's invoice list","id":"4444c8c0-0e6f-4f94-9011-84e11fe7150a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings/:bookingCode/invoices","description":"

Description

\n

This API endpoint allows users to retrieve the invoice list associated with a specific booking, identified by the :bookingCode parameter.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Please be advised that a valid :bookingCode is required in the URL to retrieve the invoice list for a specific booking.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings",":bookingCode","invoices"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"bookingCode"}]}},"response":[{"id":"358690c9-f527-4d03-b271-4bb26c57ed26","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/invoices","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","invoices"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:11:55 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"},{"id":"a7e3b507-65f1-4b55-a566-43d3c6325279","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/invoices","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","invoices"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"212"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:11:30 GMT"},{"key":"ETag","value":"\"eb8z89na8g5w\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"errors\": [\n {\n \"code\": \"InvoiceNotFound\",\n \"description\": \"No invoices found for the given booking number 24180002\",\n \"type\": 2\n }\n ]\n}"}],"_postman_id":"4444c8c0-0e6f-4f94-9011-84e11fe7150a"},{"name":"Get booking cancellation reasons","id":"89c31495-3b4b-4e5f-be18-5eef0e4cdc3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings/cancel-reasons","description":"

Description

\n

This API endpoint enables the retrieval of a list of reasons for cancellations of bookings.

\n

Notes

\n
    \n
  • Please ensure that you have the necessary authentication and authorization to access this endpoint.
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings","cancel-reasons"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"346599fc-e6ca-4e99-89e7-8773ce7bce5b","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings/cancel-reasons"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"242"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:13:24 GMT"},{"key":"ETag","value":"\"i2d7cj2k9z6q\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"reasons\": [\n {\n \"id\": 3,\n \"name\": \"High Price\",\n \"description\": \"High Price\"\n },\n {\n \"id\": 4,\n \"name\": \"Operational Change\",\n \"description\": \"Operational Change\"\n },\n {\n \"id\": 5,\n \"name\": \"Poor Service\",\n \"description\": \"Poor Service\"\n }\n ]\n}"},{"id":"78db8c17-4818-45c3-bae8-1e5c097aee07","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/bookings/cancel-reasons"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:13:08 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"}],"_postman_id":"89c31495-3b4b-4e5f-be18-5eef0e4cdc3a"},{"name":"Update booking's payment method","id":"bf13edb0-5ed0-4443-b25b-1d897245f3fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentMethodId\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://drayup.com/api/v1/bookings/:bookingCode/payment-method","description":"

Description

\n

This API endpoint enables users to modify the designated payment method for a particular booking by entering the bookingCode and paymentMethodId.

\n

Notes

\n
    \n

  • Make sure you have the necessary authentication and authorization to access that endpoint.

    \n
    • \n

  • Please be advised that a valid :bookingCode is required in the URL to retrieve the invoice list for a specific booking.

    \n
    • \n

  • Please be advised that a valid :paymentMethodId is required in the request body to retrieve the invoice list for a specific booking.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings",":bookingCode","payment-method"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"bookingCode"}]}},"response":[{"id":"ac2f2237-1f1b-41e1-a791-00658efab2d6","name":"200 OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentMethodId\" : 363\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/payment-method","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","payment-method"],"variable":[{"key":"bookingCode","value":"24310002"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"164"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:42:35 GMT"},{"key":"ETag","value":"\"11u2ybubvxw4k\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"updatedPaymentMethodId\": 363,\n \"updatedPaymentMethodName\": \"visa ending in 5556\",\n \"bookingCode\": \"24310002\",\n \"isSuccess\": true,\n \"updatedAt\": \"2024-07-28T15:42:35.4679096Z\"\n}"},{"id":"610aeba7-0654-4398-a536-90a6eb9de16a","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentMethodId\" : 363\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/payment-method","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","payment-method"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:14:41 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"},{"id":"30b80a48-6aa5-4ab0-8edc-6a879e85019e","name":"500 Internal Server Error","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentMethodId\" : 363\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/payment-method","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","payment-method"],"variable":[{"key":"bookingCode","value":"24300002"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"330"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:16:03 GMT"},{"key":"ETag","value":"\"jj6a8o3msv96\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.6.1\",\n \"title\": \"Error\",\n \"status\": 500,\n \"errors\": [\n {\n \"code\": \"PaymentMethodUpdateFailure\",\n \"description\": \"An unexpected problem occurred while updating payment method with Id 363 of the booking number 24300002 : You cannot change the payment method for one-time bookings..\",\n \"type\": 0\n }\n ]\n}"}],"_postman_id":"bf13edb0-5ed0-4443-b25b-1d897245f3fe"},{"name":"Cancel booking by booking code","id":"2b711dc9-ecf2-4c12-8077-d9b3ca456184","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"reasonId\" : 3\r\n}","options":{"raw":{"language":"json"}}},"url":"https://drayup.com/api/v1/bookings/:bookingCode/cancel","description":"

Description

\n

This API endpoint enables the cancellation of a specific reservation, identified by the :bookingCode parameter, with a reasonId.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Please be advised that a valid :bookingCode is required in the URL to cancel a specific booking.

    \n
    • \n

  • Please be advised that a valid :reasonId is required in the request body to cancel a specific booking.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["bookings",":bookingCode","cancel"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"bookingCode"}]}},"response":[{"id":"1ca068d2-3a70-49a7-bdcc-413a3adeec0a","name":"200 OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"reasonId\" : 3\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/cancel","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","cancel"],"variable":[{"key":"bookingCode","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"110"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:40:34 GMT"},{"key":"ETag","value":"\"7g2s7mnvru32\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"booking\": {\n \"id\": 473,\n \"code\": \"24310001\",\n \"status\": \"Confirmed\",\n \"paymentStatus\": \"Received\"\n },\n \"reason\": \"High Price\"\n}"},{"id":"41e786d6-593f-4df3-8933-80e5b9621b49","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"reasonId\" : 3\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/cancel","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","cancel"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:17:57 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"},{"id":"4eed33c5-73c9-4faf-bb47-c43b23acd1e5","name":"500 Internal Server Error","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"reasonId\" : 3\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://drayup.com/api/v1/bookings/:bookingCode/cancel","host":["https://drayup.com/api/v1"],"path":["bookings",":bookingCode","cancel"],"variable":[{"key":"bookingCode","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"334"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Jul 2024 14:19:20 GMT"},{"key":"ETag","value":"\"15yq8atkj499a\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.6.1\",\n \"title\": \"Error\",\n \"status\": 500,\n \"errors\": [\n {\n \"code\": \"Cancellation Failure\",\n \"description\": \"An unexpected problem occurred while canceling the booking number 24300002 : This booking (24300002) can not be cancelled in 24 hours. Please contact Drayup Customer Services..\",\n \"type\": 0\n }\n ]\n}"}],"_postman_id":"2b711dc9-ecf2-4c12-8077-d9b3ca456184"}],"id":"07f62b65-c8f5-4adc-89d8-0078e25499dd","_postman_id":"07f62b65-c8f5-4adc-89d8-0078e25499dd","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}},{"name":"Equipments","item":[{"name":"Get equipment list","id":"e46e409e-7e6f-4a17-a566-3f9826270176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments","description":"

Description

\n

This API endpoint enables the retrieval of the equipment list for all created bookings.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Please note that the isActive, search, equipmentType, page, and itemsPerPage parameters are optional and can be used for filtering and pagination purposes.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["equipments"],"host":["https://drayup.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

(optional, default: true) Filter equipments based on their active status.

\n","type":"text/plain"},"key":"isActive","value":""},{"disabled":true,"description":{"content":"

(optional, default: null) Search term to filter equipments.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

(optional, default: null) Filter equipments based on their type.

\n","type":"text/plain"},"key":"equipmentType","value":""},{"disabled":true,"description":{"content":"

(optional, default: 1) Page number for pagination.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

(optional, default: 5) Number of items to be displayed per page.

\n","type":"text/plain"},"key":"itemsPerPage","value":""}],"variable":[]}},"response":[{"id":"3c664a87-a26b-453a-89c0-b41dd49ebbac","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/equipments","host":["https://drayup.com/api/v1"],"path":["equipments"],"query":[{"key":"isActive","value":"","description":"(optional, default: true) Filter equipments based on their active status.","disabled":true},{"key":"search","value":"","description":"(optional, default: null) Search term to filter equipments.","disabled":true},{"key":"equipmentType","value":"","description":"(optional, default: null) Filter equipments based on their type.","disabled":true},{"key":"page","value":"","description":"(optional, default: 1) Page number for pagination.","disabled":true},{"key":"itemsPerPage","value":"","description":"(optional, default: 5) Number of items to be displayed per page.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"365"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:31:48 GMT"},{"key":"ETag","value":"\"oyalzhunca5\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"equipments\": [\n {\n \"id\": 36,\n \"code\": \"TLLU2337065\",\n \"booking\": {\n \"id\": 473,\n \"code\": \"24310001\"\n },\n \"equipmentType\": {\n \"id\": 1,\n \"name\": \"Container/Chassis 20'/40'/45'\"\n },\n \"location\": \"Telfair\",\n \"slot\": \"Loaded - Ground\",\n \"status\": \"Gate-In\",\n \"gateInDateTime\": \"2024-07-28T15:31:28.2156781\",\n \"pinCode\": \"C263589\",\n \"isVerified\": false,\n \"overage\": {\n \"days\": 0,\n \"amount\": 0,\n \"paidAmount\": 0\n }\n }\n ],\n \"totalResults\": 1\n}"},{"id":"0196a94d-6ae0-4c2d-83d4-98d964c3ff1d","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/equipments","host":["https://drayup.com/api/v1"],"path":["equipments"],"query":[{"key":"isActive","value":"","description":"(optional, default: true) Filter equipments based on their active status.","disabled":true},{"key":"search","value":"","description":"(optional, default: null) Search term to filter equipments.","disabled":true},{"key":"equipmentType","value":"","description":"(optional, default: null) Filter equipments based on their type.","disabled":true},{"key":"page","value":"","description":"(optional, default: 1) Page number for pagination.","disabled":true},{"key":"itemsPerPage","value":"","description":"(optional, default: 5) Number of items to be displayed per page.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:29:29 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"}],"_postman_id":"e46e409e-7e6f-4a17-a566-3f9826270176"},{"name":"Get equipment by code","id":"5d10dc6e-7686-4361-8ef0-f792d76b45b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments/:equipmentCode","description":"

Description

\n

This API endpoint allows users to retrieve equipment details by entering the :equipmentCode.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • You must provide a valid :equipmentId in the URL to get details for a specific equipment.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["equipments",":equipmentCode"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"equipmentCode"}]}},"response":[{"id":"919cbe72-86e2-49c7-a8c2-5cb8a2b8c844","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1equipment/:equipmentId","host":["https://drayup.com/api/v1equipment"],"path":[":equipmentId"],"variable":[{"key":"equipmentId","value":"12","description":"The equipment id from equipment list"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"314"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 17 Aug 2023 12:38:47 GMT"},{"key":"ETag","value":"\"p6808aupws8q\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 12,\n \"code\": \"432434\",\n \"booking\": {\n \"id\": 60,\n \"code\": \"23320002\"\n },\n \"equipmentType\": {\n \"id\": 1,\n \"name\": \"Container/Chassis (20'/40'/45')\"\n },\n \"location\": \"Savannah\",\n \"slot\": \"A1-011\",\n \"status\": \"Gate-In\",\n \"gateIn\": \"2023-08-05T22:20:05.9133955\",\n \"pinCode\": \"-\",\n \"verified\": false,\n \"overage\": {\n \"days\": 7,\n \"amount\": 77,\n \"paidAmount\": 77\n }\n }\n}"},{"id":"f9a08752-29a4-4cba-a1dc-d3d2748ad837","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/equipments/:equipmentId","host":["https://drayup.com/api/v1"],"path":["equipments",":equipmentId"],"variable":[{"key":"equipmentId","value":"","description":"The equipment id from equipment list"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"67"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Nov 2023 09:58:56 GMT"},{"key":"ETag","value":"\"ray8v4bykl1v\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"equipmentId\": \"The value ':equipmentId' is not valid.\"\n }\n}"},{"id":"057434a4-7b81-490a-890a-a600981f817a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/equipments/:equipmentId","host":["https://drayup.com/api/v1"],"path":["equipments",":equipmentId"],"variable":[{"key":"equipmentId","value":"","description":"The equipment id from equipment list"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 16 Nov 2023 09:47:04 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5d10dc6e-7686-4361-8ef0-f792d76b45b7"},{"name":"Get equipment status list","id":"8c1143e8-bddb-4f43-aac7-0116582e4fad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments/statuses","description":"

Description

\n

This API endpoint allows users to retrieve a list of equipment statuses.

\n

Notes

\n
    \n
  • Please ensure that you have the necessary authentication and authorization to access this endpoint.
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["equipments","statuses"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"81657b01-7738-48bb-ba5c-042da7ccebde","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1equipment-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"136"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 17 Aug 2023 12:37:49 GMT"},{"key":"ETag","value":"\"klqwx1qmao3s\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Gate-In\"\n },\n {\n \"id\": 4,\n \"name\": \"Ready for Pick-Up\"\n },\n {\n \"id\": 2,\n \"name\": \"Ready for Gate-Out\"\n },\n {\n \"id\": 3,\n \"name\": \"Gate-Out\"\n }\n ]\n}"},{"id":"cdf421d8-75ea-493d-84ae-904e40d48333","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments/statuses"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 16 Nov 2023 09:47:32 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8c1143e8-bddb-4f43-aac7-0116582e4fad"},{"name":"Get equipment type list","id":"7f239890-5261-482d-a354-36403aafc90b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments/types","description":"

Description

\n

This API endpoint enables the retrieval of a list of equipment types.

\n

Notes

\n
    \n
  • Please ensure that you have the necessary authentication and authorization to access this endpoint.
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["equipments","types"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ae0d211d-8b51-4adf-88c7-00a12a99587b","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments/types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"441"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 17 Aug 2023 12:37:58 GMT"},{"key":"ETag","value":"\"hestpt2abdc9\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Container/Chassis (20'/40'/45')\"\n },\n {\n \"id\": 2,\n \"name\": \"Container/Chassis (45')\"\n },\n {\n \"id\": 3,\n \"name\": \"Container/Chassis (53')\"\n },\n {\n \"id\": 4,\n \"name\": \"Trailer (53')\"\n },\n {\n \"id\": 5,\n \"name\": \"Truck Only (25')\"\n },\n {\n \"id\": 6,\n \"name\": \"Yacht (36 Feet and Longer)\"\n },\n {\n \"id\": 7,\n \"name\": \"Boat\"\n },\n {\n \"id\": 8,\n \"name\": \"Construction Equipment (41 Feet and Longer)\"\n },\n {\n \"id\": 9,\n \"name\": \"Construction Equipment (40 Feet and Shorter)\"\n },\n {\n \"id\": 10,\n \"name\": \"Car/SUV (40 Feet)\"\n }\n ]\n}"},{"id":"66436b8d-c2da-4a31-8615-6f8fe2a6c9ba","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/equipments/types"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 16 Nov 2023 09:47:43 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7f239890-5261-482d-a354-36403aafc90b"}],"id":"0c69ac7b-eb2b-46ef-bef1-60f1bb25cd04","_postman_id":"0c69ac7b-eb2b-46ef-bef1-60f1bb25cd04","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}},{"name":"Invoices","item":[{"name":"Get invoice list","id":"ea6841c5-c2e1-455b-9062-295270e3943d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/invoices","description":"

Description

\n

This API endpoint enables users to retrieve a comprehensive list of all invoices created.

\n

Notes

\n
    \n

  • Make sure you have the necessary authentication and authorization to access that endpoint, if necessary.

    \n
    • \n

  • The itemsPerPage, page, and month parameters are optional and can be used for filtering and pagination.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["invoices"],"host":["https://drayup.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

(optional) Number of items to be displayed per page.

\n","type":"text/plain"},"key":"itemsPerPage","value":""},{"disabled":true,"description":{"content":"

(optional, default: 1) Page number for pagination.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

(optional, datetime in ISO format) Filter invoices based on the month.

\n","type":"text/plain"},"key":"month","value":""}],"variable":[]}},"response":[{"id":"610c2f00-8c97-43b4-8b79-889abbc61901","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/invoices","host":["https://drayup.com/api/v1"],"path":["invoices"],"query":[{"key":"itemsPerPage","value":"","description":"optional, default 5","disabled":true},{"key":"page","value":"","description":"optional, default 1","disabled":true},{"key":"month","value":"","description":"optional, datetime in ISO format","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"463"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 29 Aug 2023 13:32:41 GMT"},{"key":"ETag","value":"\"xrmc0jnqvmcv\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 189,\n \"invoiceNo\": null,\n \"invoiceDate\": null,\n \"price\": {\n \"amount\": 129,\n \"currency\": \"US Dollar\",\n \"symbol\": \"$\"\n },\n \"downloadUrl\": \"https://drayup-ui-dev.azurewebsites.net/uploads/invoices/23350002-189.pdf\",\n \"booking\": {\n \"bookingId\": 75,\n \"bookingCode\": \"23350002\",\n \"checkIn\": \"2023-08-29T00:00:00\",\n \"checkOut\": \"2023-08-30T00:00:00\",\n \"space\": 1,\n \"usedSpace\": 0,\n \"invoiceTerm\": 1,\n \"isPinCodeUsed\": true,\n \"createdDate\": \"2023-08-29T13:31:02.8137229Z\",\n \"yard\": {\n \"id\": 1,\n \"name\": \"Savannah\"\n }\n }\n }\n ]\n}"},{"id":"2d6ebf58-07f4-4f9d-b218-dec7e7b3c9dc","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/invoices","host":["https://drayup.com/api/v1"],"path":["invoices"],"query":[{"key":"itemsPerPage","value":"","description":"optional, default 5","disabled":true},{"key":"page","value":"","description":"optional, default 1","disabled":true},{"key":"month","value":"","description":"optional, datetime in ISO format","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 16 Nov 2023 09:47:53 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ea6841c5-c2e1-455b-9062-295270e3943d"},{"name":"Get invoice by number","id":"fbd02e61-dc1b-4f80-9760-07d69252ddb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/invoices/:invoiceNo","description":"

Description

\n

This API endpoint enables users to retrieve a specific invoice, identified by the :invoiceNo parameter.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • You must provide a valid :invoiceId in the URL to get details for a specific invoice.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["invoices",":invoiceNo"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"invoiceNo"}]}},"response":[{"id":"91189f9b-7c6d-4f98-9de6-7092442042d2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/invoices/:invoiceNo","host":["https://drayup.com/api/v1"],"path":["invoices",":invoiceNo"],"variable":[{"key":"invoiceNo","value":"0000002231"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"478"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:35:23 GMT"},{"key":"ETag","value":"\"j9lgfzv7t9da\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": 1014,\n \"no\": \"0000002231\",\n \"date\": \"2024-07-28T15:27:39.8354197\",\n \"price\": {\n \"amount\": 13.85,\n \"currency\": \"US Dollar\",\n \"symbol\": \"$\"\n },\n \"downloadUrl\": \"/uploads/invoices/24310001-0000002231-1014.pdf\",\n \"booking\": {\n \"bookingId\": 473,\n \"bookingCode\": \"24310001\",\n \"status\": \"Confirmed\",\n \"checkIn\": \"2024-07-28T00:00:00\",\n \"checkOut\": \"2025-08-31T00:00:00\",\n \"space\": 1,\n \"usedSpace\": 1,\n \"invoiceTerm\": 1,\n \"isPinCodeUsed\": true,\n \"createdDate\": \"2024-07-28T15:27:40.215303\",\n \"yard\": {\n \"id\": 1,\n \"name\": \"Telfair\"\n }\n }\n }\n}"},{"id":"e3acb2a4-36d0-47ec-b5b6-4239d4e71028","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/invoices/:invoiceNo","host":["https://drayup.com/api/v1"],"path":["invoices",":invoiceNo"],"variable":[{"key":"invoiceNo","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"192"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 26 Jul 2024 16:23:24 GMT"},{"key":"ETag","value":"\"hw6rkh4ioo5c\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"errors\": [\n {\n \"code\": \"InvoiceNotFound\",\n \"description\": \"Invoice number 1000000021 not found\",\n \"type\": 2\n }\n ]\n}"}],"_postman_id":"fbd02e61-dc1b-4f80-9760-07d69252ddb3"}],"id":"651e4461-fd2f-4632-8af8-c4cece286f3f","_postman_id":"651e4461-fd2f-4632-8af8-c4cece286f3f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}},{"name":"Booking Reservations","item":[{"name":"Create a booking reservation","id":"b9c0c95c-5b4e-45b2-bd96-333b42ad2640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"checkIn\": \"yyyy-MM-dd\",\r\n \"checkOut\": \"yyyy-MM-dd\",\r\n \"bookingType\": 1,\r\n \"equipmentTypeId\": 1,\r\n \"paymentMethodId\": 1,\r\n \"space\": 1,\r\n \"isPinCodeUsed\": true,\r\n \"yardId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://drayup.com/api/v1/reservations","description":"

Description

\n

This API endpoint enables users to create reservations for Drayup bookings. It allows users to reserve a booking for a specified time period and provide additional booking details.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Prior to making a reservation, it is essential to ensure that at least one valid payment method has been added to the Drayup application. Once a payment method has been added, it is necessary to run this request in order to obtain the updated list of available payment method IDs.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["reservations"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8d23e657-9583-4344-9a19-5634cb8f3244","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"checkIn\": \"yyyy-MM-dd\",\r\n \"checkOut\": \"yyyy-MM-dd\",\r\n \"bookingType\": 2,\r\n \"equipmentTypeId\": 1,\r\n \"paymentMethodId\": 1,\r\n \"space\": 1,\r\n \"isPinCodeUsed\": true,\r\n \"yardId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://drayup.com/api/v1/reservations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"48"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 26 Jul 2024 16:18:17 GMT"},{"key":"ETag","value":"\"uvsxrj14rf1c\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"reservation\": {\n \"id\": 488,\n \"status\": \"Processing\"\n }\n}"},{"id":"897596c4-81ae-462d-916b-5452cec6fd70","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"checkIn\": \"yyyy-MM-dd\",\r\n \"checkOut\": \"yyyy-MM-dd\",\r\n \"bookingType\": 1,\r\n \"equipmentTypeId\": 1,\r\n \"paymentMethodId\": 1,\r\n \"space\": 1,\r\n \"isPinCodeUsed\": true,\r\n \"yardId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://drayup.com/api/v1/reservations"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:34:26 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"}],"_postman_id":"b9c0c95c-5b4e-45b2-bd96-333b42ad2640"},{"name":"Get booking reservation by id","id":"2a7f875a-54a0-43dd-bbf4-6fb291535d8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://drayup.com/api/v1/reservations/:bookingReservationId","description":"

Description

\n

This API endpoint allows users to complete the booking process by fetching a specific reservation, identified by the :bookingReservationId parameter.

\n

Notes

\n
    \n

  • Please ensure that you have the necessary authentication and authorization to access this endpoint.

    \n
    • \n

  • Please be advised that a valid :bookingReservationId is required in the URL to complete the booking reservation.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}},"urlObject":{"path":["reservations",":bookingReservationId"],"host":["https://drayup.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"bookingReservationId"}]}},"response":[{"id":"9fe1d311-af12-4335-9d39-c3c921338f50","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/reservations/:bookingReservationId","host":["https://drayup.com/api/v1"],"path":["reservations",":bookingReservationId"],"variable":[{"key":"bookingReservationId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"77"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 26 Jul 2024 16:18:24 GMT"},{"key":"ETag","value":"\"rnrp1fkrfd25\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"reservation\": {\n \"id\": 488,\n \"booking\": {\n \"code\": \"24300012\",\n \"status\": \"Confirmed\"\n }\n }\n}"},{"id":"6fbfb4b9-c241-4674-b7c0-eb4b100995ab","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://drayup.com/api/v1/reservations/:bookingReservationId","host":["https://drayup.com/api/v1"],"path":["reservations",":bookingReservationId"],"variable":[{"key":"bookingReservationId","value":"123"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"195"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 28 Jul 2024 15:33:49 GMT"},{"key":"ETag","value":"\"o2j62cgnd35f\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Unauthorized\",\n \"status\": 401,\n \"errors\": [\n {\n \"code\": \"InvalidAuthHeader\",\n \"description\": \"Authorization header was not found.\",\n \"type\": 4\n }\n ]\n}"}],"_postman_id":"2a7f875a-54a0-43dd-bbf4-6fb291535d8a"}],"id":"571dce13-85e2-4f65-b6f6-69318b542097","_postman_id":"571dce13-85e2-4f65-b6f6-69318b542097","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","id":"5e73153a-e708-40d1-9b6a-f3183299ecd8","name":"Drayup Web API Reference","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"e99bbbdb-9a95-4eba-a301-437774a94fb2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f30cae22-3d36-4225-b81f-26905bdad338","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://drayup.com/api/v1"},{"key":"token","value":""}]}