Automate VTEX Checkout
HumDay reads VTEX Checkout’s own published API description and derives 32 operations from it. Describe the outcome you want in plain words — you get a program that is written, proven on real data, and run for you.
What VTEX Checkout is
>ℹ️ Check the new [Checkout onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey. The Checkout API allows you to obtain and configure information about the
API host: vtex.local
What HumDay can do in VTEX Checkout
22 documented operations change something in VTEX Checkout.
- PUTPlace order
/api/checkout/pub/orders - POSTAdd cart items
/api/checkout/pub/orderForm/{orderFormId}/items - POSTAdd payment data
/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData - POSTProcess order
/api/checkout/pub/gatewayCallback/{orderGroup} - POSTAdd coupons to the cart
/api/checkout/pub/orderForm/{orderFormId}/coupons - POSTPlace order from an existing cart
/api/checkout/pub/orderForm/{orderFormId}/transaction - POSTCart simulation
/api/checkout/pub/orderForms/simulation - POSTUpdate orderForm configuration
/api/checkout/pvt/configuration/orderForm - POSTUpdate cart items
/api/checkout/pub/orderForm/{orderFormId}/items/update - POSTClear orderForm messages
/api/checkout/pub/orderForm/{orderFormId}/messages/clear - POSTRemove all items
/api/checkout/pub/orderForm/{orderFormId}/items/removeAll - POSTUpdate window to change seller
/api/checkout/pvt/configuration/window-to-change-seller - POSTAdd shipping address and select delivery option
/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData - POSTAdd marketing data
/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData - POSTAdd client profile
/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData - POSTAdd merchant context data
/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData - POSTAdd client preferences
/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData - PATCHIgnore profile data
/api/checkout/pub/orderForm/{orderFormId}/profile - PUTChange price
/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price - PUTSet multiple custom field values
/api/checkout/pub/orderForm/{orderFormId}/customData/{appId} - DELETERemove single custom field value
/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName} - PUTSet single custom field value
/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}
What HumDay can read from VTEX Checkout
These are the operations a schedule or a trigger can watch.
- GETGet current or create a new cart
/api/checkout/pub/orderForm - GETGet client profile by email
/api/checkout/pub/profiles - GETList pickup points by location
/api/checkout/pub/pickup-points - GETRemove all personal data
/checkout/changeToAnonymousUser/{orderFormId} - GETGet orderForm configuration
/api/checkout/pvt/configuration/orderForm - GETGet sellers by region or address
/api/checkout/pub/regions/{regionId} - GETGet window to change seller
/api/checkout/pvt/configuration/window-to-change-seller - GETGet cart information by ID
/api/checkout/pub/orderForm/{orderFormId} - GETCart installments
/api/checkout/pub/orderForm/{orderFormId}/installments - GETGet address by postal code
/api/checkout/pub/postal-code/{countryCode}/{postalCode}
How automating VTEX Checkout works
- Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
- Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
- See it proven. The program runs and shows you the result before it is allowed near your live VTEX Checkout account.
- Grant access, then go live. You approve the specific VTEX Checkout operations it may use — and only those.
Automate VTEX Checkout with these
- VTEX Catalog162 operations
- VTEX Catalog Seller Portal16 operations
- VTEX Customer Credit26 operations
- VTEX Do8 operations
- VTEX GiftCard11 operations
- VTEX GiftCard Hub15 operations
- VTEX Headless CMS3 operations
- VTEX Intelligent Search7 operations
- VTEX Legacy Search15 operations
- VTEX License Manager12 operations
- VTEX Logistics53 operations
- VTEX Marketplace23 operations
Questions about VTEX Checkout automation
- Can HumDay connect to VTEX Checkout?
- Yes. HumDay reads VTEX Checkout's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 32 operations are documented.
- Do I need to write code to automate VTEX Checkout?
- No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your VTEX Checkout account.
- What can HumDay do in VTEX Checkout?
- 22 of the 32 documented operations change something in VTEX Checkout, and 10 read from it. HumDay only ever uses the specific operations your approved contract needs.
- Is my VTEX Checkout account safe?
- Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to VTEX Checkout is held behind that approval.
Where this came from
The operations above are read from a published API description for VTEX Checkout at raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Checkout API.json. Descriptions are the provider’s own words, not ours. Last published 2023-03-03.