Documentação do fornecedor

Alimente seu aplicativo e recupere os pedidos através da API.

Conecte seu ERP, plataforma de e-commerce, POS ou software de negócios para SellViaApp. Envie categorias, produtos e preços, e depois recupere os pedidos confirmados como JSON.

URL basehttps://api.sellviaapp.com/

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Início rápido

Authenticate, choose a route, test.

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

X-API-Key

Bearer token

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

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

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

Real time

Connect SellViaApp to any HTTPS-capable system.

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

Create the destination

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

Verify the signature

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

Acknowledge quickly

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

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

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

Pontos finais

Clientes

Crie e gerencie contas de clientes para cada loja.

5 routes

POST /customer/add Chave da API

Crie um cliente e gere o login do fornecedor.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

nom string Necessário

Sobrenome do cliente.

prenom string Necessário

Primeiro nome do cliente.

email e- mail Necessário

Email único dentro do fornecedor.

denomination string Optional

Nome da empresa, opcional.

password string Necessário

Pelo menos oito caracteres.

address string Optional

Postal address.

zipcode string Optional

Postal code.

city string Optional

City.

country string Optional

Country.

phone string Optional

Phone number.

cellphone string Optional

Mobile phone number.

vat_number string Optional

VAT number.

language string Optional

Two-letter ISO language code.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /customer/list Chave + Carregador

Listar ou filtrar informações autorizadas do cliente.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /customer/me Chave + Carregador

Obtenha o perfil do cliente autenticado.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /customer/update Chave + Carregador

Atualizar perfil, idioma, tipo, e-mail ou senha.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

first_name string Optional

First name.

last_name string Optional

Last name.

company string Optional

Company name.

email e- mail Optional

New email address, unique within the shop.

address string Optional

Postal address.

zipcode string Optional

Postal code.

city string Optional

City.

country string Optional

Country.

phone string Optional

Phone number.

cellphone string Optional

Mobile phone number.

vat_number string Optional

VAT number.

language string Optional

Two-letter ISO language code.

account_type enum Optional

company | individual

notifications_enabled booleano Optional

Allow mobile notifications.

password string Optional

New password, at least eight characters.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /customer/deleteaccount Chave + Carregador

Desativar a conta do cliente na loja ativa.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Pontos finais

Catálogo

Categorias, produtos, imagens, preços, ações, promoções e favoritos.

18 routes

GET /fam1/list Chave + Carregador

Listar as categorias primárias.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /fam1/add Chave + Carregador

Criar uma categoria primária.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

name string Necessário

Visible category name.

external_key string Optional

Stable identifier from your software.

sort_order inteiro Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /fam1/update Chave + Carregador

Atualizar uma categoria primária.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identifier of the category to update.

name string Necessário

Visible category name.

external_key string Optional

Stable identifier from your software.

sort_order inteiro Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /fam1/delete Chave + Carregador

Esconder uma categoria primária.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identifier of the category to hide.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /fam2/list Chave + Carregador

Listar subcategorias.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

category_id inteiro Optional

Limit results to one primary category.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /fam2/add Chave + Carregador

Criar uma subcategoria.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

category_id inteiro Necessário

Parent primary category identifier.

name string Necessário

Visible category name.

external_key string Optional

Stable identifier from your software.

sort_order inteiro Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /fam2/update Chave + Carregador

Actualizar uma subcategoria.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identifier of the subcategory to update.

name string Necessário

Visible category name.

external_key string Optional

Stable identifier from your software.

sort_order inteiro Optional

Display order, starting at 1.

image_url url Optional

HTTPS image URL.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /fam2/delete Chave + Carregador

Esconder uma subcategoria.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identifier of the subcategory to hide.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /product/list Chave + Carregador

Listar e procurar produtos com paginação.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

customer_id inteiro Optional

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

search string Optional

Pesquisa por código, nome ou descrição.

category_id inteiro Optional

Filtro de categoria primária.

subcategory_id inteiro Optional

Filtro de subcategoria.

price_group string Optional

Customer price group.

favorites booleano Optional

Return favourites only.

promotions booleano Optional

Return active promotions only.

new booleano Optional

Return new products only.

progressive booleano Optional

Fast pagination without calculating the total count.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /product/image URL Assinado

Sirva uma imagem de produto assinada e cashável.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

supplier string Necessário

Public shop suffix.

id inteiro Necessário

Product identifier.

slot inteiro Optional

Image slot from 1 to 5.

signature string Necessário

Signed-link signature returned by product/list.

variant enum Optional

small | thumb | large

Output

Possible results

200Binary image with its MIME type

400Invalid request or JSON

401Missing or invalid authentication

403Invalid signed link

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

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

Error example

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

POST /product/add Chave + Carregador

Criar um produto.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

code string Necessário

Código do produto único dentro da loja.

name string Necessário

Nome exibido na aplicação.

description string Optional

Descrição detalhada do produto.

base_price decimal Optional

Preço de venda excluindo imposto de acordo com sua configuração.

vat_rate decimal Optional

Taxa de IVA, por exemplo 21.

category_id inteiro Optional

Primary category identifier.

subcategory_id inteiro Optional

Subcategory identifier.

external_key string Optional

Identificador estável do seu ERP.

unit string Optional

Unit code, for example pc.

unit_name string Optional

Human-readable unit name.

image_url url Optional

URL HTTPS da imagem principal.

is_new booleano Optional

Highlight the product as new.

active booleano Optional

Controla a visibilidade do produto.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /product/update Chave + Carregador

Actualize um produto.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identifier of the product to update.

code string Necessário

Código do produto único dentro da loja.

name string Necessário

Nome exibido na aplicação.

description string Optional

Descrição detalhada do produto.

base_price decimal Optional

Preço de venda excluindo imposto de acordo com sua configuração.

vat_rate decimal Optional

Taxa de IVA, por exemplo 21.

category_id inteiro Optional

Primary category identifier.

subcategory_id inteiro Optional

Subcategory identifier.

external_key string Optional

Identificador estável do seu ERP.

unit string Optional

Unit code, for example pc.

unit_name string Optional

Human-readable unit name.

image_url url Optional

URL HTTPS da imagem principal.

is_new booleano Optional

Highlight the product as new.

active booleano Optional

Controla a visibilidade do produto.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /product/delete Chave + Carregador

Esconder um produto.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identifier of the product to hide.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /product/favoris Chave + Carregador

Adicione ou remova um produto dos favoritos.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

product_id inteiro Necessário

Product identifier.

favorite booleano Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /price/list Chave + Carregador

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

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

product_id inteiro Optional

Limit results to one product.

price_group string Optional

Price group, defaults to 01.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /mark/list Chave + Carregador

Listar as marcas disponíveis.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /size/list Chave + Carregador

Listar os tamanhos disponíveis.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /libweb/list Chave + Carregador

List web reference labels, falling back to catalogue labels.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Pontos finais

Carrinho e encomendas

Gerencie o carrinho e confirme uma ordem atomicamente.

10 routes

GET /order/list Chave + Carregador

List every confirmed shop order with pagination.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

customer_id inteiro Optional

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

guid string Optional

Filter a confirmed order by GUID.

from_date data Optional

Filter from this date using YYYY-MM-DD.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /order/delete Chave + Carregador

Limpar e apagar o carrinho atual.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /order/total Chave + Carregador

Calcular o carrinho subtotal, o IVA e o total.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /order/shipping/quote Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

delivery_mode enum Necessário

pickup | delivery

delivery_country string Optional

Two-letter ISO code or delivery-country name.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /order/count/line Chave + Carregador

Conta as linhas na carroça.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /order/sendtomegawin Chave + Carregador

Confirme a ordem, o modo de cumprimento e o endereço.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

order_guid uuid Optional

GUID do carrinho para confirmar.

delivery_mode enum Necessário

pickup | delivery

delivery_address string Optional

Requerido para entrega.

delivery_country string Optional

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

delivery_date data Optional

AAAA-MM-DD

delivery_comment string Optional

Instruções de cumprimento.

language string Optional

Linguagem de e-mail transacional.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /orderline/add Chave + Carregador

Adicionar um produto e quantidade ao carrinho.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

product_id inteiro Necessário

Identifier of the product to add.

quantity decimal Necessário

Quantity strictly greater than zero.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /orderline/list Chave + Carregador

Recupera as linhas atuais do carrinho.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /orderline/update Chave + Carregador

Atualizar uma quantidade de linha.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

item_id inteiro Necessário

Cart line identifier.

quantity decimal Necessário

Quantity; zero removes the line.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /orderline/delete Chave + Carregador

Remova uma linha do carrinho.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

item_id inteiro Necessário

Identifier of the line to remove.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Pontos finais

Customer payments

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

4 routes

GET /payment/config Chave + Carregador

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

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /payment/checkout/create Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

purpose_type enum Necessário

order | booking

purpose_id inteiro Necessário

Identifier of the confirmed order or customer-confirmed booking.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /payment/pay-later Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

purpose_type enum Necessário

order | booking

purpose_id inteiro Necessário

Authorised order or booking identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /payment/status Chave + Carregador

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

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

reference string Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enum Optional

order | booking

purpose_id inteiro Optional

Paid object identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Pontos finais

Documentos

Faturas, estimativas, ordens e suas linhas.

8 routes

POST /document/add Chave + Carregador

Crie um documento ligado ao cliente.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

doc_type string Optional

invoice | estimate | purchase_order

doc_number string Optional

Document number; generated automatically when omitted on creation.

doc_date data Optional

AAAA-MM-DD

due_date data Optional

AAAA-MM-DD

payment_method string Optional

Método de pagamento.

remark string Optional

Observação em forma livre.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /document/list Chave + Carregador

Listar ou filtrar documentos.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

doc_type string Optional

Filter by document type.

guid uuid Optional

Filter by document GUID.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /document/update Chave + Carregador

Atualizar um documento identificado pelo GUID.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

document_guid uuid Necessário

GUID of the document to update.

doc_type string Optional

invoice | estimate | purchase_order

doc_number string Optional

Document number; generated automatically when omitted on creation.

doc_date data Optional

AAAA-MM-DD

due_date data Optional

AAAA-MM-DD

payment_method string Optional

Método de pagamento.

remark string Optional

Observação em forma livre.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /document/delete Chave + Carregador

Apagar um documento e as suas linhas.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

document_guid uuid Necessário

GUID of the document to delete.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /documentline/add Chave + Carregador

Adicione uma linha e recalcule o documento.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

document_guid uuid Necessário

GUIA DO Documento.

text string Optional

Descrição da linha.

quantity decimal Optional

Quantity, default 1.

unit_price decimal Optional

Preço unitário, excluindo IVA.

vat_rate decimal Optional

VAT rate, default 21.

discount_percentage decimal Optional

Desconto percentual.

product_code string Optional

Associated product code.

product_id inteiro Optional

Associated product identifier.

packages decimal Optional

Number of packages.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /documentline/list Chave + Carregador

Recupere um documento com todas as suas linhas.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

guid uuid Necessário

GUID of the document whose lines must be retrieved.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /documentline/update Chave + Carregador

Atualizar uma linha identificada pelo GUID.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

document_guid uuid Necessário

GUIA DO Documento.

line_guid uuid Necessário

GUID of the line to update.

text string Optional

Descrição da linha.

quantity decimal Optional

Quantity, default 1.

unit_price decimal Optional

Preço unitário, excluindo IVA.

vat_rate decimal Optional

VAT rate, default 21.

discount_percentage decimal Optional

Desconto percentual.

product_code string Optional

Associated product code.

product_id inteiro Optional

Associated product identifier.

packages decimal Optional

Number of packages.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /documentline/delete Chave + Carregador

Apagar uma linha e recalcular os totais.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

document_guid uuid Necessário

GUIA DO Documento.

line_guid uuid Necessário

GUID of the line to delete.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Pontos finais

Real-time webhooks

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

10 routes

GET /webhooks/events Chave + Carregador

List all available events and the contract version.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /webhooks/endpoints/list Chave + Carregador

List destinations, status and counters.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /webhooks/endpoints/create Chave + Carregador

Create an HTTPS destination and receive its signing secret once.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

label string Necessário

Internal name for this destination.

target_url url Necessário

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

events array Necessário

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /webhooks/endpoints/update Chave + Carregador

Update the destination, events or pause delivery.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Destination identifier.

label string Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

New event selection.

status enum Optional

active | paused

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /webhooks/endpoints/delete Chave + Carregador

Soft-delete a destination.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Destination identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /webhooks/endpoints/rotate-secret Chave + Carregador

Replace the HMAC secret and reveal it once.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Destination identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /webhooks/deliveries/list Chave + Carregador

Inspect deliveries, responses, errors and attempts.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id inteiro Optional

Limit results to one destination.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /webhooks/deliveries/retry Chave + Carregador

Retry one delivery without replaying the others.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Internal delivery identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /webhooks/test Chave + Carregador

Emit and deliver a signed test event.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

endpoint_id inteiro Necessário

Destination to test.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /webhooks/stats Chave + Carregador

Retrieve the last thirty days of delivery metrics.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Pontos finais

Notifications and integrations

Mobile notifications and external synchronisation.

47 routes

GET /admin/notification/sendtomobile Chave + Carregador

Recupere notificações móveis.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /admin/notification/setdelivery Chave + Carregador

Marcar uma notificação conforme entregue.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

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

guid string Necessário

Notification GUID token.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/categories/sync Chave + Carregador

Batch-sync WooCommerce categories and subcategories.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

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

items[].external_id string Necessário

Stable WooCommerce identifier.

items[].name string Necessário

Visible name.

items[].parent_external_id string Optional

Parent category identifier.

items[].sort_order inteiro Optional

Display order.

items[].images array Optional

Up to five HTTPS URLs.

items[].active booleano Optional

false archives the category.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/products/sync Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 250 products or variations per batch.

items[].external_id string Necessário

Stable WooCommerce identifier used for deduplication.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id string Optional

Parent product for a variation.

items[].sku string Optional

SKU; a fallback code is generated when omitted.

items[].name string Necessário

Product name.

items[].description string Optional

Product description.

items[].regular_price decimal Optional

Regular price.

items[].sale_price decimal Optional

Sale price.

items[].date_on_sale_from data Optional

ISO 8601 sale start.

items[].date_on_sale_to data Optional

ISO 8601 sale end.

items[].vat_rate decimal Optional

Taxa de IVA.

items[].stock_quantity inteiro Optional

Available stock.

items[].category_external_id string Optional

Synchronised primary category.

items[].subcategory_external_id string Optional

Synchronised subcategory.

items[].images array Optional

Up to five HTTPS images.

items[].attributes array Optional

WooCommerce variation attributes.

items[].active booleano Optional

Visibility in SellViaApp.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/customers/sync Chave + Carregador

Create or update WooCommerce customer accounts without sending email.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

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

items[].external_id string Necessário

Stable WooCommerce user identifier.

items[].username string Necessário

WooCommerce username preserved exactly in client.login.

items[].email e- mail Optional

Customer email address used for deduplication.

items[].first_name string Optional

Primeiro nome do cliente.

items[].last_name string Optional

Sobrenome do cliente.

items[].company string Optional

Company or business name.

items[].phone string Optional

Phone number.

items[].vat_number string Optional

VAT number.

items[].language iso-639-1 Optional

Two-letter language; English by default.

items[].billing object Optional

Full WooCommerce billing address.

items[].shipping object Optional

Shipping address retained in synchronisation metadata.

items[].active booleano Optional

Account active state.

items[].send_email booleano Optional

Must remain false. This route never sends email.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /woocommerce/products/inventory Chave + Carregador

Quickly update prices, promotions, stock or visibility only.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 500 lightweight updates.

items[].external_id string Necessário

Previously synchronised product.

items[].stock_quantity inteiro Optional

New quantity.

items[].regular_price decimal Optional

New regular price.

items[].sale_price decimal Optional

New sale price.

items[].active booleano Optional

New visibility.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/products/archive Chave + Carregador

Batch-archive deleted WooCommerce products without changing orders.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

entity_type enum Optional

product | category | subcategory

items array Necessário

List of up to 500 external identifiers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /woocommerce/orders/feed Chave + Carregador

Retrieve confirmed orders with cursor-based reconciliation.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

cursor string Optional

Opaque cursor returned by the previous response.

updated_since datetime Optional

ISO 8601 starting date.

limit inteiro Optional

1 to 100 orders.

unacknowledged_only booleano Optional

Defaults to true to prevent duplicates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/orders/acknowledge Chave + Carregador

Confirm that an order was imported into WooCommerce.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Orders processed by WooCommerce.

items[].order_guid string Necessário

SellViaApp GUID returned by the feed.

items[].external_order_id string Optional

WooCommerce order identifier.

items[].status enum Necessário

imported | failed | ignored

items[].error string Optional

Explanation when import failed.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/webhooks/subscribe Chave + Carregador

Input

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

target_url url Necessário

Public HTTPS URL; private networks are rejected.

events array Optional

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

Output

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /woocommerce/webhooks/list Chave + Carregador

List active WooCommerce webhooks.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /woocommerce/webhooks/delete Chave + Carregador

Disable a WooCommerce webhook.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Webhook identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /woocommerce/webhooks/process Chave + Carregador

Process pending webhook deliveries with automatic retries.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

Maximum deliveries to process.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /woocommerce/sync/logs Chave + Carregador

View the technical synchronisation log.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/categories/sync Chave + Carregador

Sync Shopify collections and product types.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 500 collections or product types.

items[].external_id string Necessário

Stable Shopify GID.

items[].name string Necessário

Visible name.

items[].parent_external_id string Optional

Parent collection for a product type.

items[].images array Optional

HTTPS URLs.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/categories/archive Chave + Carregador

Archive a deleted Shopify collection.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

GIDs of deleted collections.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/products/sync Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 250 Shopify variants per batch.

items[].external_id string Necessário

Variant GID.

items[].parent_external_id string Optional

Parent product GID.

items[].sku string Optional

SKU

items[].name string Necessário

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 inteiro Optional

Available quantity.

items[].images array Optional

Up to five HTTPS images.

items[].active booleano Optional

SellViaApp visibility.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /shopify/products/inventory Chave + Carregador

Quickly update Shopify prices, inventory or visibility.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 500 lightweight updates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/products/archive Chave + Carregador

Archive Shopify variants by identifier.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Variant GIDs to archive.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/products/archive-parent Chave + Carregador

Archive every variant of a deleted Shopify product.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 100 parent product GIDs.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/customers/sync Chave + Carregador

Sync Shopify customers without sending email.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 250 customers; no email is sent.

items[].external_id string Necessário

Shopify customer GID.

items[].username string Necessário

Username used in SellViaApp.

items[].email e- mail Optional

Customer email.

items[].send_email booleano Optional

Must remain false.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/customers/redact Chave + Carregador

Redact customer data requested by Shopify.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Optional

Customer GIDs to redact.

all booleano Optional

Redacts all Shopify customers for shop/redact.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /shopify/orders/feed Chave + Carregador

Retrieve SellViaApp orders not yet imported into Shopify.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

cursor string Optional

Opaque cursor.

limit inteiro Optional

1–100

unacknowledged_only booleano Optional

true recommended.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/orders/acknowledge Chave + Carregador

Acknowledge a Shopify order import.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Imported orders.

items[].order_guid string Necessário

SellViaApp GUID.

items[].external_order_id string Optional

Created Shopify GID.

items[].status enum Necessário

imported | failed | ignored

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/webhooks/subscribe Chave + Carregador

Input

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

target_url url Necessário

Connector HTTPS URL.

events array Optional

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

Output

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /shopify/webhooks/list Chave + Carregador

List Shopify connector webhooks.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /shopify/webhooks/delete Chave + Carregador

Disable a Shopify webhook.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Webhook ID

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /shopify/webhooks/process Chave + Carregador

Retry pending Shopify notifications.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

Maximum count.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /shopify/account Chave + Carregador

Identify the store and retrieve its mobile test account.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /shopify/sync/logs Chave + Carregador

View Shopify logs isolated from WooCommerce.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/connect Público

Connect a Wix instance to an existing SellViaApp Dashboard account.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

email e- mail Necessário

Email used to sign in to the SellViaApp Dashboard.

password string Necessário

Verified once and never stored by the connector.

instance_id string Necessário

Stable Wix installation identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /wix/account Chave + Carregador

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

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/disconnect Chave + Carregador

Revoke the connector token and disconnect Wix.

Input

Available parameters

Corpo JSON

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/categories/sync Chave + Carregador

Synchronise Wix Stores V1/V3 categories or collections.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 500 Wix categories or collections per batch.

items[].external_id string Necessário

Stable Wix identifier.

items[].name string Necessário

Nome exibido na aplicação.

items[].parent_external_id string Optional

Parent category identifier.

items[].image url Optional

HTTPS presentation image.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/products/sync Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 250 Wix products or variants per batch.

items[].external_id string Necessário

Wix product or variant identifier.

items[].parent_external_id string Optional

Parent product of a variant.

items[].sku string Optional

SKU

items[].name string Necessário

Product title.

items[].regular_price decimal Optional

Regular price.

items[].sale_price decimal Optional

Active sale price.

items[].stock_quantity inteiro Optional

Available stock.

items[].images array Optional

Up to five HTTPS images.

items[].visible booleano Optional

Visibility in SellViaApp.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

PATCH /wix/products/inventory Chave + Carregador

Quickly update Wix prices, inventory or visibility.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Lightweight price, inventory or visibility updates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/products/archive Chave + Carregador

Archive deleted Wix products.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

entity_type enum Optional

product | category | subcategory

items array Necessário

External Wix identifiers to archive.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/customers/sync Chave + Carregador

Synchronise Wix contacts without sending email.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Up to 250 contacts; no SellViaApp email is sent.

items[].external_id string Necessário

Wix contact identifier.

items[].username string Necessário

Email or fallback username.

items[].active booleano Optional

true for synchronised contacts.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/customers/redact Chave + Carregador

Redact one or more synchronised Wix contacts.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

all booleano Optional

Redact all contacts originating from Wix.

items array Optional

External Wix identifiers to redact when all is false.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/privacy/shop-redact Chave + Carregador

Remove Wix-origin data after uninstall.

Input

Available parameters

Corpo JSON

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /wix/orders/feed Chave + Carregador

Read SellViaApp orders to reconcile with Wix.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

cursor string Optional

Opaque cursor from the previous page.

updated_since datetime Optional

Optional ISO 8601 date.

limit inteiro Optional

1–100

unacknowledged_only booleano Optional

Defaults to true to prevent duplicates.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/orders/acknowledge Chave + Carregador

Record the result of a Wix order reconciliation.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Reconciliation results.

items[].order_guid string Necessário

SellViaApp order GUID.

items[].external_order_id string Optional

Linked Wix order identifier.

items[].status enum Necessário

imported | failed | ignored

items[].error string Optional

Readable error when processing fails.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/webhooks/subscribe Chave + Carregador

Create a signed SellViaApp destination for the Wix connector.

Input

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

target_url url Necessário

HTTPS URL of the receiving system.

events array Optional

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

Output

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /wix/webhooks/list Chave + Carregador

List SellViaApp webhooks for the Wix connector.

Input

Available parameters

URL query

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

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

DELETE /wix/webhooks/delete Chave + Carregador

Disable a Wix connector webhook.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Webhook ID

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

POST /wix/webhooks/process Chave + Carregador

Process pending SellViaApp deliveries for Wix.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

Maximum number of deliveries.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

GET /wix/sync/logs Chave + Carregador

View the isolated Wix synchronisation log.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

Número da página, começando em 1.

per_page inteiro Optional

Number of results per page.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

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

Error example

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

Reference

Responses and errors

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

400Pedido inválido

401Autenticação necessária

403Acesso negado

404Recurso ou rota não encontrado

409Conflito de negócios

422A validação falhou

429Muitos pedidos

5xxIncidente técnico

Área de trabalho da API

Endpoint

GET

Parâmetros do URLUm parâmetro por linha: nome=valor Corpo JSONEdite os valores de exemplo antes do teste.

O código gerado contém as credenciais introduzidas. Guarde-as no servidor e nunca partilhe uma captura sem as ocultar.

Resposta da API