An API request is a regular HTTP request sent to a particular URL. The Venddor API follows RESTful principles with resources organized in a hierarchical structure.
https://www.venddor.com.br/api
The Venddor API supports multiple URL formats, with API 2.0 being the recommended version for all new integrations.
https://www.venddor.com.br/api/:object — refer to all objects of a certain typehttps://www.venddor.com.br/api/:object/:id — refer to a single objecthttps://www.venddor.com.br/api/:object/:id/:nested_object — refer to all nested objects of a certain objecthttps://www.venddor.com.br/api/:object/:id/:nested_object/:id — refer to a single nested object of a certain objectExample: https://www.venddor.com.br/api/product/1/features refers to all the features of the product with ID 1.
https://www.venddor.com.br/api.php?_d=:object&ajax_custom=1 — refer to all objects of a certain typehttps://www.venddor.com.br/api.php?_d=:object/:id&ajax_custom=1 — refer to a single objecthttps://www.venddor.com.br/api.php?_d=:object/:id/:nested_object&ajax_custom=1 — refer to all nested objects of a certain objecthttps://www.venddor.com.br/api.php?_d=:object/:id/:nested_object/:id&ajax_custom=1 — refer to a single nested object of a certain objectUse this format if mod_rewrite is disabled on the server where the target store is installed.
https://www.venddor.com.br/api/2/:object — refer to all objects of a certain typehttps://www.venddor.com.br/api/2/:object/:id — refer to a single objecthttps://www.venddor.com.br/api/2/:object/:id/:nested_object — refer to all nested objects of a certain objecthttps://www.venddor.com.br/api/2/:object/:id/:nested_object/:id — refer to a single nested object of a certain objectThis version offers enhanced performance and stability for all API operations.
| Variable | Description |
|---|---|
:object |
The type of resource you're interacting with (e.g., products, categories, users) |
:id |
The unique identifier for a specific resource |
:nested_object |
A related resource type that belongs to the parent object |
# Get all products https://www.venddor.com.br/api/2/products # Get a specific product with ID 42 https://www.venddor.com.br/api/2/products/42 # Get all features of product with ID 42 https://www.venddor.com.br/api/2/products/42/features # Get a specific feature with ID 7 for product with ID 42 https://www.venddor.com.br/api/2/products/42/features/7