POST /answerShippingQuery

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
ok Boolean Yes

Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)

error_message String No

Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.

shipping_options[] Array No

Required if ok is True. A JSON-serialized array of available shipping options.

shipping_options[].id String Yes

Shipping option identifier

shipping_options[].prices[] Array Yes

List of price portions

shipping_options[].prices[].label String Yes

Portion label

shipping_options[].prices[].amount Integer Yes

Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

shipping_options[].title String Yes

Option title

shipping_query_id String Yes

Unique identifier for the query to be answered

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.