An API, or Application Programming Interface, is a set of rules and protocols that allow different software applications to communicate with each other. In the context of Gelato Connect Logistics, APIs are used to interact with various carriers to request shipping labels, track shipments, and obtain shipping rates. By using APIs, GCL can seamlessly integrate with carrier systems to automate and streamline logistics processes.
Key Benefits of APIs:
Automation: APIs enable automated interactions between systems, reducing manual effort and errors.
Real-time Data: Access real-time information about shipments, rates, and delivery statuses.
Scalability: Easily scale operations by integrating with multiple carriers through a single API interface.
Sharing API Credentials from Carriers
To use carrier services through Gelato Connect Logistics, you need to share API credentials from your carriers. These credentials authenticate and authorize your access to carrier systems. Here is how you can share API credentials:
Steps to Share API Credentials:
Obtain API Credentials:
Contact your carrier account representative to obtain API credentials, which typically include an API key, username, password, and other necessary information.
Some carriers may have a developer portal where you can register and generate API credentials.
Securely Share Credentials with Gelato:
Once you have the credentials, securely share them with your Gelato Partner Account Manager. Ensure that credentials are transmitted through secure channels, such as encrypted emails or secure file-sharing services.
Configure Credentials in GCL:
Gelato will configure the credentials within the GCL system to enable seamless communication with the carrier APIs. Gelato ensures that all credentials are stored securely and used exclusively for authorized interactions with the carrier.
Testing and Validation:
Gelato will perform testing to ensure that the API integration with the carrier is functioning correctly. Any issues or discrepancies will be addressed in collaboration with the carrier and your team.
By sharing API credentials, you enable GCL to interact directly with carrier systems, ensuring efficient and accurate processing of shipping orders.
FAQs
How can I check the shipping cost via API?
Our API supports two methods for retrieving shipping costs.
In the first method, you can request all available shipping methods along with their corresponding costs in your initial API call. After reviewing the returned options, you can make a second API call to confirm and proceed with the selected shipping method.
In the second method, if you already know which shipping method you want to use, you can request the shipping cost directly along with the label and tracking number in a single API call. This simplifies the process when the shipping method is predetermined.
What units of measure are used in the Connect API?
The Connect API uses millimeters (mm) for all dimensions and grams (g) for weight. Please ensure that all API requests and data submissions follow these units to avoid processing errors.
Can I import shipping prices via API?
GelatoConnect is not set up for import or inbound shipping at this time. This feature is part of our future development plans, but it will take some time to build. We will share updates once it becomes available.