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/

Cabeçalhos necessáriosX-API-Key + Bearer

Contrato legível por máquina · JSONOpenAPI 3.1 · Baixar ↓ Contrato legível por máquina · YAMLOpenAPI 3.1 · Baixar ↓ Suporte ao desenvolvedorapi@sellviaapp.com

Início rápido

Autenticar, escolher uma rota, testar.

Obtenha a X-API-Key e gere o token Bearer em Dashboard → API. Introduza ambos abaixo. Depois, selecione «Testar · Gerar» num endpoint para consultar a resposta e o código de exemplo em cURL, PHP 8 ou JavaScript.

X-API-Key

Bearer token

Credenciais incompletasDigite o token X-API-Key e Bearer para preparar um teste.

As credenciais permanecem em memória apenas para esta página. Para uma operação relacionada ao cliente, adicione customer_id.

Keep in mindHTTPS + JSON · mantenha ambas as credenciais do lado do servidor · nunca envie tokens para suporte.

Real time

Conecte SellViaApp a qualquer sistema compatível com HTTPS.

Um webhook avisa o seu ERP, CRM ou outro sistema quando há alterações importantes. Pode tratar-se de produtos, clientes, carrinhos, encomendas, documentos ou definições. Consulte o objeto completo através da API quando precisar.

Criar o destino

No Painel → Webhooks, digite uma URL HTTPS e selecione eventos. O segredo é mostrado uma vez.

Verificar a assinatura

Calcule HMAC-SHA256 sobre timestamp.delivery_id.raw_body e compare o resultado com X-SellViaApp-Signature.

Reconheça rapidamente.

Devolva HTTP 2xx, deduplicar com X-SellViaApp-Event-Id, então processar em segundo plano.

Entrega confiávelAté oito tentativas com atrasos progressivos. Um destino repetidamente falhando é pausado automaticamente, e cada entrega permanece visível e reexperimentável no 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

Parâmetros disponíveis

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

Endereço postal.

zipcode string Optional

Postal code.

city string Optional

City.

country string Optional

Country.

phone string Optional

Phone number.

cellphone string Optional

Número de telemóvel.

vat_number string Optional

VAT number.

language string Optional

Código ISO de duas letras.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

first_name string Optional

First name.

last_name string Optional

Last name.

company string Optional

Company name.

email e- mail Optional

Novo endereço de email, único dentro da loja.

address string Optional

Endereço postal.

zipcode string Optional

Postal code.

city string Optional

City.

country string Optional

Country.

phone string Optional

Phone number.

cellphone string Optional

Número de telemóvel.

vat_number string Optional

VAT number.

language string Optional

Código ISO de duas letras.

account_type enum Optional

company | individual

notifications_enabled booleano Optional

Permitir notificações móveis.

password string Optional

Nova senha, pelo menos oito caracteres.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

28 routes

GET /fam1/list Chave + Carregador

Listar as categorias primárias.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

name string Necessário

Nome de categoria visível.

external_key string Optional

Identificador estável do seu software.

sort_order inteiro Optional

Exibe a ordem, começando em 1.

image_url url Optional

URL de imagem HTTPS.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador da categoria a actualizar.

name string Necessário

Nome de categoria visível.

external_key string Optional

Identificador estável do seu software.

sort_order inteiro Optional

Exibe a ordem, começando em 1.

image_url url Optional

URL de imagem HTTPS.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador da categoria a esconder.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

category_id inteiro Optional

Limitar os resultados a uma categoria primária.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

category_id inteiro Necessário

Identificador da categoria primária-mãe.

name string Necessário

Nome de categoria visível.

external_key string Optional

Identificador estável do seu software.

sort_order inteiro Optional

Exibe a ordem, começando em 1.

image_url url Optional

URL de imagem HTTPS.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador da subcategoria a actualizar.

name string Necessário

Nome de categoria visível.

external_key string Optional

Identificador estável do seu software.

sort_order inteiro Optional

Exibe a ordem, começando em 1.

image_url url Optional

URL de imagem HTTPS.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador da subcategoria a esconder.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

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

Grupo de preços do cliente.

favorites booleano Optional

Devolver apenas os favoritos.

promotions booleano Optional

Devolver apenas promoções activas.

new booleano Optional

Devolva apenas novos produtos.

progressive booleano Optional

Paginação rápida sem calcular a contagem total.

group_variants booleano Optional

Variantes de grupo sob o produto pai e combinações de retorno. As opções também são devolvidas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /product/variants Chave + Carregador

Recuperar os grupos e combinações variantes de um produto.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

product_id inteiro Necessário

Identificador do produto-mãe.

groups array Optional

Apenas POST: lista completa de 0–3 grupos {nome, valores[]}. Um array vazio remove variantes.

combinations array Optional

Só POST: todas as combinações em ordem de grupo, cada uma com seleções[], sku, preço e estoque. Máximo 100.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /product/variants Chave + Carregador

Substituir os grupos e combinações variantes de um produto.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

product_id inteiro Necessário

Identificador do produto-mãe.

groups array Optional

Apenas POST: lista completa de 0–3 grupos {nome, valores[]}. Um array vazio remove variantes.

combinations array Optional

Só POST: todas as combinações em ordem de grupo, cada uma com seleções[], sku, preço e estoque. Máximo 100.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /product/options Chave + Carregador

Recuperar grupos de opções de um produto e extras opcionais.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

product_id inteiro Necessário

Identificador do produto-mãe.

groups array Optional

Apenas POST: lista completa de 0–10 grupos {id, nome, selection_mode, opções[]}. Um array vazio remove as opções.

groups[].options[] array Optional

Cada opção: id existente ou 0, nome, preço, quantity_mode (única ou quantidade), max_quantity (1 ou 2–50), facultativo unit_label; opcional image_base64 (JPEG/PNG/WebP, 1 MB) ou remove_photo.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /product/options Chave + Carregador

Substituir os grupos de opções de um produto e extras opcionais.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

product_id inteiro Necessário

Identificador do produto-mãe.

groups array Optional

Apenas POST: lista completa de 0–10 grupos {id, nome, selection_mode, opções[]}. Um array vazio remove as opções.

groups[].options[] array Optional

Cada opção: id existente ou 0, nome, preço, quantity_mode (única ou quantidade), max_quantity (1 ou 2–50), facultativo unit_label; opcional image_base64 (JPEG/PNG/WebP, 1 MB) ou remove_photo.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

supplier string Necessário

Sufixo de loja pública.

id inteiro Necessário

Identificador do produto.

slot inteiro Optional

slot de imagem de 1 a 5.

signature string Necessário

Assinatura do link assinado retornado por produto / lista.

variant enum Optional

small | thumb | large

Output

Resultados possíveis

200Imagem binária com o seu tipo MIME

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Ligação assinada inválida

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

200 O corpo contém diretamente a imagem binária e o cabeçalho Tipo de Conteúdo indica seu formato.

Error example

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

Parâmetros disponíveis

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

Identificador da categoria primária.

subcategory_id inteiro Optional

Identificador da subcategoria.

external_key string Optional

Identificador estável do seu ERP.

unit string Optional

Código da unidade, por exemplo pc.

unit_name string Optional

Nome de unidade legível pelo ser humano.

image_url url Optional

URL HTTPS da imagem principal.

is_new booleano Optional

Destaque o produto como novo.

active booleano Optional

Controla a visibilidade do produto.

action_type enum Optional

cart | auction | inquiry

auction.start_price decimal Optional

Preço inicial exigido quando action_type for leilão.

auction.buy_now_price decimal Optional

Preço opcional de compra-agora.

auction.minimum_increment decimal Optional

Incremento mínimo opcional da proposta.

auction.starts_at datetime Optional

Início opcional como ISO 8601 com fuso horário.

auction.ends_at datetime Optional

Fim opcional como ISO 8601 com fuso horário.

auction.hide_after_end booleano Optional

Ocultar o produto após expirar; requer ends_at.

auction.terms string Optional

Termos específicos do leilão, no máximo 5.000 caracteres.

inquiry.prompt string Optional

Pedido de informação, no máximo 1000 caracteres.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador do produto a actualizar.

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

Identificador da categoria primária.

subcategory_id inteiro Optional

Identificador da subcategoria.

external_key string Optional

Identificador estável do seu ERP.

unit string Optional

Código da unidade, por exemplo pc.

unit_name string Optional

Nome de unidade legível pelo ser humano.

image_url url Optional

URL HTTPS da imagem principal.

is_new booleano Optional

Destaque o produto como novo.

active booleano Optional

Controla a visibilidade do produto.

action_type enum Optional

cart | auction | inquiry

auction.start_price decimal Optional

Preço inicial exigido quando action_type for leilão.

auction.buy_now_price decimal Optional

Preço opcional de compra-agora.

auction.minimum_increment decimal Optional

Incremento mínimo opcional da proposta.

auction.starts_at datetime Optional

Início opcional como ISO 8601 com fuso horário.

auction.ends_at datetime Optional

Fim opcional como ISO 8601 com fuso horário.

auction.hide_after_end booleano Optional

Ocultar o produto após expirar; requer ends_at.

auction.terms string Optional

Termos específicos do leilão, no máximo 5.000 caracteres.

inquiry.prompt string Optional

Pedido de informação, no máximo 1000 caracteres.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /product/action Chave + Carregador

Recuperar um tipo de ação do produto e suas configurações.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

product_id inteiro Necessário

Identificador da ação do produto para recuperar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

PUT /product/action/configure Chave + Carregador

Configurar compra direta, leilão ou solicitação de informações e suas configurações.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

product_id inteiro Necessário

Identificador do produto a configurar.

action_type enum Necessário

cart | auction | inquiry

auction.start_price decimal Optional

Preço inicial exigido para leilão.

auction.buy_now_price decimal Optional

Preço opcional de compra-agora.

auction.minimum_increment decimal Optional

Incremento mínimo opcional.

auction.starts_at datetime Optional

Início opcional como ISO 8601 com fuso horário.

auction.ends_at datetime Optional

Fim opcional como ISO 8601 com fuso horário.

auction.hide_after_end booleano Optional

Esconder o produto após a data final.

auction.terms string Optional

Termos, no máximo 5.000 caracteres.

inquiry.prompt string Optional

Prompt opcional, no máximo 1.000 caracteres.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador do produto a esconder.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Necessário

Identificador do produto.

favorite booleano Optional

true to add, false to remove; comuta o estado quando omitido.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /product/auction Chave + Carregador

Recuperar um estado de leilão e histórico de lances anônimos.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Necessário

Identificador do produto do leilão.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /product/auction/bid Chave + Carregador

Colocar uma proposta com validação atômica de montante mínimo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Necessário

Identificador do produto do leilão.

amount decimal Necessário

Quantidade de lance, pelo menos o mínimo retornado pelo servidor.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /product/auction/buy-now Chave + Carregador

Compre agora e feche o leilão.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Necessário

Identificador do produto com compra agora habilitado.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /product/inquiry Chave + Carregador

Enviar um pedido de informação ligado a um produto.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Necessário

Identificador do produto relacionado.

message string Necessário

Pergunta do cliente, 5 a 5.000 caracteres.

name string Optional

Nome do contato; padrão para o perfil assinado.

email e- mail Optional

Responder e-mail; ou e-mail ou telefone é necessário.

phone string Optional

Responder telefone; e-mail ou telefone é necessário.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Lista de preços aplicáveis ao grupo de clientes, retrocedendo ao preço de venda do produto.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Optional

Limitar os resultados a um produto.

price_group string Optional

Grupo de preços, padrão para 01.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Listar as etiquetas de referência web, remetendo para as etiquetas de catálogo.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

14 routes

GET /order/list Chave + Carregador

Liste todas as encomendas confirmadas com paginação.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

guid string Optional

Filtrar uma ordem confirmada pelo GUID.

from_date data Optional

Filtrar a partir desta data usando YYY-MM-DD.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /promotion/validate Chave + Carregador

Validar um código de promoção contra o carrinho atual no servidor e calcular líquidos, IVA e descontos totais.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

promotion_code string Necessário

Código contendo 3 a 64 letras, números, hífens ou sublinhados. O servidor verifica datas, limite de uso e elegibilidade.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /loyalty/summary Chave + Carregador

Recuperar o programa de fidelidade, saldo do cliente e valor de desconto disponível.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /loyalty/history Chave + Carregador

Liste o histórico de ganhos, resgate, correção e expiração do cliente.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /loyalty/quote Chave + Carregador

Calcular ao lado do servidor quantos pontos podem ser resgatados contra o carrinho atual.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

loyalty_points inteiro Necessário

Número de pontos que o cliente quer resgatar.

delivery_mode enum Necessário

pickup | delivery

delivery_country string Optional

País usado para recalcular taxas de envio.

promotion_code string Optional

Código opcional de promoção aplicado antes do desconto de fidelidade.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Calcule as taxas de envio do carrinho, modo de cumprimento e país.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

delivery_mode enum Necessário

pickup | delivery

delivery_country string Optional

Código ISO de duas letras ou nome do país de entrega.

promotion_code string Optional

Código opcional; a cotação recalcula o desconto antes das taxas de envio.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

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

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

order_guid uuid Optional

GUID do carrinho para confirmar.

delivery_mode enum Necessário

pickup | delivery

delivery_address string Optional

Requerido para entrega.

stock_site_id inteiro Optional

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

delivery_country string Optional

Código ISO de duas letras ou nome do país utilizado para calcular a taxa.

delivery_date data Optional

AAAA-MM-DD

delivery_comment string Optional

Instruções de cumprimento.

language string Optional

Linguagem de e-mail transacional.

promotion_code string Optional

Código opcional, revalidado e resgatado atomicamente durante a confirmação.

loyalty_points inteiro Optional

Pontos para resgatar; equilíbrio e regras são revalidadas e debitadas atomicamente.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

product_id inteiro Necessário

Identificador do produto a adicionar.

quantity decimal Necessário

Quantidade estritamente maior que zero.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

item_id inteiro Necessário

Identificador da linha do carrinho.

quantity decimal Necessário

Quantidade; zero remove a linha.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

item_id inteiro Necessário

Identificador da linha a remover.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Pagamentos aos clientes

Escolha pagar na entrega ou abra um pagamento seguro Stripe, em seguida, recupere seu status verificado pelo servidor.

4 routes

GET /payment/config Chave + Carregador

Recuperar os métodos de pagamento Stripe habilitados e o provedor de conta Stripe selecionado para o aplicativo.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Crie ou retome uma página Stripe Checkout para uma encomenda ou reserva por pagar do cliente autenticado. Se ainda puder ser alterada, a opção de pagamento na entrega é substituída em segurança.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

purpose_type enum Necessário

order | booking

purpose_id inteiro Necessário

Identificador do pedido confirmado ou da reserva confirmada pelo cliente.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Grave o pagamento na entrega ou substitua um pagamento Stripe ainda aberto após sua sessão ser verificada e expirada com segurança.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

purpose_type enum Necessário

order | booking

purpose_id inteiro Necessário

Identificador de ordem ou reserva autorizado.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Recuperar um status de pagamento; apenas o webhook Stripe assinado pode confirmá-lo como pago.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

reference string Optional

SellViaApp Referência do pagamento. Caso contrário, fornecer purpose_type e purpose_id.

purpose_type enum Optional

order | booking

purpose_id inteiro Optional

Identificador de objeto pago.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

doc_type string Optional

invoice | estimate | purchase_order

doc_number string Optional

Número do documento; gerado automaticamente quando omitido na criação.

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

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

doc_type string Optional

Filtrar por tipo de documento.

guid uuid Optional

Filtrar por documento GUID.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

document_guid uuid Necessário

GUID do documento a atualizar.

doc_type string Optional

invoice | estimate | purchase_order

doc_number string Optional

Número do documento; gerado automaticamente quando omitido na criação.

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

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

document_guid uuid Necessário

GUID do documento a apagar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

document_guid uuid Necessário

GUIA DO Documento.

text string Optional

Descrição da linha.

quantity decimal Optional

Quantidade, padrão 1.

unit_price decimal Optional

Preço unitário, excluindo IVA.

vat_rate decimal Optional

Taxa de IVA, incumprimento 21.

discount_percentage decimal Optional

Desconto percentual.

product_code string Optional

Código do produto associado.

product_id inteiro Optional

Identificador de produto associado.

packages decimal Optional

Número de embalagens.

Output

Resultados possíveis

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

guid uuid Necessário

GUID do documento cujas linhas devem ser recuperadas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

document_guid uuid Necessário

GUIA DO Documento.

line_guid uuid Necessário

GUID da linha a atualizar.

text string Optional

Descrição da linha.

quantity decimal Optional

Quantidade, padrão 1.

unit_price decimal Optional

Preço unitário, excluindo IVA.

vat_rate decimal Optional

Taxa de IVA, incumprimento 21.

discount_percentage decimal Optional

Desconto percentual.

product_code string Optional

Código do produto associado.

product_id inteiro Optional

Identificador de produto associado.

packages decimal Optional

Número de embalagens.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

document_guid uuid Necessário

GUIA DO Documento.

line_guid uuid Necessário

GUIA da linha a apagar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Anzóis web em tempo real

Receba automaticamente alterações SellViaApp em seu ERP, CRM, automação ou serviço de negócios.

10 routes

GET /webhooks/events Chave + Carregador

Liste todos os eventos disponíveis e a versão do contrato.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Listar destinos, status e balcões.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Crie um destino HTTPS e receba seu segredo de assinatura uma vez.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

label string Necessário

Nome interno para este destino.

target_url url Necessário

URL HTTPS público na porta 443. Redes privadas e redirecionamentos são rejeitados.

events array Necessário

Eventos exatos, um grupo como produto.*, ou todos com *.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Atualizar o destino, eventos ou entrega de pausa.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador do destino.

label string Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

Nova seleção de eventos.

status enum Optional

active | paused

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Deletar um destino.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador do destino.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Substitua o segredo do HMAC e revele-o uma vez.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador do destino.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Inspecione entregas, respostas, erros e tentativas.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id inteiro Optional

Limitar os resultados a um destino.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Tente novamente uma entrega sem repetir os outros.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador interno de entrega.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Emite e entrega um evento de teste assinado.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

endpoint_id inteiro Necessário

Destino a testar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Recuperar os últimos trinta dias de métricas de entrega.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Notificações e integrações

notificações móveis e sincronização externa.

64 routes

GET /admin/notification/sendtomobile Chave + Carregador

Recupere notificações móveis.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

customer_id inteiro Optional

Só é necessário com um token de integração quando a operação visa um cliente específico.

guid string Necessário

Token GUID de notificação.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /push/device/register Chave + Carregador

Associar uma instalação móvel com esta conta de cliente para Firebase push.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

installation_id string Necessário

ID de instalação aleatória estável (48 caracteres hex).

fid string Necessário

ID de instalação Firebase fornecido pela aplicação.

platform enum Necessário

android | ios

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /push/device/unregister Chave + Carregador

Remova esta loja das notificações de push neste dispositivo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

installation_id string Necessário

Instalação para não registrar esta conta.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /push/notification/ack Chave + Carregador

Reconheça uma notificação observada no aplicativo ou aberta pelo cliente.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

installation_id string Necessário

Instalação que reconhece a notificação.

guid string Necessário

Identificação de notificação para esta loja.

event enum Necessário

received | opened

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Categorias e subcategorias WooCommerce em lote.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 categorias. Cada objeto usa external_id, nome e, para uma subcategoria, parent_external_id.

items[].external_id string Necessário

Identificador WooCommerce estável.

items[].name string Necessário

Visible name.

items[].parent_external_id string Optional

Identificador da categoria-mãe.

items[].sort_order inteiro Optional

Display order.

items[].images array Optional

Até cinco URLs HTTPS.

items[].active booleano Optional

arquivos falsos da categoria.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Sincronize produtos, variações, imagens, preços, IVA, estoque e visibilidade.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 produtos ou variações por lote.

items[].external_id string Necessário

Identificador WooCommerce estável usado para deduplicação.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id string Optional

Produto pai para uma variação.

items[].sku string Optional

SKU; um código de reserva é gerado quando omitido.

items[].name string Necessário

Product name.

items[].description string Optional

Descrição do produto.

items[].regular_price decimal Optional

Regular price.

items[].sale_price decimal Optional

Sale price.

items[].date_on_sale_from data Optional

Início da venda da ISO 8601.

items[].date_on_sale_to data Optional

Ponto de venda ISO 8601.

items[].vat_rate decimal Optional

Taxa de IVA.

items[].stock_quantity inteiro Optional

Stock disponível.

items[].category_external_id string Optional

Categoria primária sincronizada.

items[].subcategory_external_id string Optional

Subcategoria sincronizada.

items[].images array Optional

Até cinco imagens HTTPS.

items[].attributes array Optional

WooCommerce atributos de variação.

items[].active booleano Optional

Visibilidade em SellViaApp.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Crie ou atualize contas de clientes WooCommerce sem enviar e-mail.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 contas de clientes por lote. Nenhum email é enviado.

items[].external_id string Necessário

Identificador de usuário WooCommerce estável.

items[].username string Necessário

O nome de usuário WooCommerce foi preservado exatamente no client.login.

items[].email e- mail Optional

Endereço de email do cliente usado para deduplicação.

items[].first_name string Optional

Primeiro nome do cliente.

items[].last_name string Optional

Sobrenome do cliente.

items[].company string Optional

Empresa ou nome comercial.

items[].phone string Optional

Phone number.

items[].vat_number string Optional

VAT number.

items[].language iso-639-1 Optional

Língua de duas letras; Inglês por padrão.

items[].billing object Optional

Endereço de cobrança WooCommerce completo.

items[].shipping object Optional

Endereço de envio retido em metadados de sincronização.

items[].active booleano Optional

Estado ativo da conta.

items[].send_email booleano Optional

Deve permanecer falso. Esta rota nunca envia email.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Atualizar rapidamente os preços, promoções, estoque ou visibilidade apenas.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 atualizações leves.

items[].external_id string Necessário

Produto sincronizado anteriormente.

items[].stock_quantity inteiro Optional

New quantity.

items[].regular_price decimal Optional

Novo preço normal.

items[].sale_price decimal Optional

Novo preço de venda.

items[].active booleano Optional

Nova visibilidade.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Lote-arquivo excluídos produtos WooCommerce sem alterar as ordens.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

entity_type enum Optional

product | category | subcategory

items array Necessário

Lista de até 500 identificadores externos.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Obter ordens confirmadas com reconciliação baseada em cursor.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

cursor string Optional

Cursor opaco retornado pela resposta anterior.

updated_since datetime Optional

ISO 8601 data de início.

limit inteiro Optional

1 a 100 ordens.

unacknowledged_only booleano Optional

O padrão é verdadeiro para evitar duplicatas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Confirme que uma ordem foi importada para o WooCommerce.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Ordens processadas pela WooCommerce.

items[].order_guid string Necessário

SellViaApp GUID retornado pelo feed.

items[].external_order_id string Optional

Identificador de ordem WooCommerce.

items[].status enum Necessário

imported | failed | ignored

items[].error string Optional

Explicação quando a importação falhou.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Registre um webhook HTTPS WooCommerce assinado.

Input

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

target_url url Necessário

URL HTTPS público; redes privadas são rejeitadas.

events array Optional

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

Output

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Listar os webhooks WooCommerce ativos.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Desactivar um webhook WooCommerce.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Identificador Webhook.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Processo pendente entregas webhook com repetições automáticas.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

Entregas máximas para processar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Ver o registo de sincronização técnica.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Sincronize coleções Shopify e tipos de produtos.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 coleções ou tipos de produtos.

items[].external_id string Necessário

GID Shopify estável.

items[].name string Necessário

Visible name.

items[].parent_external_id string Optional

Coleta pai para um tipo de produto.

items[].images array Optional

HTTPS URLs.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Arquivar uma coleção Shopify excluída.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

GIDs de coleções apagadas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Sincronize produtos Shopify, variantes, imagens, preços, inventário e visibilidade.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 variantes Shopify por lote.

items[].external_id string Necessário

Variant GID.

items[].parent_external_id string Optional

Produto pai GID.

items[].sku string Optional

SKU

items[].name string Necessário

Produto e título variante.

items[].regular_price decimal Optional

Regular ou comparar a preço.

items[].sale_price decimal Optional

Preço de venda activo.

items[].stock_quantity inteiro Optional

Quantidade disponível.

items[].images array Optional

Até cinco imagens HTTPS.

items[].active booleano Optional

visibilidade SellViaApp.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Atualize rapidamente os preços, inventário ou visibilidade Shopify.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 atualizações leves.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Arquivar as variantes Shopify pelo identificador.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Variantes GIDs para arquivar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Arquive cada variante de um produto Shopify excluído.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 100 GIDs do produto pai.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Sincronize clientes Shopify sem enviar e-mail.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 clientes; nenhum email é enviado.

items[].external_id string Necessário

Shopify cliente GID.

items[].username string Necessário

Nome de usuário usado em SellViaApp.

items[].email e- mail Optional

E-mail do cliente.

items[].send_email booleano Optional

Deve permanecer falso.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Refact dados de clientes solicitados pela Shopify.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Optional

GIDs de clientes para redigir.

all booleano Optional

Redacts todos os clientes Shopify para loja/redact.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Obtenha as encomendas SellViaApp ainda não importadas para Shopify.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

cursor string Optional

Opaque cursor.

limit inteiro Optional

1–100

unacknowledged_only booleano Optional

verdadeiro recomendado.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Reconheça uma importação de ordem Shopify.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Ordens importadas.

items[].order_guid string Necessário

GUIA SellViaApp.

items[].external_order_id string Optional

Criado o GID Shopify.

items[].status enum Necessário

imported | failed | ignored

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Registre o webhook SellViaApp assinado para Shopify.

Input

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

target_url url Necessário

URL HTTPS do conector.

events array Optional

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

Output

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Listar webhooks de conector Shopify.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Desactivar um webhook Shopify.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Webhook ID

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Tente novamente aguardar notificações Shopify.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

Maximum count.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Identificar a loja e recuperar sua conta de teste móvel.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Ver registros Shopify isolados de WooCommerce.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Conecte uma instância Wix a uma conta existente do Painel SellViaApp.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

email e- mail Necessário

Email usado para iniciar sessão no Painel SellViaApp.

password string Necessário

Verificado uma vez e nunca armazenado pelo conector.

instance_id string Necessário

Identificador de instalação Wix estável.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Identificar a conta SellViaApp conectada à Wix e sua conta de teste móvel.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Revogar o token do conector e desconectar Wix.

Input

Parâmetros disponíveis

Corpo JSON

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Sincronizar Wix Lojas V1/V3 categorias ou coleções.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 categorias ou coleções Wix por lote.

items[].external_id string Necessário

Identificador Wix estável.

items[].name string Necessário

Nome exibido na aplicação.

items[].parent_external_id string Optional

Identificador da categoria-mãe.

items[].image url Optional

Imagem de apresentação HTTPS.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Sincronizar produtos Wix com imagens, preços, inventário e visibilidade.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 produtos ou variantes Wix por lote.

items[].external_id string Necessário

Wix produto ou identificador variante.

items[].parent_external_id string Optional

Produto pai de uma variante.

items[].sku string Optional

SKU

items[].name string Necessário

Product title.

items[].regular_price decimal Optional

Regular price.

items[].sale_price decimal Optional

Preço de venda activo.

items[].stock_quantity inteiro Optional

Stock disponível.

items[].images array Optional

Até cinco imagens HTTPS.

items[].visible booleano Optional

Visibilidade em SellViaApp.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Atualize rapidamente os preços, inventário ou visibilidade Wix.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Preço leve, inventário ou atualizações de visibilidade.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Arquivo excluído Wix produtos.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

entity_type enum Optional

product | category | subcategory

items array Necessário

Identificadores externos do Wix para arquivo.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Sincronizar contatos Wix sem enviar e-mail.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 contatos; nenhum e-mail SellViaApp é enviado.

items[].external_id string Necessário

Identificador de contacto Wix.

items[].username string Necessário

Email ou nome de usuário de reserva.

items[].active booleano Optional

verdadeiro para contactos sincronizados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Redigir um ou mais contactos Wix sincronizados.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

all booleano Optional

Redigir todos os contactos originários do Wix.

items array Optional

Identificadores externos do Wix para redigir quando tudo for falso.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Remover dados de origem Wix após desinstalar.

Input

Parâmetros disponíveis

Corpo JSON

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Leia as ordens SellViaApp para se reconciliar com Wix.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

cursor string Optional

Cursor opaco da página anterior.

updated_since datetime Optional

Data opcional ISO 8601.

limit inteiro Optional

1–100

unacknowledged_only booleano Optional

O padrão é verdadeiro para evitar duplicatas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Grave o resultado de uma reconciliação de ordem Wix.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Resultados de reconciliação.

items[].order_guid string Necessário

SellViaApp ordem GUID.

items[].external_order_id string Optional

Identificador de ordem Wix ligado.

items[].status enum Necessário

imported | failed | ignored

items[].error string Optional

Erro legível quando o processamento falha.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Crie um destino SellViaApp assinado para o conector Wix.

Input

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

target_url url Necessário

URL HTTPS do sistema de recepção.

events array Optional

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

Output

201Recurso criado

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Listar webhooks SellViaApp para o conector Wix.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Desabilitar um webhook de conector Wix.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Webhook ID

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Processo pendente SellViaApp entregas para Wix.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

Número máximo de entregas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

Veja o registro isolado de sincronização Wix.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/oauth/device/code Público

Inicie uma autorização Odoo OAuth sem compartilhar a senha SellViaApp.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

client_id string Necessário

sellviaapp_odoo

installation_id string Necessário

UUID estável para esta instalação Odoo.

instance_url url Optional

URL HTTPS público da instância Odoo.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/oauth/device/token Público

Trocar um código de dispositivo aprovado por um token de acesso de integração revogável.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

client_id string Necessário

sellviaapp_odoo

grant_type string Necessário

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

device_code string Necessário

O código opaco retornou ao iniciar o fluxo.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /odoo/account Chave + Carregador

Verifique a conta SellViaApp conectada à instalação Odoo.

Input

Parâmetros disponíveis

URL query

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/disconnect Chave + Carregador

Revogue imediatamente este símbolo de instalação Odoo.

Input

Parâmetros disponíveis

Corpo JSON

Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/categories/sync Chave + Carregador

Sincronizar a hierarquia da categoria Odoo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 categorias Odoo por lote.

items[].external_id string Necessário

Identificador Odoo estável.

items[].name string Necessário

Visible name.

items[].parent_external_id string Optional

Categoria dos pais.

items[].translations object Optional

Nomes traduzidos chaveados pelo código de idioma.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/categories/archive Chave + Carregador

Esconder as categorias Odoo removidas do catálogo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Identificadores de categoria raiz a esconder.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/products/sync Chave + Carregador

Sincronizar variantes Odoo, referências, descrições, traduções, imagens, preços, IVA e estoque.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 produtos ou variantes Odoo por lote.

items[].external_id string Necessário

Estável product.product identificador da variante.

items[].parent_external_id string Optional

identificador product.template.

items[].sku string Optional

Referência interna do Odoo.

items[].barcode string Optional

Barcode.

items[].name string Necessário

Nome do produto ou variante.

items[].description string Optional

Descrição das vendas.

items[].regular_price decimal Optional

Odoo preço de venda.

items[].vat_rate decimal Optional

Primeira taxa de IVA aplicável.

items[].stock_quantity decimal Optional

Disponível ou na mão de acordo com a configuração Odoo.

items[].images array Optional

Até cinco URLs de imagem Odoo HTTPS assinados.

items[].translations object Optional

Nome e descrição em línguas Odoo activas.

items[].attributes array Optional

Atributos variáveis.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

PATCH /odoo/products/inventory Chave + Carregador

Atualize rapidamente os preços Odoo, estoque e visibilidade.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 500 atualizações de preço leve, estoque ou visibilidade.

items[].external_id string Necessário

Identificador estável de um registro já publicado product.product.

items[].stock_quantity decimal Optional

Quantidade disponível ou na mão de acordo com a configuração Odoo.

items[].stock_status enum Optional

instock | outofstock

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/products/archive Chave + Carregador

Ocultar produtos Odoo removidos, categorias ou subcategorias.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

entity_type enum Optional

product | category | subcategory

items array Necessário

Identificadores externos do Odoo para ocultar.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/customers/sync Chave + Carregador

Envie contatos Odoo para SellViaApp e prepare seu acesso móvel.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Até 250 contatos Odoo por lote.

items[].external_id string Necessário

Identificador res.partner estável.

items[].email e- mail Necessário

Email usado para acesso móvel.

items[].send_invitation booleano Optional

Envie o convite apenas ao criar a conta.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/customers/feed Chave + Carregador

Recuperar clientes SellViaApp para reconciliação segura em duplicata com contatos Odoo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

De 1 a 100 clientes por página.

cursor string Optional

Cursor opaco devolvido pela página anterior.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/orders/feed Chave + Carregador

Recupere ordens confirmadas SellViaApp em Odoo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

limit inteiro Optional

De 1 a 100 pedidos por página.

cursor string Optional

Cursor opaco devolvido pela página anterior.

unacknowledged_only booleano Optional

Retorne apenas ordens ainda não importadas.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

POST /odoo/orders/acknowledge Chave + Carregador

Grave o resultado de uma importação de ordem Odoo.

Input

Parâmetros disponíveis

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

items array Necessário

Importar resultados com identificador de ordem, status e referência Odoo.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Error example

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

GET /odoo/sync/logs Chave + Carregador

Veja o registro isolado de sincronização Odoo.

Input

Parâmetros disponíveis

URL query

NomeTipoRequirementDesignação das mercadorias

page inteiro Optional

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

per_page inteiro Optional

Número de resultados por página.

Output

Resultados possíveis

200Operação de sucesso

400Pedido inválido ou JSON

401Autenticação em falta ou inválida

403Acesso insuficiente

404Recurso solicitado não encontrado

409Conflito com os dados existentes

422Parâmetro rejeitado pela validação

429Limite de solicitação atingido

5xxIncidente técnico temporário

Exemplo de sucesso

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

Respostas e erros

Em «Parâmetros e respostas», consulte os campos obrigatórios e opcionais, os códigos de estado e exemplos JSON. Uma lista vazia indica apenas que ainda não há dados. Não significa que o endpoint esteja indisponível.

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