1.1. Same Day Delivery intervals

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

express_delivery: Contains available service classes and options for "Express delivery"
same_day_delivery: Contains available intervals for "Same day" delivery
Each of the objects contains the allowed field, which indicates the availability of this delivery mode.

HTTP Request

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

Header Parameters

Accept-Language *

string

Preferred language of response

* Required parameter

Request Body

{
  "fullname": string,
  "start_point": [
    "number"
  ]
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

fullname	string Full name indicating the city (Moscow, Sadovnicheskaya Naberezhnaya, 82 bld. 2). It's important to enter a locality indicating the house number but without the apartment number, entrance, or floor
start_point[]	array Array of two real numbers [longitude, latitude]. The order is important!

* Required parameter

Responses

Code 200

{
  "express_delivery": {
    "allowed": boolean,
    "available_tariffs": [
      {
        "minimal_price": number,
        "name": string,
        "supported_requirements": [
          {
            "default": boolean,
            "name": string,
            "options": [
              {
                "text": string,
                "title": string
              }
            ],
            "required": boolean,
            "text": string,
            "title": string,
            "type": string
          }
        ],
        "text": string,
        "title": string
      }
    ]
  },
  "same_day_delivery": {
    "allowed": boolean,
    "available_intervals": [
      {
        "from": string,
        "to": string
      }
    ]
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

express_delivery *

object

Information about available "Express delivery" service classes

express_delivery.allowed *

boolean

"Express delivery" is available

express_delivery.available_tariffs[] *

array

Available "Express delivery" service classes

express_delivery.available_tariffs[].minimal_price *

number

express_delivery.available_tariffs[].name *

string

Service class

express_delivery.available_tariffs[].supported_requirements[] *

array

One Of:

express_delivery.available_tariffs[].supported_requirements[].name *	string Requirement type
express_delivery.available_tariffs[].supported_requirements[].options[] *	array Possible choices
express_delivery.available_tariffs[].supported_requirements[].options[].text *	string Localized description of the requirement
express_delivery.available_tariffs[].supported_requirements[].options[].title *	string Localized name of the requirement
express_delivery.available_tariffs[].supported_requirements[].options[].value *	object Value passed to enable the option
express_delivery.available_tariffs[].supported_requirements[].required *	boolean Required field
express_delivery.available_tariffs[].supported_requirements[].text *	string Localized description of the requirement type
express_delivery.available_tariffs[].supported_requirements[].title *	string Localized name of the requirement type
express_delivery.available_tariffs[].supported_requirements[].type *	string Type of choice Allowed values select multi_select

express_delivery.available_tariffs[].supported_requirements[].default *	boolean Default value
express_delivery.available_tariffs[].supported_requirements[].name *	string Requirement type
express_delivery.available_tariffs[].supported_requirements[].required *	boolean Required field
express_delivery.available_tariffs[].supported_requirements[].text *	string Localized description of the requirement type
express_delivery.available_tariffs[].supported_requirements[].title *	string Localized name of the requirement type
express_delivery.available_tariffs[].supported_requirements[].type *	string Type of choice Allowed values bool

express_delivery.available_tariffs[].supported_requirements[].name *

string

Requirement type

express_delivery.available_tariffs[].supported_requirements[].options[] *

array

Possible choices

express_delivery.available_tariffs[].supported_requirements[].options[].text *

string

Localized description of the requirement

express_delivery.available_tariffs[].supported_requirements[].options[].title *

string

Localized name of the requirement

express_delivery.available_tariffs[].supported_requirements[].options[].value *

object

Value passed to enable the option

express_delivery.available_tariffs[].supported_requirements[].required *

boolean

Required field

express_delivery.available_tariffs[].supported_requirements[].text *

string

Localized description of the requirement type

express_delivery.available_tariffs[].supported_requirements[].title *

string

Localized name of the requirement type

express_delivery.available_tariffs[].supported_requirements[].type *

string

Type of choice

Allowed values

select
multi_select

express_delivery.available_tariffs[].supported_requirements[].default *

boolean

Default value

express_delivery.available_tariffs[].supported_requirements[].name *

string

Requirement type

express_delivery.available_tariffs[].supported_requirements[].required *

boolean

Required field

express_delivery.available_tariffs[].supported_requirements[].text *

string

Localized description of the requirement type

express_delivery.available_tariffs[].supported_requirements[].title *

string

Localized name of the requirement type

express_delivery.available_tariffs[].supported_requirements[].type *

string

Type of choice

Allowed values

bool

express_delivery.available_tariffs[].text *

string

express_delivery.available_tariffs[].title *

string

same_day_delivery *

object

Information about available "Same day" delivery intervals

same_day_delivery.allowed *

boolean

"Same day" delivery is available

same_day_delivery.available_intervals[] *

array

Available "Same day" delivery intervals

same_day_delivery.available_intervals[].from *

string

Start of the time interval (UTC)

same_day_delivery.available_intervals[].to *

string

End of the time interval (UTC)

* Required parameter

Code 400

Invalid claim

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

code *	string Error code
message *	string Error description

* Required parameter

Example

Request:

curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/delivery-methods" \
-H "Accept-Language: {string}" \
-d '{
  "fullname": "St. Petersburg, Bolshaya Monetnaya Ulitsa, 1 bld. 1A",
  "start_point": [
    0.1,
    0.1
  ]
}'
Copied to clipboard

Responses:

{
  "express_delivery": {
    "available_tariffs": [
      {
        "minimal_price": 213,
        "name": "cargo",
        "supported_requirements": [
          {
            "name": "cargo_type",
            "options": [
              {
                "text": "170 cm in length, 100 cm in width, 90 cm in height",
                "title": "Small body"
              }
            ],
            "required": false,
            "text": "Requirement for transportation vehicle dimensions",
            "title": "Body type",
            "type": "select"
          }
        ],
        "text": "Express tariff",
        "title": "Express"
      }
    ]
  },
  "same_day_delivery": {
    "available_intervals": [
      {
        "from": "2020-01-01T00:00:00+00:00",
        "to": "2020-01-02T00:00:00+00:00"
      }
    ]
  }
}
Copied to clipboard

{
  "code": "validation_error",
  "message": "Validation error"
}
Copied to clipboard