Getting started and aсcess to API

API integration allows businesses to manage their deliveries using HTTP requests. You can customize Yango Delivery integration according to your individual needs. For example, to send out a single order or several orders at once, or whether to do it automatically or manually.

API access

Before you start using the API, you need to obtain a token:

1. Log in to your personal account using the username and password that you received from your Yango Delivery manager.

2. Open the Integration tab.

3. Under Activate your integration, click Get token.

4. Use this token to access the Yango Delivery API. To do this, pass the token to the Authorization header in all your requests:

Authorization: Bearer <OAuth_token>

The OAuth token remains valid indefinitely.

Note

If you change the password to your personal account, the previously issued OAuth token becomes invalid. In this case, you need to get a new OAuth token.

Delivery options and order creation

Available delivery options are:

  • Express delivery:

    • Express pickup. Available delivery options may vary depending on the courier's arrival time.

    • Deferred order (allows specifying the desired time of the courier's arrival to the sender).

  • Cargo delivery:

    • Express pickup.

    • Deferred order.

  • Same-day delivery: The delivery is made within the selected interval.

All requests to the Yango Delivery API are made to the host at https://b2b.taxi.yandex.net.

Order stages

Description

API method

1. Create delivery claim.

You create a delivery claim that includes the specified address and delivery option.

claims/create

2. View the estimation results.

You submit the request. If the claim can be fulfilled, you receive a response with the actual cost of the order.
If not, the response provides the reasons why your claim can't be fulfilled.

claims/info

3. Confirm the claim.

If you agree with the delivery terms, you confirm the claim. This initiates the process of finding a courier for the order.

claims/accept

4. Track the claim status.

You submit a request for one or multiple claims and receive information about their status.

To learn more, see the API methods section:

If you have any problems, please contact your Yango Delivery manager.

Order cancellation

You can cancel the claim if needed:

  1. For information about the terms of cancellation, call the claims/cancel-info method.

    An order can be canceled free of charge if the courier hasn't arrived at the sender's location yet (pickup_arrived status). Cancellations made after the courier's arrival are subject to a fee.

  2. Cancel the claim by calling the claims/cancel method.

    Warning

    If the courier has already picked up the items, the order can only be canceled through the support service.

Next
Status model