Documentazione del fornitore

Feed your app e recuperare gli ordini tramite l'API.

Collegare la piattaforma ERP, e-commerce, POS o software aziendale a SellViaApp. Invia categorie, prodotti e prezzi, quindi recuperare gli ordini di negozio confermati come JSON.

URL della basehttps://api.sellviaapp.com/

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Avvio rapido

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)

Punti di fine

Clienti

Creare e gestire account clienti per ogni negozio.

5 routes

POST /customer/add Chiave API

Crea un cliente e genera il login del fornitore.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

nom stringa Obbligatorio

Il cognome del cliente.

prenom stringa Obbligatorio

Nome del cliente.

email email Obbligatorio

Email unica all'interno del fornitore.

denomination stringa Optional

Nome della società, facoltativo.

password stringa Obbligatorio

Almeno otto personaggi.

address stringa Optional

Postal address.

zipcode stringa Optional

Postal code.

city stringa Optional

City.

country stringa Optional

Country.

phone stringa Optional

Phone number.

cellphone stringa Optional

Mobile phone number.

vat_number stringa Optional

VAT number.

language stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Elenca o filtra le informazioni dei clienti autorizzate.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Recupera il profilo del cliente autenticato.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Profilo di aggiornamento, lingua, tipo, email o password.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

first_name stringa Optional

First name.

last_name stringa Optional

Last name.

company stringa Optional

Company name.

email email Optional

New email address, unique within the shop.

address stringa Optional

Postal address.

zipcode stringa Optional

Postal code.

city stringa Optional

City.

country stringa Optional

Country.

phone stringa Optional

Phone number.

cellphone stringa Optional

Mobile phone number.

vat_number stringa Optional

VAT number.

language stringa Optional

Two-letter ISO language code.

account_type enumera Optional

company | individual

notifications_enabled boolean Optional

Allow mobile notifications.

password stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Disattivare l'account cliente nel negozio attivo.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

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

Punti di fine

Catalogo

Categorie, prodotti, immagini, prezzi, stock, promozioni e favoriti.

18 routes

GET /fam1/list Chiave + Cuscinetto

Elenca le categorie primarie.

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

5xxxxTemporary 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 Chiave + Cuscinetto

Creare una categoria primaria.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

name stringa Obbligatorio

Visible category name.

external_key stringa Optional

Stable identifier from your software.

sort_order Integer Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiorna una categoria primaria.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Identifier of the category to update.

name stringa Obbligatorio

Visible category name.

external_key stringa Optional

Stable identifier from your software.

sort_order Integer Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Nascondere una categoria primaria.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Elenca le sottocategorie.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

category_id Integer Optional

Limit results to one primary category.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Crea una sottocategoria.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

category_id Integer Obbligatorio

Parent primary category identifier.

name stringa Obbligatorio

Visible category name.

external_key stringa Optional

Stable identifier from your software.

sort_order Integer Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiorna una sottocategoria.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Identifier of the subcategory to update.

name stringa Obbligatorio

Visible category name.

external_key stringa Optional

Stable identifier from your software.

sort_order Integer Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Nascondi una sottocategoria.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Elenco e ricerca prodotti con impaginazione.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

customer_id Integer Optional

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

search stringa Optional

Cerca per codice, nome o descrizione.

category_id Integer Optional

Filtro di categoria primario.

subcategory_id Integer Optional

Filtro sottocategoria.

price_group stringa Optional

Customer price group.

favorites boolean Optional

Return favourites only.

promotions boolean Optional

Return active promotions only.

new boolean Optional

Return new products only.

progressive boolean Optional

Fast pagination without calculating the total count.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 URL del registro

Servire un'immagine firmata e memorizzabile del prodotto.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

supplier stringa Obbligatorio

Public shop suffix.

id Integer Obbligatorio

Product identifier.

slot Integer Optional

Image slot from 1 to 5.

signature stringa Obbligatorio

Signed-link signature returned by product/list.

variant enumera 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

5xxxxTemporary 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 Chiave + Cuscinetto

Creare un prodotto.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

code stringa Obbligatorio

Codice prodotto unico all'interno del negozio.

name stringa Obbligatorio

Nome visualizzato nell'app.

description stringa Optional

Descrizione dettagliata del prodotto.

base_price decimale Optional

Prezzo di vendita escluso tassa in base alla vostra configurazione.

vat_rate decimale Optional

Tassi IVA, ad esempio 21.

category_id Integer Optional

Primary category identifier.

subcategory_id Integer Optional

Subcategory identifier.

external_key stringa Optional

Identificatore stabile dal tuo ERP.

unit stringa Optional

Unit code, for example pc.

unit_name stringa Optional

Human-readable unit name.

image_url url Optional

URL HTTPS dell'immagine principale.

is_new boolean Optional

Highlight the product as new.

active boolean Optional

Controlla la visibilità del prodotto.

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

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiorna un prodotto.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Identifier of the product to update.

code stringa Obbligatorio

Codice prodotto unico all'interno del negozio.

name stringa Obbligatorio

Nome visualizzato nell'app.

description stringa Optional

Descrizione dettagliata del prodotto.

base_price decimale Optional

Prezzo di vendita escluso tassa in base alla vostra configurazione.

vat_rate decimale Optional

Tassi IVA, ad esempio 21.

category_id Integer Optional

Primary category identifier.

subcategory_id Integer Optional

Subcategory identifier.

external_key stringa Optional

Identificatore stabile dal tuo ERP.

unit stringa Optional

Unit code, for example pc.

unit_name stringa Optional

Human-readable unit name.

image_url url Optional

URL HTTPS dell'immagine principale.

is_new boolean Optional

Highlight the product as new.

active boolean Optional

Controlla la visibilità del prodotto.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Nascondi un prodotto.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiungere o rimuovere un prodotto dai preferiti.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

product_id Integer Obbligatorio

Product identifier.

favorite boolean Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

product_id Integer Optional

Limit results to one product.

price_group stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Elenca le marche disponibili.

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

5xxxxTemporary 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 Chiave + Cuscinetto

Elenco disponibili dimensioni.

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

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

Punti di fine

Carico e ordini

Gestisci il carrello e confermi un ordine atomico.

10 routes

GET /order/list Chiave + Cuscinetto

List every confirmed shop order with pagination.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

customer_id Integer Optional

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

guid stringa Optional

Filter a confirmed order by GUID.

from_date data 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

5xxxxTemporary 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 Chiave + Cuscinetto

Cancellare ed eliminare il carrello corrente.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Calcola il carrello subtotale, IVA e totale.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

delivery_mode enumera Obbligatorio

pickup | delivery

delivery_country stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Conta le linee nel carrello.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Confermare l'ordine, la modalità di esecuzione e l'indirizzo.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

order_guid Uuid Optional

GUID del carrello da confermare.

delivery_mode enumera Obbligatorio

pickup | delivery

delivery_address stringa Optional

Richiesto per la consegna.

delivery_country stringa Optional

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

delivery_date data Optional

YYYYY-MM-DD

delivery_comment stringa Optional

Istruzioni di adempimento.

language stringa Optional

Linguaggio e-mail transazionale.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiungere un prodotto e la quantità al carrello.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

product_id Integer Obbligatorio

Identifier of the product to add.

quantity decimale Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Recuperare le linee di carrello correnti.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiornare una quantità di linea.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

item_id Integer Obbligatorio

Cart line identifier.

quantity decimale Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Rimuovere una linea dal carrello.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

item_id Integer Obbligatorio

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

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

Punti di fine

Customer payments

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

4 routes

GET /payment/config Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

purpose_type enumera Obbligatorio

order | booking

purpose_id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

purpose_type enumera Obbligatorio

order | booking

purpose_id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

reference stringa Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enumera Optional

order | booking

purpose_id Integer Optional

Paid object identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

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

Punti di fine

Documenti

Fatture, stime, ordini e loro linee.

8 routes

POST /document/add Chiave + Cuscinetto

Creare un documento legato al cliente.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

doc_type stringa Optional

invoice | estimate | purchase_order

doc_number stringa Optional

Document number; generated automatically when omitted on creation.

doc_date data Optional

YYYYY-MM-DD

due_date data Optional

YYYYY-MM-DD

payment_method stringa Optional

Metodo di pagamento.

remark stringa Optional

Osservazione libera.

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

5xxxxTemporary 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 Chiave + Cuscinetto

Elenca o filtra i documenti.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

doc_type stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiornare un documento identificato da GUID.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

document_guid Uuid Obbligatorio

GUID of the document to update.

doc_type stringa Optional

invoice | estimate | purchase_order

doc_number stringa Optional

Document number; generated automatically when omitted on creation.

doc_date data Optional

YYYYY-MM-DD

due_date data Optional

YYYYY-MM-DD

payment_method stringa Optional

Metodo di pagamento.

remark stringa Optional

Osservazione libera.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Eliminare un documento e le sue linee.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

document_guid Uuid Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiungere una riga e ricalcolare il documento.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

document_guid Uuid Obbligatorio

Documento di ricerca.

text stringa Optional

Descrizione della linea.

quantity decimale Optional

Quantity, default 1.

unit_price decimale Optional

Prezzo unitario IVA esclusa.

vat_rate decimale Optional

VAT rate, default 21.

discount_percentage decimale Optional

Percentuale di sconto.

product_code stringa Optional

Associated product code.

product_id Integer Optional

Associated product identifier.

packages decimale 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

5xxxxTemporary 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 Chiave + Cuscinetto

Recuperare un documento con tutte le sue linee.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

guid Uuid Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Aggiorna una linea identificata da GUID.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

document_guid Uuid Obbligatorio

Documento di ricerca.

line_guid Uuid Obbligatorio

GUID of the line to update.

text stringa Optional

Descrizione della linea.

quantity decimale Optional

Quantity, default 1.

unit_price decimale Optional

Prezzo unitario IVA esclusa.

vat_rate decimale Optional

VAT rate, default 21.

discount_percentage decimale Optional

Percentuale di sconto.

product_code stringa Optional

Associated product code.

product_id Integer Optional

Associated product identifier.

packages decimale 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

5xxxxTemporary 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 Chiave + Cuscinetto

Eliminare una linea e ricalcolare i totali.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

document_guid Uuid Obbligatorio

Documento di ricerca.

line_guid Uuid Obbligatorio

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

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

Punti di fine

Real-time webhooks

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

10 routes

GET /webhooks/events Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

Create an HTTPS destination and receive its signing secret once.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

label stringa Obbligatorio

Internal name for this destination.

target_url url Obbligatorio

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

events array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Update the destination, events or pause delivery.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Destination identifier.

label stringa Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

New event selection.

status enumera 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

5xxxxTemporary 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 Chiave + Cuscinetto

Soft-delete a destination.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Replace the HMAC secret and reveal it once.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Inspect deliveries, responses, errors and attempts.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

status enumera Optional

pending | processing | retry | delivered | failed

endpoint_id Integer Optional

Limit results to one destination.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Retry one delivery without replaying the others.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Emit and deliver a signed test event.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

endpoint_id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

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

Punti di fine

Notifications and integrations

Mobile notifications and external synchronisation.

47 routes

GET /admin/notification/sendtomobile Chiave + Cuscinetto

Recuperare le notifiche mobili.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Segna una notifica come consegnata.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

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

guid stringa Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Batch-sync WooCommerce categories and subcategories.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

items[].external_id stringa Obbligatorio

Stable WooCommerce identifier.

items[].name stringa Obbligatorio

Visible name.

items[].parent_external_id stringa Optional

Parent category identifier.

items[].sort_order Integer Optional

Display order.

items[].images array Optional

Up to five HTTPS URLs.

items[].active boolean Optional

false archives the category.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 products or variations per batch.

items[].external_id stringa Obbligatorio

Stable WooCommerce identifier used for deduplication.

items[].type enumera Optional

simple | variable | variation

items[].parent_external_id stringa Optional

Parent product for a variation.

items[].sku stringa Optional

SKU; a fallback code is generated when omitted.

items[].name stringa Obbligatorio

Product name.

items[].description stringa Optional

Product description.

items[].regular_price decimale Optional

Regular price.

items[].sale_price decimale Optional

Sale price.

items[].date_on_sale_from data Optional

ISO 8601 sale start.

items[].date_on_sale_to data Optional

ISO 8601 sale end.

items[].vat_rate decimale Optional

Tassi IVA.

items[].stock_quantity Integer Optional

Available stock.

items[].category_external_id stringa Optional

Synchronised primary category.

items[].subcategory_external_id stringa Optional

Synchronised subcategory.

items[].images array Optional

Up to five HTTPS images.

items[].attributes array Optional

WooCommerce variation attributes.

items[].active boolean Optional

Visibility in SellViaApp.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Create or update WooCommerce customer accounts without sending email.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

items[].external_id stringa Obbligatorio

Stable WooCommerce user identifier.

items[].username stringa Obbligatorio

WooCommerce username preserved exactly in client.login.

items[].email email Optional

Customer email address used for deduplication.

items[].first_name stringa Optional

Nome del cliente.

items[].last_name stringa Optional

Il cognome del cliente.

items[].company stringa Optional

Company or business name.

items[].phone stringa Optional

Phone number.

items[].vat_number stringa Optional

VAT number.

items[].language iso-639-1 Optional

Two-letter language; English by default.

items[].billing object Optional

Full WooCommerce billing address.

items[].shipping object Optional

Shipping address retained in synchronisation metadata.

items[].active boolean Optional

Account active state.

items[].send_email boolean Optional

Must remain false. This route never sends email.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Quickly update prices, promotions, stock or visibility only.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 500 lightweight updates.

items[].external_id stringa Obbligatorio

Previously synchronised product.

items[].stock_quantity Integer Optional

New quantity.

items[].regular_price decimale Optional

New regular price.

items[].sale_price decimale Optional

New sale price.

items[].active boolean Optional

New visibility.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Batch-archive deleted WooCommerce products without changing orders.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

entity_type enumera Optional

product | category | subcategory

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Retrieve confirmed orders with cursor-based reconciliation.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

cursor stringa Optional

Opaque cursor returned by the previous response.

updated_since datetime Optional

ISO 8601 starting date.

limit Integer Optional

1 to 100 orders.

unacknowledged_only boolean Optional

Defaults to true to prevent duplicates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Confirm that an order was imported into WooCommerce.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Orders processed by WooCommerce.

items[].order_guid stringa Obbligatorio

SellViaApp GUID returned by the feed.

items[].external_order_id stringa Optional

WooCommerce order identifier.

items[].status enumera Obbligatorio

imported | failed | ignored

items[].error stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Input

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

target_url url Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

Disable a WooCommerce webhook.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Process pending webhook deliveries with automatic retries.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

Maximum deliveries to process.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

View the technical synchronisation log.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Sync Shopify collections and product types.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 500 collections or product types.

items[].external_id stringa Obbligatorio

Stable Shopify GID.

items[].name stringa Obbligatorio

Visible name.

items[].parent_external_id stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Archive a deleted Shopify collection.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 Shopify variants per batch.

items[].external_id stringa Obbligatorio

Variant GID.

items[].parent_external_id stringa Optional

Parent product GID.

items[].sku stringa Optional

SKU

items[].name stringa Obbligatorio

Product and variant title.

items[].regular_price decimale Optional

Regular or compare-at price.

items[].sale_price decimale Optional

Active sale price.

items[].stock_quantity Integer Optional

Available quantity.

items[].images array Optional

Up to five HTTPS images.

items[].active boolean Optional

SellViaApp visibility.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Quickly update Shopify prices, inventory or visibility.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Archive Shopify variants by identifier.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Archive every variant of a deleted Shopify product.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Sync Shopify customers without sending email.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 customers; no email is sent.

items[].external_id stringa Obbligatorio

Shopify customer GID.

items[].username stringa Obbligatorio

Username used in SellViaApp.

items[].email email Optional

Customer email.

items[].send_email boolean Optional

Must remain false.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Redact customer data requested by Shopify.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Optional

Customer GIDs to redact.

all boolean Optional

Redacts all Shopify customers for shop/redact.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Retrieve SellViaApp orders not yet imported into Shopify.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

cursor stringa Optional

Opaque cursor.

limit Integer Optional

1–100

unacknowledged_only boolean Optional

true recommended.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Acknowledge a Shopify order import.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Imported orders.

items[].order_guid stringa Obbligatorio

SellViaApp GUID.

items[].external_order_id stringa Optional

Created Shopify GID.

items[].status enumera Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Input

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

target_url url Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

Disable a Shopify webhook.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Retry pending Shopify notifications.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

Maximum count.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

View Shopify logs isolated from WooCommerce.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Pubblico

Connect a Wix instance to an existing SellViaApp Dashboard account.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

email email Obbligatorio

Email used to sign in to the SellViaApp Dashboard.

password stringa Obbligatorio

Verified once and never stored by the connector.

instance_id stringa Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

Revoke the connector token and disconnect Wix.

Input

Available parameters

Corpo JSON

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

5xxxxTemporary 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 Chiave + Cuscinetto

Synchronise Wix Stores V1/V3 categories or collections.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 500 Wix categories or collections per batch.

items[].external_id stringa Obbligatorio

Stable Wix identifier.

items[].name stringa Obbligatorio

Nome visualizzato nell'app.

items[].parent_external_id stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

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

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 Wix products or variants per batch.

items[].external_id stringa Obbligatorio

Wix product or variant identifier.

items[].parent_external_id stringa Optional

Parent product of a variant.

items[].sku stringa Optional

SKU

items[].name stringa Obbligatorio

Product title.

items[].regular_price decimale Optional

Regular price.

items[].sale_price decimale Optional

Active sale price.

items[].stock_quantity Integer Optional

Available stock.

items[].images array Optional

Up to five HTTPS images.

items[].visible boolean Optional

Visibility in SellViaApp.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Quickly update Wix prices, inventory or visibility.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Archive deleted Wix products.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

entity_type enumera Optional

product | category | subcategory

items array Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Synchronise Wix contacts without sending email.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 contacts; no SellViaApp email is sent.

items[].external_id stringa Obbligatorio

Wix contact identifier.

items[].username stringa Obbligatorio

Email or fallback username.

items[].active boolean Optional

true for synchronised contacts.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Redact one or more synchronised Wix contacts.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

all boolean Optional

Redact all contacts originating from Wix.

items array Optional

External Wix identifiers to redact when all is false.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Remove Wix-origin data after uninstall.

Input

Available parameters

Corpo JSON

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

5xxxxTemporary 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 Chiave + Cuscinetto

Read SellViaApp orders to reconcile with Wix.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

cursor stringa Optional

Opaque cursor from the previous page.

updated_since datetime Optional

Optional ISO 8601 date.

limit Integer Optional

1–100

unacknowledged_only boolean Optional

Defaults to true to prevent duplicates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

Record the result of a Wix order reconciliation.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Reconciliation results.

items[].order_guid stringa Obbligatorio

SellViaApp order GUID.

items[].external_order_id stringa Optional

Linked Wix order identifier.

items[].status enumera Obbligatorio

imported | failed | ignored

items[].error stringa 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

5xxxxTemporary 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 Chiave + Cuscinetto

Create a signed SellViaApp destination for the Wix connector.

Input

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

target_url url Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

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

5xxxxTemporary 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 Chiave + Cuscinetto

Disable a Wix connector webhook.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

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

5xxxxTemporary 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 Chiave + Cuscinetto

Process pending SellViaApp deliveries for Wix.

Input

Available parameters

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

Maximum number of deliveries.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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 Chiave + Cuscinetto

View the isolated Wix synchronisation log.

Input

Available parameters

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxxxTemporary 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.

400Richiesta non valida

401Autenticazione richiesta

403Accesso negato

404Risorse o percorso non trovato

409conflitto commerciale

422Mancato il mancato convalida

429Troppe richieste

5xxxxIncidenza tecnica

Area di lavoro API

Endpoint

GET

Parametri URLUn parametro per riga: nome=valore Corpo JSONModifica i valori di esempio prima del test.

Il codice generato contiene le credenziali inserite. Conservale sul server e non condividere mai uno screenshot senza oscurarle.

Risposta API