Venddor - Marketplace

Getting Started

The v1.0 API provides full backward compatibility. If you have existing integrations with the legacy REST API, simply change the base URL to your Venddor store and everything works out of the box.

Authentication

All endpoints (except /auth_tokens) require HTTP Basic Auth. Use your admin email as username and your API key as password.

bash

curl -u admin@venddor.com.br:YOUR_API_KEY \
  "https://your-store.venddor.com.br/api/v1.0/products"

Token Authentication

Alternatively, obtain a token via POST /auth_tokens and use it in the Authorization header.

bash

# Get token
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@venddor.com.br","password":"***"}' \
  "https://your-store.venddor.com.br/api/v1.0/auth_tokens"

# Use token
curl -H "Authorization: Bearer TOKEN" \
  "https://your-store.venddor.com.br/api/v1.0/products"

Response Format

All responses are JSON. List endpoints return paginated results with a paramsobject. Monetary values are returned as decimal strings (e.g. "49.90"). IDs are returned as strings.

Status Codes

200Success

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Validation Error

500Server Error

⬢

Core

5 entities

AuthTokens

Authenticate via email/password or CNPJ/password to receive a session token. This is the only unauthenticated endpoint.

POST

/api/v1.0/auth_tokens

Request Body Fields

Field	Type	Required	Description
email	string	optional	User email address
password	string	required	User password
CNPJ	string	optional	Brazilian company ID (alternative to email)

Response Example

json

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "ttl": 86400
}

Products

Full product CRUD with legacy field compatibility. Prices as decimal strings, amounts as integers.

GET	/api/v1.0/products	List products with pagination and filters
GET	/api/v1.0/products/{id}	Get single product
POST	/api/v1.0/products	Create a new product
PUT	/api/v1.0/products/{id}	Update a product
DELETE	/api/v1.0/products/{id}	Delete a product
GET	/api/v1.0/products/{product_id}/discussions	List reviews for a product
GET	/api/v1.0/products/{product_id}/features	Get feature values for a product

Query Parameters

Name	Type	Description
page	integer	Page number (default: 1)
items_per_page	integer	Items per page (default: 10, max: 250)
company_id	integer	Filter by vendor/company ID
category_id	integer	Filter by category
status	string	Product status: A (active), D (disabled), H (hidden)
q	string	Search query (matches name, description, SKU)
product_code	string	Filter by exact SKU
sort_by	string	Sort field: product, price, amount, timestamp
sort_order	string	asc or desc

Request Body Fields

Field	Type	Required	Description
product	string	required	Product name
product_code	string	optional	SKU / product code
price	string	required	Price as decimal string, e.g. "49.90"
amount	integer	optional	Stock quantity
company_id	integer	optional	Vendor/company ID
category_ids	integer[]	optional	Array of category IDs
status	string	optional	A (active), D (disabled), H (hidden)
full_description	string	optional	Full HTML description
short_description	string	optional	Short plain-text description
main_pair	object	optional	Main image: {detailed: {image_path: "https://..."}}
weight	string	optional	Weight in kg as decimal string
list_price	string	optional	Compare-at / list price

Response Example

json

{
  "products": [
    {
      "product_id": "123",
      "product": "Cimento Portland CP-II 50kg",
      "product_code": "CIM-CP2-50",
      "price": "49.90",
      "list_price": "59.90",
      "amount": "150",
      "status": "A",
      "company_id": "5",
      "category_ids": [12, 34],
      "main_pair": {
        "detailed": {
          "image_path": "https://cdn.venddor.com.br/images/123.jpg"
        }
      },
      "timestamp": "1711929600"
    }
  ],
  "params": {
    "total_items": 342,
    "page": 1,
    "items_per_page": 10
  }
}

Orders

Order management with full lifecycle support. Status codes follow legacy conventions.

GET	/api/v1.0/orders	List orders with filters
GET	/api/v1.0/orders/{id}	Get full order details
POST	/api/v1.0/orders	Create a new order
PUT	/api/v1.0/orders/{id}	Update order / change status
DELETE	/api/v1.0/orders/{id}	Cancel/delete order

Query Parameters

Name	Type	Description
page	integer	Page number
items_per_page	integer	Items per page
status	string	Filter by status code
user_id	integer	Filter by customer
company_id	integer	Filter by vendor
period	string	Date range: today, this_month, last_month, custom
time_from	integer	Unix timestamp (for custom period)
time_to	integer	Unix timestamp (for custom period)

Request Body Fields

Field	Type	Required	Description
user_id	integer	required	Customer user ID
status	string	optional	P=Processed, O=Open, C=Complete, D=Declined, F=Failed, I=Cancelled, B=Backordered
products	object[]	optional	Array of {product_id, amount, price}
payment_id	integer	optional	Payment method ID
shipping_id	integer	optional	Shipping method ID
user_data	object	optional	Billing/shipping address fields

Response Example

json

{
  "orders": [
    {
      "order_id": "1042",
      "user_id": "87",
      "total": "249.80",
      "subtotal": "199.80",
      "shipping_cost": "50.00",
      "status": "P",
      "timestamp": "1711929600",
      "company_id": "5",
      "products": {
        "1": {
          "product_id": "123",
          "product": "Cimento Portland",
          "amount": "2",
          "price": "99.90"
        }
      }
    }
  ],
  "params": { "total_items": 156, "page": 1 }
}

Users

User management for customers, vendors, and admins. Supports Brazilian-specific fields (CPF/CNPJ).

GET	/api/v1.0/users	List users
GET	/api/v1.0/users/{id}	Get user details
POST	/api/v1.0/users	Create user
PUT	/api/v1.0/users/{id}	Update user
DELETE	/api/v1.0/users/{id}	Delete user
GET	/api/v1.0/users/{user_id}/usergroups	List user's usergroup memberships
PUT	/api/v1.0/users/{user_id}/usergroups/{group_id}	Update user's usergroup status

Query Parameters

Name	Type	Description
page	integer	Page number
items_per_page	integer	Items per page
user_type	string	A (admin), V (vendor), C (customer)
status	string	A (active), D (disabled)
company_id	integer	Filter by vendor company
q	string	Search by name or email

Request Body Fields

Field	Type	Required	Description
email	string	required	Email address
password	string	optional	Password (required on create)
user_type	string	optional	A, V, or C
status	string	optional	A (active) or D (disabled)
firstname	string	optional	First name
lastname	string	optional	Last name
phone	string	optional	Phone number
company_id	integer	optional	Vendor company ID
CNPJ	string	optional	Brazilian company ID (14 digits)

Response Example

json

{
  "users": [
    {
      "user_id": "87",
      "email": "joao@empresa.com.br",
      "user_type": "C",
      "status": "A",
      "firstname": "Joao",
      "lastname": "Silva",
      "phone": "+5511999887766",
      "company_id": "0"
    }
  ],
  "params": { "total_items": 1245, "page": 1 }
}

Field	Type	Required	Description
category	string	required	Category name
parent_id	integer	optional	Parent category ID (0 for root)
status	string	optional	A (active) or D (disabled)
position	integer	optional	Sort position

Catalog

4 entities

Features

Product features/attributes (color, size, brand, etc). Supports text, number, date, select, and checkbox types.

GET	/api/v1.0/features	List features
GET	/api/v1.0/features/{id}	Get feature
POST	/api/v1.0/features	Create feature
PUT	/api/v1.0/features/{id}	Update feature
DELETE	/api/v1.0/features/{id}	Delete feature

Request Body Fields

Field	Type	Required	Description
description	string	required	Feature name
feature_type	string	optional	S (select), T (text), N (number), D (date), C (checkbox), E (extended), B (brand), A (author)
categories_ids	integer[]	optional	Categories this feature applies to
group_id	integer	optional	Feature group ID

Options

Product options (size, color selectors, text inputs). Options drive variant combinations.

GET	/api/v1.0/options	List options
GET	/api/v1.0/options/{id}	Get option
POST	/api/v1.0/options	Create option
PUT	/api/v1.0/options/{id}	Update option
DELETE	/api/v1.0/options/{id}	Delete option

Request Body Fields

Field	Type	Required	Description
option_name	string	required	Option name
option_type	string	optional	S (selectbox), R (radio), C (checkbox), I (input), T (textarea), F (file)
product_id	integer	optional	Product this option belongs to
variants	object[]	optional	Array of {variant_name, modifier, modifier_type}

Combinations

Option combinations (variants) with their own price, SKU, stock, weight, and image.

GET	/api/v1.0/combinations	List combinations
GET	/api/v1.0/combinations/{hash}	Get combination by hash
POST	/api/v1.0/combinations	Create combination
PUT	/api/v1.0/combinations/{hash}	Update combination
DELETE	/api/v1.0/combinations/{hash}	Delete combination

Request Body Fields

Field	Type	Required	Description
product_id	integer	required	Product ID
combination	object	optional	Map of option_id -> variant_id
amount	integer	optional	Stock for this combination
price	string	optional	Price modifier
product_code	string	optional	SKU for this combination

Exceptions

Option combination exceptions (forbidden or allowed combinations).

GET	/api/v1.0/exceptions	List exceptions
GET	/api/v1.0/exceptions/{id}	Get exception
POST	/api/v1.0/exceptions	Create exception
DELETE	/api/v1.0/exceptions/{id}	Delete exception

Request Body Fields

Field	Type	Required	Description
product_id	integer	required	Product ID
combination	object	optional	Map of option_id -> variant_id
type	string	optional	F (forbidden) or A (allowed)

○

Commerce

5 entities

Payments

Payment method configuration and management.

GET	/api/v1.0/payments	List payment methods
GET	/api/v1.0/payments/{id}	Get payment method
POST	/api/v1.0/payments	Create payment method
PUT	/api/v1.0/payments/{id}	Update payment method
DELETE	/api/v1.0/payments/{id}	Delete payment method

Request Body Fields

Field	Type	Required	Description
payment	string	required	Payment method name
processor_type	string	optional	Payment processor type (e.g. pix, braspag, pagarme, offline)
processor_params	object	optional	Gateway configuration parameters (API keys, merchant IDs, etc.)
position	integer	optional	Sort position
company_id	string	optional	Vendor ID (for vendor-specific payment methods)
description	string	optional	Description shown to customers
status	string	optional	A (active) or D (disabled)

Shippings

Shipping method configuration and management.

GET	/api/v1.0/shippings	List shipping methods
GET	/api/v1.0/shippings/{id}	Get shipping method
POST	/api/v1.0/shippings	Create shipping method
PUT	/api/v1.0/shippings/{id}	Update shipping method
DELETE	/api/v1.0/shippings/{id}	Delete shipping method

Shipments

Shipment tracking for orders (tracking numbers, carrier info).

GET	/api/v1.0/shipments	List shipments
GET	/api/v1.0/shipments/{id}	Get shipment
POST	/api/v1.0/shipments	Create shipment
PUT	/api/v1.0/shipments/{id}	Update shipment
DELETE	/api/v1.0/shipments/{id}	Delete shipment

Request Body Fields

Field	Type	Required	Description
order_id	string	required	Order ID
shipping_id	string	required	Shipping method ID
tracking_number	string	optional	Carrier tracking number
carrier	string	optional	Carrier name (e.g. Correios, Jadlog)
comments	string	optional	Internal shipment comments
products	array	optional	Array of {item_id: string, amount: integer} objects

Statuses

Order status definitions and configuration.

GET	/api/v1.0/statuses	List statuses
GET	/api/v1.0/statuses/{id}	Get status
POST	/api/v1.0/statuses	Create status
PUT	/api/v1.0/statuses/{id}	Update status
DELETE	/api/v1.0/statuses/{id}	Delete status

Taxes

Tax rule management (ICMS, ISS, IPI for Brazilian market).

GET	/api/v1.0/taxes	List taxes
GET	/api/v1.0/taxes/{id}	Get tax
POST	/api/v1.0/taxes	Create tax
PUT	/api/v1.0/taxes/{id}	Update tax
DELETE	/api/v1.0/taxes/{id}	Delete tax

☰

Content

6 entities

Pages

CMS pages (about, terms, blog posts, etc).

GET	/api/v1.0/pages	List pages
GET	/api/v1.0/pages/{id}	Get page
POST	/api/v1.0/pages	Create page
PUT	/api/v1.0/pages/{id}	Update page
DELETE	/api/v1.0/pages/{id}	Delete page

Request Body Fields

Field	Type	Required	Description
page	string	required	Page title
page_type	string	optional	T (text), L (link), F (form), B (blog)
description	string	optional	Page HTML content
status	string	optional	A (active) or D (disabled)

Blocks

Layout blocks for storefront page composition.

GET	/api/v1.0/blocks	List blocks
GET	/api/v1.0/blocks/{id}	Get block
POST	/api/v1.0/blocks	Create block
PUT	/api/v1.0/blocks/{id}	Update block
DELETE	/api/v1.0/blocks/{id}	Delete block

Languages

Installed language packs (read-only in compat API).

GET	/api/v1.0/languages	List languages
GET	/api/v1.0/languages/{id}	Get language

Settings

Store settings configuration.

GET	/api/v1.0/settings	List settings
GET	/api/v1.0/settings/{id}	Get setting
PUT	/api/v1.0/settings/{id}	Update setting

Promotions

Promotion rules and discount campaigns.

GET	/api/v1.0/promotions	List promotions
GET	/api/v1.0/promotions/{id}	Get promotion
POST	/api/v1.0/promotions	Create promotion
PUT	/api/v1.0/promotions/{id}	Update promotion
DELETE	/api/v1.0/promotions/{id}	Delete promotion

PromotionBanners

Banners linked to active promotions (read-only).

GET	/api/v1.0/promotion_banners	List promotion banners
GET	/api/v1.0/promotion_banners/{id}	Get promotion banner

⊞

Marketplace

4 entities

Stores / Vendors

Vendor/company management. Both /stores and /vendors paths are supported as aliases.

Alias: /api/v1.0/vendors/* maps to the same handlers.

GET	/api/v1.0/stores	List stores/vendors
GET	/api/v1.0/stores/{id}	Get store/vendor
POST	/api/v1.0/stores	Create store/vendor
PUT	/api/v1.0/stores/{id}	Update store/vendor
DELETE	/api/v1.0/stores/{id}	Delete store/vendor

Usergroups

Usergroup definitions and privilege management.

GET	/api/v1.0/usergroups	List usergroups
GET	/api/v1.0/usergroups/{id}	Get usergroup
POST	/api/v1.0/usergroups	Create usergroup
PUT	/api/v1.0/usergroups/{id}	Update usergroup
DELETE	/api/v1.0/usergroups/{id}	Delete usergroup

Destinations

Shipping rate area / destination zone definitions (read-only).

GET	/api/v1.0/destinations	List destinations
GET	/api/v1.0/destinations/{id}	Get destination

Discussions

Product reviews / discussion threads.

GET	/api/v1.0/discussions	List discussions
GET	/api/v1.0/discussions/{id}	Get discussion
POST	/api/v1.0/discussions	Create discussion/review
DELETE	/api/v1.0/discussions/{id}	Delete discussion

⚑

Brazilian

7 entities

ExtraOrderFields

Fiscal note data from ERPs (NF-e number, series, key). Used by Charrua and ERP integrations.

PUT

/api/v1.0/extra_order_fields/{order_id}

Request Body Fields

Field	Type	Required	Description
link_nota	string	optional	URL link to the fiscal note
codigo_pedido_erp	string	optional	ERP order code
chave_nota	string	optional	44-digit NF-e access key
xml_nota	string	optional	NF-e XML content
pdf_nota	string	optional	URL to NF-e PDF
nota_fiscal	string	optional	Fiscal note number
base64_xml	string	optional	Base64-encoded NF-e XML

DeliveryMethods

Shipping quote by product + zipcode. Used by storefront for real-time delivery estimates.

GET

/api/v1.0/delivery_methods

Query Parameters

Name	Type	Description
product_id	integer	Product to quote shipping for
zipcode	string	Destination CEP (Brazilian postal code)
amount	integer	Quantity

CreditScore

ClearSale CNPJ credit check for B2B customers.

POST

/api/v1.0/credit_score

Request Body Fields

Field	Type	Required	Description
CNPJ	string	required	Brazilian company ID (14 digits)

SellersAvailability

Vendor location lookup for geo-based delivery availability.

GET

/api/v1.0/sellers_availability

Query Parameters

Name	Type	Description
zipcode	string	Destination CEP
product_id	integer	Product ID

OrderLimit

B2B credit limit management per user per vendor.

PUT

/api/v1.0/order_limit

Request Body Fields

Field	Type	Required	Description
user_id	integer	required	Customer user ID
company_id	integer	required	Vendor ID
limit_amount	string	optional	Credit limit as decimal, e.g. "10000.00"

Subscribers

Newsletter subscriber management.

GET	/api/v1.0/subscribers	List subscribers
GET	/api/v1.0/subscribers/{id}	Get subscriber
POST	/api/v1.0/subscribers	Create subscriber
DELETE	/api/v1.0/subscribers/{id}	Delete subscriber

CallRequests

Callback request management (customer requests a phone call).

GET	/api/v1.0/call_requests	List call requests
GET	/api/v1.0/call_requests/{id}	Get call request
POST	/api/v1.0/call_requests	Create call request
DELETE	/api/v1.0/call_requests/{id}	Delete call request

☷

B2B

5 entities

BusinessPartners

B2B partner/company profiles for wholesale operations.

GET	/api/v1.0/business_partners	List business partners
GET	/api/v1.0/business_partners/{id}	Get business partner
POST	/api/v1.0/business_partners	Create business partner
PUT	/api/v1.0/business_partners/{id}	Update business partner

Managers

Field sales managers / representatives.

GET	/api/v1.0/managers	List managers
GET	/api/v1.0/managers/{id}	Get manager
POST	/api/v1.0/managers	Create manager
PUT	/api/v1.0/managers/{id}	Update manager
DELETE	/api/v1.0/managers/{id}	Delete manager

PaymentCodes

B2B payment condition codes (payment terms, installment plans).

GET	/api/v1.0/payment_codes	List payment codes
POST	/api/v1.0/payment_codes	Create payment code

MixProducts

Mixed product bundles for B2B orders.

GET	/api/v1.0/mix_products	List mix products
POST	/api/v1.0/mix_products	Create mix product

ManagerTransactions

Sales transaction records for field managers.

GET	/api/v1.0/manager_transactions	List manager transactions
POST	/api/v1.0/manager_transactions	Create manager transaction

▷

Vendor App

18 entities

VendorLogin

Vendor mobile app authentication and password reset.

POST	/api/v1.0/vendor_login	Vendor app login
PUT	/api/v1.0/vendor_login	Vendor password reset

VendorSignup

New vendor registration from mobile app.

POST

/api/v1.0/vendor_signup

VendorStart

App initialization data (config, permissions, menus).

GET

/api/v1.0/vendor_start

VendorDashboard

Vendor dashboard summary (sales, orders, revenue).

GET

/api/v1.0/vendor_dashboard

VendorCompany

Vendor company profile management.

GET	/api/v1.0/vendor_company	Get vendor company info
PUT	/api/v1.0/vendor_company	Update vendor company info

VendorProfile

Vendor user profile management.

GET	/api/v1.0/vendor_profile	Get vendor profile
PUT	/api/v1.0/vendor_profile	Update vendor profile

VendorCategories

Categories available to the vendor.

GET

/api/v1.0/vendor_categories

VendorProducts

Vendor product listing and bulk delete.

GET	/api/v1.0/vendor_products	List vendor products
POST	/api/v1.0/vendor_products	Bulk delete products

VendorProduct

Single product CRUD from vendor mobile app.

GET	/api/v1.0/vendor_product/{id}	Get vendor product
POST	/api/v1.0/vendor_product	Create product
PUT	/api/v1.0/vendor_product/{id}	Update product

VendorProductOptions

Product options for vendor app product editor.

GET

/api/v1.0/vendor_product_options

VendorProductAttachments

Product file attachments (datasheets, manuals).

GET

/api/v1.0/vendor_product_attachments

VendorRequiredProducts

Required/accessory product associations.

GET

/api/v1.0/vendor_required_products

VendorOrders

Vendor order listing.

GET

/api/v1.0/vendor_orders

VendorOrder

Single order detail and status update from vendor app.

GET	/api/v1.0/vendor_order/{id}	Get order details
PUT	/api/v1.0/vendor_order/{id}	Update order status

VendorNotifications

Push notification history for vendor.

GET

/api/v1.0/vendor_notifications

VendorChats

Customer-vendor chat/messaging.

GET	/api/v1.0/vendor_chats	List chat threads
POST	/api/v1.0/vendor_chats	Send chat message

VendorAuctions

Auction/bidding system for vendor products.

GET	/api/v1.0/vendor_auctions	List auctions
POST	/api/v1.0/vendor_auctions	Create/update auction

VendorUpload

File/image upload from vendor mobile app.

POST

/api/v1.0/vendor_upload

⇄

Integrations

12 entities

MagentoOrders

Magento connector - order synchronization.

GET	/api/v1.0/magento_orders	List Magento orders
GET	/api/v1.0/magento_orders/{id}	Get Magento order
PUT	/api/v1.0/magento_orders/{id}	Update Magento order

MagentoProducts

Magento connector - product synchronization.

GET	/api/v1.0/magento_products	List Magento products
GET	/api/v1.0/magento_products/{id}	Get Magento product
PUT	/api/v1.0/magento_products/{id}	Update Magento product

MagentoStores

Magento connector - store synchronization.

GET	/api/v1.0/magento_stores	List Magento stores
GET	/api/v1.0/magento_stores/{id}	Get Magento store
PUT	/api/v1.0/magento_stores/{id}	Update Magento store

Missions

Field mission tracking (Magento connector).

GET	/api/v1.0/missions	List missions
PUT	/api/v1.0/missions/{id}	Update mission

MissionSurveys

Survey data collected during field missions.

GET	/api/v1.0/mission_surveys	List surveys
PUT	/api/v1.0/mission_surveys/{id}	Update survey

POSLogin

Point-of-sale terminal authentication.

GET

/api/v1.0/pos_login

POSCheckout

Point-of-sale order placement.

POST

/api/v1.0/pos_checkout

POSCustomers

Customer lookup from POS terminal.

GET

/api/v1.0/pos_customers

POSProducts

Product catalog for POS terminal.

GET

/api/v1.0/pos_products

SyncObjects

POS offline sync data (products, customers, orders).

GET

/api/v1.0/sync_objects

Routes

Delivery route management for field sales.

GET	/api/v1.0/routes/{manager_id}	List routes for manager
POST	/api/v1.0/routes	Create route
PUT	/api/v1.0/routes/{id}	Update route
DELETE	/api/v1.0/routes/{id}	Delete route

Checkins

Field check-in records for delivery route tracking.

GET	/api/v1.0/checkins/{manager_id}	List check-ins for manager
POST	/api/v1.0/checkins	Create check-in

…

Other

8 entities

Carts

Admin access to user carts (view and clear).

GET	/api/v1.0/carts/{user_id}	Get user cart
DELETE	/api/v1.0/carts/{user_id}	Clear user cart

Wishlists

User wishlist management.

GET	/api/v1.0/wishlists	List wishlist items
POST	/api/v1.0/wishlists	Add to wishlist
DELETE	/api/v1.0/wishlists	Remove from wishlist

Notifications

Marketing notification list (read-only).

GET

/api/v1.0/notifications

MakeAnOffer

Price negotiation system (customer proposes a price).

GET	/api/v1.0/make_an_offer	List offers
POST	/api/v1.0/make_an_offer	Create offer
PUT	/api/v1.0/make_an_offer/{id}	Update offer
DELETE	/api/v1.0/make_an_offer/{id}	Delete offer

ProductBoxes

Kit/bundle product definitions.

GET	/api/v1.0/product_boxes	List product boxes
GET	/api/v1.0/product_boxes/{id}	Get product box
POST	/api/v1.0/product_boxes	Create product box
PUT	/api/v1.0/product_boxes/{id}	Update product box
DELETE	/api/v1.0/product_boxes/{id}	Delete product box
GET	/api/v1.0/product_boxes_variants	List box variants
GET	/api/v1.0/product_boxes_descriptions	List box descriptions

Charrua

Charrua ERP integration (field sales data sync).

GET

/api/v1.0/charrua

InternalUsergroups

Internal usergroup override per company (ignore email matching).

PUT

/api/v1.0/internal_usergroups/{company_id}

EC API Changes

Extended API entities (customers, user profiles, product variations, order extensions).

POST	/api/v1.0/customers	Bulk update customers
GET	/api/v1.0/user_profiles	List user profiles
POST	/api/v1.0/user_profiles	Create user profile
PUT	/api/v1.0/user_profiles/{id}	Update user profile
POST	/api/v1.0/product_variations	Create product variations
PUT	/api/v1.0/orders_ext/{id}	Update extended order data

Need the modern API? View API v1 (REST) Reference →

212 endpoints across 74 entities

GET	/api/v1.0/categories	List categories
GET	/api/v1.0/categories/{id}	Get category
POST	/api/v1.0/categories	Create category
PUT	/api/v1.0/categories/{id}	Update category
DELETE	/api/v1.0/categories/{id}	Delete category
GET	/api/v1.0/categories/{id}/products	List products in category

Venddor API v1.0 Documentation

Getting Started

Authentication

Token Authentication

Response Format

Status Codes

Core

AuthTokens

Request Body Fields

Response Example

Products

Query Parameters

Request Body Fields

Response Example

Orders

Query Parameters

Request Body Fields

Response Example

Users

Query Parameters

Request Body Fields

Response Example

Categories

Request Body Fields

Response Example

Catalog

Features

Request Body Fields

Options

Request Body Fields

Combinations

Request Body Fields

Exceptions

Request Body Fields

Commerce

Payments

Request Body Fields

Shippings

Shipments

Request Body Fields

Statuses

Taxes

Content

Pages

Request Body Fields

Blocks

Languages

Settings

Promotions

PromotionBanners

Marketplace

Stores / Vendors

Usergroups

Destinations

Discussions

Brazilian

ExtraOrderFields

Request Body Fields

DeliveryMethods

Query Parameters

CreditScore

Request Body Fields

SellersAvailability

Query Parameters

OrderLimit

Request Body Fields

Subscribers

CallRequests

B2B

BusinessPartners

Managers

PaymentCodes

MixProducts

ManagerTransactions

Vendor App

VendorLogin

VendorSignup

VendorStart

VendorDashboard

VendorCompany