Getting started and aсcess to API

The Yandex Delivery API provides businesses with an option to use HTTP requests to create orders.

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 Yandex Delivery manager.

2. Open the Integration tab.

3. Under Activate your integration, click Get token.

4. Use this token to access the Yandex 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

Russia

Available delivery options in Russia:

  • 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.

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

Order stages

Description

API method

1. Get delivery options.

You submit a request for the system to estimate the preliminary cost of the available delivery options.

offers/calculate

2. Create delivery claim.

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

claims/create

3. 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

4. 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

5. 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, contact your Yandex Delivery manager.

Other countries

Available delivery options outside Russia:

  • 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 Yandex Delivery API are made to the host at https://b2b.taxi.yandex.net.

Order stages

Description

API method

1. Get a preliminary cost estimate for the delivery.

You submit a request for the system to estimate the preliminary delivery cost without creating a claim.

check-price

2. Create delivery claim.

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

claims/create

3. 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

4. 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

5. 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 Yandex 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