Fluxo Básico
Autenticação
API Explorer
Ajuda
Versão 1
Versão 2
Versão 3
Pedido ERP (v2):
Recurso para gerenciamento de pedidos
GET
v2/orders
Fila de integração
Notas:
Lista atualizada
Parâmetros de Entrada:
Parâmetros de Retorno:
Dados de Entrada:
Dados JSON de Retorno:
[
{
"updated_at": "2019-06-14T17:46:43",
"total_ordered": "822.56",
"tags": [],
"sync_status": "string",
"status": {
"type": "string",
"label": "string",
"code": "5555576"
},
"shipping_method": "string",
"shipping_cost": "24.556",
"shipping_carrier": "string",
"shipping_address": {
"street": "string",
"secondary_phone": "string",
"region": "string",
"reference": "string",
"postcode": "string",
"phone": "string",
"number": "string",
"neighborhood": "string",
"full_name": "string",
"detail": "string",
"country": "string",
"complement": "string",
"city": "string"
},
"shipped_date": "string",
"shipments": [],
"placed_at": "string",
"payments": [
{
"value": "string",
"transaction_date": "string",
"status": "string",
"sefaz": {
"type_integration": "0",
"payment_indicator": "0",
"name_payment": "string",
"name_card_issuer": "string",
"id_payment": "string",
"id_card_issuer": "string"
},
"parcels": "0",
"method": "string",
"description": "string",
"card_issuer": "string",
"autorization_id": "string"
}
],
"items": [
{
"special_price": "string",
"shipping_cost": "string",
"qty": "string",
"product_id": "string",
"original_price": "string",
"name": "string",
"id": "string",
"detail": "string"
}
],
"invoices": [{
"volume_qty": 0,
"number": "string",
"line": "string",
"key": "string",
"issue_date": "string"
}],
"interest": "0",
"import_info": {
"ss_name": "",
"remote_id": "string",
"remote_code": ""
},
"estimated_delivery_shift": "string",
"estimated_delivery": "string",
"discount": "0",
"delivery_contract_type": "string",
"delivered_date": "",
"customer": {
"vat_number": "string",
"phones": [
"string",
"string"
],
"name": "string",
"gender": "string",
"email": "string",
"date_of_birth": "string"
},
"code": "",
"channel": "",
"calculation_type": "string",
"billing_address": {
"street": "string",
"secondary_phone": "string",
"region": "string",
"reference": "string",
"postcode": "string",
"phone": "string",
"number": "0",
"neighborhood": "string",
"full_name": "string",
"detail": "string",
"country": "string",
"complement": "string",
"city": "string"
},
"approved_date": "string",
"origin": ""
}
]
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v2/orders/{numeroPedido}/cancel
Cancela Pedido
Notas:
Parâmetros de Entrada:
- Lista de Status:
cancel: (Tira da lista cancela)
{"status":"cancel"}
Parâmetros de Retorno:
{
"Code": "string",
"Label": "string"
}
Dados de Entrada:
orders/{pedido}/cancel
Dados JSON de Retorno:
{
"Code": "string",
"Label": "string"
}
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v2/orders/{numeroPedido}/invoice
Invoice Pedido
Notas:
Parâmetros de Entrada:
invoice : (Atualiza a nota fiscal)
{
"status": "invoice",
"invoice": {
"key": "string"
}
}
Parâmetros de Retorno:
{
"Code": "string",
"Label": "string"
}
Dados de Entrada:
orders/{pedido}/invoice
Dados JSON de Retorno:
{Code": "string",
"Label":"string"}
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v2/orders/{numeroPedido}/shipments
Shipments Pedido
Notas:
Parâmetros de Entrada:
shipments : (Atualiza para em viagem)
{
"status": "shipments",
"shipment": {
"code": "string",
"itens": [{
"sku": "string",
"qty": 0
}]
},
"track": {
"code": "string",
"carrier": "string",
"method": "string",
"url": "string"
}
}
Parâmetros de Retorno:
{
"Code": "string",
"Label": "string"
}
Dados de Entrada:
orders/{pedido}/shipments
Dados JSON de Retorno:
{Code": "string",
"Label":"string"}
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
DELETE
v2/orders/{pedido}
Deletar o pedido da fila
Notas:
Parâmetros de Entrada:
Parâmetros de Retorno:
Dados de Entrada:
orders/{pedido}
Dados JSON de Retorno:
{"Code": "string",
"Label": "string",
"Type": "string"
}
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v2/orders/{numeroPedido}/pedidoerp
Informe Pedido ERP
Notas:
Parâmetros de Entrada:
{"status":"pedidoerp",
"pedidoerp": "",
"fp": "",
"flf": ""
}
Parâmetros de Retorno:
Dados de Entrada:
orders/{pedido}/pedidoerp
Dados JSON de Retorno:
{"status":"string",
"pedidoerp": "string",
"fp": "integer",
"flf": "integer"
}
Codigos de Respostas:
200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Products:
Recurso para gerenciamento de produtos