Create the destination
In Dashboard → Webhooks, enter an HTTPS URL and select events. The secret is shown once.
Supplier documentation
Feed your app and retrieve orders through the API.
Connect your ERP, e-commerce platform, POS or business software to SellViaApp. Send categories, products and prices, then retrieve confirmed shop orders as JSON.
Base URL
https://api.sellviaapp.com/Required headers
Developer supportapi@sellviaapp.com
X-API-Key + BearerQuick start
Authenticate, choose a route, test.
Get the X-API-Key and generate the Bearer in Dashboard → API. Enter them below, then use “Test · Generate” on an endpoint to obtain the response and cURL, PHP 8 or JavaScript code.
Credentials incompleteEnter the X-API-Key and Bearer token to prepare a test.
Credentials remain in memory for this page only. For a customer-related operation, add customer_id.
Keep in mindHTTPS + JSON · keep both credentials server-side · never send tokens to support.
Real time
Connect SellViaApp to any HTTPS-capable system.
A webhook alerts your ERP, CRM, automation or software whenever a product, customer, cart, order, document or important setting changes. Use the API to retrieve the full authoritative object when needed.
Verify the signature
Compute HMAC-SHA256 over timestamp.delivery_id.raw_body and compare it with X-SellViaApp-Signature.
Acknowledge quickly
Return HTTP 2xx, deduplicate with X-SellViaApp-Event-Id, then process in the background.
Reliable deliveryUp to eight attempts with progressive delays. A repeatedly failing destination is paused automatically, and every delivery remains visible and retryable in the Dashboard.
payload = timestamp + "." + delivery_id + "." + raw_body
expected = "v1=" + HMAC_SHA256(payload, signing_secret)Endpoints
Customers
Create and manage customer accounts for each shop.
5 routes ⌄
Endpoints
Customers
Create and manage customer accounts for each shop.
/customer/add
API key
Create a customer and generate the supplier login.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
nom
string
Required
Customer last name.
prenom
string
Required
Customer first name.
email
email
Required
Email unique within the supplier.
denomination
string
Optional
Company name, optional.
password
string
Required
At least eight characters.
address
string
Optional
Postal address.
zipcode
string
Optional
Postal code.
city
string
Optional
City.
country
string
Optional
Country.
phone
string
Optional
Phone number.
cellphone
string
Optional
Mobile phone number.
vat_number
string
Optional
VAT number.
language
string
Optional
Two-letter ISO language code.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/customer/list
Key + Bearer
List or filter authorised customer information.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/customer/me
Key + Bearer
Retrieve the signed-in customer profile.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/customer/update
Key + Bearer
Update profile, language, type, email or password.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
first_name
string
Optional
First name.
last_name
string
Optional
Last name.
company
string
Optional
Company name.
email
email
Optional
New email address, unique within the shop.
address
string
Optional
Postal address.
zipcode
string
Optional
Postal code.
city
string
Optional
City.
country
string
Optional
Country.
phone
string
Optional
Phone number.
cellphone
string
Optional
Mobile phone number.
vat_number
string
Optional
VAT number.
language
string
Optional
Two-letter ISO language code.
account_type
enum
Optional
company | individual
notifications_enabled
boolean
Optional
Allow mobile notifications.
password
string
Optional
New password, at least eight characters.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/customer/deleteaccount
Key + Bearer
Deactivate the customer account in the active shop.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Endpoints
Catalogue
Categories, products, images, prices, stock, promotions and favourites.
18 routes ⌄
Endpoints
Catalogue
Categories, products, images, prices, stock, promotions and favourites.
/fam1/list
Key + Bearer
List primary categories.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam1/add
Key + Bearer
Create a primary category.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
name
string
Required
Visible category name.
external_key
string
Optional
Stable identifier from your software.
sort_order
integer
Optional
Display order, starting at 1.
image_url
url
Optional
HTTPS image URL.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam1/update
Key + Bearer
Update a primary category.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Identifier of the category to update.
name
string
Required
Visible category name.
external_key
string
Optional
Stable identifier from your software.
sort_order
integer
Optional
Display order, starting at 1.
image_url
url
Optional
HTTPS image URL.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam1/delete
Key + Bearer
Hide a primary category.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Identifier of the category to hide.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam2/list
Key + Bearer
List subcategories.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
category_id
integer
Optional
Limit results to one primary category.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam2/add
Key + Bearer
Create a subcategory.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
category_id
integer
Required
Parent primary category identifier.
name
string
Required
Visible category name.
external_key
string
Optional
Stable identifier from your software.
sort_order
integer
Optional
Display order, starting at 1.
image_url
url
Optional
HTTPS image URL.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam2/update
Key + Bearer
Update a subcategory.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Identifier of the subcategory to update.
name
string
Required
Visible category name.
external_key
string
Optional
Stable identifier from your software.
sort_order
integer
Optional
Display order, starting at 1.
image_url
url
Optional
HTTPS image URL.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/fam2/delete
Key + Bearer
Hide a subcategory.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Identifier of the subcategory to hide.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/product/list
Key + Bearer
List and search products with pagination.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
search
string
Optional
Search by code, name or description.
category_id
integer
Optional
Primary category filter.
subcategory_id
integer
Optional
Subcategory filter.
price_group
string
Optional
Customer price group.
favorites
boolean
Optional
Return favourites only.
promotions
boolean
Optional
Return active promotions only.
new
boolean
Optional
Return new products only.
progressive
boolean
Optional
Fast pagination without calculating the total count.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/product/image
Signed URL
Serve a signed, cacheable product image.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
supplier
string
Required
Public shop suffix.
id
integer
Required
Product identifier.
slot
integer
Optional
Image slot from 1 to 5.
signature
string
Required
Signed-link signature returned by product/list.
variant
enum
Optional
small | thumb | large
Output
Possible results
200Binary image with its MIME type
400Invalid request or JSON
401Missing or invalid authentication
403Invalid signed link
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
200 The body directly contains the binary image and the Content-Type header indicates its format.
Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/product/add
Key + Bearer
Create a product.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
code
string
Required
Product code unique within the shop.
name
string
Required
Name displayed in the app.
description
string
Optional
Detailed product description.
base_price
decimal
Optional
Selling price excluding tax according to your configuration.
vat_rate
decimal
Optional
VAT rate, for example 21.
category_id
integer
Optional
Primary category identifier.
subcategory_id
integer
Optional
Subcategory identifier.
external_key
string
Optional
Stable identifier from your ERP.
unit
string
Optional
Unit code, for example pc.
unit_name
string
Optional
Human-readable unit name.
image_url
url
Optional
HTTPS URL of the main image.
is_new
boolean
Optional
Highlight the product as new.
active
boolean
Optional
Controls product visibility.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/product/update
Key + Bearer
Update a product.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Identifier of the product to update.
code
string
Required
Product code unique within the shop.
name
string
Required
Name displayed in the app.
description
string
Optional
Detailed product description.
base_price
decimal
Optional
Selling price excluding tax according to your configuration.
vat_rate
decimal
Optional
VAT rate, for example 21.
category_id
integer
Optional
Primary category identifier.
subcategory_id
integer
Optional
Subcategory identifier.
external_key
string
Optional
Stable identifier from your ERP.
unit
string
Optional
Unit code, for example pc.
unit_name
string
Optional
Human-readable unit name.
image_url
url
Optional
HTTPS URL of the main image.
is_new
boolean
Optional
Highlight the product as new.
active
boolean
Optional
Controls product visibility.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/product/delete
Key + Bearer
Hide a product.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Identifier of the product to hide.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/product/favoris
Key + Bearer
Add or remove a product from favourites.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
product_id
integer
Required
Product identifier.
favorite
boolean
Optional
true to add, false to remove; toggles the state when omitted.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/price/list
Key + Bearer
List prices applicable to the customer group, falling back to the product sales price.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
product_id
integer
Optional
Limit results to one product.
price_group
string
Optional
Price group, defaults to 01.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/mark/list
Key + Bearer
List available brands.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/size/list
Key + Bearer
List available sizes.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/libweb/list
Key + Bearer
List web reference labels, falling back to catalogue labels.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Endpoints
Cart and orders
Manage the cart and confirm an order atomically.
10 routes ⌄
Endpoints
Cart and orders
Manage the cart and confirm an order atomically.
/order/list
Key + Bearer
List every confirmed shop order with pagination.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
guid
string
Optional
Filter a confirmed order by GUID.
from_date
date
Optional
Filter from this date using YYYY-MM-DD.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/order/delete
Key + Bearer
Clear and delete the current cart.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/order/total
Key + Bearer
Calculate cart subtotal, VAT and total.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/order/shipping/quote
Key + Bearer
Calculate shipping fees from the cart, fulfilment mode and country.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
delivery_mode
enum
Required
pickup | delivery
delivery_country
string
Optional
Two-letter ISO code or delivery-country name.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Shipping fee calculated",
"data": {
"delivery_mode": "delivery",
"country_code": "BE",
"shipping_mode": "country_rules",
"shipping_fee": 6.9,
"free_shipping": false,
"free_shipping_from": 75,
"amount_until_free": 25,
"product_total": 50,
"total": 56.9,
"rule": "country:BE",
"currency": "EUR",
"currency_symbol": "€"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/order/count/line
Key + Bearer
Count lines in the cart.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/order/sendtomegawin
Key + Bearer
Confirm the order, fulfilment mode and address.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
order_guid
uuid
Optional
GUID of the cart to confirm.
delivery_mode
enum
Required
pickup | delivery
delivery_address
string
Optional
Required for delivery.
delivery_country
string
Optional
Two-letter ISO code or country name used to calculate the rate.
delivery_date
date
Optional
YYYY-MM-DD
delivery_comment
string
Optional
Fulfilment instructions.
language
string
Optional
Transactional email language.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/orderline/add
Key + Bearer
Add a product and quantity to the cart.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
product_id
integer
Required
Identifier of the product to add.
quantity
decimal
Required
Quantity strictly greater than zero.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/orderline/list
Key + Bearer
Retrieve current cart lines.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/orderline/update
Key + Bearer
Update a line quantity.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
item_id
integer
Required
Cart line identifier.
quantity
decimal
Required
Quantity; zero removes the line.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/orderline/delete
Key + Bearer
Remove a line from the cart.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
item_id
integer
Required
Identifier of the line to remove.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Endpoints
Customer payments
Choose pay on delivery or open a secure Stripe payment, then retrieve its server-verified status.
4 routes ⌄
Endpoints
Customer payments
Choose pay on delivery or open a secure Stripe payment, then retrieve its server-verified status.
/payment/config
Key + Bearer
Retrieve the enabled Stripe payment methods and the Stripe account provider selected for the app.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/payment/checkout/create
Key + Bearer
Create or resume a Stripe Checkout page for an unpaid order or booking owned by the signed-in customer. A still-changeable pay-on-delivery choice is safely replaced.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
purpose_type
enum
Required
order | booking
purpose_id
integer
Required
Identifier of the confirmed order or customer-confirmed booking.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/payment/pay-later
Key + Bearer
Record pay on delivery or replace a still-open Stripe payment after its session is securely checked and expired.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
purpose_type
enum
Required
order | booking
purpose_id
integer
Required
Authorised order or booking identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/payment/status
Key + Bearer
Retrieve a payment status; only the signed Stripe webhook can confirm it as paid.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
reference
string
Optional
SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.
purpose_type
enum
Optional
order | booking
purpose_id
integer
Optional
Paid object identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Endpoints
Documents
Invoices, estimates, orders and their lines.
8 routes ⌄
Endpoints
Documents
Invoices, estimates, orders and their lines.
/document/add
Key + Bearer
Create a document linked to the customer.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
doc_type
string
Optional
invoice | estimate | purchase_order
doc_number
string
Optional
Document number; generated automatically when omitted on creation.
doc_date
date
Optional
YYYY-MM-DD
due_date
date
Optional
YYYY-MM-DD
payment_method
string
Optional
Payment method.
remark
string
Optional
Free-form remark.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/document/list
Key + Bearer
List or filter documents.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
doc_type
string
Optional
Filter by document type.
guid
uuid
Optional
Filter by document GUID.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/document/update
Key + Bearer
Update a document identified by GUID.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
document_guid
uuid
Required
GUID of the document to update.
doc_type
string
Optional
invoice | estimate | purchase_order
doc_number
string
Optional
Document number; generated automatically when omitted on creation.
doc_date
date
Optional
YYYY-MM-DD
due_date
date
Optional
YYYY-MM-DD
payment_method
string
Optional
Payment method.
remark
string
Optional
Free-form remark.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/document/delete
Key + Bearer
Delete a document and its lines.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
document_guid
uuid
Required
GUID of the document to delete.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/documentline/add
Key + Bearer
Add a line and recalculate the document.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
document_guid
uuid
Required
Document GUID.
text
string
Optional
Line description.
quantity
decimal
Optional
Quantity, default 1.
unit_price
decimal
Optional
Unit price excluding VAT.
vat_rate
decimal
Optional
VAT rate, default 21.
discount_percentage
decimal
Optional
Percentage discount.
product_code
string
Optional
Associated product code.
product_id
integer
Optional
Associated product identifier.
packages
decimal
Optional
Number of packages.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/documentline/list
Key + Bearer
Retrieve a document with all its lines.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
guid
uuid
Required
GUID of the document whose lines must be retrieved.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/documentline/update
Key + Bearer
Update a line identified by GUID.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
document_guid
uuid
Required
Document GUID.
line_guid
uuid
Required
GUID of the line to update.
text
string
Optional
Line description.
quantity
decimal
Optional
Quantity, default 1.
unit_price
decimal
Optional
Unit price excluding VAT.
vat_rate
decimal
Optional
VAT rate, default 21.
discount_percentage
decimal
Optional
Percentage discount.
product_code
string
Optional
Associated product code.
product_id
integer
Optional
Associated product identifier.
packages
decimal
Optional
Number of packages.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/documentline/delete
Key + Bearer
Delete a line and recalculate totals.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
document_guid
uuid
Required
Document GUID.
line_guid
uuid
Required
GUID of the line to delete.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Endpoints
Real-time webhooks
Automatically receive SellViaApp changes in your ERP, CRM, automation or business service.
10 routes ⌄
Endpoints
Real-time webhooks
Automatically receive SellViaApp changes in your ERP, CRM, automation or business service.
/webhooks/events
Key + Bearer
List all available events and the contract version.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/endpoints/list
Key + Bearer
List destinations, status and counters.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/endpoints/create
Key + Bearer
Create an HTTPS destination and receive its signing secret once.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
label
string
Required
Internal name for this destination.
target_url
url
Required
Public HTTPS URL on port 443. Private networks and redirects are rejected.
events
array
Required
Exact events, a group such as product.*, or all with *.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/endpoints/update
Key + Bearer
Update the destination, events or pause delivery.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Destination identifier.
label
string
Optional
New label.
target_url
url
Optional
New HTTPS URL.
events
array
Optional
New event selection.
status
enum
Optional
active | paused
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/endpoints/delete
Key + Bearer
Soft-delete a destination.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Destination identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/endpoints/rotate-secret
Key + Bearer
Replace the HMAC secret and reveal it once.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Destination identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/deliveries/list
Key + Bearer
Inspect deliveries, responses, errors and attempts.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
status
enum
Optional
pending | processing | retry | delivered | failed
endpoint_id
integer
Optional
Limit results to one destination.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/deliveries/retry
Key + Bearer
Retry one delivery without replaying the others.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Internal delivery identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/test
Key + Bearer
Emit and deliver a signed test event.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
endpoint_id
integer
Required
Destination to test.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/webhooks/stats
Key + Bearer
Retrieve the last thirty days of delivery metrics.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Endpoints
Notifications and integrations
Mobile notifications and external synchronisation.
47 routes ⌄
Endpoints
Notifications and integrations
Mobile notifications and external synchronisation.
/admin/notification/sendtomobile
Key + Bearer
Retrieve mobile notifications.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/admin/notification/setdelivery
Key + Bearer
Mark a notification as delivered.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
customer_id
integer
Optional
Required only with an integration token when the operation targets a specific customer.
guid
string
Required
Notification GUID token.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/categories/sync
Key + Bearer
Batch-sync WooCommerce categories and subcategories.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 500 categories. Each object uses external_id, name and, for a subcategory, parent_external_id.
items[].external_id
string
Required
Stable WooCommerce identifier.
items[].name
string
Required
Visible name.
items[].parent_external_id
string
Optional
Parent category identifier.
items[].sort_order
integer
Optional
Display order.
items[].images
array
Optional
Up to five HTTPS URLs.
items[].active
boolean
Optional
false archives the category.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/products/sync
Key + Bearer
Sync products, variations, images, prices, VAT, stock and visibility.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 250 products or variations per batch.
items[].external_id
string
Required
Stable WooCommerce identifier used for deduplication.
items[].type
enum
Optional
simple | variable | variation
items[].parent_external_id
string
Optional
Parent product for a variation.
items[].sku
string
Optional
SKU; a fallback code is generated when omitted.
items[].name
string
Required
Product name.
items[].description
string
Optional
Product description.
items[].regular_price
decimal
Optional
Regular price.
items[].sale_price
decimal
Optional
Sale price.
items[].date_on_sale_from
date
Optional
ISO 8601 sale start.
items[].date_on_sale_to
date
Optional
ISO 8601 sale end.
items[].vat_rate
decimal
Optional
VAT rate.
items[].stock_quantity
integer
Optional
Available stock.
items[].category_external_id
string
Optional
Synchronised primary category.
items[].subcategory_external_id
string
Optional
Synchronised subcategory.
items[].images
array
Optional
Up to five HTTPS images.
items[].attributes
array
Optional
WooCommerce variation attributes.
items[].active
boolean
Optional
Visibility in SellViaApp.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/customers/sync
Key + Bearer
Create or update WooCommerce customer accounts without sending email.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 250 customer accounts per batch. No email is sent.
items[].external_id
string
Required
Stable WooCommerce user identifier.
items[].username
string
Required
WooCommerce username preserved exactly in client.login.
items[].email
email
Optional
Customer email address used for deduplication.
items[].first_name
string
Optional
Customer first name.
items[].last_name
string
Optional
Customer last name.
items[].company
string
Optional
Company or business name.
items[].phone
string
Optional
Phone number.
items[].vat_number
string
Optional
VAT number.
items[].language
iso-639-1
Optional
Two-letter language; English by default.
items[].billing
object
Optional
Full WooCommerce billing address.
items[].shipping
object
Optional
Shipping address retained in synchronisation metadata.
items[].active
boolean
Optional
Account active state.
items[].send_email
boolean
Optional
Must remain false. This route never sends email.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/products/inventory
Key + Bearer
Quickly update prices, promotions, stock or visibility only.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 500 lightweight updates.
items[].external_id
string
Required
Previously synchronised product.
items[].stock_quantity
integer
Optional
New quantity.
items[].regular_price
decimal
Optional
New regular price.
items[].sale_price
decimal
Optional
New sale price.
items[].active
boolean
Optional
New visibility.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/products/archive
Key + Bearer
Batch-archive deleted WooCommerce products without changing orders.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
entity_type
enum
Optional
product | category | subcategory
items
array
Required
List of up to 500 external identifiers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/orders/feed
Key + Bearer
Retrieve confirmed orders with cursor-based reconciliation.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
cursor
string
Optional
Opaque cursor returned by the previous response.
updated_since
datetime
Optional
ISO 8601 starting date.
limit
integer
Optional
1 to 100 orders.
unacknowledged_only
boolean
Optional
Defaults to true to prevent duplicates.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/orders/acknowledge
Key + Bearer
Confirm that an order was imported into WooCommerce.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Orders processed by WooCommerce.
items[].order_guid
string
Required
SellViaApp GUID returned by the feed.
items[].external_order_id
string
Optional
WooCommerce order identifier.
items[].status
enum
Required
imported | failed | ignored
items[].error
string
Optional
Explanation when import failed.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/webhooks/subscribe
Key + Bearer
Register a signed HTTPS WooCommerce webhook.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
target_url
url
Required
Public HTTPS URL; private networks are rejected.
events
array
Optional
order.created | order.updated | order.cancelled | *
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/webhooks/list
Key + Bearer
List active WooCommerce webhooks.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/webhooks/delete
Key + Bearer
Disable a WooCommerce webhook.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Webhook identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/webhooks/process
Key + Bearer
Process pending webhook deliveries with automatic retries.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
limit
integer
Optional
Maximum deliveries to process.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/woocommerce/sync/logs
Key + Bearer
View the technical synchronisation log.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/categories/sync
Key + Bearer
Sync Shopify collections and product types.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 500 collections or product types.
items[].external_id
string
Required
Stable Shopify GID.
items[].name
string
Required
Visible name.
items[].parent_external_id
string
Optional
Parent collection for a product type.
items[].images
array
Optional
HTTPS URLs.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/categories/archive
Key + Bearer
Archive a deleted Shopify collection.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
GIDs of deleted collections.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/products/sync
Key + Bearer
Sync Shopify products, variants, images, prices, inventory and visibility.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 250 Shopify variants per batch.
items[].external_id
string
Required
Variant GID.
items[].parent_external_id
string
Optional
Parent product GID.
items[].sku
string
Optional
SKU
items[].name
string
Required
Product and variant title.
items[].regular_price
decimal
Optional
Regular or compare-at price.
items[].sale_price
decimal
Optional
Active sale price.
items[].stock_quantity
integer
Optional
Available quantity.
items[].images
array
Optional
Up to five HTTPS images.
items[].active
boolean
Optional
SellViaApp visibility.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/products/inventory
Key + Bearer
Quickly update Shopify prices, inventory or visibility.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 500 lightweight updates.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/products/archive
Key + Bearer
Archive Shopify variants by identifier.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Variant GIDs to archive.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/products/archive-parent
Key + Bearer
Archive every variant of a deleted Shopify product.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 100 parent product GIDs.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/customers/sync
Key + Bearer
Sync Shopify customers without sending email.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 250 customers; no email is sent.
items[].external_id
string
Required
Shopify customer GID.
items[].username
string
Required
Username used in SellViaApp.
items[].email
email
Optional
Customer email.
items[].send_email
boolean
Optional
Must remain false.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/customers/redact
Key + Bearer
Redact customer data requested by Shopify.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Optional
Customer GIDs to redact.
all
boolean
Optional
Redacts all Shopify customers for shop/redact.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/orders/feed
Key + Bearer
Retrieve SellViaApp orders not yet imported into Shopify.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
cursor
string
Optional
Opaque cursor.
limit
integer
Optional
1–100
unacknowledged_only
boolean
Optional
true recommended.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/orders/acknowledge
Key + Bearer
Acknowledge a Shopify order import.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Imported orders.
items[].order_guid
string
Required
SellViaApp GUID.
items[].external_order_id
string
Optional
Created Shopify GID.
items[].status
enum
Required
imported | failed | ignored
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/webhooks/subscribe
Key + Bearer
Register the signed SellViaApp webhook for Shopify.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
target_url
url
Required
Connector HTTPS URL.
events
array
Optional
order.created | order.updated | order.cancelled | *
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/webhooks/list
Key + Bearer
List Shopify connector webhooks.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/webhooks/delete
Key + Bearer
Disable a Shopify webhook.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Webhook ID
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/webhooks/process
Key + Bearer
Retry pending Shopify notifications.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
limit
integer
Optional
Maximum count.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/account
Key + Bearer
Identify the store and retrieve its mobile test account.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/shopify/sync/logs
Key + Bearer
View Shopify logs isolated from WooCommerce.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/connect
Public
Connect a Wix instance to an existing SellViaApp Dashboard account.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
email
email
Required
Email used to sign in to the SellViaApp Dashboard.
password
string
Required
Verified once and never stored by the connector.
instance_id
string
Required
Stable Wix installation identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/account
Key + Bearer
Identify the SellViaApp account connected to Wix and its mobile test account.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/disconnect
Key + Bearer
Revoke the connector token and disconnect Wix.
Input
JSON bodyAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/categories/sync
Key + Bearer
Synchronise Wix Stores V1/V3 categories or collections.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 500 Wix categories or collections per batch.
items[].external_id
string
Required
Stable Wix identifier.
items[].name
string
Required
Name displayed in the app.
items[].parent_external_id
string
Optional
Parent category identifier.
items[].image
url
Optional
HTTPS presentation image.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/products/sync
Key + Bearer
Synchronise Wix products with images, prices, inventory and visibility.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 250 Wix products or variants per batch.
items[].external_id
string
Required
Wix product or variant identifier.
items[].parent_external_id
string
Optional
Parent product of a variant.
items[].sku
string
Optional
SKU
items[].name
string
Required
Product title.
items[].regular_price
decimal
Optional
Regular price.
items[].sale_price
decimal
Optional
Active sale price.
items[].stock_quantity
integer
Optional
Available stock.
items[].images
array
Optional
Up to five HTTPS images.
items[].visible
boolean
Optional
Visibility in SellViaApp.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/products/inventory
Key + Bearer
Quickly update Wix prices, inventory or visibility.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Lightweight price, inventory or visibility updates.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/products/archive
Key + Bearer
Archive deleted Wix products.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
entity_type
enum
Optional
product | category | subcategory
items
array
Required
External Wix identifiers to archive.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/customers/sync
Key + Bearer
Synchronise Wix contacts without sending email.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Up to 250 contacts; no SellViaApp email is sent.
items[].external_id
string
Required
Wix contact identifier.
items[].username
string
Required
Email or fallback username.
items[].active
boolean
Optional
true for synchronised contacts.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/customers/redact
Key + Bearer
Redact one or more synchronised Wix contacts.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
all
boolean
Optional
Redact all contacts originating from Wix.
items
array
Optional
External Wix identifiers to redact when all is false.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/privacy/shop-redact
Key + Bearer
Remove Wix-origin data after uninstall.
Input
JSON bodyAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/orders/feed
Key + Bearer
Read SellViaApp orders to reconcile with Wix.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
cursor
string
Optional
Opaque cursor from the previous page.
updated_since
datetime
Optional
Optional ISO 8601 date.
limit
integer
Optional
1–100
unacknowledged_only
boolean
Optional
Defaults to true to prevent duplicates.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/orders/acknowledge
Key + Bearer
Record the result of a Wix order reconciliation.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
items
array
Required
Reconciliation results.
items[].order_guid
string
Required
SellViaApp order GUID.
items[].external_order_id
string
Optional
Linked Wix order identifier.
items[].status
enum
Required
imported | failed | ignored
items[].error
string
Optional
Readable error when processing fails.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/webhooks/subscribe
Key + Bearer
Create a signed SellViaApp destination for the Wix connector.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
target_url
url
Required
HTTPS URL of the receiving system.
events
array
Optional
order.created | order.updated | order.cancelled | *
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/webhooks/list
Key + Bearer
List SellViaApp webhooks for the Wix connector.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/webhooks/delete
Key + Bearer
Disable a Wix connector webhook.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
id
integer
Required
Webhook ID
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/webhooks/process
Key + Bearer
Process pending SellViaApp deliveries for Wix.
Input
JSON bodyAvailable parameters
NameTypeRequirementDescription
limit
integer
Optional
Maximum number of deliveries.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/wix/sync/logs
Key + Bearer
View the isolated Wix synchronisation log.
Input
URL queryAvailable parameters
NameTypeRequirementDescription
page
integer
Optional
Page number, starting at 1.
per_page
integer
Optional
Number of results per page.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}No endpoint matches your search.
Reference
Responses and errors
Each row has a “Parameters and responses” button showing required or optional fields, possible statuses and JSON examples. An empty list means the resource is not populated yet, not that the endpoint is down.
400Invalid request
401Authentication required
403Access denied
404Resource or route not found
409Business conflict
422Validation failed
429Too many requests
5xxTechnical incident