Welcome to the Official iCarry Web API documentation! This guide will walk you through the steps required to access the API and retrieve the connector credentials from your store. By following these steps.
\nTo begin, you need to access the iCarry Web API by visiting the respective store URL based on your location:
\nOnce you are on the iCarry store website, navigate to the settings section. You can usually find this section in the sidebar or menu and then click on the Connectors & Integration section.
\nAfter locating the connector credentials section within the settings, you will find a table displaying the necessary information. Follow these steps to copy the credentials:
\nThat's it! You have now successfully accessed the iCarry Web API and retrieved the connector credentials from your store. These credentials will be necessary for authenticating your requests and accessing the available API endpoints, You can use them in the GetToken API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28009312","collectionId":"d98f17cc-5dc1-43b8-a6cc-c177126fbf60","publishedId":"2s93sgXAY9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-20T15:11:42.000Z"},"item":[{"name":"Authenticate","item":[{"name":"GetTokenForCustomerApi","item":[{"name":"Authenticate ApiMember","id":"4180e5f2-39b7-446b-a8ab-a12655df80d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Email\": \"To authenticate a user and acquire an authentication token, it is necessary to utilize the specified parameters, namely \"email\" and \"password,\" as extracted from the connector and integration settings at iCarry. These parameters play a crucial role in the authentication procedure by verifying the user's legitimacy and providing them with the necessary bearer token for access.
\n","urlObject":{"path":["api-frontend","Authenticate","GetTokenForCustomerApi"],"host":["https://test.icarry.com"],"query":[],"variable":[]}},"response":[{"id":"8711f29f-72ca-46ff-9e4c-ee8d6bd242db","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"StartFragment
\nTo access the API resources, you need to authenticate your requests using a bearer token. The bearer token should be included in the Authorization header of each request made to the API.
EndFragment
\nStartFragment
\nTo obtain a bearer token, you need to send a GET request to the /gettoken endpoint. This endpoint is responsible for generating and returning a valid bearer token that you can use for subsequent API requests.
EndFragment
\n","_postman_id":"9222521e-32f5-4128-a911-f407c77b7e7c"},{"name":"Warehouse","item":[{"name":"Get By Id","item":[{"name":"{id}","item":[{"name":"Gets a warehouse","id":"0ae4f9a7-76d9-4957-9e90-23956a5c571b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://test.icarry.com/api-frontend/Warehouse/GetById/:id","urlObject":{"path":["api-frontend","Warehouse","GetById",":id"],"host":["https://test.icarry.com"],"query":[],"variable":[{"id":"c727c070-bdae-4291-acca-e537c950bdae","type":"any","value":"Warehouse name
\n","type":"text/plain"},"key":"name","value":"API to retrieve the return address for the warehouse and any available warehouses for the vendor in the system.
\n","_postman_id":"e6f2df91-2027-4ab5-8369-ce812a37652a"}],"id":"4936cf9c-d631-4cee-8fc8-39a73d61281a","description":"At iCarry, every shipment necessitates the inclusion of pickup and dropoff locations. When processing a shipment, the pickup location is saved and can subsequently be utilized for future shipments. Alternatively, users have the option to access and manage their saved locations, which are referred to as \"My Locations.\" These warehouses can be created using the provided API request.
\n","_postman_id":"4936cf9c-d631-4cee-8fc8-39a73d61281a"},{"name":"Country","item":[{"name":"GetAllCountry","item":[{"name":"/api-frontend/Country/GetAllCountry","id":"8d4660ae-8aa9-478b-9df9-0cd1a860c91f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://test.icarry.com/api-frontend/Country/GetAllCountry","description":"StartFragment
\nAPI for get available countries in system this API do not get any parameters and return list of all country available in system
\nEndFragment
\n","urlObject":{"path":["api-frontend","Country","GetAllCountry"],"host":["https://test.icarry.com"],"query":[],"variable":[]}},"response":[{"id":"9064ebf2-6857-468a-b730-f5023b98e737","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"API for get available countries in system this API do not get any parameters and return list of all country available in system
\n","_postman_id":"9382fe2d-52e8-44f7-abc8-a2a9ddd4f0be"},{"name":"GetById","item":[{"name":"{id}","item":[{"name":"/api-frontend/Country/GetById/:id","id":"c28d2a40-86c0-47bc-bcd4-2d148bb18f00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://test.icarry.com/api-frontend/Country/GetById/:id","urlObject":{"path":["api-frontend","Country","GetById",":id"],"host":["https://test.icarry.com"],"query":[],"variable":[{"id":"71f01a67-bfb8-46a8-bd42-ab36fb0e8523","type":"any","value":"Each Country has Unique ID
\n","_postman_id":"52d546c1-f1f7-46d8-bdeb-aafb6eaaecdd"}],"id":"990fee69-14e2-4d65-8a75-f13c03059127","description":"API to retrieve a list of the states from the system that are based on the selected country.
\n","_postman_id":"990fee69-14e2-4d65-8a75-f13c03059127"},{"name":"GetStatesByCountryId","item":[{"name":"{countryId}","item":[{"name":"/api-frontend/Country/GetStatesByCountryId/:countryId","id":"b2db645c-adb5-480a-95ae-7ff63e165373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://test.icarry.com/api-frontend/Country/GetStatesByCountryId/:countryId?addSelectStateItem=(Required)
\n","type":"text/plain"},"key":"addSelectStateItem","value":"iCARRY has carriers that offer international shipments, there is a country list and each country has its own state.
\nStartFragment
\nEndFragment
\n","_postman_id":"cce1d886-8236-43d8-8488-14c7817a2714"},{"name":"Merchants APIs","item":[{"name":"Get Rates","item":[{"name":"/api-frontend/SmartwareShipment/EstimateRatesByCOD","id":"bca8af28-d97e-430c-b396-94d0f2f66dff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CODAmount\": 2,\n \"COdCurrency\": \"USD\",\n \"DropOffLocation\": \"Beirut\",\n \"ToLongitude\": 35.5017767,\n \"ToLatitude\":33.8937913 ,\n \"ActualWeight\": 1,\n \"Dimensions\": {\n \"Length\": 2,\n \"Width\": 2,\n \"Height\": 2\n },\n \"PackageType\": \"Parcel\",\n \"DropAddress\": {\n \"CountryCode\": \"LB\",\n \"City\": \"Beirut\"\n },\n \"ParcelDimensionsList\": [\n {\n \"Quantity\": 1,\n \"Weight\": 10,\n \"Length\": 20,\n \"Width\": 30,\n \"Height\": 40\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://test.icarry.com/api-frontend/SmartwareShipment/EstimateRatesByCOD","description":"","urlObject":{"path":["api-frontend","SmartwareShipment","EstimateRatesByCOD"],"host":["https://test.icarry.com"],"query":[],"variable":[]}},"response":[{"id":"d0a4c212-9a3d-4a4e-a705-c454781bb793","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"API for obtaining Rates returned by carriers whose APIs receive shipping details as parameters like drop-off location, size, total weight, and package type (parcel or document)
\n","_postman_id":"e25f4a03-7ed2-45e8-b93e-17ca226dd29b"},{"name":"Create Order","item":[{"name":"Create Order","id":"c2898646-8081-4b18-8cfb-ac857ca74a57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ParcelDimensionsList\": [\n {\n \"Quantity\": \"