Documentación de proveedores

Alimenta tu aplicación y recupera pedidos a través de la API

Conecta tu ERP, plataforma de comercio electrónico, POS o software de negocios para SellViaApp. Enviar categorías, productos y precios, luego recuperar pedidos confirmados de compra como JSON.

Base URLhttps://api.sellviaapp.com/

Cabeceras requeridasX-API-Key + Bearer

Contrato legible por máquina · JSONOpenAPI 3.1 · Descargar ↓ Contrato legible por máquina · YAMLOpenAPI 3.1 · Descargar ↓ Apoyo a los desarrolladoresapi@sellviaapp.com

Inicio rápido

Autentizar, elegir una ruta, probar.

Obtenga el X-API-Key y genere el token Bearer en Dashboard → API. Introduzca ambos abajo. Después, pulse «Probar · Generar» en un endpoint para ver la respuesta y el código de ejemplo en cURL, PHP 8 o JavaScript.

X-API-Key

Bearer token

Credenciales incompletasIntroduzca el token X-API-Key y Bearer para preparar una prueba.

Las credenciales permanecen en memoria sólo para esta página. Para una operación relacionada con el cliente, añadir customer_id.

Keep in mindHTTPS + JSON · mantener ambas credenciales lado servidor · nunca enviar fichas para apoyar.

Real time

Connect SellViaApp to any HTTPS-capable system.

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

Create the destination

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

Verify the signature

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

Acknowledge quickly

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

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

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

Puntos finales

Clientes

Crear y gestionar cuentas de clientes para cada tienda.

5 routes

POST /customer/add Clave de API

Cree un cliente y genere el acceso del proveedor.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

nom cuerda Necesidad

El apellido del cliente.

prenom cuerda Necesidad

Nombre de pila del cliente.

email email Necesidad

Correo electrónico único dentro del proveedor.

denomination cuerda Optional

Nombre de la compañía, opcional.

password cuerda Necesidad

Al menos ocho personajes.

address cuerda Optional

Postal address.

zipcode cuerda Optional

Postal code.

city cuerda Optional

City.

country cuerda Optional

Country.

phone cuerda Optional

Phone number.

cellphone cuerda Optional

Mobile phone number.

vat_number cuerda Optional

VAT number.

language cuerda Optional

Two-letter ISO language code.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Lista o filtro de información autorizada al cliente.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Recuperar el perfil de cliente firmado.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Actualizar perfil, idioma, tipo, correo electrónico o contraseña.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

first_name cuerda Optional

First name.

last_name cuerda Optional

Last name.

company cuerda Optional

Company name.

email email Optional

New email address, unique within the shop.

address cuerda Optional

Postal address.

zipcode cuerda Optional

Postal code.

city cuerda Optional

City.

country cuerda Optional

Country.

phone cuerda Optional

Phone number.

cellphone cuerda Optional

Mobile phone number.

vat_number cuerda Optional

VAT number.

language cuerda Optional

Two-letter ISO language code.

account_type enum Optional

company | individual

notifications_enabled boolean Optional

Allow mobile notifications.

password cuerda Optional

New password, at least eight characters.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Desactivar la cuenta de cliente en la tienda activa.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Puntos finales

Catálogo

Categorías, productos, imágenes, precios, stock, promociones y favoritos.

28 routes

GET /fam1/list Llav + portador

Lista de categorías primarias.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Crear una categoría primaria.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

name cuerda Necesidad

Visible category name.

external_key cuerda Optional

Stable identifier from your software.

sort_order entero Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Actualizar una categoría primaria.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Identifier of the category to update.

name cuerda Necesidad

Visible category name.

external_key cuerda Optional

Stable identifier from your software.

sort_order entero Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Esconder una categoría primaria.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Identifier of the category to hide.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Lista subcategorías.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

category_id entero Optional

Limit results to one primary category.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Cree una subcategoría.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

category_id entero Necesidad

Parent primary category identifier.

name cuerda Necesidad

Visible category name.

external_key cuerda Optional

Stable identifier from your software.

sort_order entero Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Actualice una subcategoría.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Identifier of the subcategory to update.

name cuerda Necesidad

Visible category name.

external_key cuerda Optional

Stable identifier from your software.

sort_order entero Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Ocultar una subcategoría.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Identifier of the subcategory to hide.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Listar y buscar productos con paginación.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

search cuerda Optional

Buscar por código, nombre o descripción.

category_id entero Optional

Filtro de categoría primaria.

subcategory_id entero Optional

Filtro subcategoría.

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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Retrieve a product’s variant groups and combinations.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

product_id entero Necesidad

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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Replace a product’s variant groups and combinations.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

product_id entero Necesidad

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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Retrieve a product’s option groups and optional extras.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

product_id entero Necesidad

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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Replace a product’s option groups and optional extras.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

product_id entero Necesidad

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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Servir una imagen de producto firmada y cacheable.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

supplier cuerda Necesidad

Public shop suffix.

id entero Necesidad

Product identifier.

slot entero Optional

Image slot from 1 to 5.

signature cuerda Necesidad

Signed-link signature returned by product/list.

variant enum Optional

small | thumb | large

Output

Posibles resultados

200Binary image with its MIME type

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Invalid signed link

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

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 Llav + portador

Cree un producto.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

code cuerda Necesidad

Código de producto único dentro de la tienda.

name cuerda Necesidad

Nombre mostrado en la aplicación.

description cuerda Optional

Descripción detallada del producto.

base_price decimal Optional

Precio de venta excluyendo el impuesto según su configuración.

vat_rate decimal Optional

Tasa de IVA, por ejemplo 21.

category_id entero Optional

Primary category identifier.

subcategory_id entero Optional

Subcategory identifier.

external_key cuerda Optional

Identificador estable de su ERP.

unit cuerda Optional

Unit code, for example pc.

unit_name cuerda Optional

Human-readable unit name.

image_url url Optional

URL HTTPS de la imagen principal.

is_new boolean Optional

Highlight the product as new.

active boolean Optional

Controla la visibilidad del producto.

action_type enum Optional

cart | auction | inquiry

auction.start_price decimal Optional

Required starting price when action_type is auction.

auction.buy_now_price decimal Optional

Optional buy-now price.

auction.minimum_increment decimal 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 cuerda Optional

Auction-specific terms, maximum 5,000 characters.

inquiry.prompt cuerda Optional

Information-request prompt, maximum 1,000 characters.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Actualizar un producto.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Identifier of the product to update.

code cuerda Necesidad

Código de producto único dentro de la tienda.

name cuerda Necesidad

Nombre mostrado en la aplicación.

description cuerda Optional

Descripción detallada del producto.

base_price decimal Optional

Precio de venta excluyendo el impuesto según su configuración.

vat_rate decimal Optional

Tasa de IVA, por ejemplo 21.

category_id entero Optional

Primary category identifier.

subcategory_id entero Optional

Subcategory identifier.

external_key cuerda Optional

Identificador estable de su ERP.

unit cuerda Optional

Unit code, for example pc.

unit_name cuerda Optional

Human-readable unit name.

image_url url Optional

URL HTTPS de la imagen principal.

is_new boolean Optional

Highlight the product as new.

active boolean Optional

Controla la visibilidad del producto.

action_type enum Optional

cart | auction | inquiry

auction.start_price decimal Optional

Required starting price when action_type is auction.

auction.buy_now_price decimal Optional

Optional buy-now price.

auction.minimum_increment decimal 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 cuerda Optional

Auction-specific terms, maximum 5,000 characters.

inquiry.prompt cuerda Optional

Information-request prompt, maximum 1,000 characters.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Retrieve a product action type and its settings.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

product_id entero Necesidad

Identifier of the product action to retrieve.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

product_id entero Necesidad

Identifier of the product to configure.

action_type enum Necesidad

cart | auction | inquiry

auction.start_price decimal Optional

Required starting price for auction.

auction.buy_now_price decimal Optional

Optional buy-now price.

auction.minimum_increment decimal 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 cuerda Optional

Terms, maximum 5,000 characters.

inquiry.prompt cuerda Optional

Optional prompt, maximum 1,000 characters.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Ocultar un producto.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Identifier of the product to hide.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Añadir o quitar un producto de los favoritos.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Necesidad

Product identifier.

favorite boolean Optional

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

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Retrieve an auction state and anonymised bid history.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Necesidad

Identifier of the auction product.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Place a bid with atomic minimum-amount validation.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Necesidad

Identifier of the auction product.

amount decimal Necesidad

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

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Buy now and atomically close the auction.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Necesidad

Identifier of the product with buy now enabled.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Send an information request linked to a product.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Necesidad

Identifier of the related product.

message cuerda Necesidad

Customer question, 5 to 5,000 characters.

name cuerda Optional

Contact name; defaults to the signed-in profile.

email email Optional

Reply email; either email or phone is required.

phone cuerda Optional

Reply phone; either email or phone is required.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

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

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Optional

Limit results to one product.

price_group cuerda Optional

Price group, defaults to 01.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Lista de marcas disponibles.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Lista de tamaños disponibles.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

List web reference labels, falling back to catalogue labels.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Puntos finales

Carrito y pedidos

Administrar el carrito y confirmar un pedido atómico.

14 routes

GET /order/list Llav + portador

List every confirmed shop order with pagination.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

guid cuerda Optional

Filter a confirmed order by GUID.

from_date Fecha Optional

Filter from this date using YYYY-MM-DD.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Limpiar y eliminar el carro actual.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Calcular el subtotal de la cesta, IVA y total.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

promotion_code cuerda Necesidad

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

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

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

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

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

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

loyalty_points entero Necesidad

Number of points the customer wants to redeem.

delivery_mode enum Necesidad

pickup | delivery

delivery_country cuerda Optional

Country used to recalculate shipping fees.

promotion_code cuerda Optional

Optional promotion code applied before the loyalty discount.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

delivery_mode enum Necesidad

pickup | delivery

delivery_country cuerda Optional

Two-letter ISO code or delivery-country name.

promotion_code cuerda Optional

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

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Cuenta líneas en el carro.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

order_guid uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu Optional

GUID del carro para confirmar.

delivery_mode enum Necesidad

pickup | delivery

delivery_address cuerda Optional

Se requiere para el envío.

stock_site_id entero 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 cuerda Optional

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

delivery_date Fecha Optional

YYYY-MM-DD

delivery_comment cuerda Optional

Instrucciones de Fulfilment.

language cuerda Optional

Lenguaje de correo electrónico transaccional.

promotion_code cuerda Optional

Optional code, revalidated and redeemed atomically during confirmation.

loyalty_points entero Optional

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

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Añadir un producto y cantidad a la cesta.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

product_id entero Necesidad

Identifier of the product to add.

quantity decimal Necesidad

Quantity strictly greater than zero.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Recuperar las líneas de carro actuales.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Actualizar una cantidad de línea.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

item_id entero Necesidad

Cart line identifier.

quantity decimal Necesidad

Quantity; zero removes the line.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Quita una línea del carrito.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

item_id entero Necesidad

Identifier of the line to remove.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Puntos finales

Pagos de clientes

Elija pagar en la entrega o abrir un pago seguro de Stripe, luego recuperar su estado verificado por servidor.

4 routes

GET /payment/config Llav + portador

Recuperar los métodos de pago de Stripe habilitados y el proveedor de cuenta de Stripe seleccionado para la aplicación.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Crear o reanudar una página de Checkout de Stripe para un pedido no pagado o reserva propiedad del cliente firmado. Se reemplaza con seguridad una opción de pago por entrega que sigue cambiando.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

purpose_type enum Necesidad

order | booking

purpose_id entero Necesidad

Identificador del pedido confirmado o reserva confirmada por el cliente.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Pago de registro en la entrega o reemplazar un pago de Stripe todavía abierto después de que su sesión sea verificada y expirada de forma segura.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

purpose_type enum Necesidad

order | booking

purpose_id entero Necesidad

Orden autorizada o identificador de reserva.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Recuperar un estado de pago; sólo el webhook firmado Stripe puede confirmarlo como pagado.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

reference cuerda Optional

SellViaApp referencia de pago. De lo contrario, purpose_type y purpose_id.

purpose_type enum Optional

order | booking

purpose_id entero Optional

Identificador de objetos pagados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Puntos finales

Documentos

Facturas, estimaciones, órdenes y sus líneas.

8 routes

POST /document/add Llav + portador

Crear un documento relacionado con el cliente.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

doc_type cuerda Optional

invoice | estimate | purchase_order

doc_number cuerda Optional

Document number; generated automatically when omitted on creation.

doc_date Fecha Optional

YYYY-MM-DD

due_date Fecha Optional

YYYY-MM-DD

payment_method cuerda Optional

Método de pago.

remark cuerda Optional

Nota de forma libre.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Lista o filtración de documentos.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

doc_type cuerda Optional

Filter by document type.

guid uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu Optional

Filter by document GUID.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Actualizar un documento identificado por GUID.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

document_guid uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu Necesidad

GUID of the document to update.

doc_type cuerda Optional

invoice | estimate | purchase_order

doc_number cuerda Optional

Document number; generated automatically when omitted on creation.

doc_date Fecha Optional

YYYY-MM-DD

due_date Fecha Optional

YYYY-MM-DD

payment_method cuerda Optional

Método de pago.

remark cuerda Optional

Nota de forma libre.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Eliminar un documento y sus líneas.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

GUID of the document to delete.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Agregue una línea y recalcule el documento.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Documento GUID.

text cuerda Optional

Descripción de la línea.

quantity decimal Optional

Quantity, default 1.

unit_price decimal Optional

Precio unitario, sin IVA.

vat_rate decimal Optional

VAT rate, default 21.

discount_percentage decimal Optional

Descuento porcentual.

product_code cuerda Optional

Associated product code.

product_id entero Optional

Associated product identifier.

packages decimal Optional

Number of packages.

Output

Posibles resultados

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Recuperar un documento con todas sus líneas.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

GUID of the document whose lines must be retrieved.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Actualizar una línea identificada por GUID.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Documento GUID.

line_guid uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu Necesidad

GUID of the line to update.

text cuerda Optional

Descripción de la línea.

quantity decimal Optional

Quantity, default 1.

unit_price decimal Optional

Precio unitario, sin IVA.

vat_rate decimal Optional

VAT rate, default 21.

discount_percentage decimal Optional

Descuento porcentual.

product_code cuerda Optional

Associated product code.

product_id entero Optional

Associated product identifier.

packages decimal Optional

Number of packages.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Eliminar una línea y recalcular los totales.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Documento GUID.

GUID of the line to delete.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Puntos finales

Real-time webhooks

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

10 routes

GET /webhooks/events Llav + portador

List all available events and the contract version.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

List destinations, status and counters.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Create an HTTPS destination and receive its signing secret once.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

label cuerda Necesidad

Internal name for this destination.

target_url url Necesidad

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

events array Necesidad

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

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Update the destination, events or pause delivery.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Destination identifier.

label cuerda Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

New event selection.

status enum Optional

active | paused

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Soft-delete a destination.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Destination identifier.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Replace the HMAC secret and reveal it once.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Destination identifier.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Inspect deliveries, responses, errors and attempts.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id entero Optional

Limit results to one destination.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Retry one delivery without replaying the others.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Internal delivery identifier.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Emit and deliver a signed test event.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

endpoint_id entero Necesidad

Destination to test.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Retrieve the last thirty days of delivery metrics.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Puntos finales

Notifications and integrations

Mobile notifications and external synchronisation.

64 routes

GET /admin/notification/sendtomobile Llav + portador

Recuperar las notificaciones móviles.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Marcar una notificación como entregada.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Se requiere sólo con un token de integración cuando la operación se dirige a un cliente específico.

guid cuerda Necesidad

Notification GUID token.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

installation_id cuerda Necesidad

Stable random installation ID (48 hex characters).

fid cuerda Necesidad

Firebase Installation ID supplied by the app.

platform enum Necesidad

android | ios

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Remove this shop from push notifications on this device.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

installation_id cuerda Necesidad

Installation to unregister for this account.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

installation_id cuerda Necesidad

Installation acknowledging the notification.

guid cuerda Necesidad

Notification ID for this shop.

event enum Necesidad

received | opened

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Batch-sync WooCommerce categories and subcategories.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

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

items[].external_id cuerda Necesidad

Stable WooCommerce identifier.

items[].name cuerda Necesidad

Visible name.

items[].parent_external_id cuerda Optional

Parent category identifier.

items[].sort_order entero Optional

Display order.

items[].images array Optional

Up to five HTTPS URLs.

items[].active boolean Optional

false archives the category.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 products or variations per batch.

items[].external_id cuerda Necesidad

Stable WooCommerce identifier used for deduplication.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id cuerda Optional

Parent product for a variation.

items[].sku cuerda Optional

SKU; a fallback code is generated when omitted.

items[].name cuerda Necesidad

Product name.

items[].description cuerda Optional

Product description.

items[].regular_price decimal Optional

Regular price.

items[].sale_price decimal Optional

Sale price.

items[].date_on_sale_from Fecha Optional

ISO 8601 sale start.

items[].date_on_sale_to Fecha Optional

ISO 8601 sale end.

items[].vat_rate decimal Optional

Tasa de IVA.

items[].stock_quantity entero Optional

Available stock.

items[].category_external_id cuerda Optional

Synchronised primary category.

items[].subcategory_external_id cuerda 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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Create or update WooCommerce customer accounts without sending email.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

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

items[].external_id cuerda Necesidad

Stable WooCommerce user identifier.

items[].username cuerda Necesidad

WooCommerce username preserved exactly in client.login.

items[].email email Optional

Customer email address used for deduplication.

items[].first_name cuerda Optional

Nombre de pila del cliente.

items[].last_name cuerda Optional

El apellido del cliente.

items[].company cuerda Optional

Company or business name.

items[].phone cuerda Optional

Phone number.

items[].vat_number cuerda 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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Quickly update prices, promotions, stock or visibility only.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 500 lightweight updates.

items[].external_id cuerda Necesidad

Previously synchronised product.

items[].stock_quantity entero Optional

New quantity.

items[].regular_price decimal Optional

New regular price.

items[].sale_price decimal Optional

New sale price.

items[].active boolean Optional

New visibility.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Batch-archive deleted WooCommerce products without changing orders.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

entity_type enum Optional

product | category | subcategory

items array Necesidad

List of up to 500 external identifiers.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Retrieve confirmed orders with cursor-based reconciliation.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

cursor cuerda Optional

Opaque cursor returned by the previous response.

updated_since datetime Optional

ISO 8601 starting date.

limit entero Optional

1 to 100 orders.

unacknowledged_only boolean Optional

Defaults to true to prevent duplicates.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Confirm that an order was imported into WooCommerce.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Orders processed by WooCommerce.

items[].order_guid cuerda Necesidad

SellViaApp GUID returned by the feed.

items[].external_order_id cuerda Optional

WooCommerce order identifier.

items[].status enum Necesidad

imported | failed | ignored

items[].error cuerda Optional

Explanation when import failed.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Input

Cuerpo JSON

NombreTipoRequirementDescripción

target_url url Necesidad

Public HTTPS URL; private networks are rejected.

events array Optional

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

Output

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

List active WooCommerce webhooks.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Disable a WooCommerce webhook.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Webhook identifier.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Process pending webhook deliveries with automatic retries.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

limit entero Optional

Maximum deliveries to process.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

View the technical synchronisation log.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Sync Shopify collections and product types.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 500 collections or product types.

items[].external_id cuerda Necesidad

Stable Shopify GID.

items[].name cuerda Necesidad

Visible name.

items[].parent_external_id cuerda Optional

Parent collection for a product type.

items[].images array Optional

HTTPS URLs.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Archive a deleted Shopify collection.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

GIDs of deleted collections.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 Shopify variants per batch.

items[].external_id cuerda Necesidad

Variant GID.

items[].parent_external_id cuerda Optional

Parent product GID.

items[].sku cuerda Optional

SKU

items[].name cuerda Necesidad

Product and variant title.

items[].regular_price decimal Optional

Regular or compare-at price.

items[].sale_price decimal Optional

Active sale price.

items[].stock_quantity entero Optional

Available quantity.

items[].images array Optional

Up to five HTTPS images.

items[].active boolean Optional

SellViaApp visibility.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Quickly update Shopify prices, inventory or visibility.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 500 lightweight updates.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Archive Shopify variants by identifier.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Variant GIDs to archive.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Archive every variant of a deleted Shopify product.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 100 parent product GIDs.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Sync Shopify customers without sending email.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 customers; no email is sent.

items[].external_id cuerda Necesidad

Shopify customer GID.

items[].username cuerda Necesidad

Username used in SellViaApp.

items[].email email Optional

Customer email.

items[].send_email boolean Optional

Must remain false.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Redact customer data requested by Shopify.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Optional

Customer GIDs to redact.

all boolean Optional

Redacts all Shopify customers for shop/redact.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Retrieve SellViaApp orders not yet imported into Shopify.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

cursor cuerda Optional

Opaque cursor.

limit entero Optional

1–100

unacknowledged_only boolean Optional

true recommended.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Acknowledge a Shopify order import.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Imported orders.

items[].order_guid cuerda Necesidad

SellViaApp GUID.

items[].external_order_id cuerda Optional

Created Shopify GID.

items[].status enum Necesidad

imported | failed | ignored

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Input

Cuerpo JSON

NombreTipoRequirementDescripción

target_url url Necesidad

Connector HTTPS URL.

events array Optional

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

Output

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

List Shopify connector webhooks.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Disable a Shopify webhook.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Webhook ID

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Retry pending Shopify notifications.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

limit entero Optional

Maximum count.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Identify the store and retrieve its mobile test account.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

View Shopify logs isolated from WooCommerce.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Público

Connect a Wix instance to an existing SellViaApp Dashboard account.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

email email Necesidad

Email used to sign in to the SellViaApp Dashboard.

password cuerda Necesidad

Verified once and never stored by the connector.

instance_id cuerda Necesidad

Stable Wix installation identifier.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

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

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Revoke the connector token and disconnect Wix.

Input

Parámetros disponibles

Cuerpo JSON

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Synchronise Wix Stores V1/V3 categories or collections.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 500 Wix categories or collections per batch.

items[].external_id cuerda Necesidad

Stable Wix identifier.

items[].name cuerda Necesidad

Nombre mostrado en la aplicación.

items[].parent_external_id cuerda Optional

Parent category identifier.

items[].image url Optional

HTTPS presentation image.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 Wix products or variants per batch.

items[].external_id cuerda Necesidad

Wix product or variant identifier.

items[].parent_external_id cuerda Optional

Parent product of a variant.

items[].sku cuerda Optional

SKU

items[].name cuerda Necesidad

Product title.

items[].regular_price decimal Optional

Regular price.

items[].sale_price decimal Optional

Active sale price.

items[].stock_quantity entero Optional

Available stock.

items[].images array Optional

Up to five HTTPS images.

items[].visible boolean Optional

Visibility in SellViaApp.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Quickly update Wix prices, inventory or visibility.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Lightweight price, inventory or visibility updates.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Archive deleted Wix products.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

entity_type enum Optional

product | category | subcategory

items array Necesidad

External Wix identifiers to archive.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Synchronise Wix contacts without sending email.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 contacts; no SellViaApp email is sent.

items[].external_id cuerda Necesidad

Wix contact identifier.

items[].username cuerda Necesidad

Email or fallback username.

items[].active boolean Optional

true for synchronised contacts.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Redact one or more synchronised Wix contacts.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

all boolean Optional

Redact all contacts originating from Wix.

items array Optional

External Wix identifiers to redact when all is false.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Remove Wix-origin data after uninstall.

Input

Parámetros disponibles

Cuerpo JSON

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Read SellViaApp orders to reconcile with Wix.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

cursor cuerda Optional

Opaque cursor from the previous page.

updated_since datetime Optional

Optional ISO 8601 date.

limit entero Optional

1–100

unacknowledged_only boolean Optional

Defaults to true to prevent duplicates.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Record the result of a Wix order reconciliation.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Reconciliation results.

items[].order_guid cuerda Necesidad

SellViaApp order GUID.

items[].external_order_id cuerda Optional

Linked Wix order identifier.

items[].status enum Necesidad

imported | failed | ignored

items[].error cuerda Optional

Readable error when processing fails.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Create a signed SellViaApp destination for the Wix connector.

Input

Cuerpo JSON

NombreTipoRequirementDescripción

target_url url Necesidad

HTTPS URL of the receiving system.

events array Optional

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

Output

201Recursos creados

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

List SellViaApp webhooks for the Wix connector.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Disable a Wix connector webhook.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Webhook ID

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Process pending SellViaApp deliveries for Wix.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

limit entero Optional

Maximum number of deliveries.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

View the isolated Wix synchronisation log.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Público

Start an Odoo OAuth authorisation without sharing the SellViaApp password.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

client_id cuerda Necesidad

sellviaapp_odoo

installation_id cuerda Necesidad

Stable UUID for this Odoo installation.

instance_url url Optional

Public HTTPS URL of the Odoo instance.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Público

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

client_id cuerda Necesidad

sellviaapp_odoo

grant_type cuerda Necesidad

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

device_code cuerda Necesidad

Opaque code returned when starting the flow.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Verify the SellViaApp account connected to the Odoo installation.

Input

Parámetros disponibles

URL query

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Immediately revoke this Odoo installation token.

Input

Parámetros disponibles

Cuerpo JSON

No se espera ningún parámetro de negocio. Enviar sólo los encabezados de autenticación indicados.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Synchronise the Odoo category hierarchy.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 500 Odoo categories per batch.

items[].external_id cuerda Necesidad

Stable Odoo identifier.

items[].name cuerda Necesidad

Visible name.

items[].parent_external_id cuerda Optional

Parent category.

items[].translations object Optional

Translated names keyed by language code.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Hide Odoo categories removed from the catalogue.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Root category identifiers to hide.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 Odoo products or variants per batch.

items[].external_id cuerda Necesidad

Stable product.product variant identifier.

items[].parent_external_id cuerda Optional

product.template identifier.

items[].sku cuerda Optional

Odoo internal reference.

items[].barcode cuerda Optional

Barcode.

items[].name cuerda Necesidad

Product or variant name.

items[].description cuerda Optional

Sales description.

items[].regular_price decimal Optional

Odoo sale price.

items[].vat_rate decimal Optional

First applicable VAT rate.

items[].stock_quantity decimal 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

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

Quickly update Odoo prices, stock and visibility.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 500 lightweight price, stock or visibility updates.

items[].external_id cuerda Necesidad

Stable identifier of an already published product.product record.

items[].stock_quantity decimal Optional

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

items[].stock_status enum Optional

instock | outofstock

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Hide removed Odoo products, categories or subcategories.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

entity_type enum Optional

product | category | subcategory

items array Necesidad

External Odoo identifiers to hide.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

Send Odoo contacts to SellViaApp and prepare their mobile access.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Up to 250 Odoo contacts per batch.

items[].external_id cuerda Necesidad

Stable res.partner identifier.

items[].email email Necesidad

Email used for mobile access.

items[].send_invitation boolean Optional

Send the invitation only when creating the account.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

{
    "success": false,
    "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 Llav + portador

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

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

limit entero Optional

From 1 to 100 customers per page.

cursor cuerda Optional

Opaque cursor returned by the previous page.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Retrieve confirmed SellViaApp orders in Odoo.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

limit entero Optional

From 1 to 100 orders per page.

cursor cuerda Optional

Opaque cursor returned by the previous page.

unacknowledged_only boolean Optional

Return only orders not yet imported.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

{
    "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 Llav + portador

Record the result of an Odoo order import.

Input

Parámetros disponibles

Cuerpo JSON

NombreTipoRequirementDescripción

items array Necesidad

Import results with order identifier, status and Odoo reference.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Error example

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

View the isolated Odoo synchronisation log.

Input

Parámetros disponibles

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Número de resultados por página.

Output

Posibles resultados

200Funcionamiento exitoso

400Solicitud inválida o JSON

401Autenticación perdida o inválida

403Acceso insuficiente

404Recursos solicitados no encontrados

409Conflicto con los datos existentes

422Parámetro rechazado por validación

429Límite de solicitud alcanzado

5xxIncidencia técnica temporal

Ejemplo de éxito

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

Respuestas y errores

En «Parámetros y respuestas» encontrará campos obligatorios y opcionales, códigos de estado y ejemplos JSON. Una lista vacía solo indica que todavía no hay datos. No significa que el endpoint haya fallado.

400Solicitud de invalidez

401Autenticación necesaria

403Acceso denegado

404Recursos o ruta no encontrada

409Conflicto comercial

422Falló la validación

429Demasiadas solicitudes

5xxIncidencia técnica

Entorno de trabajo API

Endpoint

GET

Parámetros de URLUn parámetro por línea: nombre=valor Cuerpo JSONModifica los valores de ejemplo antes de probar.

El código generado contiene las credenciales introducidas. Guárdalas en el servidor y nunca compartas una captura sin ocultarlas.

Respuesta de la API