VTEX
Commerce & fulfillmentCredentials form
Manage orders, invoices, tracking, catalog, inventory and customer profiles in a VTEX commerce account.
12 actions
| Action | Effect | Data handled | Scope |
|---|---|---|---|
| vtex_list_ordersLists orders, newest first, filtered by status, creation date range or a search text (order id, customer name, email or document) | read | Personal data | |
| vtex_get_orderReturns one order with items, totals, customer profile, shipping, payment transactions, invoices and status | read | Personal data | |
| vtex_start_handlingMoves an order from ready-for-handling to handling, signalling that fulfillment has started | write | Personal data | |
| vtex_cancel_orderCancels an order that has not been invoiced, with an optional reason | write | Personal data | |
| vtex_invoice_orderNotifies VTEX of an order's invoice, which moves it to invoiced and captures payment | write | Personal data | |
| vtex_update_trackingAdds or changes the tracking number, URL and carrier of an order's invoice | write | Personal data | |
| vtex_search_productsSearches the storefront catalog by text and returns products with their SKUs, prices and availability, up to 50 per call | read | General | |
| vtex_get_productReturns a catalog product by id: name, brand, category, description, link and active flags | read | General | |
| vtex_get_skuReturns a SKU by id: name, product, reference code, dimensions, weight and active flag | read | General | |
| vtex_get_inventoryReturns a SKU's stock per warehouse: total, reserved and whether it is unlimited | read | General | |
| vtex_update_inventorySets a SKU's stock quantity in one warehouse, or marks it unlimited | write | General | |
| vtex_search_customersSearches customer profiles (Master Data entity CL) with a where clause or keyword, returning the fields asked for | read | Personal data |