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/

Vereiste headersX-API-Key + Bearer

Machineleesbaar contract · JSONOpenAPI 3.1 · Download ↓ Machineleesbaar contract · YAMLOpenAPI 3.1 · Download ↓ Ontwikkelaarsondersteuningapi@sellviaapp.com

Snel starten

Authenticeren, een route kiezen, testen.

Haal de X-API-Key op en maak de Bearer-token aan via Dashboard → API. Vul beide hieronder in. Kies daarna ‘Testen · Genereren’ bij een endpoint om het antwoord en voorbeeldcode voor cURL, PHP 8 of JavaScript te bekijken.

X-API-Key

Bearer token

Onvolledige geloofsbrievenVoer de X-API-Key en Bearer token in om een test voor te bereiden.

Geheimen blijven alleen voor deze pagina in het geheugen. Voor een klantgerelateerde operatie, voeg customer_id toe.

Keep in mindHTTPS + JSON · houden beide referenties server-side · nooit tokens te sturen naar ondersteuning.

Real time

Verbind SellViaApp met elk HTTPS-geschikt systeem.

Een webhook waarschuwt uw ERP, CRM, automatisering of software wanneer een product, klant, winkelwagen, bestelling, document of belangrijke instelling verandert. Gebruik de API om het volledige gezaghebbende object op te halen indien nodig.

Doel aanmaken

In Dashboard → Webhooks, voer een HTTPS URL en selecteer gebeurtenissen. Het geheim wordt eenmaal getoond.

Controleer de handtekening

Berekenen HMAC-SHA256 over timestamp.delivery_id.raw_body en vergelijk het met X-SellViaApp-Signature.

Snel bevestigen

Retourneren HTTP 2xx, dedupliceren met X-SellViaApp-Event-Id, vervolgens verwerken op de achtergrond.

Betrouwbare leveringTot acht pogingen met geleidelijke vertragingen. Een herhaaldelijk falende bestemming wordt automatisch onderbroken, en elke levering blijft zichtbaar en opnieuw te proberen in het 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

Beschikbare 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

Postadres.

zipcode tekenreeks Optional

Postal code.

city tekenreeks Optional

City.

country tekenreeks Optional

Country.

phone tekenreeks Optional

Phone number.

cellphone tekenreeks Optional

Mobiel telefoonnummer.

vat_number tekenreeks Optional

VAT number.

language tekenreeks Optional

Tweeletterige ISO-taalcode.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

first_name tekenreeks Optional

First name.

last_name tekenreeks Optional

Last name.

company tekenreeks Optional

Company name.

email e-mail Optional

Nieuw e-mailadres, uniek binnen de winkel.

address tekenreeks Optional

Postadres.

zipcode tekenreeks Optional

Postal code.

city tekenreeks Optional

City.

country tekenreeks Optional

Country.

phone tekenreeks Optional

Phone number.

cellphone tekenreeks Optional

Mobiel telefoonnummer.

vat_number tekenreeks Optional

VAT number.

language tekenreeks Optional

Tweeletterige ISO-taalcode.

account_type enum Optional

company | individual

notifications_enabled booleaans Optional

Mobiele meldingen toestaan.

password tekenreeks Optional

Nieuw wachtwoord, minstens acht tekens.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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.

28 routes

GET /fam1/list Sleutel + drager

Lijst van primaire categorieën.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

name tekenreeks Vereist

Zichtbare categorienaam.

external_key tekenreeks Optional

Stabiele identificatie van uw software.

sort_order geheel getal Optional

Weergavevolgorde, te beginnen bij 1.

image_url url Optional

HTTPS afbeeldingsURL.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identificatie van de te actualiseren categorie.

name tekenreeks Vereist

Zichtbare categorienaam.

external_key tekenreeks Optional

Stabiele identificatie van uw software.

sort_order geheel getal Optional

Weergavevolgorde, te beginnen bij 1.

image_url url Optional

HTTPS afbeeldingsURL.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identificatie van de te verbergen categorie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

category_id geheel getal Optional

Beperk de resultaten tot één primaire categorie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

category_id geheel getal Vereist

Identificatiecode primaire hoofdcategorie.

name tekenreeks Vereist

Zichtbare categorienaam.

external_key tekenreeks Optional

Stabiele identificatie van uw software.

sort_order geheel getal Optional

Weergavevolgorde, te beginnen bij 1.

image_url url Optional

HTTPS afbeeldingsURL.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identificatie van de te actualiseren subcategorie.

name tekenreeks Vereist

Zichtbare categorienaam.

external_key tekenreeks Optional

Stabiele identificatie van uw software.

sort_order geheel getal Optional

Weergavevolgorde, te beginnen bij 1.

image_url url Optional

HTTPS afbeeldingsURL.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identificatie van de te verbergen subcategorie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

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

Klantenprijsgroep.

favorites booleaans Optional

Alleen favorieten retourneren.

promotions booleaans Optional

Alleen actieve promoties retourneren.

new booleaans Optional

Alleen nieuwe producten retourneren.

progressive booleaans Optional

Snelle paginatie zonder de totale telling te berekenen.

group_variants booleaans Optional

Groepsvarianten onder het basisproduct en retourcombinaties. Opties worden ook teruggegeven.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/variants Sleutel + drager

Retrieve a product’s variant groups and combinations.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

product_id geheel getal Vereist

Identificatienummer van het moederproduct.

groups array Optional

POST alleen: volledige lijst van 0–3 groepen {naam, waarden[]}. Een lege array verwijdert varianten.

combinations array Optional

POST alleen: alle combinaties in groep volgorde, elk met selecties[], sku, prijs en voorraad. Maximaal 100.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/variants Sleutel + drager

Vervang een product... ...groepen en combinaties.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

product_id geheel getal Vereist

Identificatienummer van het moederproduct.

groups array Optional

POST alleen: volledige lijst van 0–3 groepen {naam, waarden[]}. Een lege array verwijdert varianten.

combinations array Optional

POST alleen: alle combinaties in groep volgorde, elk met selecties[], sku, prijs en voorraad. Maximaal 100.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/options Sleutel + drager

De optiegroepen en extra keuzes van een product ophalen.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

product_id geheel getal Vereist

Identificatienummer van het moederproduct.

groups array Optional

POST alleen: volledige lijst van 0–10 Groepen {id, naam, selection_mode, opties[]}. Een lege array verwijdert opties.

groups[].options[] array Optional

Per optie: bestaande ID of 0, naam, prijs, quantity_mode (single of quantity), max_quantity (1 of 2–50) en eventueel unit_label. Voeg een afbeelding toe met image_base64 (JPEG/PNG/WebP, 1 MB) of verwijder die met remove_photo.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/options Sleutel + drager

Een product vervangen optie groepen en optionele extra's.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

product_id geheel getal Vereist

Identificatienummer van het moederproduct.

groups array Optional

POST alleen: volledige lijst van 0–10 Groepen {id, naam, selection_mode, opties[]}. Een lege array verwijdert opties.

groups[].options[] array Optional

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/image Ondertekende URL

Serveer een gesigneerde, cachebare productafbeelding.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

supplier tekenreeks Vereist

Openbare winkel achtervoegsel.

id geheel getal Vereist

Productidentificatie.

slot geheel getal Optional

Afbeelding slot van 1 tot 5.

signature tekenreeks Vereist

Ondertekende link handtekening geretourneerd door product/lijst.

variant enum Optional

small | thumb | large

Output

Mogelijke resultaten

200Binaire afbeelding met het MIME-type

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Ongeldige ondertekende verwijzing

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

200 De body bevat direct de binaire afbeelding en de Content-Type header geeft het formaat aan.

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

Beschikbare 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

Identificatiecode primaire categorie.

subcategory_id geheel getal Optional

Subcategorie-identificatie.

external_key tekenreeks Optional

Stabiele identificatie van uw ERP.

unit tekenreeks Optional

Eenheidscode, bijvoorbeeld pc.

unit_name tekenreeks Optional

Menselijk leesbare eenheidnaam.

image_url url Optional

HTTPS URL van de hoofdafbeelding.

is_new booleaans Optional

Het product als nieuw markeren.

active booleaans Optional

Controleert product zichtbaarheid.

action_type enum Optional

cart | auction | inquiry

auction.start_price decimaal Optional

Vereiste startprijs wanneer action_type is veiling.

auction.buy_now_price decimaal Optional

Optionele koop-now prijs.

auction.minimum_increment decimaal Optional

Facultatief minimale verhoging van het bod.

auction.starts_at datetime Optional

Optionele start als ISO 8601 met tijdzone.

auction.ends_at datetime Optional

Facultatief einde als ISO 8601 met tijdzone.

auction.hide_after_end booleaans Optional

Verberg het product na het verstrijken; vereist ends_at.

auction.terms tekenreeks Optional

Veiling-specifieke termen, maximaal 5000 tekens.

inquiry.prompt tekenreeks Optional

Informatie-verzoek prompt, maximaal 1000 tekens.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identificatie van het te actualiseren product.

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

Identificatiecode primaire categorie.

subcategory_id geheel getal Optional

Subcategorie-identificatie.

external_key tekenreeks Optional

Stabiele identificatie van uw ERP.

unit tekenreeks Optional

Eenheidscode, bijvoorbeeld pc.

unit_name tekenreeks Optional

Menselijk leesbare eenheidnaam.

image_url url Optional

HTTPS URL van de hoofdafbeelding.

is_new booleaans Optional

Het product als nieuw markeren.

active booleaans Optional

Controleert product zichtbaarheid.

action_type enum Optional

cart | auction | inquiry

auction.start_price decimaal Optional

Vereiste startprijs wanneer action_type is veiling.

auction.buy_now_price decimaal Optional

Optionele koop-now prijs.

auction.minimum_increment decimaal Optional

Facultatief minimale verhoging van het bod.

auction.starts_at datetime Optional

Optionele start als ISO 8601 met tijdzone.

auction.ends_at datetime Optional

Facultatief einde als ISO 8601 met tijdzone.

auction.hide_after_end booleaans Optional

Verberg het product na het verstrijken; vereist ends_at.

auction.terms tekenreeks Optional

Veiling-specifieke termen, maximaal 5000 tekens.

inquiry.prompt tekenreeks Optional

Informatie-verzoek prompt, maximaal 1000 tekens.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/action Sleutel + drager

Haal een product actie type en de instellingen.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

product_id geheel getal Vereist

Identificatie van de actie om het product op te halen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

PUT /product/action/configure Sleutel + drager

Configureren van directe aankoop, veiling of informatieaanvraag en hun instellingen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

product_id geheel getal Vereist

Identificatie van het te configureren product.

action_type enum Vereist

cart | auction | inquiry

auction.start_price decimaal Optional

Vereiste startprijs voor de veiling.

auction.buy_now_price decimaal Optional

Optionele koop-now prijs.

auction.minimum_increment decimaal Optional

Optionele minimumverhoging.

auction.starts_at datetime Optional

Optionele start als ISO 8601 met tijdzone.

auction.ends_at datetime Optional

Facultatief einde als ISO 8601 met tijdzone.

auction.hide_after_end booleaans Optional

Verberg het product na de einddatum.

auction.terms tekenreeks Optional

Voorwaarden, maximaal 5000 karakters.

inquiry.prompt tekenreeks Optional

Optionele prompt, maximaal 1.000 tekens.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Identificatie van het te verbergen product.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Vereist

Productidentificatie.

favorite booleaans Optional

true to add, false to remove; schakelt de staat aan als deze wordt weggelaten.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/auction Sleutel + drager

Haal een veilingstaat op en anonimiseerde biedgeschiedenis.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Vereist

Identificatie van het veilingproduct.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/auction/bid Sleutel + drager

Plaats een bod met atomaire minimumbedrag validering.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Vereist

Identificatie van het veilingproduct.

amount decimaal Vereist

Bied bedrag, ten minste het minimum dat door de server wordt teruggegeven.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/auction/buy-now Sleutel + drager

Koop nu en sluit de veiling atomair af.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Vereist

Identificatie van het product met koop nu ingeschakeld.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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/inquiry Sleutel + drager

Stuur een informatieaanvraag in verband met een product.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Vereist

Identificatie van het betrokken product.

message tekenreeks Vereist

Klantvraag, 5 tot 5.000 karakters.

name tekenreeks Optional

Contactnaam; standaardinstellingen voor het ingelogde profiel.

email e-mail Optional

E-mail beantwoorden; e-mail of telefoon is vereist.

phone tekenreeks Optional

Antwoord telefoon; e-mail of telefoon is vereist.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lijst van prijzen die van toepassing zijn op de klantengroep, terugvallend op de verkoopprijs van het product.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Optional

Beperk de resultaten tot één product.

price_group tekenreeks Optional

Prijsgroep, wanbetaling tot 01.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lijst web referentie labels, terugvallend op catalogus labels.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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.

14 routes

GET /order/list Sleutel + drager

Noteer elke bevestigde winkelorder met paginatie.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

guid tekenreeks Optional

Filter een bevestigde bestelling van GUID.

from_date datum Optional

Filter vanaf deze datum met JJJJ-MM-DD.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /promotion/validate Sleutel + drager

Valideer een promotiecode met de huidige winkelwagen op de server en bereken netto, BTW en totale kortingen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

promotion_code tekenreeks Vereist

Code met 3 tot 64 letters, nummers, koppeltekens of onderstrepingen. De server controleert data, gebruikslimiet en subsidiabiliteit.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "success": true,
    "message": "Promotion code validated",
    "data": {
        "promotion": {
            "id": 12,
            "code": "WELCOME10",
            "name": "Welcome offer",
            "discount_type": "percent",
            "discount_value": 10,
            "scope": "all",
            "currency": "EUR",
            "currency_symbol": "€",
            "eligible_item_count": 2,
            "original_product_total": 60.5,
            "discount_net": 5,
            "discount_tax": 1.05,
            "discount_total": 6.05,
            "subtotal": 45,
            "vat_total": 9.45,
            "product_total": 54.45
        }
    },
    "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 /loyalty/summary Sleutel + drager

Haal het loyaliteitsprogramma, de klantenbalans en de beschikbare kortingswaarde terug.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /loyalty/history Sleutel + drager

Lijst van de klant verdienen, inwisselen, correctie en vervaldatum geschiedenis.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /loyalty/quote Sleutel + drager

Bereken aan de serverzijde hoeveel punten kunnen worden ingewisseld tegen de huidige winkelwagen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

loyalty_points geheel getal Vereist

Aantal punten die de klant wil inwisselen.

delivery_mode enum Vereist

pickup | delivery

delivery_country tekenreeks Optional

Land gebruikt om verzendkosten opnieuw te berekenen.

promotion_code tekenreeks Optional

Optionele promotiecode toegepast vóór de loyaliteitskorting.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Bereken verzendkosten uit de winkelwagen, vervullingmodus en land.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

delivery_mode enum Vereist

pickup | delivery

delivery_country tekenreeks Optional

Tweeletterige ISO-code of naam van het leveringsland.

promotion_code tekenreeks Optional

Optionele code; de offerte herberekent de korting voor verzendingskosten.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Confirm the order, delivery and, in multi-site mode, the chosen stock location.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

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.

stock_site_id geheel getal Optional

Customer-selected location in multi-site mode. Without this field, the server automatically assigns a location able to fulfil the entire cart for older apps.

delivery_country tekenreeks Optional

Tweeletterige ISO-code of landnaam die wordt gebruikt om het tarief te berekenen.

delivery_date datum Optional

JJJJ-MM-DD

delivery_comment tekenreeks Optional

Gebruiksaanwijzing.

language tekenreeks Optional

Transactie e-mail taal.

promotion_code tekenreeks Optional

Facultatief code, opnieuw gevalideerd en atomair ingewisseld tijdens bevestiging.

loyalty_points geheel getal Optional

Punten om in te lossen; saldo en regels worden hervalideerd en atomair gedebiteerd.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

product_id geheel getal Vereist

Identificatie van het toe te voegen product.

quantity decimaal Vereist

Hoeveelheid strikt groter dan nul.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

item_id geheel getal Vereist

Nummer van de kar.

quantity decimaal Vereist

Hoeveelheid; nul verwijdert de lijn.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

item_id geheel getal Vereist

Identificatie van de te verwijderen lijn.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Klantbetalingen

Kies betalen bij levering of open een beveiligde Stripe-betaling en haal vervolgens de server-geverifieerde status op.

4 routes

GET /payment/config Sleutel + drager

Ophalen van de ingeschakelde Stripe betaalmethoden en de Stripe-accountprovider geselecteerd voor de app.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Maak of hervat een Stripe Checkout pagina voor een onbetaalde bestelling of boeking eigendom van de ingelogde klant. Een nog steeds wisselende betaal-op-leveringskeuze wordt veilig vervangen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

purpose_type enum Vereist

order | booking

purpose_id geheel getal Vereist

Identificatie van de bevestigde order of klantbevestigde boeking.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 betalen bij levering of vervangen van een nog open Stripe betaling na de sessie is veilig gecontroleerd en verlopen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

purpose_type enum Vereist

order | booking

purpose_id geheel getal Vereist

Toegelaten order- of boekingsidentificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Een betalingsstatus ophalen; alleen de ondertekende Stripe webhook kan het bevestigen als betaald.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

reference tekenreeks Optional

SellViaApp referentie van de betaling. Andere purpose_type en purpose_id.

purpose_type enum Optional

order | booking

purpose_id geheel getal Optional

Betaalde objectidentificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

doc_type tekenreeks Optional

invoice | estimate | purchase_order

doc_number tekenreeks Optional

Documentnummer; automatisch gegenereerd bij het aanmaken.

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

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

doc_type tekenreeks Optional

Filter op documenttype.

guid uuid Optional

Filter op document GUID.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

document_guid uuid Vereist

GIDS van het te actualiseren document.

doc_type tekenreeks Optional

invoice | estimate | purchase_order

doc_number tekenreeks Optional

Documentnummer; automatisch gegenereerd bij het aanmaken.

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

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

document_guid uuid Vereist

GIDS van het te verwijderen document.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

document_guid uuid Vereist

Documenten.

text tekenreeks Optional

Lijnbeschrijving.

quantity decimaal Optional

Hoeveelheid, standaard 1.

unit_price decimaal Optional

Eenheidsprijs exclusief BTW.

vat_rate decimaal Optional

BTW-tarief, standaard 21.

discount_percentage decimaal Optional

Percentage korting.

product_code tekenreeks Optional

Geassocieerde productcode.

product_id geheel getal Optional

Betrokken productidentificatiecode.

packages decimaal Optional

Aantal verpakkingen.

Output

Mogelijke resultaten

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

guid uuid Vereist

GIDS van het document waarvan de regels moeten worden opgehaald.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

document_guid uuid Vereist

Documenten.

line_guid uuid Vereist

GIDS van de lijn om bij te werken.

text tekenreeks Optional

Lijnbeschrijving.

quantity decimaal Optional

Hoeveelheid, standaard 1.

unit_price decimaal Optional

Eenheidsprijs exclusief BTW.

vat_rate decimaal Optional

BTW-tarief, standaard 21.

discount_percentage decimaal Optional

Percentage korting.

product_code tekenreeks Optional

Geassocieerde productcode.

product_id geheel getal Optional

Betrokken productidentificatiecode.

packages decimaal Optional

Aantal verpakkingen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

document_guid uuid Vereist

Documenten.

line_guid uuid Vereist

GIDS van de te verwijderen regel.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Ontvang automatisch SellViaApp wijzigingen in uw ERP, CRM, automatisering of zakelijke service.

10 routes

GET /webhooks/events Sleutel + drager

Geef een overzicht van alle beschikbare evenementen en de contractversie.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lijst van bestemmingen, status en tellers.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Maak een HTTPS-bestemming en ontvang het ondertekeningsgeheim eenmaal.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

label tekenreeks Vereist

Interne naam voor deze bestemming.

target_url url Vereist

Openbare HTTPS URL op poort 443. Particuliere netwerken en omleidingen worden afgewezen.

events array Vereist

Exacte gebeurtenissen, een groep zoals product.*, of alle met *.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 de bestemming, gebeurtenissen of pauze levering.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Bestemmingsidentificatie.

label tekenreeks Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

Nieuwe evenementselectie.

status enum Optional

active | paused

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Zacht-verwijder een bestemming.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Bestemmingsidentificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Vervang het HMAC geheim en onthul het eenmaal.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Bestemmingsidentificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Inspecteer leveringen, reacties, fouten en pogingen.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id geheel getal Optional

Beperk de resultaten tot één bestemming.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Probeer de ene levering zonder de andere te herhalen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Interne leveringsidentificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 en leveren een ondertekende test evenement.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

endpoint_id geheel getal Vereist

Bestemming om te testen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Haal de laatste dertig dagen van leveringsstatistieken.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Kennisgevingen en integraties

Mobiele meldingen en externe synchronisatie.

64 routes

GET /admin/notification/sendtomobile Sleutel + drager

Mobiele meldingen ophalen.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

customer_id geheel getal Optional

Vereist alleen met een integratie token wanneer de operatie gericht is op een specifieke klant.

guid tekenreeks Vereist

Notificatie GUID token.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /push/device/register Sleutel + drager

Sluit een mobiele installatie aan bij dit klantenaccount voor Firebase push.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

installation_id tekenreeks Vereist

Stabiele willekeurige installatie ID (48 hex tekens).

fid tekenreeks Vereist

Firebase Installatie ID geleverd door de app.

platform enum Vereist

android | ios

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /push/device/unregister Sleutel + drager

Verwijder deze winkel van push meldingen op dit apparaat.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

installation_id tekenreeks Vereist

Installatie om uit te schrijven voor dit account.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /push/notification/ack Sleutel + drager

Erken een kennisgeving waargenomen in de app of geopend door de klant.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

installation_id tekenreeks Vereist

Installatie die de kennisgeving erkent.

guid tekenreeks Vereist

Notificatie-ID voor deze winkel.

event enum Vereist

received | opened

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 categorieën en subcategorieën.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 categorieën. Elk object gebruikt external_id, naam en, voor een subcategorie, parent_external_id.

items[].external_id tekenreeks Vereist

Stabiele WooCommerce-identificatiecode.

items[].name tekenreeks Vereist

Visible name.

items[].parent_external_id tekenreeks Optional

Identificatiecode van de moedercategorie.

items[].sort_order geheel getal Optional

Display order.

items[].images array Optional

Maximaal vijf HTTPS-URL's.

items[].active booleaans Optional

valse archieven de categorie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Synchroniseer producten, variaties, afbeeldingen, prijzen, BTW, voorraad en zichtbaarheid.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 producten of variaties per partij.

items[].external_id tekenreeks Vereist

Stabiele WooCommerce identificatiecode gebruikt voor deduplicatie.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id tekenreeks Optional

Ouder product voor een variatie.

items[].sku tekenreeks Optional

SKU; een terugvalcode wordt gegenereerd wanneer deze wordt weggelaten.

items[].name tekenreeks Vereist

Product name.

items[].description tekenreeks Optional

Productbeschrijving.

items[].regular_price decimaal Optional

Regular price.

items[].sale_price decimaal Optional

Sale price.

items[].date_on_sale_from datum Optional

ISO 8601 verkoop start.

items[].date_on_sale_to datum Optional

ISO 8601 verkoop einde.

items[].vat_rate decimaal Optional

BTW-tarief.

items[].stock_quantity geheel getal Optional

Beschikbare voorraad.

items[].category_external_id tekenreeks Optional

Gesynchroniseerde primaire categorie.

items[].subcategory_external_id tekenreeks Optional

Gesynchroniseerde subcategorie.

items[].images array Optional

Maximaal vijf HTTPS beelden.

items[].attributes array Optional

WooCommerce variatie attributen.

items[].active booleaans Optional

Zichtbaarheid in SellViaApp.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Maak of update WooCommerce klantenaccounts zonder e-mail te sturen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 klantenaccounts per batch. Er wordt geen e-mail verstuurd.

items[].external_id tekenreeks Vereist

Stabiele WooCommerce gebruikersidentificatie.

items[].username tekenreeks Vereist

WooCommerce gebruikersnaam precies bewaard in client.login.

items[].email e-mail Optional

E-mailadres van de klant gebruikt voor deduplicatie.

items[].first_name tekenreeks Optional

Voornaam van de klant.

items[].last_name tekenreeks Optional

Achternaam van de klant.

items[].company tekenreeks Optional

Bedrijfsnaam of bedrijfsnaam.

items[].phone tekenreeks Optional

Phone number.

items[].vat_number tekenreeks Optional

VAT number.

items[].language iso-639-1 Optional

Tweeletterige taal; Engels standaard.

items[].billing object Optional

Volledig WooCommerce factuuradres.

items[].shipping object Optional

Verzendadres bewaard in synchronisatiemetadata.

items[].active booleaans Optional

Rekening actieve status.

items[].send_email booleaans Optional

Moet vals blijven. Deze route stuurt nooit e-mail.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Update snel prijzen, promoties, voorraad of zichtbaarheid alleen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 lichtgewicht updates.

items[].external_id tekenreeks Vereist

Eerder gesynchroniseerd product.

items[].stock_quantity geheel getal Optional

New quantity.

items[].regular_price decimaal Optional

Nieuwe vaste prijs.

items[].sale_price decimaal Optional

Nieuwe verkoopprijs.

items[].active booleaans Optional

Nieuwe zichtbaarheid.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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-archief verwijderde WooCommerce producten zonder het wijzigen van bestellingen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

entity_type enum Optional

product | category | subcategory

items array Vereist

Lijst van maximaal 500 externe identificatiemiddelen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Herstel bevestigde orders met cursor-gebaseerde verzoening.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

cursor tekenreeks Optional

Ondoorzichtige cursor teruggegeven door het vorige antwoord.

updated_since datetime Optional

ISO 8601 startdatum.

limit geheel getal Optional

1 tot 100 bestellingen.

unacknowledged_only booleaans Optional

Standaardwaarden om duplicaten te voorkomen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Bevestig dat een bestelling is geïmporteerd in WooCommerce.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Bestellingen verwerkt door WooCommerce.

items[].order_guid tekenreeks Vereist

SellViaApp GUID teruggestuurd door de feed.

items[].external_order_id tekenreeks Optional

WooCommerce-volgnummer.

items[].status enum Vereist

imported | failed | ignored

items[].error tekenreeks Optional

Verklaring bij importeren mislukt.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Registreer een ondertekende HTTPS WooCommerce webhook.

Input

JSON-body

NaamTypeRequirementOmschrijving

target_url url Vereist

Publieke HTTPS URL; private netwerken worden afgewezen.

events array Optional

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

Output

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lijst actieve WooCommerce webhooks.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Schakel een WooCommerce webhook uit.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Webhook identificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Proces in afwachting van webhook leveringen met automatische retrieves.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal Optional

Maximale leveringen om te verwerken.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Bekijk het technische synchronisatielogboek.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 collecties en producttypes.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 collecties of producttypes.

items[].external_id tekenreeks Vereist

Stabiele Shopify GID.

items[].name tekenreeks Vereist

Visible name.

items[].parent_external_id tekenreeks Optional

Oudercollectie voor een producttype.

items[].images array Optional

HTTPS URLs.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Archiveer een verwijderde Shopify collectie.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

GID's van verwijderde collecties.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 producten, varianten, afbeeldingen, prijzen, inventaris en zichtbaarheid.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 Shopify varianten per batch.

items[].external_id tekenreeks Vereist

Variant GID.

items[].parent_external_id tekenreeks Optional

Ouderproduct GID.

items[].sku tekenreeks Optional

SKU

items[].name tekenreeks Vereist

Product- en varianttitel.

items[].regular_price decimaal Optional

Regelmatige of vergelijkbare prijs.

items[].sale_price decimaal Optional

Actieve verkoopprijs.

items[].stock_quantity geheel getal Optional

Beschikbare hoeveelheid.

items[].images array Optional

Maximaal vijf HTTPS beelden.

items[].active booleaans Optional

SellViaApp zichtbaarheid.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Update Shopify prijzen, inventaris of zichtbaarheid snel.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 lichtgewicht updates.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Archief Shopify varianten door identificatie.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Variant GID's te archiveren.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Archief elke variant van een geschrapt Shopify product.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 100 basisproduct GID's.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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-klanten zonder e-mail te sturen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 klanten; er wordt geen e-mail verzonden.

items[].external_id tekenreeks Vereist

Shopify klant GID.

items[].username tekenreeks Vereist

Gebruikersnaam gebruikt in SellViaApp.

items[].email e-mail Optional

Klanten e-mail.

items[].send_email booleaans Optional

Moet vals blijven.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 klantgegevens opgevraagd door Shopify.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Optional

Klant GID's om te redacteren.

all booleaans Optional

Redacts alle Shopify klanten voor winkel / redact.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Ophalen SellViaApp bestellingen nog niet geïmporteerd in Shopify.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

cursor tekenreeks Optional

Opaque cursor.

limit geheel getal Optional

1–100

unacknowledged_only booleaans Optional

Echt aanbevolen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Bevestig een Shopify bestelling import.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Geïmporteerde orders.

items[].order_guid tekenreeks Vereist

SellViaApp GUID.

items[].external_order_id tekenreeks Optional

Aangemaakt Shopify GID.

items[].status enum Vereist

imported | failed | ignored

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Registreer de getekende SellViaApp webhook voor Shopify.

Input

JSON-body

NaamTypeRequirementOmschrijving

target_url url Vereist

Connector HTTPS URL.

events array Optional

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

Output

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lijst Shopify connector webhooks.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Schakel een Shopify webhook uit.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Webhook ID

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Probeer in afwachting van Shopify meldingen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal Optional

Maximum count.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Identificeer de winkel en haal zijn mobiele testaccount op.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Bekijk Shopify logs geïsoleerd van WooCommerce.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Sluit een Wix instantie aan op een bestaand SellViaApp Dashboard account.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

email e-mail Vereist

E-mail gebruikt om zich aan te melden bij het SellViaApp Dashboard.

password tekenreeks Vereist

Eenmaal geverifieerd en nooit opgeslagen door de connector.

instance_id tekenreeks Vereist

Stabiele Wix installatie-identificatie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Identificeer de SellViaApp-account verbonden met Wix en zijn mobiele testaccount.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Trek de connector token in en ontkoppel Wix.

Input

Beschikbare parameters

JSON-body

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Synchroniseer Wix Stores V1/V3 categorieën of collecties.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 Wix categorieën of collecties per batch.

items[].external_id tekenreeks Vereist

Stabiele Wix-identificatiecode.

items[].name tekenreeks Vereist

Naam weergegeven in de app.

items[].parent_external_id tekenreeks Optional

Identificatiecode van de moedercategorie.

items[].image url Optional

HTTPS presentatie afbeelding.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Synchroniseer Wix producten met afbeeldingen, prijzen, inventaris en zichtbaarheid.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 Wix producten of varianten per batch.

items[].external_id tekenreeks Vereist

Wix product- of variantidentificatiecode.

items[].parent_external_id tekenreeks Optional

Hoofdproduct van een variant.

items[].sku tekenreeks Optional

SKU

items[].name tekenreeks Vereist

Product title.

items[].regular_price decimaal Optional

Regular price.

items[].sale_price decimaal Optional

Actieve verkoopprijs.

items[].stock_quantity geheel getal Optional

Beschikbare voorraad.

items[].images array Optional

Maximaal vijf HTTPS beelden.

items[].visible booleaans Optional

Zichtbaarheid in SellViaApp.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Update Wix prijzen, inventaris of zichtbaarheid snel.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Lichtgewicht prijs, inventaris of zichtbaarheid updates.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Archief verwijderd Wix producten.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

entity_type enum Optional

product | category | subcategory

items array Vereist

Externe Wix identificaties om te archiveren.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Synchroniseer Wix contacten zonder e-mail te sturen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 contacten; er wordt geen SellViaApp e-mail verstuurd.

items[].external_id tekenreeks Vereist

Wix contactpersoon.

items[].username tekenreeks Vereist

E-mail of fallback gebruikersnaam.

items[].active booleaans Optional

voor gesynchroniseerde contacten.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Redacteer één of meer gesynchroniseerde Wix contacten.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

all booleaans Optional

Redacteer alle contacten afkomstig van Wix.

items array Optional

Externe Wix-ID’s die geanonimiseerd moeten worden wanneer all op false staat.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Verwijder Wix-origine gegevens na het verwijderen.

Input

Beschikbare parameters

JSON-body

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lees SellViaApp orders om te combineren met Wix.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

cursor tekenreeks Optional

Ondoorzichtige cursor van de vorige pagina.

updated_since datetime Optional

Facultatief ISO 8601 datum.

limit geheel getal Optional

1–100

unacknowledged_only booleaans Optional

Standaardwaarden om duplicaten te voorkomen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Registreer het resultaat van een Wix orde afstemming.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Verzoeningsresultaten.

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

Leesbare fout bij verwerking mislukt.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Maak een gesigneerde SellViaApp bestemming voor de Wix connector.

Input

JSON-body

NaamTypeRequirementOmschrijving

target_url url Vereist

HTTPS URL van het ontvangende systeem.

events array Optional

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

Output

201Hulpbron aangemaakt

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Lijst SellViaApp webhooks voor de Wix connector.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Schakel een Wix connector webhook uit.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

id geheel getal Vereist

Webhook ID

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Proces lopende SellViaApp leveringen voor Wix.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal Optional

Maximumaantal leveringen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Bekijk het geïsoleerde Wix-synchronisatielogboek.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/oauth/device/code Openbaar

Start een Odoo OAuth-vergunning zonder het SellViaApp wachtwoord te delen.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

client_id tekenreeks Vereist

sellviaapp_odoo

installation_id tekenreeks Vereist

Stabiele UUID voor deze Odoo installatie.

instance_url url Optional

Publieke HTTPS URL van de Odoo instantie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/oauth/device/token Openbaar

Wissel een goedgekeurde apparaatcode uit voor een herroepbare toegangstoken voor integratie.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

client_id tekenreeks Vereist

sellviaapp_odoo

grant_type tekenreeks Vereist

urn:ietf:params:oauth:grant-type:device_code

device_code tekenreeks Vereist

Ondoorzichtige code terug bij het starten van de stroom.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/account Sleutel + drager

Controleer de SellViaApp account verbonden met de Odoo installatie.

Input

Beschikbare parameters

URL query

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/disconnect Sleutel + drager

Trek onmiddellijk deze Odoo installatie token in.

Input

Beschikbare parameters

JSON-body

Er wordt geen bedrijfsparameter verwacht. Alleen de opgegeven authenticatiekoppen verzenden.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/categories/sync Sleutel + drager

Synchroniseer de Odoo categoriehiërarchie.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 Odoo categorieën per batch.

items[].external_id tekenreeks Vereist

Stabiele Odoo-identificatiecode.

items[].name tekenreeks Vereist

Visible name.

items[].parent_external_id tekenreeks Optional

Oudercategorie.

items[].translations object Optional

Vertaalde namen getoetst door taalcode.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/categories/archive Sleutel + drager

Verberg Odoo categorieën verwijderd uit de catalogus.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Te verbergen identificatienummers van de wortelcategorie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/products/sync Sleutel + drager

Synchroniseer Odoo varianten, referenties, beschrijvingen, vertalingen, afbeeldingen, prijzen, BTW en voorraad.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 Odoo producten of varianten per batch.

items[].external_id tekenreeks Vereist

Stabiel product.product variant identificatie.

items[].parent_external_id tekenreeks Optional

product.template-identificatiecode.

items[].sku tekenreeks Optional

Odoo interne referentie.

items[].barcode tekenreeks Optional

Barcode.

items[].name tekenreeks Vereist

Naam van het product of variant.

items[].description tekenreeks Optional

Verkoopbenaming.

items[].regular_price decimaal Optional

Odoo verkoopprijs.

items[].vat_rate decimaal Optional

Eerste toepasselijke BTW-tarief.

items[].stock_quantity decimaal Optional

Beschikbaar of on-hand voorraad volgens de Odoo instelling.

items[].images array Optional

Maximaal vijf gesigneerde Odoo HTTPS afbeeldingsURL's.

items[].translations object Optional

Naam en beschrijving in actieve Odoo talen.

items[].attributes array Optional

Variante eigenschappen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/products/inventory Sleutel + drager

Update Odoo prijzen, voorraad en zichtbaarheid snel.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 500 lichtgewicht prijs, voorraad of zichtbaarheid updates.

items[].external_id tekenreeks Vereist

Stabiel identificatienummer van een reeds gepubliceerd product.product record.

items[].stock_quantity decimaal Optional

Beschikbaar of on-hand hoeveelheid volgens de Odoo instelling.

items[].stock_status enum Optional

instock | outofstock

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/products/archive Sleutel + drager

Verberg verwijderde Odoo producten, categorieën of subcategorieën.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

entity_type enum Optional

product | category | subcategory

items array Vereist

Externe Odoo identificaties om te verbergen.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/customers/sync Sleutel + drager

Stuur Odoo contacten naar SellViaApp en bereid hun mobiele toegang voor.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Tot 250 Odoo contacten per batch.

items[].external_id tekenreeks Vereist

Stabiele res.partner identificatie.

items[].email e-mail Vereist

E-mail gebruikt voor mobiele toegang.

items[].send_invitation booleaans Optional

Verzend de uitnodiging alleen bij het aanmaken van het account.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/customers/feed Sleutel + drager

SellViaApp-klanten ophalen voor dubbele-veilige afstemming met Odoo-contacten.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal Optional

Van 1 tot 100 klanten per pagina.

cursor tekenreeks Optional

Ondoorzichtige cursor teruggestuurd door de vorige pagina.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/orders/feed Sleutel + drager

Ophalen bevestigde SellViaApp bestellingen in Odoo.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

limit geheel getal Optional

Van 1 tot 100 bestellingen per pagina.

cursor tekenreeks Optional

Ondoorzichtige cursor teruggestuurd door de vorige pagina.

unacknowledged_only booleaans Optional

Retour alleen bestellingen nog niet geïmporteerd.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/orders/acknowledge Sleutel + drager

Record het resultaat van een Odoo bestelling import.

Input

Beschikbare parameters

JSON-body

NaamTypeRequirementOmschrijving

items array Vereist

Importeer resultaten met orderidentificatie, status en Odoo-referentie.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

{
    "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 /odoo/sync/logs Sleutel + drager

Bekijk het geïsoleerde Odoo-synchronisatielogboek.

Input

Beschikbare parameters

URL query

NaamTypeRequirementOmschrijving

page geheel getal Optional

Paginanummer, vanaf 1.

per_page geheel getal Optional

Aantal resultaten per pagina.

Output

Mogelijke resultaten

200Succesvolle werking

400Ongeldig verzoek of JSON

401Ontbrekende of ongeldige authenticatie

403Onvoldoende toegang

404Aangevraagde hulpbron niet gevonden

409Conflict met bestaande gegevens

422Door validatie afgewezen parameter

429Verzoeklimiet bereikt

5xxTijdelijk technisch incident

Succesvoorbeeld

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

Reacties en fouten

Bij ‘Parameters en antwoorden’ ziet u verplichte en optionele velden, statuscodes en JSON-voorbeelden. Een lege lijst betekent alleen dat er nog geen gegevens zijn. Het endpoint is daardoor niet uitgevallen.

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