26/07/2017
Mastering the Yandex Delivery API for Seamless Logistics
In today's fast-paced world, efficient and reliable delivery services are paramount for businesses of all sizes. Yandex, a leading technology company, offers a robust Delivery API that empowers businesses to integrate sophisticated logistics solutions directly into their operations. Whether you're a burgeoning e-commerce startup or an established enterprise, understanding and leveraging the Yandex Delivery API can significantly streamline your delivery processes, reduce costs, and enhance customer satisfaction. This comprehensive guide will walk you through the essential steps of getting started, understanding delivery options, creating orders, and tracking your shipments.
Gaining Access to the Yandex Delivery API
Before you can harness the power of the Yandex Delivery API, you'll need to obtain the necessary credentials. This process is straightforward and ensures secure access to the platform. The key to accessing the API is an OAuth token, which acts as your unique identifier and authorization key.
Steps to Obtain Your OAuth Token:
- Log In to Your Personal Account: Access your Yandex Delivery personal account using the username and password provided by your Yandex Delivery manager. This account is your central hub for managing integrations and tracking your deliveries.
- Navigate to the Integration Tab: Once logged in, locate and open the 'Integration' tab. This section contains all the necessary tools and information for connecting your systems with the Yandex Delivery API.
- Activate Your Integration: Within the Integration tab, you will find an option to 'Activate your integration.' Click on this to initiate the process of generating your API token.
- Retrieve Your Token: Upon activation, you will be provided with your OAuth token. This token is crucial for all subsequent API requests.
Using Your OAuth Token:
To authenticate your requests to the Yandex Delivery API, you must include your OAuth token in the Authorization header. The format for this is:
Authorization: Bearer <OAuth_token>
It's important to note that your OAuth token has an indefinite validity period. However, if you ever change the password associated with your personal account, the previously issued OAuth token will become invalid. In such cases, you will need to repeat the token retrieval process to obtain a new, valid token.
Understanding Yandex Delivery Options and Order Creation
The Yandex Delivery API supports a variety of delivery options tailored to meet diverse business needs, both within Russia and internationally. The process of creating a delivery order involves a series of API calls that guide you through estimating costs, submitting claims, and confirming your delivery.
Delivery Options in Russia:
Within Russia, Yandex Delivery offers flexible options to cater to different urgency and scheduling requirements:
- Express Delivery: This option focuses on rapid pickup and delivery. Depending on the courier's availability, you might have access to specific delivery timeframes.
- Deferred Order (Russia): This feature allows you to specify a preferred time for the courier's arrival at the sender's location, providing greater control over the pickup process.
- Cargo Delivery: For larger shipments, Yandex offers cargo delivery, which also includes options for express pickup and deferred orders.
Delivery Options Outside Russia:
For international operations, Yandex Delivery provides a similar set of core services, with the addition of same-day delivery:
- Express Delivery: Similar to the Russian offering, this covers swift pickup and delivery, with potential variations based on courier availability.
- Deferred Order (International): Enables scheduling of courier pickup at a desired time for the sender.
- Cargo Delivery: Supports the transportation of larger goods with express pickup and deferred order options.
- Same-Day Delivery: This option guarantees delivery within a specified time interval on the same day the order is placed, ideal for urgent shipments.
Core API Host:
All requests to the Yandex Delivery API are directed to the following host:
https://b2b.taxi.yandex.net
The Order Creation Workflow:
Creating a delivery order with the Yandex Delivery API follows a structured workflow, ensuring all necessary information is processed accurately. The stages are as follows:
For Deliveries within Russia:
| Stage | Description | API Method |
|---|---|---|
| 1. Get Delivery Options | Submit a request to estimate the preliminary cost of available delivery options. This helps you compare different services before committing. | offers/calculate |
| 2. Create Delivery Claim | Create a formal delivery claim, detailing the recipient's address, chosen delivery option, and any other relevant information. | claims/create |
| 3. View Estimation Results | Submit a request to get the actual cost and fulfillment status. The response will either provide the confirmed cost or explain why the claim cannot be fulfilled. | claims/info |
| 4. Confirm the Claim | If you agree with the delivery terms and cost, confirm the claim. This action initiates the process of assigning a courier to your order. | claims/accept |
| 5. Track Claim Status | Submit requests to monitor the status of one or multiple claims. This allows you to stay informed about the progress of your delivery. | Refer to API methods section for detailed tracking information. |
For Deliveries Outside Russia:
| Stage | Description | API Method |
|---|---|---|
| 1. Get Preliminary Cost Estimate | Submit a request to get an estimated delivery cost without creating a formal claim. This is useful for initial budgeting and planning. | check-price |
| 2. Create Delivery Claim | Create a delivery claim, specifying the address, chosen delivery option, and other necessary details. | claims/create |
| 3. View Estimation Results | Submit a request to receive the actual cost and fulfillment status. The response indicates if the claim can be met or provides reasons for rejection. | claims/info |
| 4. Confirm the Claim | Approve the delivery terms and cost to proceed with the order. This step triggers the search for a suitable courier. | claims/accept |
| 5. Track Claim Status | Retrieve information about the status of your claims by submitting requests for specific orders. | Refer to API methods section for detailed tracking information. |
Claim Information and Support:
Throughout the process, you can retrieve detailed information about your delivery claims. If you encounter any issues or have questions, your dedicated Yandex Delivery manager is your primary point of contact for assistance. They can provide guidance on specific API methods, troubleshoot problems, and ensure your integration runs smoothly.
Order Cancellation
Flexibility is key in logistics, and the Yandex Delivery API understands this. If circumstances change, you have the ability to cancel a delivery claim if it's still within the allowed cancellation window. The specific method and conditions for cancellation would typically be detailed within the API documentation or accessible through your personal account portal. It's advisable to consult the official Yandex Delivery API documentation for the precise endpoints and parameters related to order cancellation to ensure you are following the correct procedure.
Key Takeaways for Integration
Integrating with the Yandex Delivery API offers a powerful way to enhance your business's logistical capabilities. By securing your OAuth token, understanding the various delivery options available, and following the structured order creation workflow, you can efficiently manage your shipments. Remember to always refer to the official API documentation for the most up-to-date information on endpoints, parameters, and best practices. With Yandex Delivery, you're well-equipped to meet your customers' delivery expectations and optimize your supply chain.
Frequently Asked Questions:
- Q1: How long is my OAuth token valid?
- Your OAuth token is valid indefinitely, but it becomes invalid if you change your personal account password.
- Q2: What is the difference between delivery options in Russia and other countries?
- The core options like Express and Cargo delivery are similar. However, deliveries outside Russia also include a 'Same-day delivery' option for urgent shipments.
- Q3: Where can I find detailed information about specific API methods like tracking?
- Detailed information on all API methods, including tracking, can be found in the official Yandex Delivery API documentation. Your Yandex Delivery manager can also point you to the relevant resources.
- Q4: Can I cancel an order after it has been confirmed?
- You can cancel a claim if needed, but the ability to do so may depend on the stage of the order and specific cancellation policies. Consult the API documentation or your manager for details.
- Q5: What is the base URL for all Yandex Delivery API requests?
- The base URL for all Yandex Delivery API requests is https://b2b.taxi.yandex.net.
By mastering the Yandex Delivery API, businesses can unlock a new level of efficiency and reliability in their delivery operations, ensuring timely and cost-effective service for their customers.
If you want to read more articles similar to Yandex Delivery API: Your Logistics Solution, you can visit the Taxis category.