Documentation
Feedback
Guides

Checkout UI Custom Upload Prescription

The Checkout UI Custom app is responsible for customizing your store's Checkout UI through the admin's interface.

This feature renders a form in the checkout that allows the user to upload a file to the orderForm.

Captura de Pantalla 2021-09-14 a la(s) 11 44 16

Configuration

  1. Using your terminal and the VTEX IO CLI, log into the desired VTEX account.
  2. Run vtex install vtex install vtexarg.file-manager-rest on the account you're working on.
  3. Run vtex install vtex.checkout-ui-custom@0.5.3-hkignore.1 on the account you're working on.
  4. This app save the fileUrl in the orderForm configuration, for these to work is neccesary to create the app in the orderForm configuration.

Creating the app in the orderForm configuration

  1. First of all, you should get your current orderForm configuration.
  2. Through Postman, make a GET request to this endpoint https://{{account}}.myvtex.com/api/checkout/pvt/configuration/orderForm.

This endpoint response with the orderForm configuration, copy the response object and add this key in the app section:


_11
"apps": [
_11
_11
+ {
_11
+ "fields": [
_11
+ "data"
_11
+ ],
_11
+ "id": "uploadfiles",
_11
+ "major": 1
_11
+ },
_11
_11
]

  1. POST the new orderForm configuration with the new app.
  2. Through Postman, make a POST request to this endpoint https://{{account}}.myvtex.com/api/checkout/pvt/configuration/orderForm.
Captura de Pantalla 2021-09-14 a la(s) 12 39 35

It's important to make the GET request before the POST so as not to overwrite any pre-existing orderForm configuration.

Contributors
1
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
Was this helpful?
Suggest edits (GitHub)
On this page