Documentação Completa
A documentação compelta pode ser encontrada no endereço: https://developer.getcommerce.com.br/wsdl/
URL para Integração
O ambiente de testes será liberado no endereço (https://demonstracao.getcommerce.com.br/api/v2_soap?wsdl=1). Após a conclusão da integração basta alterar o domínio para a loja do cliente.
Formatação de Dados
Peso, Preço e Estoque | Data |
---|---|
9.99 | aaaa-mm-dd |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento">
<soapenv:Header/>
<soapenv:Body>
<urn:loginParam>
<username>USUARIO</username>
<apiKey>SENHA</apiKey>
</urn:loginParam>
</soapenv:Body>
</soapenv:Envelope>
Categorias
Métodos
• catalogCategoryCreate - Cria Categoria
• catalogCategoryUpdate - Atualiza Categoria
• catalogCategoryDelete - Exclui Categoria
Exemplo de Criação
Chamada do método catalogCategoryCreate para criação de uma categoria.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento">
<soapenv:Header/>
<soapenv:Body>
<urn:catalogCategoryCreateRequestParam>
<sessionId>b14994660e809102baf5e02a0a2f615f</sessionId>
<parentId>2</parentId>
<categoryData>
<name>Categoria Teste</name>
<is_active>1</is_active>
<is_anchor>1</is_anchor>
<available_sort_by>
<complexObjectArray>use_config</complexObjectArray>
</available_sort_by>
<default_sort_by>use_config</default_sort_by>
<include_in_menu>1</include_in_menu>
</categoryData>
</urn:catalogCategoryCreateRequestParam>
</soapenv:Body>
</soapenv:Envelope>
Produtos
Métodos
• catalogProductCreate - Cria Produto
• catalogProductUpdate - Atualiza Produto
• catalogProductDelete - Exclui Produto
Valores para o campo 'status' (status) | Valores para o campo 'visibility' (visibilidade) |
---|---|
1 - Habilitado | 1 - Não Visível Individualmente |
2 - Desabilitado | 2 - Visível em Catálogo |
3 - Visível em Busca | |
4 - Visível em Catálogo e Busca |
Exemplo de Criação
Chamada do método catalogProductCreate para criação do produto simples (filho).
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento">
<soapenv:Header/>
<soapenv:Body>
<urn:catalogProductCreateRequestParam>
<sessionId>dcc6cf2b377aa62b0105f403d29abbd4</sessionId>
<type>simple</type>
<set>4</set>
<sku>produto-filho</sku>
<productData>
<categories>
<string>1</string>
<string>2</string>
</categories>
<name>Produto Teste</name>
<short_description>Produto Teste</short_description>
<weight>0.4</weight>
<status>1</status>
<visibility>4</visibility>
<price>100.20</price>
</productData>
</urn:catalogProductCreateRequestParam>
</soapenv:Body>
</soapenv:Envelope>
Estoque
Métodos
• catalogInventoryStockItemUpdate - Atualiza Estoque
Exemplo de Atualização
Chamada do método catalogInventoryStockItemUpdate para atualização do estoque.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento">
<soapenv:Header/>
<soapenv:Body>
<urn:catalogInventoryStockItemUpdateRequestParam>
<sessionId>e3743e387ee34d1fce79840688f730a2</sessionId>
<productId>1</productId>
<data>
<qty>2</qty>
<is_in_stock>1</is_in_stock>
</data>
</urn:catalogInventoryStockItemUpdateRequestParam>
</soapenv:Body>
</soapenv:Envelope>
Clientes
Métodos
• customer.list - Lista todos os clientes
• customer.info - Recupera informação de um cliente
Pedidos
Métodos
• sales_order.list - Lista todos os pedidos (pode ser utilizado filtros)
• sales_order.info - Recupera informação de um pedido
• sales_order.addComment - Adiciona comentário e/ou altera status para o pedido
• sales_order.cancel - Cancela um pedido
Faturamento de Pedido
Métodos
• sales_order_invoice.create - Fatura o Pedido
Envio do Pedido
Métodos
• sales_order_shipment.create - Cria um Envio
• sales_order_shipment.addTrack - Adiciona código de rastreio
• sales_order_shipment.getCarriers - Lista Serviços de Envio disponíveis