Skip to content

GramIO API Reference / gramio/dist / AnswerShippingQueryParams

Interface: AnswerShippingQueryParams

Defined in: @gramio/types/out/params.d.ts:4281

Params object for answerShippingQuery method

Properties

PropertyTypeDescriptionDefined in
error_message?stringRequired 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.@gramio/types/out/params.d.ts:4297
okbooleanPass 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)@gramio/types/out/params.d.ts:4289
shipping_options?TelegramShippingOption[]Required if ok is True. A JSON-serialized array of available shipping options.@gramio/types/out/params.d.ts:4293
shipping_query_idstringUnique identifier for the query to be answered@gramio/types/out/params.d.ts:4285