Skip to content
Back to top
View this page

# ShippingQuery

class telegram.ShippingQuery(id, from_user, invoice_payload, shipping_address, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  This object contains information about an incoming shipping query.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `id` is equal.

  Note

  In Python `from` is a reserved word. Use `from_user` instead.

  Available In

  `telegram.Update.shipping_query`

  Parameters:

    - id (`str`) – Unique query identifier.

    - from_user (`telegram.User`) – User who sent the query.

    - invoice_payload (`str`) – Bot-specified invoice payload.

    - shipping_address (`telegram.ShippingAddress`) – User specified shipping address.

  id

    Unique query identifier.

    Type:

      `str`

  from_user

    User who sent the query.

    Type:

      `telegram.User`

  invoice_payload

    Bot-specified invoice payload.

    Type:

      `str`

  shipping_address

    User specified shipping address.

    Type:

      `telegram.ShippingAddress`

  async answer(ok, shipping_options=None, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)

    Shortcut for:

        await bot.answer_shipping_query(update.shipping_query.id, *args, **kwargs)

    For the documentation of the arguments, please see `telegram.Bot.answer_shipping_query()`.

  classmethod de_json(data, bot=None)

    See `telegram.TelegramObject.de_json()`.