whatsapp-docs-mcp 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (406) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +181 -0
  3. package/dist/index.d.ts +3 -0
  4. package/dist/index.d.ts.map +1 -0
  5. package/dist/index.js +65 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/prompts.d.ts +22 -0
  8. package/dist/prompts.d.ts.map +1 -0
  9. package/dist/prompts.js +305 -0
  10. package/dist/prompts.js.map +1 -0
  11. package/dist/resources.d.ts +24 -0
  12. package/dist/resources.d.ts.map +1 -0
  13. package/dist/resources.js +132 -0
  14. package/dist/resources.js.map +1 -0
  15. package/dist/tools.d.ts +6 -0
  16. package/dist/tools.d.ts.map +1 -0
  17. package/dist/tools.js +379 -0
  18. package/dist/tools.js.map +1 -0
  19. package/dist/utils/fileLoader.d.ts +19 -0
  20. package/dist/utils/fileLoader.d.ts.map +1 -0
  21. package/dist/utils/fileLoader.js +126 -0
  22. package/dist/utils/fileLoader.js.map +1 -0
  23. package/dist/utils/search.d.ts +27 -0
  24. package/dist/utils/search.d.ts.map +1 -0
  25. package/dist/utils/search.js +91 -0
  26. package/dist/utils/search.js.map +1 -0
  27. package/docs/QUICK_REFERENCE.md +223 -0
  28. package/docs/anuncios_com_clique_para_whatsapp/AGENTS.md +8 -0
  29. package/docs/anuncios_com_clique_para_whatsapp/welcome_message_sequences.md +449 -0
  30. package/docs/ativos_da_conta/AGENTS.md +9 -0
  31. package/docs/ativos_da_conta/outros_ativos/AGENTS.md +12 -0
  32. package/docs/ativos_da_conta/outros_ativos/business_profiles.md +137 -0
  33. package/docs/ativos_da_conta/outros_ativos/display_names.md +108 -0
  34. package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +123 -0
  35. package/docs/ativos_da_conta/outros_ativos/qr_codes.md +198 -0
  36. package/docs/ativos_da_conta/outros_ativos/whatsapp_business_accounts.md +99 -0
  37. package/docs/ativos_da_conta/telefones_comerciais/AGENTS.md +11 -0
  38. package/docs/ativos_da_conta/telefones_comerciais/conversational_components.md +347 -0
  39. package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +486 -0
  40. package/docs/ativos_da_conta/telefones_comerciais/registration.md +171 -0
  41. package/docs/ativos_da_conta/telefones_comerciais/two_step_verification.md +66 -0
  42. package/docs/catalogos/AGENTS.md +12 -0
  43. package/docs/catalogos/receive_responses.md +28 -0
  44. package/docs/catalogos/sell_products_and_services.md +24 -0
  45. package/docs/catalogos/set_commerce_settings.md +163 -0
  46. package/docs/catalogos/share_products.md +401 -0
  47. package/docs/catalogos/upload_inventory.md +28 -0
  48. package/docs/comecar/AGENTS.md +8 -0
  49. package/docs/comecar/get_started.md +127 -0
  50. package/docs/dados_privacidade_e_politica/AGENTS.md +16 -0
  51. package/docs/dados_privacidade_e_politica/block_users.md +549 -0
  52. package/docs/dados_privacidade_e_politica/data_privacy_and_security.md +78 -0
  53. package/docs/dados_privacidade_e_politica/encryption.md +8 -0
  54. package/docs/dados_privacidade_e_politica/getting_opt_in.md +41 -0
  55. package/docs/dados_privacidade_e_politica/identity_change.md +34 -0
  56. package/docs/dados_privacidade_e_politica/local_storage.md +277 -0
  57. package/docs/dados_privacidade_e_politica/no_storage.md +132 -0
  58. package/docs/dados_privacidade_e_politica/policy_enforcement.md +85 -0
  59. package/docs/dados_privacidade_e_politica/policy_enforcement_violations.md +127 -0
  60. package/docs/grupos/AGENTS.md +15 -0
  61. package/docs/grupos/error_codes.md +170 -0
  62. package/docs/grupos/faq.md +30 -0
  63. package/docs/grupos/get_started.md +73 -0
  64. package/docs/grupos/groups.md +75 -0
  65. package/docs/grupos/groups_messaging.md +340 -0
  66. package/docs/grupos/pricing.md +322 -0
  67. package/docs/grupos/reference.md +1059 -0
  68. package/docs/grupos/webhooks.md +298 -0
  69. package/docs/index.md +318 -0
  70. package/docs/insights/AGENTS.md +8 -0
  71. package/docs/insights/analytics.md +944 -0
  72. package/docs/ligacoes/AGENTS.md +20 -0
  73. package/docs/ligacoes/app_review_guidelines.md +48 -0
  74. package/docs/ligacoes/business_initiated_calls.md +858 -0
  75. package/docs/ligacoes/call_button_messages_deep_links.md +454 -0
  76. package/docs/ligacoes/call_settings.md +643 -0
  77. package/docs/ligacoes/calling.md +130 -0
  78. package/docs/ligacoes/faq.md +468 -0
  79. package/docs/ligacoes/integration_patterns.md +121 -0
  80. package/docs/ligacoes/pricing.md +339 -0
  81. package/docs/ligacoes/reference.md +1923 -0
  82. package/docs/ligacoes/sip.md +1090 -0
  83. package/docs/ligacoes/troubleshooting.md +483 -0
  84. package/docs/ligacoes/user_call_permissions.md +672 -0
  85. package/docs/ligacoes/user_initiated_calls.md +1030 -0
  86. package/docs/mensagens/AGENTS.md +46 -0
  87. package/docs/mensagens/limites_de_mensagens/AGENTS.md +9 -0
  88. package/docs/mensagens/limites_de_mensagens/messaging_limits.md +91 -0
  89. package/docs/mensagens/limites_de_mensagens/upcoming_changes.md +8 -0
  90. package/docs/mensagens/recursos_adicionais/AGENTS.md +13 -0
  91. package/docs/mensagens/recursos_adicionais/contextual_replies.md +82 -0
  92. package/docs/mensagens/recursos_adicionais/link_previews.md +58 -0
  93. package/docs/mensagens/recursos_adicionais/mark_message_as_read.md +111 -0
  94. package/docs/mensagens/recursos_adicionais/media.md +419 -0
  95. package/docs/mensagens/recursos_adicionais/payload_encryption.md +8 -0
  96. package/docs/mensagens/recursos_adicionais/typing_indicators.md +117 -0
  97. package/docs/mensagens/tipos_de_mensagens/AGENTS.md +24 -0
  98. package/docs/mensagens/tipos_de_mensagens/address_messages.md +465 -0
  99. package/docs/mensagens/tipos_de_mensagens/audio_messages.md +211 -0
  100. package/docs/mensagens/tipos_de_mensagens/contacts_messages.md +482 -0
  101. package/docs/mensagens/tipos_de_mensagens/document_messages.md +232 -0
  102. package/docs/mensagens/tipos_de_mensagens/image_messages.md +176 -0
  103. package/docs/mensagens/tipos_de_mensagens/interactive_cta_url_messages.md +240 -0
  104. package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +8 -0
  105. package/docs/mensagens/tipos_de_mensagens/interactive_list_messages.md +300 -0
  106. package/docs/mensagens/tipos_de_mensagens/interactive_reply_buttons_messages.md +271 -0
  107. package/docs/mensagens/tipos_de_mensagens/location_messages.md +156 -0
  108. package/docs/mensagens/tipos_de_mensagens/location_request_messages.md +310 -0
  109. package/docs/mensagens/tipos_de_mensagens/message_with_link.md +8 -0
  110. package/docs/mensagens/tipos_de_mensagens/reaction_messages.md +144 -0
  111. package/docs/mensagens/tipos_de_mensagens/sticker_messages.md +157 -0
  112. package/docs/mensagens/tipos_de_mensagens/template_messages.md +20 -0
  113. package/docs/mensagens/tipos_de_mensagens/text_messages.md +142 -0
  114. package/docs/mensagens/tipos_de_mensagens/video_messages.md +149 -0
  115. package/docs/mensagens/visao_geral/AGENTS.md +8 -0
  116. package/docs/mensagens/visao_geral/send_messages.md +370 -0
  117. package/docs/mensagens_de_marketing/AGENTS.md +10 -0
  118. package/docs/mensagens_de_marketing/implementacao/AGENTS.md +10 -0
  119. package/docs/mensagens_de_marketing/implementacao/get_started.md +107 -0
  120. package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +180 -0
  121. package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +260 -0
  122. package/docs/mensagens_de_marketing/recursos/AGENTS.md +12 -0
  123. package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +8 -0
  124. package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +8 -0
  125. package/docs/mensagens_de_marketing/recursos/deep_links.md +302 -0
  126. package/docs/mensagens_de_marketing/recursos/track_click_events.md +119 -0
  127. package/docs/mensagens_de_marketing/recursos/view_metrics.md +338 -0
  128. package/docs/mensagens_de_marketing/visao_geral/AGENTS.md +8 -0
  129. package/docs/mensagens_de_marketing/visao_geral/overview.md +26 -0
  130. package/docs/modelos/AGENTS.md +12 -0
  131. package/docs/modelos/gerenciamento_de_modelos/AGENTS.md +21 -0
  132. package/docs/modelos/gerenciamento_de_modelos/components.md +717 -0
  133. package/docs/modelos/gerenciamento_de_modelos/supported_languages.md +462 -0
  134. package/docs/modelos/gerenciamento_de_modelos/tap_target_url_title_override.md +211 -0
  135. package/docs/modelos/gerenciamento_de_modelos/template_categorization.md +499 -0
  136. package/docs/modelos/gerenciamento_de_modelos/template_comparison.md +136 -0
  137. package/docs/modelos/gerenciamento_de_modelos/template_library.md +526 -0
  138. package/docs/modelos/gerenciamento_de_modelos/template_management.md +148 -0
  139. package/docs/modelos/gerenciamento_de_modelos/template_media.md +8 -0
  140. package/docs/modelos/gerenciamento_de_modelos/template_migration.md +164 -0
  141. package/docs/modelos/gerenciamento_de_modelos/template_pacing.md +38 -0
  142. package/docs/modelos/gerenciamento_de_modelos/template_pausing.md +58 -0
  143. package/docs/modelos/gerenciamento_de_modelos/template_quality.md +47 -0
  144. package/docs/modelos/gerenciamento_de_modelos/template_review.md +74 -0
  145. package/docs/modelos/gerenciamento_de_modelos/time_to_live.md +88 -0
  146. package/docs/modelos/modelos_de_autenticacao/AGENTS.md +13 -0
  147. package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +73 -0
  148. package/docs/modelos/modelos_de_autenticacao/authentication_templates.md +252 -0
  149. package/docs/modelos/modelos_de_autenticacao/autofill_button_authentication_templates.md +732 -0
  150. package/docs/modelos/modelos_de_autenticacao/copy_code_button_authentication_templates.md +402 -0
  151. package/docs/modelos/modelos_de_autenticacao/error_signals.md +143 -0
  152. package/docs/modelos/modelos_de_autenticacao/zero_tap_authentication_templates.md +742 -0
  153. package/docs/modelos/modelos_de_marketing/AGENTS.md +18 -0
  154. package/docs/modelos/modelos_de_marketing/call_permission_request_message_template.md +221 -0
  155. package/docs/modelos/modelos_de_marketing/catalog_templates.md +308 -0
  156. package/docs/modelos/modelos_de_marketing/coupon_templates.md +425 -0
  157. package/docs/modelos/modelos_de_marketing/custom_marketing_templates.md +537 -0
  158. package/docs/modelos/modelos_de_marketing/limited_time_offer_templates.md +496 -0
  159. package/docs/modelos/modelos_de_marketing/marketing_templates.md +112 -0
  160. package/docs/modelos/modelos_de_marketing/media_card_carousel_templates.md +770 -0
  161. package/docs/modelos/modelos_de_marketing/mpm_templates.md +717 -0
  162. package/docs/modelos/modelos_de_marketing/per_user_limits.md +42 -0
  163. package/docs/modelos/modelos_de_marketing/product_card_carousel_templates.md +515 -0
  164. package/docs/modelos/modelos_de_marketing/spm_templates.md +466 -0
  165. package/docs/modelos/modelos_de_utilidade/AGENTS.md +8 -0
  166. package/docs/modelos/modelos_de_utilidade/utility_templates.md +583 -0
  167. package/docs/modelos/visao_geral/AGENTS.md +8 -0
  168. package/docs/modelos/visao_geral/overview.md +163 -0
  169. package/docs/pagamentos/AGENTS.md +9 -0
  170. package/docs/pagamentos/pagamentos_na_india/AGENTS.md +19 -0
  171. package/docs/pagamentos/pagamentos_na_india/checkout_button_templates.md +1332 -0
  172. package/docs/pagamentos/pagamentos_na_india/enhanced_payment_links.md +93 -0
  173. package/docs/pagamentos/pagamentos_na_india/onboarding_apis.md +580 -0
  174. package/docs/pagamentos/pagamentos_na_india/orderdetailstemplate.md +205 -0
  175. package/docs/pagamentos/pagamentos_na_india/orderstatustemplate.md +143 -0
  176. package/docs/pagamentos/pagamentos_na_india/overview.md +102 -0
  177. package/docs/pagamentos/pagamentos_na_india/payment_links.md +581 -0
  178. package/docs/pagamentos/pagamentos_na_india/pg.md +1228 -0
  179. package/docs/pagamentos/pagamentos_na_india/upi_intent/AGENTS.md +12 -0
  180. package/docs/pagamentos/pagamentos_na_india/upi_intent/dynamic_vpa.md +572 -0
  181. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md +343 -0
  182. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md +145 -0
  183. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md +146 -0
  184. package/docs/pagamentos/pagamentos_na_india/upi_intent/upi_intent.md +660 -0
  185. package/docs/pagamentos/pagamentos_no_brasil/AGENTS.md +14 -0
  186. package/docs/pagamentos/pagamentos_no_brasil/boleto.md +104 -0
  187. package/docs/pagamentos/pagamentos_no_brasil/offsite_pix.md +128 -0
  188. package/docs/pagamentos/pagamentos_no_brasil/one_click_payments.md +226 -0
  189. package/docs/pagamentos/pagamentos_no_brasil/orderdetailstemplate.md +180 -0
  190. package/docs/pagamentos/pagamentos_no_brasil/orders.md +768 -0
  191. package/docs/pagamentos/pagamentos_no_brasil/overview.md +32 -0
  192. package/docs/pagamentos/pagamentos_no_brasil/payment_links.md +104 -0
  193. package/docs/parceiros/AGENTS.md +12 -0
  194. package/docs/parceiros/analise_do_app/AGENTS.md +8 -0
  195. package/docs/parceiros/analise_do_app/app_review.md +91 -0
  196. package/docs/parceiros/gerenciamento/AGENTS.md +14 -0
  197. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/AGENTS.md +15 -0
  198. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_accounts.md +274 -0
  199. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_system_users.md +106 -0
  200. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +277 -0
  201. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/AGENTS.md +9 -0
  202. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/manage_phone_numbers.md +248 -0
  203. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/registering_phone_numbers.md +373 -0
  204. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +551 -0
  205. package/docs/parceiros/gerenciamento/partner_led_business_verification.md +367 -0
  206. package/docs/parceiros/gerenciamento/pixel_tracking.md +35 -0
  207. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/AGENTS.md +18 -0
  208. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/adding_waba_to_mps.md +64 -0
  209. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/business_customer_support.md +102 -0
  210. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_embedded_signup.md +151 -0
  211. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_meta_business_suite.md +234 -0
  212. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +292 -0
  213. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_via_embedded_signup.md +118 -0
  214. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solution_partners_via_embedded_signup.md +76 -0
  215. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_embedded_signup.md +90 -0
  216. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_meta_business_suite.md +265 -0
  217. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/support.md +48 -0
  218. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +8 -0
  219. package/docs/parceiros/integracao_de_clientes/AGENTS.md +9 -0
  220. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/AGENTS.md +26 -0
  221. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/app_only_install.md +135 -0
  222. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/automatic_events_api.md +204 -0
  223. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/bypass_phone_addition.md +52 -0
  224. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/custom_flows.md +40 -0
  225. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/default_flow.md +90 -0
  226. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/errors.md +185 -0
  227. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/hosted_es.md +153 -0
  228. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +417 -0
  229. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +926 -0
  230. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_solution_partner.md +402 -0
  231. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_tech_provider.md +332 -0
  232. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +168 -0
  233. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_filled_data.md +524 -0
  234. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_verified_numbers.md +291 -0
  235. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/AGENTS.md +12 -0
  236. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_2_public_preview.md +88 -0
  237. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +98 -0
  238. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3_public_preview.md +88 -0
  239. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_4.md +92 -0
  240. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/versions.md +463 -0
  241. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/website_optional.md +57 -0
  242. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/AGENTS.md +11 -0
  243. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solution_embedded_creation.md +178 -0
  244. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +775 -0
  245. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_solution_conversations.md +319 -0
  246. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/partner_initiated_waba_creation.md +74 -0
  247. package/docs/parceiros/seja_um_parceiro/AGENTS.md +11 -0
  248. package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +280 -0
  249. package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +194 -0
  250. package/docs/parceiros/seja_um_parceiro/measurement_partners.md +146 -0
  251. package/docs/parceiros/seja_um_parceiro/upgrade_to_tech_partner.md +94 -0
  252. package/docs/parceiros/visao_geral/AGENTS.md +8 -0
  253. package/docs/parceiros/visao_geral/overview.md +190 -0
  254. package/docs/recado/AGENTS.md +9 -0
  255. package/docs/recado/precos/AGENTS.md +11 -0
  256. package/docs/recado/precos/pricing.md +915 -0
  257. package/docs/recado/precos/pricing_authentication_international_rates.md +464 -0
  258. package/docs/recado/precos/pricing_conversation_based_pricing.md +773 -0
  259. package/docs/recado/precos/pricing_updates_to_pricing.md +8 -0
  260. package/docs/recado/sobre_a_plataforma/AGENTS.md +10 -0
  261. package/docs/recado/sobre_a_plataforma/about_the_platform.md +217 -0
  262. package/docs/recado/sobre_a_plataforma/access_tokens.md +110 -0
  263. package/docs/recado/sobre_a_plataforma/permissions.md +55 -0
  264. package/docs/referencia/AGENTS.md +92 -0
  265. package/docs/referencia/bot_do_whatsapp_business/AGENTS.md +8 -0
  266. package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +762 -0
  267. package/docs/referencia/business/AGENTS.md +14 -0
  268. package/docs/referencia/business/add_phone_numbers_api.md +726 -0
  269. package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1006 -0
  270. package/docs/referencia/business/owned_whatsapp_business_accounts.md +802 -0
  271. package/docs/referencia/business/whatsapp_business_accounts_api.md +1550 -0
  272. package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +783 -0
  273. package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +790 -0
  274. package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +886 -0
  275. package/docs/referencia/changelog.md +10 -0
  276. package/docs/referencia/conta_do_whatsapp_business/AGENTS.md +24 -0
  277. package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2202 -0
  278. package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +267 -0
  279. package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +275 -0
  280. package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +782 -0
  281. package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1532 -0
  282. package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +8 -0
  283. package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +1581 -0
  284. package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +8 -0
  285. package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +1686 -0
  286. package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1772 -0
  287. package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +8 -0
  288. package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +8 -0
  289. package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +2178 -0
  290. package/docs/referencia/conta_do_whatsapp_business/template_api.md +976 -0
  291. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +842 -0
  292. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1384 -0
  293. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +854 -0
  294. package/docs/referencia/grupo/AGENTS.md +11 -0
  295. package/docs/referencia/grupo/groups_invite_link_api.md +304 -0
  296. package/docs/referencia/grupo/groups_join_requests_api.md +686 -0
  297. package/docs/referencia/grupo/groups_participants_api.md +274 -0
  298. package/docs/referencia/grupo/groups_query_api.md +436 -0
  299. package/docs/referencia/historico_de_mensagens/AGENTS.md +8 -0
  300. package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +866 -0
  301. package/docs/referencia/inscricao/AGENTS.md +10 -0
  302. package/docs/referencia/inscricao/application_connected_client_businesses.md +812 -0
  303. package/docs/referencia/inscricao/application_solutions_api.md +874 -0
  304. package/docs/referencia/inscricao/solution_creation_api.md +824 -0
  305. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/AGENTS.md +8 -0
  306. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +724 -0
  307. package/docs/referencia/midias/AGENTS.md +9 -0
  308. package/docs/referencia/midias/media_api.md +342 -0
  309. package/docs/referencia/midias/media_download_api.md +160 -0
  310. package/docs/referencia/numero_da_conta_do_whatsapp/AGENTS.md +8 -0
  311. package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +778 -0
  312. package/docs/referencia/perfil_do_whatsapp_business/AGENTS.md +8 -0
  313. package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1494 -0
  314. package/docs/referencia/solucao_do_whatsapp_business/AGENTS.md +14 -0
  315. package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +762 -0
  316. package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +704 -0
  317. package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +812 -0
  318. package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +778 -0
  319. package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +812 -0
  320. package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +768 -0
  321. package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +798 -0
  322. package/docs/referencia/telefone_do_whatsapp_business/AGENTS.md +29 -0
  323. package/docs/referencia/telefone_do_whatsapp_business/block_api.md +542 -0
  324. package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1608 -0
  325. package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1402 -0
  326. package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +598 -0
  327. package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +482 -0
  328. package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +485 -0
  329. package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +315 -0
  330. package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +188 -0
  331. package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1798 -0
  332. package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +377 -0
  333. package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +714 -0
  334. package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +780 -0
  335. package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +734 -0
  336. package/docs/referencia/telefone_do_whatsapp_business/register_api.md +411 -0
  337. package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +674 -0
  338. package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +746 -0
  339. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +932 -0
  340. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1540 -0
  341. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1600 -0
  342. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1478 -0
  343. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1179 -0
  344. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1315 -0
  345. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/AGENTS.md +11 -0
  346. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +778 -0
  347. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +768 -0
  348. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1382 -0
  349. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +820 -0
  350. package/docs/referencia/usuario/AGENTS.md +8 -0
  351. package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +864 -0
  352. package/docs/referencia/webhooks/AGENTS.md +8 -0
  353. package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1655 -0
  354. package/docs/suporte/AGENTS.md +13 -0
  355. package/docs/suporte/api_status_page.md +134 -0
  356. package/docs/suporte/error_codes.md +1194 -0
  357. package/docs/suporte/experiments.md +26 -0
  358. package/docs/suporte/health_status.md +225 -0
  359. package/docs/suporte/load_testing.md +340 -0
  360. package/docs/suporte/support.md +408 -0
  361. package/docs/visao_geral/AGENTS.md +8 -0
  362. package/docs/visao_geral/overview.md +2590 -0
  363. package/docs/webhooks/AGENTS.md +41 -0
  364. package/docs/webhooks/referencia/AGENTS.md +20 -0
  365. package/docs/webhooks/referencia/account_alerts.md +190 -0
  366. package/docs/webhooks/referencia/account_review_update.md +90 -0
  367. package/docs/webhooks/referencia/account_update.md +379 -0
  368. package/docs/webhooks/referencia/business_capability_update.md +121 -0
  369. package/docs/webhooks/referencia/history.md +302 -0
  370. package/docs/webhooks/referencia/message_template_components_update.md +179 -0
  371. package/docs/webhooks/referencia/message_template_quality_update.md +136 -0
  372. package/docs/webhooks/referencia/message_template_status_update.md +253 -0
  373. package/docs/webhooks/referencia/messages/AGENTS.md +24 -0
  374. package/docs/webhooks/referencia/messages/audio.md +298 -0
  375. package/docs/webhooks/referencia/messages/button.md +170 -0
  376. package/docs/webhooks/referencia/messages/contacts.md +491 -0
  377. package/docs/webhooks/referencia/messages/document.md +307 -0
  378. package/docs/webhooks/referencia/messages/errors.md +132 -0
  379. package/docs/webhooks/referencia/messages/image.md +304 -0
  380. package/docs/webhooks/referencia/messages/interactive.md +225 -0
  381. package/docs/webhooks/referencia/messages/location.md +296 -0
  382. package/docs/webhooks/referencia/messages/messages.md +44 -0
  383. package/docs/webhooks/referencia/messages/order.md +208 -0
  384. package/docs/webhooks/referencia/messages/reaction.md +178 -0
  385. package/docs/webhooks/referencia/messages/status.md +364 -0
  386. package/docs/webhooks/referencia/messages/sticker.md +298 -0
  387. package/docs/webhooks/referencia/messages/system.md +140 -0
  388. package/docs/webhooks/referencia/messages/text.md +322 -0
  389. package/docs/webhooks/referencia/messages/unsupported.md +165 -0
  390. package/docs/webhooks/referencia/messages/video.md +304 -0
  391. package/docs/webhooks/referencia/outros_webhooks/AGENTS.md +16 -0
  392. package/docs/webhooks/referencia/outros_webhooks/partner_solutions.md +114 -0
  393. package/docs/webhooks/referencia/outros_webhooks/payment_configuration_update.md +135 -0
  394. package/docs/webhooks/referencia/outros_webhooks/phone_number_name_update.md +129 -0
  395. package/docs/webhooks/referencia/outros_webhooks/phone_number_quality_update.md +172 -0
  396. package/docs/webhooks/referencia/outros_webhooks/security.md +108 -0
  397. package/docs/webhooks/referencia/outros_webhooks/smb_app_state_sync.md +146 -0
  398. package/docs/webhooks/referencia/outros_webhooks/smb_message_echoes.md +143 -0
  399. package/docs/webhooks/referencia/outros_webhooks/template_category_update.md +154 -0
  400. package/docs/webhooks/referencia/outros_webhooks/user_preferences.md +150 -0
  401. package/docs/webhooks/visao_geral/AGENTS.md +11 -0
  402. package/docs/webhooks/visao_geral/message_echoes.md +8 -0
  403. package/docs/webhooks/visao_geral/override.md +235 -0
  404. package/docs/webhooks/visao_geral/overview.md +158 -0
  405. package/docs/webhooks/visao_geral/set_up_whatsapp_echo_bot.md +109 -0
  406. package/package.json +50 -0
@@ -0,0 +1,1332 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-in/checkout-button-templates -->
2
+ <!-- Scraped: 2025-12-20T17:46:09.936Z -->
3
+
4
+ # Modelos com botão de finalização da compra
5
+
6
+ Updated: 3 de nov de 2025
7
+
8
+ Os modelos de botão de finalização da compra são modelos de marketing que podem exibir um ou mais produtos juntamente com os botões de finalização da compra correspondentes que os usuários do WhatsApp podem usar para fazer compras sem sair do cliente do WhatsApp.
9
+
10
+ ![](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/461864193_1053025166222560_1984323495828319066_n.png?_nc_cat=108&ccb=1-7&_nc_sid=e280be&_nc_ohc=Dewt7_RiaqwQ7kNvwHJpwB2&_nc_oc=AdnU7zHhkbqN--vtS6CDywyubSm7O1oC-4va413YXEUyIE-PAVMrf5gZY5wVeZw46_s&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_AfmjkyJyJo71rodI0-FkCGzE2dfUvHX8_15cI_703dhTyQ&oe=69611FBC)
11
+
12
+ ## Produtos únicos
13
+
14
+ Os modelos de botão de finalização da compra podem mostrar uma imagem ou um cabeçalho de vídeo de produto único, juntamente com o corpo e o rodapé da mensagem, um botão de finalização da compra e até 9 botões de resposta rápida.
15
+
16
+ ![](https://scontent-gru2-1.xx.fbcdn.net/v/t39.2365-6/461716389_980926930508984_4731907095777942335_n.png?_nc_cat=109&ccb=1-7&_nc_sid=e280be&_nc_ohc=1cHy8ASDwYkQ7kNvwEIdZ_z&_nc_oc=AdkZ_ukImm5n2NNMD-_OjSnv3EivRxzmT4_Ydd7_UhswzgSf27DIGGtjCZrPms6Vzvg&_nc_zt=14&_nc_ht=scontent-gru2-1.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_AfnKBuY-hC3ZcSJJktNNwCebmmB1fNny5teX1KJUWWzh0Q&oe=696137F7)
17
+
18
+ Os usuários do WhatsApp que tocarem no botão verão os seguintes detalhes do pedido:
19
+
20
+ ![](https://scontent-gru2-1.xx.fbcdn.net/v/t39.2365-6/461898315_2387340868275631_829544685895208004_n.png?_nc_cat=109&ccb=1-7&_nc_sid=e280be&_nc_ohc=aR5XwuUV1H8Q7kNvwHuAf_A&_nc_oc=AdlWlLAYXbG5BXJYstJumTW_dI7k2oBj1inQnucPJk3CVFgBOH76Yb_-e2buyEN8F1s&_nc_zt=14&_nc_ht=scontent-gru2-1.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_Afkse8Hbnh2A3XnjeASL7nfxq0lbufuJ2ticJyDB1o-6cA&oe=69612B4B)
21
+
22
+ Para continuar, os usuários podem selecionar as informações de envio fornecidas por você (se souber e tiver fornecido essas informações na carga de envio de mensagem)...
23
+
24
+ ![](https://scontent-gru2-1.xx.fbcdn.net/v/t39.2365-6/461872330_923861569791765_2740463248926355079_n.png?_nc_cat=107&ccb=1-7&_nc_sid=e280be&_nc_ohc=zJvQkMplRqAQ7kNvwG3TBIt&_nc_oc=AdlJMdCUd2FX5yoAWQOT62Vb-rFkFFxnzKLZ1Hsd0r4SUp2SIdn2-oaHgeHxOGyFBxA&_nc_zt=14&_nc_ht=scontent-gru2-1.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_AfnRg97QZkD6h3F708WnZFXRxzcUfuvJ_ZlNz3mGM3j4lw&oe=69611AEA)
25
+
26
+ ... ou podem adicionar as próprias informações de envio:
27
+
28
+ ![](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/461774395_433815155940531_3266765354702751375_n.png?_nc_cat=108&ccb=1-7&_nc_sid=e280be&_nc_ohc=McHFgifk45gQ7kNvwFeI7Bo&_nc_oc=AdmiDsLzE0iC_ZWyg0NvPZ6fu7CgOlS7A4JQ4c95H9RAsbrtx8PCnuMLcjqxPFnsGnQ&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_AflHNhImM_N6ZsFsuItvtFmEzVu7jKLNeUww04HfiqIaQA&oe=69612DD9)
29
+
30
+ ## Como habilitar cupons, inventário em tempo real e atualizações de preços
31
+
32
+ A habilitação de cupons, inventário em tempo real e atualizações de preços está em versão beta e disponível apenas para empresas da Índia e usuários do WhatsApp com um código de ligação de país da Índia. Para saber mais, entre em contato com whatsappindia-bizpayments-support@meta.com.
33
+
34
+ Para habilitar cupons, inventário em tempo real e atualizações de preços, você pode configurar um ponto de extremidade de finalização da compra que troca dados em tempo real para atualizar o pedido no cliente do WhatsApp. Com essa opção, as empresas recebem o endereço de entrega e oferecem cupons com base no pedido, permitindo que os usuários apliquem o cupom. Isso também permite que as empresas validem o inventário e a capacidade de atendimento do pedido antes da finalização da compra.
35
+
36
+ A configuração do ponto de extremidade de finalização da compra inclui as etapas a seguir e é o mesmo método que o [ponto de extremidade do WhatsApp Flows](/docs/whatsapp/flows/guides/implementingyourflowendpoint#implementing-endpoint-for-flows) usa para compartilhar os dados com os clientes do WhatsApp.
37
+
38
+ - Crie um par de chaves, carregue e assine a chave pública usando a [API de Nuvem](/docs/whatsapp/cloud-api/reference/whatsapp-business-encryption#set-business-public-key).- [Configurar o ponto de extremidade](#setup_the_endpoint)- [Implementar a criptografia/descriptografia de carga](#implement_encryption_decryption)- [Vincular o ponto de extremidade de finalização da compra com a configuração de pagamento](#link_checkout_endpoint)- [Implementar a lógica do ponto de extremidade de finalização da compra](#implement_checkout_logic)
39
+
40
+ ### Configurar o ponto de extremidade
41
+
42
+ O cliente do WhatsApp faz uma solicitação HTTPS para trocar os dados com o ponto de extremidade da empresa. Verifique se o ponto de extremidade está configurado para aceitar a solicitação e vincule o URL do ponto de extremidade à [configuração de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#link-your-payment-account):
43
+
44
+ ```
45
+ https://business.com/checkout
46
+ ```
47
+
48
+ Seu servidor deve estar habilitado para receber e processar solicitações `POST`, usar `HTTPS` e ter um certificado TLS/SSL válido instalado. Esse certificado não precisa ser usado para criptografia/descriptografia de carga.
49
+
50
+ ### Implementar a criptografia/descriptografia
51
+
52
+ O corpo de cada solicitação contém a carga criptografada e aparece da seguinte forma:
53
+
54
+ #### Exemplo de sintaxe de solicitação do ponto de extremidade
55
+
56
+ ```
57
+ {
58
+ encrypted_flow_data: "<ENCRYPTED_FLOW_DATA>",
59
+ encrypted_aes_key: "<ENCRYPTED_AES_KEY>",
60
+ initial_vector: "<INITIAL_VECTOR>"
61
+ }
62
+ ```
63
+
64
+ Parâmetro
65
+
66
+ Descrição
67
+
68
+ String `encrypted_flow_data`
69
+
70
+ **Obrigatório.** A carga criptografada da solicitação.
71
+
72
+ String `encrypted_aes_key`
73
+
74
+ **Obrigatório.** A chave AES de 128 bits criptografada.
75
+
76
+ String `initial_vector`
77
+
78
+ **Obrigatório.** O vetor de inicialização de 128 bits.
79
+
80
+ Depois de processar a solicitação descriptografada, crie uma resposta e criptografe-a antes de enviá-la de volta para o cliente do WhatsApp. Criptografe a carga usando a chave AES recebida na solicitação e envie-a de volta como uma string Base64.
81
+
82
+ Consulte exemplos de como [descriptografar e criptografar](/docs/whatsapp/flows/guides/implementingyourflowendpoint#request-decryption-and-encryption).
83
+
84
+ Se uma solicitação não puder ser descriptografada, o ponto de extremidade retornará o código de status da resposta HTTP 421 (consulte [Códigos de erro do ponto de extremidade comercial](/docs/whatsapp/flows/reference/error-codes#endpoint_error_codes) para saber mais).
85
+
86
+ #### Exemplo de resposta do ponto de extremidade
87
+
88
+ ```
89
+ curl -i -H "Content-Type: application/json" -X POST -d '{"encrypted_flow_data":"4Wor0bpfvrNqnkH+XQZLn3HnU2Zi7hG\\/UHjISS93Fzn9J7youssaLeXlNUH","encrypted_aes_key":"ufA0fXD1Wz...","initial_vector":"G\\/1rq1naEOMR4TJHFvIs\\/Q==."}' 'https://business.com/checkout'HTTP/2 200content-type: text/plaincontent-length: 232date: Wed, 06 Jul 2022 14:03:03 GMTyZcJQaH3AqfzKgjn64vAcASaJrOMN27S6CESyU68WN/cDCP6abskoMa/pPjszXGKyyh/23lw84HW6ZilMfU6KL3j5AWwOx6GWNwtq8Aj7gz/Y7R+LccmJWxKo2UccMu5xJlduIFlFlOS1gAnOwKrk8wpuprsi4jAOspw3xO2uh3J883aC/csu/MhRPiYCaGGy/tTNvVDmb2Gw1WXFmpvLsZ/SBrgG0cDQJjQzpTO
90
+ ```
91
+
92
+ ### Vincular o ponto de extremidade de finalização da compra com a configuração de pagamento
93
+
94
+ A empresa deve ter uma [configuração de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#link-your-payment-account) baseada em gateway de pagamento e entrar em contato com whatsappindia-bizpayments-support@meta.com para habilitar a vinculação do ponto de extremidade de finalização da compra com a configuração de pagamento na conta do WhatsApp Business.
95
+
96
+ Antes de vincular o ponto de extremidade de finalização da compra, você deve criar uma [configuração de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#link-your-payment-account) e vincular à conta do gateway de pagamento. Recomendamos que você use a configuração de pagamento vinculada apenas com a integração de modelo de botão de finalização da compra.
97
+
98
+ Para vincular o ponto de extremidade com a configuração de pagamento, siga [APIs de integração – Vincular ponto de extremidade de dados](/documentation/business-messaging/whatsapp/payments/payments-in/onboarding-apis#link-or-update-data-endpoint)
99
+
100
+ ### Implementar a lógica do ponto de extremidade da finalização da compra
101
+
102
+ A integração do ponto de extremidade de finalização da compra do WhatsApp herda a permissão "data\_exchange", semelhante ao Flows. Além disso, oferece suporte ao conjunto de subações baseadas na interação do usuário e transmite as informações relevantes em cada uma dessas ações para permitir que as empresas forneçam cupons específicos de usuários e atualizem as informações de preços de acordo.
103
+
104
+ Subação
105
+
106
+ Método
107
+
108
+ Descrição
109
+
110
+ `get_coupons`
111
+
112
+ Solicitação
113
+
114
+ Quando os usuários clicam em uma CTA de oferta de descontos, o WhatsApp transmite [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject), excluindo as [configurações de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paymentsettingsobject). Ele também transmite `user phone number` como um parâmetro de entrada.
115
+
116
+ ```
117
+ {  "input":  {    "user_id": "user_phone_number"  }}
118
+ ```
119
+
120
+ Consulte o exemplo de [solicitação de obtenção de cupons](#get_coupon_request) para entender a ordem e os parâmetros de entrada
121
+
122
+ Resposta
123
+
124
+ O ponto de extremidade de finalização da compra deve transmitir a lista de informações do cupom, como código, identificação e descrição.
125
+
126
+ ```
127
+ {  "coupons":    [        {            "code": "coupon_code",            "id": "coupon_id",            "description": "coupon_description"        }    ]}
128
+ ```
129
+
130
+ Consulte o exemplo de [resposta de obtenção de cupons](#get_coupon_response) para entender a resposta esperada.
131
+
132
+ `apply_coupon`
133
+
134
+ Solicitação
135
+
136
+ Quando os usuários selecionam ou inserem um cupom, o WhatsApp transmite [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject), excluindo as [configurações de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paymentsettingsobject). Também transmite `user phone number` e informações sobre o cupom a ser aplicado como um parâmetro de entrada.
137
+
138
+ ```
139
+ {  "input":  {    "user_id": "user_phone_number",    "coupon":    {      "code": "WELCOME70"    }  }}
140
+ ```
141
+
142
+ Consulte o exemplo de [solicitação de aplicação de cupom](#apply_coupon_request) para entender a ordem e os parâmetros de entrada
143
+
144
+ Resposta
145
+
146
+ O ponto de extremidade de finalização da compra deve atualizar o item e o preço do pedido em [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject) e anexar o cupom ao pedido
147
+
148
+ Consulte o exemplo de [resposta de aplicação de cupom](#apply_coupon_response) para entender a resposta esperada.
149
+
150
+ `remove_coupon`
151
+
152
+ Solicitação
153
+
154
+ Quando os usuários tentam remover um cupom aplicado, o WhatsApp transmite [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject), excluindo as [configurações de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paymentsettingsobject). Ele também transmite `user phone number` como um parâmetro de entrada.
155
+
156
+ ```
157
+ {  "input":  {    "user_id": "user_phone_number"  }}
158
+ ```
159
+
160
+ Consulte o exemplo de [solicitação de remoção de cupom](#remove_coupon_request) para entender a resposta esperada.
161
+
162
+ Resposta
163
+
164
+ O ponto de extremidade de finalização da compra deve atualizar o item e o preço do pedido em [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject) e remover o cupom anexado ao pedido.
165
+
166
+ Consulte o exemplo de [resposta de remoção de cupom](#remove_coupon_response) para entender a resposta esperada.
167
+
168
+ `apply_shipping`
169
+
170
+ Solicitação
171
+
172
+ Quando os usuários tentam enviar um endereço de entrega, o WhatsApp transmite [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject), excluindo as [configurações de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paymentsettingsobject). Também transmite as informações de envio e `user phone number` como um parâmetro de entrada.
173
+
174
+ ```
175
+ {  "input":  {    "user_id": "user_phone_number"  }}
176
+ ```
177
+
178
+ Consulte o exemplo de [solicitação de aplicação de envio](#apply_shipping_request) para entender a resposta esperada.
179
+
180
+ Resposta
181
+
182
+ O ponto de extremidade de finalização da compra deve atualizar o item e o custo de envio em [parâmetros de pedido](/documentation/business-messaging/whatsapp/payments/payments-in/pg#paramobject).
183
+
184
+ Consulte o exemplo de [resposta da aplicação de envio](#apply_shipping_response) para entender a resposta esperada.
185
+
186
+ Criamos um [exemplo de ponto de extremidade de finalização da compra](https://l.facebook.com/l.php?u=https%3A%2F%2Fgithub.com%2FWhatsApp%2FWhatsApp-Checkout-Button-Template-Endpoint&h=AT2NzfGirew_5IjpruU2uBTSmpPHEJz_vdsV8L2aQsnXg6xGo1EUI_HgnlQu9OMBV4uH7SEprIZkmP7YwIrQi1TGA-yQSLijlj9JpbZMcmlBkXsPYCeeJspIZGv0b7krCzcaAk3czZfkAb7aMozjdU61RHs) no Node.js que você pode clonar (remixar) no Glitch para criar seu próprio ponto de extremidade e fazer um protótipo da lógica de finalização da compra. Para começar, siga as instruções no arquivo [README.md](https://l.facebook.com/l.php?u=https%3A%2F%2Fgithub.com%2FWhatsApp%2FWhatsApp-Checkout-Button-Template-Endpoint%2Fblob%2Fmain%2FREADME.md&h=AT2NzfGirew_5IjpruU2uBTSmpPHEJz_vdsV8L2aQsnXg6xGo1EUI_HgnlQu9OMBV4uH7SEprIZkmP7YwIrQi1TGA-yQSLijlj9JpbZMcmlBkXsPYCeeJspIZGv0b7krCzcaAk3czZfkAb7aMozjdU61RHs). O uso do Glitch é totalmente opcional. É possível clonar o código de exemplo do Glitch e executá-lo em qualquer ambiente da sua preferência. Depois de concluir as etapas acima, quando a empresa envia o modelo de finalização da compra com a configuração de pagamento vinculada, o WhatsApp habilita os cupons, o inventário em tempo real e as atualizações de preços, além de permitir que os usuários apliquem cupons e compartilhem endereços de entrega.
187
+
188
+ Quando habilitado, o `Apply a savings offer` aparecerá na tela de resumo do pedido
189
+
190
+ ![Image](https://scontent-gru1-1.xx.fbcdn.net/v/t39.2365-6/566208922_1339318471260137_8031940610378006006_n.jpg?_nc_cat=104&ccb=1-7&_nc_sid=e280be&_nc_ohc=y7ui9Fa0x9EQ7kNvwEFjtpv&_nc_oc=Adl281s3rXoSiIZZlr0Y_fw_zYA_xvdUJ6W79AQjqfY2RyrLWrHxPmAhFwWTHf5mg_U&_nc_zt=14&_nc_ht=scontent-gru1-1.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_AfnZlOx52qyrDcOmYb-1oN7ehs8zxH2Tgb2n3_zffi9TWw&oe=69613620)
191
+
192
+ O usuário pode clicar em `Apply a savings offer` para explorar os cupons. Nesse momento, o WhatsApp faz uma `get_coupons` solicitação para buscar a lista de cupons com base nas informações de `user phone number` e pedidos passados.
193
+
194
+ ![Image](https://scontent-gru2-1.xx.fbcdn.net/v/t39.2365-6/560013461_1339318424593475_5113635030322783543_n.jpg?_nc_cat=111&ccb=1-7&_nc_sid=e280be&_nc_ohc=YvUG8mbT_kwQ7kNvwFpwOAh&_nc_oc=Adl50UJJBWnG0yznvDYdo0Xx84iTLkHNRQfq6dtvoWytvo7Q95jx6hjl7tPhFQHkzzk&_nc_zt=14&_nc_ht=scontent-gru2-1.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_Afk4Cu4g7_0SKyCIXt-D0HV9DBO8JHBVWaoeKxx_iSgCBg&oe=69612F2B)
195
+
196
+ Quando o usuário tenta aplicar um cupom, o WhatsApp faz `apply_coupon` e permite que as empresas atualizem o pedido ou o preço do item com base no cupom selecionado.
197
+
198
+ ![Image](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/560498579_1339318444593473_8466127193448601632_n.jpg?_nc_cat=110&ccb=1-7&_nc_sid=e280be&_nc_ohc=MWyvO-V2tQMQ7kNvwG9Xqc2&_nc_oc=AdlhNdUA8vwkpI_RUJrLLZ1vOMGIv9tnpF6rxv87pfQVKyaQZjXxqzKdnoR2kdLpk6o&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_Afkfk6eZNdYqpJJa8VjjRX8P5Z338pq8ZOwog2iqPy_4kg&oe=69610CF9)
199
+
200
+ Assim como com os cupons, o usuário pode compartilhar o endereço de entrega clicando em `Add shipping address` e selecionando os endereços salvos com as empresas ou adicionando um novo endereço. O WhatsApp faz uma solicitação `apply_shipping` quando o usuário tenta enviar o endereço e permite que as empresas verifiquem o inventário e a logística com base no endereço fornecido.
201
+
202
+ ![Image](https://scontent-gru2-1.xx.fbcdn.net/v/t39.2365-6/561725167_1339318187926832_1852627850653076539_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=e280be&_nc_ohc=23ts7MmHSHIQ7kNvwHDByyO&_nc_oc=AdlqYHqGYjgkCkfmwyDOQOS0XsT9lPNo9XPzy5NFZ3tOvavLWHMLwtQ6tSFQutKXSr8&_nc_zt=14&_nc_ht=scontent-gru2-1.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_AfmDuu8X8OFTW_Eo5Y0gyQ1zurA89vvEE-77aaMXEnB16w&oe=696133D2)![Image](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/560467967_1339318057926845_5662577297785116122_n.jpg?_nc_cat=108&ccb=1-7&_nc_sid=e280be&_nc_ohc=hVD1myP_J8gQ7kNvwHZdCyK&_nc_oc=Adm7jcmYq7-0VDaHodwrSjJ16QgLqAPykKWhy1K87Yh_U0aVqNQE0bvUzMmmgY6vh3c&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_Afk9CWNmY75-FveeadZRqk1kFqEpFVJ4pNAl7V05HcuGLw&oe=69613024)
203
+
204
+ Os usuários podem continuar a fazer o pedido usando a forma de pagamento preferencial configurada no cliente do WhatsApp:
205
+
206
+ ![](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/461783140_456335920794267_694558377704466245_n.png?_nc_cat=108&ccb=1-7&_nc_sid=e280be&_nc_ohc=1vVb5h9qTXYQ7kNvwFNGs2G&_nc_oc=AdmuVw8l5H2btROXYZlxSotSvAmLHCa7QP5OLwdg_HIwC1aYUUawqUiBfgeqRijkvgQ&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=sd6uHUO2SY6EGltFStOA7w&oh=00_Aflh33-hED7WGUZ7BMuBcLr94_VI_XBa8RrHOoPA7U1uQQ&oe=69612B1D)
207
+
208
+ Após o processamento do pedido, um [webhook de pagamento](/documentation/business-messaging/whatsapp/payments/payments-in/pg#step-2--receive-webhook-about-transaction-status) é disparado.
209
+
210
+ ## Vários produtos
211
+
212
+ É possível criar um [modelo de carrossel de cartões de mídia](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) que mostra até 10 produtos em um carrossel de cartões, cada um com o próprio botão de finalização da compra. Para isso, crie um modelo de carrossel de cartão de mídia como de costume, mas substitua um dos botões por um [botão de finalização da compra](#checkout-buttons). Além disso, verifique se esse é o primeiro botão no cartão.
213
+
214
+ Os botões de finalização da compra em modelos de carrossel com cartão de mídia acionam o mesmo fluxo de pedido e pagamento que os botões de finalização da compra em modelos que exibem um único produto.
215
+
216
+ ## Botões de finalização da compra
217
+
218
+ Cada botão de finalização da compra em um modelo deve corresponder a um único produto. Os botões de finalização da compra, ao criar um modelo, devem ter a seguinte sintaxe não personalizável:
219
+
220
+ ```
221
+ {  "type": "order_details",  "text": "Buy now"}
222
+ ```
223
+
224
+ Observe que isso é apenas uma definição de botão. Os detalhes reais sobre o produto relacionado a esse botão são incluídos quando você [envia o modelo](#sending-payment-button-templates) em uma mensagem de modelo. Por exemplo:
225
+
226
+ ```
227
+ {  "type": "button",  "sub_type": "order_details",  "index": 0,  "parameters": [    {      "type": "action",      "action": {        "order_details": {          "reference_id": "abc.123_xyz-1",          "type": "physical-goods",          "currency": "INR",          "payment_settings": [            {              "type": "payment_gateway",              "payment_gateway": {                "type": "razorpay",                "configuration_name": "prod-razor-pay-config-05"              }            }          ],          "shipping_info": {            "country": "IN",            "addresses": [              {                "name": "Nidhi Tripathi",                "phone_number": "919000090000",                "address": "Bandra Kurla Complex",                "city": "Mumbai",                "state": "Maharastra",                "in_pin_code": "400051",                "house_number": "12",                "tower_number": "5",                "building_name": "One BKC",                "landmark_area": "Near BKC Circle"              }            ]          },          "order": {            "items": [              {                "amount": {                  "offset": 100,                  "value": 200000                },                "sale_amount": {                  "offset": 100,                  "value": 150000                },                "name": "Blue Elf Aloe",                "quantity": 1,                "country_of_origin": "India",                "importer_name": "Lucky Shrub Imports and Exports",                "importer_address": {                  "address_line1": "One BKC",                  "address_line2": "Bandra Kurla Complex",                  "city": "Mumbai",                  "zone_code": "MH",                  "postal_code": "400051",                  "country_code": "IN"                }              }            ],            "subtotal": {              "offset": 100,              "value": 150000            },            "shipping": {              "offset": 100,              "value": 20000            },            "tax": {              "offset": 100,              "value": 10000            },            "discount": {              "offset": 100,              "value": 15000,              "description": "Additional 10% off"            },            "status": "pending",            "expiration": {              "timestamp": "1726627150"            }          },          "total_amount": {            "offset": 100,            "value": 165000          }        }      }    }  ]}
228
+ ```
229
+
230
+ Se você estiver enviando um [modelo de carrossel de cartão de mídia](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) (que pode ter dois ou mais produtos), cada botão de finalização da compra deve ser definido no modelo. Os detalhes do item que mapeiam para cada botão devem ser incluídos quando o modelo for enviado.
231
+
232
+ ## Como criar modelos com botão de finalização da compra
233
+
234
+ Use o ponto de extremidade [**POST /<WHATSAPP\_BUSINESS\_ACCOUNT\_ID>/message\_templates**](/documentation/business-messaging/whatsapp/reference/whatsapp-business-account/template-api#post-version-waba-id-message-templates) para criar um modelo com botão de finalização da compra.
235
+
236
+ ### Sintaxe da solicitação
237
+
238
+ ```
239
+ POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates
240
+ ```
241
+
242
+ ### Corpo do post
243
+
244
+ O corpo do post abaixo é para um modelo de botão de finalização da compra que mostra um botão único. Consulte o documento [Modelos de carrossel de cartão de mídia](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) e veja a sintaxe do corpo do post para o modelo de carrossel.
245
+
246
+ ```
247
+ {
248
+ "name": "<TEMPLATE_NAME>",
249
+ "language": "<TEMPLATE_LANGUAGE>",
250
+ "category": "marketing",
251
+ "components": [
252
+ {
253
+ "type": "header",
254
+ "format": "<MESSAGE_HEADER_FORMAT>",
255
+ "example": {
256
+ "header_handle": [
257
+ "<MESSAGE_HEADER_ASSET_HANDLE>"
258
+ ]
259
+ }
260
+ },
261
+ {
262
+ "type": "body",
263
+ "text": "<MESSAGE_BODY_TEXT>",
264
+ "example": {
265
+ "body_text": [
266
+ [
267
+ "<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>",
268
+ "<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>"
269
+ ]
270
+ ]
271
+ }
272
+ },
273
+
274
+ /* Footer component is optional */
275
+ {
276
+ "type": "footer",
277
+ "text": "<MESSAGE_FOOTER_TEXT>"
278
+ },
279
+
280
+ {
281
+ "type": "buttons",
282
+ "buttons": [
283
+ {
284
+ "type": "order_details",
285
+ "text": "Buy now"
286
+ },
287
+
288
+ /* Quick-reply buttons are optional; up to 9 permitted */
289
+ {
290
+ "type": "quick_reply",
291
+ "text": "<QUICK_REPLY_BUTTON_LABEL_TEXT>"
292
+ }
293
+ ]
294
+ }
295
+ ]
296
+ }
297
+ ```
298
+
299
+ ### Parâmetros do corpo do post
300
+
301
+ Espaço reservado
302
+
303
+ Descrição
304
+
305
+ Valor de exemplo
306
+
307
+ `<MESSAGE_BODY_TEXT>`
308
+
309
+ _String_
310
+
311
+ **Obrigatório.**
312
+
313
+ Texto do corpo da mensagem. Aceita variáveis.
314
+
315
+ Máximo de 1.024 caracteres.
316
+
317
+ `Hi {{1}}! The {{2}} is back in stock! Order now before it's gone!`
318
+
319
+ `<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>`
320
+
321
+ _String_
322
+
323
+ **Obrigatório se a string de texto do corpo da mensagem tiver variáveis.**
324
+
325
+ String(s) de variáveis de exemplo de texto do corpo da mensagem. O número de strings precisa corresponder ao número de espaços reservados para variáveis na string de texto do corpo da mensagem.
326
+
327
+ Se o texto do corpo da mensagem usar uma única variável, o valor `body_text` poderá ser uma string; caso contrário, deverá ser uma matriz contendo uma matriz de strings.
328
+
329
+ `Pablo`
330
+
331
+ `<MESSAGE_FOOTER_TEXT>`
332
+
333
+ _String_
334
+
335
+ **Obrigatório com o uso de um rodapé de mensagem.**
336
+
337
+ String de texto do rodapé da mensagem.
338
+
339
+ Máximo de 60 caracteres.
340
+
341
+ `Tap 'Stop' below to stop back-in-stock reminders.`
342
+
343
+ `<MESSAGE_HEADER_ASSET_HANDLE>`
344
+
345
+ _String_
346
+
347
+ **Obrigatório se um cabeçalho com mídia não textual for usado.**
348
+
349
+ Nome de usuário do ativo de mídia carregado. Use a [API de Carregamento Retomável](/docs/graph-api/guides/upload) para gerar um identificador de ativo.
350
+
351
+ Os ativos de mídia são cortados automaticamente na proporção ampla com base no dispositivo do usuário do WhatsApp.
352
+
353
+ `4::anBlZw==:ARa525ZJ1g0J-8egeiRvb4Z4r9RSi9qeKF7-wXsUiaDFsll5CKbu5H7h_9mTW0TDfA8LEGHC4bAeXtJJiVQADMp5Ooe2huQlhpBxMadJiu3qVg:e:1724535430:634974688087057:100089620928913:ARaQoFQMm6BlbI3MYo4`
354
+
355
+ `<MESSAGE_HEADER_FORMAT>`
356
+
357
+ _String_
358
+
359
+ **Obrigatório.**
360
+
361
+ Formato do cabeçalho da mensagem. O valor pode ser `image` ou `video`.
362
+
363
+ `image`
364
+
365
+ `<QUICK_REPLY_BUTTON_LABEL_TEXT>`
366
+
367
+ _String_
368
+
369
+ **Obrigatório ao usar um botão de resposta rápida.**
370
+
371
+ O texto do botão de resposta rápida.
372
+
373
+ Máximo de 25 caracteres.
374
+
375
+ `Stop`
376
+
377
+ `<TEMPLATE_LANGUAGE>`
378
+
379
+ _String_
380
+
381
+ **Obrigatório.**
382
+
383
+ O [código de localidade e idioma](/documentation/business-messaging/whatsapp/templates/supported-languages) do modelo.
384
+
385
+ `en_US`
386
+
387
+ `<TEMPLATE_NAME>`
388
+
389
+ _String_
390
+
391
+ **Obrigatório.**
392
+
393
+ O nome do modelo.
394
+
395
+ Máximo de 512 caracteres.
396
+
397
+ `item_back_in_stock_v1`
398
+
399
+ ### Exemplo de solicitação
400
+
401
+ Esta solicitação de exemplo cria um modelo de botão de finalização da compra com cabeçalho de mensagem de imagem única, corpo de texto de mensagem que usa duas variáveis, rodapé, botão de finalização da compra único e botão de resposta rápida.
402
+
403
+ ```
404
+ curl 'https://graph.facebook.com/v24.0/102290129340398/message_templates' \
405
+ -H 'Content-Type: application/json' \
406
+ -H 'Authorization: Bearer EAAJB...' \
407
+ -d '
408
+ {
409
+ "name": "item_back_in_stock_v1",
410
+ "language": "en_US",
411
+ "category": "marketing",
412
+ "components": [
413
+ {
414
+ "type": "header",
415
+ "format": "image",
416
+ "example": {
417
+ "header_handle": [
418
+ "3:NDU..."
419
+ ]
420
+ }
421
+ },
422
+ {
423
+ "type": "body",
424
+ "text": "Hi {{1}}! The {{2}} is back in stock! Order now before it\'s gone!",
425
+ "example": {
426
+ "body_text": [
427
+ [
428
+ "Pablo",
429
+ "Blue Elf Aloe"
430
+ ]
431
+ ]
432
+ }
433
+ },
434
+ {
435
+ "type": "footer",
436
+ "text": "Tap \'Stop\' below to stop back-in-stock reminders."
437
+ },
438
+ {
439
+ "type": "buttons",
440
+ "buttons": [
441
+ {
442
+ "type": "order_details",
443
+ "text": "Buy now"
444
+ },
445
+ {
446
+ "type": "quick_reply",
447
+ "text": "Stop"
448
+ }
449
+ ]
450
+ }
451
+ ]
452
+ }'
453
+ ```
454
+
455
+ ## Como enviar modelos com botão de finalização da compra
456
+
457
+ Depois que o modelo de botão de finalização da compra ou carrossel for aprovado, você poderá enviá-lo em uma mensagem de modelo.
458
+
459
+ ### Sintaxe da solicitação
460
+
461
+ Use o ponto de extremidade [**POST /<WHATSAPP\_BUSINESS\_PHONE\_NUMBER\_ID>/messages**](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api) para enviar um modelo de botão de finalização da compra ou um modelo de carrossel aprovado para um usuário do WhatsApp.
462
+
463
+ ```
464
+ POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages
465
+ ```
466
+
467
+ ### Corpo do post
468
+
469
+ Essa sintaxe do corpo do post é para um modelo de botão de finalização da compra. Consulte [Como enviar modelos de carrossel de cartão de mídia](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) para ver a sintaxe da carga do corpo do post para o modelo de carrossel de cartão de mídia.
470
+
471
+ ```
472
+ {
473
+ "messaging_product": "whatsapp",
474
+ "recipient_type": "individual",
475
+ "to": "<WHATSAPP_USER_PHONE_NUMBER>",
476
+ "type": "template",
477
+ "template": {
478
+ "name": "<TEMPLATE_NAME>",
479
+ "language": {
480
+ "policy": "deterministic",
481
+ "code": "<TEMPLATE_LANGUAGE>"
482
+ },
483
+ "components": [
484
+ {
485
+ "type": "header",
486
+ "parameters": [
487
+ {
488
+ "type": "<MESSAGE_HEADER_FORMAT>",
489
+ "<MESSAGE_HEADER_FORMAT>": {
490
+ "id": "<MESSAGE_HEADER_ASSET_ID>"
491
+ }
492
+ }
493
+ ]
494
+ },
495
+ {
496
+ "type": "body",
497
+ "parameters": [
498
+ {
499
+ <MESSAGE_BODY_TEXT_VARIABLE>
500
+ },
501
+ {
502
+ <MESSAGE_BODY_TEXT_VARIABLE>
503
+ }
504
+ ]
505
+ },
506
+ {
507
+ "type": "button",
508
+ "sub_type": "order_details",
509
+ "index": 0,
510
+ "parameters": [
511
+ {
512
+ "type": "action",
513
+ "action": {
514
+ "order_details": {
515
+ "reference_id": "<REFERENCE_ID>",
516
+ "currency": "INR",
517
+ "type": "<PRODUCT_TYPE>",
518
+ "payment_settings": [
519
+ {
520
+ "type": "payment_gateway",
521
+ "payment_gateway": {
522
+ "type": "<PAYMENT_GATEWAY_NAME>",
523
+ "configuration_name": "<PAYMENT_GATEWAY_CONFIGURATION_NAME>"
524
+ }
525
+ }
526
+ ],
527
+
528
+ /* "shipping_info" required for physical-goods type, else omit */
529
+ "shipping_info": {
530
+ "country": "IN",
531
+ "addresses": [
532
+
533
+ /* object required if you know recipient's address, otherwise omit (i.e., set "addresses" to an empty array) */
534
+ {
535
+ "name": "<SHIPPING_INFO_NAME>",
536
+ "phone_number": "<SHIPPING_INFO_PHONE_NUMBER>",
537
+ "address": "<SHIPPING_INFO_ADDRESS>",
538
+ "city": "<SHIPPING_INFO_CITY>",
539
+ "state": "<SHIPPING_INFO_STATE>",
540
+ "in_pin_code": "<SHIPPING_INFO_INDIA_PIN>",
541
+ "landmark_area": "<SHIPPING_INFO_LANDMARK_AREA>",
542
+ "house_number": "<SHIPPING_INFO_HOUSE_NUMBER>",
543
+ "tower_number": "<SHIPPING_INFO_TOWER_NUMBER>",
544
+ "building_name": "<SHIPPING_INFO_BUILDING_NAME>"
545
+ }
546
+
547
+ ]
548
+ },
549
+
550
+ "order": {
551
+ "items": [
552
+ {
553
+ "amount": {
554
+ "offset": 100,
555
+ "value": <ITEM_PRICE>
556
+ },
557
+
558
+ /* "sale_amount" optional */
559
+ "sale_amount": {
560
+ "offset": 100,
561
+ "value": <SALE_PRICE>
562
+ },
563
+
564
+ "name": "<ITEM_NAME>",
565
+ "quantity": <ITEM_QUANTITY>,
566
+ "country_of_origin": "<ITEM_COUNTRY_OF_ORIGIN>",
567
+ "importer_name": "<IMPORTER_NAME>",
568
+ "importer_address": {
569
+ "address_line1": "<IMPORTER_ADDRESS_LINE_1>",
570
+ "address_line2": "<IMPORTER_ADDRESS_LINE_2>",
571
+ "city": "<IMPORTER_CITY>",
572
+ "zone_code": "<IMPORTER_ZONE_CODE>",
573
+ "postal_code": "<IMPORTER_POSTAL_CODE>",
574
+ "country_code": "IN"
575
+ }
576
+ }
577
+ ],
578
+ "subtotal": {
579
+ "offset": 100,
580
+ "value": <SUBTOTAL_AMOUNT>
581
+ }
582
+ "shipping": {
583
+ "offset": 100,
584
+ "value": <SHIPPING_AMOUNT>
585
+ },
586
+ "tax": {
587
+ "offset": 100,
588
+ "value": <TAX_AMOUNT>,
589
+ "description": "<TAX_DESCRIPTION>"
590
+ },
591
+
592
+ /* "discount" optional */
593
+ "discount": {
594
+ "offset": 100,
595
+ "value": <DISCOUNT_AMOUNT>,
596
+ "description": "<DISCOUNT_DESCRIPTION>"
597
+ },
598
+ "status": "pending",
599
+
600
+ /* "expiration" optional */
601
+ "expiration": {
602
+ "timestamp": "<EXPIRATION_TIMESTAMP>"
603
+ }
604
+ },
605
+ "total_amount": {
606
+ "offset": 100,
607
+ "value": <TOTAL_AMOUNT>
608
+ }
609
+ }
610
+ }
611
+ }
612
+ ]
613
+ }
614
+ ]
615
+ }
616
+ }
617
+ ```
618
+
619
+ ### Parâmetros do corpo do post
620
+
621
+ Espaço reservado
622
+
623
+ Descrição
624
+
625
+ Valor de exemplo
626
+
627
+ `<DISCOUNT_AMOUNT>`
628
+
629
+ _Número inteiro_
630
+
631
+ **Obrigatório se um desconto for usado.**
632
+
633
+ Valor do desconto multiplicado pelo valor de discount.offset.
634
+
635
+ Por exemplo, para representar um desconto de ₹2, o valor será `200`.
636
+
637
+ O valor do desconto aplica-se ao subtotal do pedido.
638
+
639
+ `15000`
640
+
641
+ `<DISCOUNT_DESCRIPTION>`
642
+
643
+ _String_
644
+
645
+ **Opcional.**
646
+
647
+ Descrição do desconto.
648
+
649
+ Máximo de 60 caracteres.
650
+
651
+ `Additional 10% off`
652
+
653
+ `<EXPIRATION_TIMESTAMP>`
654
+
655
+ _String_
656
+
657
+ **Obrigatório para pedidos com prazo de validade.**
658
+
659
+ Registro de data e hora UTC que indica quando devemos desabilitar o botão **Comprar agora**. O registro de data e hora será usado para gerar uma string de texto que aparece na parte inferior da janela **Detalhes do pedido**. Por exemplo:
660
+
661
+ _O pedido expira em 30 de setembro de 2024 às 12h._
662
+
663
+ Os usuários do WhatsApp que visualizarem a mensagem depois desse período não poderão comprar o item usando o botão de finalização da compra.
664
+
665
+ Os valores devem representar um horário UTC de pelo menos 300 segundos a partir do momento em que a solicitação de envio de mensagem é enviada para nós.
666
+
667
+ `1726692927`
668
+
669
+ `<IMPORTER_ADDRESS_LINE_1>`
670
+
671
+ _String_
672
+
673
+ **Obrigatório.**
674
+
675
+ Endereço da importadora, linha 1 (porta, torre, número, rua etc.).
676
+
677
+ Máximo de 100 caracteres.
678
+
679
+ `One BKC`
680
+
681
+ `<IMPORTER_ADDRESS_LINE_2>`
682
+
683
+ _String_
684
+
685
+ **Opcional.**
686
+
687
+ Endereço da importadora (cont.): linha 2 (ponto de referência, área etc.).
688
+
689
+ Máximo de 100 caracteres.
690
+
691
+ `Bandra Kurla Complex`
692
+
693
+ `<IMPORTER_CITY>`
694
+
695
+ _String_
696
+
697
+ **Obrigatório.**
698
+
699
+ Cidade da importadora.
700
+
701
+ Máximo de 120 caracteres.
702
+
703
+ `Mumbai`
704
+
705
+ `<IMPORTER_NAME>`
706
+
707
+ _String_
708
+
709
+ **Obrigatório.**
710
+
711
+ Nome da importadora.
712
+
713
+ Máximo de 200 caracteres.
714
+
715
+ `Lucky Shrub Imports and Exports`
716
+
717
+ `<IMPORTER_POSTAL_CODE>`
718
+
719
+ _String_
720
+
721
+ **Obrigatório.**
722
+
723
+ Número do código postal de 6 dígitos da importadora.
724
+
725
+ Máximo de 6 dígitos.
726
+
727
+ `400051`
728
+
729
+ `<IMPORTER_ZONE_CODE>`
730
+
731
+ _String_
732
+
733
+ **Obrigatório.**
734
+
735
+ Código de zona de duas letras da importadora.
736
+
737
+ `MH`
738
+
739
+ `<ITEM_COUNTRY_OF_ORIGIN>`
740
+
741
+ _String_
742
+
743
+ **Obrigatório.**
744
+
745
+ País de origem do item.
746
+
747
+ Máximo de 100 caracteres.
748
+
749
+ `India`
750
+
751
+ `<ITEM_NAME>`
752
+
753
+ _String_
754
+
755
+ **Obrigatório.**
756
+
757
+ Nome do item
758
+
759
+ Máximo de 60 caracteres.
760
+
761
+ `Blue Elf Aloe`
762
+
763
+ `<ITEM_PRICE>`
764
+
765
+ _Número inteiro_
766
+
767
+ **Obrigatório.**
768
+
769
+ Preço do item individual (preço por item) multiplicado pelo valor de amount.offset.
770
+
771
+ Por exemplo, para representar o preço de um item de ₹ 12,99, o valor seria `1299`.
772
+
773
+ `200000`
774
+
775
+ `<ITEM_QUANTITY>`
776
+
777
+ _Número inteiro_
778
+
779
+ **Obrigatório.**
780
+
781
+ O número de itens no pedido, se o pedido for efetuado.
782
+
783
+ Máximo de 100 números inteiros.
784
+
785
+ `1`
786
+
787
+ `<MESSAGE_BODY_TEXT_VARIABLE>`
788
+
789
+ _Objeto_
790
+
791
+ **Obrigatório se o texto do corpo da mensagem de modelo usar variáveis; caso contrário, omita.**
792
+
793
+ Objeto que descreve uma variável de mensagem. Se o modelo usa diversas variáveis, defina um objeto para cada uma delas.
794
+
795
+ É compatível com os tipos `text`, `currency` e `date_time`. Consulte [Parâmetros de mensagens](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api#parameter-object).
796
+
797
+ Não há um limite máximo de caracteres para esse valor, mas ele é contabilizado no limite de 1.024 caracteres do texto do corpo da mensagem.
798
+
799
+ ```
800
+ {
801
+ "type":"text",
802
+ "text": "Nidhi"
803
+ }
804
+ ```
805
+
806
+ `<MESSAGE_HEADER_ASSET_ID>`
807
+
808
+ _String_
809
+
810
+ **Obrigatório.**
811
+
812
+ A identificação do ativo de mídia carregado do ativo de cabeçalho. Use o ponto de extremidade [**POST /<BUSINESS\_PHONE\_NUMBER\_ID>/media**](/documentation/business-messaging/whatsapp/business-phone-numbers/media#upload-media) para gerar uma identificação de ativo.
813
+
814
+ `1558081531584829`
815
+
816
+ `<MESSAGE_HEADER_FORMAT>`
817
+
818
+ _String_
819
+
820
+ **Obrigatório.**
821
+
822
+ Indica o tipo de cabeçalho e um nome de propriedade correspondente.
823
+
824
+ Observe que o espaço reservado `<MESSAGE_HEADER_FORMAT>` aparece duas vezes no exemplo de corpo do post acima, pois serve como espaço reservado para o valor da propriedade de tipo e o nome de propriedade correspondente.
825
+
826
+ O valor pode ser `image` ou `video`.
827
+
828
+ `image`
829
+
830
+ `<PAYMENT_GATEWAY_CONFIGURATION_NAME>`
831
+
832
+ _String_
833
+
834
+ **Obrigatório.**
835
+
836
+ O nome de configuração do gateway de pagamento que você [configurou](/documentation/business-messaging/whatsapp/payments/payments-in/onboarding-apis) na sua conta do WhatsApp Business.
837
+
838
+ `prod-razor-pay-config-05`
839
+
840
+ `<PAYMENT_GATEWAY_NAME>`
841
+
842
+ _String_
843
+
844
+ **Obrigatório.**
845
+
846
+ O nome do gateway de pagamento que você [configurou](/documentation/business-messaging/whatsapp/payments/payments-in/onboarding-apis) na sua conta do WhatsApp Business.
847
+
848
+ Os valores podem ser os seguintes:
849
+
850
+ - `razorpay`- `payu`- `zaakpay`
851
+
852
+ `razorpay`
853
+
854
+ `<PRODUCT_TYPE>`
855
+
856
+ _String_
857
+
858
+ **Obrigatório.**
859
+
860
+ Tipo de produto O valor pode ser `digital-goods` ou `physical-goods`.
861
+
862
+ `digital-goods`
863
+
864
+ `<QUICK_REPLY_BUTTON_PAYLOAD>`
865
+
866
+ _String_
867
+
868
+ **Opcional.**
869
+
870
+ O valor a ser incluído em webhooks de mensagens (`messages.button.payload`) quando o botão for tocado.
871
+
872
+ `opt-out`
873
+
874
+ `<REFERENCE_ID>`
875
+
876
+ _String_
877
+
878
+ **Obrigatório.**
879
+
880
+ A identificação de referência única do pedido ou da fatura. Diferencia maiúsculas de minúsculas. Não pode estar vazio. Será precedido por um símbolo de hash (#) no fluxo de finalização da compra.
881
+
882
+ O valor deve ser único para cada mensagem de modelo de botão de finalização da compra. Se você enviar um modelo de carrossel, cada botão de finalização da compra deverá ter uma identificação de referência única.
883
+
884
+ Se você precisar enviar várias mensagens para o mesmo pedido/fatura, recomendamos anexar um número de sequência ao valor (por exemplo, -1).
885
+
886
+ Os valores podem conter apenas letras em inglês, números, sublinhados, traços ou pontos.
887
+
888
+ Máximo de 35 caracteres.
889
+
890
+ `abc.123_xyz-1`
891
+
892
+ `<SALE_PRICE>`
893
+
894
+ _Número inteiro_
895
+
896
+ **Obrigatório se usar um valor de venda.**
897
+
898
+ Preço do item em promoção multiplicado pelo valor `sale.offset`.
899
+
900
+ Por exemplo, para representar um preço de venda de ₹10, o valor seria `1000`.
901
+
902
+ `150000`
903
+
904
+ `<SHIPPING_AMOUNT>`
905
+
906
+ _Número inteiro_
907
+
908
+ **Obrigatório.**
909
+
910
+ Custo de envio do pedido multiplicado pelo valor `shipping.offset`.
911
+
912
+ Por exemplo, para representar um custo de envio de ₹ 0,99, o valor seria `99`.
913
+
914
+ `20000`
915
+
916
+ `<SHIPPING_INFO_ADDRESS>`
917
+
918
+ _String_
919
+
920
+ **Obrigatório se você souber as informações de envio do destinatário.**
921
+
922
+ Endereço do destinatário do produto.
923
+
924
+ Máximo de 512 caracteres.
925
+
926
+ `Bandra Kurla Complex`
927
+
928
+ `<SHIPPING_INFO_BUILDING_NAME>`
929
+
930
+ _String_
931
+
932
+ **Opcional.**
933
+
934
+ Nome do edifício do destinatário do produto.
935
+
936
+ Máximo de 128 caracteres.
937
+
938
+ `One BKC`
939
+
940
+ `<SHIPPING_INFO_CITY>`
941
+
942
+ _String_
943
+
944
+ **Obrigatório se você souber as informações de envio do destinatário.**
945
+
946
+ Nome completo da cidade do destinatário do produto.
947
+
948
+ Máximo de 100 caracteres.
949
+
950
+ `Mumbai`
951
+
952
+ `<SHIPPING_INFO_FLOOR_NUMBER>`
953
+
954
+ _String_
955
+
956
+ **Opcional.**
957
+
958
+ O número do andar do destinatário do produto.
959
+
960
+ Máximo de 10 caracteres.
961
+
962
+ `2`
963
+
964
+ `<SHIPPING_INFO_HOUSE_NUMBER>`
965
+
966
+ _String_
967
+
968
+ **Opcional.**
969
+
970
+ Número do destinatário do produto.
971
+
972
+ Máximo de 8 caracteres.
973
+
974
+ `12`
975
+
976
+ `<SHIPPING_INFO_INDIA_PIN>`
977
+
978
+ _String_
979
+
980
+ **Obrigatório se você souber as informações de envio do destinatário.**
981
+
982
+ Código postal do destinatário do produto.
983
+
984
+ Máximo de 6 caracteres.
985
+
986
+ `400051`
987
+
988
+ `<SHIPPING_INFO_LANDMARK_AREA>`
989
+
990
+ _String_
991
+
992
+ **Opcional.**
993
+
994
+ Área de ponto de referência do destinatário do produto.
995
+
996
+ Máximo de 128 caracteres.
997
+
998
+ `Near BKC Circle`
999
+
1000
+ `<SHIPPING_INFO_NAME>`
1001
+
1002
+ _String_
1003
+
1004
+ **Obrigatório se você souber as informações de envio do destinatário.**
1005
+
1006
+ Nome completo do destinatário do produto.
1007
+
1008
+ Máximo de 256 caracteres.
1009
+
1010
+ `Nidhi Tripathi`
1011
+
1012
+ `<SHIPPING_INFO_PHONE_NUMBER>`
1013
+
1014
+ _String_
1015
+
1016
+ **Obrigatório se você souber as informações de envio do destinatário.**
1017
+
1018
+ Número de telefone do WhatsApp do destinatário do produto.
1019
+
1020
+ Máximo de 12 caracteres.
1021
+
1022
+ `919000090000`
1023
+
1024
+ `<SHIPPING_INFO_STATE>`
1025
+
1026
+ _String_
1027
+
1028
+ **Obrigatório se você souber as informações de envio do destinatário.**
1029
+
1030
+ Nome completo do estado do destinatário do produto.
1031
+
1032
+ Máximo de 100 caracteres.
1033
+
1034
+ `Maharastra`
1035
+
1036
+ `<SHIPPING_INFO_TOWER_NUMBER>`
1037
+
1038
+ _String_
1039
+
1040
+ **Opcional.**
1041
+
1042
+ Número da torre do destinatário do produto.
1043
+
1044
+ Máximo de 8 caracteres.
1045
+
1046
+ `2`
1047
+
1048
+ `<SUBTOTAL_AMOUNT>`
1049
+
1050
+ _Número inteiro_
1051
+
1052
+ **Obrigatório.**
1053
+
1054
+ Subtotal do pedido. Para calcular, multiplique `<ITEM_PRICE>` por `<ITEM_QUANTITY>` por `subtotal.offset`.
1055
+
1056
+ Por exemplo, se o modelo for destinado a um pedido único com dois itens que custam ₹12,99, o valor seria `2598`.
1057
+
1058
+ `150000`
1059
+
1060
+ `<TAX_AMOUNT>`
1061
+
1062
+ _Número inteiro_
1063
+
1064
+ **Obrigatório.**
1065
+
1066
+ Valor do imposto multiplicado por `tax.offset`.
1067
+
1068
+ Por exemplo, para representar um valor de imposto de ₹5, o valor seria `500`.
1069
+
1070
+ `10000`
1071
+
1072
+ `<TAX_DESCRIPTION>`
1073
+
1074
+ _String_
1075
+
1076
+ **Opcional.**
1077
+
1078
+ Descrição do imposto.
1079
+
1080
+ Máximo de 60 caracteres.
1081
+
1082
+ `Sales tax`
1083
+
1084
+ `<TEMPLATE_LANGUAGE>`
1085
+
1086
+ _String_
1087
+
1088
+ **Obrigatório.**
1089
+
1090
+ O [código de localidade e idioma](/documentation/business-messaging/whatsapp/templates/supported-languages) do modelo.
1091
+
1092
+ `en_US`
1093
+
1094
+ `<TEMPLATE_NAME>`
1095
+
1096
+ _String_
1097
+
1098
+ **Obrigatório.**
1099
+
1100
+ O nome do modelo.
1101
+
1102
+ Máximo de 512 caracteres.
1103
+
1104
+ `item_back_in_stock_v1`
1105
+
1106
+ `<TOTAL_AMOUNT>`
1107
+
1108
+ _Número inteiro_
1109
+
1110
+ **Obrigatório.**
1111
+
1112
+ Valor total do pedido multiplicado pelo valor `total_amount.offset`.
1113
+
1114
+ Por exemplo, para representar o valor total de ₹ 18,00, o valor seria `1800`.
1115
+
1116
+ Deve ser uma soma de:
1117
+
1118
+ - `order.subtotal.value`- `order.shipping.value`- `order.tax.value`
1119
+
1120
+ Descontando:
1121
+
1122
+ - `order.discount.value`
1123
+
1124
+ `165000`
1125
+
1126
+ `<WHATSAPP_USER_PHONE_NUMBER>`
1127
+
1128
+ _String_
1129
+
1130
+ **Obrigatório.**
1131
+
1132
+ Número de telefone do usuário do WhatsApp.
1133
+
1134
+ `+16505551234`
1135
+
1136
+ ### Exemplo de solicitação
1137
+
1138
+ ```
1139
+ curl 'https://graph.facebook.com/v24.0/106540352242922/messages' \
1140
+ -H 'Content-Type: application/json' \
1141
+ -H 'Authorization: Bearer EAAJB...' \
1142
+ -d '
1143
+ {
1144
+ "messaging_product": "whatsapp",
1145
+ "recipient_type": "individual",
1146
+ "to": "+16505551234",
1147
+ "type": "template",
1148
+ "template": {
1149
+ "name": "item_back_in_stock_v2",
1150
+ "language": {
1151
+ "policy": "deterministic",
1152
+ "code": "en_US"
1153
+ },
1154
+ "components": [
1155
+ {
1156
+ "type": "header",
1157
+ "parameters": [
1158
+ {
1159
+ "type": "image",
1160
+ "image": {
1161
+ "id": "1558081531584829"
1162
+ }
1163
+ }
1164
+ ]
1165
+ },
1166
+ {
1167
+ "type": "body",
1168
+ "parameters": [
1169
+ {
1170
+ "type": "text",
1171
+ "text": "Nidhi"
1172
+ },
1173
+ {
1174
+ "type": "text",
1175
+ "text": "Blue Elf Aloe"
1176
+ }
1177
+ ]
1178
+ },
1179
+ {
1180
+ "type": "button",
1181
+ "sub_type": "order_details",
1182
+ "index": 0,
1183
+ "parameters": [
1184
+ {
1185
+ "type": "action",
1186
+ "action": {
1187
+ "order_details": {
1188
+ "reference_id": "abc.123_xyz-1",
1189
+ "type": "physical-goods",
1190
+ "currency": "INR",
1191
+ "payment_settings": [
1192
+ {
1193
+ "type": "payment_gateway",
1194
+ "payment_gateway": {
1195
+ "type": "razorpay",
1196
+ "configuration_name": "prod-razor-pay-config-05"
1197
+ }
1198
+ }
1199
+ ],
1200
+ "shipping_info": {
1201
+ "country": "IN",
1202
+ "addresses": [
1203
+ {
1204
+ "name": "Nidhi Tripathi",
1205
+ "phone_number": "919000090000",
1206
+ "address": "Bandra Kurla Complex",
1207
+ "city": "Mumbai",
1208
+ "state": "Maharastra",
1209
+ "in_pin_code": "400051",
1210
+ "house_number": "12",
1211
+ "tower_number": "5",
1212
+ "building_name": "One BKC",
1213
+ "landmark_area": "Near BKC Circle"
1214
+ }
1215
+ ]
1216
+ },
1217
+ "order": {
1218
+ "items": [
1219
+ {
1220
+ "amount": {
1221
+ "offset": 100,
1222
+ "value": 200000
1223
+ },
1224
+ "sale_amount": {
1225
+ "offset": 100,
1226
+ "value": 150000
1227
+ },
1228
+ "name": "Blue Elf Aloe",
1229
+ "quantity": 1,
1230
+ "country_of_origin": "India",
1231
+ "importer_name": "Lucky Shrub Imports and Exports",
1232
+ "importer_address": {
1233
+ "address_line1": "One BKC",
1234
+ "address_line2": "Bandra Kurla Complex",
1235
+ "city": "Mumbai",
1236
+ "zone_code": "MH",
1237
+ "postal_code": "400051",
1238
+ "country_code": "IN"
1239
+ }
1240
+ }
1241
+ ],
1242
+ "subtotal": {
1243
+ "offset": 100,
1244
+ "value": 150000
1245
+ },
1246
+ "shipping": {
1247
+ "offset": 100,
1248
+ "value": 20000
1249
+ },
1250
+ "tax": {
1251
+ "offset": 100,
1252
+ "value": 10000
1253
+ },
1254
+ "discount": {
1255
+ "offset": 100,
1256
+ "value": 15000,
1257
+ "description": "Additional 10% off"
1258
+ },
1259
+ "status": "pending",
1260
+ "expiration": {
1261
+ "timestamp": "1726627150"
1262
+ }
1263
+ },
1264
+ "total_amount": {
1265
+ "offset": 100,
1266
+ "value": 165000
1267
+ }
1268
+ }
1269
+ }
1270
+ }
1271
+ ]
1272
+ }
1273
+ ]
1274
+ }
1275
+ }'
1276
+ ```
1277
+
1278
+ Os exemplos de solicitação e respostas abaixo são compatíveis apenas com o recurso [Habilitação de cupons, inventário em tempo real e atualizações de preços](#enabling_coupons_inventory), que está em versão beta e disponível apenas para empresas da Índia e usuários do WhatsApp com código de chamada de país da Índia. Para saber mais, entre em contato com whatsappindia-bizpayments-support@meta.com.
1279
+
1280
+ ### Obter cupons – Exemplo de solicitação de ponto de extremidade
1281
+
1282
+ ```
1283
+ {    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ]            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 20000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "total_amount":            {                "offset": 100,                "value": 165000            }        },        "input":        {            "user_id": "919000090000"        }    },    "action": "data_exchange",    "sub_action": "get_coupons",    "version": "1.0"}
1284
+ ```
1285
+
1286
+ ### Obter cupons – Exemplo de resposta do ponto de extremidade
1287
+
1288
+ ```
1289
+ {    "version": "1.0",    "sub_action": "get_coupons",    "data":    {        "coupons":        [            {                "description": "Save R20 on the order",                "code": "TRYNEW20",                "id": "try_new_20_id"            },            {                "description": "Save R30 on the order",                "code": "TRYNEW30",                "id": "try_new_30_id"            },            {                "description": "Save R50 on the order",                "code": "TRYNEW50",                "id": "try_new50_id"            }        ]    }}
1290
+ ```
1291
+
1292
+ ### Aplicar cupom – Exemplo de solicitação de ponto de extremidade
1293
+
1294
+ ```
1295
+ {    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ]            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 20000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "total_amount":            {                "offset": 100,                "value": 165000            }        },        "input":        {            "user_id": "919000090000",            "coupon":            {                "code": "TRYNEW10"            }        }    },    "action": "data_exchange",    "sub_action": "apply_coupon",    "version": "1.0"}
1296
+ ```
1297
+
1298
+ ### Aplicar cupom – Exemplo de resposta de ponto de extremidade
1299
+
1300
+ ```
1301
+ {    "sub_action": "apply_coupon",    "version": "1.0",    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ]            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 20000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "coupon":            {                "code": "TRYNEW10",                "discount":                {                    "value": 16500,                    "offset": 100                }            },            "total_amount":            {                "offset": 100,                "value": 148500            }        }    }}
1302
+ ```
1303
+
1304
+ ### Remover cupom – Exemplo de solicitação do ponto de extremidade
1305
+
1306
+ ```
1307
+ {    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ]            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 20000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "coupon":            {                "code": "TRYNEW10",                "discount":                {                    "value": 16500,                    "offset": 100                }            },            "total_amount":            {                "offset": 100,                "value": 148500            }        },        "input":        {            "user_id": "919000090000"        }    },    "action": "data_exchange",    "sub_action": "remove_coupon",    "version": "1.0"}
1308
+ ```
1309
+
1310
+ ### Remover cupom – Exemplo de resposta do ponto de extremidade
1311
+
1312
+ ```
1313
+ {    "sub_action": "remove_coupon",    "version": "1.0",    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ]            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 20000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "total_amount":            {                "offset": 100,                "value": 165000            }        }    }}
1314
+ ```
1315
+
1316
+ ### Aplicar envio – Exemplo de solicitação de ponto de extremidade
1317
+
1318
+ ```
1319
+ {    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ]            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 20000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "coupon":            {                "code": "TRYNEW10",                "discount":                {                    "value": 16500,                    "offset": 100                }            },            "total_amount":            {                "offset": 100,                "value": 148500            }        },        "input":        {            "user_id": "919000090000",            "selected_address":            {                "name": "Nidhi Tripathi",                "phone_number": "919000090000",                "address": "Bandra Kurla Complex",                "city": "Mumbai",                "state": "Maharastra",                "in_pin_code": "400051",                "house_number": "12",                "tower_number": "5",                "building_name": "One BKC",                "landmark_area": "Near BKC Circle"            }        }    },    "action": "data_exchange",    "sub_action": "apply_shipping",    "version": "1.0"}
1320
+ ```
1321
+
1322
+ ### Aplicar envio – Exemplo de resposta de ponto de extremidade
1323
+
1324
+ ```
1325
+ {    "sub_action": "apply_shipping",    "version": "1.0",    "data":    {        "order_details":        {            "reference_id": "abc.123_xyz-1",            "type": "physical-goods",            "currency": "INR",            "shipping_info":            {                "country": "IN",                "addresses":                [                    {                        "name": "Nidhi Tripathi",                        "phone_number": "919000090000",                        "address": "Bandra Kurla Complex",                        "city": "Mumbai",                        "state": "Maharastra",                        "in_pin_code": "400051",                        "house_number": "12",                        "tower_number": "5",                        "building_name": "One BKC",                        "landmark_area": "Near BKC Circle"                    }                ],                "selected_address":                {                    "name": "Nidhi Tripathi",                    "phone_number": "919000090000",                    "address": "Bandra Kurla Complex",                    "city": "Mumbai",                    "state": "Maharastra",                    "in_pin_code": "400051",                    "house_number": "12",                    "tower_number": "5",                    "building_name": "One BKC",                    "landmark_area": "Near BKC Circle"                }            },            "order":            {                "items":                [                    {                        "amount":                        {                            "offset": 100,                            "value": 200000                        },                        "sale_amount":                        {                            "offset": 100,                            "value": 150000                        },                        "name": "Blue Elf Aloe",                        "quantity": 1,                        "country_of_origin": "India",                        "importer_name": "Lucky Shrub Imports and Exports",                        "importer_address":                        {                            "address_line1": "One BKC",                            "address_line2": "Bandra Kurla Complex",                            "city": "Mumbai",                            "zone_code": "MH",                            "postal_code": "400051",                            "country_code": "IN"                        }                    }                ],                "subtotal":                {                    "offset": 100,                    "value": 150000                },                "shipping":                {                    "offset": 100,                    "value": 40000                },                "tax":                {                    "offset": 100,                    "value": 10000                },                "discount":                {                    "offset": 100,                    "value": 15000,                    "description": "Additional 10% off"                },                "status": "pending",                "expiration":                {                    "timestamp": "1726627150",                    "description": "order expires in 5 min"                }            },            "coupon":            {                "code": "TRYNEW10",                "discount":                {                    "value": 16500,                    "offset": 100                }            },            "total_amount":            {                "offset": 100,                "value": 168500            }        }    }}
1326
+ ```
1327
+
1328
+ Você achou esta página útil?
1329
+
1330
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
1331
+
1332
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)