Getting Started
The bare /api/* surface is the CS-Cart-compatible REST layer. If you have existing integrations with a 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.
curl -u admin@venddor.com.br:YOUR_API_KEY \
"https://your-store.venddor.com.br/api/products"Token Authentication
Alternatively, obtain a token via POST /auth_tokens and use it in the Authorization header.
# Get token
curl -X POST \
-H "Content-Type: application/json" \
-d '{"email":"admin@venddor.com.br","password":"***"}' \
"https://your-store.venddor.com.br/api/auth_tokens"
# Use token
curl -H "Authorization: Bearer TOKEN" \
"https://your-store.venddor.com.br/api/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.
HTTP Status Codes
Status Field Convention CHAR(1)
Every status field across the API is stored and emitted as a single uppercase letter. Standardized 2026-05-21. Each domain uses a subset of the alphabet — see the per-endpoint enum for the exact allowed letters.
Backwards compatibility: request bodies and query parameters also accept the long-form labels ("active", "disabled", "pending", "hidden", etc.) and normalize them to the canonical letter at the service-layer boundary. Output is always the canonical letter — never the long-form label. New integrations should send the letter directly.
# Both of these are accepted on the same endpoint:
curl -X PUT -u admin@venddor.com.br:KEY \
-H "Content-Type: application/json" \
-d '{"status":"A"}' \
"https://your-store.venddor.com.br/api/products/123"
curl -X PUT -u admin@venddor.com.br:KEY \
-H "Content-Type: application/json" \
-d '{"status":"active"}' \
"https://your-store.venddor.com.br/api/products/123"
# But the response always returns:
# { "status": "A", ... }Core
5 entitiesAuthTokens
Authenticate via email/password or CNPJ/password to receive a session token. This is the only unauthenticated endpoint.
| POST | /api/auth_tokens | Login and receive auth token |
Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
| string | optional | User email address | |
| password | string | required | User password |
| CNPJ | string | optional | Brazilian company ID (alternative to email) |
Response Example
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"ttl": 86400
}Products
Full product CRUD with legacy field compatibility. Prices as decimal strings, amounts as integers.
| GET | /api/products | List products with pagination and filters |
| GET | /api/products/{id} | Get single product |
| POST | /api/products | Create a new product |
| PUT | /api/products/{id} | Update a product |
| DELETE | /api/products/{id} | Delete a product |
| GET | /api/products/{product_id}/discussions | List reviews for a product |
| GET | /api/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
{
"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/orders | List orders with filters |
| GET | /api/orders/{id} | Get full order details |
| POST | /api/orders | Create a new order |
| PUT | /api/orders/{id} | Update order / change status |
| DELETE | /api/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
{
"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/users | List users |
| GET | /api/users/{id} | Get user details |
| POST | /api/users | Create user |
| PUT | /api/users/{id} | Update user |
| DELETE | /api/users/{id} | Delete user |
| GET | /api/users/{user_id}/usergroups | List user's usergroup memberships |
| PUT | /api/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 |
|---|---|---|---|
| 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
{
"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 }
}Categories
Product category hierarchy with full CRUD. Nested categories supported via parent_id.
| GET | /api/categories | List categories |
| GET | /api/categories/{id} | Get category |
| POST | /api/categories | Create category |
| PUT | /api/categories/{id} | Update category |
| DELETE | /api/categories/{id} | Delete category |
| GET | /api/categories/{id}/products | List products in category |
Request Body Fields
| 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 |
Response Example
{
"categories": [
{
"category_id": "12",
"category": "Materiais de Construcao",
"parent_id": "0",
"status": "A",
"position": "10",
"product_count": "87"
}
]
}Catalog
4 entitiesFeatures
Product features/attributes (color, size, brand, etc). Supports text, number, date, select, and checkbox types.
| GET | /api/features | List features |
| GET | /api/features/{id} | Get feature |
| POST | /api/features | Create feature |
| PUT | /api/features/{id} | Update feature |
| DELETE | /api/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/options | List options |
| GET | /api/options/{id} | Get option |
| POST | /api/options | Create option |
| PUT | /api/options/{id} | Update option |
| DELETE | /api/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/combinations | List combinations |
| GET | /api/combinations/{hash} | Get combination by hash |
| POST | /api/combinations | Create combination |
| PUT | /api/combinations/{hash} | Update combination |
| DELETE | /api/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/exceptions | List exceptions |
| GET | /api/exceptions/{id} | Get exception |
| POST | /api/exceptions | Create exception |
| DELETE | /api/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 entitiesPayments
Payment method configuration and management.
| GET | /api/payments | List payment methods |
| GET | /api/payments/{id} | Get payment method |
| POST | /api/payments | Create payment method |
| PUT | /api/payments/{id} | Update payment method |
| DELETE | /api/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/shippings | List shipping methods |
| GET | /api/shippings/{id} | Get shipping method |
| POST | /api/shippings | Create shipping method |
| PUT | /api/shippings/{id} | Update shipping method |
| DELETE | /api/shippings/{id} | Delete shipping method |
Shipments
Shipment tracking for orders (tracking numbers, carrier info).
| GET | /api/shipments | List shipments |
| GET | /api/shipments/{id} | Get shipment |
| POST | /api/shipments | Create shipment |
| PUT | /api/shipments/{id} | Update shipment |
| DELETE | /api/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/statuses | List statuses |
| GET | /api/statuses/{id} | Get status |
| POST | /api/statuses | Create status |
| PUT | /api/statuses/{id} | Update status |
| DELETE | /api/statuses/{id} | Delete status |
Taxes
Tax rule management (ICMS, ISS, IPI for Brazilian market).
| GET | /api/taxes | List taxes |
| GET | /api/taxes/{id} | Get tax |
| POST | /api/taxes | Create tax |
| PUT | /api/taxes/{id} | Update tax |
| DELETE | /api/taxes/{id} | Delete tax |
Content
6 entitiesPages
CMS pages (about, terms, blog posts, etc).
| GET | /api/pages | List pages |
| GET | /api/pages/{id} | Get page |
| POST | /api/pages | Create page |
| PUT | /api/pages/{id} | Update page |
| DELETE | /api/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/blocks | List blocks |
| GET | /api/blocks/{id} | Get block |
| POST | /api/blocks | Create block |
| PUT | /api/blocks/{id} | Update block |
| DELETE | /api/blocks/{id} | Delete block |
Languages
Installed language packs (read-only in compat API).
| GET | /api/languages | List languages |
| GET | /api/languages/{id} | Get language |
Settings
Store settings configuration.
| GET | /api/settings | List settings |
| GET | /api/settings/{id} | Get setting |
| PUT | /api/settings/{id} | Update setting |
Promotions
Promotion rules and discount campaigns.
| GET | /api/promotions | List promotions |
| GET | /api/promotions/{id} | Get promotion |
| POST | /api/promotions | Create promotion |
| PUT | /api/promotions/{id} | Update promotion |
| DELETE | /api/promotions/{id} | Delete promotion |
Marketplace
4 entitiesStores / Vendors
Vendor/company management. Both /stores and /vendors paths are supported as aliases.
Alias: /api/vendors/* maps to the same handlers.
| GET | /api/stores | List stores/vendors |
| GET | /api/stores/{id} | Get store/vendor |
| POST | /api/stores | Create store/vendor |
| PUT | /api/stores/{id} | Update store/vendor |
| DELETE | /api/stores/{id} | Delete store/vendor |
Usergroups
Usergroup definitions and privilege management.
| GET | /api/usergroups | List usergroups |
| GET | /api/usergroups/{id} | Get usergroup |
| POST | /api/usergroups | Create usergroup |
| PUT | /api/usergroups/{id} | Update usergroup |
| DELETE | /api/usergroups/{id} | Delete usergroup |
Destinations
Shipping rate area / destination zone definitions (read-only).
| GET | /api/destinations | List destinations |
| GET | /api/destinations/{id} | Get destination |
Discussions
Product reviews / discussion threads.
| GET | /api/discussions | List discussions |
| GET | /api/discussions/{id} | Get discussion |
| POST | /api/discussions | Create discussion/review |
| DELETE | /api/discussions/{id} | Delete discussion |
Brazilian
7 entitiesExtraOrderFields
Fiscal note data from ERPs (NF-e number, series, key). Used by Charrua and ERP integrations.
| PUT | /api/extra_order_fields/{order_id} | Update extra fields on an order |
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/delivery_methods | Get shipping quotes |
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/credit_score | Request credit score for CNPJ |
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/sellers_availability | Check vendor availability by location |
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/order_limit | Update 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/subscribers | List subscribers |
| GET | /api/subscribers/{id} | Get subscriber |
| POST | /api/subscribers | Create subscriber |
| DELETE | /api/subscribers/{id} | Delete subscriber |
CallRequests
Callback request management (customer requests a phone call).
| GET | /api/call_requests | List call requests |
| GET | /api/call_requests/{id} | Get call request |
| POST | /api/call_requests | Create call request |
| DELETE | /api/call_requests/{id} | Delete call request |
B2B
5 entitiesBusinessPartners
B2B partner/company profiles for wholesale operations.
| GET | /api/business_partners | List business partners |
| GET | /api/business_partners/{id} | Get business partner |
| POST | /api/business_partners | Create business partner |
| PUT | /api/business_partners/{id} | Update business partner |
Managers
Field sales managers / representatives.
| GET | /api/managers | List managers |
| GET | /api/managers/{id} | Get manager |
| POST | /api/managers | Create manager |
| PUT | /api/managers/{id} | Update manager |
| DELETE | /api/managers/{id} | Delete manager |
PaymentCodes
B2B payment condition codes (payment terms, installment plans).
| GET | /api/payment_codes | List payment codes |
| POST | /api/payment_codes | Create payment code |
MixProducts
Mixed product bundles for B2B orders.
| GET | /api/mix_products | List mix products |
| POST | /api/mix_products | Create mix product |
ManagerTransactions
Sales transaction records for field managers.
| GET | /api/manager_transactions | List manager transactions |
| POST | /api/manager_transactions | Create manager transaction |
Vendor App
18 entitiesVendorLogin
Vendor mobile app authentication and password reset.
| POST | /api/vendor_login | Vendor app login |
| PUT | /api/vendor_login | Vendor password reset |
VendorSignup
New vendor registration from mobile app.
| POST | /api/vendor_signup | Register new vendor |
VendorStart
App initialization data (config, permissions, menus).
| GET | /api/vendor_start | Get app init data |
VendorDashboard
Vendor dashboard summary (sales, orders, revenue).
| GET | /api/vendor_dashboard | Get dashboard data |
VendorCompany
Vendor company profile management.
| GET | /api/vendor_company | Get vendor company info |
| PUT | /api/vendor_company | Update vendor company info |
VendorProfile
Vendor user profile management.
| GET | /api/vendor_profile | Get vendor profile |
| PUT | /api/vendor_profile | Update vendor profile |
VendorCategories
Categories available to the vendor.
| GET | /api/vendor_categories | List vendor categories |
VendorProducts
Vendor product listing and bulk delete.
| GET | /api/vendor_products | List vendor products |
| POST | /api/vendor_products | Bulk delete products |
VendorProduct
Single product CRUD from vendor mobile app.
| GET | /api/vendor_product/{id} | Get vendor product |
| POST | /api/vendor_product | Create product |
| PUT | /api/vendor_product/{id} | Update product |
VendorProductOptions
Product options for vendor app product editor.
| GET | /api/vendor_product_options | List product options |
VendorProductAttachments
Product file attachments (datasheets, manuals).
| GET | /api/vendor_product_attachments | List product attachments |
VendorRequiredProducts
Required/accessory product associations.
| GET | /api/vendor_required_products | List required products |
VendorOrders
Vendor order listing.
| GET | /api/vendor_orders | List vendor orders |
VendorOrder
Single order detail and status update from vendor app.
| GET | /api/vendor_order/{id} | Get order details |
| PUT | /api/vendor_order/{id} | Update order status |
VendorNotifications
Push notification history for vendor.
| GET | /api/vendor_notifications | List vendor notifications |
VendorChats
Customer-vendor chat/messaging.
| GET | /api/vendor_chats | List chat threads |
| POST | /api/vendor_chats | Send chat message |
VendorAuctions
Auction/bidding system for vendor products.
| GET | /api/vendor_auctions | List auctions |
| POST | /api/vendor_auctions | Create/update auction |
VendorUpload
File/image upload from vendor mobile app.
| POST | /api/vendor_upload | Upload file/image |
Integrations
12 entitiesMagentoOrders
Magento connector - order synchronization.
| GET | /api/magento_orders | List Magento orders |
| GET | /api/magento_orders/{id} | Get Magento order |
| PUT | /api/magento_orders/{id} | Update Magento order |
MagentoProducts
Magento connector - product synchronization.
| GET | /api/magento_products | List Magento products |
| GET | /api/magento_products/{id} | Get Magento product |
| PUT | /api/magento_products/{id} | Update Magento product |
MagentoStores
Magento connector - store synchronization.
| GET | /api/magento_stores | List Magento stores |
| GET | /api/magento_stores/{id} | Get Magento store |
| PUT | /api/magento_stores/{id} | Update Magento store |
Missions
Field mission tracking (Magento connector).
| GET | /api/missions | List missions |
| PUT | /api/missions/{id} | Update mission |
MissionSurveys
Survey data collected during field missions.
| GET | /api/mission_surveys | List surveys |
| PUT | /api/mission_surveys/{id} | Update survey |
POSLogin
Point-of-sale terminal authentication.
| GET | /api/pos_login | POS login |
POSCheckout
Point-of-sale order placement.
| POST | /api/pos_checkout | POS checkout |
POSCustomers
Customer lookup from POS terminal.
| GET | /api/pos_customers | List POS customers |
POSProducts
Product catalog for POS terminal.
| GET | /api/pos_products | List POS products |
SyncObjects
POS offline sync data (products, customers, orders).
| GET | /api/sync_objects | Get sync data |
Routes
Delivery route management for field sales.
| GET | /api/routes/{manager_id} | List routes for manager |
| POST | /api/routes | Create route |
| PUT | /api/routes/{id} | Update route |
| DELETE | /api/routes/{id} | Delete route |
Checkins
Field check-in records for delivery route tracking.
| GET | /api/checkins/{manager_id} | List check-ins for manager |
| POST | /api/checkins | Create check-in |
Other
8 entitiesCarts
Admin access to user carts (view and clear).
| GET | /api/carts/{user_id} | Get user cart |
| DELETE | /api/carts/{user_id} | Clear user cart |
Wishlists
User wishlist management.
| GET | /api/wishlists | List wishlist items |
| POST | /api/wishlists | Add to wishlist |
| DELETE | /api/wishlists | Remove from wishlist |
Notifications
Marketing notification list (read-only).
| GET | /api/notifications | List notifications |
MakeAnOffer
Price negotiation system (customer proposes a price).
| GET | /api/make_an_offer | List offers |
| POST | /api/make_an_offer | Create offer |
| PUT | /api/make_an_offer/{id} | Update offer |
| DELETE | /api/make_an_offer/{id} | Delete offer |
ProductBoxes
Kit/bundle product definitions.
| GET | /api/product_boxes | List product boxes |
| GET | /api/product_boxes/{id} | Get product box |
| POST | /api/product_boxes | Create product box |
| PUT | /api/product_boxes/{id} | Update product box |
| DELETE | /api/product_boxes/{id} | Delete product box |
| GET | /api/product_boxes_variants | List box variants |
| GET | /api/product_boxes_descriptions | List box descriptions |
Charrua
Charrua ERP integration (field sales data sync).
| GET | /api/charrua | List Charrua records |
InternalUsergroups
Internal usergroup override per company (ignore email matching).
| PUT | /api/internal_usergroups/{company_id} | Update internal usergroup |
EC API Changes
Extended API entities (customers, user profiles, product variations, order extensions).
| POST | /api/customers | Bulk update customers |
| GET | /api/user_profiles | List user profiles |
| POST | /api/user_profiles | Create user profile |
| PUT | /api/user_profiles/{id} | Update user profile |
| POST | /api/product_variations | Create product variations |
| PUT | /api/orders_ext/{id} | Update extended order data |
Need the modern API? View API v1 (REST) Reference →
212 endpoints across 74 entities