📄️ Introduction
Cargamos is a company that provides last-mile delivery services through its network of last-mile distribution centers. Any physical or legal company that wants to use these services can register and integrate their orders using our integration mechanisms. The benefits of using Cargamos for last-mile delivery include same-day or next-day deliveries, including retry management and real-time traceability. Furthermore, it employs vehicle types optimized for the type of package, which generates cost savings and a better experience for your customers.
📄️ Shipper
The shipper is the one who requests the shipment service, or package delivery. It can be an individual or a legal entity. To perform an integration, registration is required, a process described in the section Cargamos API Usage Guide/Step 1: Registration. Depending on the integration method, such as using the API, an authentication and authorization process will need to be conducted when integrating shipments.
📄️ Shipment
Shipment Overview
📄️ Integration
"Delivery orders" are requests made to Cargamos to perform a delivery service. These orders must be validated considering that the shipper is authorized to be served, the provided information is sufficient to carry out the service, there is coverage for the requested location, and that the requested service level (through the dates shipperDropoffDate and expectedDeliveryDate) can be honored within the times, locations, and conditions of the contract signed with Cargamos. Once this delivery order is validated, it becomes a shipment. This entire process, from when the order is provided to when it is validated and a shipment is generated in the system, occurs during the integration process.
📄️ Recipient Location
It represents the address of the final recipient of the package/shipment, or in other words, the dropoff. It is represented by various fields that must be provided separately. The latter is necessary to make it easier for geocoding services to automatically provide additional help to determine the exact location, if necessary; In the same way, they facilitate the visualization of the information by the dealer.
📄️ Recipient Information
It represents basic information of the final recipient. This information is used to contact the recipient in case there are problems locating the recipient during delivery. This information is not persisted in the system, and is deleted once the shipment's life cycle ends.
📄️ Package
This refers to the physical information of the unique consolidated package that will be integrated and consequently delivered. It includes information about its contents, dimensions, weight, value, etc. It's possible to specify the items that make up the package with information compatible with the "Carta Porte" document, as used in Mexico.
📄️ Service Level and Shipment Management Parameters
Each integration has additional parameters associated with the service level, as well as those used for managing the shipment by the shipper.
📄️ Webhooks
A webhook consists of a URL through which the server\*, Cargamos in this case, can initiate communication with the client, and provide information as it becomes available and without requiring the client to request it on demand. Note that communications are typically initiated by the client. In this case, it's the server that initiates the communication.
📄️ Authentication
Cargamos employs an OAuth flow to authorize API calls. The sequence observed in the figure is followed.