Documentatie van de leverancier

Voer uw app en ophalen van bestellingen via de API.

Sluit uw ERP, e-commerce platform, POS of zakelijke software aan op SellViaApp. Verzend categorieën, producten en prijzen, dan ophalen bevestigde winkel bestellingen als JSON.

Basis-URLhttps://api.sellviaapp.com/

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Snel starten

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.

X-API-Key

Bearer token

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.

Create the destination

In Dashboard → Webhooks, enter an HTTPS URL and select events. The secret is shown once.

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)

Eindpunten

Klanten

Maak en beheer klantaccounts voor elke winkel.

5 routes

POST /customer/add API-sleutel

Maak een klant en genereren van de leverancier login.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

nom tekenreeks Vereist

Achternaam van de klant.

prenom tekenreeks Vereist

Voornaam van de klant.

email e-mail Vereist

E-mail uniek binnen de leverancier.

denomination tekenreeks Optional

Bedrijfsnaam, optioneel.

password tekenreeks Vereist

Minstens acht karakters.

address tekenreeks Optional

Postal address.

zipcode tekenreeks Optional

Postal code.

city tekenreeks Optional

City.

country tekenreeks Optional

Country.

phone tekenreeks Optional

Phone number.

cellphone tekenreeks Optional

Mobile phone number.

vat_number tekenreeks Optional

VAT number.

language tekenreeks 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"
        }
    }
}

GET /customer/list Sleutel + drager

Lijst of filter geautoriseerde klantinformatie.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal 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"
        }
    }
}

GET /customer/me Sleutel + drager

Haal het ingelogde klantenprofiel op.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

PATCH /customer/update Sleutel + drager

Update profiel, taal, type, e-mail of wachtwoord.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

first_name tekenreeks Optional

First name.

last_name tekenreeks Optional

Last name.

company tekenreeks Optional

Company name.

email e-mail Optional

New email address, unique within the shop.

address tekenreeks Optional

Postal address.

zipcode tekenreeks Optional

Postal code.

city tekenreeks Optional

City.

country tekenreeks Optional

Country.

phone tekenreeks Optional

Phone number.

cellphone tekenreeks Optional

Mobile phone number.

vat_number tekenreeks Optional

VAT number.

language tekenreeks Optional

Two-letter ISO language code.

account_type enum Optional

company | individual

notifications_enabled booleaans Optional

Allow mobile notifications.

password tekenreeks 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"
        }
    }
}

DELETE /customer/deleteaccount Sleutel + drager

Deactiveer het klantenaccount in de actieve winkel.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

Eindpunten

Catalogus

Categorieën, producten, afbeeldingen, prijzen, voorraad, promoties en favorieten.

18 routes

GET /fam1/list Sleutel + drager

Lijst van primaire categorieën.

Input

Available parameters

URL query

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"
        }
    }
}

POST /fam1/add Sleutel + drager

Maak een primaire categorie.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

name tekenreeks Vereist

Visible category name.

external_key tekenreeks Optional

Stable identifier from your software.

sort_order geheel getal 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"
        }
    }
}

PATCH /fam1/update Sleutel + drager

Update een primaire categorie.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identifier of the category to update.

name tekenreeks Vereist

Visible category name.

external_key tekenreeks Optional

Stable identifier from your software.

sort_order geheel getal 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"
        }
    }
}

DELETE /fam1/delete Sleutel + drager

Verberg een primaire categorie.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

GET /fam2/list Sleutel + drager

Lijstsubcategorieën.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

category_id geheel getal 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"
        }
    }
}

POST /fam2/add Sleutel + drager

Maak een subcategorie aan.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

category_id geheel getal Vereist

Parent primary category identifier.

name tekenreeks Vereist

Visible category name.

external_key tekenreeks Optional

Stable identifier from your software.

sort_order geheel getal 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"
        }
    }
}

PATCH /fam2/update Sleutel + drager

Een subcategorie bijwerken.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identifier of the subcategory to update.

name tekenreeks Vereist

Visible category name.

external_key tekenreeks Optional

Stable identifier from your software.

sort_order geheel getal 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"
        }
    }
}

DELETE /fam2/delete Sleutel + drager

Verberg een subcategorie.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

GET /product/list Sleutel + drager

Lijst en zoek producten met paginatie.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Number of results per page.

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

search tekenreeks Optional

Zoeken op code, naam of beschrijving.

category_id geheel getal Optional

Filter van primaire categorie.

subcategory_id geheel getal Optional

Subcategorie filter.

price_group tekenreeks Optional

Customer price group.

favorites booleaans Optional

Return favourites only.

promotions booleaans Optional

Return active promotions only.

new booleaans Optional

Return new products only.

progressive booleaans 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"
        }
    }
}

GET /product/image Ondertekende URL

Serveer een gesigneerde, cachebare productafbeelding.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

supplier tekenreeks Vereist

Public shop suffix.

id geheel getal Vereist

Product identifier.

slot geheel getal Optional

Image slot from 1 to 5.

signature tekenreeks Vereist

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"
        }
    }
}

POST /product/add Sleutel + drager

Maak een product aan.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

code tekenreeks Vereist

Code uniek binnen de winkel.

name tekenreeks Vereist

Naam weergegeven in de app.

description tekenreeks Optional

Gedetailleerde productbeschrijving.

base_price decimaal Optional

Verkoopprijs exclusief belasting volgens uw configuratie.

vat_rate decimaal Optional

BTW-tarief, bijvoorbeeld 21.

category_id geheel getal Optional

Primary category identifier.

subcategory_id geheel getal Optional

Subcategory identifier.

external_key tekenreeks Optional

Stabiele identificatie van uw ERP.

unit tekenreeks Optional

Unit code, for example pc.

unit_name tekenreeks Optional

Human-readable unit name.

image_url url Optional

HTTPS URL van de hoofdafbeelding.

is_new booleaans Optional

Highlight the product as new.

active booleaans Optional

Controleert product zichtbaarheid.

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"
        }
    }
}

PATCH /product/update Sleutel + drager

Update een product.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identifier of the product to update.

code tekenreeks Vereist

Code uniek binnen de winkel.

name tekenreeks Vereist

Naam weergegeven in de app.

description tekenreeks Optional

Gedetailleerde productbeschrijving.

base_price decimaal Optional

Verkoopprijs exclusief belasting volgens uw configuratie.

vat_rate decimaal Optional

BTW-tarief, bijvoorbeeld 21.

category_id geheel getal Optional

Primary category identifier.

subcategory_id geheel getal Optional

Subcategory identifier.

external_key tekenreeks Optional

Stabiele identificatie van uw ERP.

unit tekenreeks Optional

Unit code, for example pc.

unit_name tekenreeks Optional

Human-readable unit name.

image_url url Optional

HTTPS URL van de hoofdafbeelding.

is_new booleaans Optional

Highlight the product as new.

active booleaans Optional

Controleert product zichtbaarheid.

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"
        }
    }
}

DELETE /product/delete Sleutel + drager

Verberg een product.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

POST /product/favoris Sleutel + drager

Voeg een product toe of verwijder deze uit favorieten.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

product_id geheel getal Vereist

Product identifier.

favorite booleaans 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"
        }
    }
}

GET /price/list Sleutel + drager

List prices applicable to the customer group, falling back to the product sales price.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

product_id geheel getal Optional

Limit results to one product.

price_group tekenreeks 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"
        }
    }
}

GET /mark/list Sleutel + drager

Lijst beschikbare merken.

Input

Available parameters

URL query

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"
        }
    }
}

GET /size/list Sleutel + drager

Lijst beschikbare maten.

Input

Available parameters

URL query

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"
        }
    }
}

GET /libweb/list Sleutel + drager

List web reference labels, falling back to catalogue labels.

Input

Available parameters

URL query

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"
        }
    }
}

Eindpunten

Winkelwagen en bestellingen

Beheer de kar en bevestig een order atomair.

10 routes

GET /order/list Sleutel + drager

List every confirmed shop order with pagination.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Number of results per page.

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

guid tekenreeks Optional

Filter a confirmed order by GUID.

from_date datum 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"
        }
    }
}

DELETE /order/delete Sleutel + drager

Wis en verwijder de huidige kar.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

GET /order/total Sleutel + drager

Bereken kar subtotaal, BTW en totaal.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

POST /order/shipping/quote Sleutel + drager

Calculate shipping fees from the cart, fulfilment mode and country.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

delivery_mode enum Vereist

pickup | delivery

delivery_country tekenreeks 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"
        }
    }
}

GET /order/count/line Sleutel + drager

Tel de lijnen in de kar.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

POST /order/sendtomegawin Sleutel + drager

Bevestig de volgorde, vervullingmodus en adres.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

order_guid uuid Optional

De cipier van de kar om te bevestigen.

delivery_mode enum Vereist

pickup | delivery

delivery_address tekenreeks Optional

Vereist voor levering.

delivery_country tekenreeks Optional

Two-letter ISO code or country name used to calculate the rate.

delivery_date datum Optional

JJJJ-MM-DD

delivery_comment tekenreeks Optional

Gebruiksaanwijzing.

language tekenreeks Optional

Transactie e-mail taal.

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"
        }
    }
}

POST /orderline/add Sleutel + drager

Voeg een product en hoeveelheid toe aan de winkelwagen.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

product_id geheel getal Vereist

Identifier of the product to add.

quantity decimaal Vereist

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"
        }
    }
}

GET /orderline/list Sleutel + drager

Ophalen van huidige karlijnen.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

PATCH /orderline/update Sleutel + drager

Update een regelhoeveelheid.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

item_id geheel getal Vereist

Cart line identifier.

quantity decimaal Vereist

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"
        }
    }
}

DELETE /orderline/delete Sleutel + drager

Verwijder een lijn uit de kar.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

item_id geheel getal Vereist

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"
        }
    }
}

Eindpunten

Customer payments

Choose pay on delivery or open a secure Stripe payment, then retrieve its server-verified status.

4 routes

GET /payment/config Sleutel + drager

Retrieve the enabled Stripe payment methods and the Stripe account provider selected for the app.

Input

Available parameters

URL query

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"
        }
    }
}

POST /payment/checkout/create Sleutel + drager

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

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

purpose_type enum Vereist

order | booking

purpose_id geheel getal Vereist

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"
        }
    }
}

POST /payment/pay-later Sleutel + drager

Record pay on delivery or replace a still-open Stripe payment after its session is securely checked and expired.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

purpose_type enum Vereist

order | booking

purpose_id geheel getal Vereist

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"
        }
    }
}

GET /payment/status Sleutel + drager

Retrieve a payment status; only the signed Stripe webhook can confirm it as paid.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

reference tekenreeks Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enum Optional

order | booking

purpose_id geheel getal 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"
        }
    }
}

Eindpunten

Documenten

Facturen, schattingen, orders en hun regels.

8 routes

POST /document/add Sleutel + drager

Maak een document aan dat gekoppeld is aan de klant.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

doc_type tekenreeks Optional

invoice | estimate | purchase_order

doc_number tekenreeks Optional

Document number; generated automatically when omitted on creation.

doc_date datum Optional

JJJJ-MM-DD

due_date datum Optional

JJJJ-MM-DD

payment_method tekenreeks Optional

Betalingswijze.

remark tekenreeks Optional

Een opmerking in vrije vorm.

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"
        }
    }
}

GET /document/list Sleutel + drager

Lijst of filterdocumenten.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

doc_type tekenreeks 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"
        }
    }
}

PATCH /document/update Sleutel + drager

Een document bijwerken dat door GUID is geïdentificeerd.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

document_guid uuid Vereist

GUID of the document to update.

doc_type tekenreeks Optional

invoice | estimate | purchase_order

doc_number tekenreeks Optional

Document number; generated automatically when omitted on creation.

doc_date datum Optional

JJJJ-MM-DD

due_date datum Optional

JJJJ-MM-DD

payment_method tekenreeks Optional

Betalingswijze.

remark tekenreeks Optional

Een opmerking in vrije vorm.

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"
        }
    }
}

DELETE /document/delete Sleutel + drager

Een document en de regels verwijderen.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

document_guid uuid Vereist

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"
        }
    }
}

POST /documentline/add Sleutel + drager

Voeg een regel toe en bereken het document opnieuw.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

document_guid uuid Vereist

Documenten.

text tekenreeks Optional

Lijnbeschrijving.

quantity decimaal Optional

Quantity, default 1.

unit_price decimaal Optional

Eenheidsprijs exclusief BTW.

vat_rate decimaal Optional

VAT rate, default 21.

discount_percentage decimaal Optional

Percentage korting.

product_code tekenreeks Optional

Associated product code.

product_id geheel getal Optional

Associated product identifier.

packages decimaal 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"
        }
    }
}

GET /documentline/list Sleutel + drager

Een document met al zijn regels ophalen.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

guid uuid Vereist

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"
        }
    }
}

PATCH /documentline/update Sleutel + drager

Update een lijn die door GUID is geïdentificeerd.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

document_guid uuid Vereist

Documenten.

line_guid uuid Vereist

GUID of the line to update.

text tekenreeks Optional

Lijnbeschrijving.

quantity decimaal Optional

Quantity, default 1.

unit_price decimaal Optional

Eenheidsprijs exclusief BTW.

vat_rate decimaal Optional

VAT rate, default 21.

discount_percentage decimaal Optional

Percentage korting.

product_code tekenreeks Optional

Associated product code.

product_id geheel getal Optional

Associated product identifier.

packages decimaal 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"
        }
    }
}

DELETE /documentline/delete Sleutel + drager

Verwijder een regel en bereken de totalen.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

document_guid uuid Vereist

Documenten.

line_guid uuid Vereist

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"
        }
    }
}

Eindpunten

Real-time webhooks

Automatically receive SellViaApp changes in your ERP, CRM, automation or business service.

10 routes

GET /webhooks/events Sleutel + drager

List all available events and the contract version.

Input

Available parameters

URL query

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"
        }
    }
}

GET /webhooks/endpoints/list Sleutel + drager

List destinations, status and counters.

Input

Available parameters

URL query

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"
        }
    }
}

POST /webhooks/endpoints/create Sleutel + drager

Create an HTTPS destination and receive its signing secret once.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

label tekenreeks Vereist

Internal name for this destination.

target_url url Vereist

Public HTTPS URL on port 443. Private networks and redirects are rejected.

events array Vereist

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"
        }
    }
}

PATCH /webhooks/endpoints/update Sleutel + drager

Update the destination, events or pause delivery.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Destination identifier.

label tekenreeks 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"
        }
    }
}

DELETE /webhooks/endpoints/delete Sleutel + drager

Soft-delete a destination.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

POST /webhooks/endpoints/rotate-secret Sleutel + drager

Replace the HMAC secret and reveal it once.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

GET /webhooks/deliveries/list Sleutel + drager

Inspect deliveries, responses, errors and attempts.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Number of results per page.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id geheel getal 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"
        }
    }
}

POST /webhooks/deliveries/retry Sleutel + drager

Retry one delivery without replaying the others.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

POST /webhooks/test Sleutel + drager

Emit and deliver a signed test event.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

endpoint_id geheel getal Vereist

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"
        }
    }
}

GET /webhooks/stats Sleutel + drager

Retrieve the last thirty days of delivery metrics.

Input

Available parameters

URL query

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"
        }
    }
}

Eindpunten

Notifications and integrations

Mobile notifications and external synchronisation.

47 routes

GET /admin/notification/sendtomobile Sleutel + drager

Mobiele meldingen ophalen.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal 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"
        }
    }
}

POST /admin/notification/setdelivery Sleutel + drager

Markeer een kennisgeving zoals deze is gedaan.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Required only with an integration token when the operation targets a specific customer.

guid tekenreeks Vereist

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"
        }
    }
}

POST /woocommerce/categories/sync Sleutel + drager

Batch-sync WooCommerce categories and subcategories.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 500 categories. Each object uses external_id, name and, for a subcategory, parent_external_id.

items[].external_id tekenreeks Vereist

Stable WooCommerce identifier.

items[].name tekenreeks Vereist

Visible name.

items[].parent_external_id tekenreeks Optional

Parent category identifier.

items[].sort_order geheel getal Optional

Display order.

items[].images array Optional

Up to five HTTPS URLs.

items[].active booleaans 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"
        }
    }
}

POST /woocommerce/products/sync Sleutel + drager

Sync products, variations, images, prices, VAT, stock and visibility.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 250 products or variations per batch.

items[].external_id tekenreeks Vereist

Stable WooCommerce identifier used for deduplication.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id tekenreeks Optional

Parent product for a variation.

items[].sku tekenreeks Optional

SKU; a fallback code is generated when omitted.

items[].name tekenreeks Vereist

Product name.

items[].description tekenreeks Optional

Product description.

items[].regular_price decimaal Optional

Regular price.

items[].sale_price decimaal Optional

Sale price.

items[].date_on_sale_from datum Optional

ISO 8601 sale start.

items[].date_on_sale_to datum Optional

ISO 8601 sale end.

items[].vat_rate decimaal Optional

BTW-tarief.

items[].stock_quantity geheel getal Optional

Available stock.

items[].category_external_id tekenreeks Optional

Synchronised primary category.

items[].subcategory_external_id tekenreeks Optional

Synchronised subcategory.

items[].images array Optional

Up to five HTTPS images.

items[].attributes array Optional

WooCommerce variation attributes.

items[].active booleaans 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"
        }
    }
}

POST /woocommerce/customers/sync Sleutel + drager

Create or update WooCommerce customer accounts without sending email.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 250 customer accounts per batch. No email is sent.

items[].external_id tekenreeks Vereist

Stable WooCommerce user identifier.

items[].username tekenreeks Vereist

WooCommerce username preserved exactly in client.login.

items[].email e-mail Optional

Customer email address used for deduplication.

items[].first_name tekenreeks Optional

Voornaam van de klant.

items[].last_name tekenreeks Optional

Achternaam van de klant.

items[].company tekenreeks Optional

Company or business name.

items[].phone tekenreeks Optional

Phone number.

items[].vat_number tekenreeks 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 booleaans Optional

Account active state.

items[].send_email booleaans 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"
        }
    }
}

PATCH /woocommerce/products/inventory Sleutel + drager

Quickly update prices, promotions, stock or visibility only.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 500 lightweight updates.

items[].external_id tekenreeks Vereist

Previously synchronised product.

items[].stock_quantity geheel getal Optional

New quantity.

items[].regular_price decimaal Optional

New regular price.

items[].sale_price decimaal Optional

New sale price.

items[].active booleaans 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"
        }
    }
}

POST /woocommerce/products/archive Sleutel + drager

Batch-archive deleted WooCommerce products without changing orders.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

entity_type enum Optional

product | category | subcategory

items array Vereist

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"
        }
    }
}

GET /woocommerce/orders/feed Sleutel + drager

Retrieve confirmed orders with cursor-based reconciliation.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

cursor tekenreeks Optional

Opaque cursor returned by the previous response.

updated_since datetime Optional

ISO 8601 starting date.

limit geheel getal Optional

1 to 100 orders.

unacknowledged_only booleaans 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"
        }
    }
}

POST /woocommerce/orders/acknowledge Sleutel + drager

Confirm that an order was imported into WooCommerce.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Orders processed by WooCommerce.

items[].order_guid tekenreeks Vereist

SellViaApp GUID returned by the feed.

items[].external_order_id tekenreeks Optional

WooCommerce order identifier.

items[].status enum Vereist

imported | failed | ignored

items[].error tekenreeks 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"
        }
    }
}

POST /woocommerce/webhooks/subscribe Sleutel + drager

Input

JSON-body

NaamTypeRequirementOmschrijving

target_url url Vereist

Public HTTPS URL; private networks are rejected.

events array Optional

order.created | order.updated | order.cancelled | *

Output

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"
        }
    }
}

GET /woocommerce/webhooks/list Sleutel + drager

List active WooCommerce webhooks.

Input

Available parameters

URL query

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"
        }
    }
}

DELETE /woocommerce/webhooks/delete Sleutel + drager

Disable a WooCommerce webhook.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

POST /woocommerce/webhooks/process Sleutel + drager

Process pending webhook deliveries with automatic retries.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal 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"
        }
    }
}

GET /woocommerce/sync/logs Sleutel + drager

View the technical synchronisation log.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal 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"
        }
    }
}

POST /shopify/categories/sync Sleutel + drager

Sync Shopify collections and product types.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 500 collections or product types.

items[].external_id tekenreeks Vereist

Stable Shopify GID.

items[].name tekenreeks Vereist

Visible name.

items[].parent_external_id tekenreeks 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"
        }
    }
}

POST /shopify/categories/archive Sleutel + drager

Archive a deleted Shopify collection.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

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"
        }
    }
}

POST /shopify/products/sync Sleutel + drager

Sync Shopify products, variants, images, prices, inventory and visibility.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 250 Shopify variants per batch.

items[].external_id tekenreeks Vereist

Variant GID.

items[].parent_external_id tekenreeks Optional

Parent product GID.

items[].sku tekenreeks Optional

SKU

items[].name tekenreeks Vereist

Product and variant title.

items[].regular_price decimaal Optional

Regular or compare-at price.

items[].sale_price decimaal Optional

Active sale price.

items[].stock_quantity geheel getal Optional

Available quantity.

items[].images array Optional

Up to five HTTPS images.

items[].active booleaans 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"
        }
    }
}

PATCH /shopify/products/inventory Sleutel + drager

Quickly update Shopify prices, inventory or visibility.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

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"
        }
    }
}

POST /shopify/products/archive Sleutel + drager

Archive Shopify variants by identifier.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

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"
        }
    }
}

POST /shopify/products/archive-parent Sleutel + drager

Archive every variant of a deleted Shopify product.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

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"
        }
    }
}

POST /shopify/customers/sync Sleutel + drager

Sync Shopify customers without sending email.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 250 customers; no email is sent.

items[].external_id tekenreeks Vereist

Shopify customer GID.

items[].username tekenreeks Vereist

Username used in SellViaApp.

items[].email e-mail Optional

Customer email.

items[].send_email booleaans 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"
        }
    }
}

POST /shopify/customers/redact Sleutel + drager

Redact customer data requested by Shopify.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Optional

Customer GIDs to redact.

all booleaans 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"
        }
    }
}

GET /shopify/orders/feed Sleutel + drager

Retrieve SellViaApp orders not yet imported into Shopify.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

cursor tekenreeks Optional

Opaque cursor.

limit geheel getal Optional

1–100

unacknowledged_only booleaans 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"
        }
    }
}

POST /shopify/orders/acknowledge Sleutel + drager

Acknowledge a Shopify order import.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Imported orders.

items[].order_guid tekenreeks Vereist

SellViaApp GUID.

items[].external_order_id tekenreeks Optional

Created Shopify GID.

items[].status enum Vereist

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"
        }
    }
}

POST /shopify/webhooks/subscribe Sleutel + drager

Input

JSON-body

NaamTypeRequirementOmschrijving

target_url url Vereist

Connector HTTPS URL.

events array Optional

order.created | order.updated | order.cancelled | *

Output

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"
        }
    }
}

GET /shopify/webhooks/list Sleutel + drager

List Shopify connector webhooks.

Input

Available parameters

URL query

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"
        }
    }
}

DELETE /shopify/webhooks/delete Sleutel + drager

Disable a Shopify webhook.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

POST /shopify/webhooks/process Sleutel + drager

Retry pending Shopify notifications.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal 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"
        }
    }
}

GET /shopify/account Sleutel + drager

Identify the store and retrieve its mobile test account.

Input

Available parameters

URL query

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"
        }
    }
}

GET /shopify/sync/logs Sleutel + drager

View Shopify logs isolated from WooCommerce.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal 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"
        }
    }
}

POST /wix/connect Openbaar

Connect a Wix instance to an existing SellViaApp Dashboard account.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

email e-mail Vereist

Email used to sign in to the SellViaApp Dashboard.

password tekenreeks Vereist

Verified once and never stored by the connector.

instance_id tekenreeks Vereist

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"
        }
    }
}

GET /wix/account Sleutel + drager

Identify the SellViaApp account connected to Wix and its mobile test account.

Input

Available parameters

URL query

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"
        }
    }
}

POST /wix/disconnect Sleutel + drager

Revoke the connector token and disconnect Wix.

Input

Available parameters

JSON-body

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"
        }
    }
}

POST /wix/categories/sync Sleutel + drager

Synchronise Wix Stores V1/V3 categories or collections.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 500 Wix categories or collections per batch.

items[].external_id tekenreeks Vereist

Stable Wix identifier.

items[].name tekenreeks Vereist

Naam weergegeven in de app.

items[].parent_external_id tekenreeks 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"
        }
    }
}

POST /wix/products/sync Sleutel + drager

Synchronise Wix products with images, prices, inventory and visibility.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 250 Wix products or variants per batch.

items[].external_id tekenreeks Vereist

Wix product or variant identifier.

items[].parent_external_id tekenreeks Optional

Parent product of a variant.

items[].sku tekenreeks Optional

SKU

items[].name tekenreeks Vereist

Product title.

items[].regular_price decimaal Optional

Regular price.

items[].sale_price decimaal Optional

Active sale price.

items[].stock_quantity geheel getal Optional

Available stock.

items[].images array Optional

Up to five HTTPS images.

items[].visible booleaans 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"
        }
    }
}

PATCH /wix/products/inventory Sleutel + drager

Quickly update Wix prices, inventory or visibility.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

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"
        }
    }
}

POST /wix/products/archive Sleutel + drager

Archive deleted Wix products.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

entity_type enum Optional

product | category | subcategory

items array Vereist

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"
        }
    }
}

POST /wix/customers/sync Sleutel + drager

Synchronise Wix contacts without sending email.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Up to 250 contacts; no SellViaApp email is sent.

items[].external_id tekenreeks Vereist

Wix contact identifier.

items[].username tekenreeks Vereist

Email or fallback username.

items[].active booleaans 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"
        }
    }
}

POST /wix/customers/redact Sleutel + drager

Redact one or more synchronised Wix contacts.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

all booleaans 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"
        }
    }
}

POST /wix/privacy/shop-redact Sleutel + drager

Remove Wix-origin data after uninstall.

Input

Available parameters

JSON-body

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"
        }
    }
}

GET /wix/orders/feed Sleutel + drager

Read SellViaApp orders to reconcile with Wix.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

cursor tekenreeks Optional

Opaque cursor from the previous page.

updated_since datetime Optional

Optional ISO 8601 date.

limit geheel getal Optional

1–100

unacknowledged_only booleaans 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"
        }
    }
}

POST /wix/orders/acknowledge Sleutel + drager

Record the result of a Wix order reconciliation.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Reconciliation results.

items[].order_guid tekenreeks Vereist

SellViaApp order GUID.

items[].external_order_id tekenreeks Optional

Linked Wix order identifier.

items[].status enum Vereist

imported | failed | ignored

items[].error tekenreeks 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"
        }
    }
}

POST /wix/webhooks/subscribe Sleutel + drager

Create a signed SellViaApp destination for the Wix connector.

Input

JSON-body

NaamTypeRequirementOmschrijving

target_url url Vereist

HTTPS URL of the receiving system.

events array Optional

order.created | order.updated | order.cancelled | *

Output

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"
        }
    }
}

GET /wix/webhooks/list Sleutel + drager

List SellViaApp webhooks for the Wix connector.

Input

Available parameters

URL query

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"
        }
    }
}

DELETE /wix/webhooks/delete Sleutel + drager

Disable a Wix connector webhook.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

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"
        }
    }
}

POST /wix/webhooks/process Sleutel + drager

Process pending SellViaApp deliveries for Wix.

Input

Available parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal 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"
        }
    }
}

GET /wix/sync/logs Sleutel + drager

View the isolated Wix synchronisation log.

Input

Available parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal 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"
        }
    }
}

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.

400Ongeldig verzoek

401Aanmelding vereist

403Toegang geweigerd

404Hulpbron of route niet gevonden

409Bedrijfsconflict

422Validatie mislukt

429Te veel verzoeken

5xxTechnisch incident

API-werkruimte

Endpoint

GET

URL-parametersEén parameter per regel: naam=waarde JSON-bodyPas de voorbeeldwaarden aan vóór de test.

De gegenereerde code bevat de ingevoerde toegangsgegevens. Bewaar ze op de server en deel nooit een niet-gemaskeerde schermafbeelding.

API-antwoord