Cancel order in VTEX Orders

What this operation does

Cancel order

• POSTChanges data · Ordersvtex.local/api/oms/pvt/orders/{orderId}/cancel

How HumDay uses it

1. You describe the outcome. Not this operation by name — what you want to happen. HumDay works out which operations it needs.
2. The contract names it. Before anything is built, you see exactly which VTEX Orders operations the program may use, and this is one of them.
3. You approve access. Because this one changes data, it cannot run until you have explicitly granted it.

Other VTEX Orders operations

• Create or update hook configurationPOST · changes data
• Order invoice notificationPOST · changes data
• Commit feed itemsPOST · changes data
• Update order's partial invoice (send tracking number)PATCH · changes data
• Create or update feed configurationPOST · changes data
• Delete hook configurationDELETE · changes data
• Send payment notificationPOST · changes data
• Delete feed configurationDELETE · changes data

All 28 VTEX Orders operations

Questions

Can HumDay cancel order in VTEX Orders?

Yes. This operation is published in VTEX Orders's own API description, so HumDay can use it without a hand-built connector — once you have approved it for your automation.

Will this change my VTEX Orders data?

Yes — this is a POST operation, so it changes something in VTEX Orders. HumDay holds anything that writes behind an approval you grant explicitly, and the contract you approve says what it may touch.

Do I need to write code?

No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a proof run before anything touches your VTEX Orders account.

Where this came from

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