{"_id":"574ddb66ea0af21900bdfb86","link_external":false,"order":0,"body":"Abaixo são feitas algumas considerações acerca da documentação.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Qual é o seu negócio?\"\n}\n[/block]\nA Rapiddo trabalha com entregas super expressas e a integração com nosso sistema é feita de modo a facilitar o uso de nossos serviços. Abaixo os públicos alvo de nossa documentação:\n\n1. Entregas administrativas/e-commerces - Solicitação de entregas com um ponto de coleta e um ou múltiplos pontos de entrega. É possível entregar documentos ou pacotes. Saiba mais sobre o serviço [aqui](http://entregas.rapiddo.com.br)\n2. Delivery de comida - Solicitação de entregas com um ponto de coleta e um de entrega, podendo ou não haver retorno (para devolução de troco ou máquina de cartão de crédito). Saiba mais sobre o serviço [aqui](http://food.rapiddo.com.br) \n3. Farmácias, SaaS (sistema para gestão de frota própria) e outros serviços - Entre em contato com nossa equipe comercial para saber como podemos te atender\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Entregas administrativas/e-commerces\"\n}\n[/block]\nO Rapiddo trabalha com integrações diretas:\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Magento e Ciashop\",\n  \"body\": \"O aplicação Ciashop e o plugin para Magento não estão mais sendo suportados, porém para usuários de ambas as plataformas, ainda é possível que se faça a integração direta, usando nossas APIs\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tracking\"\n}\n[/block]\nNo caso de clientes tracking, todas as APIs de integração estão disponíveis.","createdAt":"2016-05-31T18:43:50.550Z","githubsync":"","hidden":false,"title":"Primeiros passos","version":"552ed3282594f70d001b2d6d","category":"553feb536a7d010d0057c963","excerpt":"","isReference":false,"slug":"sobre-a-documentação","link_url":"","project":"552ed3282594f70d001b2d69","type":"basic","updates":[],"user":"56533f1854e3e221002c28ea","__v":8,"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"parentDoc":null,"sync_unique":"","next":{"description":"","pages":[]},"childrenPages":[]}

Primeiros passos


Abaixo são feitas algumas considerações acerca da documentação. [block:api-header] { "type": "basic", "title": "Qual é o seu negócio?" } [/block] A Rapiddo trabalha com entregas super expressas e a integração com nosso sistema é feita de modo a facilitar o uso de nossos serviços. Abaixo os públicos alvo de nossa documentação: 1. Entregas administrativas/e-commerces - Solicitação de entregas com um ponto de coleta e um ou múltiplos pontos de entrega. É possível entregar documentos ou pacotes. Saiba mais sobre o serviço [aqui](http://entregas.rapiddo.com.br) 2. Delivery de comida - Solicitação de entregas com um ponto de coleta e um de entrega, podendo ou não haver retorno (para devolução de troco ou máquina de cartão de crédito). Saiba mais sobre o serviço [aqui](http://food.rapiddo.com.br) 3. Farmácias, SaaS (sistema para gestão de frota própria) e outros serviços - Entre em contato com nossa equipe comercial para saber como podemos te atender [block:api-header] { "type": "basic", "title": "Entregas administrativas/e-commerces" } [/block] O Rapiddo trabalha com integrações diretas: [block:callout] { "type": "warning", "title": "Magento e Ciashop", "body": "O aplicação Ciashop e o plugin para Magento não estão mais sendo suportados, porém para usuários de ambas as plataformas, ainda é possível que se faça a integração direta, usando nossas APIs" } [/block] [block:api-header] { "type": "basic", "title": "Tracking" } [/block] No caso de clientes tracking, todas as APIs de integração estão disponíveis.
Abaixo são feitas algumas considerações acerca da documentação. [block:api-header] { "type": "basic", "title": "Qual é o seu negócio?" } [/block] A Rapiddo trabalha com entregas super expressas e a integração com nosso sistema é feita de modo a facilitar o uso de nossos serviços. Abaixo os públicos alvo de nossa documentação: 1. Entregas administrativas/e-commerces - Solicitação de entregas com um ponto de coleta e um ou múltiplos pontos de entrega. É possível entregar documentos ou pacotes. Saiba mais sobre o serviço [aqui](http://entregas.rapiddo.com.br) 2. Delivery de comida - Solicitação de entregas com um ponto de coleta e um de entrega, podendo ou não haver retorno (para devolução de troco ou máquina de cartão de crédito). Saiba mais sobre o serviço [aqui](http://food.rapiddo.com.br) 3. Farmácias, SaaS (sistema para gestão de frota própria) e outros serviços - Entre em contato com nossa equipe comercial para saber como podemos te atender [block:api-header] { "type": "basic", "title": "Entregas administrativas/e-commerces" } [/block] O Rapiddo trabalha com integrações diretas: [block:callout] { "type": "warning", "title": "Magento e Ciashop", "body": "O aplicação Ciashop e o plugin para Magento não estão mais sendo suportados, porém para usuários de ambas as plataformas, ainda é possível que se faça a integração direta, usando nossas APIs" } [/block] [block:api-header] { "type": "basic", "title": "Tracking" } [/block] No caso de clientes tracking, todas as APIs de integração estão disponíveis.
{"_id":"574c4aeea1f0be2000ae36ef","__v":15,"category":"555f3dca57fe0a0d00c8f45a","excerpt":"Aqui você encontra informações referentes aos primeiros passos que devem ser tomados para que a integração seja feita com sucesso.","hidden":false,"order":0,"parentDoc":null,"user":"56533f1854e3e221002c28ea","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","params":[]},"isReference":false,"link_external":false,"title":"Primeiros passos","updates":[],"link_url":"","project":"552ed3282594f70d001b2d69","slug":"primeiros-passos","sync_unique":"","version":"552ed3282594f70d001b2d6d","body":"Para se fazer uma integração entre seu sistema e o sistema do Rapiddo, é necessário que você tenha:\n\n1. Conta na Rapiddo, como empresa\n2. Forma de pagamento configurada\n3. Pelo menos um depósito cadastrado, _no caso do envio de pedidos_\n4. Horários de roteirização configurados\n5. Chave de acesso à API criada e ativa\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Criação de conta\"\n}\n[/block]\nAntes de iniciar a integração, é necessário cadastro na Rapiddo como empresa. Caso ainda não possua uma conta na Rapiddo, os passos são bastante simples:\n1. <a href=\"https://www.rapiddo.com.br/app/#/\" target=\"_blank\">Acesse a página inicial da Rapiddo</a> para Integração, no Rapiddo.\n2. Clique em *Cadastrar* e selecione *Empresa**\n3. Preencha todos os dados e clique em *Cadastrar*\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Cadastro da forma de pagamento\"\n}\n[/block]\nUma vez cadastrado como empresa na Rapiddo, é necessário cadastrar a forma de pagamento, importante para que os pedidos sejam aceitos pelo sistema. Para tal\n1. Faça login <a href=\"https://www.rapiddo.com.br/app/#/\" target=\"_blank\">Acesse a página inicial da Rapiddo</a>, clicando em *Minha Conta*\n2. Clique em *Minha Conta* > *Pagamento*\n3. Selecione uma das modalidades (*Boleto* ou *Cartão de crédito*) e preencha os dados\n4. Clique em *Enviar*\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Cadastro de depósito\"\n}\n[/block]\nNo caso da API de pedidos (Orders), cada item a ser entregue está localizado em um depósito específico que deve ser existir previamente em nosso sistema e que é referenciado no pedido através de seu alias, isto é, representa o local/endereço onde o pedido deve ser coletado. Para cadastrar um depósito, siga os seguintes passos:\n1. Faça login <a href=\"https://www.rapiddo.com.br/app/#/\" target=\"_blank\">Acesse a página inicial da Rapiddo</a>, clicando em *Minha Conta*\n2. Clique em *Roteirizador* > *Depósito* > *Inserir novo Depósito*\n3. Preencha os dados do depósito e clique em salvar. \n\n**Importante:**\n* O campo *Depósito* representa o nome do depósito e será usado na inclusão do pedido, *exatamente como informado nesse campo*\n* Caso a opção *Roteirizador* não esteja disponível na interface, entrar em contato com nossa equipe através de api@rapiddo.com.br\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Configuração dos horários de roteirização\"\n}\n[/block]\nNo atual momento a configuração dos horários de roteirização não está disponível na interface nova acessada pelos nossos clientes, porém é possível realizar essa configuração através da interface antiga. Para tal, siga os seguintes passos:\n1. Faça login <a href=\"https://b2b.rapiddo.com.br/api\" target=\"_blank\">na interface antiga da Rapiddo</a>, clicando em *Login*\n2. Uma vez logado no <a href=\"https://b2b.rapiddo.com.br/api\" target=\"_blank\">painel de configuração</a>, vá até (3)\n3. Selecione os horários de roteirização e a quantidade de itens que podem ser transportados no baú da moto (essa informação é necessária e será usada caso não sejam informados tamanhos individuais dos pacotes na inclusão dos pedidos)\n4. Clique em *Salvar*\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Criação da chave de acesso à API e autenticação\"\n}\n[/block]\nNo atual momento a configuração dos horários de roteirização não está disponível na interface nova acessada pelos nossos clientes, porém é possível realizar essa configuração através da interface antiga. Para tal, siga os seguintes passos:\n1. Faça login <a href=\"https://b2b.rapiddo.com.br/api\" target=\"_blank\">na interface antiga da Rapiddo</a>, clicando em *Login*\n2. Uma vez logado no <a href=\"https://b2b.rapiddo.com.br/api\" target=\"_blank\">painel de configuração</a>, vá até (5)\n3. Clique em Criar Chave de Acesso","createdAt":"2016-05-30T14:15:10.676Z","githubsync":"","type":"basic","childrenPages":[]}

Primeiros passos

Aqui você encontra informações referentes aos primeiros passos que devem ser tomados para que a integração seja feita com sucesso.

Para se fazer uma integração entre seu sistema e o sistema do Rapiddo, é necessário que você tenha: 1. Conta na Rapiddo, como empresa 2. Forma de pagamento configurada 3. Pelo menos um depósito cadastrado, _no caso do envio de pedidos_ 4. Horários de roteirização configurados 5. Chave de acesso à API criada e ativa [block:api-header] { "type": "basic", "title": "Criação de conta" } [/block] Antes de iniciar a integração, é necessário cadastro na Rapiddo como empresa. Caso ainda não possua uma conta na Rapiddo, os passos são bastante simples: 1. <a href="https://www.rapiddo.com.br/app/#/" target="_blank">Acesse a página inicial da Rapiddo</a> para Integração, no Rapiddo. 2. Clique em *Cadastrar* e selecione *Empresa** 3. Preencha todos os dados e clique em *Cadastrar* [block:api-header] { "type": "basic", "title": "Cadastro da forma de pagamento" } [/block] Uma vez cadastrado como empresa na Rapiddo, é necessário cadastrar a forma de pagamento, importante para que os pedidos sejam aceitos pelo sistema. Para tal 1. Faça login <a href="https://www.rapiddo.com.br/app/#/" target="_blank">Acesse a página inicial da Rapiddo</a>, clicando em *Minha Conta* 2. Clique em *Minha Conta* > *Pagamento* 3. Selecione uma das modalidades (*Boleto* ou *Cartão de crédito*) e preencha os dados 4. Clique em *Enviar* [block:api-header] { "type": "basic", "title": "Cadastro de depósito" } [/block] No caso da API de pedidos (Orders), cada item a ser entregue está localizado em um depósito específico que deve ser existir previamente em nosso sistema e que é referenciado no pedido através de seu alias, isto é, representa o local/endereço onde o pedido deve ser coletado. Para cadastrar um depósito, siga os seguintes passos: 1. Faça login <a href="https://www.rapiddo.com.br/app/#/" target="_blank">Acesse a página inicial da Rapiddo</a>, clicando em *Minha Conta* 2. Clique em *Roteirizador* > *Depósito* > *Inserir novo Depósito* 3. Preencha os dados do depósito e clique em salvar. **Importante:** * O campo *Depósito* representa o nome do depósito e será usado na inclusão do pedido, *exatamente como informado nesse campo* * Caso a opção *Roteirizador* não esteja disponível na interface, entrar em contato com nossa equipe através de api@rapiddo.com.br [block:api-header] { "type": "basic", "title": "Configuração dos horários de roteirização" } [/block] No atual momento a configuração dos horários de roteirização não está disponível na interface nova acessada pelos nossos clientes, porém é possível realizar essa configuração através da interface antiga. Para tal, siga os seguintes passos: 1. Faça login <a href="https://b2b.rapiddo.com.br/api" target="_blank">na interface antiga da Rapiddo</a>, clicando em *Login* 2. Uma vez logado no <a href="https://b2b.rapiddo.com.br/api" target="_blank">painel de configuração</a>, vá até (3) 3. Selecione os horários de roteirização e a quantidade de itens que podem ser transportados no baú da moto (essa informação é necessária e será usada caso não sejam informados tamanhos individuais dos pacotes na inclusão dos pedidos) 4. Clique em *Salvar* [block:api-header] { "type": "basic", "title": "Criação da chave de acesso à API e autenticação" } [/block] No atual momento a configuração dos horários de roteirização não está disponível na interface nova acessada pelos nossos clientes, porém é possível realizar essa configuração através da interface antiga. Para tal, siga os seguintes passos: 1. Faça login <a href="https://b2b.rapiddo.com.br/api" target="_blank">na interface antiga da Rapiddo</a>, clicando em *Login* 2. Uma vez logado no <a href="https://b2b.rapiddo.com.br/api" target="_blank">painel de configuração</a>, vá até (5) 3. Clique em Criar Chave de Acesso
Para se fazer uma integração entre seu sistema e o sistema do Rapiddo, é necessário que você tenha: 1. Conta na Rapiddo, como empresa 2. Forma de pagamento configurada 3. Pelo menos um depósito cadastrado, _no caso do envio de pedidos_ 4. Horários de roteirização configurados 5. Chave de acesso à API criada e ativa [block:api-header] { "type": "basic", "title": "Criação de conta" } [/block] Antes de iniciar a integração, é necessário cadastro na Rapiddo como empresa. Caso ainda não possua uma conta na Rapiddo, os passos são bastante simples: 1. <a href="https://www.rapiddo.com.br/app/#/" target="_blank">Acesse a página inicial da Rapiddo</a> para Integração, no Rapiddo. 2. Clique em *Cadastrar* e selecione *Empresa** 3. Preencha todos os dados e clique em *Cadastrar* [block:api-header] { "type": "basic", "title": "Cadastro da forma de pagamento" } [/block] Uma vez cadastrado como empresa na Rapiddo, é necessário cadastrar a forma de pagamento, importante para que os pedidos sejam aceitos pelo sistema. Para tal 1. Faça login <a href="https://www.rapiddo.com.br/app/#/" target="_blank">Acesse a página inicial da Rapiddo</a>, clicando em *Minha Conta* 2. Clique em *Minha Conta* > *Pagamento* 3. Selecione uma das modalidades (*Boleto* ou *Cartão de crédito*) e preencha os dados 4. Clique em *Enviar* [block:api-header] { "type": "basic", "title": "Cadastro de depósito" } [/block] No caso da API de pedidos (Orders), cada item a ser entregue está localizado em um depósito específico que deve ser existir previamente em nosso sistema e que é referenciado no pedido através de seu alias, isto é, representa o local/endereço onde o pedido deve ser coletado. Para cadastrar um depósito, siga os seguintes passos: 1. Faça login <a href="https://www.rapiddo.com.br/app/#/" target="_blank">Acesse a página inicial da Rapiddo</a>, clicando em *Minha Conta* 2. Clique em *Roteirizador* > *Depósito* > *Inserir novo Depósito* 3. Preencha os dados do depósito e clique em salvar. **Importante:** * O campo *Depósito* representa o nome do depósito e será usado na inclusão do pedido, *exatamente como informado nesse campo* * Caso a opção *Roteirizador* não esteja disponível na interface, entrar em contato com nossa equipe através de api@rapiddo.com.br [block:api-header] { "type": "basic", "title": "Configuração dos horários de roteirização" } [/block] No atual momento a configuração dos horários de roteirização não está disponível na interface nova acessada pelos nossos clientes, porém é possível realizar essa configuração através da interface antiga. Para tal, siga os seguintes passos: 1. Faça login <a href="https://b2b.rapiddo.com.br/api" target="_blank">na interface antiga da Rapiddo</a>, clicando em *Login* 2. Uma vez logado no <a href="https://b2b.rapiddo.com.br/api" target="_blank">painel de configuração</a>, vá até (3) 3. Selecione os horários de roteirização e a quantidade de itens que podem ser transportados no baú da moto (essa informação é necessária e será usada caso não sejam informados tamanhos individuais dos pacotes na inclusão dos pedidos) 4. Clique em *Salvar* [block:api-header] { "type": "basic", "title": "Criação da chave de acesso à API e autenticação" } [/block] No atual momento a configuração dos horários de roteirização não está disponível na interface nova acessada pelos nossos clientes, porém é possível realizar essa configuração através da interface antiga. Para tal, siga os seguintes passos: 1. Faça login <a href="https://b2b.rapiddo.com.br/api" target="_blank">na interface antiga da Rapiddo</a>, clicando em *Login* 2. Uma vez logado no <a href="https://b2b.rapiddo.com.br/api" target="_blank">painel de configuração</a>, vá até (5) 3. Clique em Criar Chave de Acesso
{"_id":"574c5e66a1f0be2000ae372d","excerpt":"","title":"Informações Gerais","link_url":"","order":0,"slug":"informações-gerais-1","sync_unique":"","version":"552ed3282594f70d001b2d6d","__v":1,"githubsync":"","link_external":false,"hidden":false,"project":"552ed3282594f70d001b2d69","updates":[],"category":"5731e5c6900b680e00cb3c73","createdAt":"2016-05-30T15:38:14.039Z","parentDoc":null,"type":"basic","user":"56533f1854e3e221002c28ea","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","params":[]},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"O que é um Order?\"\n}\n[/block]\nOrders são objetos que representam pedidos que serão executados pelos entregadores. Um order sempre está relacionado com um depósito e basicamente representa algo que será coletado no depósito e entregue em um destino.\n\nEssa API é útil especialmente para ecommerces e deliveries, pois conseguem captar exatamente sua necessidade.","isReference":false,"childrenPages":[]}

Informações Gerais


[block:api-header] { "type": "basic", "title": "O que é um Order?" } [/block] Orders são objetos que representam pedidos que serão executados pelos entregadores. Um order sempre está relacionado com um depósito e basicamente representa algo que será coletado no depósito e entregue em um destino. Essa API é útil especialmente para ecommerces e deliveries, pois conseguem captar exatamente sua necessidade.
[block:api-header] { "type": "basic", "title": "O que é um Order?" } [/block] Orders são objetos que representam pedidos que serão executados pelos entregadores. Um order sempre está relacionado com um depósito e basicamente representa algo que será coletado no depósito e entregue em um destino. Essa API é útil especialmente para ecommerces e deliveries, pois conseguem captar exatamente sua necessidade.
{"_id":"574da4d90db0870e007539f1","category":"5731e5c6900b680e00cb3c73","excerpt":"","order":1,"type":"basic","body":"No caso de clientes que roteirizam seus pedidos, os volumes dos pedidos - que constam em um mesmo lote de roteirização e que são de um mesmo depósito - são considerados para que sejam distribuídos em diferentes rotas de entrega, isto é, são considerados para viabilizar a coleta de forma que todos os pedidos em uma rota caibam no modal em questão (por exemplo, no baú da moto do entregador), sendo assim, é muito importante que os campos que são capazes de descrever o volume total de um pedido sejam enviados:\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Campo \\\"amount\\\"\"\n}\n[/block]\nTrata-se de um campo obrigatório, porém será substituído pelo campo \"packages\", caso seja informado, dado que é um campo que descreve a quantidade de pacotes de tamanho padrão abstrato.\nO volume ocupado por cada unidade em \"amount\" é configurado **prévia e indiretamente** (vide \"Primeiros passos\" em \"API Rapiddo\"); se configura a quantidade de pacotes padrão que cabem no baú da moto e a partir dessa configuração calculamos o volume padrão de cada pacote.\nPara efeitos de volumetria, a quantidade informada em \"amount\" é multiplicada pelo volume padrão, de modo que assim obtemos o volume total ocupado pelo pedido.\nA possível imprecisão dessa medida justifica a preferência por sempre enviar \"packages\", dado que esse campo pode descrever com exatidão todos os pacotes que estão atrelados ao pedido em questão\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Campo \\\"packages\\\"\"\n}\n[/block]\nTrata-se de um campo opcional, porém deve se dar a preferência por enviá-lo sempre, dado que é a descrição mais fiel das dimensões físicas dos componentes do pedido. \nDescreve as dimensões, pesos e quantidades de cada pacote que faz parte de um pedido; trata-se de uma string que representa um JSON. Caso seja enviado, esse campo será utilizado, em lugar de \"amount\", para descrever os volumes, durante o processo de roteirização.\nAbaixo encontra-se a descrição do objeto literal (em JavaScript) que descreve o campo, porém é importante notar que o campo em si é uma string e que se espera o formato JSON - optou-se descrever em um objeto literal pela simplicidade.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/*\\n\\tJavaScript object representando a descrição do parâmetro \\\"packages\\\". \\n*/\\n{\\n  items: [\\t\\t\\t\\t\\t\\t// Lista de itens (ou pacotes) que fazem parte do pedido\\n    {\\t\\t\\t\\t\\t\\t\\t\\t\\t// DESCRIÇÃO DO PRIMEIRO PACOTE:\\n      quantity: 1,\\t\\t// * Quantidade de pacotes iguais a esse\\n      weight: 1.0, \\t\\t// * Peso do pacote (em quilogramas)\\n      height: 3.0, \\t\\t// * Altura do pacote (em centimetros)\\n      width: 4.0, \\t\\t// * Largura do pacote (em centímetros)\\n      length: 5.0\\t\\t\\t// * Comprimento do pacote (em centímetros)\\n    }, \\n    {\\n      quantity: 2, \\n      weight: 2.0, \\n      height: 4.0, \\n      width:5.0, \\n      length: 6.0\\n    }, \\n    {\\n      quantity: 1, \\n      weight: 3.0, \\n      height: 5.0, \\n      width:6.0, \\n      length: 7.0\\n    }\\n  ]\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","hidden":false,"link_external":false,"link_url":"","project":"552ed3282594f70d001b2d69","updates":[],"__v":5,"createdAt":"2016-05-31T14:51:05.356Z","githubsync":"","isReference":false,"title":"Dimensões/Cubagem dos Pedidos","user":"56533f1854e3e221002c28ea","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"parentDoc":null,"slug":"dimensoes-cubagem-dos-pedidos","sync_unique":"","version":"552ed3282594f70d001b2d6d","childrenPages":[]}

Dimensões/Cubagem dos Pedidos


No caso de clientes que roteirizam seus pedidos, os volumes dos pedidos - que constam em um mesmo lote de roteirização e que são de um mesmo depósito - são considerados para que sejam distribuídos em diferentes rotas de entrega, isto é, são considerados para viabilizar a coleta de forma que todos os pedidos em uma rota caibam no modal em questão (por exemplo, no baú da moto do entregador), sendo assim, é muito importante que os campos que são capazes de descrever o volume total de um pedido sejam enviados: [block:api-header] { "type": "basic", "title": "Campo \"amount\"" } [/block] Trata-se de um campo obrigatório, porém será substituído pelo campo "packages", caso seja informado, dado que é um campo que descreve a quantidade de pacotes de tamanho padrão abstrato. O volume ocupado por cada unidade em "amount" é configurado **prévia e indiretamente** (vide "Primeiros passos" em "API Rapiddo"); se configura a quantidade de pacotes padrão que cabem no baú da moto e a partir dessa configuração calculamos o volume padrão de cada pacote. Para efeitos de volumetria, a quantidade informada em "amount" é multiplicada pelo volume padrão, de modo que assim obtemos o volume total ocupado pelo pedido. A possível imprecisão dessa medida justifica a preferência por sempre enviar "packages", dado que esse campo pode descrever com exatidão todos os pacotes que estão atrelados ao pedido em questão [block:api-header] { "type": "basic", "title": "Campo \"packages\"" } [/block] Trata-se de um campo opcional, porém deve se dar a preferência por enviá-lo sempre, dado que é a descrição mais fiel das dimensões físicas dos componentes do pedido. Descreve as dimensões, pesos e quantidades de cada pacote que faz parte de um pedido; trata-se de uma string que representa um JSON. Caso seja enviado, esse campo será utilizado, em lugar de "amount", para descrever os volumes, durante o processo de roteirização. Abaixo encontra-se a descrição do objeto literal (em JavaScript) que descreve o campo, porém é importante notar que o campo em si é uma string e que se espera o formato JSON - optou-se descrever em um objeto literal pela simplicidade. [block:code] { "codes": [ { "code": "/*\n\tJavaScript object representando a descrição do parâmetro \"packages\". \n*/\n{\n items: [\t\t\t\t\t\t// Lista de itens (ou pacotes) que fazem parte do pedido\n {\t\t\t\t\t\t\t\t\t// DESCRIÇÃO DO PRIMEIRO PACOTE:\n quantity: 1,\t\t// * Quantidade de pacotes iguais a esse\n weight: 1.0, \t\t// * Peso do pacote (em quilogramas)\n height: 3.0, \t\t// * Altura do pacote (em centimetros)\n width: 4.0, \t\t// * Largura do pacote (em centímetros)\n length: 5.0\t\t\t// * Comprimento do pacote (em centímetros)\n }, \n {\n quantity: 2, \n weight: 2.0, \n height: 4.0, \n width:5.0, \n length: 6.0\n }, \n {\n quantity: 1, \n weight: 3.0, \n height: 5.0, \n width:6.0, \n length: 7.0\n }\n ]\n}", "language": "javascript" } ] } [/block]
No caso de clientes que roteirizam seus pedidos, os volumes dos pedidos - que constam em um mesmo lote de roteirização e que são de um mesmo depósito - são considerados para que sejam distribuídos em diferentes rotas de entrega, isto é, são considerados para viabilizar a coleta de forma que todos os pedidos em uma rota caibam no modal em questão (por exemplo, no baú da moto do entregador), sendo assim, é muito importante que os campos que são capazes de descrever o volume total de um pedido sejam enviados: [block:api-header] { "type": "basic", "title": "Campo \"amount\"" } [/block] Trata-se de um campo obrigatório, porém será substituído pelo campo "packages", caso seja informado, dado que é um campo que descreve a quantidade de pacotes de tamanho padrão abstrato. O volume ocupado por cada unidade em "amount" é configurado **prévia e indiretamente** (vide "Primeiros passos" em "API Rapiddo"); se configura a quantidade de pacotes padrão que cabem no baú da moto e a partir dessa configuração calculamos o volume padrão de cada pacote. Para efeitos de volumetria, a quantidade informada em "amount" é multiplicada pelo volume padrão, de modo que assim obtemos o volume total ocupado pelo pedido. A possível imprecisão dessa medida justifica a preferência por sempre enviar "packages", dado que esse campo pode descrever com exatidão todos os pacotes que estão atrelados ao pedido em questão [block:api-header] { "type": "basic", "title": "Campo \"packages\"" } [/block] Trata-se de um campo opcional, porém deve se dar a preferência por enviá-lo sempre, dado que é a descrição mais fiel das dimensões físicas dos componentes do pedido. Descreve as dimensões, pesos e quantidades de cada pacote que faz parte de um pedido; trata-se de uma string que representa um JSON. Caso seja enviado, esse campo será utilizado, em lugar de "amount", para descrever os volumes, durante o processo de roteirização. Abaixo encontra-se a descrição do objeto literal (em JavaScript) que descreve o campo, porém é importante notar que o campo em si é uma string e que se espera o formato JSON - optou-se descrever em um objeto literal pela simplicidade. [block:code] { "codes": [ { "code": "/*\n\tJavaScript object representando a descrição do parâmetro \"packages\". \n*/\n{\n items: [\t\t\t\t\t\t// Lista de itens (ou pacotes) que fazem parte do pedido\n {\t\t\t\t\t\t\t\t\t// DESCRIÇÃO DO PRIMEIRO PACOTE:\n quantity: 1,\t\t// * Quantidade de pacotes iguais a esse\n weight: 1.0, \t\t// * Peso do pacote (em quilogramas)\n height: 3.0, \t\t// * Altura do pacote (em centimetros)\n width: 4.0, \t\t// * Largura do pacote (em centímetros)\n length: 5.0\t\t\t// * Comprimento do pacote (em centímetros)\n }, \n {\n quantity: 2, \n weight: 2.0, \n height: 4.0, \n width:5.0, \n length: 6.0\n }, \n {\n quantity: 1, \n weight: 3.0, \n height: 5.0, \n width:6.0, \n length: 7.0\n }\n ]\n}", "language": "javascript" } ] } [/block]
{"_id":"58f794a588fb5b0f00aef61e","link_external":false,"title":"/api/v1/orders/simulate","hidden":false,"link_url":"","project":"552ed3282594f70d001b2d69","slug":"orders-simulate","__v":3,"api":{"url":"/orders/simulate","auth":"required","examples":{"codes":[{"name":"Query","language":"text","code":"https://api.rapiddo.com.br/api/v1/orders/simulate?api_key=abc123&live_mode=false&zip_code=13020432&depot_alias=testedeposito"},{"language":"java","code":"import org.springframework.http.HttpMethod;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\n\n\t\t//Trocar \"abc123\" por sua API KEY\n\t\tString URL = \"https://api.rapiddo.com.br/api/v1/orders/simulate?api_key=abc123&live_mode=false&zip_code=13020432&depot_alias=testedeposito\";\n\n\t\tHttpHeaders headers = new HttpHeaders();\n    headers.setContentType(MediaType.APPLICATION_JSON);\n    HttpEntity<String> entity = new HttpEntity<String>(headers);\n\n\t\tResponseEntity<String> result = restTemplate.exchange(URL, HttpMethod.GET, entity, String.class);"}]},"method":"get","params":[{"type":"string","name":"api_key","_id":"58f767d2a83063230061f496","ref":"","in":"query","required":true,"desc":"Token de acesso","default":""},{"required":true,"desc":"Chavemento entre produção e teste","default":"","type":"string","name":"live_mode","_id":"58f767d2a83063230061f495","ref":"","in":"query"},{"required":true,"type":"string","_id":"58f797484af822230021774a","default":"","desc":"CEP de destino","in":"query","name":"zipcode","ref":""},{"desc":"Nome do depósito","default":"","type":"string","name":"depot_alias","_id":"58f7983288fb5b0f00aef625","ref":"","in":"query","required":false},{"_id":"58f7983288fb5b0f00aef624","ref":"","in":"query","required":false,"desc":"Descrição dos pacotes","default":"","type":"string","name":"packages"}],"results":{"codes":[{"code":"{  \n   \"distance\":8823,\t\t\t// Distância, em metros, entre o depósito e o endereço de entrega\n   \"time\":3757,\t\t\t\t\t// Tempo estimado, em segundos, de deslocamento\n   \"price\":2338\t\t\t\t\t// Preço estimado, em centavos, pela entrega\n}","language":"json","status":200,"name":""},{"name":"","code":"{\n  \"reason\": \"Erro ao geolocalizar o endereço.\",\n  \"code\": 400,\n  \"method\": \"GET\",\n  \"name\": \"Bad Request\",\n  \"error_code\": \"008\",\n  \"url\": \"http://localhost:8080/ilocate-ws/api/v1/orders/simulate\"\n}","language":"json","status":400}]},"settings":""},"body":"##**Objeto Simulate**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"distance\",\n    \"0-2\": \"Distancia em metros, entre o depósito e o endereço de entrega\",\n    \"0-3\": \"Distancia em metros, entre o depósito e o endereço de entrega\",\n    \"1-0\": \"time\",\n    \"1-2\": \"Tempo estimado, em segundos, de deslocamento\",\n    \"1-3\": \"Tempo estimado, em segundos, de deslocamento\",\n    \"2-3\": \"Preço estimado, em centavos, pela entrega\",\n    \"2-2\": \"Preço estimado, em centavos, pela entrega\",\n    \"2-0\": \"price\",\n    \"h-1\": \"Type\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"Integer\",\n    \"2-1\": \"Integer\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"5731e5c6900b680e00cb3c73","user":"56533f1854e3e221002c28ea","isReference":false,"next":{"pages":[],"description":""},"sync_unique":"","parentDoc":null,"type":"get","updates":[],"version":"552ed3282594f70d001b2d6d","createdAt":"2017-04-19T16:47:33.108Z","excerpt":"Faz simulação de uma order","githubsync":"","order":2,"childrenPages":[]}

get/api/v1/orders/simulate

Faz simulação de uma order

Query Params

api_key:
required
string
Token de acesso
live_mode:
required
string
Chavemento entre produção e teste
zipcode:
required
string
CEP de destino
depot_alias:
string
Nome do depósito
packages:
string
Descrição dos pacotes
##**Objeto Simulate** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Description", "h-3": "Description", "0-0": "distance", "0-2": "Distancia em metros, entre o depósito e o endereço de entrega", "0-3": "Distancia em metros, entre o depósito e o endereço de entrega", "1-0": "time", "1-2": "Tempo estimado, em segundos, de deslocamento", "1-3": "Tempo estimado, em segundos, de deslocamento", "2-3": "Preço estimado, em centavos, pela entrega", "2-2": "Preço estimado, em centavos, pela entrega", "2-0": "price", "h-1": "Type", "0-1": "Integer", "1-1": "Integer", "2-1": "Integer" }, "cols": 3, "rows": 3 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##**Objeto Simulate** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Description", "h-3": "Description", "0-0": "distance", "0-2": "Distancia em metros, entre o depósito e o endereço de entrega", "0-3": "Distancia em metros, entre o depósito e o endereço de entrega", "1-0": "time", "1-2": "Tempo estimado, em segundos, de deslocamento", "1-3": "Tempo estimado, em segundos, de deslocamento", "2-3": "Preço estimado, em centavos, pela entrega", "2-2": "Preço estimado, em centavos, pela entrega", "2-0": "price", "h-1": "Type", "0-1": "Integer", "1-1": "Integer", "2-1": "Integer" }, "cols": 3, "rows": 3 } [/block]
{"_id":"58f77673e2ae302300b5bbcc","category":"5731e5c6900b680e00cb3c73","isReference":false,"link_external":false,"order":3,"parentDoc":null,"__v":1,"body":"##**Objeto Order**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"delivery_date_min\",\n    \"2-0\": \"delivery_date_max\",\n    \"3-0\": \"lat\",\n    \"4-0\": \"lng\",\n    \"5-0\": \"street\",\n    \"6-0\": \"street_number\",\n    \"7-0\": \"neighborhood\",\n    \"8-0\": \"city\",\n    \"9-0\": \"province\",\n    \"10-0\": \"country\",\n    \"11-0\": \"reference\",\n    \"12-0\": \"complement\",\n    \"13-0\": \"zip_code\",\n    \"14-0\": \"contact_name\",\n    \"15-0\": \"contact_phone\",\n    \"16-0\": \"contact_email\",\n    \"17-0\": \"depot_alias\",\n    \"18-0\": \"amount\",\n    \"19-0\": \"packages\",\n    \"20-0\": \"description\",\n    \"21-0\": \"modal\",\n    \"22-0\": \"client_id\",\n    \"0-3\": \"Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)\",\n    \"1-3\": \"Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"2-3\": \"Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"3-3\": \"Latitude\",\n    \"4-3\": \"Longitude\",\n    \"5-3\": \"Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)\",\n    \"6-3\": \"Endereço de entrega - número\",\n    \"7-3\": \"Endereço de entrega - bairro\",\n    \"8-3\": \"Endereço de entrega - cidade\",\n    \"9-3\": \"Endereço de entrega - estado\",\n    \"10-3\": \"Endereço de entrega - país\",\n    \"11-3\": \"Endereço de entrega - referência (auxílio para o entregador)\",\n    \"12-3\": \"Endereço de entrega - complemento\",\n    \"13-3\": \"Endereço de entrega - CEP\",\n    \"14-3\": \"Nome do contato (destinatário)\",\n    \"15-3\": \"Telefone do contato (destinatário)\",\n    \"16-3\": \"Email do contato (destinatário)\",\n    \"17-3\": \"Nome do depósito (tal qual configurado na página de depósitos)\",\n    \"18-3\": \"Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)\",\n    \"19-3\": \"Descrição dos pacotes (sobrescreve \\\"amount\\\", dado que é uma descrição mais precisa de cada pacote)\",\n    \"20-3\": \"Descrição da entrega (informação mostrada ao entregador)\",\n    \"21-3\": \"Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)\",\n    \"22-3\": \"ID do cliente (campo opcional, não relevante nas integrações de e-commerces)\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\n    \"6-2\": \"String\",\n    \"7-2\": \"String\",\n    \"8-2\": \"String\",\n    \"9-2\": \"String\",\n    \"10-2\": \"String\",\n    \"11-2\": \"String\",\n    \"12-2\": \"String\",\n    \"13-2\": \"String\",\n    \"14-2\": \"String\",\n    \"15-2\": \"String\",\n    \"16-2\": \"String\",\n    \"17-2\": \"String\",\n    \"18-2\": \"String\",\n    \"19-2\": \"String\",\n    \"20-2\": \"String\",\n    \"21-2\": \"String\",\n    \"22-2\": \"String\",\n    \"0-1\": \"<span style=\\\"color:red\\\">*required, unique*</span>\",\n    \"5-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"9-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"10-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"13-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"18-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"17-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"8-1\": \"<span style=\\\"color:red\\\">*required*</span>\"\n  },\n  \"cols\": 4,\n  \"rows\": 23\n}\n[/block]","project":"552ed3282594f70d001b2d69","next":{"pages":[],"description":""},"hidden":false,"link_url":"","sync_unique":"","title":"/api/v1/orders","type":"get","updates":[],"createdAt":"2017-04-19T14:38:43.870Z","githubsync":"","user":"56533f1854e3e221002c28ea","slug":"apiv1orders-new-1","version":"552ed3282594f70d001b2d6d","api":{"params":[{"ref":"","in":"query","required":true,"desc":"Token de acesso","default":"","type":"string","name":"api_key","_id":"58f767d2a83063230061f496"},{"in":"query","required":true,"desc":"Chavemento entre produção e teste","default":"","type":"string","name":"live_mode","_id":"58f767d2a83063230061f495","ref":""},{"required":false,"desc":"Data de início do intervalo de busca","default":"","type":"string","name":"since","_id":"58f777a3aecd081b00cbd705","ref":"","in":"query"},{"ref":"","in":"query","required":false,"desc":"Data de fim do intervalo de busca","default":"","type":"string","name":"until","_id":"58f777a3aecd081b00cbd704"},{"in":"query","required":false,"desc":"Status dos pedidos que se deseja buscar","default":"","type":"string","name":"status","_id":"58f777a3aecd081b00cbd703","ref":""}],"results":{"codes":[{"name":"","code":"[  \n   {  \n      \"id\":\"DVfjH\",\n      \"status\":\"COMPLETED\",\n      \"workerName\":\"Entregador teste\",\n      \"receiverName\":null,\n      \"workerLastLat\":-23.6824097,\n      \"workerLastLon\":-46.59530190000003,\n      \"workerLastTrackDate\":\"19/04/2017 11:32:49\",\n      \"delivered\":null,\n      \"trackingId\":\"decaaY\",\n      \"signatureHash\":null,\n      \"digitalProtocol\":null,\n      \"jobId\":null\n   },\n   {  \n      \"id\":\"JCgpu\",\n      \"status\":\"ARRIVED_AT_DESTINATION\",\n      \"workerName\":\"Entregador teste\",\n      \"receiverName\":null,\n      \"workerLastLat\":-23.6824115,\n      \"workerLastLon\":-46.59530010000001,\n      \"workerLastTrackDate\":\"19/04/2017 11:32:49\",\n      \"delivered\":null,\n      \"trackingId\":\"1VFt0p\",\n      \"signatureHash\":null,\n      \"digitalProtocol\":null,\n      \"jobId\":null\n   },\n   {  \n      \"id\":\"OZmQi\",\n      \"status\":\"COMPLETED\",\n      \"workerName\":\"Entregador teste\",\n      \"receiverName\":null,\n      \"workerLastLat\":-23.68241,\n      \"workerLastLon\":-46.59530160000003,\n      \"workerLastTrackDate\":\"19/04/2017 11:32:49\",\n      \"delivered\":null,\n      \"trackingId\":\"EzKq0M\",\n      \"signatureHash\":null,\n      \"digitalProtocol\":null,\n      \"jobId\":null\n   },\n   {  \n      \"id\":\"skOTZ\",\n      \"status\":\"COMPLETED\",\n      \"workerName\":\"Entregador teste\",\n      \"receiverName\":null,\n      \"workerLastLat\":-23.6824103,\n      \"workerLastLon\":-46.595301300000024,\n      \"workerLastTrackDate\":\"19/04/2017 11:32:49\",\n      \"delivered\":null,\n      \"trackingId\":\"FjFgk9\",\n      \"signatureHash\":null,\n      \"digitalProtocol\":null,\n      \"jobId\":null\n   },\n   {  \n      \"id\":\"uAVmU\",\n      \"status\":\"COMPLETED\",\n      \"workerName\":\"Entregador teste\",\n      \"receiverName\":null,\n      \"workerLastLat\":-23.6824088,\n      \"workerLastLon\":-46.59530280000004,\n      \"workerLastTrackDate\":\"19/04/2017 11:32:49\",\n      \"delivered\":null,\n      \"trackingId\":\"UmVbQC\",\n      \"signatureHash\":\"0848cd82616350ca180fb41b35fad262\",\n      \"digitalProtocol\":null,\n      \"jobId\":2171447\n   },\n   {  \n      \"id\":\"wDYhl\",\n      \"status\":\"ON_ROW\",\n      \"workerName\":null,\n      \"receiverName\":null,\n      \"workerLastLat\":null,\n      \"workerLastLon\":null,\n      \"workerLastTrackDate\":null,\n      \"delivered\":null,\n      \"trackingId\":\"XPpQ4N\",\n      \"signatureHash\":null,\n      \"digitalProtocol\":null,\n      \"jobId\":null\n   }\n]","language":"json","status":200},{"name":"","code":"{\n  \"reason\": \"Data passada para pesquisa é incorreta.\",\n  \"code\": 400,\n  \"method\": \"GET\",\n  \"name\": \"Bad Request\",\n  \"error_code\": \"310\",\n  \"url\": \"https://api.rapiddo.com.br/api/v1/orders\"\n}","language":"json","status":400}]},"settings":"","url":"/orders","auth":"required","examples":{"codes":[{"code":"https://api.rapiddo.com.br/api/v1/orders?api_key=abc123&live_mode=false","language":"text","name":"Query"},{"code":"import org.springframework.http.HttpMethod;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\n\n\t\t//Trocar \"abc123\" por sua API KEY\n\t\tString URL = \"https://api.rapiddo.com.br/api/v1/orders?api_key=abc123&live_mode=false\";\n\n\t\tHttpHeaders headers = new HttpHeaders();\n    headers.setContentType(MediaType.APPLICATION_JSON);\n    HttpEntity<String> entity = new HttpEntity<String>(headers);\n\n\t\t//foi utilizado override no toString do objeto Order. toString utilizado está na aba Java - toString\n\t\tResponseEntity<String> result = restTemplate.exchange(URL, HttpMethod.GET, entity, String.class);","language":"java"}]},"method":"get"},"excerpt":"Retorna todas orders","childrenPages":[]}

get/api/v1/orders

Retorna todas orders

Query Params

api_key:
required
string
Token de acesso
live_mode:
required
string
Chavemento entre produção e teste
since:
string
Data de início do intervalo de busca
until:
string
Data de fim do intervalo de busca
status:
string
Status dos pedidos que se deseja buscar
##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude", "4-3": "Longitude", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude", "4-3": "Longitude", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]
{"_id":"58f6712fa1a8450f00159b88","body":"##**Objeto Order**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"delivery_date_min\",\n    \"2-0\": \"delivery_date_max\",\n    \"3-0\": \"lat\",\n    \"4-0\": \"lng\",\n    \"5-0\": \"street\",\n    \"6-0\": \"street_number\",\n    \"7-0\": \"neighborhood\",\n    \"8-0\": \"city\",\n    \"9-0\": \"province\",\n    \"10-0\": \"country\",\n    \"11-0\": \"reference\",\n    \"12-0\": \"complement\",\n    \"13-0\": \"zip_code\",\n    \"14-0\": \"contact_name\",\n    \"15-0\": \"contact_phone\",\n    \"16-0\": \"contact_email\",\n    \"17-0\": \"depot_alias\",\n    \"18-0\": \"amount\",\n    \"19-0\": \"packages\",\n    \"20-0\": \"description\",\n    \"21-0\": \"modal\",\n    \"22-0\": \"client_id\",\n    \"0-3\": \"Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)\",\n    \"1-3\": \"Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"2-3\": \"Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"3-3\": \"Latitude do endereço de entrega\",\n    \"4-3\": \"Longitude do endereço de entrega\",\n    \"5-3\": \"Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)\",\n    \"6-3\": \"Endereço de entrega - número\",\n    \"7-3\": \"Endereço de entrega - bairro\",\n    \"8-3\": \"Endereço de entrega - cidade\",\n    \"9-3\": \"Endereço de entrega - estado\",\n    \"10-3\": \"Endereço de entrega - país\",\n    \"11-3\": \"Endereço de entrega - referência (auxílio para o entregador)\",\n    \"12-3\": \"Endereço de entrega - complemento\",\n    \"13-3\": \"Endereço de entrega - CEP\",\n    \"14-3\": \"Nome do contato (destinatário)\",\n    \"15-3\": \"Telefone do contato (destinatário)\",\n    \"16-3\": \"Email do contato (destinatário)\",\n    \"17-3\": \"Nome do depósito (tal qual configurado na página de depósitos)\",\n    \"18-3\": \"Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)\",\n    \"19-3\": \"Descrição dos pacotes (sobrescreve \\\"amount\\\", dado que é uma descrição mais precisa de cada pacote)\",\n    \"20-3\": \"Descrição da entrega (informação mostrada ao entregador)\",\n    \"21-3\": \"Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)\",\n    \"22-3\": \"ID do cliente (campo opcional, não relevante nas integrações de e-commerces)\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\n    \"6-2\": \"String\",\n    \"7-2\": \"String\",\n    \"8-2\": \"String\",\n    \"9-2\": \"String\",\n    \"10-2\": \"String\",\n    \"11-2\": \"String\",\n    \"12-2\": \"String\",\n    \"13-2\": \"String\",\n    \"14-2\": \"String\",\n    \"15-2\": \"String\",\n    \"16-2\": \"String\",\n    \"17-2\": \"String\",\n    \"18-2\": \"String\",\n    \"19-2\": \"String\",\n    \"20-2\": \"String\",\n    \"21-2\": \"String\",\n    \"22-2\": \"String\",\n    \"0-1\": \"<span style=\\\"color:red\\\">*required, unique*</span>\",\n    \"5-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"9-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"10-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"13-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"18-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"17-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"8-1\": \"<span style=\\\"color:red\\\">*required*</span>\"\n  },\n  \"cols\": 4,\n  \"rows\": 23\n}\n[/block]","order":4,"project":"552ed3282594f70d001b2d69","updates":[],"user":"56533f1854e3e221002c28ea","__v":3,"githubsync":"","slug":"apiv1orders-new","createdAt":"2017-04-18T20:03:59.963Z","hidden":false,"link_url":"","title":"/api/v1/orders","parentDoc":null,"api":{"examples":{"codes":[{"name":"Query","language":"text","code":"https://api.rapiddo.com.br/api/v1/orders?api_key=abc123&live_mode=false&id=cWBlm&street=Av. Barao de Itapura&street_number=1500&neighborhood=Botafogo&city=Campinas&province=Sao Paulo&country=Brasil&zip_code=13020432&depot_alias=testedeposito&amount=1&packages=[{\"items\":[{\"quantity\":2,\"weight\":3.0,\"height\":2.0,\"width\":3.0,\"length\":2.0},{\"quantity\":2,\"weight\":3.0,\"height\":2.0,\"width\":3.0,\"length\":2.0}]}]"},{"code":"import org.springframework.http.HttpMethod;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\nimport model.Items;\nimport model.Order;\nimport model.Packages;\n    \n    Order pedido = new Order();\n\n\t\tPackages pack = new Packages();\n\t\tpack.setHeight(2.0);\n\t\tpack.setLength(2.0);\n\t\tpack.setQuantity(2);\n\t\tpack.setWeight(3.0);\n\t\tpack.setWidth(3.0);\n\t\tPackages pack2 = new Packages();\n\t\tpack2.setHeight(2.0);\n\t\tpack2.setLength(2.0);\n\t\tpack2.setQuantity(2);\n\t\tpack2.setWeight(3.0);\n\t\tpack2.setWidth(3.0);\n\n\t\tList<Packages> listItems = new ArrayList<Packages>();\n\t\tlistItems.add(pack);\n\t\tlistItems.add(pack2);\n\n\t\tItems item = new Items();\n\t\titem.setItems(listItems);\n\n\t\tpedido.setPackages(item);\n\n\n\t\tpedido.setId(\"cWBlm\");\n\t\tpedido.setStreet(\"Av. Barao de Itapura\");\n\t\tpedido.setStreet_number(\"1500\");\n\t\tpedido.setNeighborhood(\"Botafogo\");\n\t\tpedido.setCity(\"Campinas\");\n\t\tpedido.setProvince(\"Sao Paulo\");\n\t\tpedido.setCountry(\"Brasil\");\n\t\tpedido.setZip_code(\"13020432\");\n\t\tpedido.setDepot_alias(\"testedeposito\");\n\t\tpedido.setAmount(\"1\");\n\n\n\t\tString items = gson.toJson(pedido.getPackages());\n\t\t//Trocar \"abc123\" por sua API KEY\n\t\tString URL = \"https://api.rapiddo.com.br/api/v1/orders?api_key=abc123&live_mode=false\";\n\n\t\tHttpHeaders headers = new HttpHeaders();\n    headers.setContentType(MediaType.APPLICATION_JSON);\n    HttpEntity<String> entity = new HttpEntity<String>(headers);\n\n\t\t//foi utilizado override no toString do objeto Order. toString utilizado está na aba Java - toString\n\t\tResponseEntity<String> result = restTemplate.exchange(URL + pedido.toString(), HttpMethod.POST, entity, String.class,items);","language":"java"},{"name":"JSON - Object Packages","language":"json","code":"/*\n\tJavaScript object representando a descrição do parâmetro \"packages\". Esse campo deverá ser serializado para envio\n*/\n{\n  items: [\t\t\t\t\t\t// Lista de itens (ou pacotes) que fazem parte do pedido\n    {\t\t\t\t\t\t\t\t\t// DESCRIÇÃO DO PRIMEIRO PACOTE:\n      quantity: 1,\t\t// * Quantidade de pacotes iguais a esse\n      weight: 1.0, \t\t// * Peso do pacote\n      height: 3.0, \t\t// * Altura do pacote\n      width: 4.0, \t\t// * Largura do pacote\n      length: 5.0\t\t\t// * Comprimento do pacote\n    }, \n    {\n      quantity: 2, \n      weight: 2.0, \n      height: 4.0, \n      width:5.0, \n      length: 6.0\n    }, \n    {\n      quantity: 1, \n      weight: 3.0, \n      height: 5.0, \n      width:6.0, \n      length: 7.0\n    }\n  ]\n}\n"},{"language":"java","code":"//toString utilizado no exemplo em java\npublic String toString() {\n\t\t\n\t\tString s = (id != null ? \"&id=\" + id + \"\" : \"\")\n\t\t\t\t+ (live_mode != null ? \"&live_mode=\" + live_mode + \"\" : \"\")\n\t\t\t\t+ (delivery_date_min != null ? \"&delivery_date_min=\" + delivery_date_min + \"\" : \"\")\n\t\t\t\t+ (delivery_date_max != null ? \"&delivery_date_max=\" + delivery_date_max + \"\" : \"\")\n\t\t\t\t+ (lat != null ? \"&lat=\" + lat + \"\" : \"\") + (lng != null ? \"&lng=\" + lng + \"\" : \"\")\n\t\t\t\t+ (street != null ? \"&street=\" + street + \"\" : \"\")\n\t\t\t\t+ (street_number != null ? \"&street_number=\" + street_number + \"\" : \"\")\n\t\t\t\t+ (neighborhood != null ? \"&neighborhood=\" + neighborhood + \"\" : \"\")\n\t\t\t\t+ (city != null ? \"&city=\" + city + \"\" : \"\") + (province != null ? \"&province=\" + province + \"\" : \"\")\n\t\t\t\t+ (country != null ? \"&country=\" + country + \"\" : \"\")\n\t\t\t\t+ (reference != null ? \"&reference=\" + reference + \"\" : \"\")\n\t\t\t\t+ (complement != null ? \"&complement=\" + complement + \"\" : \"\")\n\t\t\t\t+ (zip_code != null ? \"&zip_code=\" + zip_code + \"\" : \"\")\n\t\t\t\t+ (contact_name != null ? \"&contact_name=\" + contact_name + \"\" : \"\")\n\t\t\t\t+ (contact_phone != null ? \"&contact_phone=\" + contact_phone + \"\" : \"\")\n\t\t\t\t+ (contact_email != null ? \"&contact_email=\" + contact_email + \"\" : \"\")\n\t\t\t\t+ (depot_alias != null ? \"&depot_alias=\" + depot_alias + \"\" : \"\")\n\t\t\t\t+ (amount != null ? \"&amount=\" + amount + \"\" : \"\")\n\t\t\t\t+ (packages != null ? \"&packages={items}\" : \"\")\n\t\t\t\t+ (description != null ? \"&description=\" + description + \"\" : \"\")\n\t\t\t\t+ (modal != null ? \"&modal=\" + modal + \"\" : \"\") + (client_id != null ? \"&client_id=\" + client_id : \"\");\n\t\t\n\t\t\n\t\treturn StringUtils.replace(s, \"?&\", \"?\");\n\t}\n","name":"Java - toString"}]},"method":"post","params":[{"type":"string","name":"api_key","_id":"58f767d2a83063230061f496","ref":"","in":"query","required":true,"desc":"Token de acesso","default":""},{"required":true,"desc":"Chavemento entre produção e teste","default":"","type":"string","name":"live_mode","_id":"58f767d2a83063230061f495","ref":"","in":"query"},{"type":"string","name":"id","_id":"58f767d2a83063230061f494","ref":"","in":"query","required":true,"desc":"Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)","default":""},{"required":false,"desc":"Início do intervalo de entrega","default":"","type":"string","name":"delivery_date_min","_id":"58f767d2a83063230061f493","ref":"","in":"query"},{"type":"string","name":"delivery_date_max","_id":"58f767d2a83063230061f492","ref":"","in":"query","required":false,"desc":"Final do intervalo de entrega","default":""},{"desc":"Latitude","default":"","type":"string","name":"lat","_id":"58f767d2a83063230061f491","ref":"","in":"query","required":false},{"_id":"58f767d2a83063230061f490","ref":"","in":"query","required":false,"desc":"Longitude","default":"","type":"string","name":"lng"},{"_id":"58f767d2a83063230061f48f","ref":"","in":"query","required":true,"desc":"Endereço de entrega","default":"","type":"string","name":"street"},{"name":"street_number","_id":"58f767d2a83063230061f48e","ref":"","in":"query","required":false,"desc":"Número do endereço","default":"","type":"string"},{"type":"string","name":"neighborhood","_id":"58f767d2a83063230061f48d","ref":"","in":"query","required":false,"desc":"Bairro","default":""},{"name":"city","ref":"","required":true,"type":"string","_id":"58f767d2a83063230061f48c","default":"","desc":"Cidade","in":"query"},{"_id":"58f767d2a83063230061f48b","ref":"","in":"query","required":true,"desc":"Estado","default":"","type":"string","name":"province"},{"name":"country","_id":"58f767d2a83063230061f48a","ref":"","in":"query","required":true,"desc":"País","default":"","type":"string"},{"type":"string","name":"reference","_id":"58f7696881bb94370053ce35","ref":"","in":"query","required":false,"desc":"Referência do endereço","default":""},{"required":false,"desc":"Complemento do endereço","default":"","type":"string","name":"complement","_id":"58f7696881bb94370053ce34","ref":"","in":"query"},{"ref":"","in":"query","required":true,"desc":"CEP","default":"","type":"string","name":"zip_code","_id":"58f7696881bb94370053ce33"},{"default":"","type":"string","name":"contact_name","_id":"58f7696881bb94370053ce32","ref":"","in":"query","required":false,"desc":"Nome do contato( destinatário)"},{"default":"","type":"string","name":"contact_phone","_id":"58f7696881bb94370053ce31","ref":"","in":"query","required":false,"desc":"Telefone de contato (destinatário)"},{"in":"query","required":false,"desc":"Email de contato ( destinatário)","default":"","type":"string","name":"contact_email","_id":"58f7696881bb94370053ce30","ref":""},{"required":true,"desc":"Nome do depósito","default":"","type":"string","name":"depot_alias","_id":"58f7696881bb94370053ce2f","ref":"","in":"query"},{"ref":"","in":"query","required":true,"desc":"Quantidade de pacotes","default":"","type":"string","name":"amount","_id":"58f7696881bb94370053ce2e"},{"in":"query","required":false,"desc":"Descrição dos pacotes","default":"","type":"string","name":"packages","_id":"58f7696881bb94370053ce2d","ref":""},{"desc":"Descrição da entrega","default":"","type":"string","name":"description","_id":"58f7696881bb94370053ce2c","ref":"","in":"query","required":false},{"_id":"58f7696881bb94370053ce2b","ref":"","in":"query","required":false,"desc":"Modal utilizado","default":"","type":"string","name":"modal"},{"name":"client_id","_id":"58f7696881bb94370053ce2a","ref":"","in":"query","required":false,"desc":"ID do cliente","default":"","type":"string"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"trackingId\": \"p4uGk3\"\n}"},{"status":400,"name":"","code":"{\n  \"reason\": \"Data inválida.\",\n  \"code\": 400,\n  \"method\": \"POST\",\n  \"name\": \"Bad Request\",\n  \"error_code\": \"904\",\n  \"url\": \"http://api.rapiddo.com.br/api/v1/orders\"\n}","language":"json"}]},"settings":"","url":"/orders","auth":"required"},"category":"5731e5c6900b680e00cb3c73","excerpt":"Inclui um pedido","isReference":false,"link_external":false,"next":{"pages":[],"description":""},"sync_unique":"","type":"post","version":"552ed3282594f70d001b2d6d","childrenPages":[]}

post/api/v1/orders

Inclui um pedido

Query Params

api_key:
required
string
Token de acesso
live_mode:
required
string
Chavemento entre produção e teste
id:
required
string
Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)
delivery_date_min:
string
Início do intervalo de entrega
delivery_date_max:
string
Final do intervalo de entrega
lat:
string
Latitude
lng:
string
Longitude
street:
required
string
Endereço de entrega
street_number:
string
Número do endereço
neighborhood:
string
Bairro
city:
required
string
Cidade
province:
required
string
Estado
country:
required
string
País
reference:
string
Referência do endereço
complement:
string
Complemento do endereço
zip_code:
required
string
CEP
contact_name:
string
Nome do contato( destinatário)
contact_phone:
string
Telefone de contato (destinatário)
contact_email:
string
Email de contato ( destinatário)
depot_alias:
required
string
Nome do depósito
amount:
required
string
Quantidade de pacotes
packages:
string
Descrição dos pacotes
description:
string
Descrição da entrega
modal:
string
Modal utilizado
client_id:
string
ID do cliente
##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude do endereço de entrega", "4-3": "Longitude do endereço de entrega", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude do endereço de entrega", "4-3": "Longitude do endereço de entrega", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]
{"_id":"58f779689c723f19004e1fce","body":"##**Objeto Order**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"delivery_date_min\",\n    \"2-0\": \"delivery_date_max\",\n    \"3-0\": \"lat\",\n    \"4-0\": \"lng\",\n    \"5-0\": \"street\",\n    \"6-0\": \"street_number\",\n    \"7-0\": \"neighborhood\",\n    \"8-0\": \"city\",\n    \"9-0\": \"province\",\n    \"10-0\": \"country\",\n    \"11-0\": \"reference\",\n    \"12-0\": \"complement\",\n    \"13-0\": \"zip_code\",\n    \"14-0\": \"contact_name\",\n    \"15-0\": \"contact_phone\",\n    \"16-0\": \"contact_email\",\n    \"17-0\": \"depot_alias\",\n    \"18-0\": \"amount\",\n    \"19-0\": \"packages\",\n    \"20-0\": \"description\",\n    \"21-0\": \"modal\",\n    \"22-0\": \"client_id\",\n    \"0-3\": \"Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)\",\n    \"1-3\": \"Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"2-3\": \"Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"3-3\": \"Latitude\",\n    \"4-3\": \"Longitude\",\n    \"5-3\": \"Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)\",\n    \"6-3\": \"Endereço de entrega - número\",\n    \"7-3\": \"Endereço de entrega - bairro\",\n    \"8-3\": \"Endereço de entrega - cidade\",\n    \"9-3\": \"Endereço de entrega - estado\",\n    \"10-3\": \"Endereço de entrega - país\",\n    \"11-3\": \"Endereço de entrega - referência (auxílio para o entregador)\",\n    \"12-3\": \"Endereço de entrega - complemento\",\n    \"13-3\": \"Endereço de entrega - CEP\",\n    \"14-3\": \"Nome do contato (destinatário)\",\n    \"15-3\": \"Telefone do contato (destinatário)\",\n    \"16-3\": \"Email do contato (destinatário)\",\n    \"17-3\": \"Nome do depósito (tal qual configurado na página de depósitos)\",\n    \"18-3\": \"Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)\",\n    \"19-3\": \"Descrição dos pacotes (sobrescreve \\\"amount\\\", dado que é uma descrição mais precisa de cada pacote)\",\n    \"20-3\": \"Descrição da entrega (informação mostrada ao entregador)\",\n    \"21-3\": \"Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)\",\n    \"22-3\": \"ID do cliente (campo opcional, não relevante nas integrações de e-commerces)\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\n    \"6-2\": \"String\",\n    \"7-2\": \"String\",\n    \"8-2\": \"String\",\n    \"9-2\": \"String\",\n    \"10-2\": \"String\",\n    \"11-2\": \"String\",\n    \"12-2\": \"String\",\n    \"13-2\": \"String\",\n    \"14-2\": \"String\",\n    \"15-2\": \"String\",\n    \"16-2\": \"String\",\n    \"17-2\": \"String\",\n    \"18-2\": \"String\",\n    \"19-2\": \"String\",\n    \"20-2\": \"String\",\n    \"21-2\": \"String\",\n    \"22-2\": \"String\",\n    \"0-1\": \"<span style=\\\"color:red\\\">*required, unique*</span>\",\n    \"5-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"9-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"10-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"13-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"18-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"17-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"8-1\": \"<span style=\\\"color:red\\\">*required*</span>\"\n  },\n  \"cols\": 4,\n  \"rows\": 23\n}\n[/block]","excerpt":"Retorna uma order","link_external":false,"next":{"pages":[],"description":""},"title":"/api/v1/orders/{id}","user":"56533f1854e3e221002c28ea","__v":2,"api":{"auth":"required","examples":{"codes":[{"code":"https://api.rapiddo.com.br/api/v1/orders/wDYFl?api_key=abc123&live_mode=false","language":"text","name":"Query"},{"code":"import org.springframework.http.HttpMethod;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\n\n\t\t//Trocar \"abc123\" por sua API KEY\n\t\tString URL = \"https://api.rapiddo.com.br/api/v1/orders/wDYFl?api_key=abc123&live_mode=false\";\n\n\t\tHttpHeaders headers = new HttpHeaders();\n    headers.setContentType(MediaType.APPLICATION_JSON);\n    HttpEntity<String> entity = new HttpEntity<String>(headers);\n\n\t\t//foi utilizado override no toString do objeto Order. toString utilizado está na aba Java - toString\n\t\tResponseEntity<String> result = restTemplate.exchange(URL, HttpMethod.GET, entity, String.class);","language":"java"}]},"method":"get","params":[{"name":"api_key","_id":"58f767d2a83063230061f496","ref":"","in":"query","required":true,"desc":"Token de acesso","default":"","type":"string"},{"type":"string","name":"live_mode","_id":"58f767d2a83063230061f495","ref":"","in":"query","required":true,"desc":"Chavemento entre produção e teste","default":""},{"in":"path","name":"id","ref":"","required":true,"type":"int","_id":"58f7875288fb5b0f00aef518","default":"","desc":"Identificador do pedido na loja do cliente"}],"results":{"codes":[{"status":200,"name":"","code":"[  \n   {  \n      \"id\":\"wDYFl\",\n      \"status\":\"ON_ROW\",\n      \"workerName\":null,\n      \"receiverName\":null,\n      \"workerLastLat\":null,\n      \"workerLastLon\":null,\n      \"workerLastTrackDate\":null,\n      \"delivered\":null,\n      \"trackingId\":\"XPMv9N\",\n      \"signatureHash\":null,\n      \"digitalProtocol\":null,\n      \"jobId\":null\n   }\n]","language":"json"},{"code":"//Retorno quando não é encontrado\n[]","language":"json","status":200,"name":""}]},"settings":"","url":"/orders/{id}"},"hidden":false,"link_url":"","project":"552ed3282594f70d001b2d69","sync_unique":"","updates":[],"createdAt":"2017-04-19T14:51:20.822Z","githubsync":"","isReference":false,"order":5,"slug":"apiv1orders-new-2","type":"get","category":"5731e5c6900b680e00cb3c73","parentDoc":null,"version":"552ed3282594f70d001b2d6d","childrenPages":[]}

get/api/v1/orders/{id}

Retorna uma order

Path Params

id:
required
integer
Identificador do pedido na loja do cliente

Query Params

api_key:
required
string
Token de acesso
live_mode:
required
string
Chavemento entre produção e teste
##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude", "4-3": "Longitude", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude", "4-3": "Longitude", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]
{"_id":"58f78737dc59890f002115ce","updates":[],"slug":"apiv1orders-newid","category":"5731e5c6900b680e00cb3c73","excerpt":"Deleta uma order","isReference":false,"link_external":false,"version":"552ed3282594f70d001b2d6d","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"https://api.rapiddo.com.br/api/v1/orders/cWBlm?api_key=abc123&live_mode=false","name":"Query"},{"language":"java","code":"import org.springframework.http.HttpMethod;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\n\n\t\t//Trocar \"abc123\" por sua API KEY\n\t\tString URL = \"https://api.rapiddo.com.br/api/v1/orders/cWBlm?api_key=abc123&live_mode=false\";\n\n\t\tHttpHeaders headers = new HttpHeaders();\n    headers.setContentType(MediaType.APPLICATION_JSON);\n    HttpEntity<String> entity = new HttpEntity<String>(headers);\n\n\t\t//foi utilizado override no toString do objeto Order. toString utilizado está na aba Java - toString\n\t\tResponseEntity<String> result = restTemplate.exchange(URL, HttpMethod.DELETE, entity, String.class);"}]},"method":"delete","params":[{"desc":"Token de acesso","default":"","type":"string","name":"api_key","_id":"58f767d2a83063230061f496","ref":"","in":"query","required":true},{"_id":"58f767d2a83063230061f495","ref":"","in":"query","required":true,"desc":"Chavemento entre produção e teste","default":"","type":"string","name":"live_mode"},{"_id":"58f7876aaf622f1900766691","default":"","desc":"Identificador do pedido na loja do cliente","in":"path","name":"id","ref":"","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"[]","name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/clients/{id}\",\n  \"method\": \"DELETE\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","name":""}]},"settings":"","url":"/orders/{id}"},"body":"##**Objeto Order**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"delivery_date_min\",\n    \"2-0\": \"delivery_date_max\",\n    \"3-0\": \"lat\",\n    \"4-0\": \"lng\",\n    \"5-0\": \"street\",\n    \"6-0\": \"street_number\",\n    \"7-0\": \"neighborhood\",\n    \"8-0\": \"city\",\n    \"9-0\": \"province\",\n    \"10-0\": \"country\",\n    \"11-0\": \"reference\",\n    \"12-0\": \"complement\",\n    \"13-0\": \"zip_code\",\n    \"14-0\": \"contact_name\",\n    \"15-0\": \"contact_phone\",\n    \"16-0\": \"contact_email\",\n    \"17-0\": \"depot_alias\",\n    \"18-0\": \"amount\",\n    \"19-0\": \"packages\",\n    \"20-0\": \"description\",\n    \"21-0\": \"modal\",\n    \"22-0\": \"client_id\",\n    \"0-3\": \"Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)\",\n    \"1-3\": \"Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"2-3\": \"Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)\",\n    \"3-3\": \"Latitude\",\n    \"4-3\": \"Longitude\",\n    \"5-3\": \"Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)\",\n    \"6-3\": \"Endereço de entrega - número\",\n    \"7-3\": \"Endereço de entrega - bairro\",\n    \"8-3\": \"Endereço de entrega - cidade\",\n    \"9-3\": \"Endereço de entrega - estado\",\n    \"10-3\": \"Endereço de entrega - país\",\n    \"11-3\": \"Endereço de entrega - referência (auxílio para o entregador)\",\n    \"12-3\": \"Endereço de entrega - complemento\",\n    \"13-3\": \"Endereço de entrega - CEP\",\n    \"14-3\": \"Nome do contato (destinatário)\",\n    \"15-3\": \"Telefone do contato (destinatário)\",\n    \"16-3\": \"Email do contato (destinatário)\",\n    \"17-3\": \"Nome do depósito (tal qual configurado na página de depósitos)\",\n    \"18-3\": \"Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)\",\n    \"19-3\": \"Descrição dos pacotes (sobrescreve \\\"amount\\\", dado que é uma descrição mais precisa de cada pacote)\",\n    \"20-3\": \"Descrição da entrega (informação mostrada ao entregador)\",\n    \"21-3\": \"Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)\",\n    \"22-3\": \"ID do cliente (campo opcional, não relevante nas integrações de e-commerces)\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\n    \"6-2\": \"String\",\n    \"7-2\": \"String\",\n    \"8-2\": \"String\",\n    \"9-2\": \"String\",\n    \"10-2\": \"String\",\n    \"11-2\": \"String\",\n    \"12-2\": \"String\",\n    \"13-2\": \"String\",\n    \"14-2\": \"String\",\n    \"15-2\": \"String\",\n    \"16-2\": \"String\",\n    \"17-2\": \"String\",\n    \"18-2\": \"String\",\n    \"19-2\": \"String\",\n    \"20-2\": \"String\",\n    \"21-2\": \"String\",\n    \"22-2\": \"String\",\n    \"0-1\": \"<span style=\\\"color:red\\\">*required, unique*</span>\",\n    \"5-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"9-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"10-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"13-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"18-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"17-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"8-1\": \"<span style=\\\"color:red\\\">*required*</span>\"\n  },\n  \"cols\": 4,\n  \"rows\": 23\n}\n[/block]","createdAt":"2017-04-19T15:50:15.680Z","hidden":false,"next":{"pages":[],"description":""},"order":6,"sync_unique":"","type":"delete","user":"56533f1854e3e221002c28ea","githubsync":"","link_url":"","parentDoc":null,"project":"552ed3282594f70d001b2d69","title":"/api/v1/orders/{id}","__v":1,"childrenPages":[]}

delete/api/v1/orders/{id}

Deleta uma order

Path Params

id:
required
string
Identificador do pedido na loja do cliente

Query Params

api_key:
required
string
Token de acesso
live_mode:
required
string
Chavemento entre produção e teste
##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude", "4-3": "Longitude", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##**Objeto Order** [block:parameters] { "data": { "h-0": "Attribute", "h-2": "Type", "h-3": "Description", "0-0": "id", "1-0": "delivery_date_min", "2-0": "delivery_date_max", "3-0": "lat", "4-0": "lng", "5-0": "street", "6-0": "street_number", "7-0": "neighborhood", "8-0": "city", "9-0": "province", "10-0": "country", "11-0": "reference", "12-0": "complement", "13-0": "zip_code", "14-0": "contact_name", "15-0": "contact_phone", "16-0": "contact_email", "17-0": "depot_alias", "18-0": "amount", "19-0": "packages", "20-0": "description", "21-0": "modal", "22-0": "client_id", "0-3": "Identificador do pedido na loja do cliente (para efeitos de rastreabilidade, esse número deve ser único)", "1-3": "Início do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "2-3": "Final do intervalo de entrega (não informe esse dado se não desejar selecionar o lote em que será roteirizado o pedido)", "3-3": "Latitude", "4-3": "Longitude", "5-3": "Endereço de entrega - tipo e logradouro (por exemplo, Avenida Paulista)", "6-3": "Endereço de entrega - número", "7-3": "Endereço de entrega - bairro", "8-3": "Endereço de entrega - cidade", "9-3": "Endereço de entrega - estado", "10-3": "Endereço de entrega - país", "11-3": "Endereço de entrega - referência (auxílio para o entregador)", "12-3": "Endereço de entrega - complemento", "13-3": "Endereço de entrega - CEP", "14-3": "Nome do contato (destinatário)", "15-3": "Telefone do contato (destinatário)", "16-3": "Email do contato (destinatário)", "17-3": "Nome do depósito (tal qual configurado na página de depósitos)", "18-3": "Quantidade (pacotes de tamanho padrão, configurados juntamente com os horários de otimização)", "19-3": "Descrição dos pacotes (sobrescreve \"amount\", dado que é uma descrição mais precisa de cada pacote)", "20-3": "Descrição da entrega (informação mostrada ao entregador)", "21-3": "Modal utilizado (não informar quando não houver necessidade de alteração do modal padrão)", "22-3": "ID do cliente (campo opcional, não relevante nas integrações de e-commerces)", "0-2": "String", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "7-2": "String", "8-2": "String", "9-2": "String", "10-2": "String", "11-2": "String", "12-2": "String", "13-2": "String", "14-2": "String", "15-2": "String", "16-2": "String", "17-2": "String", "18-2": "String", "19-2": "String", "20-2": "String", "21-2": "String", "22-2": "String", "0-1": "<span style=\"color:red\">*required, unique*</span>", "5-1": "<span style=\"color:red\">*required*</span>", "9-1": "<span style=\"color:red\">*required*</span>", "10-1": "<span style=\"color:red\">*required*</span>", "13-1": "<span style=\"color:red\">*required*</span>", "18-1": "<span style=\"color:red\">*required*</span>", "17-1": "<span style=\"color:red\">*required*</span>", "8-1": "<span style=\"color:red\">*required*</span>" }, "cols": 4, "rows": 23 } [/block]
{"_id":"57323656752a1f190012eb88","type":"get","__v":0,"editedParams":true,"hidden":false,"isReference":false,"link_external":false,"project":"552ed3282594f70d001b2d69","slug":"orders-get-signature","user":"56533f1854e3e221002c28ea","body":"Caso seja encontrada uma assinatura para o pedido denotado por seu ID em conjunto com seu hash, será retornada a imagem da assinatura do cliente. Para obter o hash, vide [/api/v1/orders/:id](doc:orders-get)","createdAt":"2016-05-10T19:28:22.676Z","excerpt":"Obtém a assinatura de um pedido de determinado id","version":"552ed3282594f70d001b2d6d","updates":[],"sync_unique":"","api":{"method":"get","params":[{"desc":"Identificador do pedido no sistema do cliente","default":"path","type":"string","name":"id","in":"path","_id":"57323656752a1f190012eb8a","ref":"","required":true},{"ref":"","required":true,"desc":"Hash da assinatura","default":"query","type":"string","name":"hash","in":"query","_id":"57323656752a1f190012eb89"}],"results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{\n  \"reason\": \"Arquivo não enviado.\",\n  \"code\": 400,\n  \"method\": \"GET\",\n  \"name\": \"Bad Request\",\n  \"error_code\": \"208\",\n  \"url\": \"https://api.rapiddo.com.br/api/v1/orders/signature/PEDIDO-123\"\n}","name":""}]},"settings":"","url":"/orders/signature/:id","auth":"required","examples":{"codes":[{"code":"try {\n  String id = \"PEDIDO-123\";\n  String apiKey = \"YOUR_API_KEY\";\n  String hash = \"2c72a5078f72b0c1f2f89cdf820e30a3\";\n\n  HttpClient httpClient = HttpClients.createDefault();\n  HttpDelete httpDelete = new HttpDelete(\"https://api.rapiddo.com.br/api/v1/orders/signature/\" + id + \"?\" + \n                                         \"api_key=\" + apiKey + \n                                         \"&hash=\" + hash);\n\n  HttpResponse response = httpClient.execute(httpDelete);\n  HttpEntity entity = response.getEntity();\n\n  if (entity != null) {\n    InputStream inStream = entity.getContent();\n    try {\n      BufferedReader in = new BufferedReader(new InputStreamReader(inStream, \"UTF-8\"));\n      String line = null;\n      while ((line = in.readLine()) != null) {\n        System.out.println(line);\n      }\n    } finally {\n      inStream.close();\n    }\n  }\n} catch (Exception e) {\n  // Do something\n  e.printStackTrace();\n}","language":"java"}]}},"category":"5731e5c6900b680e00cb3c73","editedParams2":true,"githubsync":"","link_url":"","order":7,"parentDoc":null,"title":"/api/v1/orders/signature/:id","childrenPages":[]}

get/api/v1/orders/signature/:id

Obtém a assinatura de um pedido de determinado id

Path Params

id:
required
stringpath
Identificador do pedido no sistema do cliente

Query Params

hash:
required
stringquery
Hash da assinatura
Caso seja encontrada uma assinatura para o pedido denotado por seu ID em conjunto com seu hash, será retornada a imagem da assinatura do cliente. Para obter o hash, vide [/api/v1/orders/:id](doc:orders-get)

Definition

{{ api_url }}{{ page_api_url }}

Examples



Caso seja encontrada uma assinatura para o pedido denotado por seu ID em conjunto com seu hash, será retornada a imagem da assinatura do cliente. Para obter o hash, vide [/api/v1/orders/:id](doc:orders-get)
{"_id":"58efa6e4ba4bab19002b5941","excerpt":"Cria um novo Client","hidden":false,"link_url":"","parentDoc":null,"project":"552ed3282594f70d001b2d69","api":{"settings":"","url":"/clients","auth":"required","examples":{"codes":[{"code":"/api/v1/clients?api_key=abc123&live_mode=true","language":"text","name":"Query"},{"code":"[\n\t{\n\t\t“phoneNumber”: “(11) 1234-5678”,\n\t\t“clientName”: “Nome Test”,\n\t\t“companyName”: “Company Test”,\n\t\t“cpnj”: “87557111000181”,\n\t\t“email”: “email@teste”,\n\t\t“password”:”senha”\n\t}\n]","language":"json"},{"code":"//Bibliotecas importadas para execução desse exemplo\nimport org.springframework.web.client.RestTemplate;\nimport org.springframework.http.HttpEntity;\nimport org.springframework.http.HttpHeaders;\nimport org.springframework.http.HttpMethod;\nimport org.springframework.http.ResponseEntity;\nimport com.google.gson.Gson;\n//Objeto Client criado seguindo o modelo do Object Client no fim da página\nimport model.Client;\n        \n    Client cliente = new Client();\n\t\tcliente.setClientName(\"Nome Test\");\n\t\tcliente.setCnpj(\"87557111000181\");\n\t\tcliente.setCompanyName(\"Company Test\");\n\t\tcliente.setEmail(\"email@teste\");\n\t\tcliente.setPassword(\"senha\");\n\t\tcliente.setPhoneNumber(\"(11) 1234-5678\");\n\t\tlistClient = new ArrayList<>();\n\t\tlistClient.add(cliente);\n    \n    RestTemplate restTemplate = new RestTemplate();\n    Gson gson = new Gson();\n    \n    HttpHeaders headers = new HttpHeaders();\n\t\theaders.setContentType(MediaType.APPLICATION_JSON);\n\t\tHttpEntity<String> entity = new HttpEntity<String>(gson.toJson(listClient),headers);\n    \n    //Trocar \"abc123\" por sua API KEY\n    String URL = \"https://api.rapiddo.com.br/api/v1/clients?api_key=abc123&live_mode=false\";\n  \n    ResponseEntity<String> result = restTemplate.exchange(URL, HttpMethod.POST, entity, String.class);","language":"java","name":null}]},"method":"post","params":[{"default":"","type":"string","name":"api_key","_id":"58efa7c19affa139003a9231","ref":"","in":"query","required":true,"desc":"Token de Acesso"},{"default":"","type":"boolean","name":"live_mode","_id":"58efa7c19affa139003a9230","ref":"","in":"query","required":true,"desc":"Chaveamento entre produção e teste"},{"in":"body","required":true,"desc":"Lista de objetos Client","default":"","type":"array_object","name":"clients","_id":"58efa7c19affa139003a922f","ref":""},{"desc":"application/json","default":"","type":"string","name":"Content-Type","_id":"58efa7c19affa139003a922e","ref":"","in":"header","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"[\n\t{\n\t\t\"id\": 179922,\n\t\t\"companyName\": \"Company Test\",\n\t\t\"cnpj\": \"87557111000181\",\n\t\t\"clientName\": \"Nome Test\",\n\t\t\"phoneNumber\": \"(11) 1234-5678”,\n\t\t\"email\": \"email@teste\",\n\t\t\"password\": “”\n\t}\n]\n","name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/clients\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","name":""}]}},"body":"##**Objeto Client**\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"1-0\": \"companyName\",\n    \"2-0\": \"clientName\",\n    \"3-0\": \"email\",\n    \"4-0\": \"password\",\n    \"5-0\": \"phoneNumber\",\n    \"6-0\": \"cnpj\",\n    \"1-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"2-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"3-1\": \"<span style=\\\"color:red\\\">*required, unique*</span>\",\n    \"4-1\": \"\",\n    \"5-1\": \"\",\n    \"6-1\": \"<span style=\\\"color:red\\\">*required*</span>\",\n    \"0-1\": \"\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"\",\n    \"h-2\": \"Type\",\n    \"0-2\": \"Integer\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"String\",\n    \"4-2\": \"String\",\n    \"5-2\": \"String\",\n    \"6-2\": \"String\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Id do objeto Client gerado pelo sistema e retornado na criação.\",\n    \"1-3\": \"Nome da empresa do Cliente\",\n    \"2-3\": \"Nome do Cliente\",\n    \"3-3\": \"Email do Cliente.\\n**Formatos:** \\\"xxxxx@xxxx.xxx\\\"( com pontuação) ou \\\"xxxxxxxxx\\\"( sem pontuação)\",\n    \"4-3\": \"Senha do Cliente\",\n    \"5-3\": \"Telefone do Cliente.\\n**Formatos:** Qualquer formato, aceitando [a-Z] e [0-9]\",\n    \"6-3\": \"CNPJ do Cliente.\\n**Formatos:** \\\"xxxxxxxxxxxxxx\\\"(14 numeros) ou \\\"xx.xxx.xxx/xxxx-xx\\\"(com pontuação)\"\n  },\n  \"cols\": 4,\n  \"rows\": 7\n}\n[/block]","sync_unique":"","type":"post","githubsync":"","isReference":false,"link_external":false,"updates":[],"__v":1,"next":{"pages":[],"description":""},"order":0,"title":"/api/v1/clients","user":"56533f1854e3e221002c28ea","version":"552ed3282594f70d001b2d6d","category":"572c9db5beb99b2000ab50a2","createdAt":"2017-04-13T16:27:16.308Z","slug":"apiv1clients-new","childrenPages":[]}

post/api/v1/clients

Cria um novo Client

Query Params

api_key:
required
string
Token de Acesso
live_mode:
required
boolean
Chaveamento entre produção e teste

Body Params

clients:
required
array of objects
Lista de objetos Client

Headers

Content-Type:
required
string
application/json
##**Objeto Client** [block:parameters] { "data": { "0-0": "id", "1-0": "companyName", "2-0": "clientName", "3-0": "email", "4-0": "password", "5-0": "phoneNumber", "6-0": "cnpj", "1-1": "<span style=\"color:red\">*required*</span>", "2-1": "<span style=\"color:red\">*required*</span>", "3-1": "<span style=\"color:red\">*required, unique*</span>", "4-1": "", "5-1": "", "6-1": "<span style=\"color:red\">*required*</span>", "0-1": "", "h-0": "Attribute", "h-1": "", "h-2": "Type", "0-2": "Integer", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "h-3": "Description", "0-3": "Id do objeto Client gerado pelo sistema e retornado na criação.", "1-3": "Nome da empresa do Cliente", "2-3": "Nome do Cliente", "3-3": "Email do Cliente.\n**Formatos:** \"xxxxx@xxxx.xxx\"( com pontuação) ou \"xxxxxxxxx\"( sem pontuação)", "4-3": "Senha do Cliente", "5-3": "Telefone do Cliente.\n**Formatos:** Qualquer formato, aceitando [a-Z] e [0-9]", "6-3": "CNPJ do Cliente.\n**Formatos:** \"xxxxxxxxxxxxxx\"(14 numeros) ou \"xx.xxx.xxx/xxxx-xx\"(com pontuação)" }, "cols": 4, "rows": 7 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##**Objeto Client** [block:parameters] { "data": { "0-0": "id", "1-0": "companyName", "2-0": "clientName", "3-0": "email", "4-0": "password", "5-0": "phoneNumber", "6-0": "cnpj", "1-1": "<span style=\"color:red\">*required*</span>", "2-1": "<span style=\"color:red\">*required*</span>", "3-1": "<span style=\"color:red\">*required, unique*</span>", "4-1": "", "5-1": "", "6-1": "<span style=\"color:red\">*required*</span>", "0-1": "", "h-0": "Attribute", "h-1": "", "h-2": "Type", "0-2": "Integer", "1-2": "String", "2-2": "String", "3-2": "String", "4-2": "String", "5-2": "String", "6-2": "String", "h-3": "Description", "0-3": "Id do objeto Client gerado pelo sistema e retornado na criação.", "1-3": "Nome da empresa do Cliente", "2-3": "Nome do Cliente", "3-3": "Email do Cliente.\n**Formatos:** \"xxxxx@xxxx.xxx\"( com pontuação) ou \"xxxxxxxxx\"( sem pontuação)", "4-3": "Senha do Cliente", "5-3": "Telefone do Cliente.\n**Formatos:** Qualquer formato, aceitando [a-Z] e [0-9]", "6-3": "CNPJ do Cliente.\n**Formatos:** \"xxxxxxxxxxxxxx\"(14 numeros) ou \"xx.xxx.xxx/xxxx-xx\"(com pontuação)" }, "cols": 4, "rows": 7 } [/block]
{"_id":"572ca50ecf980c2200104bea","hidden":false,"isReference":false,"type":"get","user":"5720e5627e91d00e00804eed","__v":1,"editedParams":true,"editedParams2":true,"slug":"apiv1clientsid","api":{"auth":"required","examples":{"codes":[{"code":"/api/v1/clients/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"get","params":[{"ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"query","_id":"572c98356f08d4190057accc"},{"required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"query","_id":"572c98356f08d4190057acca","ref":""},{"default":"path","type":"int","name":"id","in":"path","_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do cliente"}],"results":{"codes":[{"name":"","code":"{\n  \"phoneNumber\": \"\",\n  \"clientName\": \"\",\n  \"companyName\": \"\",\n  \"cnpj\": \"\",\n  \"id\": 0,\n  \"email\": \"\"\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/clients/{id}\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/clients/{id}"},"category":"572c9db5beb99b2000ab50a2","createdAt":"2016-05-06T14:07:10.514Z","githubsync":"","version":"552ed3282594f70d001b2d6d","parentDoc":null,"sync_unique":"","title":"/api/v1/clients/{id}","updates":[],"order":2,"project":"552ed3282594f70d001b2d69","body":"Busca um cliente a partir de seu Identificador Rapiddo","excerpt":"Visualizar","link_external":false,"link_url":"","childrenPages":[]}

get/api/v1/clients/{id}

Visualizar

Path Params

id:
required
integerpath
Identificador Rapiddo do cliente

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Busca um cliente a partir de seu Identificador Rapiddo

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca um cliente a partir de seu Identificador Rapiddo
{"_id":"572ca5decf980c2200104bee","excerpt":"Edição","githubsync":"","link_external":false,"updates":[],"category":"572c9db5beb99b2000ab50a2","createdAt":"2016-05-06T14:10:38.990Z","hidden":false,"link_url":"","sync_unique":"","title":"/api/v1/clients/{id}","editedParams":true,"editedParams2":true,"order":3,"parentDoc":null,"slug":"apiv1clientsid-1","user":"5720e5627e91d00e00804eed","type":"put","version":"552ed3282594f70d001b2d6d","__v":2,"api":{"examples":{"codes":[{"name":"body","code":"{\n  \"password\": \"\",\n  \"phoneNumber\": \"\",\n  \"clientName\": \"\",\n  \"companyName\": \"\",\n  \"cnpj\": \"\",\n  \"id\": 0,\n  \"email\": \"\"\n}","language":"json"},{"code":"/api/v1/clients/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"put","params":[{"in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key"},{"default":"query","desc":"Chaveamento entre produção e teste","name":"live_mode","ref":"","required":true,"type":"boolean","in":"body","_id":"572c98356f08d4190057acca"},{"required":true,"desc":"Identificador Rapiddo do cliente","default":"path","type":"int","name":"id","in":"path","_id":"572c98356f08d4190057accb","ref":""},{"default":"body","type":"object","name":"apiClient","in":"body","_id":"572ca65cbeb99b2000ab50ca","ref":"","required":true,"desc":"Objeto Client"}],"results":{"codes":[{"name":"","code":"{\n  \"phoneNumber\": \"\",\n  \"clientName\": \"\",\n  \"companyName\": \"\",\n  \"cnpj\": \"\",\n  \"id\": 0,\n  \"email\": \"\"\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/clients/{id}\",\n  \"method\": \"PUT\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/clients/{id}","auth":"required"},"body":"Edita um cliente","isReference":false,"project":"552ed3282594f70d001b2d69","childrenPages":[]}

put/api/v1/clients/{id}

Edição

Path Params

id:
required
integerpath
Identificador Rapiddo do cliente

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
apiClient:
required
objectbody
Objeto Client
Edita um cliente

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Edita um cliente
{"_id":"572ca89e7c8eff0e00aaa260","editedParams2":true,"isReference":false,"link_url":"","slug":"apiv1clientsid-2","sync_unique":"","version":"552ed3282594f70d001b2d6d","title":"/api/v1/clients/{id}","user":"5720e5627e91d00e00804eed","type":"delete","category":"572c9db5beb99b2000ab50a2","createdAt":"2016-05-06T14:22:22.448Z","editedParams":true,"excerpt":"Remoção","hidden":false,"order":4,"parentDoc":null,"updates":[],"__v":0,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/clients/{id}\",\n  \"method\": \"DELETE\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/clients/{id}","auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/clients/1?api_key=abc123&live_mode=true"}]},"method":"delete","params":[{"name":"api_key","in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string"},{"ref":"","required":true,"type":"boolean","in":"body","_id":"572c98356f08d4190057acca","default":"query","desc":"Chaveamento entre produção e teste","name":"live_mode"},{"in":"path","_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do cliente","default":"path","type":"int","name":"id"}]},"body":"Deleta um cliente dado seu Identificador Rapiddo","githubsync":"","link_external":false,"project":"552ed3282594f70d001b2d69","childrenPages":[]}

delete/api/v1/clients/{id}

Remoção

Path Params

id:
required
integerpath
Identificador Rapiddo do cliente

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Deleta um cliente dado seu Identificador Rapiddo

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Deleta um cliente dado seu Identificador Rapiddo
{"_id":"572ca905c310640e008f639c","body":"Salva depósitos","editedParams":true,"githubsync":"","slug":"apiv1clientsid2","sync_unique":"","category":"572ca8b07c8eff0e00aaa261","editedParams2":true,"isReference":false,"parentDoc":null,"user":"5720e5627e91d00e00804eed","__v":1,"api":{"results":{"codes":[{"code":"[{\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"alias\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"id\": 0,\n  \"contactPhone\": \"\"\n}]","language":"json","status":200,"name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/depots\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","status":400,"language":"json"}]},"settings":"","url":"/api/v1/depots","auth":"required","examples":{"codes":[{"name":"body","language":"json","code":"[\n  {\n    \"contactEmail\": \"\",\n    \"contactName\": \"\",\n    \"alias\": \"\",\n    \"location\": {\n      \"zipCode\": \"\",\n      \"country\": \"\",\n      \"city\": \"\",\n      \"latitude\": 0,\n      \"reference\": \"\",\n      \"number\": \"\",\n      \"province\": \"\",\n      \"street\": \"\",\n      \"neighborhood\": \"\",\n      \"complement\": \"\",\n      \"geoAddress\": \"\",\n      \"longitude\": 0\n    },\n    \"id\": 0,\n    \"contactPhone\": \"\"\n  }\n]"},{"name":"query","language":"text","code":"/api/v1/depots?api_key=abc123&live_mode=true&id=0"}]},"method":"post","params":[{"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true},{"type":"boolean","in":"body","_id":"572c98356f08d4190057acca","default":"query","desc":"Chaveamento entre produção e teste","name":"live_mode","ref":"","required":true},{"default":"query","type":"int","name":"id","in":"body","_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do cliente"},{"in":"body","_id":"572ca9dbcf980c2200104c04","default":"body","desc":"Lista de Depots","name":"depots","ref":"","required":true,"type":"object"}]},"createdAt":"2016-05-06T14:24:05.298Z","link_external":false,"link_url":"","type":"post","excerpt":"Inclusão","hidden":false,"order":0,"project":"552ed3282594f70d001b2d69","title":"/api/v1/depots","updates":[],"version":"552ed3282594f70d001b2d6d","childrenPages":[]}

post/api/v1/depots

Inclusão

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
id:
required
integerquery
Identificador Rapiddo do cliente
depots:
required
objectbody
Lista de Depots
Salva depósitos

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Salva depósitos
{"_id":"572cab1ecf980c2200104c08","createdAt":"2016-05-06T14:33:02.394Z","editedParams":true,"editedParams2":true,"isReference":false,"type":"get","__v":1,"excerpt":"Listar","hidden":false,"project":"552ed3282594f70d001b2d69","sync_unique":"","title":"/api/v1/depots","user":"5720e5627e91d00e00804eed","order":1,"api":{"params":[{"name":"api_key","in":"query","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string"},{"default":"query","type":"boolean","name":"live_mode","in":"query","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste"},{"_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do cliente","default":"query","type":"int","name":"id","in":"query"}],"results":{"codes":[{"name":"","code":"[{\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"alias\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"id\": 0,\n  \"contactPhone\": \"\"\n}]","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/depots\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/depots","auth":"required","examples":{"codes":[{"code":"/api/v1/depots?api_key=abc123&live_mode=true&id=0","language":"text","name":"query"}]},"method":"get"},"body":"Lista depósitos de um cliente","category":"572ca8b07c8eff0e00aaa261","githubsync":"","link_external":false,"link_url":"","parentDoc":null,"updates":[],"slug":"apiv1depots","version":"552ed3282594f70d001b2d6d","childrenPages":[]}

get/api/v1/depots

Listar

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
id:
required
integerquery
Identificador Rapiddo do cliente
Lista depósitos de um cliente

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Lista depósitos de um cliente
{"_id":"572cabca6f08d4190057ad0e","type":"get","user":"5720e5627e91d00e00804eed","__v":1,"api":{"url":"/api/v1/depots/{id}","auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/depots/1?api_key=abc123&live_mode=true&client_id=1"}]},"method":"get","params":[{"in":"query","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key"},{"name":"live_mode","in":"query","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean"},{"default":"query","type":"int","name":"client_id","in":"query","_id":"572cacbfcf980c2200104c0f","ref":"","required":true,"desc":"Identificador Rapiddo do cliente"},{"in":"path","_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do depósito","default":"path","type":"int","name":"id"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"alias\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"id\": 0,\n  \"contactPhone\": \"\"\n}","language":"json"},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/depots/{id}\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":""},"hidden":false,"project":"552ed3282594f70d001b2d69","title":"/api/v1/depots/{id}","slug":"apiv1depotsid","updates":[],"category":"572ca8b07c8eff0e00aaa261","githubsync":"","link_external":false,"order":2,"version":"552ed3282594f70d001b2d6d","editedParams":true,"editedParams2":true,"isReference":false,"link_url":"","sync_unique":"","body":"Visualiza um depósito dado seu Identificador Rapiddo","createdAt":"2016-05-06T14:35:54.778Z","excerpt":"Visualizar","parentDoc":null,"childrenPages":[]}

get/api/v1/depots/{id}

Visualizar

Path Params

id:
required
integerpath
Identificador Rapiddo do depósito

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
client_id:
required
integerquery
Identificador Rapiddo do cliente
Visualiza um depósito dado seu Identificador Rapiddo

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Visualiza um depósito dado seu Identificador Rapiddo
{"_id":"572cacf35c03ec290060a457","__v":1,"createdAt":"2016-05-06T14:40:51.386Z","editedParams2":true,"hidden":false,"project":"552ed3282594f70d001b2d69","type":"put","updates":[],"api":{"url":"/api/v1/depots/{id}","auth":"required","examples":{"codes":[{"code":"/api/v1/depots/1?api_key=abc123&live_mode=true","language":"text","name":"query"},{"code":"{\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"alias\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"id\": 0,\n  \"contactPhone\": \"\"\n}","language":"json","name":"body"}]},"method":"put","params":[{"_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body"},{"in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode"},{"name":"id","in":"path","_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do depósito","default":"path","type":"int"},{"desc":"Objeto Depot","default":"body","type":"object","name":"apiDepot","in":"body","_id":"572cacbfcf980c2200104c0f","ref":"","required":true}],"results":{"codes":[{"name":"","code":"{\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"alias\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"id\": 0,\n  \"contactPhone\": \"\"\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/depots/{id}\",\n  \"method\": \"PUT\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":""},"link_url":"","order":3,"parentDoc":null,"title":"/api/v1/depots/{id}","user":"5720e5627e91d00e00804eed","body":"Edita um depósito","category":"572ca8b07c8eff0e00aaa261","editedParams":true,"isReference":false,"slug":"apiv1depotsid-1","sync_unique":"","version":"552ed3282594f70d001b2d6d","excerpt":"Edição","githubsync":"","link_external":false,"childrenPages":[]}

put/api/v1/depots/{id}

Edição

Path Params

id:
required
integerpath
Identificador Rapiddo do depósito

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
apiDepot:
required
objectbody
Objeto Depot
Edita um depósito

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Edita um depósito
{"_id":"572cad807c8eff0e00aaa272","project":"552ed3282594f70d001b2d69","title":"/api/v1/depots/{id}","githubsync":"","isReference":false,"excerpt":"Remoção","link_external":false,"link_url":"","type":"delete","user":"5720e5627e91d00e00804eed","body":"Deleta um depósito dado seu Identificador Rapiddo","category":"572ca8b07c8eff0e00aaa261","editedParams":true,"slug":"apiv1depotsid-2","__v":1,"hidden":false,"order":4,"parentDoc":null,"sync_unique":"","updates":[],"version":"552ed3282594f70d001b2d6d","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/depots/{id}\",\n  \"method\": \"PUT\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/depots/{id}","auth":"required","examples":{"codes":[{"code":"/api/v1/depots/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"delete","params":[{"_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body"},{"in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode"},{"ref":"","required":true,"desc":"Identificador Rapiddo do depósito","default":"path","type":"int","name":"id","in":"path","_id":"572c98356f08d4190057accb"}]},"createdAt":"2016-05-06T14:43:12.111Z","editedParams2":true,"childrenPages":[]}

delete/api/v1/depots/{id}

Remoção

Path Params

id:
required
integerpath
Identificador Rapiddo do depósito

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Deleta um depósito dado seu Identificador Rapiddo

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Deleta um depósito dado seu Identificador Rapiddo
{"_id":"572caf2373c5671700a7ad5f","project":"552ed3282594f70d001b2d69","slug":"apiv1destinationstask_id","title":"/api/v1/destinations/{task_id}","createdAt":"2016-05-06T14:50:11.484Z","editedParams":true,"excerpt":"Inclusão","isReference":false,"link_url":"","order":0,"category":"572cae5c6f08d4190057ad18","body":"Salva destinos","editedParams2":true,"type":"post","user":"5720e5627e91d00e00804eed","version":"552ed3282594f70d001b2d6d","__v":2,"api":{"results":{"codes":[{"name":"","code":"[{\n  \"dispatcherDescription\": \"\",\n  \"scheduled\": false,\n  \"paymentType\": \"\",\n  \"deliveryCheckinDate\": \"\",\n  \"senderName\": \"\",\n  \"workerDescription\": \"\",\n  \"price\": 0,\n  \"pickUpCheckoutDate\": \"\",\n  \"id\": 0,\n  \"worker\": {\n    \"visible\": false,\n    \"lastLongitude\": 0,\n    \"companyName\": \"\",\n    \"lastTrackDate\": \"\",\n    \"active\": false,\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"busy\": false,\n    \"cpf\": \"\",\n    \"name\": \"\",\n    \"id\": 0,\n    \"lastLatitude\": 0,\n    \"email\": \"\"\n  },\n  \"deliveryDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"trackingId\": \"\",\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"receiverName\": \"\",\n  \"depotDescription\": \"\",\n  \"index\": 0,\n  \"shareId\": \"\",\n  \"priority\": 0,\n  \"deliveryCheckoutDate\": \"\",\n  \"pickUpDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"size\": 0,\n  \"pickUpCheckinDate\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"workerCost\": 0,\n  \"contactPhone\": \"\",\n  \"depotAlias\": \"\",\n  \"status\": \"\"\n}]","language":"json","status":200},{"name":"","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/destinations/{task_id}\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":"","url":"/api/v1/destinations/{task_id}","auth":"required","examples":{"codes":[{"code":"/api/v1/destinations/1?api_key=abc123&live_mode=true","language":"text","name":"query"},{"name":"body","language":"json","code":"[{\n  \"dispatcherDescription\": \"\",\n  \"scheduled\": false,\n  \"paymentType\": \"\",\n  \"deliveryCheckinDate\": \"\",\n  \"senderName\": \"\",\n  \"workerDescription\": \"\",\n  \"price\": 0,\n  \"pickUpCheckoutDate\": \"\",\n  \"id\": 0,\n  \"worker\": {\n    \"visible\": false,\n    \"lastLongitude\": 0,\n    \"companyName\": \"\",\n    \"lastTrackDate\": \"\",\n    \"active\": false,\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"busy\": false,\n    \"cpf\": \"\",\n    \"name\": \"\",\n    \"id\": 0,\n    \"lastLatitude\": 0,\n    \"email\": \"\"\n  },\n  \"deliveryDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"trackingId\": \"\",\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"receiverName\": \"\",\n  \"depotDescription\": \"\",\n  \"index\": 0,\n  \"shareId\": \"\",\n  \"priority\": 0,\n  \"deliveryCheckoutDate\": \"\",\n  \"pickUpDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"size\": 0,\n  \"pickUpCheckinDate\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"workerCost\": 0,\n  \"contactPhone\": \"\",\n  \"depotAlias\": \"\",\n  \"status\": \"\"\n}]"}]},"method":"post","params":[{"in":"body","_id":"572caf2373c5671700a7ad61","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key"},{"name":"live_mode","in":"body","_id":"572caf2373c5671700a7ad60","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean"},{"desc":"Identificador Rapiddo da task","default":"path","type":"int","name":"task_id","in":"path","_id":"572caf3d6f08d4190057ad1c","ref":"","required":true},{"default":"body","desc":"Lista de destination","name":"destination","ref":"","required":true,"type":"object","in":"body","_id":"572caf54c310640e008f63b9"}]},"link_external":false,"parentDoc":null,"sync_unique":"","updates":[],"githubsync":"","hidden":false,"childrenPages":[]}

post/api/v1/destinations/{task_id}

Inclusão

Path Params

task_id:
required
integerpath
Identificador Rapiddo da task

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
destination:
required
objectbody
Lista de destination
Salva destinos

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Salva destinos
{"_id":"572cb0d773c5671700a7ad66","body":"Edita destino","excerpt":"Edição","slug":"apiv1destinationsid","user":"5720e5627e91d00e00804eed","__v":0,"api":{"url":"/api/v1/destinations/{id}","auth":"required","examples":{"codes":[{"code":"/api/v1/destinations/1?api_key=abc123&live_mode=true","language":"text","name":"query"},{"language":"json","code":"[{\n  \"dispatcherDescription\": \"\",\n  \"scheduled\": false,\n  \"paymentType\": \"\",\n  \"deliveryCheckinDate\": \"\",\n  \"senderName\": \"\",\n  \"workerDescription\": \"\",\n  \"price\": 0,\n  \"pickUpCheckoutDate\": \"\",\n  \"id\": 0,\n  \"worker\": {\n    \"visible\": false,\n    \"lastLongitude\": 0,\n    \"companyName\": \"\",\n    \"lastTrackDate\": \"\",\n    \"active\": false,\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"busy\": false,\n    \"cpf\": \"\",\n    \"name\": \"\",\n    \"id\": 0,\n    \"lastLatitude\": 0,\n    \"email\": \"\"\n  },\n  \"deliveryDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"trackingId\": \"\",\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"receiverName\": \"\",\n  \"depotDescription\": \"\",\n  \"index\": 0,\n  \"shareId\": \"\",\n  \"priority\": 0,\n  \"deliveryCheckoutDate\": \"\",\n  \"pickUpDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"size\": 0,\n  \"pickUpCheckinDate\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"workerCost\": 0,\n  \"contactPhone\": \"\",\n  \"depotAlias\": \"\",\n  \"status\": \"\"\n}]","name":"body"}]},"method":"put","params":[{"type":"string","name":"api_key","in":"body","_id":"572caf2373c5671700a7ad61","ref":"","required":true,"desc":"Token de acesso","default":"query"},{"required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"body","_id":"572caf2373c5671700a7ad60","ref":""},{"desc":"Identificador Rapiddo do destination","default":"path","type":"int","name":"id","in":"path","_id":"572caf3d6f08d4190057ad1c","ref":"","required":true},{"name":"destination","in":"body","_id":"572caf54c310640e008f63b9","ref":"","required":true,"desc":"Lista de destination","default":"body","type":"object"}],"results":{"codes":[{"status":200,"language":"json","code":"[{\n  \"dispatcherDescription\": \"\",\n  \"scheduled\": false,\n  \"paymentType\": \"\",\n  \"deliveryCheckinDate\": \"\",\n  \"senderName\": \"\",\n  \"workerDescription\": \"\",\n  \"price\": 0,\n  \"pickUpCheckoutDate\": \"\",\n  \"id\": 0,\n  \"worker\": {\n    \"visible\": false,\n    \"lastLongitude\": 0,\n    \"companyName\": \"\",\n    \"lastTrackDate\": \"\",\n    \"active\": false,\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"busy\": false,\n    \"cpf\": \"\",\n    \"name\": \"\",\n    \"id\": 0,\n    \"lastLatitude\": 0,\n    \"email\": \"\"\n  },\n  \"deliveryDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"trackingId\": \"\",\n  \"contactEmail\": \"\",\n  \"contactName\": \"\",\n  \"receiverName\": \"\",\n  \"depotDescription\": \"\",\n  \"index\": 0,\n  \"shareId\": \"\",\n  \"priority\": 0,\n  \"deliveryCheckoutDate\": \"\",\n  \"pickUpDate\": {\n    \"max\": \"\",\n    \"min\": \"\"\n  },\n  \"size\": 0,\n  \"pickUpCheckinDate\": \"\",\n  \"location\": {\n    \"zipCode\": \"\",\n    \"country\": \"\",\n    \"city\": \"\",\n    \"latitude\": 0,\n    \"reference\": \"\",\n    \"number\": \"\",\n    \"province\": \"\",\n    \"street\": \"\",\n    \"neighborhood\": \"\",\n    \"complement\": \"\",\n    \"geoAddress\": \"\",\n    \"longitude\": 0\n  },\n  \"workerCost\": 0,\n  \"contactPhone\": \"\",\n  \"depotAlias\": \"\",\n  \"status\": \"\"\n}]","name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/destinations/{id}\",\n  \"method\": \"PUT\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","name":""}]},"settings":""},"parentDoc":null,"category":"572cae5c6f08d4190057ad18","isReference":false,"order":1,"link_url":"","project":"552ed3282594f70d001b2d69","title":"/api/v1/destinations/{id}","type":"put","updates":[],"editedParams":true,"editedParams2":true,"hidden":false,"sync_unique":"","version":"552ed3282594f70d001b2d6d","createdAt":"2016-05-06T14:57:27.593Z","githubsync":"","link_external":false,"childrenPages":[]}

put/api/v1/destinations/{id}

Edição

Path Params

id:
required
integerpath
Identificador Rapiddo do destination

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
destination:
required
objectbody
Lista de destination
Edita destino

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Edita destino
{"_id":"572cb175cf980c2200104c25","createdAt":"2016-05-06T15:00:05.008Z","editedParams":true,"project":"552ed3282594f70d001b2d69","title":"/api/v1/destinations/{id}","type":"delete","__v":1,"body":"Remove destino","category":"572cae5c6f08d4190057ad18","editedParams2":true,"excerpt":"Remoção","api":{"auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/destinations/1?api_key=abc123&live_mode=true"}]},"method":"delete","params":[{"type":"string","name":"api_key","in":"body","_id":"572caf2373c5671700a7ad61","ref":"","required":true,"desc":"Token de acesso","default":"query"},{"required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"body","_id":"572caf2373c5671700a7ad60","ref":""},{"default":"path","type":"int","name":"id","in":"path","_id":"572caf3d6f08d4190057ad1c","ref":"","required":true,"desc":"Identificador Rapiddo do destination"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/destinations/{id}\",\n  \"method\": \"DELETE\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","name":""}]},"settings":"","url":"/api/v1/destinations/{id}"},"hidden":false,"link_external":false,"order":2,"parentDoc":null,"slug":"apiv1destinationsid-1","version":"552ed3282594f70d001b2d6d","githubsync":"","isReference":false,"link_url":"","sync_unique":"","updates":[],"user":"5720e5627e91d00e00804eed","childrenPages":[]}

delete/api/v1/destinations/{id}

Remoção

Path Params

id:
required
integerpath
Identificador Rapiddo do destination

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Remove destino

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Remove destino
{"_id":"572cb2aac310640e008f63c0","type":"get","category":"572cb1b97c8eff0e00aaa281","editedParams":true,"parentDoc":null,"title":"/api/v1/actions","order":0,"project":"552ed3282594f70d001b2d69","version":"552ed3282594f70d001b2d6d","__v":0,"editedParams2":true,"githubsync":"","link_url":"","slug":"apiv1actions","user":"5720e5627e91d00e00804eed","api":{"method":"get","params":[{"default":"query","type":"string","name":"api_key","in":"query","_id":"572cb2aac310640e008f63c3","ref":"","required":true,"desc":"Token de acesso"},{"in":"query","_id":"572cb2aac310640e008f63c2","default":"query","desc":"Início intervalo da busca","name":"since","ref":"","required":false,"type":"string"},{"default":"query","desc":"Fim do intervalo da busca","name":"until","ref":"","required":false,"type":"string","in":"query","_id":"572cb2aac310640e008f63c1"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[{\n  \"date\": \"\",\n  \"resultCode\": \"\",\n  \"responseList\": [\n    {\n      \"date\": \"\",\n      \"code\": \"\",\n      \"description\": \"\",\n      \"time\": 0,\n      \"text\": \"\",\n      \"id\": 0,\n      \"user\": \"\"\n    }\n  ],\n  \"typeDescription\": \"\",\n  \"resultDescription\": \"\",\n  \"text\": \"\",\n  \"id\": 0,\n  \"user\": \"\",\n  \"trackingId\": \"\",\n  \"typeCode\": \"\"\n}]"},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/actions\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","name":""}]},"settings":"","url":"/api/v1/actions","auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/actions?api_key=abc123&since=01/05/2016&until=15/05/2016"}]}},"excerpt":"Listar por data","isReference":false,"link_external":false,"sync_unique":"","updates":[],"body":"Lista todas as ações com alterações em um período","createdAt":"2016-05-06T15:05:14.989Z","hidden":false,"childrenPages":[]}

get/api/v1/actions

Listar por data

Query Params

api_key:
required
stringquery
Token de acesso
since:
stringquery
Início intervalo da busca
until:
stringquery
Fim do intervalo da busca
Lista todas as ações com alterações em um período

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Lista todas as ações com alterações em um período
{"_id":"572cb32e6f08d4190057ad2b","editedParams":true,"githubsync":"","slug":"apiv1actions-1","body":"Salva um registro de ação para uma tarefa","category":"572cb1b97c8eff0e00aaa281","createdAt":"2016-05-06T15:07:26.081Z","order":1,"parentDoc":null,"sync_unique":"","title":"/api/v1/actions","type":"post","editedParams2":true,"excerpt":"Inclusão","isReference":false,"user":"5720e5627e91d00e00804eed","version":"552ed3282594f70d001b2d6d","__v":1,"api":{"auth":"required","examples":{"codes":[{"code":"/api/v1/actions?api_key=abc123","language":"text","name":"query"},{"code":"{\n  \"date\": \"\",\n  \"resultCode\": \"\",\n  \"responseList\": [\n    {\n      \"date\": \"\",\n      \"code\": \"\",\n      \"description\": \"\",\n      \"time\": 0,\n      \"text\": \"\",\n      \"id\": 0,\n      \"user\": \"\"\n    }\n  ],\n  \"typeDescription\": \"\",\n  \"resultDescription\": \"\",\n  \"text\": \"\",\n  \"id\": 0,\n  \"user\": \"\",\n  \"trackingId\": \"\",\n  \"typeCode\": \"\"\n}","language":"json","name":"body"}]},"method":"post","params":[{"type":"string","name":"api_key","in":"body","_id":"572cb2aac310640e008f63c3","ref":"","required":true,"desc":"Token de acesso","default":"query"},{"type":"string","name":"taskAction","in":"body","_id":"572cb2aac310640e008f63c1","ref":"","required":true,"desc":"Objeto WorkerAction","default":"body"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"date\": \"\",\n  \"resultCode\": \"\",\n  \"responseList\": [\n    {\n      \"date\": \"\",\n      \"code\": \"\",\n      \"description\": \"\",\n      \"time\": 0,\n      \"text\": \"\",\n      \"id\": 0,\n      \"user\": \"\"\n    }\n  ],\n  \"typeDescription\": \"\",\n  \"resultDescription\": \"\",\n  \"text\": \"\",\n  \"id\": 0,\n  \"user\": \"\",\n  \"trackingId\": \"\",\n  \"typeCode\": \"\"\n}"},{"name":"","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/actions\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":"","url":"/api/v1/actions"},"project":"552ed3282594f70d001b2d69","updates":[],"hidden":false,"link_external":false,"link_url":"","childrenPages":[]}

post/api/v1/actions

Inclusão

Body Params

api_key:
required
stringquery
Token de acesso
taskAction:
required
stringbody
Objeto WorkerAction
Salva um registro de ação para uma tarefa

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Salva um registro de ação para uma tarefa
{"_id":"572cb4226f08d4190057ad2e","githubsync":"","slug":"apiv1actionstracking_id","type":"get","user":"5720e5627e91d00e00804eed","version":"552ed3282594f70d001b2d6d","__v":0,"excerpt":"Listar por task","link_external":false,"link_url":"","project":"552ed3282594f70d001b2d69","parentDoc":null,"updates":[],"api":{"auth":"required","examples":{"codes":[{"code":"/api/v1/actions/1?api_key=abc123","language":"text","name":"query"}]},"method":"get","params":[{"name":"api_key","in":"query","_id":"572cb2aac310640e008f63c3","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string"},{"default":"path","type":"string","name":"tracking_id","in":"path","_id":"572cb2aac310640e008f63c1","ref":"","required":true,"desc":"Identificador de rastreamento da Task"}],"results":{"codes":[{"name":"","code":"{\n  \"date\": \"\",\n  \"resultCode\": \"\",\n  \"responseList\": [\n    {\n      \"date\": \"\",\n      \"code\": \"\",\n      \"description\": \"\",\n      \"time\": 0,\n      \"text\": \"\",\n      \"id\": 0,\n      \"user\": \"\"\n    }\n  ],\n  \"typeDescription\": \"\",\n  \"resultDescription\": \"\",\n  \"text\": \"\",\n  \"id\": 0,\n  \"user\": \"\",\n  \"trackingId\": \"\",\n  \"typeCode\": \"\"\n}","language":"json","status":200},{"name":"","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/actions/{tracking_id}\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":"","url":"/api/v1/actions/{tracking_id}"},"body":"Lista todas as ações para uma tarefa","category":"572cb1b97c8eff0e00aaa281","editedParams2":true,"sync_unique":"","title":"/api/v1/actions/{tracking_id}","createdAt":"2016-05-06T15:11:30.865Z","editedParams":true,"hidden":false,"isReference":false,"order":2,"childrenPages":[]}

get/api/v1/actions/{tracking_id}

Listar por task

Path Params

tracking_id:
required
stringpath
Identificador de rastreamento da Task

Query Params

api_key:
required
stringquery
Token de acesso
Lista todas as ações para uma tarefa

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Lista todas as ações para uma tarefa
{"_id":"572cb4fcc310640e008f63c7","title":"/api/v1/tasks","user":"5720e5627e91d00e00804eed","editedParams2":true,"excerpt":"Inclusão","link_url":"","slug":"apiv1tasks","sync_unique":"","type":"post","updates":[],"version":"552ed3282594f70d001b2d6d","api":{"examples":{"codes":[{"language":"json","code":"[\n  {\n    \"client\": {\n      \"password\": \"\",\n      \"phoneNumber\": \"\",\n      \"clientName\": \"\",\n      \"companyName\": \"\",\n      \"id\": 0,\n      \"email\": \"\"\n    },\n    \"id\": 0,\n    \"depots\": [\n      {\n        \"contactEmail\": \"\",\n        \"contactName\": \"\",\n        \"alias\": \"\",\n        \"location\": {\n          \"zipCode\": \"\",\n          \"country\": \"\",\n          \"city\": \"\",\n          \"latitude\": 0,\n          \"reference\": \"\",\n          \"number\": \"\",\n          \"province\": \"\",\n          \"street\": \"\",\n          \"neighborhood\": \"\",\n          \"complement\": \"\",\n          \"geoAddress\": \"\",\n          \"longitude\": 0\n        },\n        \"id\": 0,\n        \"contactPhone\": \"\"\n      }\n    ],\n    \"destinations\": [\n      {\n        \"dispatcherDescription\": \"\",\n        \"scheduled\": false,\n        \"paymentType\": \"\",\n        \"deliveryCheckinDate\": \"\",\n        \"senderName\": \"\",\n        \"workerDescription\": \"\",\n        \"price\": 0,\n        \"pickUpCheckoutDate\": \"\",\n        \"id\": 0,\n        \"worker\": {\n          \"visible\": false,\n          \"lastLongitude\": 0,\n          \"companyName\": \"\",\n          \"lastTrackDate\": \"\",\n          \"active\": false,\n          \"password\": \"\",\n          \"phoneNumber\": \"\",\n          \"busy\": false,\n          \"cpf\": \"\",\n          \"name\": \"\",\n          \"id\": 0,\n          \"lastLatitude\": 0,\n          \"email\": \"\"\n        },\n        \"deliveryDate\": {\n          \"max\": \"\",\n          \"min\": \"\"\n        },\n        \"trackingId\": \"\",\n        \"contactEmail\": \"\",\n        \"contactName\": \"\",\n        \"receiverName\": \"\",\n        \"depotDescription\": \"\",\n        \"index\": 0,\n        \"shareId\": \"\",\n        \"priority\": 0,\n        \"deliveryCheckoutDate\": \"\",\n        \"pickUpDate\": {\n          \"max\": \"\",\n          \"min\": \"\"\n        },\n        \"size\": 0,\n        \"pickUpCheckinDate\": \"\",\n        \"location\": {\n          \"zipCode\": \"\",\n          \"country\": \"\",\n          \"city\": \"\",\n          \"latitude\": 0,\n          \"reference\": \"\",\n          \"number\": \"\",\n          \"province\": \"\",\n          \"street\": \"\",\n          \"neighborhood\": \"\",\n          \"complement\": \"\",\n          \"geoAddress\": \"\",\n          \"longitude\": 0\n        },\n        \"workerCost\": 0,\n        \"contactPhone\": \"\",\n        \"depotAlias\": \"\",\n        \"status\": \"\"\n      }\n    ]\n  }\n]","name":"body"},{"code":"/api/v1/tasks?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"post","params":[{"name":"api_key","in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string"},{"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true},{"type":"object","in":"body","_id":"572c98356f08d4190057accb","default":"body","desc":"Objeto Task","name":"tasks","ref":"","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"client\": {\n      \"password\": \"\",\n      \"phoneNumber\": \"\",\n      \"clientName\": \"\",\n      \"companyName\": \"\",\n      \"id\": 0,\n      \"email\": \"\"\n    },\n    \"id\": 0,\n    \"depots\": [\n      {\n        \"contactEmail\": \"\",\n        \"contactName\": \"\",\n        \"alias\": \"\",\n        \"location\": {\n          \"zipCode\": \"\",\n          \"country\": \"\",\n          \"city\": \"\",\n          \"latitude\": 0,\n          \"reference\": \"\",\n          \"number\": \"\",\n          \"province\": \"\",\n          \"street\": \"\",\n          \"neighborhood\": \"\",\n          \"complement\": \"\",\n          \"geoAddress\": \"\",\n          \"longitude\": 0\n        },\n        \"id\": 0,\n        \"contactPhone\": \"\"\n      }\n    ],\n    \"destinations\": [\n      {\n        \"dispatcherDescription\": \"\",\n        \"scheduled\": false,\n        \"paymentType\": \"\",\n        \"deliveryCheckinDate\": \"\",\n        \"senderName\": \"\",\n        \"workerDescription\": \"\",\n        \"price\": 0,\n        \"pickUpCheckoutDate\": \"\",\n        \"id\": 0,\n        \"worker\": {\n          \"visible\": false,\n          \"lastLongitude\": 0,\n          \"companyName\": \"\",\n          \"lastTrackDate\": \"\",\n          \"active\": false,\n          \"password\": \"\",\n          \"phoneNumber\": \"\",\n          \"busy\": false,\n          \"cpf\": \"\",\n          \"name\": \"\",\n          \"id\": 0,\n          \"lastLatitude\": 0,\n          \"email\": \"\"\n        },\n        \"deliveryDate\": {\n          \"max\": \"\",\n          \"min\": \"\"\n        },\n        \"trackingId\": \"\",\n        \"contactEmail\": \"\",\n        \"contactName\": \"\",\n        \"receiverName\": \"\",\n        \"depotDescription\": \"\",\n        \"index\": 0,\n        \"shareId\": \"\",\n        \"priority\": 0,\n        \"deliveryCheckoutDate\": \"\",\n        \"pickUpDate\": {\n          \"max\": \"\",\n          \"min\": \"\"\n        },\n        \"size\": 0,\n        \"pickUpCheckinDate\": \"\",\n        \"location\": {\n          \"zipCode\": \"\",\n          \"country\": \"\",\n          \"city\": \"\",\n          \"latitude\": 0,\n          \"reference\": \"\",\n          \"number\": \"\",\n          \"province\": \"\",\n          \"street\": \"\",\n          \"neighborhood\": \"\",\n          \"complement\": \"\",\n          \"geoAddress\": \"\",\n          \"longitude\": 0\n        },\n        \"workerCost\": 0,\n        \"contactPhone\": \"\",\n        \"depotAlias\": \"\",\n        \"status\": \"\"\n      }\n    ]\n  }\n]","name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":"","url":"/api/v1/tasks","auth":"required"},"category":"572cb485cf980c2200104c2d","createdAt":"2016-05-06T15:15:08.457Z","editedParams":true,"hidden":false,"isReference":false,"order":0,"parentDoc":null,"project":"552ed3282594f70d001b2d69","__v":0,"body":"Salva uma tarefa","githubsync":"","link_external":false,"childrenPages":[]}

post/api/v1/tasks

Inclusão

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
tasks:
required
objectbody
Objeto Task
Salva uma tarefa

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Salva uma tarefa
{"_id":"572cb5fb73c5671700a7ad72","order":1,"parentDoc":null,"sync_unique":"","createdAt":"2016-05-06T15:19:23.802Z","version":"552ed3282594f70d001b2d6d","body":"Busca uma lista de pedidos dado um intervalo de tempo e/ou status","isReference":false,"hidden":false,"link_external":false,"link_url":"","slug":"apiv1tasks-1","category":"572cb485cf980c2200104c2d","editedParams2":true,"editedParams":true,"excerpt":"Listar","githubsync":"","project":"552ed3282594f70d001b2d69","title":"/api/v1/tasks","type":"get","__v":0,"api":{"auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/tasks?api_key=abc123&live_mode=true&since=01/05/2016&until=15/05/2016"}]},"method":"get","params":[{"in":"query","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key"},{"name":"live_mode","in":"query","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean"},{"default":"query","type":"string","name":"since","in":"query","_id":"572cb5fb73c5671700a7ad75","ref":"","required":false,"desc":"Primeira data do intervalo da busca"},{"_id":"572cb5fb73c5671700a7ad74","ref":"","required":false,"desc":"Segunda data do intervalo da busca","default":"query","type":"string","name":"until","in":"query"},{"in":"query","_id":"572cb5fb73c5671700a7ad73","ref":"","required":false,"desc":"Status para busca","default":"query","type":"string","name":"status"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"client\": {\n      \"password\": \"\",\n      \"phoneNumber\": \"\",\n      \"clientName\": \"\",\n      \"companyName\": \"\",\n      \"id\": 0,\n      \"email\": \"\"\n    },\n    \"id\": 0,\n    \"depots\": [\n      {\n        \"contactEmail\": \"\",\n        \"contactName\": \"\",\n        \"alias\": \"\",\n        \"location\": {\n          \"zipCode\": \"\",\n          \"country\": \"\",\n          \"city\": \"\",\n          \"latitude\": 0,\n          \"reference\": \"\",\n          \"number\": \"\",\n          \"province\": \"\",\n          \"street\": \"\",\n          \"neighborhood\": \"\",\n          \"complement\": \"\",\n          \"geoAddress\": \"\",\n          \"longitude\": 0\n        },\n        \"id\": 0,\n        \"contactPhone\": \"\"\n      }\n    ],\n    \"destinations\": [\n      {\n        \"dispatcherDescription\": \"\",\n        \"scheduled\": false,\n        \"paymentType\": \"\",\n        \"deliveryCheckinDate\": \"\",\n        \"senderName\": \"\",\n        \"workerDescription\": \"\",\n        \"price\": 0,\n        \"pickUpCheckoutDate\": \"\",\n        \"id\": 0,\n        \"worker\": {\n          \"visible\": false,\n          \"lastLongitude\": 0,\n          \"companyName\": \"\",\n          \"lastTrackDate\": \"\",\n          \"active\": false,\n          \"password\": \"\",\n          \"phoneNumber\": \"\",\n          \"busy\": false,\n          \"cpf\": \"\",\n          \"name\": \"\",\n          \"id\": 0,\n          \"lastLatitude\": 0,\n          \"email\": \"\"\n        },\n        \"deliveryDate\": {\n          \"max\": \"\",\n          \"min\": \"\"\n        },\n        \"trackingId\": \"\",\n        \"contactEmail\": \"\",\n        \"contactName\": \"\",\n        \"receiverName\": \"\",\n        \"depotDescription\": \"\",\n        \"index\": 0,\n        \"shareId\": \"\",\n        \"priority\": 0,\n        \"deliveryCheckoutDate\": \"\",\n        \"pickUpDate\": {\n          \"max\": \"\",\n          \"min\": \"\"\n        },\n        \"size\": 0,\n        \"pickUpCheckinDate\": \"\",\n        \"location\": {\n          \"zipCode\": \"\",\n          \"country\": \"\",\n          \"city\": \"\",\n          \"latitude\": 0,\n          \"reference\": \"\",\n          \"number\": \"\",\n          \"province\": \"\",\n          \"street\": \"\",\n          \"neighborhood\": \"\",\n          \"complement\": \"\",\n          \"geoAddress\": \"\",\n          \"longitude\": 0\n        },\n        \"workerCost\": 0,\n        \"contactPhone\": \"\",\n        \"depotAlias\": \"\",\n        \"status\": \"\"\n      }\n    ]\n  }\n]","name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":"","url":"/api/v1/tasks"},"updates":[],"user":"5720e5627e91d00e00804eed","childrenPages":[]}

get/api/v1/tasks

Listar

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
since:
stringquery
Primeira data do intervalo da busca
until:
stringquery
Segunda data do intervalo da busca
status:
stringquery
Status para busca
Busca uma lista de pedidos dado um intervalo de tempo e/ou status

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca uma lista de pedidos dado um intervalo de tempo e/ou status
{"_id":"572cb6b6c310640e008f63cb","__v":0,"api":{"settings":"","url":"/api/v1/tasks/{id}/associate/service/{service_id}","auth":"required","examples":{"codes":[{"code":"/api/v1/tasks/1/associate/service/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"post","params":[{"_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body"},{"in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode"},{"default":"path","desc":"Identificador Rapiddo da Task","name":"id","ref":"","required":true,"type":"int","in":"path","_id":"572cb5fb73c5671700a7ad75"},{"required":true,"type":"int","in":"path","_id":"572cb5fb73c5671700a7ad74","default":"path","desc":"Identificador Rapiddo do Serviço","name":"service_id","ref":""},{"required":false,"type":"string","in":"body","_id":"572cb5fb73c5671700a7ad73","default":"query","desc":"Autor da associação","name":"author","ref":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"client\": {\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"clientName\": \"\",\n    \"companyName\": \"\",\n    \"id\": 0,\n    \"email\": \"\"\n  },\n  \"id\": 0,\n  \"depots\": [\n    {\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"alias\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"id\": 0,\n      \"contactPhone\": \"\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"dispatcherDescription\": \"\",\n      \"scheduled\": false,\n      \"paymentType\": \"\",\n      \"deliveryCheckinDate\": \"\",\n      \"senderName\": \"\",\n      \"workerDescription\": \"\",\n      \"price\": 0,\n      \"pickUpCheckoutDate\": \"\",\n      \"id\": 0,\n      \"worker\": {\n        \"visible\": false,\n        \"lastLongitude\": 0,\n        \"companyName\": \"\",\n        \"lastTrackDate\": \"\",\n        \"active\": false,\n        \"password\": \"\",\n        \"phoneNumber\": \"\",\n        \"busy\": false,\n        \"cpf\": \"\",\n        \"name\": \"\",\n        \"id\": 0,\n        \"lastLatitude\": 0,\n        \"email\": \"\"\n      },\n      \"deliveryDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"trackingId\": \"\",\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"receiverName\": \"\",\n      \"depotDescription\": \"\",\n      \"index\": 0,\n      \"shareId\": \"\",\n      \"priority\": 0,\n      \"deliveryCheckoutDate\": \"\",\n      \"pickUpDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"size\": 0,\n      \"pickUpCheckinDate\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"workerCost\": 0,\n      \"contactPhone\": \"\",\n      \"depotAlias\": \"\",\n      \"status\": \"\"\n    }\n  ]\n}","name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks/{id}/associate/service/{service_id}\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]}},"editedParams":true,"hidden":false,"link_url":"","parentDoc":null,"slug":"apiv1tasksidassociateserviceservice_id","type":"post","version":"552ed3282594f70d001b2d6d","category":"572cb485cf980c2200104c2d","link_external":false,"sync_unique":"","body":"Busca uma task a partir de seu identificador e associa a um serviço","createdAt":"2016-05-06T15:22:30.476Z","editedParams2":true,"excerpt":"Associar a serviço","isReference":false,"project":"552ed3282594f70d001b2d69","updates":[],"user":"5720e5627e91d00e00804eed","githubsync":"","order":2,"title":"/api/v1/tasks/{id}/associate/service/{service_id}","childrenPages":[]}

post/api/v1/tasks/{id}/associate/service/{service_id}

Associar a serviço

Path Params

id:
required
integerpath
Identificador Rapiddo da Task
service_id:
required
integerpath
Identificador Rapiddo do Serviço

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
author:
stringquery
Autor da associação
Busca uma task a partir de seu identificador e associa a um serviço

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca uma task a partir de seu identificador e associa a um serviço
{"_id":"572cb8546f08d4190057ad39","api":{"settings":"","url":"/api/v1/tasks/{id}/associate/{worker_id}","auth":"required","examples":{"codes":[{"code":"/api/v1/tasks/1/associate/service/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"post","params":[{"ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body","_id":"572c98356f08d4190057accc"},{"type":"boolean","name":"live_mode","in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query"},{"type":"int","name":"id","in":"path","_id":"572cb5fb73c5671700a7ad75","ref":"","required":true,"desc":"Identificador Rapiddo da Task","default":"path"},{"required":true,"desc":"Identificador Rapiddo do Worker","default":"path","type":"int","name":"worker_id","in":"path","_id":"572cb5fb73c5671700a7ad74","ref":""},{"desc":"Autor da associação","default":"query","type":"string","name":"author","in":"body","_id":"572cb5fb73c5671700a7ad73","ref":"","required":false},{"name":"pre_allocation","in":"body","_id":"572cb895cf980c2200104c37","ref":"","required":false,"desc":"Pré aloca entrega para o entregador","default":"query","type":"boolean"}],"results":{"codes":[{"name":"","code":"{\n  \"client\": {\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"clientName\": \"\",\n    \"companyName\": \"\",\n    \"id\": 0,\n    \"email\": \"\"\n  },\n  \"id\": 0,\n  \"depots\": [\n    {\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"alias\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"id\": 0,\n      \"contactPhone\": \"\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"dispatcherDescription\": \"\",\n      \"scheduled\": false,\n      \"paymentType\": \"\",\n      \"deliveryCheckinDate\": \"\",\n      \"senderName\": \"\",\n      \"workerDescription\": \"\",\n      \"price\": 0,\n      \"pickUpCheckoutDate\": \"\",\n      \"id\": 0,\n      \"worker\": {\n        \"visible\": false,\n        \"lastLongitude\": 0,\n        \"companyName\": \"\",\n        \"lastTrackDate\": \"\",\n        \"active\": false,\n        \"password\": \"\",\n        \"phoneNumber\": \"\",\n        \"busy\": false,\n        \"cpf\": \"\",\n        \"name\": \"\",\n        \"id\": 0,\n        \"lastLatitude\": 0,\n        \"email\": \"\"\n      },\n      \"deliveryDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"trackingId\": \"\",\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"receiverName\": \"\",\n      \"depotDescription\": \"\",\n      \"index\": 0,\n      \"shareId\": \"\",\n      \"priority\": 0,\n      \"deliveryCheckoutDate\": \"\",\n      \"pickUpDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"size\": 0,\n      \"pickUpCheckinDate\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"workerCost\": 0,\n      \"contactPhone\": \"\",\n      \"depotAlias\": \"\",\n      \"status\": \"\"\n    }\n  ]\n}","language":"json","status":200},{"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks/{id}/associate/{worker_id}\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","status":400}]}},"excerpt":"Associar a entregador","githubsync":"","link_url":"","order":3,"slug":"apiv1tasksidassociateworker_id","updates":[],"body":"Busca uma task a partir de seu identificador e associa a um entregador","createdAt":"2016-05-06T15:29:24.390Z","isReference":false,"link_external":false,"project":"552ed3282594f70d001b2d69","category":"572cb485cf980c2200104c2d","editedParams2":true,"sync_unique":"","title":"/api/v1/tasks/{id}/associate/{worker_id}","user":"5720e5627e91d00e00804eed","__v":1,"editedParams":true,"hidden":false,"parentDoc":null,"type":"post","version":"552ed3282594f70d001b2d6d","childrenPages":[]}

post/api/v1/tasks/{id}/associate/{worker_id}

Associar a entregador

Path Params

id:
required
integerpath
Identificador Rapiddo da Task
worker_id:
required
integerpath
Identificador Rapiddo do Worker

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
author:
stringquery
Autor da associação
pre_allocation:
booleanquery
Pré aloca entrega para o entregador
Busca uma task a partir de seu identificador e associa a um entregador

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca uma task a partir de seu identificador e associa a um entregador
{"_id":"572cb9c05c03ec290060a480","slug":"apiv1tasksiddisassociate","category":"572cb485cf980c2200104c2d","excerpt":"Desassociar entregador","githubsync":"","hidden":false,"link_url":"","order":4,"project":"552ed3282594f70d001b2d69","sync_unique":"","__v":0,"api":{"auth":"required","examples":{"codes":[{"language":"text","name":"query","code":"/api/v1/tasks/1/disassociate?api_key=abc123&live_mode=true"}]},"method":"post","params":[{"type":"string","name":"api_key","in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query"},{"required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"body","_id":"572c98356f08d4190057acca","ref":""},{"desc":"Identificador Rapiddo da Task","default":"path","type":"int","name":"id","in":"path","_id":"572cb5fb73c5671700a7ad75","ref":"","required":true},{"ref":"","required":false,"desc":"Autor da associação","default":"query","type":"string","name":"author","in":"body","_id":"572cb5fb73c5671700a7ad73"}],"results":{"codes":[{"name":"","code":"{\n  \"client\": {\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"clientName\": \"\",\n    \"companyName\": \"\",\n    \"id\": 0,\n    \"email\": \"\"\n  },\n  \"id\": 0,\n  \"depots\": [\n    {\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"alias\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"id\": 0,\n      \"contactPhone\": \"\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"dispatcherDescription\": \"\",\n      \"scheduled\": false,\n      \"paymentType\": \"\",\n      \"deliveryCheckinDate\": \"\",\n      \"senderName\": \"\",\n      \"workerDescription\": \"\",\n      \"price\": 0,\n      \"pickUpCheckoutDate\": \"\",\n      \"id\": 0,\n      \"worker\": {\n        \"visible\": false,\n        \"lastLongitude\": 0,\n        \"companyName\": \"\",\n        \"lastTrackDate\": \"\",\n        \"active\": false,\n        \"password\": \"\",\n        \"phoneNumber\": \"\",\n        \"busy\": false,\n        \"cpf\": \"\",\n        \"name\": \"\",\n        \"id\": 0,\n        \"lastLatitude\": 0,\n        \"email\": \"\"\n      },\n      \"deliveryDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"trackingId\": \"\",\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"receiverName\": \"\",\n      \"depotDescription\": \"\",\n      \"index\": 0,\n      \"shareId\": \"\",\n      \"priority\": 0,\n      \"deliveryCheckoutDate\": \"\",\n      \"pickUpDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"size\": 0,\n      \"pickUpCheckinDate\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"workerCost\": 0,\n      \"contactPhone\": \"\",\n      \"depotAlias\": \"\",\n      \"status\": \"\"\n    }\n  ]\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks/{id}/disassociate\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/tasks/{id}/disassociate"},"body":"Busca uma task a partir de seu identificador e desassocia de um entregador","createdAt":"2016-05-06T15:35:28.173Z","editedParams":true,"editedParams2":true,"updates":[],"isReference":false,"link_external":false,"title":"/api/v1/tasks/{id}/disassociate","user":"5720e5627e91d00e00804eed","version":"552ed3282594f70d001b2d6d","parentDoc":null,"type":"post","childrenPages":[]}

post/api/v1/tasks/{id}/disassociate

Desassociar entregador

Path Params

id:
required
integerpath
Identificador Rapiddo da Task

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
author:
stringquery
Autor da associação
Busca uma task a partir de seu identificador e desassocia de um entregador

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca uma task a partir de seu identificador e desassocia de um entregador
{"_id":"572cbacacf980c2200104c42","parentDoc":null,"user":"5720e5627e91d00e00804eed","link_url":"","project":"552ed3282594f70d001b2d69","__v":0,"api":{"auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/tasks/1?api_key=abc123&live_mode=true"}]},"method":"delete","params":[{"_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body"},{"in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode"},{"default":"path","desc":"Identificador do Pedido","name":"tracking_id","ref":"","required":true,"type":"int","in":"path","_id":"572cb5fb73c5671700a7ad75"},{"desc":"Motivo cancelamento","name":"cancel_type","ref":"","required":false,"type":"string","in":"body","_id":"572cb5fb73c5671700a7ad73","default":"query"}],"results":{"codes":[{"code":"{}","language":"json","status":200,"name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks/{tracking_id}\",\n  \"method\": \"DELETE\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/tasks/{tracking_id}"},"body":"Cancela uma task dado o trackingId e o identificador da company","editedParams2":true,"hidden":false,"isReference":false,"slug":"apiv1taskstracking_id","title":"/api/v1/tasks/{tracking_id}","sync_unique":"","type":"delete","category":"572cb485cf980c2200104c2d","createdAt":"2016-05-06T15:39:54.673Z","githubsync":"","link_external":false,"order":5,"updates":[],"editedParams":true,"excerpt":"Cancelar","version":"552ed3282594f70d001b2d6d","childrenPages":[]}

delete/api/v1/tasks/{tracking_id}

Cancelar

Path Params

tracking_id:
required
integerpath
Identificador do Pedido

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
cancel_type:
stringquery
Motivo cancelamento
Cancela uma task dado o trackingId e o identificador da company

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Cancela uma task dado o trackingId e o identificador da company
{"_id":"572cbb72c310640e008f63df","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks/{tracking_id}\",\n  \"method\": \"PUT\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/tasks/{tracking_id}","auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/tasks/1?api_key=abc123&live_mode=true"}]},"method":"put","params":[{"_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body"},{"in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode"},{"ref":"","required":true,"desc":"Identificador do Pedido","default":"path","type":"int","name":"tracking_id","in":"path","_id":"572cb5fb73c5671700a7ad75"}]},"githubsync":"","link_url":"","user":"5720e5627e91d00e00804eed","version":"552ed3282594f70d001b2d6d","__v":0,"category":"572cb485cf980c2200104c2d","editedParams2":true,"title":"/api/v1/tasks/{tracking_id}","type":"put","body":"Completa uma task dado o trackingId e o identificador da company","createdAt":"2016-05-06T15:42:42.707Z","excerpt":"Completar","hidden":false,"slug":"apiv1taskstracking_id-1","updates":[],"sync_unique":"","editedParams":true,"isReference":false,"link_external":false,"order":6,"parentDoc":null,"project":"552ed3282594f70d001b2d69","childrenPages":[]}

put/api/v1/tasks/{tracking_id}

Completar

Path Params

tracking_id:
required
integerpath
Identificador do Pedido

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Completa uma task dado o trackingId e o identificador da company

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Completa uma task dado o trackingId e o identificador da company
{"_id":"572cbba773c5671700a7ad7d","editedParams":true,"githubsync":"","hidden":false,"parentDoc":null,"slug":"apiv1taskstracking_id-2","order":7,"project":"552ed3282594f70d001b2d69","sync_unique":"","api":{"params":[{"name":"api_key","in":"query","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string"},{"default":"query","type":"boolean","name":"live_mode","in":"query","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste"},{"_id":"572cb5fb73c5671700a7ad75","ref":"","required":true,"desc":"Identificador do Pedido","default":"path","type":"int","name":"tracking_id","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"client\": {\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"clientName\": \"\",\n    \"companyName\": \"\",\n    \"id\": 0,\n    \"email\": \"\"\n  },\n  \"id\": 0,\n  \"depots\": [\n    {\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"alias\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"id\": 0,\n      \"contactPhone\": \"\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"dispatcherDescription\": \"\",\n      \"scheduled\": false,\n      \"paymentType\": \"\",\n      \"deliveryCheckinDate\": \"\",\n      \"senderName\": \"\",\n      \"workerDescription\": \"\",\n      \"price\": 0,\n      \"pickUpCheckoutDate\": \"\",\n      \"id\": 0,\n      \"worker\": {\n        \"visible\": false,\n        \"lastLongitude\": 0,\n        \"companyName\": \"\",\n        \"lastTrackDate\": \"\",\n        \"active\": false,\n        \"password\": \"\",\n        \"phoneNumber\": \"\",\n        \"busy\": false,\n        \"cpf\": \"\",\n        \"name\": \"\",\n        \"id\": 0,\n        \"lastLatitude\": 0,\n        \"email\": \"\"\n      },\n      \"deliveryDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"trackingId\": \"\",\n      \"contactEmail\": \"\",\n      \"contactName\": \"\",\n      \"receiverName\": \"\",\n      \"depotDescription\": \"\",\n      \"index\": 0,\n      \"shareId\": \"\",\n      \"priority\": 0,\n      \"deliveryCheckoutDate\": \"\",\n      \"pickUpDate\": {\n        \"max\": \"\",\n        \"min\": \"\"\n      },\n      \"size\": 0,\n      \"pickUpCheckinDate\": \"\",\n      \"location\": {\n        \"zipCode\": \"\",\n        \"country\": \"\",\n        \"city\": \"\",\n        \"latitude\": 0,\n        \"reference\": \"\",\n        \"number\": \"\",\n        \"province\": \"\",\n        \"street\": \"\",\n        \"neighborhood\": \"\",\n        \"complement\": \"\",\n        \"geoAddress\": \"\",\n        \"longitude\": 0\n      },\n      \"workerCost\": 0,\n      \"contactPhone\": \"\",\n      \"depotAlias\": \"\",\n      \"status\": \"\"\n    }\n  ]\n}","name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/tasks/{tracking_id}\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":"","url":"/api/v1/tasks/{tracking_id}","auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/tasks/1?api_key=abc123&live_mode=true"}]},"method":"get"},"editedParams2":true,"isReference":false,"link_url":"","type":"get","version":"552ed3282594f70d001b2d6d","__v":0,"body":"Busca uma task a partir de seu identifcador","category":"572cb485cf980c2200104c2d","createdAt":"2016-05-06T15:43:35.091Z","excerpt":"Vizualisar","link_external":false,"title":"/api/v1/tasks/{tracking_id}","updates":[],"user":"5720e5627e91d00e00804eed","childrenPages":[]}

get/api/v1/tasks/{tracking_id}

Vizualisar

Path Params

tracking_id:
required
integerpath
Identificador do Pedido

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Busca uma task a partir de seu identifcador

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca uma task a partir de seu identifcador
{"_id":"572ccc9a7c8eff0e00aaa2c7","editedParams2":true,"parentDoc":null,"project":"552ed3282594f70d001b2d69","type":"post","link_external":false,"slug":"apiv1tasksfefe","sync_unique":"","body":"Salva entregadores","editedParams":true,"excerpt":"Inclusão","hidden":false,"title":"/api/v1/workers","updates":[],"version":"552ed3282594f70d001b2d6d","api":{"url":"/api/v1/workers","auth":"required","examples":{"codes":[{"language":"json","code":"[\n  {\n    \"visible\": false,\n    \"lastLongitude\": 0,\n    \"companyName\": \"\",\n    \"lastTrackDate\": \"\",\n    \"active\": false,\n    \"password\": \"\",\n    \"phoneNumber\": \"\",\n    \"busy\": false,\n    \"cpf\": \"\",\n    \"name\": \"\",\n    \"id\": 0,\n    \"lastLatitude\": 0,\n    \"email\": \"\"\n  }\n]","name":"body"},{"code":"/api/v1/workers?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"post","params":[{"default":"query","type":"string","name":"api_key","in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso"},{"_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"body"},{"in":"body","_id":"572c98356f08d4190057accb","default":"body","desc":"Lista de Workers","name":"workers","ref":"","required":true,"type":"object"}],"results":{"codes":[{"status":200,"language":"json","code":"[{\n  \"visible\": false,\n  \"lastLongitude\": 0,\n  \"companyName\": \"\",\n  \"lastTrackDate\": \"\",\n  \"active\": false,\n  \"password\": \"\",\n  \"phoneNumber\": \"\",\n  \"busy\": false,\n  \"cpf\": \"\",\n  \"name\": \"\",\n  \"id\": 0,\n  \"lastLatitude\": 0,\n  \"email\": \"\"\n}]","name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/workers\",\n  \"method\": \"POST\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","language":"json","status":400}]},"settings":""},"createdAt":"2016-05-06T16:55:54.045Z","githubsync":"","order":0,"__v":0,"category":"572cbbcc6f08d4190057ad44","isReference":false,"link_url":"","user":"5720e5627e91d00e00804eed","childrenPages":[]}

post/api/v1/workers

Inclusão

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
workers:
required
objectbody
Lista de Workers
Salva entregadores

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Salva entregadores
{"_id":"572ccdd8eb7f451900b341cb","body":"Busca uma lista de entregadores dado um intervalo de tempo","editedParams":true,"excerpt":"Listar","isReference":false,"order":1,"parentDoc":null,"type":"get","updates":[],"version":"552ed3282594f70d001b2d6d","__v":2,"api":{"results":{"codes":[{"name":"","code":"[{\n  \"visible\": false,\n  \"lastLongitude\": 0,\n  \"companyName\": \"\",\n  \"lastTrackDate\": \"\",\n  \"active\": false,\n  \"password\": \"\",\n  \"phoneNumber\": \"\",\n  \"busy\": false,\n  \"cpf\": \"\",\n  \"name\": \"\",\n  \"id\": 0,\n  \"lastLatitude\": 0,\n  \"email\": \"\"\n}]","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/workers\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/workers","auth":"required","examples":{"codes":[{"code":"/api/v1/workers?api_key=abc123&live_mode=true&since=01/05/2016&until=15/05/2016&available=true&company_cnpj=11111111111111","name":"query","language":"text"}]},"method":"get","params":[{"default":"query","type":"string","name":"api_key","in":"query","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso"},{"_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"query"},{"_id":"572c98356f08d4190057accb","ref":"","required":false,"desc":"Primeira data do intervalo da busca","default":"query","type":"string","name":"since","in":"query"},{"in":"query","_id":"572cce1c6f08d4190057ad8b","ref":"","required":false,"desc":"Segunda data do intervalo da busca","default":"query","type":"string","name":"until"},{"ref":"","required":false,"desc":"Estado do entregador","default":"query","type":"boolean","name":"available","in":"query","_id":"572cce8e73c5671700a7b114"},{"type":"string","name":"company_cnpj","in":"query","_id":"572cce8e73c5671700a7b113","ref":"","required":false,"desc":"CNPJ de Empresa para busca","default":"query"}]},"category":"572cbbcc6f08d4190057ad44","editedParams2":true,"githubsync":"","link_external":false,"project":"552ed3282594f70d001b2d69","createdAt":"2016-05-06T17:01:12.618Z","hidden":false,"link_url":"","slug":"apiv1workers","sync_unique":"","title":"/api/v1/workers","user":"5720e5627e91d00e00804eed","childrenPages":[]}

get/api/v1/workers

Listar

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
since:
stringquery
Primeira data do intervalo da busca
until:
stringquery
Segunda data do intervalo da busca
available:
booleanquery
Estado do entregador
company_cnpj:
stringquery
CNPJ de Empresa para busca
Busca uma lista de entregadores dado um intervalo de tempo

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca uma lista de entregadores dado um intervalo de tempo
{"_id":"572ccecf73c5671700a7b117","title":"/api/v1/workers/{id}","sync_unique":"","body":"Edita um entregador","githubsync":"","link_url":"","order":2,"parentDoc":null,"slug":"apiv1workersid","user":"5720e5627e91d00e00804eed","__v":1,"version":"552ed3282594f70d001b2d6d","api":{"settings":"","url":"/api/v1/workers/{id}","auth":"required","examples":{"codes":[{"name":"query","language":"text","code":"/api/v1/workers/1?api_key=abc123&live_mode=true"},{"name":"body","language":"text","code":"{\n  \"visible\": false,\n  \"lastLongitude\": 0,\n  \"companyName\": \"\",\n  \"lastTrackDate\": \"\",\n  \"active\": false,\n  \"password\": \"\",\n  \"phoneNumber\": \"\",\n  \"busy\": false,\n  \"cpf\": \"\",\n  \"name\": \"\",\n  \"id\": 0,\n  \"lastLatitude\": 0,\n  \"email\": \"\"\n}"}]},"method":"put","params":[{"type":"string","name":"api_key","in":"body","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query"},{"required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean","name":"live_mode","in":"body","_id":"572c98356f08d4190057acca","ref":""},{"desc":"Identificador Rapiddo do entregador","default":"path","type":"int","name":"id","in":"path","_id":"572c98356f08d4190057accb","ref":"","required":true},{"ref":"","required":false,"desc":"Objeto Worker","default":"body","type":"object","name":"apiWorker","in":"body","_id":"572ccf1c5c03ec290060a4c7"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"visible\": false,\n  \"lastLongitude\": 0,\n  \"companyName\": \"\",\n  \"lastTrackDate\": \"\",\n  \"active\": false,\n  \"password\": \"\",\n  \"phoneNumber\": \"\",\n  \"busy\": false,\n  \"cpf\": \"\",\n  \"name\": \"\",\n  \"id\": 0,\n  \"lastLatitude\": 0,\n  \"email\": \"\"\n}"},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/workers/{id}\",\n  \"method\": \"PUT\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]}},"editedParams2":true,"isReference":false,"link_external":false,"updates":[],"createdAt":"2016-05-06T17:05:19.158Z","editedParams":true,"excerpt":"Edição","hidden":false,"project":"552ed3282594f70d001b2d69","type":"put","category":"572cbbcc6f08d4190057ad44","childrenPages":[]}

put/api/v1/workers/{id}

Edição

Path Params

id:
required
integerpath
Identificador Rapiddo do entregador

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
apiWorker:
objectbody
Objeto Worker
Edita um entregador

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Edita um entregador
{"_id":"572ccfd141ad002d00ddc6fc","isReference":false,"link_external":false,"__v":1,"body":"Busca um entregador a partir de seu identificador","category":"572cbbcc6f08d4190057ad44","editedParams":true,"githubsync":"","parentDoc":null,"updates":[],"user":"5720e5627e91d00e00804eed","excerpt":"Vizualizar","hidden":false,"project":"552ed3282594f70d001b2d69","createdAt":"2016-05-06T17:09:37.040Z","editedParams2":true,"link_url":"","slug":"apiv1workersid-1","type":"get","version":"552ed3282594f70d001b2d6d","api":{"settings":"","url":"/api/v1/workers/{id}","auth":"required","examples":{"codes":[{"code":"/api/v1/workers/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"get","params":[{"in":"query","_id":"572c98356f08d4190057accc","ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key"},{"name":"live_mode","in":"query","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query","type":"boolean"},{"default":"path","type":"int","name":"id","in":"path","_id":"572c98356f08d4190057accb","ref":"","required":true,"desc":"Identificador Rapiddo do entregador"}],"results":{"codes":[{"code":"{\n  \"visible\": false,\n  \"lastLongitude\": 0,\n  \"companyName\": \"\",\n  \"lastTrackDate\": \"\",\n  \"active\": false,\n  \"password\": \"\",\n  \"phoneNumber\": \"\",\n  \"busy\": false,\n  \"cpf\": \"\",\n  \"name\": \"\",\n  \"id\": 0,\n  \"lastLatitude\": 0,\n  \"email\": \"\"\n}","language":"json","status":200,"name":""},{"code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/workers/{id}\",\n  \"method\": \"GET\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}","status":400,"language":"json"}]}},"order":3,"sync_unique":"","title":"/api/v1/workers/{id}","childrenPages":[]}

get/api/v1/workers/{id}

Vizualizar

Path Params

id:
required
integerpath
Identificador Rapiddo do entregador

Query Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Busca um entregador a partir de seu identificador

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Busca um entregador a partir de seu identificador
{"_id":"572cd013eb7f451900b341cd","createdAt":"2016-05-06T17:10:43.798Z","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"552ed3282594f70d001b2d69","category":"572cbbcc6f08d4190057ad44","title":"/api/v1/workers/{id}","slug":"apiv1workersid-2","api":{"auth":"required","examples":{"codes":[{"code":"/api/v1/workers/1?api_key=abc123&live_mode=true","language":"text","name":"query"}]},"method":"delete","params":[{"ref":"","required":true,"desc":"Token de acesso","default":"query","type":"string","name":"api_key","in":"body","_id":"572c98356f08d4190057accc"},{"type":"boolean","name":"live_mode","in":"body","_id":"572c98356f08d4190057acca","ref":"","required":true,"desc":"Chaveamento entre produção e teste","default":"query"},{"required":true,"desc":"Identificador Rapiddo do entregador","default":"path","type":"int","name":"id","in":"path","_id":"572c98356f08d4190057accb","ref":""}],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"name\": \"Bad Request\",\n  \"url\": \"/api/v1/workers/{id}\",\n  \"method\": \"DELETE\",\n  \"reason\": \"\",\n  \"error_code\": \"\"\n}"}]},"settings":"","url":"/api/v1/workers/{id}"},"editedParams2":true,"isReference":false,"sync_unique":"","version":"552ed3282594f70d001b2d6d","__v":0,"editedParams":true,"excerpt":"Remover","parentDoc":null,"type":"delete","updates":[],"user":"5720e5627e91d00e00804eed","body":"Remove uma task dado o trackingId e o identificador da company","childrenPages":[]}

delete/api/v1/workers/{id}

Remover

Path Params

id:
required
integerpath
Identificador Rapiddo do entregador

Body Params

api_key:
required
stringquery
Token de acesso
live_mode:
required
booleanquery
Chaveamento entre produção e teste
Remove uma task dado o trackingId e o identificador da company

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Remove uma task dado o trackingId e o identificador da company
{"_id":"572cd12d73c5671700a7b11f","version":"552ed3282594f70d001b2d6d","category":"572cd0485c03ec290060a4ca","editedParams2":true,"hidden":false,"order":0,"slug":"hook","updates":[],"user":"5720e5627e91d00e00804eed","__v":0,"api":{"examples":{"codes":[]},"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","auth":"required","params":[{"type":"string","name":"id","in":"body","_id":"572cd12d73c5671700a7b120","ref":"","required":false,"desc":"Identificador do pedido","default":"header"}],"url":"/hook"},"editedParams":true,"isReference":false,"createdAt":"2016-05-06T17:15:25.471Z","title":"Orders","type":"basic","sync_unique":"","body":"Neste documento está descrito o passo-a-passo para cadastro de webhooks, bem como a forma que o mesmo é disparado durante a execução de um pedido.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Cadastro\"\n}\n[/block]\nPara fazer o cadastro, é necessário seguir os seguintes passos:\n1. Acesse o <a href=\"https://b2b.rapiddo.com.br\" target=\"_blank\">painel de configuração da API</a>\n2. Faça o login clicando em *Login* \n3. Vá até o item (7) e clique em **OFF** para habilitar essa funcionalidade \n4. Configure a URL e o método HTTP e clique em *Criar*\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Eventos gatilho (triggers)\"\n}\n[/block]\nQualquer mudança de status no pedido fará uma chamada ao Webhook cadastrado, passando como parâmetro o ID do pedido em questão. Por exemplo, suponhamos seguinte URL\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"URL hipotética\",\n  \"body\": \"http://sualoja.com.br/pedidos/hook?seu_parametro_1=valor\"\n}\n[/block]\nPara tal URL, qualquer atualização de status resultará em uma chamada feita para\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Webhook\",\n  \"body\": \"http://sualoja.com.br/pedidos/hook?seu_parametro_1=valor&id=PEDIDO-123\"\n}\n[/block]","excerpt":"Chamadas de retorno feitas pelo rapiddo","githubsync":"","link_external":false,"link_url":"","parentDoc":null,"project":"552ed3282594f70d001b2d69","childrenPages":[]}

Orders

Chamadas de retorno feitas pelo rapiddo

Neste documento está descrito o passo-a-passo para cadastro de webhooks, bem como a forma que o mesmo é disparado durante a execução de um pedido. [block:api-header] { "type": "basic", "title": "Cadastro" } [/block] Para fazer o cadastro, é necessário seguir os seguintes passos: 1. Acesse o <a href="https://b2b.rapiddo.com.br" target="_blank">painel de configuração da API</a> 2. Faça o login clicando em *Login* 3. Vá até o item (7) e clique em **OFF** para habilitar essa funcionalidade 4. Configure a URL e o método HTTP e clique em *Criar* [block:api-header] { "type": "basic", "title": "Eventos gatilho (triggers)" } [/block] Qualquer mudança de status no pedido fará uma chamada ao Webhook cadastrado, passando como parâmetro o ID do pedido em questão. Por exemplo, suponhamos seguinte URL [block:callout] { "type": "success", "title": "URL hipotética", "body": "http://sualoja.com.br/pedidos/hook?seu_parametro_1=valor" } [/block] Para tal URL, qualquer atualização de status resultará em uma chamada feita para [block:callout] { "type": "success", "title": "Webhook", "body": "http://sualoja.com.br/pedidos/hook?seu_parametro_1=valor&id=PEDIDO-123" } [/block]
Neste documento está descrito o passo-a-passo para cadastro de webhooks, bem como a forma que o mesmo é disparado durante a execução de um pedido. [block:api-header] { "type": "basic", "title": "Cadastro" } [/block] Para fazer o cadastro, é necessário seguir os seguintes passos: 1. Acesse o <a href="https://b2b.rapiddo.com.br" target="_blank">painel de configuração da API</a> 2. Faça o login clicando em *Login* 3. Vá até o item (7) e clique em **OFF** para habilitar essa funcionalidade 4. Configure a URL e o método HTTP e clique em *Criar* [block:api-header] { "type": "basic", "title": "Eventos gatilho (triggers)" } [/block] Qualquer mudança de status no pedido fará uma chamada ao Webhook cadastrado, passando como parâmetro o ID do pedido em questão. Por exemplo, suponhamos seguinte URL [block:callout] { "type": "success", "title": "URL hipotética", "body": "http://sualoja.com.br/pedidos/hook?seu_parametro_1=valor" } [/block] Para tal URL, qualquer atualização de status resultará em uma chamada feita para [block:callout] { "type": "success", "title": "Webhook", "body": "http://sualoja.com.br/pedidos/hook?seu_parametro_1=valor&id=PEDIDO-123" } [/block]