Same-day delivery

The method returns a list of services available at the point, taking into account their options.
The response contains two objects:

  1. express_delivery — contains available rates and options for "Express delivery".
  2. same_day_delivery — contains available intervals for "Same-day delivery".
    Each object contains the field ''allowed'' that indicates whether this option is available for the specified rate.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/delivery-methods

Service URL

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English

Example: en

Body

application/json
{
    "start_point": [
        0.1,
        0.1
    ],
    "fullname": "One Central Building 5, Trade Center Second, Dubai"
}

Name

Description

fullname

Type: string

Full address with an indication of the city, street, and house number.
You don't need to specify the flat, the entrance number, or the floor.

Example: One Central Building 5, Trade Center Second, Dubai

start_point

Type: number[]

Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order.

Example: 0.1,0.1

Max items: 2

Min items: 2

Responses

200 OK

OK

Body

application/json
{
    "express_delivery": {
        "allowed": false,
        "available_tariffs": [
            {
                "name": "cargo",
                "title": "Express",
                "text": "Express rate",
                "minimal_price": 213,
                "supported_requirements": [
                    {
                        "name": "cargo_type",
                        "title": "Body type",
                        "text": "Vehicle dimension requirement",
                        "type": "select",
                        "required": false,
                        "options": [
                            {
                                "title": "Small body",
                                "text": "170 cm long, 100 cm wide, 90 cm high",
                                "value": "van"
                            }
                        ]
                    },
                    {
                        "name": "string",
                        "title": "string",
                        "text": "string",
                        "type": "bool",
                        "default": false,
                        "required": false
                    }
                ],
                "delivery_options": [
                    {
                        "description": "string"
                    }
                ]
            }
        ]
    },
    "same_day_delivery": {
        "allowed": false,
        "available_intervals": [
            {
                "from": "2020-01-01T00:00:00+00:00",
                "to": "2020-01-02T00:00:00+00:00"
            }
        ]
    }
}

Name

Description

express_delivery*

Type: ExpressDeliveryInfo

Information about the available "Express delivery" rates

same_day_delivery*

Type: SameDayDeliveryInfo

Information about the available "Same-day delivery" intervals

ExpressDeliveryInfo

Information about the available "Express delivery" rates

Name

Description

allowed*

Type: boolean

"Express delivery" is available

available_tariffs*

Type: B2BTariff[]

Available "Express delivery" rates

SameDayDeliveryInfo

Information about the available "Same-day delivery" intervals

Name

Description

allowed*

Type: boolean

"Same-day delivery" is available

available_intervals*

Type: TimeInterval[]

Available "Same-day delivery" intervals
Time interval

B2BTariff

Name

Description

minimal_price*

Type: number

Minimum cost

Example: 213

name*

Type: string

Rate

Example: cargo

supported_requirements*

Type: (SelectRequirement
or BoolRequirement)[]

Supported delivery requirements

text*

Type: string

Rate description

Example: Express rate

title*

Type: string

Rate name

Example: Express

delivery_options

Type: DeliveryOption[]

TimeInterval

Time interval

Name

Description

from*

Type: string<date-time>

Interval start

Example: 2020-01-01T00:00:00+00:00

to*

Type: string<date-time>

Interval end (date and time)

Example: 2020-01-02T00:00:00+00:00

SelectRequirement

Requirement with a few options

Name

Description

name*

Type: string

Requirement type

Example: cargo_type

options*

Type: CargoRequirementChoice[]

Possible selection options

Min items: 1

required*

Type: boolean

Mandatory requirement for creating an order

text*

Type: string

Localized description of the requirement type

Example: Vehicle dimension requirement

title*

Type: string

Localized requirement name

Example: Body type

type*

Type: SelectType

Selection type: single or multiple

Example: select

Enum: select, multi_select

BoolRequirement

"Yes/no" requirement format

Name

Description

default*

Type: boolean

Default value

name*

Type: string

Requirement type

required*

Type: boolean

You must select a field

text*

Type: string

Localized description of the requirement type

title*

Type: string

Localized name of the requirement type

type*

Type: string

Selection type: yes or no

Enum: bool

DeliveryOption

Name

Description

description*

Type: string

Localized description

CargoRequirementChoice

Name

Description

text*

Type: string

Localized requirement description

Example: 170 cm long, 100 cm wide, 90 cm high

title*

Type: string

Localized requirement name

Example: Small body

value*

Type: string
or integer

The value that needs to be entered to take into account the requirement when creating an order

Example: van

SelectType

Selection type: single or multiple

Type

Description

SelectType

Example: select

Enum: select, multi_select

400 Bad Request

Invalid request

Body

application/json
{
    "code": "bad_request",
    "message": "bad request"
}

Name

Description

code*

Type: string

Error code

Example: bad_request

Enum: bad_request, address_not_found

message*

Type: string

Error description

Example: bad request

Next