Automate VTEX Orders

What VTEX Orders is

>Check the new [Orders onboarding guide](https://developers.vtex.com/docs/guides/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey. Receive, process, and manage every order in your store through our Order Management API.

API host: vtex.local

What HumDay can do in VTEX Orders

15 documented operations change something in VTEX Orders.

• POSTCreate or update hook configuration/api/orders/hook/config
• POSTOrder invoice notification/api/oms/pvt/orders/{orderId}/invoice
• POSTCommit feed items/api/orders/feed
• PATCHUpdate order's partial invoice (send tracking number)/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}
• POSTCreate or update feed configuration/api/orders/feed/config
• DELETEDelete hook configuration/api/orders/hook/config
• POSTSend payment notification/api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification
• DELETEDelete feed configuration/api/orders/feed/config
• POSTCancel order/api/oms/pvt/orders/{orderId}/cancel
• POSTTest JSONata expression/api/orders/expressions/jsonata
• POSTRegister change on order/api/oms/pvt/orders/{orderId}/changes
• POSTAdd log in orders/api/oms/pvt/orders/{orderId}/interactions
• POSTStart handling order/api/oms/pvt/orders/{orderId}/start-handling
• PUTUpdate order tracking status/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking
• POSTUpdate window to change seller/api/checkout/pvt/configuration/window-to-change-seller

What HumDay can read from VTEX Orders

These are the operations a schedule or a trigger can watch.

• GETRetrieve feed items/api/orders/feed
• GETRetrieve user order details/api/oms/user/orders/{orderId}
• GETList orders/api/oms/pvt/orders
• GETRetrieve user's orders/api/oms/user/orders
• GETGet hook configuration/api/orders/hook/config
• GETRetrieve order conversation/api/oms/pvt/orders/{orderId}/conversation-message
• GETGet order/api/oms/pvt/orders/{orderId}
• GETGet feed configuration/api/orders/feed/config
• GETRetrieve payment transaction/api/oms/pvt/orders/{orderId}/payment-transaction
• GETGet window to change seller/api/checkout/pvt/configuration/window-to-change-seller
• GETGet feed order status/api/oms/pvt/feed/orders/status
• GETExport order report with status 'Completed'/api/oms/pvt/admin/reports/completed
• GETExport order report with status 'In Progress'/api/oms/pvt/admin/reports/inprogress

How automating VTEX Orders works

1. Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
2. 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.
3. See it proven. The program runs and shows you the result before it is allowed near your live VTEX Orders account.
4. Grant access, then go live. You approve the specific VTEX Orders operations it may use — and only those.

Automate VTEX Orders with these

• VTEX Catalog162 operations
• VTEX Catalog Seller Portal16 operations
• VTEX Checkout32 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

Questions about VTEX Orders automation

Can HumDay connect to VTEX Orders?

Yes. HumDay reads VTEX Orders's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 28 operations are documented.

Do I need to write code to automate VTEX Orders?

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 Orders account.

What can HumDay do in VTEX Orders?

15 of the 28 documented operations change something in VTEX Orders, and 13 read from it. HumDay only ever uses the specific operations your approved contract needs.

Is my VTEX Orders 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 Orders is held behind that approval.

Where this came from

The operations above are read from a published API description for VTEX Orders at raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Orders API.json. Descriptions are the provider’s own words, not ours. Last published 2023-03-03.