Início

API REST Fortunyt Financial

Seja bem-vindo, aqui você irá encontrar a documentação necessária para utilizar todos os serviços desta API REST.

A API estará acessível em https://api.escritorio.fortunyt.com.br, este domínio poderá ser alterado devido a necessidades do cliente.

Especificações globais

Esta API utiliza o formato de texto JSON para o trafego de dados, como é de conhecimento JSON não é preparado para representar todos os tipos e formatos de dados existentes, para contornar essas limitações algumas convenções serão seguidas, abaixo detalhes sobre as convenções que são utilizadas globalmente pela API.

Data e Hora

Todos os atributos que representam Hora, Data ou Data e Hora são do tipo String e seguem a especificação ISO 8601, a qual é amplamente utilizada para representar data e hora, mais detalhes podem ser encontrados aqui.

URL Parâmetros

Todos os serviços que retornam mais que uma entidade, suportam na URL os parâmetros start_date e end_date, exemplo:

../products/all?start_date=2000-10-10&end_date=2017-10-10

A consulta acima irá retornar de modo paginado todos os produtos criados/cadastrados entre o período informado, este comportamento se aplica a todos os serviços que podem retornar um quantidade de entidades superior a um.

Versão do HTTP

A versão utilizada do protocolo HTTP é a HTTP/1.1.

GET /v1/status Status

É possível verificar se a API está funcionando, para isso basta acessar a URL abaixo, este é o único serviço que não necessita que o token de autenticação seja informado.

Requisição

https://api.escritorio.fortunyt.com.br/v1/status

Resposta

JSON resposta.

Status: 200 OK { "code": 200, "message": "OK" }

Para os casos de erro, veja códigos de status.

Códigos de status

Sucesso

Em caso de sucesso, o corpo da resposta conterá o JSON com a entidade ou entidades correspondentes ao recurso solicitado.

  • GET retorna 200 OK para sucesso

Erro

Respostas de erro retornam códigos de erro http padrão junto com alguma mensagem adicional:

A resposta inclui um cabeçalho com o código de erro e o corpo que contém o código de erro e uma mensagem que o descreve.

Exemplo de uma requisição com o token de autorização inválido:

Status: 401 Unauthorized { "code": 401, "errors": [ "Unauthorized" ] }

Exemplo de uma resposta com o recurso não disponível ou nada encontrado pela consulta:

Status: 404 Not Found { "code": 404, "errors": [ "Not Found" ] }

Os demais erros seguem o mesmo padrão dos exemplos.

Paginação

Alguns serviços podem retornar um quantidade massiva de entidades o que poderia causar diversos problemas os quais não serão abordados aqui, mas para evitar estes problemas a API implementa um esquema de paginação o qual está presente em todas as consultas que podem retornar mais que uma única entidade.

Exemplo: JSON com paginação

{ "pagination": { "current_page": 1, "total_pages": 2, "last_page": false, "per_page": 500, "total_records": 2 }, "records": [] }

Entendendo os atributos

“current_page” responsável por indicar qual é a página retornada, que em nosso exemplo é a página 1.

“total_pages” indica a quantidade de páginas em que o resultado da consulta foi dividido, no caso do exemplo o valor total são 2 páginas.

“per_page” atributo que indica o total de registros por página, no exemplo cada página contém até 500 registros, este número pode variar conforme o serviço consumido.

“last_page” por meio deste atributo é possível saber se a página atual é a última ou não, caso seja a última o valor será true, caso contrário será false.

“total_records” indica o total de entidades que foram encontradas, ou seja é a soma da quantidade de entidades presentes em todas as páginas.

“records” atributo que referencia o array que abriga as entidades da página atual.

Exemplo: Utilizando paginação

curl --request GET "https://api.escritorio.fortunyt.com.br/resource?page=2" --header "Authorization: meu_authorization_token"

Como pode ser observado no exemplo acima para navegar entre as páginas basta utilizar o parâmetro de URL page com o número da página desejada, no caso deste exemplo serão retornados os registros que pertencem a página 2.

Autenticação

Para consumir os serviços disponibilizados pela API é necessário enviar o seu token de autenticação por meio do header ‘Authorization’ em todos as requisições realizadas, caso ainda não tenha seu token entre em contato com a komeia.com.

Exemplo: Envio do token utilizando curl

curl --request GET "https://api.escritorio.fortunyt.com.br/resource" --header "Authorization: meu_authorization_token"

Para os casos de erro, veja códigos de status.

GET /v1/transactions/status/:status Consultar transações por status

Retorna de modo paginado as transações conforme o status informado.

Os status disponíveis para consulta são: credited, debited, locked, credit_locked, debit_locked.

Resposta

JSON com as transações e os atributos da paginação. Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 150, "total_records": 1 }, "records": [ { "description": "Bônus Indicação", "created_at": "2016-08-27T12:15:24.000Z", "origin": {}, "holder": { "id": "10634", "full_name": "CELINA LIZ REIS" }, "locked": false, "amount": 4500.1, "type": "credit", "id": "260" } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/transactions/id/:id Consultar transação por ID

Retorna uma transação conforme o ID informado.

Resposta

JSON da transação. Status: 200 OK { "description": "Bônus Indicação", "created_at": "2016-08-27T12:15:24.000Z", "origin": {}, "holder": { "id": "10634", "full_name": "CELINA LIZ REIS" }, "locked": false, "amount": 4500.1, "type": "credit", "id": "260" }

Entendendo os atributos complexos

“origin” este atributo até o momento da escrita deste documento pode variar entre um JSON de venda ou cliente.

“type” identifica se é uma transação de crédito ou débito, os valores possíveis são credit ou debit.

“locked” indica se o valor da transação já foi aplicado efetivamente ao saldo do cliente, seus possíveis valores são true ou false, exemplo: caso o type seja credit e o locked seja false, significa que o valor já foi creditado ao saldo do cliente, caso o locked seja true significa que o valor ainda será creditado ao saldo do cliente.

Para os casos de erro, veja códigos de status.

GET /v1/transactions/all Consultar todas transações

Retorna de modo paginado todas as transações cadastradas.

Resposta

JSON com as transações e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 150, "total_records": 1 }, "records": [ { "description": "Bônus Indicação", "created_at": "2016-08-27T12:15:24.000Z", "origin": {}, "holder": { "id": "10634", "full_name": "CELINA LIZ REIS" }, "locked": false, "amount": 4500.1, "type": "credit", "id": "260" } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/products/variant_id/:id Consultar produto por ID da variante

Retorna um produto conforme o ID da variante informada.

Resposta

JSON do produto.

Status: 200 OK { "id": "1", "name": "Pilha AAA", "sku": "1232", "ncm": "3212", "unit_measure": "UN", "category": "Baterias/Pilhas", "price": 12.75, "price_with_discount": 10, "description": "Pilhas palito tamanho AAA", "technical_specifications": "Pilhas para aparelhos eletrônicos", "created_at": "2016-08-26T13:38:51.000Z", "stock_quantity": 30, "weight": 2, "height": 1, "length": 3, "width": 2 }

Para os casos de erro, veja códigos de status.

GET /v1/products/id/:id Consultar produto por ID

Retorna um produto conforme o ID informado.

Resposta

JSON do produto.

Status: 200 OK { "id": "1", "name": "Pilha AAA", "sku": "1232", "ncm": "3212", "unit_measure": "UN", "category": "Baterias/Pilhas", "price": 10.5, "price_with_discount": 10, "description": "Pilhas palito tamanho AAA", "technical_specifications": "Pilhas para aparelhos eletrônicos", "created_at": "2016-08-26T13:38:51.000Z", "stock_quantity": 30, "weight": 2, "height": 1, "length": 3, "width": 2, "variants": [ { "id": "17", "name": "Pilha AAA Super", "stock_quantity": 5, "sku": "1233", "created_at": "2016-08-26T10:38:51.000Z" } ] }

Entendendo os atributos complexos

“variants” é uma representação simplificada de todas as variações existentes do produto em questão, por exemplo: imagine que temos o produto ‘Camiseta Vermelha’ o qual tem os tamanhos “P”, “M”, “G”, para representar esses tamanhos cadastramos as variações “P”, “M”, “G”, para consultar uma variante por seu ID acesse.

ATENÇÃO: Os atributos “description” e “technical_specifications” utilizam a linguagem de marcação Markdown

Para os casos de erro, veja códigos de status.

GET /v1/products/all Consultar todos os produtos

Retorna de modo paginado todos os produtos.

Resposta

JSON com os produtos e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "1", "name": "Pilha AAA", "sku": "1232", "ncm": "3212", "unit_measure": "UN", "category": "Baterias/Pilhas", "price": 10, "price_with_discount": 9.1, "description": "Pilhas palito tamanho AAA", "technical_specifications": "Pilhas para aparelhos eletrônicos", "created_at": "2016-08-26T13:38:51.000Z", "stock_quantity": 30, "weight": 2, "height": 1, "length": 3, "width": 2, "variants": [ { "id": "17", "name": "Pilha AAA Super", "stock_quantity": 5, "sku": "1233", "created_at": "2016-08-26T09:38:51.000Z" } ] }, { "id": "2", "name": "Bateria 12 amp", "sku": "3221", "ncm": "2345", "unit_measure": "UN", "category": "Baterias/Pilhas", "price": 15, "price_with_discount": 15, "description": "Bateria para controle", "technical_specifications": "Pilhas para aparelho s eletrônicos", "created_at": "2016-08-26T12:38:51.000Z", "stock_quantity": 45, "weight": 2, "height": 1.1, "length": 3.3, "width": 2, "variants": [ { "id": "18", "name": "Bateria 16 amp", "stock_quantity": 12, "sku": "3421", "created_at": "2016-08-26T20:38:51.000Z" } ] } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/orders/status/:status Consultar vendas por status

Retorna de modo paginado as vendas conforme o status informado.

Os status disponíveis para consulta são: paid, canceled, pending.

Resposta

JSON com as vendas e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/orders/shipping_service/:shipping_service Consultar vendas por serviço de frete

Retorna de modo paginado as vendas conforme o serviço de frete informado.

Para saber quais são os serviços disponíveis clique aqui.

Resposta

JSON com as vendas e os atributos da paginação

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/orders/payment_method/:payment_method Consultar vendas por método de pagamento

Retorna de modo paginado as vendas conforme o método de pagamento informado.

Para saber quais são os métodos de pagamento disponíveis clique aqui.

Resposta

JSON com as vendas e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/orders/id/:id Consultar venda por ID

Retorna uma venda conforme o ID informado.

Resposta

JSON da venda.

Status: 200 OK { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } }

Para os casos de erro, veja códigos de status.

GET /v1/orders/all Consultar todas as vendas

Retorna de modo paginado todas as vendas.

Resposta

JSON com as vendas e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/customers/status/:status Consultar clientes por status

Retorna de modo paginado os clientes conforme o status informado, os status disponíveis para consulta são: active e inactive.

Resposta

JSON com os clientes e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 300, "total_records": 2 }, "records": [ { "id": "11556", "person_type": "phisic", "sex": "male", "full_name": "GABRIEL NACK RAITZ", "birth_date": "1993-12-04", "marital_status": "single", "active": false, "cpf": "007.272.426-95", "cnpj": null, "rg": null, "pispasep": null, "phone_1": "(66) 9487-3728", "phone_2": null, "phone_3": null, "created_at": "2016-05-09T20:19:37.000Z", "user": { "login": "jennifernackraitz", "email": "jennifernackraitz@abelhinha153.com" }, "address": { "neighborhood": "Residencial Florença", "complement": "de 1171/1172 a 99998/99999", "zip_code": "78555418", "street": "Rua Nápolis", "number": "84737", "state": "MT", "city": "Sinop" } }, { "id": "71368", "person_type": "phisic", "sex": "male", "full_name": "JEREMIAS SARDA JUNKER", "birth_date": "1980-01-01", "marital_status": "single", "active": false, "cpf": "003.244.379-00", "cnpj": null, "rg": null, "pispasep": null, "phone_1": "(66) 8463-7628", "phone_2": null, "phone_3": null, "created_at": "2016-05-15T20:19:37.000Z", "user": { "login": "jeremiassardajunker", "email": "jeremiassardajunker@abelhinha153.com" }, "address": { "neighborhood": "Residencial Florença", "complement": "de 1171/1172 a 99998/99999", "zip_code": "78555418", "street": "Rua Nápolis", "number": "73627", "state": "MT", "city": "Sinop" } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/customers/id/:id Consultar cliente por ID

Retorna um cliente conforme o ID informado.

Resposta

JSON do cliente.

Status: 200 OK { "id": "11556", "person_type": "phisic", "sex": "male", "full_name": "GABRIEL NACK RAITZ", "birth_date": "1993-12-04", "marital_status": "single", "active": false, "cpf": "007.272.426-95", "cnpj": null, "rg": null, "pispasep": null, "phone_1": "(66) 9487-3728", "phone_2": null, "phone_3": null, "created_at": "2016-05-09T20:19:37.000Z", "user": { "login": "jennifernackraitz", "email": "jennifernackraitz@abelhinha153.com" }, "address": { "neighborhood": "Residencial Florença", "complement": "de 1171/1172 a 99998/99999", "zip_code": "78555418", "street": "Rua Nápolis", "number": "84737", "state": "MT", "city": "Sinop" } }

Para os casos de erro, veja códigos de status.

GET /v1/customers/all Consultar todos clientes

Retorna de modo paginado todos os clientes.

Resposta

JSON com os clientes e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 300, "total_records": 2 }, "records": [ { "id": "11556", "person_type": "phisic", "sex": "male", "full_name": "GABRIEL NACK RAITZ", "birth_date": "1993-12-04", "marital_status": "single", "active": false, "cpf": "007.272.426-95", "cnpj": null, "rg": null, "pispasep": null, "phone_1": "(66) 9487-3728", "phone_2": null, "phone_3": null, "created_at": "2016-05-09T20:19:37.000Z", "user": { "login": "jennifernackraitz", "email": "jennifernackraitz@abelhinha153.com" }, "address": { "neighborhood": "Residencial Florença", "complement": "de 1171/1172 a 99998/99999", "zip_code": "78555418", "street": "Rua Nápolis", "number": "84737", "state": "MT", "city": "Sinop" } }, { "id": "71368", "person_type": "phisic", "sex": "male", "full_name": "JEREMIAS SARDA JUNKER", "birth_date": "1980-01-01", "marital_status": "single", "active": false, "cpf": "003.244.379-00", "cnpj": null, "rg": null, "pispasep": null, "phone_1": "(66) 8463-7628", "phone_2": null, "phone_3": null, "created_at": "2016-05-15T20:19:37.000Z", "user": { "login": "jeremiassardajunker", "email": "jeremiassardajunker@abelhinha153.com" }, "address": { "neighborhood": "Residencial Florença", "complement": "de 1171/1172 a 99998/99999", "zip_code": "78555418", "street": "Rua Nápolis", "number": "73627", "state": "MT", "city": "Sinop" } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/dc_orders/status/:status Consultar vendas por status

Retorna de modo paginado as vendas conforme o status informado.

Os status disponíveis para consulta são: paid, canceled, pending.

Resposta

JSON com as vendas e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/dc_orders/shipping_service/:shipping_service Consultar vendas por serviço de frete

Retorna de modo paginado as vendas realizadas para os centros de distribuição conforme o serviço de frete informado.

Para saber quais são os serviços disponíveis clique aqui.

Resposta

JSON com as vendas e os atributos da paginação

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/dc_orders/payment_method/:payment_method Consultar vendas por método de pagamento

Retorna de modo paginado as vendas realizadas para os centros de distribuição conforme o método de pagamento informado.

Para saber quais são os métodos de pagamento disponíveis clique aqui.

Resposta

JSON com as vendas e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/dc_orders/id/:id Consultar venda por ID

Retorna uma venda realizada para um centro de distribuição conforme o ID informado.

Resposta

JSON da venda.

Status: 200 OK { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } }

Para os casos de erro, veja códigos de status.

GET /v1/dc_orders/all Consultar todas as vendas

Retorna de modo paginado todas as vendas realizadas para os centros de distribuição.

Resposta

JSON com as vendas e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 100, "total_records": 2 }, "records": [ { "id": "21", "status": "paid", "created_at": "2016-09-15T12:15:23.000Z", "paid_at": "2016-09-15T12:15:23.000Z", "canceled_at": null, "extra": null, "items": [ { "unit_amount_discount": 5, "total_amount_discount": 10, "total_amount": 10, "unit_amount": 10, "quantity": 2, "name": "Pilha AAA", "id": "16" } ], "customer": { "identity_type": "cpf", "full_name": "José da Silva", "identity": "324.212.782-03", "id": "3" }, "shipping": { "tracking_number": "02349812", "provider": "Correios", "amount": 15.55, "service": "Sedex" }, "delivery_address": { "neighborhood": "Vila Esperança", "complement": "Em frente ao parque", "zip_code": "86067-480", "street": "Rua Manaus", "number": "387", "state": "PR", "city": "Londrina" }, "payment": { "installments": 1, "provider": "Pagkom", "method": "deposit", "discount_amount": 10, "balance_amount_used": 5, "amount_without_discount": 35.55, "amount": 20.55 } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/dc_transactions/status/:status Consultar transações por status

Retorna de modo paginado as transações conforme o status informado.

Os status disponíveis para consulta são: credited, debited, locked, credit_locked, debit_locked.

Resposta

JSON com as transações e os atributos da paginação.

Status: 200 OK { "pagination": { "current_page": 1, "total_pages": 1, "last_page": true, "per_page": 150, "total_records": 1 }, "records": [ { "id": "260", "locked": false, "amount": 4500.1, "type": "credit", "description": "Saque ID: 1", "created_at": "2016-08-27T12:15:24.000Z", "origin": {}, "holder": { "id": "1", "name": "Centro de distribuição 1" } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação.

GET /v1/dc_transactions/id/:id Consultar transação por ID

Retorna uma transação conforme o ID informado.

Resposta

JSON da transação.

Status: 200 OK { "id": "260", "locked": false, "amount": 4500.1, "type": "credit", "description": "Saque ID: 1", "created_at": "2016-08-27T12:15:24.000Z", "origin": {}, "holder": { "id": "1", "name": "Centro de distribuição 1" } }

Entendendo os atributos complexos

“origin” este atributo até o momento da escrita deste documento pode variar entre um JSON de venda ou saque.

“type” identifica se é uma transação de crédito ou débito, os valores possíveis são credit ou debit.

“locked” indica se o valor da transação já foi aplicado efetivamente ao saldo do centro de distribuição, seus possíveis valores são true ou false, exemplo: caso o type seja credit e o locked seja false, significa que o valor já foi creditado ao saldo do centro de distribuição, caso o locked seja true significa que o valor ainda será creditado ao saldo do centro de distribuição.

Para os casos de erro, veja códigos de status.

GET /v1/distribution_centers/id/:id Consultar CD por ID

Retorna um centro de distribuição conforme o ID informado.

Resposta

JSON do centro de distribuição.

Status: 200 OK { "id": "1", "reserved_balance": 0, "net_balance": 1512.13, "raw_balance": 1512.13, "email": "cd1@email.com", "percentage_off_on_buy": 10, "name": "Centro de distribuição 1", "percentage_for_each_order_delivered": 5, "created_at": "2016-05-09T20:19:37.000Z", "phones": "\n(18) 3333-1234\n\n(11) 55555-5555\n", "manager": { "complement": "", "cpf": "226.371.278-05", "email": "cd1@email.com", "full_name": "José Silva", "phone": "(43) 1111-1111", "cellphone": "(43) 66666-6666" }, "address": { "state": "PR", "number": "312", "city": "Londrina", "zip_code": "86010-540", "neighborhood": "Vila Ipiranga", "complement": "de 2649/2650 a 4024/4025", "street": "Avenida Juscelino Kubitschek" } }

ATENÇÃO: O atributo “phones” utiliza a linguagem de marcação Markdown

Para os casos de erro, veja códigos de status.

GET /v1/orders/shipping_services_available Consultar serviços de frete disponíveis

Retorna todos os serviços de frete disponíveis para realizar a consulta das vendas por serviço de frete.

Resposta

JSON com os serviços de frete disponíveis para consulta

Status: 200 OK [ "Sedex", "PAC" ]

GET /v1/orders/payment_methods_available Consultar métodos de pagamento disponíveis

Retorna todos os métodos de pagamento disponíveis para realizar a consulta das vendas por método de pagamento.

Resposta

JSON com os os métodos de pagamentos disponíveis para consulta

Status: 200 OK [ "deposit", "credit_card", "payment_slip" ]

GET /v1/distribution_centers/all Consultar todos CDs

Retorna de modo paginado todos os centros de distribuição.

Resposta

JSON com os centros de distribuição e os atributos da paginação.

Status: 200 OK { "pagination": { "per_page": 300, "total_pages": 1, "current_page": 1, "last_page": true, "total_records": 1 }, "records": [ { "id": "1", "reserved_balance": 0, "net_balance": 1512.13, "raw_balance": 1512.13, "email": "cd1@email.com", "percentage_off_on_buy": 10, "name": "Centro de distribuição 1", "percentage_for_each_order_delivered": 5, "created_at": "2016-05-09T20:19:37.000Z", "phones": "\n(18) 3333-1234\n\n(11) 55555-5555\n", "manager": { "complement": "", "cpf": "226.371.278-05", "email": "cd1@email.com", "full_name": "José Silva", "phone": "(43) 1111-1111", "cellphone": "(43) 66666-6666" }, "address": { "state": "PR", "number": "312", "city": "Londrina", "zip_code": "86010-540", "neighborhood": "Vila Ipiranga", "complement": "de 2649/2650 a 4024/4025", "street": "Avenida Juscelino Kubitschek" } } ] }

Para os casos de erro, veja códigos de status e para mais informações sobre o modo paginado, acesse paginação

GET /v1/dc_transactions/all Consultar todas transações

Retorna de modo paginado todas as transações dos centros de distribuição.

Resposta

JSON com as transações e os atributos da paginação.

Status: 200 OK

{ "pagination": { "per_page": 150, "total_pages": 1, "current_page": 1, "last_page": true, "total_records": 1 }, "records": [ { "id": "260", "locked": false, "amount": 4500.1, "type": "credit", "description": "Saque ID: 1", "created_at": "2016-08-27T12:15:24.000Z", "origin": {}, "holder": { "id": "1", "name": "Centro de distribuição 1" } } ] }

Para os casos de erro, veja códigos de status.

GET /v1/dc_orders/shipping_services_available Consultar serviços de frete disponíveis

Retorna todos os serviços de frete disponíveis para realizar a consulta das vendas por serviço de frete.

Resposta

JSON com os serviços de frete disponíveis para consulta

Status: 200 OK [ "Sedex", "PAC" ]

GET /v1/dc_orders/payment_methods_available Consultar métodos de pagamento disponíveis

Retorna todos os métodos de pagamento disponíveis para realizar a consulta das vendas por método de pagamento.

Resposta

JSON com os os métodos de pagamentos disponíveis para consulta

Status: 200 OK [ "deposit", "credit_card", "payment_slip" ]