Welcome to the iPurvey API – your gateway to seamless disruption management for both travelers and freight operators. iPurvey provides an AI-driven solution that simplifies and automates the resolution of travel and freight disruptions, whether by air, rail, ship, or road.
\nDesigned for reliability and speed, the iPurvey API enables businesses to integrate intelligent claim processing and disruption management into their own systems. This eliminates paperwork, manual form submissions, and delays. With global access and seamless claim automation, iPurvey empowers organizations to support their users through unexpected disruptions while promoting sustainability and operational efficiency.
\nUnified Platform for Air & Freight: Whether you're managing air travel or freight by ship, rail, or road, the iPurvey API has you covered.
\nAI-Powered Disruption Handling: Automates the assessment and filing of claims in the event of delays or cancellations.
\nNo Forms, No Fuss: Say goodbye to time-consuming documentation. iPurvey handles the backend complexity so users don’t have to.
\nAutomatic Claims & Global Reach: Access intelligent claims processing from anywhere, anytime.
\nWith iPurvey, your users spend less time reacting to delays and more time moving forward.
\nThe iPurvey API uses Basic Authentication to secure its endpoints.
\nTo authenticate your requests:
\nGo to the Authorization tab in Postman.
\nSelect \"Basic Auth\" as the type.
\nEnter the clientId (provided during onboarding) as the Username.
Enter the clientSecret as the Password.
Postman will automatically encode these credentials into a valid Authorization: Basic header, allowing you to make authenticated requests.
The iPurvey API uses standard HTTP status codes to indicate the success or failure of an API request. Here are some standard status codes and their meanings:
\n200 OK: The request was successful
\n403 Forbidden: The request was malformed. Usually occurs when the refresh token expires.
\n400 Bad Request: The request was malformed or missing required parameters.
\n401 Unauthorized: The request was not authenticated, or the provided API key is invalid.
\n404 Not Found: The requested resource could not be found.
\n500 Internal Server Error: The access token has expired
\nIf you encounter an error, review the error message and troubleshoot accordingly. Typical issues may include providing an invalid API token, missing required parameters, or sending requests in an incorrect format.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Error Handling","slug":"error-handling"}],"owner":"13990958","collectionId":"16488e05-2e27-438f-a60e-d217122e96e1","publishedId":"2sB3BEn9x8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-08-10T11:09:05.000Z"},"item":[{"name":"Client Management","item":[{"name":"Generate Client Token","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"86590527-a0b6-4258-9b4a-3bb563b66d5a"}}],"id":"861cc382-5922-4682-9ee2-7a544a045871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"}],"url":"https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/token","description":"Gets information about the authenticated user.
\n","urlObject":{"protocol":"https","path":["v1","freight","auth","token"],"host":["staging-freight-ilekun","ipurvey","com"],"query":[],"variable":[]}},"response":[{"id":"86504f2c-c663-48eb-87d4-44c3c3e0818e","name":"Generate Client Token","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"Authorization","value":"audio/basic","type":"text"}],"url":"https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 22 Apr 2025 13:29:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"{{vault:json-web-token}}\",\n \"expiresIn\": 3000,\n \"refreshToken\": \"{{YOUR REFRESH TOKEN}}\",\n \"tokenType\": \"Bearer\"\n}"}],"_postman_id":"861cc382-5922-4682-9ee2-7a544a045871"},{"name":"Refresh Client Token","id":"6b492ac4-2686-4610-80f3-2d35c230a549","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"refreshToken","value":"YOUR REFRESH TOKEN ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refreshToken\": \"7a600be0-cfaa-45fc-886e-6460faccfa44\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-freight-ums.ipurvey.com/v1/freight/auth/refreshToken","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"16488e05-2e27-438f-a60e-d217122e96e1","id":"16488e05-2e27-438f-a60e-d217122e96e1","name":"IPurvey API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","freight","auth","refreshToken"],"host":["staging-freight-ums","ipurvey","com"],"query":[],"variable":[]}},"response":[{"id":"16950a1f-1db8-4385-9522-4861bb213a6b","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"refreshToken","value":"YOUR REFRESH TOKEN ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refreshToken\": \"{{YOUR REFRESH TOKEN}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-freight-ums.ipurvey.com/v1/freight/auth/refreshToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 22 Apr 2025 18:13:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"{{vault:json-web-token}}\",\n \"expiresIn\": 69361947,\n \"refreshToken\": \"{{YOUR REFRESH TOKEN}}\",\n \"tokenType\": \"Bearer\"\n}"}],"_postman_id":"6b492ac4-2686-4610-80f3-2d35c230a549"},{"name":"Client Details","id":"4bca6f99-c739-4135-9f1c-0547a5486e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/userByToken?accessToken={{accessToken}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"16488e05-2e27-438f-a60e-d217122e96e1","id":"16488e05-2e27-438f-a60e-d217122e96e1","name":"IPurvey API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","freight","auth","userByToken"],"host":["staging-freight-ilekun","ipurvey","com"],"query":[{"key":"accessToken","value":"{{accessToken}}"}],"variable":[]}},"response":[{"id":"87de3375-e8c9-4ad9-8377-61b67f51ef60","name":"Client Details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/userByToken?token={{vault:json-web-token}}","protocol":"https","host":["staging-freight-ilekun","ipurvey","com"],"path":["v1","freight","auth","userByToken"],"query":[{"key":"token","value":"{{vault:json-web-token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 22 Apr 2025 14:19:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"IPFUK0000187\",\n \"companyName\": \"Real freight fowarder\",\n \"productCode\": \"01BLPSM0UO0U1\",\n \"address\": \"157 test street London E7 &XZ\",\n \"phone\": \"447541456654\",\n \"email\": \"nogol28483@isorax.com\",\n \"countryCode\": \"UK\",\n \"businessType\": \"SMALL\",\n \"properties\": {\n \"uuid\": \"d2d773ee-0d79-4472-baa9-14fd04ef66a1\",\n \"version\": 0,\n \"createdBy\": \"anonymousUser\",\n \"createdDate\": 1742057012000,\n \"lastModifiedBy\": \"anonymousUser\",\n \"lastModifiedDate\": 1742057012000,\n \"username\": \"nogol28483@isorax.com\",\n \"firstName\": \"Real\",\n \"lastName\": \"forward\",\n \"email\": \"nogol28483@isorax.com\",\n \"imageUrl\": null,\n \"enabled\": true,\n \"emailVerified\": true,\n \"clientId\": \"ccc3aeab-d04e-439f-9798-bd3ffe56cb21\",\n \"clientSecret\": \"BsPeC7b9f0LP1EXPO6Zt1mCb0XjFxwvMxxYc4c2FNDg\",\n \"lastPasswordResetDate\": 1742057011000,\n \"firstTimeLogin\": false,\n \"roles\": [\n {\n \"id\": 3,\n \"name\": \"ROLE_USER\"\n },\n {\n \"id\": 10,\n \"name\": \"ROLE_FREIGHT_FORWARDER\"\n }\n ],\n \"userSignupAction\": \"SEND_TEMP_PASSWORD\"\n }\n}"}],"_postman_id":"4bca6f99-c739-4135-9f1c-0547a5486e4d"},{"name":"Update Client Details","id":"6c402fc3-a460-4828-a1d0-3af05c927bcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"16488e05-2e27-438f-a60e-d217122e96e1","id":"16488e05-2e27-438f-a60e-d217122e96e1","name":"IPurvey API Documentation","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[{"id":"80465ef0-d6bd-4d18-91ab-8303164ec44d","name":"Update Client Details","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{vault:json-web-token}}"}],"body":{"mode":"raw","raw":"{\n \"address\": \"321 Example Street, Example City, EX 54321\",\n \"billingFrequency\": 30,\n \"businessAccountType\": \"LARGE\",\n \"companyName\": \"Example Company2\",\n \"contactEmail\": \"contac73@example.com\",\n \"countryCode\": \"US\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"9225874587\",\n \"productCode\": \"01BEFPSC15M2HO1H1\",\n \"userSignupAction\": \"NONE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-freight-ilekun.ipurvey.com/v1/freightClient/IPFUS0000022"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 22 Apr 2025 14:23:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"IPFUS0000022\",\n \"companyName\": \"Example Company2\",\n \"productCode\": \"01BEFPSC15M2HO1H1\",\n \"address\": \"321 Example Street, Example City, EX 54321\",\n \"phone\": \"9225874587\",\n \"countryCode\": \"US\",\n \"businessType\": \"SMALL\",\n \"properties\": {\n \"uuid\": \"11d00fc7-0225-44bb-9431-5547485da68c\",\n \"version\": 0,\n \"createdBy\": \"anonymousUser\",\n \"createdDate\": 1718455370000,\n \"lastModifiedBy\": \"anonymousUser\",\n \"lastModifiedDate\": 1718455370000,\n \"username\": \"contac73@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"contac73@example.com\",\n \"imageUrl\": null,\n \"enabled\": true,\n \"emailVerified\": false,\n \"clientId\": \"a1eda956-17b8-43db-8367-e5f215374f5c\",\n \"clientSecret\": \"xExwWp813jG1I1cEeAR6GAnVtvwBCBzWtE4Ohodit8s\",\n \"lastPasswordResetDate\": 1718455368000,\n \"firstTimeLogin\": false,\n \"roles\": [\n {\n \"id\": 3,\n \"name\": \"ROLE_USER\"\n },\n {\n \"id\": 10,\n \"name\": \"ROLE_FREIGHT_FORWARDER\"\n },\n {\n \"id\": 11,\n \"name\": \"ROLE_FREIGHT_AGGREGATOR\"\n }\n ],\n \"userSignupAction\": \"NONE\"\n }\n}"}],"_postman_id":"6c402fc3-a460-4828-a1d0-3af05c927bcd"}],"id":"88bdf60c-7e56-4c2d-806a-001623ddaf5f","description":"This API generates an access token used to authenticate client requests. Clients must provide their clientId and clientSecret, which were issued during onboarding, in the Authorization header on Postman using Basic Auth format. The returned accessToken is required for all subsequent authenticated API calls.
POST https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/token\n\nNote: Encode clientId:clientSecret In Base64 format, by entering their values under username and password, respectively, under Postman's Authorisation >> Basic section. For example:clientId: abc123, clientSecret: xyz789 → {{vault:basic-auth}}
curl --location --request POST 'https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/token' \\\n--header 'accept: application/json' \\\n--header 'Authorization: {{vault:basic-auth}}'\n\n{\n \"accessToken\": \"{{vault:json-web-token}}\",\n \"expiresIn\": 3000,\n \"refreshToken\": \"{{ YOUR REFRESH TOKEN }}\",\n \"tokenType\": \"Bearer\"\n}\n\nThis endpoint is used to obtain a new access token when the current one has expired. The request must include a valid refreshToken, which is typically returned by the Generate Client Token API.
POST https://staging-freight-ums.ipurvey.com/v1/freight/auth/refreshToken\n\n{\n \"refreshToken\": \"{{ YOUR REFRESH TOKEN }}\"\n}\n\ncurl --location 'https://staging-freight-ums.ipurvey.com/v1/freight/auth/refreshToken' \\\n--header 'accept: */*' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"refreshToken\": \" {{ YOUR REFRESH TOKEN }}\"\n}'\n\n{\n \"accessToken\": \"{{vault:json-web-token}}\",\n \"expiresIn\": 3000,\n \"refreshToken\": \"{{ YOUR REFRESH TOKEN }}\",\n \"tokenType\": \"Bearer\"\n}\n\nThis API retrieves the authenticated user's client details using an access token generated via the Generate Token API. The access token must be passed as a query parameter to authenticate and fetch the client information successfully.
\nGET https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/userByToken?token={accessToken}\n\ncurl --location 'https://staging-freight-ilekun.ipurvey.com/v1/freight/auth/userByToken?token={accessToken}'\n\n{\n \"accountId\": \"IPFUK0000187\",\n \"companyName\": \"Real freight fowarder\",\n \"productCode\": \"01BLPSM0UO0U1\",\n \"address\": \"157 test street London E7 &XZ\",\n \"phone\": \"447541456654\",\n \"email\": \"nogol28483@isorax.com\",\n \"countryCode\": \"UK\",\n \"businessType\": \"SMALL\",\n \"properties\": {\n \"uuid\": \"d2d773ee-0d79-4472-baa9-14fd04ef66a1\",\n \"version\": 0,\n \"createdBy\": \"anonymousUser\",\n \"createdDate\": 1742057012000,\n \"lastModifiedBy\": \"anonymousUser\",\n \"lastModifiedDate\": 1742057012000,\n \"username\": \"nogol28483@isorax.com\",\n \"firstName\": \"Real\",\n \"lastName\": \"forward\",\n \"email\": \"nogol28483@isorax.com\",\n \"imageUrl\": null,\n \"enabled\": true,\n \"emailVerified\": true,\n \"clientId\": \"ccc3aeab-d04e-439f-9798-bd3ffe56cb21\",\n \"clientSecret\": \"BsPeC7b9f0LP1EXPO6Zt1mCb0XjFxwvMxxYc4c2FNDg\",\n \"lastPasswordResetDate\": 1742057011000,\n \"firstTimeLogin\": false,\n \"roles\": [\n {\n \"id\": 10,\n \"name\": \"ROLE_FREIGHT_FORWARDER\"\n },\n {\n \"id\": 3,\n \"name\": \"ROLE_USER\"\n }\n ],\n \"userSignupAction\": \"SEND_TEMP_PASSWORD\"\n }\n}\n\npropertiesproperties)Each role object includes:
\nid: A unique numeric identifier for the role.
name: Role name defining the user’s permissions (e.g., ROLE_USER, ROLE_FREIGHT_FORWARDER).
This API updates a client's information. It uses a PUT request and requires an access token in the Authorization header, prefixed with Bearer. The access token is generated from the Generate Token API.
PUT https://staging-freight-ilekun.ipurvey.com/v1/freightClient/{accountId}\n\ncurl --location --request PUT 'https://staging-freight-ilekun.ipurvey.com/v1/freightClient/IPFUS0000022' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer {accessToken}' \\\n--data-raw '{\n \"address\": \"321 Example Street, Example City, EX 54321\",\n \"billingFrequency\": 30,\n \"businessAccountType\": \"LARGE\",\n \"companyName\": \"Example Company2\",\n \"contactEmail\": \"contac73@example.com\",\n \"countryCode\": \"US\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"9225874587\",\n \"productCode\": \"01BEFPSC15M2HO1H1\",\n \"userSignupAction\": \"NONE\"\n}'\n\n{\n \"accountId\": \"IPFUS0000022\",\n \"companyName\": \"Example Company2\",\n \"productCode\": \"01BEFPSC15M2HO1H1\",\n \"address\": \"321 Example Street, Example City, EX 54321\",\n \"phone\": \"9225874587\",\n \"countryCode\": \"US\",\n \"businessType\": \"SMALL\",\n \"properties\": {\n \"uuid\": \"11d00fc7-0225-44bb-9431-5547485da68c\",\n \"version\": 0,\n \"createdBy\": \"anonymousUser\",\n \"createdDate\": 1718455370000,\n \"lastModifiedBy\": \"anonymousUser\",\n \"lastModifiedDate\": 1718455370000,\n \"username\": \"contac73@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"contac73@example.com\",\n \"imageUrl\": null,\n \"enabled\": true,\n \"emailVerified\": false,\n \"clientId\": \"a1eda956-17b8-43db-8367-e5f215374f5c\",\n \"clientSecret\": \"xExwWp813jG1I1cEeAR6GAnVtvwBCBzWtE4Ohodit8s\",\n \"lastPasswordResetDate\": 1718455368000,\n \"firstTimeLogin\": false,\n \"roles\": [\n {\n \"id\": 3,\n \"name\": \"ROLE_USER\"\n },\n {\n \"id\": 10,\n \"name\": \"ROLE_FREIGHT_FORWARDER\"\n },\n {\n \"id\": 11,\n \"name\": \"ROLE_FREIGHT_AGGREGATOR\"\n }\n ],\n \"userSignupAction\": \"NONE\"\n }\n}\n\nThis API is used to track disruption. It submits a single shipment record to verify eligibility for travel disruption compensation and request compensation. The accessToken must be obtained from the Generate Client Token API.
POST https://staging-freight-ilekun.ipurvey.com/v1/freight-dcr-service/checkShipment\n\ncurl --location 'https://staging-freight-ilekun.ipurvey.com/v1/freight-dcr-service/checkShipment' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: {{YOUR TOKEN}}' \\\n--data-raw '{ \n \"vesselDetails\": { \n \"imo\": \"9253741\", \n \"mmsi\": \"310750000\", \n \"vesselName\": \"MONTREAL EXPRESS\" \n }, \n \"shipmentBookingDetail\": { \n \"shipmentId\": \"SH123456999\", \n \"containerCount\": \"1\", \n \"containerDetails\": [ \n { \n \"container_id\": \"TCKU7509047\" \n } \n ], \n \"demurrageDays\": \"2\", \n \"detentionDays\": \"14\", \n \"shipping_route\": [ \n { \n \"modeOfTransport\": \"Ship\", \n \"departureTimezone\": \"UTC -05:00\", \n \"departureCountry\": \"Canada\", \n \"departurePortName\": \"Montreal\", \n \"departurePortUnlode\": \"CAMTR\", \n \"scheduledDepartureDateLocal\": \"2025-05-29\", \n \"scheduledDepartureTimeLocal\": \"16:00:00\", \n \"arrivalCountry\": \"United Kingdom\", \n \"arrivalTimezone\": \"UTC +01:00\", \n \"arrivalPortName\": \"Southampton\", \n \"arrivalPortUnlocode\": \"GBSOU\", \n \"scheduledArrivalDateLocal\": \"2025-05-29\", \n \"scheduledArrivalTimeLocal\": \"16:00:00\", \n \"legId\": 1 \n } \n ] \n }, \n \"intermodalFreightBookingDetail\": [ \n { \n \"modeOfTransport\": \"Rail\", \n \"departureTimezone\": \"UTC +01:00\", \n \"departureCountry\": \"United Kingdom\", \n \"departatureStation\": \"Southampton\", \n \"departureStationCode\": \"SOTDWGB\", \n \"serviceId\": \"string\", \n \"scheduledDepartureDateLocal\": \"2025-05-28\", \n \"scheduledDepartureTimeLocal\": \"16:00:00\", \n \"freightOperator\": \"GB Railfreight\", \n \"arrivalCountry\": \"United Kingdom\", \n \"arrivalTimezone\": \"UTC +01:00\", \n \"arrivalStation\": \"Hams Hall Gbrf\", \n \"arrivalStationCode\": \"\", \n \"scheduledArrivalDateLocal\": \"2025-05-28\", \n \"scheduledArrivalTimeLocal\": \"16:00:00\", \n \"legId\": 2 \n }, \n { \n \"modeOfTransport\": \"Road\", \n \"departureTimezone\": \"UTC +01:00\", \n \"departureCountry\": \"United Kingdom\", \n \"scheduledDepartureDateLocal\": \"2024-07-19\", \n \"departatureLocation\": \"Hams Hall Gbrf\", \n \"scheduledDepartureTimeLocal\": \"16:00:00\", \n \"arrivalCountry\": \"United Kingdom\", \n \"arrivalTimezone\": \"UTC +01:00\", \n \"arrivalLocation\": \"Birmingham Freightliner Terminal\", \n \"scheduledArrivalDateLocal\": \"2024-07-19\", \n \"scheduledArrivalTimeLocal\": \"23:00:00\", \n \"legId\": 3 \n } \n ], \n \"cargoDetails\": { \n \"description\": \"Consumer goods\", \n \"weight\": \"10,000 kg\", \n \"dimensions\": \"5m x 4m x 4m\", \n \"hazardous\": \"false\" \n }, \n \"bookingDetails\": { \n \"bookingReference\": \"BK567890523\", \n \"bookingStatus\": \"Confirmed\" \n }, \n \"customerDetails\": { \n \"customerName\": \"1201test Electronics Ltd\", \n \"customerEmail\": \"test@gmail.com\", \n \"customerReference\": \"IPVGB01201\" \n } \n} '\n\n{\n \"statusCode\": 200,\n \"description\": \"Shipment submitted successfully\"\n \"ipvReference\": \"IPFXX7S2508060000231\"\n}\n\nThe Freight Disruption Management Webhook allows iPurvey to proactively notify your system of shipment delays and provide AI-recommended intermodal rebooking options. Upon receiving a request, your server should respond with a status code of 200 to confirm the successful receipt of the payload.
\nYou can also choose to include a unique identifier or key with each request to make it easier to track responses on your end. This identifier will be appended to the request, allowing you to correlate the response with the original request. If you have any preferences or suggestions regarding the integration, feel free to discuss them with us.
\nhttps://{your-server-address}/{service-name}/{endpoint-name}\n\n{\n \"ipvReference\": \"IPFXX7S2409040000011\", \n \"headerText\": \"Our system has proactively identified a disruption to below intermodal freight booking. Your vessel is now scheduled to arrive at Felixstowe 08-09-2024 at 14:30. Constituting a 2 days 22 hours delay. To mitigate the impact of this disruption, we recommend rebooking your 10 containers on one or more of the recommended freight services below. We have also provided the potential CO2 emissions savings of using freight trains for your shipment instead of road transport.\",\n \"prediction\": {\n \"status\": \"Delay\", \n \"statusDescription\": \"Delay occurred in vessel journey!\",\n \"estimatedArrivalTime\": \"2024-09-08T14:30:00Z\",\n \"predictedDelayHour\": \"4 days 10 hours delay\"\n },\n \"vesselDetails\": {\n \"imo\": \"9417951\",\n \"shipmentId\": \"SH123456777\",\n \"departureLocation\": \"Port Of Singapore\",\n \"departureDate\": \"09-08-2024\",\n \"departureTime\": \"23:17\",\n \"arrivalLocation\": \"Felixstowe\",\n \"arrivalDate\": \"04-09-2024\",\n \"arrivalTime\": \"16:30:00\",\n \"containerCount\": 10\n },\n \"freightDetails\": {\n \"trainOperator\": \"GB Railfreight\",\n \"departureLocation\": \"Felixstowe\",\n \"trainDepartureDate\": \"04-09-2024\",\n \"trainDepartureTime\": \"17:35\",\n \"trainArrivalLocation\": \"Hams Half Gbrf\",\n \"trainArrivalDate\": \"04-09-2024\",\n \"trainArrivalTime\": \"21:35\"\n },\n \"recommendations\": [\n {\n \"preferenceGroupDescription\": \"Lowest CO2 Emission\",\n \"preferenceGroupDetails\": [\n {\n \"trainOperator\": \"GB Railfreight\",\n \"trainServiceId\": \"5546180\",\n \"freightTrainDepartureDate\": \"10-09-2024\",\n \"freightTrainDepartureTime\": \"00:45\",\n \"freightTrainArrivalLocation\": \"Masborough N&W Gbrf\",\n \"freightTrainArrivalDate\": \"10-09-2024\",\n \"freightTrainArrivalTime\": \"08:45\",\n \"recommendedContainerCount\": 8,\n \"customerPreferenceWeighting\": 0.62,\n \"emissionImpact\": \"68.25%\"\n },\n {\n \"trainOperator\": \"GB Railfreight\",\n \"trainServiceId\": \"5546180\",\n \"freightTrainDepartureDate\": \"10-09-2024\",\n \"freightTrainDepartureTime\": \"10:36\",\n \"freightTrainArrivalLocation\": \"Hams Half Gbrf\",\n \"freightTrainArrivalDate\": \"04-09-2024\",\n \"freightTrainArrivalTime\": \"16:36\",\n \"recommendedContainerCount\": 2,\n \"customerPreferenceWeighting\": 0.62,\n \"emissionImpact\": \"25.25%\"\n }\n ]\n },\n {\n \"preferenceGroupDescription\": \"Earliest Arrival Train\",\n \"preferenceGroupDetails\": [\n {\n \"trainOperator\": \"GB Railfreight\",\n \"trainServiceId\": \"5546180\",\n \"freightTrainDepartureDate\": \"04-09-2024\",\n \"freightTrainDepartureTime\": \"00:45\",\n \"freightTrainArrivalLocation\": \"Masborough N&W Gbrf\",\n \"freightTrainArrivalDate\": \"04-09-2024\",\n \"freightTrainArrivalTime\": \"08:45\",\n \"recommendedContainerCount\": 8,\n \"customerPreferenceWeighting\": 0.38,\n \"emissionImpact\": \"25.25%\"\n },\n {\n \"trainOperator\": \"GB Railfreight\",\n \"trainServiceId\": \"5546180\",\n \"freightTrainDepartureDate\": \"04-09-2024\",\n \"freightTrainDepartureTime\": \"01:38\",\n \"freightTrainArrivalLocation\": \"Masborough N&W Gbrf\",\n \"freightTrainArrivalDate\": \"04-09-2024\",\n \"freightTrainArrivalTime\": \"08:45\",\n \"recommendedContainerCount\": 2,\n \"customerPreferenceWeighting\": 0.38,\n \"emissionImpact\": \"68.25%\"\n }\n ]\n },\n {\n \"preferenceGroupDescription\": \"Same Train Destination\",\n \"preferenceGroupDetails\": [\n {\n \"trainOperator\": \"GB Railfreight\",\n \"trainServiceId\": \"5546180\",\n \"freightTrainDepartureDate\": \"04-09-2024\",\n \"freightTrainDepartureTime\": \"00:45\",\n \"freightTrainArrivalLocation\": \"Masborough N&W Gbrf\",\n \"freightTrainArrivalDate\": \"04-09-2024\",\n \"freightTrainArrivalTime\": \"08:45\",\n \"recommendedContainerCount\": 8,\n \"customerPreferenceWeighting\": 0.21,\n \"emissionImpact\": \"25.25%\"\n },\n {\n \"trainOperator\": \"GB Railfreight\",\n \"trainServiceId\": \"5546180\",\n \"freightTrainDepartureDate\": \"04-09-2024\",\n \"freightTrainDepartureTime\": \"01:38\",\n \"freightTrainArrivalLocation\": \"Masborough N&W Gbrf\",\n \"freightTrainArrivalDate\": \"04-09-2024\",\n \"freightTrainArrivalTime\": \"08:45\",\n \"recommendedContainerCount\": 2,\n \"customerPreferenceWeighting\": 0.21,\n \"emissionImpact\": \"68.25%\"\n }\n ]\n }\n ]\n}\n\nEach item groups rail freight options based on customer preferences, such as CO2 savings and speed.
\nEach preferenceGroupDetails item:
trainOperator: string – Name of operator
trainServiceId: string – Unique ID of the train service
freightTrainDepartureDate/Time & ArrivalDate/Time: date/time – Schedule info
freightTrainArrivalLocation: string – Destination
recommendedContainerCount: integer – Containers suggested for this route
customerPreferenceWeighting: float – Customer’s preference score (e.g., 0.62). It is the weighting allocated to the customer recommendation preference group.
emissionImpact:string – Estimated CO₂ savings. It indicates the percentage of CO₂ emissions saved when using the recommended intermodal freight.
This API retrieves the total count of shipment submission records for a specific customer. It also provides key performance metrics including:
\nShipments in the last month
\nDelayed shipments overall and in the last month
\nCancelled shipments overall and in the last month
\nOn-time shipments overall and in the last month
\nThis is essential for monitoring shipping reliability and trends of disruptions.
\nGET https://staging-freight-ilekun.ipurvey.com/v1/freight-dcr-service/countShipmentRecords?customerEmail=kiydofofyo@gufum.com\n\nNote: Postman usually auto-encodes values when you enter them in the Params section
\ncurl --location 'https://staging-freight-ilekun.ipurvey.com/v1/freight-dcr-service/countShipmentRecords?customerEmail=kiydofofyo@gufum.com'\n\n{\n \"totalShipments\": 0,\n \"lastMonthShipments\": 0,\n \"shipmentPercentage\": \"0%\",\n \"totalDelayedShipments\": 0,\n \"lastMonthDelayedShipments\": 0,\n \"delayedShipmentPercentage\": \"0%\",\n \"totalCancelledShipments\": 0,\n \"lastMonthCancelledShipments\": 0,\n \"cancelledShipmentsPercentage\": \"0%\",\n \"totalOnTimeShipments\": 0,\n \"lastMonthOnTimeShipments\": 0,\n \"onTimeShipmentsPercentage\": \"0%\"\n}\n\nThis API allows partners to submit one or more travel itineraries to verify eligibility for travel disruption compensation and request compensation. It caters for transit flights and non-transit flights by setting the transit field in your request body to either true or false. To authenticate your requests, include the x-api-key provided during registration in your request headers.
POST https://dev-ilekun-ipv.ipurvey.com/orchestrator/flight/booking/requests/b2b\n\n{\n \"request\": [\n {\n \"flightInfo\": {\n \"bookingReference\": \"62XTVW\"\n },\n \"journey\": [\n {\n \"departureDetails\": {\n \"airportCode\": \"YYZ\",\n \"airportName\": \"LESTER B PEARSON INTL\",\n \"dateLocal\": \"2024-04-05\",\n \"timeLocal\": \"21:45\"\n },\n \"arrivalDetails\": {\n \"airportCode\": \"IST\",\n \"airportName\": \"Istanbul airport\"\n },\n \"carrierCode\": \"TK\",\n \"carrierName\": \"Turkish Airline\",\n \"flightNumber\": \"TK18\",\n \"legId\": \"1\"\n }\n ],\n \"passengers\": {\n \"passengerNames\": [\n {\n \"firstName\": \"JULIET CHINYERE\",\n \"lastName\": \"IBE\"\n }\n ]\n },\n \"scheduledArrivalDate\": \"2024-04-06\",\n \"scheduledArrivalTime\": \"21:45\",\n \"transit\": true\n }\n ]\n}\n\n{\n \"batchNo\": \"809806c1-45ce-4ba4-a83a-1cbb43200f95\",\n \"message\": \"Request submitted for processing\"\n}\n\n