@vtex/faststore 0.0.8 → 0.0.11

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 (568) hide show
  1. package/CHANGELOG.md +101 -0
  2. package/README.md +0 -1
  3. package/dist/actions.json +48 -1
  4. package/dist/catalog.json +1397 -1594
  5. package/dist/cli/index.d.ts +66 -28
  6. package/dist/cli/index.js +7371 -512
  7. package/dist/cli/index.js.map +1 -1
  8. package/dist/cli/server-runtime.js +41 -60
  9. package/dist/cli/server-runtime.js.map +1 -1
  10. package/dist/client.d.ts +3 -3
  11. package/dist/client.js +2 -2
  12. package/dist/components.d.ts +67 -56
  13. package/dist/components.js +64 -53
  14. package/dist/content-types.json +5886 -555
  15. package/dist/core/dist/define-component.d.ts +7 -2
  16. package/dist/core/dist/define-content-type.d.ts +50 -2
  17. package/dist/core/dist/define-content-type.js +107 -3
  18. package/dist/core/dist/define-content-type.js.map +1 -1
  19. package/dist/core/dist/index.d.ts +2 -2
  20. package/dist/docs/access-code-field.md +1 -1
  21. package/dist/docs/access-code-sign-in.md +126 -77
  22. package/dist/docs/account-address-book.md +210 -95
  23. package/dist/docs/account-entry-point.md +4 -4
  24. package/dist/docs/account-menu.md +16 -17
  25. package/dist/docs/account-saved-cards.md +306 -0
  26. package/dist/docs/alert-dialog.md +3 -1
  27. package/dist/docs/avatar.md +4 -2
  28. package/dist/docs/billing-address.md +99 -30
  29. package/dist/docs/binding-switcher.md +157 -0
  30. package/dist/docs/buy-button.md +7 -8
  31. package/dist/docs/card-entry.md +42 -29
  32. package/dist/docs/card-summary.md +185 -0
  33. package/dist/docs/cardholder-document.md +5 -3
  34. package/dist/docs/carousel.md +5 -4
  35. package/dist/docs/cart-destination.md +251 -0
  36. package/dist/docs/cart-item.md +48 -15
  37. package/dist/docs/cart-totalizer.md +8 -6
  38. package/dist/docs/cart.md +240 -39
  39. package/dist/docs/challenge-return.md +135 -0
  40. package/dist/docs/client-preferences-fieldset.md +10 -5
  41. package/dist/docs/client-preferences.md +31 -8
  42. package/dist/docs/client-profile-fieldset.md +20 -6
  43. package/dist/docs/client-profile.md +12 -3
  44. package/dist/docs/copy-text.md +9 -7
  45. package/dist/docs/document-field.md +1 -1
  46. package/dist/docs/email-field.md +2 -1
  47. package/dist/docs/email-identification.md +12 -2
  48. package/dist/docs/footer-copyright.md +4 -2
  49. package/dist/docs/footer-social.md +1 -1
  50. package/dist/docs/form.md +54 -18
  51. package/dist/docs/free-shipping-progress.md +18 -13
  52. package/dist/docs/identity-edit.md +8 -2
  53. package/dist/docs/identity-summary.md +18 -5
  54. package/dist/docs/incentives.md +2 -2
  55. package/dist/docs/installments.md +46 -32
  56. package/dist/docs/logo.md +1 -1
  57. package/dist/docs/my-account-profile.md +16 -11
  58. package/dist/docs/navigation-link.md +5 -3
  59. package/dist/docs/order-cancel.md +3 -1
  60. package/dist/docs/order-delivery-address.md +7 -5
  61. package/dist/docs/order-delivery-group.md +1 -3
  62. package/dist/docs/order-details-back.md +1 -1
  63. package/dist/docs/order-details-header.md +1 -4
  64. package/dist/docs/order-invoice-download.md +60 -0
  65. package/dist/docs/order-list-row.md +1 -1
  66. package/dist/docs/order-list-search.md +13 -20
  67. package/dist/docs/order-list-views.md +11 -17
  68. package/dist/docs/order-list.md +12 -5
  69. package/dist/docs/order-payment.md +9 -7
  70. package/dist/docs/order-placed-date.md +1 -1
  71. package/dist/docs/order-placed-payment-summary.md +28 -15
  72. package/dist/docs/order-placed.md +49 -14
  73. package/dist/docs/order-progress.md +1 -1
  74. package/dist/docs/order-status-badge.md +20 -9
  75. package/dist/docs/order-summary.md +2 -2
  76. package/dist/docs/order-tracking-link.md +58 -0
  77. package/dist/docs/payment-method-badges.md +32 -6
  78. package/dist/docs/payment-methods.md +2 -2
  79. package/dist/docs/payment.md +36 -17
  80. package/dist/docs/phone-field.md +4 -4
  81. package/dist/docs/place-order.md +84 -36
  82. package/dist/docs/postal-code-field.md +3 -1
  83. package/dist/docs/pricing.md +21 -23
  84. package/dist/docs/product-gallery.md +19 -20
  85. package/dist/docs/product-information.md +14 -10
  86. package/dist/docs/product-list.md +7 -6
  87. package/dist/docs/product-shelf.md +7 -1
  88. package/dist/docs/promotion.md +4 -2
  89. package/dist/docs/region.md +23 -15
  90. package/dist/docs/save-card.md +7 -6
  91. package/dist/docs/saved-cards.md +65 -36
  92. package/dist/docs/select.md +3 -4
  93. package/dist/docs/shipping-address.md +57 -21
  94. package/dist/docs/shipping-simulator.md +53 -15
  95. package/dist/docs/sign-in-disclosure.md +176 -0
  96. package/dist/docs/sign-in-form.md +78 -47
  97. package/dist/docs/sign-in-redirect.md +5 -3
  98. package/dist/docs/sign-in.md +173 -0
  99. package/dist/docs/toast.md +45 -16
  100. package/dist/docs/variant-selector.md +15 -11
  101. package/dist/graphql/types.d.ts +4 -14
  102. package/dist/index.d.ts +3 -2
  103. package/dist/internal/client.d.ts +4 -3
  104. package/dist/internal/client.js +5 -2
  105. package/dist/internal/server.d.ts +10 -5
  106. package/dist/internal/server.js +9 -4
  107. package/dist/matter/access-code-sign-in/access-code-sign-in.d.ts +250 -66
  108. package/dist/matter/access-code-sign-in/access-code-sign-in.js +459 -188
  109. package/dist/matter/access-code-sign-in/access-code-sign-in.js.map +1 -1
  110. package/dist/matter/account-address-book/account-address-book-delete.d.ts +78 -40
  111. package/dist/matter/account-address-book/account-address-book-delete.js +86 -50
  112. package/dist/matter/account-address-book/account-address-book-delete.js.map +1 -1
  113. package/dist/matter/account-address-book/account-address-book-deliverability.d.ts +21 -4
  114. package/dist/matter/account-address-book/account-address-book-deliverability.js +45 -17
  115. package/dist/matter/account-address-book/account-address-book-deliverability.js.map +1 -1
  116. package/dist/matter/account-address-book/account-address-book-form-parts.d.ts +74 -19
  117. package/dist/matter/account-address-book/account-address-book-form-parts.js +77 -26
  118. package/dist/matter/account-address-book/account-address-book-form-parts.js.map +1 -1
  119. package/dist/matter/account-address-book/account-address-book-profile-notice.d.ts +27 -6
  120. package/dist/matter/account-address-book/account-address-book-profile-notice.js +55 -28
  121. package/dist/matter/account-address-book/account-address-book-profile-notice.js.map +1 -1
  122. package/dist/matter/account-address-book/account-address-book.d.ts +67 -14
  123. package/dist/matter/account-address-book/account-address-book.js +74 -33
  124. package/dist/matter/account-address-book/account-address-book.js.map +1 -1
  125. package/dist/matter/account-address-book/account-address-country-switch.js +3 -3
  126. package/dist/matter/account-address-book/account-address-country-switch.js.map +1 -1
  127. package/dist/matter/account-address-book/account-address-country.d.ts +66 -20
  128. package/dist/matter/account-address-book/account-address-country.js +83 -49
  129. package/dist/matter/account-address-book/account-address-country.js.map +1 -1
  130. package/dist/matter/account-address-book/account-address-form-context.d.ts +8 -4
  131. package/dist/matter/account-address-book/account-address-form-context.js.map +1 -1
  132. package/dist/matter/account-address-book/account-address-form.d.ts +468 -45
  133. package/dist/matter/account-address-book/account-address-form.js +518 -155
  134. package/dist/matter/account-address-book/account-address-form.js.map +1 -1
  135. package/dist/matter/account-address-book/account-address-record.d.ts +27 -6
  136. package/dist/matter/account-address-book/account-address-record.js +32 -17
  137. package/dist/matter/account-address-book/account-address-record.js.map +1 -1
  138. package/dist/matter/account-menu/account-menu.d.ts +34 -17
  139. package/dist/matter/account-menu/account-menu.js +46 -54
  140. package/dist/matter/account-menu/account-menu.js.map +1 -1
  141. package/dist/matter/account-menu-identity/account-menu-identity.js +1 -1
  142. package/dist/matter/account-saved-cards/account-saved-cards.d.ts +463 -0
  143. package/dist/matter/account-saved-cards/account-saved-cards.js +1011 -0
  144. package/dist/matter/account-saved-cards/account-saved-cards.js.map +1 -0
  145. package/dist/matter/billing-address/billing-address.d.ts +156 -74
  146. package/dist/matter/billing-address/billing-address.js +227 -156
  147. package/dist/matter/billing-address/billing-address.js.map +1 -1
  148. package/dist/matter/breadcrumb/breadcrumb.d.ts +21 -3
  149. package/dist/matter/breadcrumb/breadcrumb.js +24 -9
  150. package/dist/matter/breadcrumb/breadcrumb.js.map +1 -1
  151. package/dist/matter/buy-button/buy-button.d.ts +8 -11
  152. package/dist/matter/buy-button/buy-button.js +10 -19
  153. package/dist/matter/buy-button/buy-button.js.map +1 -1
  154. package/dist/matter/card-entry/card-capture.js +12 -4
  155. package/dist/matter/card-entry/card-capture.js.map +1 -1
  156. package/dist/matter/card-entry/card-entry.d.ts +123 -32
  157. package/dist/matter/card-entry/card-entry.js +348 -221
  158. package/dist/matter/card-entry/card-entry.js.map +1 -1
  159. package/dist/matter/cart/cart-namespace.d.ts +11 -1
  160. package/dist/matter/cart/cart-namespace.js +11 -1
  161. package/dist/matter/cart/cart-namespace.js.map +1 -1
  162. package/dist/matter/cart/cart.d.ts +416 -45
  163. package/dist/matter/cart/cart.js +782 -101
  164. package/dist/matter/cart/cart.js.map +1 -1
  165. package/dist/matter/cart-destination/cart-destination.d.ts +233 -0
  166. package/dist/matter/cart-destination/cart-destination.js +703 -0
  167. package/dist/matter/cart-destination/cart-destination.js.map +1 -0
  168. package/dist/matter/cart-item/cart-item.d.ts +145 -16
  169. package/dist/matter/cart-item/cart-item.js +230 -54
  170. package/dist/matter/cart-item/cart-item.js.map +1 -1
  171. package/dist/matter/cart-item-compositions/cart-item-compositions.js +1 -1
  172. package/dist/matter/cart-item-compositions/cart-item-compositions.js.map +1 -1
  173. package/dist/matter/cart-item-customizations/cart-item-customizations.js +1 -1
  174. package/dist/matter/cart-item-customizations/cart-item-customizations.js.map +1 -1
  175. package/dist/matter/cart-item-discounts/cart-item-discounts.js +1 -1
  176. package/dist/matter/cart-item-discounts/cart-item-discounts.js.map +1 -1
  177. package/dist/matter/cart-item-seller-info/cart-item-seller-info.js +1 -1
  178. package/dist/matter/cart-item-seller-info/cart-item-seller-info.js.map +1 -1
  179. package/dist/matter/cart-item-variations/cart-item-variations.js +1 -1
  180. package/dist/matter/cart-item-variations/cart-item-variations.js.map +1 -1
  181. package/dist/matter/cart-totalizer/cart-totalizer.d.ts +43 -9
  182. package/dist/matter/cart-totalizer/cart-totalizer.js +49 -19
  183. package/dist/matter/cart-totalizer/cart-totalizer.js.map +1 -1
  184. package/dist/matter/challenge-return/challenge-return.d.ts +62 -0
  185. package/dist/matter/challenge-return/challenge-return.js +241 -0
  186. package/dist/matter/challenge-return/challenge-return.js.map +1 -0
  187. package/dist/matter/client-preferences/client-preferences-fieldset.d.ts +86 -17
  188. package/dist/matter/client-preferences/client-preferences-fieldset.js +126 -54
  189. package/dist/matter/client-preferences/client-preferences-fieldset.js.map +1 -1
  190. package/dist/matter/client-preferences/client-preferences.d.ts +50 -7
  191. package/dist/matter/client-preferences/client-preferences.js +84 -15
  192. package/dist/matter/client-preferences/client-preferences.js.map +1 -1
  193. package/dist/matter/client-profile/client-profile.d.ts +44 -9
  194. package/dist/matter/client-profile/client-profile.js +64 -24
  195. package/dist/matter/client-profile/client-profile.js.map +1 -1
  196. package/dist/matter/client-profile-form/client-profile-fieldset.d.ts +119 -22
  197. package/dist/matter/client-profile-form/client-profile-fieldset.js +161 -73
  198. package/dist/matter/client-profile-form/client-profile-fieldset.js.map +1 -1
  199. package/dist/matter/delivery-options/delivery-options-accordion.d.ts +49 -4
  200. package/dist/matter/delivery-options/delivery-options-accordion.js +67 -14
  201. package/dist/matter/delivery-options/delivery-options-accordion.js.map +1 -1
  202. package/dist/matter/delivery-options/delivery-options-controller.d.ts +69 -9
  203. package/dist/matter/delivery-options/delivery-options-controller.js +80 -14
  204. package/dist/matter/delivery-options/delivery-options-controller.js.map +1 -1
  205. package/dist/matter/delivery-options/delivery-options.d.ts +37 -2
  206. package/dist/matter/delivery-options/delivery-options.js +75 -12
  207. package/dist/matter/delivery-options/delivery-options.js.map +1 -1
  208. package/dist/matter/delivery-options/use-delivery-option-selection.d.ts +1 -0
  209. package/dist/matter/delivery-options/use-delivery-option-selection.js +1 -1
  210. package/dist/matter/delivery-options/use-delivery-option-selection.js.map +1 -1
  211. package/dist/matter/email-identification/email-identification.d.ts +25 -3
  212. package/dist/matter/email-identification/email-identification.js +49 -12
  213. package/dist/matter/email-identification/email-identification.js.map +1 -1
  214. package/dist/matter/free-shipping-progress/free-shipping-progress.d.ts +85 -10
  215. package/dist/matter/free-shipping-progress/free-shipping-progress.js +153 -53
  216. package/dist/matter/free-shipping-progress/free-shipping-progress.js.map +1 -1
  217. package/dist/matter/identity-edit/identity-edit.d.ts +52 -10
  218. package/dist/matter/identity-edit/identity-edit.js +47 -19
  219. package/dist/matter/identity-edit/identity-edit.js.map +1 -1
  220. package/dist/matter/identity-summary/identity-summary.d.ts +76 -22
  221. package/dist/matter/identity-summary/identity-summary.js +95 -45
  222. package/dist/matter/identity-summary/identity-summary.js.map +1 -1
  223. package/dist/matter/installments/installments-select.d.ts +98 -16
  224. package/dist/matter/installments/installments-select.js +156 -48
  225. package/dist/matter/installments/installments-select.js.map +1 -1
  226. package/dist/matter/installments/installments.d.ts +96 -16
  227. package/dist/matter/installments/installments.js +115 -40
  228. package/dist/matter/installments/installments.js.map +1 -1
  229. package/dist/matter/installments/use-installments-selection.d.ts +1 -0
  230. package/dist/matter/installments/use-installments-selection.js +8 -3
  231. package/dist/matter/installments/use-installments-selection.js.map +1 -1
  232. package/dist/matter/my-account-profile/my-account-profile.d.ts +358 -103
  233. package/dist/matter/my-account-profile/my-account-profile.js +370 -174
  234. package/dist/matter/my-account-profile/my-account-profile.js.map +1 -1
  235. package/dist/matter/order-cancel/order-cancel.d.ts +65 -19
  236. package/dist/matter/order-cancel/order-cancel.js +118 -51
  237. package/dist/matter/order-cancel/order-cancel.js.map +1 -1
  238. package/dist/matter/order-delivery-address/order-delivery-address.d.ts +8 -18
  239. package/dist/matter/order-delivery-address/order-delivery-address.js +14 -23
  240. package/dist/matter/order-delivery-address/order-delivery-address.js.map +1 -1
  241. package/dist/matter/order-delivery-group/order-delivery-group.d.ts +40 -24
  242. package/dist/matter/order-delivery-group/order-delivery-group.js +64 -74
  243. package/dist/matter/order-delivery-group/order-delivery-group.js.map +1 -1
  244. package/dist/matter/order-details-header/order-details-header.d.ts +32 -15
  245. package/dist/matter/order-details-header/order-details-header.js +66 -58
  246. package/dist/matter/order-details-header/order-details-header.js.map +1 -1
  247. package/dist/matter/order-invoice-download/order-invoice-download.d.ts +78 -0
  248. package/dist/matter/order-invoice-download/order-invoice-download.js +173 -0
  249. package/dist/matter/order-invoice-download/order-invoice-download.js.map +1 -0
  250. package/dist/matter/order-list/order-list.d.ts +164 -19
  251. package/dist/matter/order-list/order-list.js +229 -87
  252. package/dist/matter/order-list/order-list.js.map +1 -1
  253. package/dist/matter/order-list-row/order-list-row.d.ts +6 -1
  254. package/dist/matter/order-list-row/order-list-row.js +3 -2
  255. package/dist/matter/order-list-row/order-list-row.js.map +1 -1
  256. package/dist/matter/order-list-search/order-list-search.d.ts +18 -26
  257. package/dist/matter/order-list-search/order-list-search.js +30 -69
  258. package/dist/matter/order-list-search/order-list-search.js.map +1 -1
  259. package/dist/matter/order-list-views/order-list-views.d.ts +15 -22
  260. package/dist/matter/order-list-views/order-list-views.js +22 -68
  261. package/dist/matter/order-list-views/order-list-views.js.map +1 -1
  262. package/dist/matter/order-payment/order-payment.d.ts +33 -10
  263. package/dist/matter/order-payment/order-payment.js +44 -39
  264. package/dist/matter/order-payment/order-payment.js.map +1 -1
  265. package/dist/matter/order-placed/order-placed-deliveries.d.ts +144 -12
  266. package/dist/matter/order-placed/order-placed-deliveries.js +115 -40
  267. package/dist/matter/order-placed/order-placed-deliveries.js.map +1 -1
  268. package/dist/matter/order-placed/order-placed.d.ts +198 -31
  269. package/dist/matter/order-placed/order-placed.js +230 -139
  270. package/dist/matter/order-placed/order-placed.js.map +1 -1
  271. package/dist/matter/order-placed-date/order-placed-date.d.ts +5 -8
  272. package/dist/matter/order-placed-date/order-placed-date.js +7 -8
  273. package/dist/matter/order-placed-date/order-placed-date.js.map +1 -1
  274. package/dist/matter/order-placed-payment-summary/order-placed-payment-summary.d.ts +90 -17
  275. package/dist/matter/order-placed-payment-summary/order-placed-payment-summary.js +93 -117
  276. package/dist/matter/order-placed-payment-summary/order-placed-payment-summary.js.map +1 -1
  277. package/dist/matter/order-progress/order-progress.d.ts +19 -8
  278. package/dist/matter/order-progress/order-progress.js +37 -45
  279. package/dist/matter/order-progress/order-progress.js.map +1 -1
  280. package/dist/matter/order-summary/order-summary.d.ts +19 -9
  281. package/dist/matter/order-summary/order-summary.js +38 -44
  282. package/dist/matter/order-summary/order-summary.js.map +1 -1
  283. package/dist/matter/order-tracking-link/order-tracking-link.d.ts +43 -0
  284. package/dist/matter/order-tracking-link/order-tracking-link.js +107 -0
  285. package/dist/matter/order-tracking-link/order-tracking-link.js.map +1 -0
  286. package/dist/matter/payment/payment-card-capture.js +17 -10
  287. package/dist/matter/payment/payment-card-capture.js.map +1 -1
  288. package/dist/matter/payment/payment-controller.d.ts +4 -2
  289. package/dist/matter/payment/payment-controller.js +30 -9
  290. package/dist/matter/payment/payment-controller.js.map +1 -1
  291. package/dist/matter/payment/payment-method-badges.js +1 -1
  292. package/dist/matter/payment/payment.d.ts +69 -19
  293. package/dist/matter/payment/payment.js +101 -35
  294. package/dist/matter/payment/payment.js.map +1 -1
  295. package/dist/matter/payment/use-payment-method-selection.d.ts +25 -4
  296. package/dist/matter/payment/use-payment-method-selection.js +94 -32
  297. package/dist/matter/payment/use-payment-method-selection.js.map +1 -1
  298. package/dist/matter/payment/use-payment-submit-gate.d.ts +14 -3
  299. package/dist/matter/payment/use-payment-submit-gate.js +47 -8
  300. package/dist/matter/payment/use-payment-submit-gate.js.map +1 -1
  301. package/dist/matter/place-order/place-order.d.ts +171 -57
  302. package/dist/matter/place-order/place-order.js +376 -185
  303. package/dist/matter/place-order/place-order.js.map +1 -1
  304. package/dist/matter/pricing/pricing.d.ts +152 -13
  305. package/dist/matter/pricing/pricing.js +153 -52
  306. package/dist/matter/pricing/pricing.js.map +1 -1
  307. package/dist/matter/product-information/product-information.d.ts +27 -4
  308. package/dist/matter/product-information/product-information.js +32 -15
  309. package/dist/matter/product-information/product-information.js.map +1 -1
  310. package/dist/matter/product-list/product-list.d.ts +24 -6
  311. package/dist/matter/product-list/product-list.js +32 -26
  312. package/dist/matter/product-list/product-list.js.map +1 -1
  313. package/dist/matter/product-shelf/product-shelf.d.ts +8 -3
  314. package/dist/matter/product-shelf/product-shelf.js +111 -10
  315. package/dist/matter/product-shelf/product-shelf.js.map +1 -1
  316. package/dist/matter/region/region.d.ts +33 -16
  317. package/dist/matter/region/region.js +59 -52
  318. package/dist/matter/region/region.js.map +1 -1
  319. package/dist/matter/save-card/save-card.d.ts +43 -8
  320. package/dist/matter/save-card/save-card.js +61 -23
  321. package/dist/matter/save-card/save-card.js.map +1 -1
  322. package/dist/matter/saved-cards/saved-cards.d.ts +113 -21
  323. package/dist/matter/saved-cards/saved-cards.js +349 -77
  324. package/dist/matter/saved-cards/saved-cards.js.map +1 -1
  325. package/dist/matter/shipping-address/address-payload.js +25 -0
  326. package/dist/matter/shipping-address/address-payload.js.map +1 -0
  327. package/dist/matter/shipping-address/country-descriptors.js +71 -71
  328. package/dist/matter/shipping-address/country-descriptors.js.map +1 -1
  329. package/dist/matter/shipping-address/library-country-descriptors.js +136 -0
  330. package/dist/matter/shipping-address/library-country-descriptors.js.map +1 -0
  331. package/dist/matter/shipping-address/shipping-address.d.ts +312 -45
  332. package/dist/matter/shipping-address/shipping-address.js +443 -188
  333. package/dist/matter/shipping-address/shipping-address.js.map +1 -1
  334. package/dist/matter/shipping-simulator/shipping-simulator.d.ts +251 -25
  335. package/dist/matter/shipping-simulator/shipping-simulator.js +261 -51
  336. package/dist/matter/shipping-simulator/shipping-simulator.js.map +1 -1
  337. package/dist/matter/sign-in/sign-in.d.ts +108 -0
  338. package/dist/matter/sign-in/sign-in.js +285 -0
  339. package/dist/matter/sign-in/sign-in.js.map +1 -0
  340. package/dist/matter/sign-in-disclosure/sign-in-disclosure.d.ts +81 -0
  341. package/dist/matter/sign-in-disclosure/sign-in-disclosure.js +232 -0
  342. package/dist/matter/sign-in-disclosure/sign-in-disclosure.js.map +1 -0
  343. package/dist/matter/sign-in-form/sign-in-form.d.ts +93 -62
  344. package/dist/matter/sign-in-form/sign-in-form.js +134 -144
  345. package/dist/matter/sign-in-form/sign-in-form.js.map +1 -1
  346. package/dist/particles/binding-switcher/binding-switcher.d.ts +59 -0
  347. package/dist/particles/binding-switcher/binding-switcher.js +194 -0
  348. package/dist/particles/binding-switcher/binding-switcher.js.map +1 -0
  349. package/dist/particles/card-summary/card-network.d.ts +17 -0
  350. package/dist/particles/card-summary/card-network.js +25 -0
  351. package/dist/particles/card-summary/card-network.js.map +1 -0
  352. package/dist/particles/card-summary/card-summary.d.ts +113 -0
  353. package/dist/particles/card-summary/card-summary.js +221 -0
  354. package/dist/particles/card-summary/card-summary.js.map +1 -0
  355. package/dist/particles/carousel/carousel.d.ts +99 -11
  356. package/dist/particles/carousel/carousel.js +103 -35
  357. package/dist/particles/carousel/carousel.js.map +1 -1
  358. package/dist/particles/copy-text/copy-text.js +5 -15
  359. package/dist/particles/copy-text/copy-text.js.map +1 -1
  360. package/dist/particles/dialog/dialog.d.ts +14 -6
  361. package/dist/particles/dialog/dialog.js +6 -3
  362. package/dist/particles/dialog/dialog.js.map +1 -1
  363. package/dist/particles/drawer/drawer.js +1 -1
  364. package/dist/particles/drawer/drawer.js.map +1 -1
  365. package/dist/particles/email-field/email-field.d.ts +2 -1
  366. package/dist/particles/email-field/email-field.js +2 -1
  367. package/dist/particles/email-field/email-field.js.map +1 -1
  368. package/dist/particles/footer-link-group/footer-link-group.js +1 -0
  369. package/dist/particles/footer-link-group/footer-link-group.js.map +1 -1
  370. package/dist/particles/footer-social/footer-social.d.ts +1 -1
  371. package/dist/particles/footer-social/footer-social.js +1 -1
  372. package/dist/particles/footer-social/footer-social.js.map +1 -1
  373. package/dist/particles/form/form.d.ts +85 -13
  374. package/dist/particles/form/form.js +91 -42
  375. package/dist/particles/form/form.js.map +1 -1
  376. package/dist/particles/gallery/gallery.d.ts +129 -12
  377. package/dist/particles/gallery/gallery.js +121 -34
  378. package/dist/particles/gallery/gallery.js.map +1 -1
  379. package/dist/particles/incentives/incentives.d.ts +1 -1
  380. package/dist/particles/incentives/incentives.js +1 -1
  381. package/dist/particles/incentives/incentives.js.map +1 -1
  382. package/dist/particles/order-details-back/order-details-back.d.ts +5 -3
  383. package/dist/particles/order-details-back/order-details-back.js +8 -10
  384. package/dist/particles/order-details-back/order-details-back.js.map +1 -1
  385. package/dist/particles/order-status-badge/order-status-badge.d.ts +3 -3
  386. package/dist/particles/order-status-badge/order-status-badge.js +4 -20
  387. package/dist/particles/order-status-badge/order-status-badge.js.map +1 -1
  388. package/dist/particles/password-field/password-field.d.ts +1 -1
  389. package/dist/particles/password-field/password-field.js +2 -4
  390. package/dist/particles/password-field/password-field.js.map +1 -1
  391. package/dist/particles/payment-methods/payment-methods.d.ts +1 -1
  392. package/dist/particles/payment-methods/payment-methods.js +1 -1
  393. package/dist/particles/payment-methods/payment-methods.js.map +1 -1
  394. package/dist/particles/phone-field/phone-field.d.ts +4 -4
  395. package/dist/particles/phone-field/phone-field.js +8 -11
  396. package/dist/particles/phone-field/phone-field.js.map +1 -1
  397. package/dist/particles/spinner/spinner.d.ts +24 -4
  398. package/dist/particles/spinner/spinner.js +25 -9
  399. package/dist/particles/spinner/spinner.js.map +1 -1
  400. package/dist/particles/switch/switch.d.ts +4 -1
  401. package/dist/particles/switch/switch.js +3 -1
  402. package/dist/particles/switch/switch.js.map +1 -1
  403. package/dist/particles/toast/toast.d.ts +49 -9
  404. package/dist/particles/toast/toast.js +81 -15
  405. package/dist/particles/toast/toast.js.map +1 -1
  406. package/dist/schema.graphql +461 -89
  407. package/dist/sdk/actions/index.d.ts +3 -1
  408. package/dist/sdk/actions/index.js +3 -1
  409. package/dist/sdk/actions/locale-action-provider.d.ts +16 -0
  410. package/dist/sdk/actions/locale-action-provider.js +20 -0
  411. package/dist/sdk/actions/locale-action-provider.js.map +1 -0
  412. package/dist/sdk/actions/saved-card-action-provider.d.ts +12 -0
  413. package/dist/sdk/actions/saved-card-action-provider.js +16 -0
  414. package/dist/sdk/actions/saved-card-action-provider.js.map +1 -0
  415. package/dist/sdk/actions/types.d.ts +6 -2
  416. package/dist/sdk/address/address-fields.js +4 -4
  417. package/dist/sdk/address/address-fields.js.map +1 -1
  418. package/dist/sdk/address/constants.js +1 -6
  419. package/dist/sdk/address/constants.js.map +1 -1
  420. package/dist/sdk/address/messages.js +44 -44
  421. package/dist/sdk/address/messages.js.map +1 -1
  422. package/dist/sdk/address/postal-code.js +15 -2
  423. package/dist/sdk/address/postal-code.js.map +1 -1
  424. package/dist/sdk/address/types.d.ts +5 -3
  425. package/dist/sdk/address/validate-address.js +3 -3
  426. package/dist/sdk/address/validate-address.js.map +1 -1
  427. package/dist/sdk/analytics/use-analytics-actions.d.ts +1 -1
  428. package/dist/sdk/analytics/use-analytics-actions.js.map +1 -1
  429. package/dist/sdk/cache/storefront-cache.js +2 -1
  430. package/dist/sdk/cache/storefront-cache.js.map +1 -1
  431. package/dist/sdk/cart/operations.d.ts +2 -1
  432. package/dist/sdk/cart/operations.js +55 -1
  433. package/dist/sdk/cart/operations.js.map +1 -1
  434. package/dist/sdk/cart/optimistic.d.ts +30 -7
  435. package/dist/sdk/cart/optimistic.js +78 -41
  436. package/dist/sdk/cart/optimistic.js.map +1 -1
  437. package/dist/sdk/cart/use-cart-actions.d.ts +7 -0
  438. package/dist/sdk/cart/use-cart-actions.js +61 -15
  439. package/dist/sdk/cart/use-cart-actions.js.map +1 -1
  440. package/dist/sdk/cart/use-cart-sync-sales-channel.js +70 -0
  441. package/dist/sdk/cart/use-cart-sync-sales-channel.js.map +1 -0
  442. package/dist/sdk/data/index.js +2 -2
  443. package/dist/sdk/data/reactive-list-item-data-provider.js +2 -2
  444. package/dist/sdk/generated/gql.js +16 -12
  445. package/dist/sdk/generated/gql.js.map +1 -1
  446. package/dist/sdk/generated/graphql.d.ts +197 -51
  447. package/dist/sdk/generated/graphql.js +2318 -91
  448. package/dist/sdk/generated/graphql.js.map +1 -1
  449. package/dist/sdk/i18n/format-error-code.js +23 -0
  450. package/dist/sdk/i18n/format-error-code.js.map +1 -0
  451. package/dist/sdk/i18n/message-formatter.d.ts +22 -0
  452. package/dist/sdk/i18n/message-formatter.js +140 -0
  453. package/dist/sdk/i18n/message-formatter.js.map +1 -0
  454. package/dist/sdk/i18n/use-message-formatter.d.ts +8 -0
  455. package/dist/sdk/i18n/use-message-formatter.js +18 -0
  456. package/dist/sdk/i18n/use-message-formatter.js.map +1 -0
  457. package/dist/sdk/identity/use-identity-actions.js.map +1 -1
  458. package/dist/sdk/locale/binding-switch-provider.d.ts +13 -0
  459. package/dist/sdk/locale/binding-switch-provider.js +20 -0
  460. package/dist/sdk/locale/binding-switch-provider.js.map +1 -0
  461. package/dist/sdk/locale/use-locale-actions.d.ts +16 -0
  462. package/dist/sdk/locale/use-locale-actions.js +70 -0
  463. package/dist/sdk/locale/use-locale-actions.js.map +1 -0
  464. package/dist/sdk/navigation/binding-switch.d.ts +39 -0
  465. package/dist/sdk/navigation/binding-switch.js +129 -0
  466. package/dist/sdk/navigation/binding-switch.js.map +1 -0
  467. package/dist/sdk/navigation/decode-route-params.d.ts +11 -0
  468. package/dist/sdk/navigation/decode-route-params.js +32 -0
  469. package/dist/sdk/navigation/decode-route-params.js.map +1 -0
  470. package/dist/sdk/navigation/redirect.d.ts +2 -0
  471. package/dist/sdk/navigation/redirect.js +19 -1
  472. package/dist/sdk/navigation/redirect.js.map +1 -1
  473. package/dist/sdk/navigation/types.d.ts +13 -0
  474. package/dist/sdk/payment/bin-format.js +20 -0
  475. package/dist/sdk/payment/bin-format.js.map +1 -0
  476. package/dist/sdk/payment/challenge-return.js +37 -0
  477. package/dist/sdk/payment/challenge-return.js.map +1 -0
  478. package/dist/sdk/payment/confirmation-last-four.js +39 -0
  479. package/dist/sdk/payment/confirmation-last-four.js.map +1 -0
  480. package/dist/sdk/payment/gateway.d.ts +1 -1
  481. package/dist/sdk/payment/gateway.js +8 -2
  482. package/dist/sdk/payment/gateway.js.map +1 -1
  483. package/dist/sdk/payment/operations.d.ts +1 -0
  484. package/dist/sdk/payment/operations.js +28 -6
  485. package/dist/sdk/payment/operations.js.map +1 -1
  486. package/dist/sdk/payment/resumed-purchase.d.ts +1 -0
  487. package/dist/sdk/payment/resumed-purchase.js +119 -0
  488. package/dist/sdk/payment/resumed-purchase.js.map +1 -0
  489. package/dist/sdk/payment/security-code-mask.js +16 -23
  490. package/dist/sdk/payment/security-code-mask.js.map +1 -1
  491. package/dist/sdk/payment/submission-registry.js +6 -2
  492. package/dist/sdk/payment/submission-registry.js.map +1 -1
  493. package/dist/sdk/payment/use-payment-actions.d.ts +18 -3
  494. package/dist/sdk/payment/use-payment-actions.js +23 -3
  495. package/dist/sdk/payment/use-payment-actions.js.map +1 -1
  496. package/dist/sdk/payment/use-place-order.d.ts +10 -2
  497. package/dist/sdk/payment/use-place-order.js +138 -76
  498. package/dist/sdk/payment/use-place-order.js.map +1 -1
  499. package/dist/sdk/provider/storefront-provider.d.ts +1 -7
  500. package/dist/sdk/provider/storefront-provider.js +4 -11
  501. package/dist/sdk/provider/storefront-provider.js.map +1 -1
  502. package/dist/sdk/saved-cards/operations.d.ts +16 -0
  503. package/dist/sdk/saved-cards/operations.js +41 -0
  504. package/dist/sdk/saved-cards/operations.js.map +1 -0
  505. package/dist/sdk/saved-cards/use-saved-card-actions.d.ts +26 -0
  506. package/dist/sdk/saved-cards/use-saved-card-actions.js +86 -0
  507. package/dist/sdk/saved-cards/use-saved-card-actions.js.map +1 -0
  508. package/dist/sdk/seo/entity-landing.d.ts +24 -0
  509. package/dist/sdk/seo/entity-landing.js +30 -0
  510. package/dist/sdk/seo/entity-landing.js.map +1 -0
  511. package/dist/sdk/seo/page-alternates.d.ts +8 -5
  512. package/dist/sdk/seo/page-alternates.js +11 -14
  513. package/dist/sdk/seo/page-alternates.js.map +1 -1
  514. package/dist/sdk/seo/search-landing.d.ts +42 -0
  515. package/dist/sdk/seo/search-landing.js +85 -0
  516. package/dist/sdk/seo/search-landing.js.map +1 -0
  517. package/dist/sdk/session/mock-session.d.ts +9 -0
  518. package/dist/sdk/session/mock-session.js +31 -0
  519. package/dist/sdk/session/mock-session.js.map +1 -0
  520. package/dist/sdk/session/read-server-session.d.ts +3 -0
  521. package/dist/sdk/session/read-server-session.js +5 -0
  522. package/dist/sdk/session/read-server-session.js.map +1 -1
  523. package/dist/sdk/session/return-path-segment.d.ts +10 -0
  524. package/dist/sdk/session/return-path-segment.js +15 -0
  525. package/dist/sdk/session/return-path-segment.js.map +1 -0
  526. package/dist/sdk/session/use-session-actions.js.map +1 -1
  527. package/dist/sdk/shipping/shipping-operations.d.ts +1 -1
  528. package/dist/sdk/shipping/shipping-operations.js +13 -0
  529. package/dist/sdk/shipping/shipping-operations.js.map +1 -1
  530. package/dist/sdk/shipping/use-cart-shipping-simulation.js.map +1 -1
  531. package/dist/sdk/shipping/use-shipping-actions.js.map +1 -1
  532. package/dist/sdk/shipping/use-shipping-simulation.js.map +1 -1
  533. package/dist/sdk/state/cart.d.ts +9 -2
  534. package/dist/sdk/state/cart.js +9 -2
  535. package/dist/sdk/state/cart.js.map +1 -1
  536. package/dist/utils/safe-href.d.ts +2 -0
  537. package/package.json +4 -3
  538. package/skills/storefront-asset/SKILL.md +2 -2
  539. package/skills/storefront-asset/references/api-side.md +27 -14
  540. package/skills/storefront-asset/references/findings.md +5 -2
  541. package/src/styles/tailwind.css +9 -2
  542. package/dist/matter/shipping-address/country-descriptors.d.ts +0 -1
  543. package/dist/message-locales.json +0 -7
  544. package/dist/sdk/i18n/client.d.ts +0 -4
  545. package/dist/sdk/i18n/client.js +0 -4
  546. package/dist/sdk/i18n/locales.d.ts +0 -8
  547. package/dist/sdk/i18n/locales.js +0 -57
  548. package/dist/sdk/i18n/locales.js.map +0 -1
  549. package/dist/sdk/i18n/messages/en-US.js +0 -164
  550. package/dist/sdk/i18n/messages/en-US.js.map +0 -1
  551. package/dist/sdk/i18n/messages/en-US.json +0 -159
  552. package/dist/sdk/i18n/messages/en-US.json.d.ts +0 -163
  553. package/dist/sdk/i18n/messages/es-ES.js +0 -164
  554. package/dist/sdk/i18n/messages/es-ES.js.map +0 -1
  555. package/dist/sdk/i18n/messages/es-ES.json +0 -159
  556. package/dist/sdk/i18n/messages/pt-BR.js +0 -164
  557. package/dist/sdk/i18n/messages/pt-BR.js.map +0 -1
  558. package/dist/sdk/i18n/messages/pt-BR.json +0 -159
  559. package/dist/sdk/i18n/provider.d.ts +0 -1
  560. package/dist/sdk/i18n/provider.js +0 -30
  561. package/dist/sdk/i18n/provider.js.map +0 -1
  562. package/dist/sdk/i18n/server.d.ts +0 -28
  563. package/dist/sdk/i18n/server.js +0 -59
  564. package/dist/sdk/i18n/server.js.map +0 -1
  565. package/dist/utils/resolve-authored-copy.js +0 -18
  566. package/dist/utils/resolve-authored-copy.js.map +0 -1
  567. package/dist/utils/substitute-template.js +0 -33
  568. package/dist/utils/substitute-template.js.map +0 -1
@@ -326,9 +326,10 @@ extend type Query {
326
326
 
327
327
  extend type Query {
328
328
  """
329
- Resolve the active cart from the request context (x-order-form-id header,
330
- then cookie). When no cart context is present, a new cart is created and
331
- the x-order-form-id cookie is set on the response.
329
+ Resolve the active cart from the request context: the order form id in the
330
+ `checkout.vtex.com=__ofid=<id>` cookie. When no cart context is present, a
331
+ new cart is created and the `checkout.vtex.com` cookie that names it is set
332
+ on the response.
332
333
  """
333
334
  cart: Cart!
334
335
  }
@@ -344,8 +345,8 @@ extend type Query {
344
345
  input: ShippingSimulateInput!
345
346
  ): ShippingSimulationPayload!
346
347
  """
347
- Simulate shipping options for the entire active cart. Reads the cart from the
348
- x-order-form-id context and simulates all of its items against the
348
+ Simulate shipping options for the entire active cart. Reads the cart named by the
349
+ `checkout.vtex.com` cookie and simulates all of its items against the
349
350
  destination, returning the options common to every item with prices summed
350
351
  across items. Never mints a cart: absent context returns a MISSING_CART_CONTEXT
351
352
  userError.
@@ -375,8 +376,8 @@ extend type Query {
375
376
  """
376
377
  shipping: Shipping!
377
378
  """
378
- Resolve the shopper's session state from the active order form (x-order-form-id
379
- header, then cookie). Projects from the same order form fetch as `cart`.
379
+ Resolve the shopper's session state from the active order form (the one the
380
+ `checkout.vtex.com` cookie names). Projects from the same order form fetch as `cart`.
380
381
  """
381
382
  session: Session!
382
383
  }
@@ -390,16 +391,17 @@ extend type Query {
390
391
 
391
392
  extend type Query {
392
393
  """
393
- A settled order's payment recap, keyed on the order group
394
- paymentStartTransaction / paymentGatewayCallback return. Null when the
395
- order group does not resolve to a settled order — never a fabricated empty
396
- projection (contrast Query.payment, which always resolves).
394
+ A settled order's payment recap, keyed on the order's Node ID. Null when the
395
+ id is malformed, of another type, or does not resolve to a settled order —
396
+ never a fabricated empty projection (contrast Query.payment, which always
397
+ resolves).
397
398
  """
398
399
  order(
399
400
  """
400
- The order group returned by paymentStartTransaction / paymentGatewayCallback.
401
+ The Relay Node ID of the order: `Order.id`, or `orderNodeId` from paymentStartTransaction /
402
+ paymentGatewayCallback.
401
403
  """
402
- orderGroup: String!
404
+ id: ID!
403
405
  ): Order
404
406
  }
405
407
 
@@ -503,6 +505,36 @@ extend type Query {
503
505
  ): CustomerOrdersConnection! @cacheControl(maxAge: 0, scope: PRIVATE)
504
506
  }
505
507
 
508
+ extend type Query {
509
+ """
510
+ The signed-in shopper's own saved cards. Takes no id — the identity comes from
511
+ the session. Resolves to the shopper's entity, with an empty list when no card
512
+ is saved. Null only when the read fails, alongside an UNAUTHORIZED,
513
+ UPSTREAM_ERROR, or UPSTREAM_TIMEOUT error at this path (ADR-00007), so the
514
+ failure does not null the rest of the operation.
515
+ """
516
+ customerSavedCards: CustomerSavedCards
517
+ }
518
+
519
+ extend type Query {
520
+ """
521
+ The credit-card networks the store accepts on the request's sales channel,
522
+ with their validation rules, for adding a saved card. Requires a signed-in
523
+ shopper. Null when the read fails, alongside an UNAUTHORIZED, UPSTREAM_ERROR,
524
+ UPSTREAM_TIMEOUT, or NO_CARD_NETWORKS error at this path (ADR-00007).
525
+ NO_CARD_NETWORKS means the store accepts no credit-card network on this
526
+ sales channel; the list is never empty.
527
+ """
528
+ savedCardNetworks: [CardNetworkRule!]
529
+ """
530
+ The signed-in shopper's saved addresses a new card can be billed to, in the
531
+ platform's order. Takes no id. Empty when none is saved. Null only when the
532
+ read fails, alongside an UNAUTHORIZED, UPSTREAM_ERROR, or UPSTREAM_TIMEOUT
533
+ error at this path.
534
+ """
535
+ customerSavedCardBillingAddresses: [CardBillingAddress!]
536
+ }
537
+
506
538
  """
507
539
  Root mutation type. Cart and checkout operations are declared via
508
540
  `extend type Mutation` in the checkout module.
@@ -526,14 +558,14 @@ extend type Mutation {
526
558
  """Item details to add."""
527
559
  input: CartItemAddInput!
528
560
  ): CartItemAddPayload!
529
- """Remove an item from the cart entirely (sets quantity to 0)."""
561
+ """Remove a line from the cart entirely (sets quantity to 0)."""
530
562
  cartItemRemove(
531
563
  """Item to remove."""
532
564
  input: CartItemRemoveInput!
533
565
  ): CartItemRemovePayload!
534
566
  """
535
567
  Remove multiple items from the cart in a single upstream write (each line's
536
- quantity is set to 0). Tolerant: variants absent from the cart are skipped.
568
+ quantity is set to 0). Tolerant: lines absent from the cart are skipped.
537
569
  """
538
570
  cartItemsRemove(
539
571
  """Items to remove."""
@@ -577,6 +609,15 @@ extend type Mutation {
577
609
  context and is never created.
578
610
  """
579
611
  cartValidate: CartValidatePayload!
612
+ """
613
+ Move the active cart onto the request's sales channel, then reconcile its locale. Takes no
614
+ arguments: the cart is resolved from the request context and is never created. An empty cart, or
615
+ a cart already on the active channel, does not send `sc`. Otherwise one POST to `items/update`
616
+ with `sc` re-sends every item's index and current quantity, so Checkout reprocesses that order
617
+ form and drops lines the destination cannot sell. An upstream failure is reported in `userErrors`
618
+ and does not throw.
619
+ """
620
+ cartSalesChannelSync: CartSalesChannelSyncPayload!
580
621
  }
581
622
 
582
623
  extend type Mutation {
@@ -623,7 +664,7 @@ extend type Mutation {
623
664
  input: PaymentMethodSelectInput!
624
665
  ): PaymentMethodSelectPayload!
625
666
  """
626
- Select an installment count for the currently-selected method. Recomputes the cart total.
667
+ Select an installment count for the currently-selected method. The returned cart's `total` is the greater of the order form's value and the selected payment's value.
627
668
  """
628
669
  paymentInstallmentSelect(
629
670
  """Installment count to select."""
@@ -743,6 +784,18 @@ extend type Mutation {
743
784
  ): CustomerOrderCancelPayload!
744
785
  }
745
786
 
787
+ extend type Mutation {
788
+ """
789
+ Removes one of the signed-in shopper's saved cards, by the id the
790
+ customerSavedCards read returned. Returns the refreshed list on success.
791
+ Throws UNAUTHORIZED / UPSTREAM_ERROR / UPSTREAM_TIMEOUT (ADR-00007).
792
+ """
793
+ customerSavedCardRemove(
794
+ """The card's id, as customerSavedCards returned it."""
795
+ id: ID!
796
+ ): CustomerSavedCardRemovePayload!
797
+ }
798
+
746
799
  """
747
800
  A manufacturer or designer brand.
748
801
  Maps to VTEX Brand entity.
@@ -1195,7 +1248,7 @@ type Rating {
1195
1248
  A curated group of products. Maps to VTEX Collection (Beta) entity.
1196
1249
  Collections can be used for seasonal promotions, editorial picks, etc.
1197
1250
  """
1198
- type Collection implements Node {
1251
+ type Collection implements Node @cacheControl(maxAge: 300, scope: PUBLIC) {
1199
1252
  """Globally unique identifier."""
1200
1253
  id: ID!
1201
1254
  """Collection title."""
@@ -1761,7 +1814,13 @@ type Cart implements Node @cacheControl(maxAge: 0, scope: PRIVATE) {
1761
1814
  items: [CartItem!]!
1762
1815
  """Aggregated totals (items, shipping, discounts, etc.)."""
1763
1816
  totalizers: [CartTotalizer!]!
1764
- """Total cart value."""
1817
+ """
1818
+ Total cart value: the greater of the order form's value and the selected payment's value.
1819
+ While an installment tier with interest is selected, the payment's value is the larger of
1820
+ the two and the total includes the interest, so it matches what the transaction charges.
1821
+ Without a selected payment it is the order form's value. Totalizer lines do not include an
1822
+ interest line, so they may not add up to this total.
1823
+ """
1765
1824
  total: Money!
1766
1825
  """
1767
1826
  Server messages from cart processing (e.g. promotions applied, stock warnings).
@@ -1804,10 +1863,10 @@ type Cart implements Node @cacheControl(maxAge: 0, scope: PRIVATE) {
1804
1863
  freeShippingProgress: FreeShippingProgress
1805
1864
  """
1806
1865
  Non-null when the cart belongs to a different sales channel than the request's active context. The
1807
- cart is left exactly as it was: nothing here reprices it or removes an item. Converging it is a
1808
- write, and the first write that carries the active channel makes Checkout reprocess the same
1809
- orderForm — prices, promotions, coupons and logistics are recomputed and items not sellable in the
1810
- destination channel are removed by Checkout, while orderFormId, attachments and addresses survive.
1866
+ cart is left exactly as it was: nothing here reprices it or removes an item. Converging it is the
1867
+ `cartSalesChannelSync` write, and that write makes Checkout reprocess the same orderForm — prices,
1868
+ promotions, coupons and logistics are recomputed and items not sellable in the destination channel
1869
+ are removed by Checkout, while orderFormId, attachments and addresses survive.
1811
1870
  """
1812
1871
  salesChannelMismatch: CartSalesChannelMismatch
1813
1872
  }
@@ -2212,30 +2271,32 @@ input CartItemAddInput {
2212
2271
  seller: ID = "U2VsbGVyOjE="
2213
2272
  }
2214
2273
 
2215
- """Input for removing an item from a cart."""
2274
+ """Input for removing a line from a cart."""
2216
2275
  input CartItemRemoveInput {
2217
- """The variant's global Node ID to remove."""
2218
- variantId: ID!
2276
+ """The line to remove: its `CartItem.lineId`."""
2277
+ lineId: String!
2219
2278
  }
2220
2279
 
2221
- """Input for removing multiple items from a cart in one call."""
2280
+ """Input for removing multiple lines from a cart in one call."""
2222
2281
  input CartItemsRemoveInput {
2223
- """The variants' global Node IDs to remove. Duplicates are collapsed."""
2224
- variantIds: [ID!]!
2282
+ """
2283
+ The lines to remove: their `CartItem.lineId` values. Duplicates are collapsed.
2284
+ """
2285
+ lineIds: [String!]!
2225
2286
  }
2226
2287
 
2227
- """Input for increasing the quantity of a cart item."""
2288
+ """Input for increasing the quantity of a cart line."""
2228
2289
  input CartItemQuantityIncreaseInput {
2229
- """The variant's global Node ID whose quantity to increase."""
2230
- variantId: ID!
2290
+ """The line whose quantity to increase: its `CartItem.lineId`."""
2291
+ lineId: String!
2231
2292
  """Amount to add to the current quantity. Defaults to 1."""
2232
2293
  quantityToAdd: Int = 1
2233
2294
  }
2234
2295
 
2235
- """Input for decreasing the quantity of a cart item."""
2296
+ """Input for decreasing the quantity of a cart line."""
2236
2297
  input CartItemQuantityDecreaseInput {
2237
- """The variant's global Node ID whose quantity to decrease."""
2238
- variantId: ID!
2298
+ """The line whose quantity to decrease: its `CartItem.lineId`."""
2299
+ lineId: String!
2239
2300
  """Amount to subtract from the current quantity. Defaults to 1."""
2240
2301
  quantityToRemove: Int = 1
2241
2302
  }
@@ -2254,7 +2315,7 @@ input CartCouponRemoveInput {
2254
2315
 
2255
2316
  """Error codes for cart item add operations."""
2256
2317
  enum CartItemAddErrorCode {
2257
- """No cart context was provided (x-order-form-id header/cookie)."""
2318
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2258
2319
  MISSING_CART_CONTEXT
2259
2320
  """The quantity must be a positive integer."""
2260
2321
  INVALID_QUANTITY
@@ -2268,58 +2329,56 @@ enum CartItemAddErrorCode {
2268
2329
 
2269
2330
  """Error codes for cart item remove operations."""
2270
2331
  enum CartItemRemoveErrorCode {
2271
- """No cart context was provided (x-order-form-id header/cookie)."""
2332
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2272
2333
  MISSING_CART_CONTEXT
2273
- """The specified variant was not found in the cart."""
2334
+ """The specified line was not found in the cart."""
2274
2335
  ITEM_NOT_FOUND
2275
2336
  """The cart was not found."""
2276
2337
  CART_NOT_FOUND
2277
- """The provided variant ID is not a valid Variant Node ID."""
2278
- INVALID_VARIANT_ID
2338
+ """The upstream checkout API returned an unusable response."""
2339
+ UPSTREAM_ERROR
2279
2340
  }
2280
2341
 
2281
2342
  """Error codes for cart items batch remove operations."""
2282
2343
  enum CartItemsRemoveErrorCode {
2283
- """No cart context was provided (x-order-form-id header/cookie)."""
2344
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2284
2345
  MISSING_CART_CONTEXT
2285
- """None of the specified variants were found in the cart."""
2346
+ """None of the specified lines were found in the cart."""
2286
2347
  ITEM_NOT_FOUND
2287
2348
  """The cart was not found."""
2288
2349
  CART_NOT_FOUND
2289
- """A provided variant ID is not a valid Variant Node ID."""
2290
- INVALID_VARIANT_ID
2291
- """The input contained no variant IDs."""
2292
- NO_VARIANT_IDS_PROVIDED
2350
+ """The input contained no line IDs."""
2351
+ NO_LINE_IDS_PROVIDED
2293
2352
  """The upstream checkout API returned an unusable response."""
2294
2353
  UPSTREAM_ERROR
2295
2354
  }
2296
2355
 
2297
2356
  """Error codes for cart item quantity increase operations."""
2298
2357
  enum CartItemQuantityIncreaseErrorCode {
2299
- """No cart context was provided (x-order-form-id header/cookie)."""
2358
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2300
2359
  MISSING_CART_CONTEXT
2301
2360
  """The quantity must be a positive integer."""
2302
2361
  INVALID_QUANTITY
2303
- """The specified variant was not found in the cart."""
2362
+ """The specified line was not found in the cart."""
2304
2363
  ITEM_NOT_FOUND
2305
2364
  """The cart was not found."""
2306
2365
  CART_NOT_FOUND
2307
- """The provided variant ID is not a valid Variant Node ID."""
2308
- INVALID_VARIANT_ID
2366
+ """The upstream checkout API returned an unusable response."""
2367
+ UPSTREAM_ERROR
2309
2368
  }
2310
2369
 
2311
2370
  """Error codes for cart item quantity decrease operations."""
2312
2371
  enum CartItemQuantityDecreaseErrorCode {
2313
- """No cart context was provided (x-order-form-id header/cookie)."""
2372
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2314
2373
  MISSING_CART_CONTEXT
2315
2374
  """The quantity must be a positive integer."""
2316
2375
  INVALID_QUANTITY
2317
- """The specified variant was not found in the cart."""
2376
+ """The specified line was not found in the cart."""
2318
2377
  ITEM_NOT_FOUND
2319
2378
  """The cart was not found."""
2320
2379
  CART_NOT_FOUND
2321
- """The provided variant ID is not a valid Variant Node ID."""
2322
- INVALID_VARIANT_ID
2380
+ """The upstream checkout API returned an unusable response."""
2381
+ UPSTREAM_ERROR
2323
2382
  }
2324
2383
 
2325
2384
  """A domain error returned from a cart item add mutation."""
@@ -2404,7 +2463,7 @@ type CartItemQuantityDecreasePayload {
2404
2463
 
2405
2464
  """Error codes for cart coupon apply operations."""
2406
2465
  enum CartCouponApplyErrorCode {
2407
- """No cart context was provided (x-order-form-id header/cookie)."""
2466
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2408
2467
  MISSING_CART_CONTEXT
2409
2468
  """The cart was not found."""
2410
2469
  CART_NOT_FOUND
@@ -2412,11 +2471,16 @@ enum CartCouponApplyErrorCode {
2412
2471
  COUPON_NOT_FOUND
2413
2472
  """The coupon code has expired."""
2414
2473
  COUPON_EXPIRED
2474
+ """
2475
+ The code was rejected while another coupon was applied, and the applied coupons were kept. The
2476
+ platform does not say whether the code is unknown or cannot be combined with them.
2477
+ """
2478
+ COUPON_NOT_COMBINED
2415
2479
  }
2416
2480
 
2417
2481
  """Error codes for cart coupon remove operations."""
2418
2482
  enum CartCouponRemoveErrorCode {
2419
- """No cart context was provided (x-order-form-id header/cookie)."""
2483
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2420
2484
  MISSING_CART_CONTEXT
2421
2485
  """The cart was not found."""
2422
2486
  CART_NOT_FOUND
@@ -2462,7 +2526,7 @@ type CartCouponRemovePayload {
2462
2526
 
2463
2527
  """Error codes for cart validation operations."""
2464
2528
  enum CartValidateErrorCode {
2465
- """No cart context was provided (x-order-form-id header/cookie)."""
2529
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2466
2530
  MISSING_CART_CONTEXT
2467
2531
  """The cart was not found."""
2468
2532
  CART_NOT_FOUND
@@ -2488,6 +2552,44 @@ type CartValidatePayload {
2488
2552
  userErrors: [CartValidateError!]!
2489
2553
  }
2490
2554
 
2555
+ """Error codes for moving a cart onto the active sales channel."""
2556
+ enum CartSalesChannelSyncErrorCode {
2557
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2558
+ MISSING_CART_CONTEXT
2559
+ """The cart was not found."""
2560
+ CART_NOT_FOUND
2561
+ """
2562
+ The upstream checkout API could not be reached or returned an unusable response.
2563
+ """
2564
+ UPSTREAM_ERROR
2565
+ }
2566
+
2567
+ """A domain error returned from the cartSalesChannelSync mutation."""
2568
+ type CartSalesChannelSyncError {
2569
+ """Machine-readable error code."""
2570
+ code: CartSalesChannelSyncErrorCode!
2571
+ """Human-readable error message."""
2572
+ message: String!
2573
+ }
2574
+
2575
+ """
2576
+ Payload returned by the cartSalesChannelSync mutation.
2577
+
2578
+ The cart comes from the request context and is never created. An empty cart, or a cart already on
2579
+ the active sales channel, does not send `sc`. Otherwise one POST to `items/update` with `sc`
2580
+ re-sends every item's index and current quantity, so Checkout reprocesses that order form and drops
2581
+ lines the destination cannot sell, and then the locale is reconciled. An upstream failure is
2582
+ reported in `userErrors` and does not throw.
2583
+ """
2584
+ type CartSalesChannelSyncPayload {
2585
+ """
2586
+ The cart after the channel move and locale reconciliation, or null if errors occurred.
2587
+ """
2588
+ cart: Cart
2589
+ """Domain errors that occurred during the operation."""
2590
+ userErrors: [CartSalesChannelSyncError!]!
2591
+ }
2592
+
2491
2593
  """The delivery channel for a shipping option."""
2492
2594
  enum DeliveryChannel {
2493
2595
  """Home delivery."""
@@ -2604,7 +2706,7 @@ enum ShippingSimulateErrorCode {
2604
2706
  """The provided seller ID is not a valid Seller Node ID."""
2605
2707
  INVALID_SELLER_ID
2606
2708
  """
2607
- No active cart in context: the cartShippingSimulation query requires an x-order-form-id and never mints a cart.
2709
+ No active cart in context: the cartShippingSimulation query requires the `checkout.vtex.com` cart cookie and never mints a cart.
2608
2710
  """
2609
2711
  MISSING_CART_CONTEXT
2610
2712
  """
@@ -2648,8 +2750,8 @@ input ShippingSimulateInput {
2648
2750
 
2649
2751
  """
2650
2752
  Input for simulating shipping for the whole active cart. Carries the
2651
- destination only; items are sourced from the cart in the x-order-form-id
2652
- context, so there is no variant, quantity, or seller.
2753
+ destination only; items are sourced from the cart named by the
2754
+ `checkout.vtex.com` cookie, so there is no variant, quantity, or seller.
2653
2755
  """
2654
2756
  input CartShippingSimulateInput {
2655
2757
  """Postal code of the delivery destination."""
@@ -2738,7 +2840,7 @@ input ClientPreferencesUpdateInput {
2738
2840
 
2739
2841
  """Error codes for client profile update operations."""
2740
2842
  enum ClientProfileUpdateErrorCode {
2741
- """No cart context was provided (x-order-form-id header/cookie)."""
2843
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2742
2844
  MISSING_CART_CONTEXT
2743
2845
  """The cart was not found."""
2744
2846
  CART_NOT_FOUND
@@ -2748,7 +2850,7 @@ enum ClientProfileUpdateErrorCode {
2748
2850
 
2749
2851
  """Error codes for client preferences update operations."""
2750
2852
  enum ClientPreferencesUpdateErrorCode {
2751
- """No cart context was provided (x-order-form-id header/cookie)."""
2853
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2752
2854
  MISSING_CART_CONTEXT
2753
2855
  """The cart was not found."""
2754
2856
  CART_NOT_FOUND
@@ -2883,8 +2985,10 @@ input ShippingAddressUpdateInput {
2883
2985
  Saved address reference. Present when the shopper picked (and possibly edited) a saved address.
2884
2986
  """
2885
2987
  savedAddressId: ID
2886
- """Recipient name for the delivery address."""
2887
- recipientName: String!
2988
+ """
2989
+ Recipient name for the delivery address. Omit it for a destination-only write: the cart keeps its current recipient name. A blank string is rejected with MISSING_RECIPIENT_NAME.
2990
+ """
2991
+ recipientName: String
2888
2992
  """Postal code for the delivery address."""
2889
2993
  postalCode: String!
2890
2994
  """ISO 3166-1 alpha-3 country code (e.g. "BRA")."""
@@ -2905,7 +3009,7 @@ input ShippingAddressUpdateInput {
2905
3009
 
2906
3010
  """Error codes for shipping address update operations."""
2907
3011
  enum ShippingAddressUpdateErrorCode {
2908
- """No cart context was provided (x-order-form-id header/cookie)."""
3012
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2909
3013
  MISSING_CART_CONTEXT
2910
3014
  """The cart was not found."""
2911
3015
  CART_NOT_FOUND
@@ -2952,7 +3056,7 @@ input ShippingOptionSelectInput {
2952
3056
 
2953
3057
  """Error codes for shipping option select operations."""
2954
3058
  enum ShippingOptionSelectErrorCode {
2955
- """No cart context was provided (x-order-form-id header/cookie)."""
3059
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
2956
3060
  MISSING_CART_CONTEXT
2957
3061
  """The cart was not found."""
2958
3062
  CART_NOT_FOUND
@@ -3084,7 +3188,17 @@ type PaymentMethod {
3084
3188
  """
3085
3189
  name: String!
3086
3190
  """
3087
- Payment-system group (e.g. "creditCardPaymentGroup", "debitCardPaymentGroup"). Store-configured; kept as a string, not an enum.
3191
+ The vendor-neutral kind of this method: the closed set `PaymentType` defines. Derived
3192
+ from `groupName`; `OTHER` covers every group that is not mapped, including store-specific
3193
+ groups and wallets other than PayPal. Never null. Read it to decide which payment UI a
3194
+ method gets; read `groupName` to tell two `OTHER` methods apart.
3195
+ """
3196
+ type: PaymentType!
3197
+ """
3198
+ The payment-system group exactly as the order form carries it (e.g. "creditCardPaymentGroup",
3199
+ "custom201PaymentGroupPaymentGroup"). Store-configured and open-ended, so kept as a string, not an
3200
+ enum. It is the gateway transport value: the Send Payments request needs this literal, and the
3201
+ gateway rejects anything else. Prefer `type` to classify a method.
3088
3202
  """
3089
3203
  groupName: String!
3090
3204
  """
@@ -3121,13 +3235,26 @@ type PaymentMethodValidator {
3121
3235
  cvvMask: String
3122
3236
  """Regex validating the security-code (CVV) input. Null when unused."""
3123
3237
  cvvRegex: String
3124
- """Whether this method requires the security code (CVV)."""
3238
+ """
3239
+ Whether this method requires the security code (CVV). False when the order form carries no
3240
+ validator for the method: a method with no validator, such as Cash or Bank Invoice,
3241
+ legitimately resolves false, and this field cannot tell that from an upstream that omitted the flag.
3242
+ """
3125
3243
  cvvRequired: Boolean!
3126
- """Whether this method requires an expiration date."""
3244
+ """
3245
+ Whether this method requires an expiration date. False when the order form carries no
3246
+ validator for the method: a method with no validator, such as Cash, legitimately resolves false.
3247
+ """
3127
3248
  expirationRequired: Boolean!
3128
- """Whether this method requires the cardholder name."""
3249
+ """
3250
+ Whether this method requires the cardholder name. False when the order form carries no
3251
+ validator for the method: a method with no validator, such as Cash, legitimately resolves false.
3252
+ """
3129
3253
  holderNameRequired: Boolean!
3130
- """Whether this method requires a billing address."""
3254
+ """
3255
+ Whether this method requires a billing address. False when the order form carries no
3256
+ validator for the method: a method with no validator, such as Cash, legitimately resolves false.
3257
+ """
3131
3258
  billingAddressRequired: Boolean!
3132
3259
  """
3133
3260
  Whether a cardholder document field is displayable for this method. Distinct from documentRequired.
@@ -3142,19 +3269,29 @@ type PaymentMethodValidator {
3142
3269
  """
3143
3270
  One installment tier: a specific installment count at a given per-installment
3144
3271
  value and total. Keyed by count within its parent PaymentInstallmentOption — a
3145
- non-normalized value object (ADR-0012).
3272
+ non-normalized value object (ADR-0012). Field names match the catalog's
3273
+ `Installment`, so one selection reads either; nullability of `interestRate` and
3274
+ `interestFree` differs by design.
3146
3275
  """
3147
3276
  type PaymentInstallment {
3148
3277
  """Number of installments (1 = single payment, no interest)."""
3149
3278
  count: Int!
3150
3279
  """Amount per installment."""
3151
3280
  value: Money!
3152
- """Total amount across all installments, including any interest."""
3153
- total: Money!
3281
+ """
3282
+ The whole-plan amount: the total across all installments, including any interest.
3283
+ """
3284
+ totalAmount: Money!
3154
3285
  """
3155
3286
  Interest rate in hundredths of a percent, exactly as the VTEX order form carries it (100 = 1%; 0 = interest-free).
3287
+ Null when the order form did not say what the rate is — which is not the same as 0 (interest-free).
3156
3288
  """
3157
- interestRate: Float!
3289
+ interestRate: Float
3290
+ """
3291
+ Whether this tier is interest-free: true when the rate is 0, false for any other rate. Null exactly
3292
+ when `interestRate` is null. The synthesized `count: 1` tier is 0 and true, a stated fact.
3293
+ """
3294
+ interestFree: Boolean
3158
3295
  }
3159
3296
 
3160
3297
  """
@@ -3197,20 +3334,31 @@ type SavedCard @cacheControl(maxAge: 0, scope: PRIVATE) {
3197
3334
  The saved card's payment-system id (PaymentMethod.id), for cross-referencing validator config and installment options.
3198
3335
  """
3199
3336
  methodId: String!
3200
- """Card network / issuer display name (e.g. "Visa")."""
3337
+ """
3338
+ Card network / issuer display name (e.g. "Visa"). An empty string when the order form carries no
3339
+ network name for the card: nothing to show.
3340
+ """
3201
3341
  network: String!
3202
- """Last four digits of the card number."""
3342
+ """
3343
+ Last four digits of the card number. An empty string when the order form carries no card number
3344
+ for the account: nothing to show.
3345
+ """
3203
3346
  lastFourDigits: String!
3204
- """BIN of the saved card, for installment-option lookup by network."""
3347
+ """
3348
+ BIN of the saved card, for installment-option lookup by network. An empty string when the order
3349
+ form carries no BIN for the account: nothing to look up.
3350
+ """
3205
3351
  bin: String!
3206
3352
  """Shopper-assigned custom label, when set."""
3207
3353
  label: String
3208
3354
  """
3209
- Whether the card is expired. Expired cards are still returned; non-selectable is a UI concern downstream.
3355
+ Whether the card is expired. Expired cards are still returned. Fails closed: true when the
3356
+ order form does not report the expiry, so a card of unknown expiry is never offered as usable.
3210
3357
  """
3211
3358
  expired: Boolean!
3212
3359
  """
3213
- Whether completing payment with this card requires the shopper to enter the CVV.
3360
+ Whether completing payment with this card requires the shopper to enter the CVV. True is the
3361
+ default: it is what the field resolves to when the order form omits `useCvvForAuthorization`.
3214
3362
  """
3215
3363
  cvvRequired: Boolean!
3216
3364
  }
@@ -3227,7 +3375,9 @@ input PaymentMethodSelectInput {
3227
3375
  """The method to select (PaymentMethod.id)."""
3228
3376
  methodId: String!
3229
3377
  """
3230
- A newly-entered card's BIN, once detected. Omit for a saved card or a non-card method.
3378
+ A newly-entered card's BIN, once the full 8 digits are known: omit it, send null or "" until then.
3379
+ Anything else is rejected with INVALID_BIN_FORMAT. With an accountId, the saved card's own BIN (1 to 8
3380
+ digits) may be restated. Omit for a non-card method.
3231
3381
  """
3232
3382
  bin: String
3233
3383
  """
@@ -3238,7 +3388,7 @@ input PaymentMethodSelectInput {
3238
3388
 
3239
3389
  """Error codes for the paymentMethodSelect mutation."""
3240
3390
  enum PaymentMethodSelectErrorCode {
3241
- """No cart context was provided (x-order-form-id header/cookie)."""
3391
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
3242
3392
  MISSING_CART_CONTEXT
3243
3393
  """The cart was not found."""
3244
3394
  CART_NOT_FOUND
@@ -3249,7 +3399,8 @@ enum PaymentMethodSelectErrorCode {
3249
3399
  """The bin does not match the BIN of the saved card named by accountId."""
3250
3400
  MISMATCHED_BIN_FOR_SAVED_CARD
3251
3401
  """
3252
- The bin is not 1 to 8 numeric digits — a BIN identifies an issuer range, never a card number.
3402
+ The bin is not in an accepted format — a BIN identifies an issuer range, never a card number. A new
3403
+ card (no accountId) carries no bin or exactly 8 digits; with an accountId, a bin is 1 to 8 digits.
3253
3404
  """
3254
3405
  INVALID_BIN_FORMAT
3255
3406
  """
@@ -3290,7 +3441,7 @@ input PaymentInstallmentSelectInput {
3290
3441
 
3291
3442
  """Error codes for the paymentInstallmentSelect mutation."""
3292
3443
  enum PaymentInstallmentSelectErrorCode {
3293
- """No cart context was provided (x-order-form-id header/cookie)."""
3444
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
3294
3445
  MISSING_CART_CONTEXT
3295
3446
  """The cart was not found."""
3296
3447
  CART_NOT_FOUND
@@ -3321,7 +3472,7 @@ type PaymentInstallmentSelectPayload {
3321
3472
  """The updated payment state, or null if errors occurred."""
3322
3473
  payment: Payment
3323
3474
  """
3324
- The recomputed cart, or null if errors occurred. Carries the order total with any installment interest applied.
3475
+ The updated cart, or null if errors occurred. Its `total` is the greater of the order form's value and the selected payment's value, so it includes the selected tier's interest.
3325
3476
  """
3326
3477
  cart: Cart
3327
3478
  """
@@ -3372,7 +3523,7 @@ input PaymentBillingAddressUpdateInput {
3372
3523
 
3373
3524
  """Error codes for the paymentBillingAddressUpdate mutation."""
3374
3525
  enum PaymentBillingAddressUpdateErrorCode {
3375
- """No cart context was provided (x-order-form-id header/cookie)."""
3526
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
3376
3527
  MISSING_CART_CONTEXT
3377
3528
  """The cart was not found."""
3378
3529
  CART_NOT_FOUND
@@ -3413,7 +3564,7 @@ are never in this enum — per ADR-00007 they surface as top-level GraphQL
3413
3564
  errors (UNAUTHORIZED / UPSTREAM_ERROR), not userErrors.
3414
3565
  """
3415
3566
  enum PaymentStartTransactionErrorCode {
3416
- """No cart context was provided (x-order-form-id header/cookie)."""
3567
+ """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
3417
3568
  MISSING_CART_CONTEXT
3418
3569
  """The cart was not found."""
3419
3570
  CART_NOT_FOUND
@@ -3469,6 +3620,11 @@ type PaymentStartTransactionPayload {
3469
3620
  The order group, needed for the gateway call's orderId parameter and for gatewayCallback's input.
3470
3621
  """
3471
3622
  orderGroup: String
3623
+ """
3624
+ The Relay Node ID of the order for this order group, for Query.order(id:). Null if errors occurred
3625
+ or the transaction carried no order group.
3626
+ """
3627
+ orderNodeId: ID
3472
3628
  """The shopper's user profile id, needed for the gateway call."""
3473
3629
  userProfileId: String
3474
3630
  """
@@ -3523,6 +3679,14 @@ enum PaymentGatewayCallbackErrorCode {
3523
3679
  VTEX answered 428: the payment needs a challenge step. When `redirectUrl` is set the shopper must be sent there; when it is null the challenge uses a mechanism this API does not hand over (for example a payment app).
3524
3680
  """
3525
3681
  REDIRECT_REQUIRED
3682
+ """
3683
+ The payment gateway answered the callback and refused the payment: a 400, 402, 422 or 500 response whose body carries a VTEX `error` object (not a login-required code). The message is a fixed sentence; nothing the gateway said is forwarded. A response that is not shaped like a gateway answer (502-504, an unreadable body, a timeout) is a top-level `UPSTREAM_ERROR` instead.
3684
+ """
3685
+ PAYMENT_DECLINED
3686
+ """
3687
+ The order group sent is not the one this session's `paymentStartTransaction` returned, or this session started none. The message is a fixed sentence that does not say which, and nothing was sent to VTEX.
3688
+ """
3689
+ ORDER_GROUP_MISMATCH
3526
3690
  }
3527
3691
 
3528
3692
  """A domain error returned from the paymentGatewayCallback mutation."""
@@ -3540,6 +3704,10 @@ type PaymentGatewayCallbackPayload {
3540
3704
  """
3541
3705
  orderId: String
3542
3706
  """
3707
+ The Relay Node ID of the finalized order, for Query.order(id:). Null if errors occurred.
3708
+ """
3709
+ orderNodeId: ID
3710
+ """
3543
3711
  The bank's challenge page; set only when VTEX answered 428 with a usable http(s) URL.
3544
3712
  """
3545
3713
  redirectUrl: String
@@ -3857,6 +4025,14 @@ type PostalCodeAddress @cacheControl(maxAge: 0, scope: PRIVATE) {
3857
4025
  The authentication methods an account enables, read before rendering a sign-in form.
3858
4026
  """
3859
4027
  type SessionAuthProviders {
4028
+ """
4029
+ Stable identifier for this account's sign-in configuration, as
4030
+ base64("SessionAuthProviders:<account>"). It identifies the account's
4031
+ configuration, never a shopper: it is what lets a client cache normalize the
4032
+ type and read it outside a page's server-side fetch. Not a Relay Node: node(id)
4033
+ on this value resolves to null, because the configuration is read as a whole.
4034
+ """
4035
+ id: ID!
3860
4036
  """Whether classic email and password sign-in is enabled."""
3861
4037
  passwordAuthentication: Boolean!
3862
4038
  """Whether email access-code (passwordless) sign-in is enabled."""
@@ -4387,6 +4563,10 @@ type CustomerOrder implements Node @cacheControl(maxAge: 0, scope: PRIVATE) {
4387
4563
  """Timestamp when the order was invoiced."""
4388
4564
  invoiceDate: DateTime
4389
4565
  """
4566
+ Invoice files the merchant sent. Oldest issue date first. Empty when none qualify.
4567
+ """
4568
+ invoices: [CustomerOrderInvoice!]!
4569
+ """
4390
4570
  Order delivery channel. The order-level value when OMS supplies it, otherwise
4391
4571
  the channel every logistics entry agrees on. Null when those entries differ.
4392
4572
  """
@@ -4462,13 +4642,33 @@ type CustomerOrderItem {
4462
4642
  }
4463
4643
 
4464
4644
  """A custom value recorded on an order line."""
4465
- type CustomerOrderItemCustomField {
4645
+ type CustomerOrderItemCustomField @cacheControl(maxAge: 0, scope: PRIVATE) {
4466
4646
  """Custom field name."""
4467
4647
  name: String!
4468
4648
  """Custom field value as recorded on the order."""
4469
4649
  value: String!
4470
4650
  }
4471
4651
 
4652
+ """Sale or return, from the OMS package type."""
4653
+ enum CustomerOrderInvoiceKind {
4654
+ """An Output invoice, the sale document."""
4655
+ SALE
4656
+ """An Input invoice, the return document."""
4657
+ RETURN
4658
+ }
4659
+
4660
+ """One invoice file the merchant sent on the order."""
4661
+ type CustomerOrderInvoice {
4662
+ """Merchant file address. http or https."""
4663
+ url: String!
4664
+ """
4665
+ Package issuance date. Null when OMS omitted it or sent a value that is not a date.
4666
+ """
4667
+ issuedAt: DateTime
4668
+ """SALE for an Output invoice. RETURN for an Input invoice."""
4669
+ kind: CustomerOrderInvoiceKind!
4670
+ }
4671
+
4472
4672
  """Products that share one selected delivery option."""
4473
4673
  type CustomerOrderDeliveryOption {
4474
4674
  """Selected service-level agreement name."""
@@ -4483,10 +4683,14 @@ type CustomerOrderDeliveryOption {
4483
4683
  address: CustomerOrderAddress
4484
4684
  """Product lines assigned to this option."""
4485
4685
  items: [CustomerOrderItem!]!
4686
+ """
4687
+ Distinct http or https tracking addresses for invoices whose items fall in this option.
4688
+ """
4689
+ trackingLinks: [String!]!
4486
4690
  }
4487
4691
 
4488
4692
  """Historical delivery address recorded on an order."""
4489
- type CustomerOrderAddress {
4693
+ type CustomerOrderAddress @cacheControl(maxAge: 0, scope: PRIVATE) {
4490
4694
  """Recipient name."""
4491
4695
  receiverName: String
4492
4696
  """Postal code."""
@@ -4510,7 +4714,7 @@ type CustomerOrderAddress {
4510
4714
  }
4511
4715
 
4512
4716
  """One payment recorded on a placed order."""
4513
- type CustomerOrderPayment {
4717
+ type CustomerOrderPayment @cacheControl(maxAge: 0, scope: PRIVATE) {
4514
4718
  """Shopper-facing payment method name."""
4515
4719
  methodName: String
4516
4720
  """
@@ -4675,3 +4879,171 @@ type CustomerOrderCancelPayload {
4675
4879
  """Typed, expected failures. Empty on success."""
4676
4880
  userErrors: [CustomerOrderCancelError!]!
4677
4881
  }
4882
+
4883
+ """
4884
+ The signed-in shopper's saved cards, read from their persistent checkout
4885
+ profile. Never cart-scoped.
4886
+ """
4887
+ type CustomerSavedCards @cacheControl(maxAge: 0, scope: PRIVATE) {
4888
+ """
4889
+ Stable identity for cache normalization. Not a Relay Node ID: derived from the
4890
+ session, with no id argument and no Query.node entry.
4891
+ """
4892
+ id: ID!
4893
+ """
4894
+ Every card the shopper saved, in the platform's order, including expired and
4895
+ unusable ones. Empty when none is saved.
4896
+ """
4897
+ cards: [CustomerSavedCard!]!
4898
+ }
4899
+
4900
+ """
4901
+ One of the shopper's saved cards, as the account sees it. Distinct from the
4902
+ cart-scoped SavedCard. Never carries a card number beyond its last four digits,
4903
+ a BIN, or a security code.
4904
+ """
4905
+ type CustomerSavedCard @cacheControl(maxAge: 0, scope: PRIVATE) {
4906
+ """Opaque, stable cache key. Not a Relay Node ID."""
4907
+ id: ID!
4908
+ """The card network the card belongs to."""
4909
+ network: CardNetwork!
4910
+ """
4911
+ The card number's last four digits. Empty when the platform's record has none.
4912
+ """
4913
+ lastDigits: String!
4914
+ """When the card expires. Null when the platform's record has no date."""
4915
+ expiry: CardExpiry
4916
+ """
4917
+ Whether the card can still be used, derived once here so the UI never re-derives it.
4918
+ """
4919
+ status: CustomerSavedCardStatus!
4920
+ }
4921
+
4922
+ """A card network, such as Visa or Mastercard."""
4923
+ type CardNetwork {
4924
+ """
4925
+ The platform's payment-system id for the network. Empty when the record has none.
4926
+ """
4927
+ id: String!
4928
+ """
4929
+ Display name of the network (e.g. "Visa"). Falls back to the id when the record has no name.
4930
+ """
4931
+ name: String!
4932
+ }
4933
+
4934
+ """A card's expiry month and year."""
4935
+ type CardExpiry {
4936
+ """Expiry month, from 1 to 12."""
4937
+ month: Int!
4938
+ """Four-digit expiry year."""
4939
+ year: Int!
4940
+ }
4941
+
4942
+ """Whether a saved card can still be used."""
4943
+ enum CustomerSavedCardStatus {
4944
+ """The card has not expired and the platform reports nothing against it."""
4945
+ USABLE
4946
+ """
4947
+ The card's expiry date has passed. Wins over any other platform report.
4948
+ """
4949
+ EXPIRED
4950
+ """The card has not expired, but the platform reports it cannot be used."""
4951
+ UNUSABLE
4952
+ }
4953
+
4954
+ """
4955
+ A card network the store accepts on the request's sales channel, with the
4956
+ rules card entry validates a card by. Read from the store's payment systems,
4957
+ never from a cart.
4958
+ """
4959
+ type CardNetworkRule @cacheControl(maxAge: 0, scope: PRIVATE) {
4960
+ """
4961
+ The network. Its id is the platform's payment-system id, the same id a saved
4962
+ card's network carries.
4963
+ """
4964
+ network: CardNetwork!
4965
+ """
4966
+ Pattern a full card number of this network matches. Null when the store sets none.
4967
+ """
4968
+ numberRegex: String
4969
+ """
4970
+ Display mask for the card number, with 9 standing for a digit. Null when the store sets none.
4971
+ """
4972
+ numberMask: String
4973
+ """Pattern the security code matches. Null when the store sets none."""
4974
+ securityCodeRegex: String
4975
+ """Display mask for the security code. Null when the store sets none."""
4976
+ securityCodeMask: String
4977
+ """Whether the card asks for a security code."""
4978
+ securityCodeRequired: Boolean!
4979
+ """Whether the card asks for an expiry date."""
4980
+ expirationRequired: Boolean!
4981
+ """Whether the card asks for the holder's name."""
4982
+ holderNameRequired: Boolean!
4983
+ """Whether a cardholder document is required for this network."""
4984
+ requiresDocument: Boolean!
4985
+ """
4986
+ Whether a cardholder document field is shown for this network. Distinct from requiresDocument.
4987
+ """
4988
+ displayDocument: Boolean!
4989
+ }
4990
+
4991
+ """
4992
+ One of the signed-in shopper's saved addresses a new card can be billed to.
4993
+ """
4994
+ type CardBillingAddress @cacheControl(maxAge: 0, scope: PRIVATE) {
4995
+ """Opaque, stable cache key. Not a Relay Node ID."""
4996
+ id: ID!
4997
+ """
4998
+ Name of the person the address belongs to. Null when the platform's record has none.
4999
+ """
5000
+ receiverName: String
5001
+ """Street name. Null when the platform's record has none."""
5002
+ street: String
5003
+ """Street number. Null when the platform's record has none."""
5004
+ number: String
5005
+ """
5006
+ Complement, such as an apartment. Null when the platform's record has none.
5007
+ """
5008
+ complement: String
5009
+ """Neighborhood. Null when the platform's record has none."""
5010
+ neighborhood: String
5011
+ """City. Null when the platform's record has none."""
5012
+ city: String
5013
+ """State or province. Null when the platform's record has none."""
5014
+ state: String
5015
+ """Postal code. Null when the platform's record has none."""
5016
+ postalCode: String
5017
+ """
5018
+ Country of the address, as the platform stores it (ISO 3166-1 alpha-3).
5019
+ """
5020
+ country: String!
5021
+ }
5022
+
5023
+ """Payload returned by customerSavedCardRemove."""
5024
+ type CustomerSavedCardRemovePayload {
5025
+ """
5026
+ The shopper's saved cards after the removal. Null when userErrors is non-empty.
5027
+ """
5028
+ customerSavedCards: CustomerSavedCards
5029
+ """Domain errors that stopped the removal. Empty on success."""
5030
+ userErrors: [CustomerSavedCardRemoveError!]!
5031
+ }
5032
+
5033
+ """A domain error returned by customerSavedCardRemove."""
5034
+ type CustomerSavedCardRemoveError {
5035
+ """Machine-readable error code."""
5036
+ code: CustomerSavedCardRemoveErrorCode!
5037
+ """Human-readable error message."""
5038
+ message: String!
5039
+ }
5040
+
5041
+ """Why a saved card was not removed."""
5042
+ enum CustomerSavedCardRemoveErrorCode {
5043
+ """The id names no saved card of the signed-in shopper."""
5044
+ CARD_NOT_FOUND
5045
+ """
5046
+ The platform refused the removal, or the card is still listed after it.
5047
+ """
5048
+ REMOVAL_REFUSED
5049
+ }