Lieferantendokumentation

Füttern Sie Ihre App und rufen Sie Bestellungen über die API ab.

Verbinden Sie Ihre ERP-, E-Commerce-Plattform, POS- oder Business-Software mit SellViaApp. Senden Sie Kategorien, Produkte und Preise und rufen Sie dann bestätigte Shop-Bestellungen als JSON ab.

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

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Schnellstart

Authenticate, choose a route, test.

Get the X-API-Key and generate the Bearer in Dashboard → API. Enter them below, then use “Test · Generate” on an endpoint to obtain the response and cURL, PHP 8 or JavaScript code.

X-API-Key

Bearer token

Credentials incompleteEnter the X-API-Key and Bearer token to prepare a test.

Credentials remain in memory for this page only. For a customer-related operation, add customer_id.

Keep in mindHTTPS + JSON · keep both credentials server-side · never send tokens to support.

Real time

Connect SellViaApp to any HTTPS-capable system.

A webhook alerts your ERP, CRM, automation or software whenever a product, customer, cart, order, document or important setting changes. Use the API to retrieve the full authoritative object when needed.

Create the destination

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

Verify the signature

Compute HMAC-SHA256 over timestamp.delivery_id.raw_body and compare it with X-SellViaApp-Signature.

Acknowledge quickly

Return HTTP 2xx, deduplicate with X-SellViaApp-Event-Id, then process in the background.

Reliable deliveryUp to eight attempts with progressive delays. A repeatedly failing destination is paused automatically, and every delivery remains visible and retryable in the Dashboard.

payload = timestamp + "." + delivery_id + "." + raw_body
expected = "v1=" + HMAC_SHA256(payload, signing_secret)

Endpunkte

Kunden

Erstellen und Verwalten von Kundenkonten für jeden Shop.

5 routes

POST /customer/add API-Schlüssel

Erstellen Sie einen Kunden und generieren Sie den Lieferanten-Login.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

nom String Erforderlich

Nachname des Kunden.

prenom String Erforderlich

Vorname des Kunden.

email E-Mail-E-Mail-Adresse Erforderlich

E-Mail einzigartig innerhalb des Lieferanten.

denomination String Optional

Name des Unternehmens, fakultativ.

password String Erforderlich

Mindestens acht Zeichen.

address String Optional

Postal address.

zipcode String Optional

Postal code.

city String Optional

City.

country String Optional

Country.

phone String Optional

Phone number.

cellphone String Optional

Mobile phone number.

vat_number String Optional

VAT number.

language String Optional

Two-letter ISO language code.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /customer/list Schlüssel + Träger

Liste oder Filter autorisierter Kundeninformationen.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /customer/me Schlüssel + Träger

Holen Sie sich das angemeldete Kundenprofil ab.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /customer/update Schlüssel + Träger

Aktualisierungsprofil, Sprache, Typ, E-Mail oder Passwort.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

first_name String Optional

First name.

last_name String Optional

Last name.

company String Optional

Company name.

email E-Mail-E-Mail-Adresse Optional

New email address, unique within the shop.

address String Optional

Postal address.

zipcode String Optional

Postal code.

city String Optional

City.

country String Optional

Country.

phone String Optional

Phone number.

cellphone String Optional

Mobile phone number.

vat_number String Optional

VAT number.

language String Optional

Two-letter ISO language code.

account_type enum Optional

company | individual

notifications_enabled Boolestan Optional

Allow mobile notifications.

password String Optional

New password, at least eight characters.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /customer/deleteaccount Schlüssel + Träger

Deaktivieren Sie das Kundenkonto im aktiven Shop.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Katalog

Kategorien, Produkte, Bilder, Preise, Lager, Promotionen und Favoriten.

18 routes

GET /fam1/list Schlüssel + Träger

Primäre Kategorien auflisten.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /fam1/add Schlüssel + Träger

Erstellen Sie eine primäre Kategorie.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

name String Erforderlich

Visible category name.

external_key String Optional

Stable identifier from your software.

sort_order Ganzzahl Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /fam1/update Schlüssel + Träger

Aktualisieren Sie eine primäre Kategorie.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier of the category to update.

name String Erforderlich

Visible category name.

external_key String Optional

Stable identifier from your software.

sort_order Ganzzahl Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /fam1/delete Schlüssel + Träger

Verstecken Sie eine primäre Kategorie.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier of the category to hide.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /fam2/list Schlüssel + Träger

Unterkategorien auflisten.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

category_id Ganzzahl Optional

Limit results to one primary category.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /fam2/add Schlüssel + Träger

Erstellen Sie eine Unterkategorie.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

category_id Ganzzahl Erforderlich

Parent primary category identifier.

name String Erforderlich

Visible category name.

external_key String Optional

Stable identifier from your software.

sort_order Ganzzahl Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /fam2/update Schlüssel + Träger

Aktualisieren Sie eine Unterkategorie.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier of the subcategory to update.

name String Erforderlich

Visible category name.

external_key String Optional

Stable identifier from your software.

sort_order Ganzzahl Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /fam2/delete Schlüssel + Träger

Verstecken Sie eine Unterkategorie.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier of the subcategory to hide.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/list Schlüssel + Träger

Liste und Suche nach Produkten mit Paginierung.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

customer_id Ganzzahl Optional

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

search String Optional

Suche nach Code, Name oder Beschreibung.

category_id Ganzzahl Optional

Filter für die Hauptkategorie.

subcategory_id Ganzzahl Optional

Filter der Unterkategorie.

price_group String Optional

Customer price group.

favorites Boolestan Optional

Return favourites only.

promotions Boolestan Optional

Return active promotions only.

new Boolestan Optional

Return new products only.

progressive Boolestan Optional

Fast pagination without calculating the total count.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/image Signierte URL

Servieren Sie ein signiertes, cachefähiges Produktbild.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

supplier String Erforderlich

Public shop suffix.

id Ganzzahl Erforderlich

Product identifier.

slot Ganzzahl Optional

Image slot from 1 to 5.

signature String Erforderlich

Signed-link signature returned by product/list.

variant enum Optional

small | thumb | large

Output

Possible results

200Binary image with its MIME type

400Invalid request or JSON

401Missing or invalid authentication

403Invalid signed link

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

200 The body directly contains the binary image and the Content-Type header indicates its format.

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/add Schlüssel + Träger

Erstellen Sie ein Produkt.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

code String Erforderlich

Produktcode einzigartig im Shop.

name String Erforderlich

Name in der App angezeigt.

description String Optional

Ausführliche Produktbeschreibung.

base_price Dezimalzahl Optional

Verkaufspreis ohne Steuern gemäß Ihrer Konfiguration.

vat_rate Dezimalzahl Optional

MwSt.-Satz, z. B. 21.

category_id Ganzzahl Optional

Primary category identifier.

subcategory_id Ganzzahl Optional

Subcategory identifier.

external_key String Optional

Stabile Identifikator aus Ihrem ERP.

unit String Optional

Unit code, for example pc.

unit_name String Optional

Human-readable unit name.

image_url url Optional

HTTPS URL des Hauptbildes.

is_new Boolestan Optional

Highlight the product as new.

active Boolestan Optional

Kontrolliert die Produktsichtbarkeit.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /product/update Schlüssel + Träger

Aktualisieren Sie ein Produkt.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier of the product to update.

code String Erforderlich

Produktcode einzigartig im Shop.

name String Erforderlich

Name in der App angezeigt.

description String Optional

Ausführliche Produktbeschreibung.

base_price Dezimalzahl Optional

Verkaufspreis ohne Steuern gemäß Ihrer Konfiguration.

vat_rate Dezimalzahl Optional

MwSt.-Satz, z. B. 21.

category_id Ganzzahl Optional

Primary category identifier.

subcategory_id Ganzzahl Optional

Subcategory identifier.

external_key String Optional

Stabile Identifikator aus Ihrem ERP.

unit String Optional

Unit code, for example pc.

unit_name String Optional

Human-readable unit name.

image_url url Optional

HTTPS URL des Hauptbildes.

is_new Boolestan Optional

Highlight the product as new.

active Boolestan Optional

Kontrolliert die Produktsichtbarkeit.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /product/delete Schlüssel + Träger

Verstecken Sie ein Produkt.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier of the product to hide.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/favoris Schlüssel + Träger

Hinzufügen oder Entfernen eines Produkts von Favoriten.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

product_id Ganzzahl Erforderlich

Product identifier.

favorite Boolestan Optional

true to add, false to remove; toggles the state when omitted.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /price/list Schlüssel + Träger

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

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

product_id Ganzzahl Optional

Limit results to one product.

price_group String Optional

Price group, defaults to 01.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /mark/list Schlüssel + Träger

Verfügbare Marken auflisten.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /size/list Schlüssel + Träger

Liste der verfügbaren Größen auf.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /libweb/list Schlüssel + Träger

List web reference labels, falling back to catalogue labels.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Warenkorb und Bestellungen

Verwalten Sie den Warenkorb und bestätigen Sie eine Bestellung atomar.

10 routes

GET /order/list Schlüssel + Träger

List every confirmed shop order with pagination.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

customer_id Ganzzahl Optional

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

guid String Optional

Filter a confirmed order by GUID.

from_date Datum Optional

Filter from this date using YYYY-MM-DD.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /order/delete Schlüssel + Träger

Löschen und löschen Sie den aktuellen Warenkorb.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /order/total Schlüssel + Träger

Berechnen Sie den Warenkorb Zwischensumme, Mehrwertsteuer und Gesamtwert.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /order/shipping/quote Schlüssel + Träger

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

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

delivery_mode enum Erforderlich

pickup | delivery

delivery_country String Optional

Two-letter ISO code or delivery-country name.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Shipping fee calculated",
    "data": {
        "delivery_mode": "delivery",
        "country_code": "BE",
        "shipping_mode": "country_rules",
        "shipping_fee": 6.9,
        "free_shipping": false,
        "free_shipping_from": 75,
        "amount_until_free": 25,
        "product_total": 50,
        "total": 56.9,
        "rule": "country:BE",
        "currency": "EUR",
        "currency_symbol": "€"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /order/count/line Schlüssel + Träger

Zählen Sie Linien im Wagen.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /order/sendtomegawin Schlüssel + Träger

Bestätigen Sie die Bestellung, den Erfüllungsmodus und die Adresse.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

order_guid Uuid Optional

GUID des Warenkorbs zu bestätigen.

delivery_mode enum Erforderlich

pickup | delivery

delivery_address String Optional

Für die Lieferung erforderlich.

delivery_country String Optional

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

delivery_date Datum Optional

JJJJ-MM-TT

delivery_comment String Optional

Anweisungen zur Erfüllung.

language String Optional

Transaktionale E-Mail-Sprache.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /orderline/add Schlüssel + Träger

Fügen Sie ein Produkt und eine Menge in den Warenkorb.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

product_id Ganzzahl Erforderlich

Identifier of the product to add.

quantity Dezimalzahl Erforderlich

Quantity strictly greater than zero.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /orderline/list Schlüssel + Träger

Abrufen von aktuellen Wagenleitungen.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /orderline/update Schlüssel + Träger

Aktualisieren Sie eine Zeilenmenge.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

item_id Ganzzahl Erforderlich

Cart line identifier.

quantity Dezimalzahl Erforderlich

Quantity; zero removes the line.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /orderline/delete Schlüssel + Träger

Entfernen Sie eine Linie aus dem Warenkorb.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

item_id Ganzzahl Erforderlich

Identifier of the line to remove.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Customer payments

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

4 routes

GET /payment/config Schlüssel + Träger

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

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /payment/checkout/create Schlüssel + Träger

Create or resume a Stripe Checkout page for an unpaid order or booking owned by the signed-in customer. A still-changeable pay-on-delivery choice is safely replaced.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

purpose_type enum Erforderlich

order | booking

purpose_id Ganzzahl Erforderlich

Identifier of the confirmed order or customer-confirmed booking.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /payment/pay-later Schlüssel + Träger

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

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

purpose_type enum Erforderlich

order | booking

purpose_id Ganzzahl Erforderlich

Authorised order or booking identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /payment/status Schlüssel + Träger

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

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

reference String Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enum Optional

order | booking

purpose_id Ganzzahl Optional

Paid object identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Dokumente

Rechnungen, Schätzungen, Bestellungen und deren Linien.

8 routes

POST /document/add Schlüssel + Träger

Erstellen Sie ein Dokument, das mit dem Kunden verknüpft ist.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

doc_type String Optional

invoice | estimate | purchase_order

doc_number String Optional

Document number; generated automatically when omitted on creation.

doc_date Datum Optional

JJJJ-MM-TT

due_date Datum Optional

JJJJ-MM-TT

payment_method String Optional

Zahlungsmethode.

remark String Optional

Freiform Bemerkung.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /document/list Schlüssel + Träger

Listen oder filtern Sie Dokumente.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

doc_type String Optional

Filter by document type.

guid Uuid Optional

Filter by document GUID.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /document/update Schlüssel + Träger

Aktualisieren Sie ein Dokument, das von GUID identifiziert wurde.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

document_guid Uuid Erforderlich

GUID of the document to update.

doc_type String Optional

invoice | estimate | purchase_order

doc_number String Optional

Document number; generated automatically when omitted on creation.

doc_date Datum Optional

JJJJ-MM-TT

due_date Datum Optional

JJJJ-MM-TT

payment_method String Optional

Zahlungsmethode.

remark String Optional

Freiform Bemerkung.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /document/delete Schlüssel + Träger

Löschen Sie ein Dokument und seine Zeilen.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

document_guid Uuid Erforderlich

GUID of the document to delete.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /documentline/add Schlüssel + Träger

Fügen Sie eine Zeile hinzu und berechnen Sie das Dokument neu.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

document_guid Uuid Erforderlich

Dokument GUID.

text String Optional

Streckenbeschreibung.

quantity Dezimalzahl Optional

Quantity, default 1.

unit_price Dezimalzahl Optional

Stückpreis ohne Mehrwertsteuer.

vat_rate Dezimalzahl Optional

VAT rate, default 21.

discount_percentage Dezimalzahl Optional

Prozentsatz des Rabatts.

product_code String Optional

Associated product code.

product_id Ganzzahl Optional

Associated product identifier.

packages Dezimalzahl Optional

Number of packages.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /documentline/list Schlüssel + Träger

Holen Sie ein Dokument mit allen seinen Zeilen ab.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

guid Uuid Erforderlich

GUID of the document whose lines must be retrieved.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /documentline/update Schlüssel + Träger

Aktualisieren Sie eine Zeile, die von GUID identifiziert wurde.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

document_guid Uuid Erforderlich

Dokument GUID.

line_guid Uuid Erforderlich

GUID of the line to update.

text String Optional

Streckenbeschreibung.

quantity Dezimalzahl Optional

Quantity, default 1.

unit_price Dezimalzahl Optional

Stückpreis ohne Mehrwertsteuer.

vat_rate Dezimalzahl Optional

VAT rate, default 21.

discount_percentage Dezimalzahl Optional

Prozentsatz des Rabatts.

product_code String Optional

Associated product code.

product_id Ganzzahl Optional

Associated product identifier.

packages Dezimalzahl Optional

Number of packages.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /documentline/delete Schlüssel + Träger

Löschen Sie eine Zeile und berechnen Sie die Gesamtsumme neu.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

document_guid Uuid Erforderlich

Dokument GUID.

line_guid Uuid Erforderlich

GUID of the line to delete.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Real-time webhooks

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

10 routes

GET /webhooks/events Schlüssel + Träger

List all available events and the contract version.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /webhooks/endpoints/list Schlüssel + Träger

List destinations, status and counters.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/endpoints/create Schlüssel + Träger

Create an HTTPS destination and receive its signing secret once.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

label String Erforderlich

Internal name for this destination.

target_url url Erforderlich

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

events array Erforderlich

Exact events, a group such as product.*, or all with *.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /webhooks/endpoints/update Schlüssel + Träger

Update the destination, events or pause delivery.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Destination identifier.

label String Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

New event selection.

status enum Optional

active | paused

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /webhooks/endpoints/delete Schlüssel + Träger

Soft-delete a destination.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Destination identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/endpoints/rotate-secret Schlüssel + Träger

Replace the HMAC secret and reveal it once.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Destination identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /webhooks/deliveries/list Schlüssel + Träger

Inspect deliveries, responses, errors and attempts.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id Ganzzahl Optional

Limit results to one destination.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/deliveries/retry Schlüssel + Träger

Retry one delivery without replaying the others.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Internal delivery identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/test Schlüssel + Träger

Emit and deliver a signed test event.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

endpoint_id Ganzzahl Erforderlich

Destination to test.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /webhooks/stats Schlüssel + Träger

Retrieve the last thirty days of delivery metrics.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Notifications and integrations

Mobile notifications and external synchronisation.

47 routes

GET /admin/notification/sendtomobile Schlüssel + Träger

Mobile Benachrichtigungen abrufen.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /admin/notification/setdelivery Schlüssel + Träger

Markieren Sie eine Benachrichtigung als geliefert.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

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

guid String Erforderlich

Notification GUID token.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/categories/sync Schlüssel + Träger

Batch-sync WooCommerce categories and subcategories.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

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

items[].external_id String Erforderlich

Stable WooCommerce identifier.

items[].name String Erforderlich

Visible name.

items[].parent_external_id String Optional

Parent category identifier.

items[].sort_order Ganzzahl Optional

Display order.

items[].images array Optional

Up to five HTTPS URLs.

items[].active Boolestan Optional

false archives the category.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/products/sync Schlüssel + Träger

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

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 250 products or variations per batch.

items[].external_id String Erforderlich

Stable WooCommerce identifier used for deduplication.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id String Optional

Parent product for a variation.

items[].sku String Optional

SKU; a fallback code is generated when omitted.

items[].name String Erforderlich

Product name.

items[].description String Optional

Product description.

items[].regular_price Dezimalzahl Optional

Regular price.

items[].sale_price Dezimalzahl Optional

Sale price.

items[].date_on_sale_from Datum Optional

ISO 8601 sale start.

items[].date_on_sale_to Datum Optional

ISO 8601 sale end.

items[].vat_rate Dezimalzahl Optional

MwSt.-Satz.

items[].stock_quantity Ganzzahl Optional

Available stock.

items[].category_external_id String Optional

Synchronised primary category.

items[].subcategory_external_id String Optional

Synchronised subcategory.

items[].images array Optional

Up to five HTTPS images.

items[].attributes array Optional

WooCommerce variation attributes.

items[].active Boolestan Optional

Visibility in SellViaApp.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/customers/sync Schlüssel + Träger

Create or update WooCommerce customer accounts without sending email.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

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

items[].external_id String Erforderlich

Stable WooCommerce user identifier.

items[].username String Erforderlich

WooCommerce username preserved exactly in client.login.

items[].email E-Mail-E-Mail-Adresse Optional

Customer email address used for deduplication.

items[].first_name String Optional

Vorname des Kunden.

items[].last_name String Optional

Nachname des Kunden.

items[].company String Optional

Company or business name.

items[].phone String Optional

Phone number.

items[].vat_number String Optional

VAT number.

items[].language iso-639-1 Optional

Two-letter language; English by default.

items[].billing object Optional

Full WooCommerce billing address.

items[].shipping object Optional

Shipping address retained in synchronisation metadata.

items[].active Boolestan Optional

Account active state.

items[].send_email Boolestan Optional

Must remain false. This route never sends email.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /woocommerce/products/inventory Schlüssel + Träger

Quickly update prices, promotions, stock or visibility only.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 500 lightweight updates.

items[].external_id String Erforderlich

Previously synchronised product.

items[].stock_quantity Ganzzahl Optional

New quantity.

items[].regular_price Dezimalzahl Optional

New regular price.

items[].sale_price Dezimalzahl Optional

New sale price.

items[].active Boolestan Optional

New visibility.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/products/archive Schlüssel + Träger

Batch-archive deleted WooCommerce products without changing orders.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

entity_type enum Optional

product | category | subcategory

items array Erforderlich

List of up to 500 external identifiers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /woocommerce/orders/feed Schlüssel + Träger

Retrieve confirmed orders with cursor-based reconciliation.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

cursor String Optional

Opaque cursor returned by the previous response.

updated_since datetime Optional

ISO 8601 starting date.

limit Ganzzahl Optional

1 to 100 orders.

unacknowledged_only Boolestan Optional

Defaults to true to prevent duplicates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/orders/acknowledge Schlüssel + Träger

Confirm that an order was imported into WooCommerce.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Orders processed by WooCommerce.

items[].order_guid String Erforderlich

SellViaApp GUID returned by the feed.

items[].external_order_id String Optional

WooCommerce order identifier.

items[].status enum Erforderlich

imported | failed | ignored

items[].error String Optional

Explanation when import failed.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/webhooks/subscribe Schlüssel + Träger

Input

JSON-Body

NameArt der ArtRequirementBeschreibung

target_url url Erforderlich

Public HTTPS URL; private networks are rejected.

events array Optional

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

Output

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /woocommerce/webhooks/list Schlüssel + Träger

List active WooCommerce webhooks.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /woocommerce/webhooks/delete Schlüssel + Träger

Disable a WooCommerce webhook.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Webhook identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/webhooks/process Schlüssel + Träger

Process pending webhook deliveries with automatic retries.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Maximum deliveries to process.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /woocommerce/sync/logs Schlüssel + Träger

View the technical synchronisation log.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/categories/sync Schlüssel + Träger

Sync Shopify collections and product types.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 500 collections or product types.

items[].external_id String Erforderlich

Stable Shopify GID.

items[].name String Erforderlich

Visible name.

items[].parent_external_id String Optional

Parent collection for a product type.

items[].images array Optional

HTTPS URLs.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/categories/archive Schlüssel + Träger

Archive a deleted Shopify collection.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

GIDs of deleted collections.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/products/sync Schlüssel + Träger

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

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 250 Shopify variants per batch.

items[].external_id String Erforderlich

Variant GID.

items[].parent_external_id String Optional

Parent product GID.

items[].sku String Optional

SKU

items[].name String Erforderlich

Product and variant title.

items[].regular_price Dezimalzahl Optional

Regular or compare-at price.

items[].sale_price Dezimalzahl Optional

Active sale price.

items[].stock_quantity Ganzzahl Optional

Available quantity.

items[].images array Optional

Up to five HTTPS images.

items[].active Boolestan Optional

SellViaApp visibility.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /shopify/products/inventory Schlüssel + Träger

Quickly update Shopify prices, inventory or visibility.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 500 lightweight updates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/products/archive Schlüssel + Träger

Archive Shopify variants by identifier.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Variant GIDs to archive.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/products/archive-parent Schlüssel + Träger

Archive every variant of a deleted Shopify product.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 100 parent product GIDs.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/customers/sync Schlüssel + Träger

Sync Shopify customers without sending email.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 250 customers; no email is sent.

items[].external_id String Erforderlich

Shopify customer GID.

items[].username String Erforderlich

Username used in SellViaApp.

items[].email E-Mail-E-Mail-Adresse Optional

Customer email.

items[].send_email Boolestan Optional

Must remain false.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/customers/redact Schlüssel + Träger

Redact customer data requested by Shopify.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Optional

Customer GIDs to redact.

all Boolestan Optional

Redacts all Shopify customers for shop/redact.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/orders/feed Schlüssel + Träger

Retrieve SellViaApp orders not yet imported into Shopify.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

cursor String Optional

Opaque cursor.

limit Ganzzahl Optional

1–100

unacknowledged_only Boolestan Optional

true recommended.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/orders/acknowledge Schlüssel + Träger

Acknowledge a Shopify order import.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Imported orders.

items[].order_guid String Erforderlich

SellViaApp GUID.

items[].external_order_id String Optional

Created Shopify GID.

items[].status enum Erforderlich

imported | failed | ignored

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/webhooks/subscribe Schlüssel + Träger

Input

JSON-Body

NameArt der ArtRequirementBeschreibung

target_url url Erforderlich

Connector HTTPS URL.

events array Optional

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

Output

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/webhooks/list Schlüssel + Träger

List Shopify connector webhooks.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /shopify/webhooks/delete Schlüssel + Träger

Disable a Shopify webhook.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Webhook ID

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/webhooks/process Schlüssel + Träger

Retry pending Shopify notifications.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Maximum count.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/account Schlüssel + Träger

Identify the store and retrieve its mobile test account.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/sync/logs Schlüssel + Träger

View Shopify logs isolated from WooCommerce.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/connect öffentlich

Connect a Wix instance to an existing SellViaApp Dashboard account.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

email E-Mail-E-Mail-Adresse Erforderlich

Email used to sign in to the SellViaApp Dashboard.

password String Erforderlich

Verified once and never stored by the connector.

instance_id String Erforderlich

Stable Wix installation identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/account Schlüssel + Träger

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

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/disconnect Schlüssel + Träger

Revoke the connector token and disconnect Wix.

Input

Available parameters

JSON-Body

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/categories/sync Schlüssel + Träger

Synchronise Wix Stores V1/V3 categories or collections.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 500 Wix categories or collections per batch.

items[].external_id String Erforderlich

Stable Wix identifier.

items[].name String Erforderlich

Name in der App angezeigt.

items[].parent_external_id String Optional

Parent category identifier.

items[].image url Optional

HTTPS presentation image.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/products/sync Schlüssel + Träger

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

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 250 Wix products or variants per batch.

items[].external_id String Erforderlich

Wix product or variant identifier.

items[].parent_external_id String Optional

Parent product of a variant.

items[].sku String Optional

SKU

items[].name String Erforderlich

Product title.

items[].regular_price Dezimalzahl Optional

Regular price.

items[].sale_price Dezimalzahl Optional

Active sale price.

items[].stock_quantity Ganzzahl Optional

Available stock.

items[].images array Optional

Up to five HTTPS images.

items[].visible Boolestan Optional

Visibility in SellViaApp.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /wix/products/inventory Schlüssel + Träger

Quickly update Wix prices, inventory or visibility.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Lightweight price, inventory or visibility updates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/products/archive Schlüssel + Träger

Archive deleted Wix products.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

entity_type enum Optional

product | category | subcategory

items array Erforderlich

External Wix identifiers to archive.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/customers/sync Schlüssel + Träger

Synchronise Wix contacts without sending email.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Up to 250 contacts; no SellViaApp email is sent.

items[].external_id String Erforderlich

Wix contact identifier.

items[].username String Erforderlich

Email or fallback username.

items[].active Boolestan Optional

true for synchronised contacts.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/customers/redact Schlüssel + Träger

Redact one or more synchronised Wix contacts.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

all Boolestan Optional

Redact all contacts originating from Wix.

items array Optional

External Wix identifiers to redact when all is false.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/privacy/shop-redact Schlüssel + Träger

Remove Wix-origin data after uninstall.

Input

Available parameters

JSON-Body

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/orders/feed Schlüssel + Träger

Read SellViaApp orders to reconcile with Wix.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

cursor String Optional

Opaque cursor from the previous page.

updated_since datetime Optional

Optional ISO 8601 date.

limit Ganzzahl Optional

1–100

unacknowledged_only Boolestan Optional

Defaults to true to prevent duplicates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/orders/acknowledge Schlüssel + Träger

Record the result of a Wix order reconciliation.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Reconciliation results.

items[].order_guid String Erforderlich

SellViaApp order GUID.

items[].external_order_id String Optional

Linked Wix order identifier.

items[].status enum Erforderlich

imported | failed | ignored

items[].error String Optional

Readable error when processing fails.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/webhooks/subscribe Schlüssel + Träger

Create a signed SellViaApp destination for the Wix connector.

Input

JSON-Body

NameArt der ArtRequirementBeschreibung

target_url url Erforderlich

HTTPS URL of the receiving system.

events array Optional

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

Output

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/webhooks/list Schlüssel + Träger

List SellViaApp webhooks for the Wix connector.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /wix/webhooks/delete Schlüssel + Träger

Disable a Wix connector webhook.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Webhook ID

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/webhooks/process Schlüssel + Träger

Process pending SellViaApp deliveries for Wix.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Maximum number of deliveries.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/sync/logs Schlüssel + Träger

View the isolated Wix synchronisation log.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Reference

Responses and errors

Each row has a “Parameters and responses” button showing required or optional fields, possible statuses and JSON examples. An empty list means the resource is not populated yet, not that the endpoint is down.

400Antrag auf Ungültigkeit

401Authentifizierung erforderlich

403Zugang verweigert

404Ressource oder Route nicht gefunden

409Geschäftskonflikt

422Validierung fehlgeschlagen

429Zu viele Anfragen

5xxTechnische Störung

API-Arbeitsbereich

Endpoint

GET

URL-ParameterEin Parameter pro Zeile: name=wert JSON-BodyBearbeiten Sie die Beispielwerte vor dem Test.

Der erzeugte Code enthält die eingegebenen Zugangsdaten. Bewahren Sie sie serverseitig auf und teilen Sie niemals einen ungeschwärzten Screenshot.

API-Antwort