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/

Intestazioni necessarieX-API-Key + Bearer

Contratto di lettura della macchina · JSONOpenAPI 3.1 · Scarica ↓ Contratto di lettura della macchina · YAMLOpenAPI 3.1 · Scarica ↓ Supporto per sviluppatoriapi@sellviaapp.com

Avvio rapido

Autentica, scegli un percorso, prova.

Recupera l’X-API-Key e genera il token Bearer in Dashboard → API. Inseriscili qui sotto. Poi scegli «Testa · Genera» su un endpoint per vedere la risposta e il codice di esempio in cURL, PHP 8 o JavaScript.

X-API-Key

Bearer token

Credenti incompletiImmettere il token X-API-Key e Bearer per preparare un test.

Le credenziali rimangono in memoria solo per questa pagina. Per un'operazione legata al cliente, aggiungere customer_id.

Keep in mindHTTPS + JSON · mantenere entrambe le credenziali lato server · non inviare mai gettoni per supportare.

Real time

Connect SellViaApp to any HTTPS-capable system.

Un webhook avvisa il tuo ERP, CRM o altro sistema quando cambiano prodotti, clienti, carrelli, ordini, documenti o impostazioni importanti. Se serve, recupera l’oggetto completo tramite l’API.

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

Parametri disponibili

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

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

28 routes

GET /fam1/list Chiave + Cuscinetto

Elenca le categorie primarie.

Input

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Identifier of the category to hide.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

category_id Integer Optional

Limit results to one primary category.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Identifier of the subcategory to hide.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

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.

group_variants boolean Optional

Group variants under the parent product and return combinations. Options are also returned.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /product/variants Chiave + Cuscinetto

Retrieve a product’s variant groups and combinations.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

product_id Integer Obbligatorio

Parent product identifier.

groups array Optional

POST only: complete list of 0–3 groups {name, values[]}. An empty array removes variants.

combinations array Optional

POST only: all combinations in group order, each with selections[], sku, price and stock. Maximum 100.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /product/variants Chiave + Cuscinetto

Replace a product’s variant groups and combinations.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

product_id Integer Obbligatorio

Parent product identifier.

groups array Optional

POST only: complete list of 0–3 groups {name, values[]}. An empty array removes variants.

combinations array Optional

POST only: all combinations in group order, each with selections[], sku, price and stock. Maximum 100.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /product/options Chiave + Cuscinetto

Retrieve a product’s option groups and optional extras.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

product_id Integer Obbligatorio

Parent product identifier.

groups array Optional

POST only: complete list of 0–10 groups {id, name, selection_mode, options[]}. An empty array removes options.

groups[].options[] array Optional

Each option: existing id or 0, name, price, quantity_mode (single or quantity), max_quantity (1 or 2–50), optional unit_label; optional image_base64 (JPEG/PNG/WebP, 1 MB) or remove_photo.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /product/options Chiave + Cuscinetto

Replace a product’s option groups and optional extras.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

product_id Integer Obbligatorio

Parent product identifier.

groups array Optional

POST only: complete list of 0–10 groups {id, name, selection_mode, options[]}. An empty array removes options.

groups[].options[] array Optional

Each option: existing id or 0, name, price, quantity_mode (single or quantity), max_quantity (1 or 2–50), optional unit_label; optional image_base64 (JPEG/PNG/WebP, 1 MB) or remove_photo.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Binary image with its MIME type

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Invalid signed link

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

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

Parametri disponibili

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.

action_type enumera Optional

cart | auction | inquiry

auction.start_price decimale Optional

Required starting price when action_type is auction.

auction.buy_now_price decimale Optional

Optional buy-now price.

auction.minimum_increment decimale Optional

Optional minimum bid increment.

auction.starts_at datetime Optional

Optional start as ISO 8601 with timezone.

auction.ends_at datetime Optional

Optional end as ISO 8601 with timezone.

auction.hide_after_end boolean Optional

Hide the product after expiry; requires ends_at.

auction.terms stringa Optional

Auction-specific terms, maximum 5,000 characters.

inquiry.prompt stringa Optional

Information-request prompt, maximum 1,000 characters.

Output

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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.

action_type enumera Optional

cart | auction | inquiry

auction.start_price decimale Optional

Required starting price when action_type is auction.

auction.buy_now_price decimale Optional

Optional buy-now price.

auction.minimum_increment decimale Optional

Optional minimum bid increment.

auction.starts_at datetime Optional

Optional start as ISO 8601 with timezone.

auction.ends_at datetime Optional

Optional end as ISO 8601 with timezone.

auction.hide_after_end boolean Optional

Hide the product after expiry; requires ends_at.

auction.terms stringa Optional

Auction-specific terms, maximum 5,000 characters.

inquiry.prompt stringa Optional

Information-request prompt, maximum 1,000 characters.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /product/action Chiave + Cuscinetto

Retrieve a product action type and its settings.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

product_id Integer Obbligatorio

Identifier of the product action to retrieve.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

PUT /product/action/configure Chiave + Cuscinetto

Configure direct purchase, auction or information request and their settings.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

product_id Integer Obbligatorio

Identifier of the product to configure.

action_type enumera Obbligatorio

cart | auction | inquiry

auction.start_price decimale Optional

Required starting price for auction.

auction.buy_now_price decimale Optional

Optional buy-now price.

auction.minimum_increment decimale Optional

Optional minimum increment.

auction.starts_at datetime Optional

Optional start as ISO 8601 with timezone.

auction.ends_at datetime Optional

Optional end as ISO 8601 with timezone.

auction.hide_after_end boolean Optional

Hide the product after the end date.

auction.terms stringa Optional

Terms, maximum 5,000 characters.

inquiry.prompt stringa Optional

Optional prompt, maximum 1,000 characters.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Identifier of the product to hide.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Obbligatorio

Product identifier.

favorite boolean Optional

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

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /product/auction Chiave + Cuscinetto

Retrieve an auction state and anonymised bid history.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Obbligatorio

Identifier of the auction product.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /product/auction/bid Chiave + Cuscinetto

Place a bid with atomic minimum-amount validation.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Obbligatorio

Identifier of the auction product.

amount decimale Obbligatorio

Bid amount, at least the minimum returned by the server.

Output

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /product/auction/buy-now Chiave + Cuscinetto

Buy now and atomically close the auction.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Obbligatorio

Identifier of the product with buy now enabled.

Output

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /product/inquiry Chiave + Cuscinetto

Send an information request linked to a product.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Obbligatorio

Identifier of the related product.

message stringa Obbligatorio

Customer question, 5 to 5,000 characters.

name stringa Optional

Contact name; defaults to the signed-in profile.

email email Optional

Reply email; either email or phone is required.

phone stringa Optional

Reply phone; either email or phone is required.

Output

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Optional

Limit results to one product.

price_group stringa Optional

Price group, defaults to 01.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

14 routes

GET /order/list Chiave + Cuscinetto

List every confirmed shop order with pagination.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

guid stringa Optional

Filter a confirmed order by GUID.

from_date data Optional

Filter from this date using YYYY-MM-DD.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /promotion/validate Chiave + Cuscinetto

Validate a promotion code against the current cart on the server and calculate net, VAT and total discounts.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

promotion_code stringa Obbligatorio

Code containing 3 to 64 letters, numbers, hyphens or underscores. The server checks dates, usage limit and eligibility.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

{
    "success": true,
    "message": "Promotion code validated",
    "data": {
        "promotion": {
            "id": 12,
            "code": "WELCOME10",
            "name": "Welcome offer",
            "discount_type": "percent",
            "discount_value": 10,
            "scope": "all",
            "currency": "EUR",
            "currency_symbol": "€",
            "eligible_item_count": 2,
            "original_product_total": 60.5,
            "discount_net": 5,
            "discount_tax": 1.05,
            "discount_total": 6.05,
            "subtotal": 45,
            "vat_total": 9.45,
            "product_total": 54.45
        }
    },
    "error": null
}

Error example

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

GET /loyalty/summary Chiave + Cuscinetto

Retrieve the loyalty programme, customer balance and available discount value.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /loyalty/history Chiave + Cuscinetto

List the customer’s earning, redemption, correction and expiry history.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /loyalty/quote Chiave + Cuscinetto

Calculate server-side how many points can be redeemed against the current cart.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

loyalty_points Integer Obbligatorio

Number of points the customer wants to redeem.

delivery_mode enumera Obbligatorio

pickup | delivery

delivery_country stringa Optional

Country used to recalculate shipping fees.

promotion_code stringa Optional

Optional promotion code applied before the loyalty discount.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

delivery_mode enumera Obbligatorio

pickup | delivery

delivery_country stringa Optional

Two-letter ISO code or delivery-country name.

promotion_code stringa Optional

Optional code; the quote recalculates the discount before shipping fees.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

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

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

order_guid Uuid Optional

GUID del carrello da confermare.

delivery_mode enumera Obbligatorio

pickup | delivery

delivery_address stringa Optional

Richiesto per la consegna.

stock_site_id Integer Optional

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

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

promotion_code stringa Optional

Optional code, revalidated and redeemed atomically during confirmation.

loyalty_points Integer Optional

Points to redeem; balance and rules are revalidated and debited atomically.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

product_id Integer Obbligatorio

Identifier of the product to add.

quantity decimale Obbligatorio

Quantity strictly greater than zero.

Output

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

item_id Integer Obbligatorio

Cart line identifier.

quantity decimale Obbligatorio

Quantity; zero removes the line.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

item_id Integer Obbligatorio

Identifier of the line to remove.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Pagamenti dei clienti

Scegliere il pagamento alla consegna o aprire un pagamento sicuro Stripe, quindi recuperare lo stato server-verified.

4 routes

GET /payment/config Chiave + Cuscinetto

Recuperare i metodi di pagamento Stripe abilitati e il fornitore di account Stripe selezionato per l'app.

Input

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Crea o riprendi una pagina Stripe Checkout per un ordine o una prenotazione non pagati del cliente autenticato. Se ancora modificabile, la scelta di pagare alla consegna viene sostituita in modo sicuro.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

purpose_type enumera Obbligatorio

order | booking

purpose_id Integer Obbligatorio

Identificazione dell'ordine confermato o della prenotazione al cliente.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Registrare il pagamento alla consegna o sostituire un pagamento Stripe ancora aperto dopo la sua sessione è controllato e scaduto in modo sicuro.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

purpose_type enumera Obbligatorio

order | booking

purpose_id Integer Obbligatorio

Ordine autorizzato o identificativo di prenotazione.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Recuperare uno stato di pagamento; solo il webhook firmato Stripe può confermare come pagato.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

reference stringa Optional

SellViaApp riferimento di pagamento. In caso contrario, purpose_type e purpose_id.

purpose_type enumera Optional

order | booking

purpose_id Integer Optional

Identificatore oggetto a pagamento.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

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

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

doc_type stringa Optional

Filter by document type.

guid Uuid Optional

Filter by document GUID.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

document_guid Uuid Obbligatorio

GUID of the document to delete.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

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

Risultati possibili

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

guid Uuid Obbligatorio

GUID of the document whose lines must be retrieved.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

document_guid Uuid Obbligatorio

Documento di ricerca.

line_guid Uuid Obbligatorio

GUID of the line to delete.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Destination identifier.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Destination identifier.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

status enumera Optional

pending | processing | retry | delivered | failed

endpoint_id Integer Optional

Limit results to one destination.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Internal delivery identifier.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

endpoint_id Integer Obbligatorio

Destination to test.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

64 routes

GET /admin/notification/sendtomobile Chiave + Cuscinetto

Recuperare le notifiche mobili.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

customer_id Integer Optional

Richiesto solo con un token di integrazione quando l'operazione si rivolge a un cliente specifico.

guid stringa Obbligatorio

Notification GUID token.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /push/device/register Chiave + Cuscinetto

Associate a mobile installation with this customer account for Firebase push.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

installation_id stringa Obbligatorio

Stable random installation ID (48 hex characters).

fid stringa Obbligatorio

Firebase Installation ID supplied by the app.

platform enumera Obbligatorio

android | ios

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /push/device/unregister Chiave + Cuscinetto

Remove this shop from push notifications on this device.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

installation_id stringa Obbligatorio

Installation to unregister for this account.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /push/notification/ack Chiave + Cuscinetto

Acknowledge a notification observed in the app or opened by the customer.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

installation_id stringa Obbligatorio

Installation acknowledging the notification.

guid stringa Obbligatorio

Notification ID for this shop.

event enumera Obbligatorio

received | opened

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

entity_type enumera Optional

product | category | subcategory

items array Obbligatorio

List of up to 500 external identifiers.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Webhook identifier.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

Maximum deliveries to process.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

GIDs of deleted collections.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 500 lightweight updates.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Variant GIDs to archive.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 100 parent product GIDs.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Optional

Customer GIDs to redact.

all boolean Optional

Redacts all Shopify customers for shop/redact.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

cursor stringa Optional

Opaque cursor.

limit Integer Optional

1–100

unacknowledged_only boolean Optional

true recommended.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Webhook ID

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

Maximum count.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Lightweight price, inventory or visibility updates.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

entity_type enumera Optional

product | category | subcategory

items array Obbligatorio

External Wix identifiers to archive.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

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

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

201Risorse create

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

id Integer Obbligatorio

Webhook ID

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

Maximum number of deliveries.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/oauth/device/code Pubblico

Start an Odoo OAuth authorisation without sharing the SellViaApp password.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

client_id stringa Obbligatorio

sellviaapp_odoo

installation_id stringa Obbligatorio

Stable UUID for this Odoo installation.

instance_url url Optional

Public HTTPS URL of the Odoo instance.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/oauth/device/token Pubblico

Exchange an approved device code for a revocable integration access token.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

client_id stringa Obbligatorio

sellviaapp_odoo

grant_type stringa Obbligatorio

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

device_code stringa Obbligatorio

Opaque code returned when starting the flow.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /odoo/account Chiave + Cuscinetto

Verify the SellViaApp account connected to the Odoo installation.

Input

Parametri disponibili

URL query

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/disconnect Chiave + Cuscinetto

Immediately revoke this Odoo installation token.

Input

Parametri disponibili

Corpo JSON

Nessun parametro aziendale è previsto. Invia solo le intestazioni di autenticazione indicate.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/categories/sync Chiave + Cuscinetto

Synchronise the Odoo category hierarchy.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 500 Odoo categories per batch.

items[].external_id stringa Obbligatorio

Stable Odoo identifier.

items[].name stringa Obbligatorio

Visible name.

items[].parent_external_id stringa Optional

Parent category.

items[].translations object Optional

Translated names keyed by language code.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/categories/archive Chiave + Cuscinetto

Hide Odoo categories removed from the catalogue.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Root category identifiers to hide.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/products/sync Chiave + Cuscinetto

Synchronise Odoo variants, references, descriptions, translations, images, prices, VAT and stock.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 Odoo products or variants per batch.

items[].external_id stringa Obbligatorio

Stable product.product variant identifier.

items[].parent_external_id stringa Optional

product.template identifier.

items[].sku stringa Optional

Odoo internal reference.

items[].barcode stringa Optional

Barcode.

items[].name stringa Obbligatorio

Product or variant name.

items[].description stringa Optional

Sales description.

items[].regular_price decimale Optional

Odoo sale price.

items[].vat_rate decimale Optional

First applicable VAT rate.

items[].stock_quantity decimale Optional

Available or on-hand stock according to the Odoo setting.

items[].images array Optional

Up to five signed Odoo HTTPS image URLs.

items[].translations object Optional

Name and description in active Odoo languages.

items[].attributes array Optional

Variant attributes.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

PATCH /odoo/products/inventory Chiave + Cuscinetto

Quickly update Odoo prices, stock and visibility.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 500 lightweight price, stock or visibility updates.

items[].external_id stringa Obbligatorio

Stable identifier of an already published product.product record.

items[].stock_quantity decimale Optional

Available or on-hand quantity according to the Odoo setting.

items[].stock_status enumera Optional

instock | outofstock

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/products/archive Chiave + Cuscinetto

Hide removed Odoo products, categories or subcategories.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

entity_type enumera Optional

product | category | subcategory

items array Obbligatorio

External Odoo identifiers to hide.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/customers/sync Chiave + Cuscinetto

Send Odoo contacts to SellViaApp and prepare their mobile access.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Up to 250 Odoo contacts per batch.

items[].external_id stringa Obbligatorio

Stable res.partner identifier.

items[].email email Obbligatorio

Email used for mobile access.

items[].send_invitation boolean Optional

Send the invitation only when creating the account.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/customers/feed Chiave + Cuscinetto

Retrieve SellViaApp customers for duplicate-safe reconciliation with Odoo contacts.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

From 1 to 100 customers per page.

cursor stringa Optional

Opaque cursor returned by the previous page.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/orders/feed Chiave + Cuscinetto

Retrieve confirmed SellViaApp orders in Odoo.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

limit Integer Optional

From 1 to 100 orders per page.

cursor stringa Optional

Opaque cursor returned by the previous page.

unacknowledged_only boolean Optional

Return only orders not yet imported.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

POST /odoo/orders/acknowledge Chiave + Cuscinetto

Record the result of an Odoo order import.

Input

Parametri disponibili

Corpo JSON

NomeTipo diRequirementDesignazione delle merci

items array Obbligatorio

Import results with order identifier, status and Odoo reference.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Error example

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

GET /odoo/sync/logs Chiave + Cuscinetto

View the isolated Odoo synchronisation log.

Input

Parametri disponibili

URL query

NomeTipo diRequirementDesignazione delle merci

page Integer Optional

Numero di pagina, a partire da 1.

per_page Integer Optional

Numero di risultati per pagina.

Output

Risultati possibili

200Funzionamento di successo

400Richiesta non valida o JSON

401Autenticazione mancante o non valida

403Accesso insufficiente

404risorsa richiesta non trovata

409Conflitto con i dati esistenti

422Parametro respinto per convalida

429Limite di richiesta raggiunto

5xxxxincidente tecnico temporaneo

Esempio di successo

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

Risposte ed errori

In «Parametri e risposte» trovi i campi obbligatori e facoltativi, i codici di stato e gli esempi JSON. Un elenco vuoto indica solo che non ci sono ancora dati. Non significa che l’endpoint non funzioni.

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