answer_shipping_query()

Client.answer_shipping_query()

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the API sends the confirmation in the form of an ShippingQueryHandler.

Use this method to reply to shipping queries.

Usable by Users Bots
Parameters:
  • shipping_query_id (str) – Unique identifier for the query to be answered.

  • ok (bool) – Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

  • shipping_options (List of ShippingOptions, optional) – Required if ok is True. A array of available shipping options.

  • error_message (str, optional) – Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user.

Returns:

bool – True, on success.

Example

# Proceed with the order
await app.answer_shipping_query(query_id, ok=True, shipping_options=shipping_options)

# Answer with error message
await app.answer_shipping_query(query_id, ok=False, error_message="Error Message displayed to the user")