{"_id":"57ff943fc135231700aed83f","__v":1,"category":"56af5753b4ddab0d008c5806","excerpt":"","isReference":false,"link_external":false,"link_url":"","project":"56af5752b4ddab0d008c5802","slug":"como-funciona-a-api","body":"As APIs (Application Programming Interfaces)  e os serviços de Web operam de maneira completamente invisível para os internautas que visitam os sites e para os usuários dos softwares.\n\nElas realizam suas funções silenciosamente, nos bastidores, e permitem que aplicativos cooperem mutuamente e assim o usuário obtém as informações desejadas ou tenha acesso aos recursos desejados.\n\nAPI é como uma chave de tradução para que 2 aplicativos conversem entre si. É como um tradutor, um intérprete que ouve uma pessoa falando grego e traduz para o português para que você entenda suas instruções.\n\nMas para que isso aconteça, é preciso que as empresas que desenvolveram esses aplicativos e softwares liberem suas APIs para desenvolvedores criarem novos aplicativos alimentados por eles ou integrá-los a outros aplicativos já existentes.\n\nEm outras palavras: APIs são utilizadas para que diferentes aplicativos baseados na internet conversem entre si sem a necessidade de que alguém intervenha ou tenha que desempenhar uma tarefa.\n\n##Introdução a Yebo\n\nCom base neste conceito de API anteriormente apresentado, nós da Yebo criamos uma API com todas as regras de negócio e lógica necessários para montar sua loja virtual por completo ou utilizar as mais novas ferramentas voltadas para e-commerce da forma que desejar.\n\nDesta forma só é necessário se preocupar com o desenvolvimento do front end da loja e com as vendas, deixe que nossa equipe mais do que especializada se encarrega de todo o Backoffice e de trazer as melhores e mais inovadoras ferramentas do mercado até você.\n\nO consumo de nossa API pode ser realizado de maneira simples e rápida, onde em minutos já é possível retornar todos os produtos, categorias e efetuar pedidos em uma loja. Além da possibilidade de utilizar os mais novos e performáticos frameworks Js para realizar este processo. A implementação de sua loja pode ser feita em Angular.js, Ember.js, BackBone.js até mesmo em Jquery ou Javascript puro, esses são apenas alguns exemplos já utilizados no desenvolvimento de lojas usando nossa API.\n\n##Painel de controle Yebo\n\nComo se já não bastasse uma API robusta e maleável, a Yebo ainda conta com um completo painel administrativo, onde todas os itens da loja podem ser facilmente cadastrados, editados e excluídos.\n\nAtravés do painel pode gerenciar seus pedidos, produtos, banners, promoções, cupons de descontos, taxons e taxonomys e muitos outros itens, deixando o cliente com autonomia total para fazer o que desejar.\n\nEste painel está constantemente passando por atualizações de usabilidade, para que sempre possamos entregar a melhor experiência aos usuários do mesmo.\n\n##GitHub Yebo\n\nPara facilitar a vida de nossos desenvolvedores e parceiros, nós disponibilizamos nosso Github de forma colaborativa e com conteúdos diversificados, indo desde a nossa SDK até exemplos simples de implementações de lojas, realizadas por nós e por nossos parceiros.\n\nCom este conteúdo que disponibilizamos fica muito mais fácil e ágil desenvolver sua loja da forma como gostaria, tendo de se preocupar apenas com o desenvolvimento do front end.\n\nhttps://github.com/yebo-ecommerce","githubsync":"","next":{"description":"","pages":[]},"order":0,"type":"basic","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","createdAt":"2016-10-13T14:03:43.867Z","hidden":false,"api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"parentDoc":null,"sync_unique":"","title":"Como funciona a API Yebo","updates":[],"childrenPages":[]}

Como funciona a API Yebo


As APIs (Application Programming Interfaces) e os serviços de Web operam de maneira completamente invisível para os internautas que visitam os sites e para os usuários dos softwares. Elas realizam suas funções silenciosamente, nos bastidores, e permitem que aplicativos cooperem mutuamente e assim o usuário obtém as informações desejadas ou tenha acesso aos recursos desejados. API é como uma chave de tradução para que 2 aplicativos conversem entre si. É como um tradutor, um intérprete que ouve uma pessoa falando grego e traduz para o português para que você entenda suas instruções. Mas para que isso aconteça, é preciso que as empresas que desenvolveram esses aplicativos e softwares liberem suas APIs para desenvolvedores criarem novos aplicativos alimentados por eles ou integrá-los a outros aplicativos já existentes. Em outras palavras: APIs são utilizadas para que diferentes aplicativos baseados na internet conversem entre si sem a necessidade de que alguém intervenha ou tenha que desempenhar uma tarefa. ##Introdução a Yebo Com base neste conceito de API anteriormente apresentado, nós da Yebo criamos uma API com todas as regras de negócio e lógica necessários para montar sua loja virtual por completo ou utilizar as mais novas ferramentas voltadas para e-commerce da forma que desejar. Desta forma só é necessário se preocupar com o desenvolvimento do front end da loja e com as vendas, deixe que nossa equipe mais do que especializada se encarrega de todo o Backoffice e de trazer as melhores e mais inovadoras ferramentas do mercado até você. O consumo de nossa API pode ser realizado de maneira simples e rápida, onde em minutos já é possível retornar todos os produtos, categorias e efetuar pedidos em uma loja. Além da possibilidade de utilizar os mais novos e performáticos frameworks Js para realizar este processo. A implementação de sua loja pode ser feita em Angular.js, Ember.js, BackBone.js até mesmo em Jquery ou Javascript puro, esses são apenas alguns exemplos já utilizados no desenvolvimento de lojas usando nossa API. ##Painel de controle Yebo Como se já não bastasse uma API robusta e maleável, a Yebo ainda conta com um completo painel administrativo, onde todas os itens da loja podem ser facilmente cadastrados, editados e excluídos. Através do painel pode gerenciar seus pedidos, produtos, banners, promoções, cupons de descontos, taxons e taxonomys e muitos outros itens, deixando o cliente com autonomia total para fazer o que desejar. Este painel está constantemente passando por atualizações de usabilidade, para que sempre possamos entregar a melhor experiência aos usuários do mesmo. ##GitHub Yebo Para facilitar a vida de nossos desenvolvedores e parceiros, nós disponibilizamos nosso Github de forma colaborativa e com conteúdos diversificados, indo desde a nossa SDK até exemplos simples de implementações de lojas, realizadas por nós e por nossos parceiros. Com este conteúdo que disponibilizamos fica muito mais fácil e ágil desenvolver sua loja da forma como gostaria, tendo de se preocupar apenas com o desenvolvimento do front end. https://github.com/yebo-ecommerce
As APIs (Application Programming Interfaces) e os serviços de Web operam de maneira completamente invisível para os internautas que visitam os sites e para os usuários dos softwares. Elas realizam suas funções silenciosamente, nos bastidores, e permitem que aplicativos cooperem mutuamente e assim o usuário obtém as informações desejadas ou tenha acesso aos recursos desejados. API é como uma chave de tradução para que 2 aplicativos conversem entre si. É como um tradutor, um intérprete que ouve uma pessoa falando grego e traduz para o português para que você entenda suas instruções. Mas para que isso aconteça, é preciso que as empresas que desenvolveram esses aplicativos e softwares liberem suas APIs para desenvolvedores criarem novos aplicativos alimentados por eles ou integrá-los a outros aplicativos já existentes. Em outras palavras: APIs são utilizadas para que diferentes aplicativos baseados na internet conversem entre si sem a necessidade de que alguém intervenha ou tenha que desempenhar uma tarefa. ##Introdução a Yebo Com base neste conceito de API anteriormente apresentado, nós da Yebo criamos uma API com todas as regras de negócio e lógica necessários para montar sua loja virtual por completo ou utilizar as mais novas ferramentas voltadas para e-commerce da forma que desejar. Desta forma só é necessário se preocupar com o desenvolvimento do front end da loja e com as vendas, deixe que nossa equipe mais do que especializada se encarrega de todo o Backoffice e de trazer as melhores e mais inovadoras ferramentas do mercado até você. O consumo de nossa API pode ser realizado de maneira simples e rápida, onde em minutos já é possível retornar todos os produtos, categorias e efetuar pedidos em uma loja. Além da possibilidade de utilizar os mais novos e performáticos frameworks Js para realizar este processo. A implementação de sua loja pode ser feita em Angular.js, Ember.js, BackBone.js até mesmo em Jquery ou Javascript puro, esses são apenas alguns exemplos já utilizados no desenvolvimento de lojas usando nossa API. ##Painel de controle Yebo Como se já não bastasse uma API robusta e maleável, a Yebo ainda conta com um completo painel administrativo, onde todas os itens da loja podem ser facilmente cadastrados, editados e excluídos. Através do painel pode gerenciar seus pedidos, produtos, banners, promoções, cupons de descontos, taxons e taxonomys e muitos outros itens, deixando o cliente com autonomia total para fazer o que desejar. Este painel está constantemente passando por atualizações de usabilidade, para que sempre possamos entregar a melhor experiência aos usuários do mesmo. ##GitHub Yebo Para facilitar a vida de nossos desenvolvedores e parceiros, nós disponibilizamos nosso Github de forma colaborativa e com conteúdos diversificados, indo desde a nossa SDK até exemplos simples de implementações de lojas, realizadas por nós e por nossos parceiros. Com este conteúdo que disponibilizamos fica muito mais fácil e ágil desenvolver sua loja da forma como gostaria, tendo de se preocupar apenas com o desenvolvimento do front end. https://github.com/yebo-ecommerce
{"_id":"58123ffc8ec81a23009796a8","user":"56af52dabc304a0d00ace11e","__v":0,"githubsync":"","link_url":"","slug":"autenticação-e-conexão-com-a-yebo","body":"Nossa API trabalha utilizando o conceito de Token em seu processo de validação, neste processo a  loja envia uma requisição à API com uma chave exclusiva de um usuário administrador com acesso aos dados daquela loja, para esta requisição é enviada uma resposta com um Token exclusivo que vai ser utilizado pelas próximas 4 horas em toda a comunicação entre loja e API. Após o período de 4 horas é necessário que uma nova requisição de Token para que o mesmo seja re gerado e a comunicação possa continuar a ser realizada.\n\nA geração da chave de usuário pode ser realizada por dentro do painel de controle da loja, seguindo o seguinte caminho: Painel de controle>> Menu Lateral Esquerdo>> Usuários>> Administradores>> Clique sobre qual usuário vai ser responsável pela conexão com a API>> Clique em Gerar gerar um nova chave.\n\nAgora basta copiar o valor exibido em “CHAVE DE ACESSO”","next":{"pages":[],"description":""},"type":"basic","updates":[],"link_external":false,"order":1,"parentDoc":null,"project":"56af5752b4ddab0d008c5802","category":"56af5753b4ddab0d008c5806","createdAt":"2016-10-27T17:57:16.896Z","excerpt":"","hidden":false,"version":"56af5752b4ddab0d008c5805","title":"Autenticação e conexão com a Yebo","api":{"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[]},"isReference":false,"sync_unique":"","childrenPages":[]}

Autenticação e conexão com a Yebo


Nossa API trabalha utilizando o conceito de Token em seu processo de validação, neste processo a loja envia uma requisição à API com uma chave exclusiva de um usuário administrador com acesso aos dados daquela loja, para esta requisição é enviada uma resposta com um Token exclusivo que vai ser utilizado pelas próximas 4 horas em toda a comunicação entre loja e API. Após o período de 4 horas é necessário que uma nova requisição de Token para que o mesmo seja re gerado e a comunicação possa continuar a ser realizada. A geração da chave de usuário pode ser realizada por dentro do painel de controle da loja, seguindo o seguinte caminho: Painel de controle>> Menu Lateral Esquerdo>> Usuários>> Administradores>> Clique sobre qual usuário vai ser responsável pela conexão com a API>> Clique em Gerar gerar um nova chave. Agora basta copiar o valor exibido em “CHAVE DE ACESSO”
Nossa API trabalha utilizando o conceito de Token em seu processo de validação, neste processo a loja envia uma requisição à API com uma chave exclusiva de um usuário administrador com acesso aos dados daquela loja, para esta requisição é enviada uma resposta com um Token exclusivo que vai ser utilizado pelas próximas 4 horas em toda a comunicação entre loja e API. Após o período de 4 horas é necessário que uma nova requisição de Token para que o mesmo seja re gerado e a comunicação possa continuar a ser realizada. A geração da chave de usuário pode ser realizada por dentro do painel de controle da loja, seguindo o seguinte caminho: Painel de controle>> Menu Lateral Esquerdo>> Usuários>> Administradores>> Clique sobre qual usuário vai ser responsável pela conexão com a API>> Clique em Gerar gerar um nova chave. Agora basta copiar o valor exibido em “CHAVE DE ACESSO”
{"_id":"56af5754b4ddab0d008c5808","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","params":[]},"body":"## Conectando com o Yebo\n\nA seguir temos um tutorial, mostrando o quanto é simples conectar em nossa API. Para este tutorial utilizamos o pacote YeboSDK, que é uma SDK desenvolvida para facilitar a vida dos desenvolvedores Yebo.\n\nEsta SDK pode ser localizada em nosso Github através do link \"https://github.com/yebo-ecommerce/js-sdk\"\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Define a versão da API utilizada\\nYeboSDK.Config.set('store:api:version', 'v2');\\n\\n// ... e a URL da loja no Yebo\\nYeboSDK.Config.set('store:url', 'http://seudominio.com.br/api');\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","hidden":false,"isReference":false,"slug":"getting-started","updates":[],"__v":6,"order":2,"type":"basic","excerpt":"","link_external":false,"next":{"description":"","pages":[]},"parentDoc":null,"version":"56af5752b4ddab0d008c5805","category":"56af5753b4ddab0d008c5806","createdAt":"2016-02-01T13:02:12.288Z","githubsync":"","link_url":"","project":"56af5752b4ddab0d008c5802","sync_unique":"","title":"Primeiros passos para conectar com a Yebo","user":"56af52dabc304a0d00ace11e","childrenPages":[]}

Primeiros passos para conectar com a Yebo


## Conectando com o Yebo A seguir temos um tutorial, mostrando o quanto é simples conectar em nossa API. Para este tutorial utilizamos o pacote YeboSDK, que é uma SDK desenvolvida para facilitar a vida dos desenvolvedores Yebo. Esta SDK pode ser localizada em nosso Github através do link "https://github.com/yebo-ecommerce/js-sdk" [block:code] { "codes": [ { "code": "// Define a versão da API utilizada\nYeboSDK.Config.set('store:api:version', 'v2');\n\n// ... e a URL da loja no Yebo\nYeboSDK.Config.set('store:url', 'http://seudominio.com.br/api');", "language": "javascript" } ] } [/block]
## Conectando com o Yebo A seguir temos um tutorial, mostrando o quanto é simples conectar em nossa API. Para este tutorial utilizamos o pacote YeboSDK, que é uma SDK desenvolvida para facilitar a vida dos desenvolvedores Yebo. Esta SDK pode ser localizada em nosso Github através do link "https://github.com/yebo-ecommerce/js-sdk" [block:code] { "codes": [ { "code": "// Define a versão da API utilizada\nYeboSDK.Config.set('store:api:version', 'v2');\n\n// ... e a URL da loja no Yebo\nYeboSDK.Config.set('store:url', 'http://seudominio.com.br/api');", "language": "javascript" } ] } [/block]
{"_id":"56b3508940438c190000474c","link_external":false,"link_url":"","next":{"description":"","pages":[]},"slug":"products","hidden":false,"githubsync":"","updates":[],"category":"56af81bcbc304a0d00ace179","createdAt":"2016-02-04T13:22:17.928Z","project":"56af5752b4ddab0d008c5802","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","api":{"results":{"codes":[{"name":"","code":"{\n  \"products\":[\n    {\n      \"id\":1,\n      \"name\":\"Primeiro Produto\",\n      \"description\":\"...\",\n      \"slug\":\"primeiro-produto\",\n      \"total_on_hand\":3000,\n      \"available\":true,\n      \"filters\":[],\n      \"breadcrumbs\":[\n        {\n          \"name\":\"Lançamentos\",\n          \"permalink\":\"lancamentos\"\n        },\n        {\n          \"name\":\"Home\",\n          \"permalink\":\"lancamentos/home\"\n        },\n        {\n          \"name\":\"Primeiro Produto\",\n          \"permalink\":\"primeiro-produto\"\n        }\n      ],\n      \"meta_description\":\"...\",\n      \"meta_keywords\":\"\",\n      \"meta_title\":null,\n      \"price\":16.0,\n      \"raw_price\":16.0,\n      \"cost_price\":\"R$17,00\",\n      \"raw_cost_price\":17.0,\n      \"discount_price\":\"R$0,00\",\n      \"raw_discount_price\":0.0,\n      \"installments\":12,\n      \"installment_value\":\"R$0,00\",\n      \"raw_installment_value\":0.0,\n      \"has_installments\":true,\n      \"installments\":[  \n        {  \n          \"name\":\"Cartão de crédito\",\n          \"installments\":{  \n            \"1\":{  \n              \"tax\":false,\n              \"raw\":12.0,\n              \"display\":\"R$12,00\"\n            },\n            \"2\":{  \n              \"tax\":false,\n              \"raw\":6.0,\n              \"display\":\"R$6,00\"\n            }\n          }\n        }\n      ],\n      \"discounts\":[\n        {\n          \"name\":\"Boleto\",\n          \"raw\":14.0,\n          \"display\":\"R$14,00\"\n        }\n      ],\n      \"product_property_ids\":[1],\n      \"variants_including_master_ids\":[6],\n      \"taxon_ids\":[4, 5],\n      \"image_ids\":[34]\n    },\n    // ...\n  ],\n  \"images\":[\n    {\n      \"id\":34,\n      \"position\":1,\n      \"attachment_content_type\":\"image/png\",\n      \"attachment_file_name\":\"primeiro_produto.png\",\n      \"attachment_updated_at\":\"2015-05-18T14:37:26.809-03:00\",\n      \"attachment_width\":null,\n      \"attachment_height\":null,\n      \"alt\":null,\n      \"viewable_id\":6,\n      \"viewable_type\": \"Spree::Variant\",\n      \"mini_url\":\"...\",\n      \"small_url\":\"...\",\n      \"product_url\":\"...\",\n      \"large_url\":\"...\"\n    },\n    // ...\n  ],\n  \"variants\":[\n    {\n      \"id\":6,\n      \"name\":\"Primeiro Produto\",\n      \"sku\":\"PRI-00001\",\n      \"weight\":\"0.0\",\n      \"height\":null,\n      \"width\":null,\n      \"depth\":null,\n      \"is_master\":true,\n      \"slug\":\"primeiro-produto\",\n      \"description\":\"...\",\n      \"track_inventory\":true,\n      \"options_text\":\"\",\n      \"can_supply\":false,\n      \"price\":\"R$16,00\",\n      \"raw_price\":16.0,\n      \"cost_price\":\"R$17,00\",\n      \"raw_cost_price\":17.0,\n      \"discount_price\":\"R$0,00\",\n      \"raw_discount_price\":0.0,\n      \"installments\":12,\n      \"installment_value\":\"R$0,00\",\n      \"raw_installment_value\":0.0,\n      \"has_installments\":true,\n      \"image_ids\":[34],\n      \"discounts\": [],\n      \"option_value_ids\": [ ],\n      \"option_types_ids\": [ ],\n      \"installments\": [\n        { \"name\": \"Cartão de credito\",\n          \"installments\":\n            { \"1\": {\n              \"tax\": false,\n              \"raw\": 16.00,\n              \"display\": \"R$16,00\",\n            \t}\n         \t\t} \n    \t\t\t},\n    \t\t\t// ...\n  \t\t\t]\t\n    \t},\n    \t// ...\n  \t],\n  \"taxons\":[\n    {\n      \"id\":5,\n      \"name\":\"Home\",\n      \n      \"pretty_name\":\"Lançamentos -\\u003e Home\",\n      \"permalink\":\"lancamentos/home\",\n      \"parent_id\":27,\n      \"taxonomy_id\":8,\n      \"description\":null,\n      \"breadcrumbs\":[\n        {\n          \"name\":\"Lançamentos\",\n          \"permalink\":\"lancamentos\"\n        },\n        {\n          \"name\":\"home\",\n          \"permalink\":\"lancamentos/home\"\n        }\n      ],\n      \"icon_url\":null,\n      \"icon_normal_url\":null,\n      \"icon_mini_url\":null,\n      \"child_ids\":[]\n    },\n    //...\n  ],\n  \"product_properties\":[\n    {\n      \"id\":1,\n      \"product_id\":3,\n      \"value\":\"Valor da propriedade\",\n      \"property_name\":\"proriedade-1\",\n      \"presentation\":\"Propriedade 1\",\n      \"position\":1,\n      \"created_at\":\"2017-01-23T18:21:09.938-02:00\",\n      \"updated_at\": \"2017-01-23T18:21:09.938-02:00\"\n\n    },\n    //...\n  ],\n  \"meta\":{\n    \"total_pages\":1,\n    \"total_count\":4,\n    \"current_page\":1\n  }\n}","language":"json","status":200}]},"settings":"","url":"/v:version/products","auth":"required","examples":{"codes":[{"language":"javascript","code":"// Define regra da busca, nesse caso sera categoria\nvar taxonomyRule = YeboSDK.Products.Rules.(['mais-vendidos/home']);\n\n// Adicionando um filtro\nvar colorFilter = YeboSDK.Products.Rules.filter('cor', ['azul', 'amarelo']);\n\n// Criando um nova Query no Yebo\nvar query = new YeboSDK.Products();\n\n// Adicionando as regras na query\nquery.and(taxonomyRule, colorFilter);\n\n// Definindo quantidade por pagina\nquery.perPage(50);\n\n// Executando Query\nquery.execute().then(function(res) {\n  // ...\n});"}]},"method":"get","params":[{"required":false,"type":"object","_id":"56b351f940438c1900004753","default":"","desc":"Parametros utilizados na busca de produtos","in":"query","name":"search","ref":""},{"name":"search[name]","ref":"","required":false,"type":"string","_id":"56b351f940438c1900004752","default":"","desc":"Busca por nome de produtos","in":"query"},{"_id":"56b351f940438c1900004751","default":"1","desc":"Número da pagina da listagem de produtos","in":"query","name":"search[page]","ref":"","required":false,"type":"int"},{"type":"int","_id":"56b351f940438c1900004750","default":"10","desc":"Quantidade de produtos por página","in":"query","name":"search[per_page]","ref":"","required":false},{"required":false,"type":"object","_id":"56b35286023ef30d009b2b53","default":"","desc":"Filtros avançados para a busca","in":"query","name":"search[filters]","ref":""},{"in":"query","name":"search[filters][and]","ref":"","required":false,"type":"array_object","_id":"56b35286023ef30d009b2b52","default":"","desc":"Filtros que tem relação `e`"},{"required":false,"type":"array_object","_id":"56b35286023ef30d009b2b51","default":"","desc":"Filtros que tem relação `ou`","in":"query","name":"search[filters][or]","ref":""},{"name":"search[filters][and/or][][name]","ref":"","required":true,"type":"string","_id":"56b3540c78a12121009006b2","default":"","desc":"Nome do filtro","in":"query"},{"_id":"56b3540c78a12121009006b1","default":"","desc":"Valores do filtro","in":"query","name":"search[filters][and/or][][values]","ref":"","required":true,"type":"array_string"},{"_id":"56b354a005daaa2300363169","default":"","desc":"Campo do filtro","in":"query","name":"search[filters][and/or][][field]","ref":"","required":false,"type":"string"},{"_id":"56b354a005daaa2300363168","default":"fixed","desc":"Tipo do filtro","in":"query","name":"search[filters][and/or][][type]","ref":"","required":false,"type":"string"},{"_id":"56b354a005daaa2300363167","default":"and","desc":"Condição entre os valores do filtro, `and` ou `or`.","in":"query","name":"search[filters][and/or][][execution]","ref":"","required":false,"type":"string"}]},"body":"A Yebo tem um cadastro de produtos completo, porém poucos campos são obrigatórios deixando o cadastro mais simples e ágil. Neste endpoint é possível obter todos os dados dos produtos de sua loja.\nPensando em uma maior maleabilidade das informações retornadas, disponibilizamos diversos tipos de filtros diferentes, assim terá as informações somente dos produtos que realmente deseja.","editedParams2":true,"excerpt":"","isReference":false,"order":0,"parentDoc":null,"sync_unique":"","__v":6,"editedParams":true,"title":"/products","type":"get","childrenPages":[]}

get/products


Query Params

search:
object
Parametros utilizados na busca de produtos
search[name]:
string
Busca por nome de produtos
search[page]:
integer1
Número da pagina da listagem de produtos
search[per_page]:
integer10
Quantidade de produtos por página
search[filters]:
object
Filtros avançados para a busca
search[filters][and]:
array of objects
Filtros que tem relação `e`
search[filters][or]:
array of objects
Filtros que tem relação `ou`
search[filters][and/or][][name]:
required
string
Nome do filtro
search[filters][and/or][][values]:
required
array of strings
Valores do filtro
search[filters][and/or][][field]:
string
Campo do filtro
search[filters][and/or][][type]:
stringfixed
Tipo do filtro
search[filters][and/or][][execution]:
stringand
Condição entre os valores do filtro, `and` ou `or`.
A Yebo tem um cadastro de produtos completo, porém poucos campos são obrigatórios deixando o cadastro mais simples e ágil. Neste endpoint é possível obter todos os dados dos produtos de sua loja. Pensando em uma maior maleabilidade das informações retornadas, disponibilizamos diversos tipos de filtros diferentes, assim terá as informações somente dos produtos que realmente deseja.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



A Yebo tem um cadastro de produtos completo, porém poucos campos são obrigatórios deixando o cadastro mais simples e ágil. Neste endpoint é possível obter todos os dados dos produtos de sua loja. Pensando em uma maior maleabilidade das informações retornadas, disponibilizamos diversos tipos de filtros diferentes, assim terá as informações somente dos produtos que realmente deseja.
{"_id":"56b37d800fb3582100572f4a","order":1,"project":"56af5752b4ddab0d008c5802","body":"`Aggregations` é o nome dado ao agrupamento dos filtros. Geralmente é utilizada para montar o `selects` dos filtros de busca em uma listagem de produtos.","editedParams":true,"githubsync":"","link_url":"","type":"get","updates":[],"version":"56af5752b4ddab0d008c5805","createdAt":"2016-02-04T16:34:08.341Z","hidden":false,"slug":"productsaggs","sync_unique":"","title":"/products/aggs","__v":3,"editedParams2":true,"link_external":false,"parentDoc":null,"user":"56af52dabc304a0d00ace11e","api":{"method":"get","params":[{"type":"string","name":"root","in":"query","_id":"56b3806b0e4c450d00699cf4","required":false,"desc":"Categoria base utilizado no agrupamento de categorias","default":"","ref":""},{"_id":"56b3806b0e4c450d00699cf3","required":false,"desc":"Range de preços","default":"","type":"array_object","name":"ranges","in":"query","ref":""},{"_id":"56b3806b0e4c450d00699cf1","required":true,"desc":"Preço inicial","default":"","type":"string","name":"ranges[][from]","in":"query","ref":""},{"_id":"56b3806b0e4c450d00699cf2","required":true,"desc":"Preço final","default":"","type":"int","name":"ranges[][to]","in":"query","ref":""},{"_id":"56b351f940438c1900004753","required":false,"desc":"Parametros utilizados na busca de produtos","default":"","type":"object","name":"search","in":"query","ref":""},{"in":"query","_id":"56b351f940438c1900004752","required":false,"desc":"Busca por nome de produtos","default":"","type":"string","name":"search[name]","ref":""},{"default":"1","type":"int","name":"search[page]","in":"query","_id":"56b351f940438c1900004751","required":false,"desc":"Número da pagina da listagem de produtos","ref":""},{"required":false,"desc":"Quantidade de produtos por página","default":"10","type":"int","name":"search[per_page]","in":"query","_id":"56b351f940438c1900004750","ref":""},{"desc":"Filtros avançados para a busca","default":"","type":"object","name":"search[filters]","in":"query","_id":"56b35286023ef30d009b2b53","required":false,"ref":""},{"default":"","type":"array_object","name":"search[filters][and]","in":"query","_id":"56b35286023ef30d009b2b52","required":false,"desc":"Filtros que tem relação `e`","ref":""},{"in":"query","_id":"56b35286023ef30d009b2b51","required":false,"desc":"Filtros que tem relação `ou`","default":"","type":"array_object","name":"search[filters][or]","ref":""},{"type":"string","name":"search[filters][and/or][][name]","in":"query","_id":"56b3540c78a12121009006b2","required":true,"desc":"Nome do filtro","default":"","ref":""},{"_id":"56b3540c78a12121009006b1","required":true,"desc":"Valores do filtro","default":"","type":"array_string","name":"search[filters][and/or][][values]","in":"query","ref":""},{"required":false,"desc":"Campo do filtro","default":"","type":"string","name":"search[filters][and/or][][field]","in":"query","_id":"56b354a005daaa2300363169","ref":""},{"desc":"Tipo do filtro","default":"fixed","type":"string","name":"search[filters][and/or][][type]","in":"query","_id":"56b354a005daaa2300363168","required":false,"ref":""},{"default":"and","type":"string","name":"search[filters][and/or][][execution]","in":"query","_id":"56b354a005daaa2300363167","required":false,"desc":"Condição entre os valores do filtro, `and` ou `or`.","ref":""}],"results":{"codes":[{"code":"{\n\t\"filters\":[\n    {\n      \"id\": 2,\n      \"name\": \"Filtro\",\n      \"presentation\": \"Filtro\",\n      \"count\": 5,\n      \"values\": [\n         {\n           \"id\": 1,\n           \"value\": \"Valor 1\",\n           \"presentation\": \"Filtro 1\",\n           \"count\": 2\n         },\n         {\n           \"id\": 2,\n           \"value\": \"Valor 2\",\n           \"presentation\": \"Filtro 2\",\n           \"count\": 1 },\n         {\n           \"id\": 3,\n           \"value\": \"Valor 3\",\n           \"presentation\": \"Filtro 3\",\n           \"count\": 2\n         }\n      ]\n    }\n\t],\n  \"prices\":[\n    {\n      \"to\":30.00,\n      \"count\":5\n    },\n    {\n      \"to\":60.00,\n      \"from\":31.00,\n      \"count\":0\n    },\n    {\n      \"from\":61.0,\n      \"count\":15\n    }\n  ],\n  \"filters\":[\n\n  ],\n  \"taxons\":[\n    {\n      \"id\":5,\n      \"name\":\"Marcas\",\n      \"permalink\":\"marcas\",\n      \"count\":10\n    },\n    {\n      \"id\":6,\n      \"name\":\"Primeira Marca\",\n      \"permalink\":\"marcas/primeira-marca\",\n      \"count\":5\n    },\n    {\n      \"id\":7,\n      \"name\":\"Segunda Marca\",\n      \"permalink\":\"marcas/segunda-marca\",\n      \"count\":5\n    }\n  ]\n}","name":"","status":200,"language":"json"}]},"settings":"","url":"/v:version/products/aggs","auth":"required","examples":{"codes":[{"code":"// Query, previamente definida\n// var query = ...\n\n// Opções das aggregations\nvar options = {\n  root: 'marcas',\n  ranges: [\n    { from: 0, to: 30 },    // Entre R$0 e R$30\n    { from: 31, to: 60 },   // Entre R$31 e R$60\n    { from: 61, to: null }, // Apartir de R$61\n  ]\n};\n\n// Aggregations\nquery.aggs(options).then(function(res) {\n  // ...\n});","language":"javascript"}]}},"category":"56af81bcbc304a0d00ace179","excerpt":"","isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

get/products/aggs


Query Params

root:
string
Categoria base utilizado no agrupamento de categorias
ranges:
array of objects
Range de preços
ranges[][from]:
required
string
Preço inicial
ranges[][to]:
required
integer
Preço final
search:
object
Parametros utilizados na busca de produtos
search[name]:
string
Busca por nome de produtos
search[page]:
integer1
Número da pagina da listagem de produtos
search[per_page]:
integer10
Quantidade de produtos por página
search[filters]:
object
Filtros avançados para a busca
search[filters][and]:
array of objects
Filtros que tem relação `e`
search[filters][or]:
array of objects
Filtros que tem relação `ou`
search[filters][and/or][][name]:
required
string
Nome do filtro
search[filters][and/or][][values]:
required
array of strings
Valores do filtro
search[filters][and/or][][field]:
string
Campo do filtro
search[filters][and/or][][type]:
stringfixed
Tipo do filtro
search[filters][and/or][][execution]:
stringand
Condição entre os valores do filtro, `and` ou `or`.
`Aggregations` é o nome dado ao agrupamento dos filtros. Geralmente é utilizada para montar o `selects` dos filtros de busca em uma listagem de produtos.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



`Aggregations` é o nome dado ao agrupamento dos filtros. Geralmente é utilizada para montar o `selects` dos filtros de busca em uma listagem de produtos.
{"_id":"56b383687c04042100b61377","editedParams":true,"hidden":false,"order":2,"title":"/products/:id","type":"get","version":"56af5752b4ddab0d008c5805","api":{"settings":"","url":"/v:version/products/:id","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\nYeboSDK.Store.fetch('products/' + id).then(function(res) {\n  // ...\n});"}]},"method":"get","params":[{"type":"int","_id":"56b351f940438c1900004753","default":"","desc":"ID do produto","in":"path","name":"id","ref":"","required":false}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"product\":{\n    \"id\":1,\n    \"name\":\"Primeiro Produto\",\n    \"description\":\"...\",\n    \"slug\":\"primeiro-produto\",\n    \"total_on_hand\":3000,\n    \"available\":true,\n    \"breadcrumbs\":[\n      {\n        \"name\":\"Lançamentos\",\n        \"permalink\":\"lancamentos\"\n      },\n      {\n        \"name\":\"Home\",\n          \"permalink\":\"lancamentos/home\"\n      },\n      {\n        \"name\":\"Primeiro Produto\",\n        \"permalink\":\"primeiro-produto\"\n      }\n    ],\n    \"meta_description\":\"...\",\n    \"meta_keywords\":\"\",\n    \"meta_title\":null,\n    \"price\":16.0,\n    \"raw_price\":16.0,\n    \"cost_price\":\"R$17,00\",\n    \"raw_cost_price\":17.0,\n    \"discount_price\":\"R$0,00\",\n    \"raw_discount_price\":0.0,\n    \"installments\":12,\n    \"installment_value\":\"R$0,00\",\n    \"raw_installment_value\":0.0,\n    \"has_installments\":true,\n    \"installments\":[  \n      {  \n        \"name\":\"Cartão de crédito\",\n        \"installments\":{  \n            \"1\":{  \n            \"tax\":false,\n            \"raw\":12.0,\n            \"display\":\"R$12,00\"\n          },\n          \"2\":{  \n            \"tax\":false,\n            \"raw\":6.0,\n            \"display\":\"R$6,00\"\n          }\n        }\n      }\n    ],\n    \"discounts\":[\n      {\n        \"name\":\"Boleto\",\n        \"raw\":14.0,\n        \"display\":\"R$14,00\"\n      }\n    ],\n    \"product_property_ids\":[1],\n    \"variants_including_master_ids\":[6],\n    \"taxon_ids\":[4, 5],\n    \"image_ids\":[34]\n  },\n  \"images\":[\n    {\n      \"id\":34,\n      \"position\":1,\n      \"attachment_content_type\":\"image/png\",\n      \"attachment_file_name\":\"primeiro_produto.png\",\n      \"attachment_updated_at\":\"2015-05-18T14:37:26.809-03:00\",\n      \"attachment_width\":null,\n      \"attachment_height\":null,\n      \"alt\":null,\n      \"viewable_id\":6,\n      \"viewable_type\":\"Spree::Variant\",\n      \"mini_url\":\"...\",\n      \"small_url\":\"...\",\n      \"product_url\":\"...\",\n      \"large_url\":\"...\"\n    },\n    // ...\n  ],\n  \"variants\":[\n    {\n      \"id\":6,\n      \"name\":\"Primeiro Produto\",\n      \"sku\":\"PRI-00001\",\n      \"weight\":\"0.0\",\n      \"height\":null,\n      \"width\":null,\n      \"depth\":null,\n      \"is_master\":true,\n      \"slug\":\"primeiro-produto\",\n      \"description\":\"...\",\n      \"track_inventory\":true,\n      \"options_text\":\"\",\n      \"can_supply\":false,\n      \"price\":\"R$16,00\",\n      \"raw_price\":16.0,\n      \"cost_price\":\"R$17,00\",\n      \"raw_cost_price\":17.0,\n      \"discount_price\":\"R$0,00\",\n      \"raw_discount_price\":0.0,\n      \"installments\":12,\n      \"installment_value\":\"R$0,00\",\n      \"raw_installment_value\":0.0,\n      \"has_installments\":true,\n      \"image_ids\":[34],\n      \"discounts\":[],\n      \"options_value_ids\":[],\n      \"options_types_ids\":[],\n      \"installments\":[\n        {\n          \"name\": \"Cartão de crédito\",\n          \"installments\": {\n            \"1\": {\n              \"tax\": false,\n              \"raw\": 16.00,\n              \"display\": \"R$16,00\",\n            }\n        }\n      ]\n    },\n    // ...\n  ],\n  \"taxons\":[\n    {\n      \"id\":5,\n      \"taxon_ids\":[],\n      \"name\":\"Home\",\n      \"pretty_name\":\"Lançamentos -\\u003e Home\",\n      \"permalink\":\"lancamentos/home\",\n      \"parent_id\":27,\n      \"taxonomy_id\":8,\n      \"description\":null,\n      \"breadcrumbs\":[\n        {\n          \"name\":\"Lançamentos\",\n          \"permalink\":\"lancamentos\"\n        },\n        {\n          \"name\":\"home\",\n          \"permalink\":\"lancamentos/home\"\n        }\n      ],\n      \"icon_url\":null,\n      \"icon_normal_url\":null,\n      \"icon_mini_url\":null,\n      \"child_ids\":[]\n    },\n    //...\n  ],\n  \"product_properties\":[\n    {\n      \"id\":1,\n      \"product_id\":3,\n      \"value\":\"Valor da propriedade\",\n      \"property_name\":\"proriedade-1\",\n      \"presentation\":\"Propriedade 1\"\n    },\n    //...\n  ],\n  \"meta\":{\n    \"total_pages\":1,\n    \"total_count\":4,\n    \"current_page\":1\n  }\n}","name":""}]}},"excerpt":"","link_external":false,"link_url":"","next":{"description":"","pages":[]},"parentDoc":null,"body":"Quando desejar retornar apenas um produto, bastar passar o Id do mesmo, para que apenas ele seja retornado.","createdAt":"2016-02-04T16:59:20.617Z","githubsync":"","updates":[],"user":"56af52dabc304a0d00ace11e","sync_unique":"","__v":2,"category":"56af81bcbc304a0d00ace179","editedParams2":true,"isReference":false,"project":"56af5752b4ddab0d008c5802","slug":"productsid","childrenPages":[]}

get/products/:id


Path Params

id:
integer
ID do produto
Quando desejar retornar apenas um produto, bastar passar o Id do mesmo, para que apenas ele seja retornado.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Quando desejar retornar apenas um produto, bastar passar o Id do mesmo, para que apenas ele seja retornado.
{"_id":"58174545b74dac1b000c1827","api":{"examples":{"codes":[{"language":"javascript","code":""}]},"method":"get","params":[{"desc":"Parametros utilizados na busca de produtos","default":"","type":"object","name":"search","_id":"56b351f940438c1900004753","ref":"","in":"query","required":false},{"name":"search[name]","_id":"56b351f940438c1900004752","ref":"","in":"query","required":false,"desc":"Busca por nome de produtos","default":"","type":"string"},{"ref":"","in":"query","required":false,"desc":"Número da pagina da listagem de produtos","default":"1","type":"int","name":"search[page]","_id":"56b351f940438c1900004751"},{"in":"query","required":false,"desc":"Quantidade de produtos por página","default":"10","type":"int","name":"search[per_page]","_id":"56b351f940438c1900004750","ref":""},{"desc":"Filtros avançados para a busca","default":"","type":"object","name":"search[filters]","_id":"56b35286023ef30d009b2b53","ref":"","in":"query","required":false},{"name":"search[filters][and]","_id":"56b35286023ef30d009b2b52","ref":"","in":"query","required":false,"desc":"Filtros que tem relação `e`","default":"","type":"array_object"},{"ref":"","in":"query","required":false,"desc":"Filtros que tem relação `ou`","default":"","type":"array_object","name":"search[filters][or]","_id":"56b35286023ef30d009b2b51"},{"default":"","type":"string","name":"search[filters][and/or][][name]","_id":"56b3540c78a12121009006b2","ref":"","in":"query","required":true,"desc":"Nome do filtro"},{"default":"","type":"array_string","name":"search[filters][and/or][][values]","_id":"56b3540c78a12121009006b1","ref":"","in":"query","required":true,"desc":"Valores do filtro"},{"default":"","type":"string","name":"search[filters][and/or][][field]","_id":"56b354a005daaa2300363169","ref":"","in":"query","required":false,"desc":"Campo do filtro"},{"in":"query","required":false,"desc":"Tipo do filtro","default":"fixed","type":"string","name":"search[filters][and/or][][type]","_id":"56b354a005daaa2300363168","ref":""},{"required":false,"desc":"Condição entre os valores do filtro, `and` ou `or`.","default":"and","type":"string","name":"search[filters][and/or][][execution]","_id":"56b354a005daaa2300363167","ref":"","in":"query"}],"results":{"codes":[{"code":"{\n   \"meta\":{\n      \"total_pages\":1,\n      \"total_count\":6,\n      \"current_page\":1\n   },\n   \"products\":[\n      {\n         \"id\":1,\n         \"name\":\"Produto\",\n         \"description\":\"\",\n         \"slug\":\"produto\",\n         \"total_on_hand\":0,\n         \"available\":true,\n         \"meta_description\":\"\",\n         \"meta_keywords\":\"\",\n         \"meta_title\":null,\n         \"image_ids\":[\n            1\n         ],\n         \"price\":\"R$1,00\",\n         \"raw_price\":1.0,\n         \"cost_price\":\"R$0,00\",\n         \"raw_cost_price\":0.0,\n         \"discount_price\":\"R$0,00\",\n         \"raw_discount_price\":0.0,\n         \"discounts\":[\n\n         ],\n         \"installments\":[\n            {\n               \"name\":\"Cartão de crédito\",\n               \"installments\":{\n                  \"1\":{\n                     \"tax\":false,\n                     \"raw\":1.0,\n                     \"display\":\"R$1,00\"\n                  },\n                  \"2\":{\n                     \"tax\":false,\n                     \"raw\":0.5,\n                     \"display\":\"R$0,50\"\n                  },\n                  \"3\":{\n                     \"tax\":false,\n                     \"raw\":0.33,\n                     \"display\":\"R$0,33\"\n                  },\n                  \"4\":{\n                     \"tax\":false,\n                     \"raw\":0.25,\n                     \"display\":\"R$0,25\"\n                  },\n                  \"5\":{\n                     \"tax\":false,\n                     \"raw\":0.2,\n                     \"display\":\"R$0,20\"\n                  },\n                  \"6\":{\n                     \"tax\":false,\n                     \"raw\":0.17,\n                     \"display\":\"R$0,17\"\n                  }\n               }\n            }\n         ]\n      },\n      // ...\n   ],\n   \"images\":[\n      {\n         \"id\":1,\n         \"position\":1,\n         \"attachment_content_type\":\"image/png\",\n         \"attachment_file_name\":\"Yebo-02_(1).png\",\n         \"attachment_updated_at\":\"2016-07-07T12:03:12.151-03:00\",\n         \"attachment_width\":null,\n         \"attachment_height\":null,\n         \"alt\":\"\",\n         \"viewable_type\":\"Spree::Variant\",\n         \"viewable_id\":5,\n         \"mini_url\":\"...\",\n         \"small_url\":\"...\",\n         \"product_url\":\"...\",\n         \"large_url\":\"...\"\n      },\n      // ...\n   ]\n}","name":"","status":200,"language":"json"}]},"settings":"","url":"/v:version/products/autocomplete","auth":"required"},"category":"56af81bcbc304a0d00ace179","hidden":false,"link_external":false,"order":3,"slug":"productsautocomplete","version":"56af5752b4ddab0d008c5805","__v":0,"githubsync":"","isReference":false,"next":{"pages":[],"description":""},"parentDoc":null,"updates":[],"user":"56af52dabc304a0d00ace11e","body":"Esta é a parte responsável pelo uso do autocomplete de produtos, muito utilizado para completar as buscas dos produtos, ajudando o cliente final a localizar mais facilmente o que deseja e otimizando o tempo de navegação em sua loja.","project":"56af5752b4ddab0d008c5802","sync_unique":"","title":"/products/autocomplete","type":"get","createdAt":"2016-10-31T13:21:09.020Z","excerpt":"","link_url":"","childrenPages":[]}

get/products/autocomplete


Query Params

search:
object
Parametros utilizados na busca de produtos
search[name]:
string
Busca por nome de produtos
search[page]:
integer1
Número da pagina da listagem de produtos
search[per_page]:
integer10
Quantidade de produtos por página
search[filters]:
object
Filtros avançados para a busca
search[filters][and]:
array of objects
Filtros que tem relação `e`
search[filters][or]:
array of objects
Filtros que tem relação `ou`
search[filters][and/or][][name]:
required
string
Nome do filtro
search[filters][and/or][][values]:
required
array of strings
Valores do filtro
search[filters][and/or][][field]:
string
Campo do filtro
search[filters][and/or][][type]:
stringfixed
Tipo do filtro
search[filters][and/or][][execution]:
stringand
Condição entre os valores do filtro, `and` ou `or`.
Esta é a parte responsável pelo uso do autocomplete de produtos, muito utilizado para completar as buscas dos produtos, ajudando o cliente final a localizar mais facilmente o que deseja e otimizando o tempo de navegação em sua loja.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Esta é a parte responsável pelo uso do autocomplete de produtos, muito utilizado para completar as buscas dos produtos, ajudando o cliente final a localizar mais facilmente o que deseja e otimizando o tempo de navegação em sua loja.
{"_id":"57163fce3389e81900a4886a","title":"/taxonomies","type":"get","__v":1,"editedParams2":true,"parentDoc":null,"sync_unique":"","excerpt":"","project":"56af5752b4ddab0d008c5802","slug":"taxonomies","updates":[],"user":"56af52dabc304a0d00ace11e","hidden":false,"isReference":false,"link_external":false,"api":{"url":"/v:version/taxonomies","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  // ...\n};\n\n// ...\nYeboSDK.Store.fetch('taxonomies', options).then(function(res) {\n  // ...\n});"}]},"method":"get","params":[{"name":"page","in":"query","_id":"57163e0c893cbe0e002d760a","ref":"","required":false,"desc":"Página atual da busca","default":"1","type":"int"},{"default":"25","type":"int","name":"per_page","in":"query","_id":"57163e0c893cbe0e002d7609","ref":"","required":false,"desc":"Quantidade de taxons por página"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"taxonomies\": [\n        {\n            \"id\": 1,\n            \"name\": \"Some Taxonomy\",\n            \"permalink\": \"some-taxonomy\",\n            \"pretty_name\": \"Some Taxonomy\",\n            \"description\": null,\n            \"taxon_ids\": [\n                5,\n                // ...\n            ]\n        },\n        // ...\n    ],\n    \"taxons\": [\n        {\n          \"id\": 5,\n          \"taxon_ids\":[],\n          \"name\": \"Taxon name\",\n          \"pretty_name\": \"Some Taxonomy -> Taxon Name\",\n          \"permalink\": \"some-taxonomy/taxon-name\",\n          \"parent_id\": 4,\n          \"taxonomy_id\": 1,\n          \"description\": \"\",\n          \"breadcrumbs\": [\n              {\n                  \"name\": \"Some Taxonomy\",\n                  \"permalink\": \"some-taxonomy\"\n              },\n              {\n                  \"name\": \"Taxon Name\",\n                  \"permalink\": \"some-taxonomy/taxon-name\"\n              }\n          ],\n          \"icon_url\": null,\n          \"icon_normal_url\": null,\n          \"icon_mini_url\": null,\n          \"child_ids\": []\n        },\n        // ...\n    ],\n    \"meta\": {}\n}","name":""}]},"settings":""},"body":"Este endpoint é responsável por retornar as taxonomies de sua loja e todos os dados referente a mesma.","createdAt":"2016-04-19T14:25:18.235Z","editedParams":true,"githubsync":"","link_url":"","category":"57163a273389e81900a4884f","next":{"description":"","pages":[]},"order":0,"version":"56af5752b4ddab0d008c5805","childrenPages":[]}

get/taxonomies


Query Params

page:
integer1
Página atual da busca
per_page:
integer25
Quantidade de taxons por página
Este endpoint é responsável por retornar as taxonomies de sua loja e todos os dados referente a mesma.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Este endpoint é responsável por retornar as taxonomies de sua loja e todos os dados referente a mesma.
{"_id":"571640ef893cbe0e002d760f","body":"Quando desejar retornar apenas um  `Taxonomy`, bastar passar o Id da mesma, para que apenas ela e o conteúdo dela seja retornado.","excerpt":"","order":1,"parentDoc":null,"project":"56af5752b4ddab0d008c5802","slug":"taxonomiesid","sync_unique":"","version":"56af5752b4ddab0d008c5805","api":{"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"taxonomy\": {\n        \"id\": 1,\n        \"name\": \"Some Taxonomy\",\n        \"permalink\": \"some-taxonomy\",\n        \"pretty_name\": \"Some Taxonomy\",\n        \"description\": null,\n        \"taxon_ids\": [\n          5,\n          // ...\n        ]\n    },\n    \"taxons\": [\n        {\n          \"id\": 5,\n          \"name\": \"Taxon name\",\n          \"pretty_name\": \"Some Taxonomy -> Taxon Name\",\n          \"permalink\": \"some-taxonomy/taxon-name\",\n          \"parent_id\": 4,\n          \"taxonomy_id\": 1,\n          \"description\": \"\",\n          \"breadcrumbs\": [\n              {\n                  \"name\": \"Some Taxonomy\",\n                  \"permalink\": \"some-taxonomy\"\n              },\n              {\n                  \"name\": \"Taxon Name\",\n                  \"permalink\": \"some-taxonomy/taxon-name\"\n              }\n          ],\n          \"icon_url\": null,\n          \"icon_normal_url\": null,\n          \"icon_mini_url\": null,\n          \"child_ids\": []\n        },\n        // ...\n    ],\n    \"meta\": {}\n}","name":""}]},"settings":"","url":"/v:version/taxonomies/:id","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// ...\nYeboSDK.Store.fetch('taxonomies/' + id).then(function(res) {\n  // ...\n});"}]}},"createdAt":"2016-04-19T14:30:07.762Z","link_external":false,"link_url":"","__v":2,"category":"57163a273389e81900a4884f","githubsync":"","hidden":false,"isReference":false,"next":{"description":"","pages":[]},"title":"/taxonomies/:id","type":"get","updates":[],"user":"56af52dabc304a0d00ace11e","childrenPages":[]}

get/taxonomies/:id


Quando desejar retornar apenas um `Taxonomy`, bastar passar o Id da mesma, para que apenas ela e o conteúdo dela seja retornado.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Quando desejar retornar apenas um `Taxonomy`, bastar passar o Id da mesma, para que apenas ela e o conteúdo dela seja retornado.
{"_id":"57163b14810df00e00cc79ca","excerpt":"","next":{"description":"","pages":[]},"slug":"taxons","user":"56af52dabc304a0d00ace11e","githubsync":"","sync_unique":"","updates":[],"isReference":false,"__v":2,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"taxons\": [\n        {\n          \"id\": 5,\n          \"name\": \"Taxon name\",\n          \"pretty_name\": \"Some Taxonomy -> Taxon Name\",\n          \"permalink\": \"some-taxonomy/taxon-name\",\n          \"parent_id\": 4,\n          \"taxonomy_id\": 1,\n          \"description\": \"\",\n          \"breadcrumbs\": [\n              {\n                  \"name\": \"Some Taxonomy\",\n                  \"permalink\": \"some-taxonomy\"\n              },\n              {\n                  \"name\": \"Taxon Name\",\n                  \"permalink\": \"some-taxonomy/taxon-name\"\n              }\n          ],\n          \"icon_url\": null,\n          \"icon_normal_url\": null,\n          \"icon_mini_url\": null,\n          \"child_ids\": []\n        },\n        // ...\n    ],\n    \"meta\": {\n      \"total_pages\": 30, \n      \"total_count\": 300,\n      \"current_page\": 1\n\t\t}\n}","name":""}]},"settings":"","url":"/v:version/taxons","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  // ...\n};\n\n// ...\nYeboSDK.Store.fetch('taxons', options).then(function(res) {\n  // ...\n});"}]},"method":"get","params":[{"in":"query","_id":"57163e0c893cbe0e002d760c","ref":"","required":false,"desc":"Uma lista de ids das taxons separadas por \",\"","default":"\"\"","type":"string","name":"ids"},{"ref":"","required":false,"desc":"Um lista de slugs das taxons separadas por \",\"","default":"\"\"","type":"string","name":"taxons","in":"query","_id":"57163e0c893cbe0e002d760b"},{"type":"int","name":"page","in":"query","_id":"57163e0c893cbe0e002d760a","ref":"","required":false,"desc":"Página atual da busca","default":"1"},{"type":"int","name":"per_page","in":"query","_id":"57163e0c893cbe0e002d7609","ref":"","required":false,"desc":"Quantidade de taxons por página","default":"25"},{"required":false,"desc":"Apenas volta taxons que pertencerem a Taxonomy especificada","default":"","type":"int","name":"taxonomy_id","in":"query","_id":"57163e0c893cbe0e002d7608","ref":""}]},"body":"Através deste método é possível realizar a busca de todas as  `Taxons` cadastradas para determinada loja.","category":"57163a273389e81900a4884f","editedParams2":true,"hidden":false,"link_external":false,"link_url":"","title":"/taxons","type":"get","createdAt":"2016-04-19T14:05:08.776Z","editedParams":true,"order":2,"parentDoc":null,"project":"56af5752b4ddab0d008c5802","version":"56af5752b4ddab0d008c5805","childrenPages":[]}

get/taxons


Query Params

ids:
string""
Uma lista de ids das taxons separadas por ","
taxons:
string""
Um lista de slugs das taxons separadas por ","
page:
integer1
Página atual da busca
per_page:
integer25
Quantidade de taxons por página
taxonomy_id:
integer
Apenas volta taxons que pertencerem a Taxonomy especificada
Através deste método é possível realizar a busca de todas as `Taxons` cadastradas para determinada loja.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Através deste método é possível realizar a busca de todas as `Taxons` cadastradas para determinada loja.
{"_id":"57163ea140ef9c2000cac980","order":3,"sync_unique":"","title":"/taxons/:id","updates":[],"category":"57163a273389e81900a4884f","createdAt":"2016-04-19T14:20:17.520Z","excerpt":"","githubsync":"","isReference":false,"hidden":false,"link_external":false,"parentDoc":null,"slug":"taxonsid","__v":4,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"taxon\": {\n        \"id\": 2,\n        \"name\": \"Another Taxon\",\n        \"pretty_name\": \"Another Taxon\",\n        \"permalink\": \"another-taxon\",\n        \"parent_id\": null,\n        \"taxonomy_id\": 1,\n        \"description\": null,\n        \"breadcrumbs\": [\n            {\n                \"name\": \"Another Taxon\",\n                \"permalink\": \"another-taxon\"\n            }\n        ],\n        \"icon_url\": null,\n        \"icon_normal_url\": null,\n        \"icon_mini_url\": null,\n        \"child_ids\": [\n            5\n        ]\n    },\n    \"taxons\": [\n        {\n          \"id\": 5,\n          \"name\": \"Taxon name\",\n          \"pretty_name\": \"Some Taxonomy -> Taxon Name\",\n          \"permalink\": \"some-taxonomy/taxon-name\",\n          \"parent_id\": 4,\n          \"taxonomy_id\": 1,\n          \"description\": \"\",\n          \"breadcrumbs\": [\n              {\n                  \"name\": \"Some Taxonomy\",\n                  \"permalink\": \"some-taxonomy\"\n              },\n              {\n                  \"name\": \"Taxon Name\",\n                  \"permalink\": \"some-taxonomy/taxon-name\"\n              }\n          ],\n          \"icon_url\": null,\n          \"icon_normal_url\": null,\n          \"icon_mini_url\": null,\n          \"child_ids\": []\n        },\n        // ...\n    ],\n    \"meta\": {}\n}","name":""}]},"settings":"","url":"/v:version/taxons/:id","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// ...\nYeboSDK.Store.fetch('taxons/' + id).then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"get"},"body":"Quando desejar retornar apenas um  `Taxon`, bastar passar o Id da mesma, para que apenas ela e o conteúdo dela seja retornado.","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","link_url":"","next":{"description":"","pages":[]},"project":"56af5752b4ddab0d008c5802","type":"get","childrenPages":[]}

get/taxons/:id


Quando desejar retornar apenas um `Taxon`, bastar passar o Id da mesma, para que apenas ela e o conteúdo dela seja retornado.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Quando desejar retornar apenas um `Taxon`, bastar passar o Id da mesma, para que apenas ela e o conteúdo dela seja retornado.
{"_id":"56b3879f3ccec63700a7ac27","body":"Através deste endpoint é possível criar  e validar os carrinhos de compra gerados em sua loja.","createdAt":"2016-02-04T17:17:19.116Z","isReference":false,"link_url":"","next":{"description":"","pages":[]},"project":"56af5752b4ddab0d008c5802","type":"post","api":{"results":{"codes":[{"language":"json","code":"{\n  \"order\":{\n    \"number\":\"R123456\",\n    \"token\":\"...\",\n    \"real\":true\n  }\n}","name":"","status":200}]},"settings":"","url":"/v:version/cart","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operação\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  number: 'R123456',\n  user_token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('cart', options, 'POST').then(function(res) {\n  // ...\n});"}]},"method":"post","params":[{"required":false,"type":"string","_id":"56b3887e0fb3582100572f68","default":"","desc":"Token da `Order`","in":"body","name":"token","ref":""},{"name":"number","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f67","default":"","desc":"Número (referencia) da `Order`","in":"body"},{"_id":"56b3887e0fb3582100572f66","default":"true","desc":"Se uma `Order` não for encontrada, buscar a ultima não completa","in":"body","name":"last","ref":"","required":false,"type":"boolean"},{"type":"boolean","_id":"56b3887e0fb3582100572f65","default":"true","desc":"Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova","in":"body","name":"create","ref":"","required":false},{"default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token","ref":"","required":false,"type":"string","_id":"56b3889417c0400d00ed47af"}]},"editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","link_external":false,"version":"56af5752b4ddab0d008c5805","category":"56b3867cb21d8e0d000991d3","hidden":false,"parentDoc":null,"sync_unique":"","title":"/cart","updates":[],"user":"56af52dabc304a0d00ace11e","__v":3,"slug":"cart","order":0,"childrenPages":[]}

post/cart


Body Params

token:
string
Token da `Order`
number:
string
Número (referencia) da `Order`
last:
booleantrue
Se uma `Order` não for encontrada, buscar a ultima não completa
create:
booleantrue
Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova
user_token:
string
Token do usuário para validar a `Order`
Através deste endpoint é possível criar e validar os carrinhos de compra gerados em sua loja.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Através deste endpoint é possível criar e validar os carrinhos de compra gerados em sua loja.
{"_id":"56b38a200709630d002a013c","order":1,"slug":"cartitems","body":"Este endpoint retorna todos os produtos e dados dos produtos que foram inseridos no carrinho de compra e corretamente armazenados.","category":"56b3867cb21d8e0d000991d3","hidden":false,"project":"56af5752b4ddab0d008c5802","title":"/cart/items","type":"get","version":"56af5752b4ddab0d008c5805","api":{"method":"get","params":[{"name":"token","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f68","default":"","desc":"Token da `Order`","in":"query"},{"type":"string","_id":"56b3887e0fb3582100572f67","default":"","desc":"Número (referencia) da `Order`","in":"query","name":"number","ref":"","required":false},{"default":"true","desc":"Se uma `Order` não for encontrada, buscar a ultima não completa","in":"query","name":"last","ref":"","required":false,"type":"boolean","_id":"56b3887e0fb3582100572f66"},{"ref":"","required":false,"type":"boolean","_id":"56b3887e0fb3582100572f65","default":"true","desc":"Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova","in":"query","name":"create"},{"desc":"Token do usuário para validar a `Order`","in":"query","name":"user_token","ref":"","required":false,"type":"string","_id":"56b3889417c0400d00ed47af","default":""}],"results":{"codes":[{"code":"{\n  \"order\":{\n    \"number\":\"R123456\",\n    \"token\":\"...\",\n    \"real\":true\n  },\n  \"items\":[\n    {\n      \"id\":226,\n      \"quantity\":2,\n      \"variant_id\":14,\n      \"product_id\":14,\n      \"prices\":{\n        \"single\":{\n          \"value\":\"14.0\",\n          \"display\":\"R$14,00\"\n        },\n        \"total\":{\n          \"value\":\"28.0\",\n          \"display\":\"R$28,00\"\n        }\n      }\n    },\n    // ...\n  ]\n}","language":"json","status":200,"name":""}]},"settings":"","url":"/v:version/cart/items","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  number: 'R123456',\n  user_token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('cart/items', options, 'GET').then(function(res) {\n  // ...\n});","language":"javascript"}]}},"link_external":false,"next":{"description":"","pages":[]},"githubsync":"","isReference":false,"link_url":"","parentDoc":null,"sync_unique":"","createdAt":"2016-02-04T17:28:00.734Z","editedParams":true,"updates":[],"user":"56af52dabc304a0d00ace11e","__v":1,"editedParams2":true,"excerpt":"","childrenPages":[]}

get/cart/items


Query Params

token:
string
Token da `Order`
number:
string
Número (referencia) da `Order`
last:
booleantrue
Se uma `Order` não for encontrada, buscar a ultima não completa
create:
booleantrue
Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova
user_token:
string
Token do usuário para validar a `Order`
Este endpoint retorna todos os produtos e dados dos produtos que foram inseridos no carrinho de compra e corretamente armazenados.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Este endpoint retorna todos os produtos e dados dos produtos que foram inseridos no carrinho de compra e corretamente armazenados.
{"_id":"56b38b803ccec63700a7ac2f","sync_unique":"","title":"/cart/items/empty","category":"56b3867cb21d8e0d000991d3","excerpt":"","hidden":false,"isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"type":"post","__v":1,"editedParams":true,"editedParams2":true,"link_external":false,"order":2,"slug":"cartitemsadd","updates":[],"user":"56af52dabc304a0d00ace11e","api":{"url":"/v:version/cart/items/empty","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  number: 'R123456',\n  user_token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('cart/items', options, 'GET').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"post","params":[{"default":"","desc":"Token da `Order`","in":"body","name":"token","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f68"},{"desc":"Número (referencia) da `Order`","in":"body","name":"number","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f67","default":""},{"in":"body","name":"last","ref":"","required":false,"type":"boolean","_id":"56b3887e0fb3582100572f66","default":"true","desc":"Se uma `Order` não for encontrada, buscar a ultima não completa"},{"required":false,"type":"boolean","_id":"56b3887e0fb3582100572f65","default":"true","desc":"Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova","in":"body","name":"create","ref":""},{"in":"body","name":"user_token","ref":"","required":false,"type":"string","_id":"56b3889417c0400d00ed47af","default":"","desc":"Token do usuário para validar a `Order`"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"order\":{\n    \"number\":\"R123456\",\n    \"token\":\"...\",\n    \"real\":true\n  },\n  \"items\":[]\n}","language":"json"}]},"settings":""},"body":"Basta utilizar este endpoint para fazer a limpeza de todos os produtos de seu carrinho.","createdAt":"2016-02-04T17:33:52.528Z","version":"56af5752b4ddab0d008c5805","project":"56af5752b4ddab0d008c5802","githubsync":"","link_url":"","childrenPages":[]}

post/cart/items/empty


Body Params

token:
string
Token da `Order`
number:
string
Número (referencia) da `Order`
last:
booleantrue
Se uma `Order` não for encontrada, buscar a ultima não completa
create:
booleantrue
Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova
user_token:
string
Token do usuário para validar a `Order`
Basta utilizar este endpoint para fazer a limpeza de todos os produtos de seu carrinho.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Basta utilizar este endpoint para fazer a limpeza de todos os produtos de seu carrinho.
{"_id":"56b38c3ab21d8e0d000991d7","hidden":false,"parentDoc":null,"updates":[],"excerpt":"","editedParams2":true,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"title":"/cart/items/add","category":"56b3867cb21d8e0d000991d3","api":{"auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  number: 'R123456',\n  user_token: '...',\n  variant: 14,\n  qty: 2\n};\n\n// ...\nYeboSDK.Store.fetch('cart/items/add', options, 'POST').then(function(res) {\n  // ...\n});"}]},"method":"post","params":[{"desc":"Token da `Order`","in":"body","name":"token","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f68","default":""},{"name":"number","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f67","default":"","desc":"Número (referencia) da `Order`","in":"body"},{"_id":"56b3887e0fb3582100572f66","default":"true","desc":"Se uma `Order` não for encontrada, buscar a ultima não completa","in":"body","name":"last","ref":"","required":false,"type":"boolean"},{"type":"boolean","_id":"56b3887e0fb3582100572f65","default":"true","desc":"Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova","in":"body","name":"create","ref":"","required":false},{"default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token","ref":"","required":false,"type":"string","_id":"56b3889417c0400d00ed47af"},{"desc":"ID da variante a ser adicionada","in":"body","name":"variant","ref":"","required":true,"type":"int","_id":"56b38c7da48d0f37000ab3b6","default":""},{"name":"qty","ref":"","required":false,"type":"int","_id":"56b38cbc0fb3582100572f6f","default":"1","desc":"Quantidade de produtos a serem adicionados","in":"body"}],"results":{"codes":[{"code":"{\n  \"order\":{\n    \"number\":\"R123456\",\n    \"token\":\"...\",\n    \"real\":true\n  },\n  \"items\":[\n    {\n      \"id\":226,\n      \"quantity\":2,\n      \"variant_id\":14,\n      \"product_id\":14,\n      \"prices\":{\n        \"single\":{\n          \"value\":\"14.0\",\n          \"display\":\"R$14,00\"\n        },\n        \"total\":{\n          \"value\":\"28.0\",\n          \"display\":\"R$28,00\"\n        }\n      }\n    },\n    // ...\n  ]\n}","language":"json","status":200,"name":""}]},"settings":"","url":"/v:version/cart/items/add"},"editedParams":true,"slug":"cartitemsadd-1","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","__v":3,"body":"Através deste endpoint é possível adiciona os produtos de sua loja em um carrinho e deixa-lo armazenado para seu cliente.","createdAt":"2016-02-04T17:36:58.371Z","githubsync":"","isReference":false,"order":3,"project":"56af5752b4ddab0d008c5802","sync_unique":"","type":"post","childrenPages":[]}

post/cart/items/add


Body Params

token:
string
Token da `Order`
number:
string
Número (referencia) da `Order`
last:
booleantrue
Se uma `Order` não for encontrada, buscar a ultima não completa
create:
booleantrue
Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova
user_token:
string
Token do usuário para validar a `Order`
variant:
required
integer
ID da variante a ser adicionada
qty:
integer1
Quantidade de produtos a serem adicionados
Através deste endpoint é possível adiciona os produtos de sua loja em um carrinho e deixa-lo armazenado para seu cliente.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Através deste endpoint é possível adiciona os produtos de sua loja em um carrinho e deixa-lo armazenado para seu cliente.
{"_id":"56b38d4ca48d0f37000ab3b8","category":"56b3867cb21d8e0d000991d3","editedParams2":true,"order":4,"title":"/cart/items/remove","updates":[],"__v":1,"body":"Através deste endpoint é possível limpar todos os produtos do carrinho do seu cliente.","createdAt":"2016-02-04T17:41:32.672Z","hidden":false,"parentDoc":null,"sync_unique":"","version":"56af5752b4ddab0d008c5805","isReference":false,"project":"56af5752b4ddab0d008c5802","slug":"cartitemsremove","user":"56af52dabc304a0d00ace11e","api":{"params":[{"required":false,"type":"string","_id":"56b3887e0fb3582100572f68","default":"","desc":"Token da `Order`","in":"body","name":"token","ref":""},{"name":"number","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f67","default":"","desc":"Número (referencia) da `Order`","in":"body"},{"_id":"56b3887e0fb3582100572f66","default":"true","desc":"Se uma `Order` não for encontrada, buscar a ultima não completa","in":"body","name":"last","ref":"","required":false,"type":"boolean"},{"type":"boolean","_id":"56b3887e0fb3582100572f65","default":"true","desc":"Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova","in":"body","name":"create","ref":"","required":false},{"default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token","ref":"","required":false,"type":"string","_id":"56b3889417c0400d00ed47af"},{"ref":"","required":true,"type":"int","_id":"56b38c7da48d0f37000ab3b6","default":"","desc":"ID da variante a ser adicionada","in":"body","name":"variant"},{"ref":"","required":false,"type":"int","_id":"56b38cbc0fb3582100572f6f","default":"1","desc":"Quantidade de produtos a serem adicionados","in":"body","name":"qty"}],"results":{"codes":[{"name":"","code":"{\n  \"order\":{\n    \"number\":\"R123456\",\n    \"token\":\"...\",\n    \"real\":true\n  },\n  \"items\":[\n    {\n      \"id\":200,\n      \"quantity\":2,\n      \"variant_id\":15,\n      \"product_id\":15,\n      \"prices\":{\n        \"single\":{\n          \"value\":\"15.0\",\n          \"display\":\"R$15,00\"\n        },\n        \"total\":{\n          \"value\":\"30.0\",\n          \"display\":\"R$30,00\"\n        }\n      }\n    },\n    // ...\n  ]\n}","language":"json","status":200}]},"settings":"","url":"/v:version/cart/items/remove","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  number: 'R123456',\n  user_token: '...',\n  variant: 14,\n  qty: 2\n};\n\n// ...\nYeboSDK.Store.fetch('cart/items/remove', options, 'POST').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"post"},"editedParams":true,"excerpt":"","githubsync":"","link_external":false,"link_url":"","next":{"description":"","pages":[]},"type":"post","childrenPages":[]}

post/cart/items/remove


Body Params

token:
string
Token da `Order`
number:
string
Número (referencia) da `Order`
last:
booleantrue
Se uma `Order` não for encontrada, buscar a ultima não completa
create:
booleantrue
Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova
user_token:
string
Token do usuário para validar a `Order`
variant:
required
integer
ID da variante a ser adicionada
qty:
integer1
Quantidade de produtos a serem adicionados
Através deste endpoint é possível limpar todos os produtos do carrinho do seu cliente.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Através deste endpoint é possível limpar todos os produtos do carrinho do seu cliente.
{"_id":"56b38dea0fb3582100572f72","order":5,"project":"56af5752b4ddab0d008c5802","slug":"cartitemsupdate","title":"/cart/items/update","category":"56b3867cb21d8e0d000991d3","editedParams":true,"githubsync":"","link_external":false,"sync_unique":"","__v":1,"createdAt":"2016-02-04T17:44:10.039Z","excerpt":"","editedParams2":true,"isReference":false,"user":"56af52dabc304a0d00ace11e","next":{"description":"","pages":[]},"parentDoc":null,"type":"post","updates":[],"api":{"settings":"","url":"/v:version/cart/items/update","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  number: 'R123456',\n  user_token: '...',\n  line_item: 200,\n  qty: 5\n};\n\n// ...\nYeboSDK.Store.fetch('cart/items/remove', options, 'POST').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"post","params":[{"name":"token","ref":"","required":false,"type":"string","_id":"56b3887e0fb3582100572f68","default":"","desc":"Token da `Order`","in":"body"},{"_id":"56b3887e0fb3582100572f67","default":"","desc":"Número (referencia) da `Order`","in":"body","name":"number","ref":"","required":false,"type":"string"},{"type":"boolean","_id":"56b3887e0fb3582100572f66","default":"true","desc":"Se uma `Order` não for encontrada, buscar a ultima não completa","in":"body","name":"last","ref":"","required":false},{"default":"true","desc":"Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova","in":"body","name":"create","ref":"","required":false,"type":"boolean","_id":"56b3887e0fb3582100572f65"},{"ref":"","required":false,"type":"string","_id":"56b3889417c0400d00ed47af","default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token"},{"desc":"ID do item do carrinho","in":"body","name":"line_item","ref":"","required":true,"type":"int","_id":"56b38c7da48d0f37000ab3b6","default":""},{"name":"qty","ref":"","required":false,"type":"int","_id":"56b38cbc0fb3582100572f6f","default":"1","desc":"Quantidade de produtos a serem adicionados","in":"body"}],"results":{"codes":[{"name":"","code":"{\n  \"order\":{\n    \"number\":\"R123456\",\n    \"token\":\"...\",\n    \"real\":true\n  },\n  \"items\":[\n    {\n      \"id\":200,\n      \"quantity\":5,\n      \"variant_id\":15,\n      \"product_id\":15,\n      \"prices\":{\n        \"single\":{\n          \"value\":\"15.0\",\n          \"display\":\"R$15,00\"\n        },\n        \"total\":{\n          \"value\":\"75.0\",\n          \"display\":\"R$75,00\"\n        }\n      }\n    },\n    // ...\n  ]\n}","language":"json","status":200}]}},"body":"Neste método é possível atualizar todos os produtos encontrados inseridos no carrinho de compra.","hidden":false,"link_url":"","version":"56af5752b4ddab0d008c5805","childrenPages":[]}

post/cart/items/update


Body Params

token:
string
Token da `Order`
number:
string
Número (referencia) da `Order`
last:
booleantrue
Se uma `Order` não for encontrada, buscar a ultima não completa
create:
booleantrue
Se não encontrar uma `Order` (até mesmo a última incompleta) inicializar uma nova
user_token:
string
Token do usuário para validar a `Order`
line_item:
required
integer
ID do item do carrinho
qty:
integer1
Quantidade de produtos a serem adicionados
Neste método é possível atualizar todos os produtos encontrados inseridos no carrinho de compra.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Neste método é possível atualizar todos os produtos encontrados inseridos no carrinho de compra.
{"_id":"56b3934c0fb3582100572f79","api":{"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[]},"excerpt":"","githubsync":"","title":"Endereços","updates":[],"user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","link_url":"","order":0,"project":"56af5752b4ddab0d008c5802","sync_unique":"","hidden":false,"link_external":false,"parentDoc":null,"slug":"endereços","__v":0,"body":"## Tipos de endereços (`kind`)\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`bill` - Endereço de cobrança\",\n    \"1-0\": \"`ship` - Endereço de entrega\"\n  },\n  \"cols\": 1,\n  \"rows\": 2\n}\n[/block]","category":"56af81c3aef9a21700da0dc3","createdAt":"2016-02-04T18:07:08.977Z","type":"basic","childrenPages":[]}

Endereços


## Tipos de endereços (`kind`) [block:parameters] { "data": { "0-0": "`bill` - Endereço de cobrança", "1-0": "`ship` - Endereço de entrega" }, "cols": 1, "rows": 2 } [/block]
## Tipos de endereços (`kind`) [block:parameters] { "data": { "0-0": "`bill` - Endereço de cobrança", "1-0": "`ship` - Endereço de entrega" }, "cols": 1, "rows": 2 } [/block]
{"_id":"56b38f960fb3582100572f76","editedParams":true,"githubsync":"","hidden":false,"order":1,"parentDoc":null,"type":"get","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","createdAt":"2016-02-04T17:51:18.724Z","editedParams2":true,"api":{"settings":"","url":"/v:version/:number/address/:kind","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  user_token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/address/bill', options).then(function(res) {\n  // ...\n});"}]},"method":"get","params":[{"name":"number","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path"},{"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`","in":"query","name":"user_token","ref":"","required":true},{"default":"","desc":"Tipo do endereço","in":"path","name":"kind","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f77"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"address\": {\n    \"id\": 1,\n    \"first_name\":\"...\",\n    \"last_name\":\"...\",\n    \"firstname\": \"...\",\n    \"lastname\": \"...\",\n    \"address1\": \"...\",\n    \"address2\": \"...\",\n    \"city\": \"....\",\n    \"zipcode\": \"...\",\n    \"phone\": \"...\",\n    \"ddd_phone\":\"...\",\n    \"ddd_alternative_phone\":\"...\",\n    \"state_name\": null,\n    \"alternative_phone\": null,\n    \"neighborhood\":\"...\",\n    \"street_number\":\"...\",\n    \"cpf\":\"...\",\n    \"rg\":\"...\",\n    \"sex\":\"...\",\n    \"birth_date\":\"...\",\n    \"pj\":false,\n    \"cnpj\":\"null\",\n    \"fictitious_name\":null,\n    \"im\":null,\n    \"ie\":null,\n    \"company\": null,\n    \"state_id\": 26,\n    \"country_id\": 28\n\n  },\n  \"states\": [\n    {\n      \"id\": 1,\n      \"name\": \"Acre\",\n      \"abbr\": \"AC\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Alagoas\",\n      \"abbr\": \"AL\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Amapá\",\n      \"abbr\": \"AP\"\n    },\n    {\n      \"id\": 3,\n      \"name\": \"Amazonas\",\n      \"abbr\": \"AM\"\n    },\n    {\n      \"id\": 5,\n      \"name\": \"Bahia\",\n      \"abbr\": \"BA\"\n    },\n    // ...\n  ],\n  \"countries\": [\n    {\n      \"id\": 28,\n      \"iso_name\": \"BRAZIL\",\n      \"iso\": \"BR\",\n      \"iso3\": \"BRA\",\n      \"name\": \"Brazil\",\n      \"numcode\": 76,\n      \"states_required\": true,\n      \"state_ids\": [1, 2, 4, 3, 5]\n    }\n  ],\n  \"meta\": {}\n}","language":"json"}]}},"category":"56af81c3aef9a21700da0dc3","excerpt":"","isReference":false,"project":"56af5752b4ddab0d008c5802","slug":"kind","sync_unique":"","updates":[],"__v":2,"body":"Retorna o endereço.","link_external":false,"link_url":"","next":{"pages":[],"description":""},"title":"/checkout/:number/address/:kind","childrenPages":[]}

get/checkout/:number/address/:kind


Path Params

number:
required
string
Número da `Order`
kind:
required
string
Tipo do endereço

Query Params

user_token:
required
string
Token do usuário para validar a `Order`
Retorna o endereço.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Retorna o endereço.
{"_id":"56b3923ba48d0f37000ab3bb","order":2,"project":"56af5752b4ddab0d008c5802","user":"56af52dabc304a0d00ace11e","body":"Criar o endereço da `Order`","editedParams":true,"editedParams2":true,"excerpt":"","isReference":false,"category":"56af81c3aef9a21700da0dc3","createdAt":"2016-02-04T18:02:35.586Z","githubsync":"","version":"56af5752b4ddab0d008c5805","updates":[],"__v":1,"link_external":false,"next":{"description":"","pages":[]},"parentDoc":null,"title":"/checkout/:number/address/create/:kind","type":"post","api":{"auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  user_token: '...',\n  first_name: '...',\n  last_name: '...',\n  // ...\n};\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/address/create/bill', options, 'POST').then(function(res) {\n  // ...\n});"}]},"method":"post","params":[{"name":"number","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path"},{"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token","ref":"","required":true},{"default":"","desc":"Tipo do endereço","in":"path","name":"kind","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f77"}],"results":{"codes":[{"name":"","code":"{\n  \"address\": {\n    \"id\": 1,\n    \"first_name\":\"...\",\n    \"last_name\":\"...\",\n    \"firstname\": \"...\",\n    \"lastname\": \"...\",\n    \"address1\": \"...\",\n    \"address2\": \"...\",\n    \"city\": \"....\",\n    \"zipcode\": \"...\",\n    \"phone\": \"...\",\n    \"ddd_phone\":\"...\",\n    \"ddd_alternative_phone\":\"...\",\n    \"state_name\": null,\n    \"alternative_phone\": null,\n    \"neighborhood\":\"...\",\n    \"street_number\":\"...\",\n    \"cpf\":\"...\",\n    \"rg\":\"...\",\n    \"sex\":\"...\",\n    \"birth_date\":\"...\",\n    \"pj\":false,\n    \"cnpj\":\"null\",\n    \"fictitious_name\":null,\n    \"im\":null,\n    \"ie\":null,\n    \"company\": null,\n    \"state_id\": 26,\n    \"country_id\": 28\n\n  },\n  \"states\": [\n    {\n      \"id\": 1,\n      \"name\": \"Acre\",\n      \"abbr\": \"AC\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Alagoas\",\n      \"abbr\": \"AL\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Amapá\",\n      \"abbr\": \"AP\"\n    },\n    {\n      \"id\": 3,\n      \"name\": \"Amazonas\",\n      \"abbr\": \"AM\"\n    },\n    {\n      \"id\": 5,\n      \"name\": \"Bahia\",\n      \"abbr\": \"BA\"\n    },\n    // ...\n  ],\n  \"countries\": [\n    {\n      \"id\": 28,\n      \"iso_name\": \"BRAZIL\",\n      \"iso\": \"BR\",\n      \"iso3\": \"BRA\",\n      \"name\": \"Brazil\",\n      \"numcode\": 76,\n      \"states_required\": true,\n      \"state_ids\": [1, 2, 4, 3, 5]\n    }\n  ],\n  \"meta\": {}\n}","language":"json","status":200}]},"settings":"","url":"/v:version/:number/address/create/:kind"},"hidden":false,"link_url":"","slug":"numberaddresscreatekind","sync_unique":"","childrenPages":[]}

post/checkout/:number/address/create/:kind


Path Params

number:
required
string
Número da `Order`
kind:
required
string
Tipo do endereço

Body Params

user_token:
required
string
Token do usuário para validar a `Order`
Criar o endereço da `Order`

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Criar o endereço da `Order`
{"_id":"56b391a5b21d8e0d000991df","next":{"description":"","pages":[]},"parentDoc":null,"sync_unique":"","type":"post","createdAt":"2016-02-04T18:00:05.618Z","link_url":"","api":{"auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  user_token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/address/remove/bill', options).then(function(res) {\n  // ...\n});"}]},"method":"post","params":[{"in":"path","name":"number","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`"},{"default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token","ref":"","required":true,"type":"string","_id":"56b38fb90709630d002a0144"},{"ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f77","default":"","desc":"Tipo do endereço","in":"path","name":"kind"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"address\": {\n    \"id\": 1,\n    \"first_name\":\"...\",\n    \"last_name\":\"...\",\n    \"firstname\": \"...\",\n    \"lastname\": \"...\",\n    \"address1\": \"...\",\n    \"address2\": \"...\",\n    \"city\": \"....\",\n    \"zipcode\": \"...\",\n    \"phone\": \"...\",\n    \"ddd_phone\":\"...\",\n    \"ddd_alternative_phone\":\"...\",\n    \"state_name\": null,\n    \"alternative_phone\": null,\n    \"neighborhood\":\"...\",\n    \"street_number\":\"...\",\n    \"cpf\":\"...\",\n    \"rg\":\"...\",\n    \"sex\":\"...\",\n    \"birth_date\":\"...\",\n    \"pj\":false,\n    \"cnpj\":\"null\",\n    \"fictitious_name\":null,\n    \"im\":null,\n    \"ie\":null,\n    \"company\": null,\n    \"state_id\": 26,\n    \"country_id\": 28\n  },\n  \"states\": [\n    {\n      \"id\": 1,\n      \"name\": \"Acre\",\n      \"abbr\": \"AC\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Alagoas\",\n      \"abbr\": \"AL\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Amapá\",\n      \"abbr\": \"AP\"\n    },\n    {\n      \"id\": 3,\n      \"name\": \"Amazonas\",\n      \"abbr\": \"AM\"\n    },\n    {\n      \"id\": 5,\n      \"name\": \"Bahia\",\n      \"abbr\": \"BA\"\n    },\n    // ...\n  ],\n  \"countries\": [\n    {\n      \"id\": 28,\n      \"iso_name\": \"BRAZIL\",\n      \"iso\": \"BR\",\n      \"iso3\": \"BRA\",\n      \"name\": \"Brazil\",\n      \"numcode\": 76,\n      \"states_required\": true,\n      \"state_ids\": [1, 2, 4, 3, 5]\n    }\n  ],\n  \"meta\": {}\n}"}]},"settings":"","url":"/v:version/:number/address/remove/:kind"},"editedParams":true,"excerpt":"","isReference":false,"link_external":false,"order":3,"__v":1,"updates":[],"slug":"numberaddresskind","title":"/checkout/:number/address/remove/:kind","editedParams2":true,"githubsync":"","user":"56af52dabc304a0d00ace11e","body":"Remove o endereço da `Order`","category":"56af81c3aef9a21700da0dc3","version":"56af5752b4ddab0d008c5805","hidden":false,"project":"56af5752b4ddab0d008c5802","childrenPages":[]}

post/checkout/:number/address/remove/:kind


Path Params

number:
required
string
Número da `Order`
kind:
required
string
Tipo do endereço

Body Params

user_token:
required
string
Token do usuário para validar a `Order`
Remove o endereço da `Order`

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Remove o endereço da `Order`
{"_id":"56b392b03ccec63700a7ac37","createdAt":"2016-02-04T18:04:32.177Z","editedParams2":true,"excerpt":"","isReference":false,"link_external":false,"link_url":"","api":{"url":"/v:version/:number/address/update/:kind","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  user_token: '...',\n  first_name: '...',\n  last_name: '...',\n  // ...\n};\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/address/create/bill', options, 'POST').then(function(res) {\n  // ...\n});"}]},"method":"post","params":[{"name":"number","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path"},{"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token","ref":"","required":true},{"default":"","desc":"Tipo do endereço","in":"path","name":"kind","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f77"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"address\": {\n      \"id\": 1,\n    \"first_name\":\"...\",\n    \"last_name\":\"...\",\n    \"firstname\": \"...\",\n    \"lastname\": \"...\",\n    \"address1\": \"...\",\n    \"address2\": \"...\",\n    \"city\": \"....\",\n    \"zipcode\": \"...\",\n    \"phone\": \"...\",\n    \"ddd_phone\":\"...\",\n    \"ddd_alternative_phone\":\"...\",\n    \"state_name\": null,\n    \"alternative_phone\": null,\n    \"neighborhood\":\"...\",\n    \"street_number\":\"...\",\n    \"cpf\":\"...\",\n    \"rg\":\"...\",\n    \"sex\":\"...\",\n    \"birth_date\":\"...\",\n    \"pj\":false,\n    \"cnpj\":\"null\",\n    \"fictitious_name\":null,\n    \"im\":null,\n    \"ie\":null,\n    \"company\": null,\n    \"state_id\": 26,\n    \"country_id\": 28\n  },\n  \"states\": [\n    {\n      \"id\": 1,\n      \"name\": \"Acre\",\n      \"abbr\": \"AC\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Alagoas\",\n      \"abbr\": \"AL\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Amapá\",\n      \"abbr\": \"AP\"\n    },\n    {\n      \"id\": 3,\n      \"name\": \"Amazonas\",\n      \"abbr\": \"AM\"\n    },\n    {\n      \"id\": 5,\n      \"name\": \"Bahia\",\n      \"abbr\": \"BA\"\n    },\n    // ...\n  ],\n  \"countries\": [\n    {\n      \"id\": 28,\n      \"iso_name\": \"BRAZIL\",\n      \"iso\": \"BR\",\n      \"iso3\": \"BRA\",\n      \"name\": \"Brazil\",\n      \"numcode\": 76,\n      \"states_required\": true,\n      \"state_ids\": [1, 2, 4, 3, 5]\n    }\n  ],\n  \"meta\": {}\n}","language":"json"}]},"settings":""},"project":"56af5752b4ddab0d008c5802","slug":"numberaddressupdatekind","sync_unique":"","type":"post","updates":[],"version":"56af5752b4ddab0d008c5805","editedParams":true,"githubsync":"","hidden":false,"next":{"pages":[],"description":""},"order":4,"parentDoc":null,"user":"56af52dabc304a0d00ace11e","body":"Remove o endereço da `Order`","category":"56af81c3aef9a21700da0dc3","title":"/checkout/:number/address/update/:kind","__v":1,"childrenPages":[]}

post/checkout/:number/address/update/:kind


Path Params

number:
required
string
Número da `Order`
kind:
required
string
Tipo do endereço

Body Params

user_token:
required
string
Token do usuário para validar a `Order`
Remove o endereço da `Order`

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Remove o endereço da `Order`
{"_id":"56b3943e0709630d002a0149","category":"56af81c3aef9a21700da0dc3","githubsync":"","link_external":false,"link_url":"","sync_unique":"","user":"56af52dabc304a0d00ace11e","body":"","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"order":5,"parentDoc":null,"slug":"entrega","type":"basic","__v":1,"hidden":false,"updates":[],"excerpt":"","project":"56af5752b4ddab0d008c5802","title":"Entregas","version":"56af5752b4ddab0d008c5805","createdAt":"2016-02-04T18:11:10.523Z","childrenPages":[]}
{"_id":"56b394840709630d002a014b","editedParams":true,"excerpt":"","hidden":false,"link_external":false,"slug":"numbershipments","updates":[],"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"shipments\": [\n    {\n      \"id\": 987,\n      \"shipments_method_id\":2,\n      \"stock\": \"default\",\n      \"line_items\": [226, 228],\n      \"rates\": [\n        {\n          \"id\": 2959,\n          \"name\": \"Sedex\",\n          \"price\": {\n            \"number\": \"5.0\",\n            \"display\": \"R$5,00\"\n          }\n        },\n        {\n          \"id\": 2960,\n          \"name\": \"Sedex 10\",\n          \"price\": {\n            \"number\": \"5.0\",\n            \"display\": \"R$5,00\"\n          }\n        },\n        {\n          \"id\": 2961,\n          \"name\": \"PAC\",\n          \"price\": {\n            \"number\": \"15.0\",\n            \"display\": \"R$15,00\"\n          }\n        }\n      ]\n    }\n  ]\n}","name":""}]},"settings":"","url":"/v:version/:number/shipments","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/shipments').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"get","params":[{"required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path","name":"number","ref":""},{"name":"user_token","ref":"","required":true,"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`","in":"query"},{"_id":"56b394aaa48d0f37000ab3bc","default":"true","desc":"As entregas serão recalculadas","in":"query","name":"calculate","ref":"","required":false,"type":"boolean"}]},"githubsync":"","isReference":false,"link_url":"","body":"Retorna/Calcula os métodos de entrega para a `Order`","category":"56af81c3aef9a21700da0dc3","editedParams2":true,"sync_unique":"","type":"get","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","__v":2,"createdAt":"2016-02-04T18:12:20.225Z","next":{"description":"","pages":[]},"order":6,"parentDoc":null,"project":"56af5752b4ddab0d008c5802","title":"/checkout/:number/shipments","childrenPages":[]}

get/checkout/:number/shipments


Path Params

number:
required
string
Número da `Order`

Query Params

user_token:
required
string
Token do usuário para validar a `Order`
calculate:
booleantrue
As entregas serão recalculadas
Retorna/Calcula os métodos de entrega para a `Order`

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Retorna/Calcula os métodos de entrega para a `Order`
{"_id":"56b395413ccec63700a7ac39","category":"56af81c3aef9a21700da0dc3","project":"56af5752b4ddab0d008c5802","sync_unique":"","updates":[],"body":"Define um método de entrega para um pacote.","githubsync":"","order":7,"parentDoc":null,"title":"/checkout/:number/shipments/set","__v":1,"api":{"results":{"codes":[{"name":"","code":"","language":"json","status":201}]},"settings":"","url":"/v:version/:number/shipments","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  package: 1,\n  rate: 1\n};\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/shipments/set', options, 'POST').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"post","params":[{"ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path","name":"number"},{"ref":"","required":true,"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`","in":"body","name":"user_token"},{"desc":"ID do pacote","in":"body","name":"package","ref":"","required":true,"type":"int","_id":"56b394aaa48d0f37000ab3bc","default":""},{"in":"body","name":"rate","ref":"","required":true,"type":"int","_id":"56b395413ccec63700a7ac3a","default":"","desc":"ID da entrega para o pacote"}]},"link_url":"","slug":"numbershipmentsset","type":"post","version":"56af5752b4ddab0d008c5805","link_external":false,"createdAt":"2016-02-04T18:15:29.218Z","editedParams":true,"editedParams2":true,"excerpt":"","hidden":false,"isReference":false,"next":{"pages":[],"description":""},"user":"56af52dabc304a0d00ace11e","childrenPages":[]}

post/checkout/:number/shipments/set


Path Params

number:
required
string
Número da `Order`

Body Params

user_token:
required
string
Token do usuário para validar a `Order`
package:
required
integer
ID do pacote
rate:
required
integer
ID da entrega para o pacote
Define um método de entrega para um pacote.

Definition

{{ api_url }}{{ page_api_url }}

Examples



Define um método de entrega para um pacote.
{"_id":"56b395d63ccec63700a7ac3b","order":8,"body":"","createdAt":"2016-02-04T18:17:58.336Z","githubsync":"","link_external":false,"sync_unique":"","title":"Pagamentos","type":"basic","excerpt":"","hidden":false,"parentDoc":null,"user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","__v":0,"category":"56af81c3aef9a21700da0dc3","link_url":"","slug":"pagamentos","api":{"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[]},"project":"56af5752b4ddab0d008c5802","updates":[],"childrenPages":[]}
{"_id":"56b396b8a48d0f37000ab3be","editedParams":true,"type":"get","githubsync":"","next":{"pages":[],"description":""},"parentDoc":null,"project":"56af5752b4ddab0d008c5802","api":{"settings":"","url":"/v:version/:number/payments","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/payments').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"get","params":[{"name":"number","ref":"","required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path"},{"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`","in":"query","name":"user_token","ref":"","required":true},{"required":false,"type":"boolean","_id":"56b394aaa48d0f37000ab3bc","default":"false","desc":"Retorna métodos de pagamento do tipo recorrência","in":"query","name":"subscription","ref":""}],"results":{"codes":[{"language":"json","code":"{\n  \"payments\": [\n    {\n      \"id\": 7,\n      \"name\": \"Boleto\"\n    },\n    {\n      \"id\": 6,\n      \"name\": \"Cartão de crédito\",\n      \"extra\": {\n      \t\"operators\":[\n          {\n            \"slug\":\"bradesconet\",\n            \"name\":\"BradescoNET\",\n            \"code\":\"19\",\n            \"image\":\"https://s3-sa-east-1.amazonaws.com/yebo-assets/flags/bradesconet.jpg\"\n          }\n        ],\n        \"flags\": [\n          {\n            \"slug\": \"cielo_visa\",\n            \"flag\": \"visa\",\n            \"acquirer\": \"cielo\",\n            \"acquirer_code\": \"1\",\n            \"name\": \"Visa\",\n            \"active\": \"1\",\n            \"min_value\": 0,\n            \"max_value\": 9.9999998E12,\n            \"installment\": 12,\n            \"tax\": 5,\n            \"tax_installment\": 5,\n            \"min_installment_value\": 0,\n            \"installments\": {\n              \"1\": {\n                \"tax\": false,\n                \"money\": \"R$66,60\"\n              },\n              \"2\": {\n                \"tax\": false,\n                \"money\": \"R$33,30\"\n              },\n              \"3\": {\n                \"tax\": false,\n                \"money\": \"R$22,20\"\n              },\n              // ...\n            },\n            \"image\": \"...\"\n          },\n          {\n            \"slug\": \"cielo_mastercard\",\n            \"flag\": \"mastercard\",\n            \"acquirer\": \"cielo\",\n            \"acquirer_code\": \"1\",\n            \"name\": \"MasterCard\",\n            \"active\": \"1\",\n            \"min_value\": 0,\n            \"max_value\": 9.9999998E10,\n            \"installment\": 7,\n            \"tax\": 0,\n            \"tax_installment\": 0,\n            \"min_installment_value\": 0,\n            \"installments\": {\n              \"1\": {\n                \"tax\": false,\n                \"money\": \"R$66,60\"\n              },\n              \"2\": {\n                \"tax\": false,\n                \"money\": \"R$33,30\"\n              },\n              // ...\n            },\n            \"image\": \"...\"\n          },\n          // ...\n        ]\n      }\n    }\n  ]\n}","name":"","status":200}]}},"category":"56af81c3aef9a21700da0dc3","editedParams2":true,"excerpt":"","sync_unique":"","updates":[],"user":"56af52dabc304a0d00ace11e","link_external":false,"link_url":"","title":"/checkout/:number/payments","__v":1,"body":"Retorna os métodos de pagamento para a `Order`","hidden":false,"isReference":false,"version":"56af5752b4ddab0d008c5805","createdAt":"2016-02-04T18:21:44.810Z","order":9,"slug":"numberpayments","childrenPages":[]}

get/checkout/:number/payments


Path Params

number:
required
string
Número da `Order`

Query Params

user_token:
required
string
Token do usuário para validar a `Order`
subscription:
booleanfalse
Retorna métodos de pagamento do tipo recorrência
Retorna os métodos de pagamento para a `Order`

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Retorna os métodos de pagamento para a `Order`
{"_id":"56b3972d0fb3582100572f7f","link_url":"","next":{"description":"","pages":[]},"order":10,"project":"56af5752b4ddab0d008c5802","updates":[],"version":"56af5752b4ddab0d008c5805","api":{"params":[{"required":true,"type":"string","_id":"56b38f960fb3582100572f78","default":"","desc":"Número da `Order`","in":"path","name":"number","ref":""},{"in":"body","name":"user_token","ref":"","required":true,"type":"string","_id":"56b38fb90709630d002a0144","default":"","desc":"Token do usuário para validar a `Order`"},{"required":true,"type":"int","_id":"56b394aaa48d0f37000ab3bc","default":"","desc":"ID do metodo de pagamento","in":"body","name":"method_id","ref":""},{"in":"body","name":"source","ref":"","required":true,"type":"string","_id":"56b3972d0fb3582100572f80","default":"","desc":"Informações utilizadas pelo pagamento"}],"results":{"codes":[{"code":"{\n  \"id\": 56,\n  \"state\": \"pending\",\n  \"name\": \"Cartão de Crédito\",\n  \"source\": {\n    \"url\": \"...\",\n    \"redirect\": false\n  }\n}","name":"","status":201,"language":"json"}]},"settings":"","url":"/v:version/:number/payments","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  method_id: 1,\n  source: {\n    number: 'xxxx xxxx xxxx xxxx',\n    month: 2,\n    year: 22,\n    // ...\n  }\n};\n\n// ...\nYeboSDK.Store.fetch('checkout/' + number + '/payments', options, 'POST').then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"post"},"excerpt":"","createdAt":"2016-02-04T18:23:41.948Z","editedParams2":true,"body":"Efetua o pagamento.","category":"56af81c3aef9a21700da0dc3","isReference":false,"link_external":false,"parentDoc":null,"sync_unique":"","title":"/checkout/:number/payments","type":"post","githubsync":"","user":"56af52dabc304a0d00ace11e","hidden":false,"slug":"numberpayments-1","__v":1,"editedParams":true,"childrenPages":[]}

post/checkout/:number/payments


Path Params

number:
required
string
Número da `Order`

Body Params

user_token:
required
string
Token do usuário para validar a `Order`
method_id:
required
integer
ID do metodo de pagamento
source:
required
string
Informações utilizadas pelo pagamento
Efetua o pagamento.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Efetua o pagamento.
{"_id":"56b398947c04042100b61385","category":"56b3983b50f85b0d00bf1326","editedParams2":true,"githubsync":"","link_external":false,"link_url":"","order":0,"project":"56af5752b4ddab0d008c5802","excerpt":"","hidden":false,"sync_unique":"","title":"/orders","type":"get","api":{"settings":"","url":"/v:version/orders","auth":"required","examples":{"codes":[{"language":"javascript","code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('orders', options).then(function(res) {\n  // ...\n});"}]},"method":"get","params":[{"name":"token","in":"query","_id":"56b398947c04042100b61386","required":true,"desc":"Token do usuário, dono das `Orders`","default":"","type":"string","ref":""},{"name":"page","in":"query","_id":"56b398b67c04042100b61388","required":false,"desc":"Número da página da listagem","default":"1","type":"string","ref":""},{"name":"per_page","in":"query","_id":"56b398b67c04042100b61387","required":false,"desc":"Quantidade de `Orders` por pagina","default":"25","type":"string","ref":""},{"name":"complete","in":"query","_id":"56b398e20fb3582100572f85","required":false,"desc":"Retorna apenas `Orders` completas","default":"","type":"boolean","ref":""},{"name":"incomplete","in":"query","_id":"56b398e20fb3582100572f84","required":false,"desc":"Retorna apenas `Orders` incompletas","default":"","type":"boolean","ref":""}],"results":{"codes":[{"name":"","code":"{\n  \"order\": [\n    {\n      \"id\": \"R481536094\",\n      \"number\": \"R481536094\",\n      \"item_total\": \"60.0\",\n      \"display_item_total\": \"R$60,00\",\n      \"total\": \"60.6\",\n      \"display_total\": \"R$60,60\",\n      \"state\": \"complete\",\n      \"adjustment_total\": \"-4.4\",\n      \"display_adjustment_total\": \"-R$4,40\",\n      \"user_id\": 1,\n      \"completed_at\": \"2016-02-04T16:23:16.879-02:00\",\n      \"ship_address_id\": 459,\n      \"payment_total\": \"0.0\",\n      \"shipping_method_id\": null,\n      \"shipment_state\": \"pending\",\n      \"payment_state\": \"balance_due\",\n      \"email\": \"...\",\n      \"special_instructions\": null,\n      \"created_at\": \"2016-02-01T23:53:40.514-02:00\",\n      \"updated_at\": \"2016-02-04T16:23:16.879-02:00\",\n      \"currency\": \"BRL\",\n      \"last_ip_address\": null,\n      \"created_by_id\": null,\n      \"shipment_total\": \"5.0\",\n      \"display_shipment_total\": \"R$5,00\",\n      \"additional_tax_total\": \"1.6\",\n      \"display_additional_tax_total\": \"R$1,60\",\n      \"promo_total\": \"0.0\",\n      \"display_promo_total\": \"R$0,00\",\n      \"channel\": \"spree\",\n      \"included_tax_total\": \"0.0\",\n      \"display_included_tax_total\": \"R$0,00\",\n      \"item_count\": 4,\n      \"approver_id\": null,\n      \"approved_at\": null,\n      \"confirmation_delivered\": true,\n      \"considered_risky\": false,\n      \"guest_token\": \"...\",\n      \"checkout_steps\": [\n        \"address\",\n        \"delivery\",\n        \"payment\",\n        \"complete\"\n      ],\n      \"discounts\": [\n        {\n          \"name\": \"Boleto\",\n          \"raw\": 54.6,\n          \"display\": \"R$54,60\"\n        }\n      ],\n      \"has_discounts\":false,\n      \"shipment_ids\": [988],\n      \"payment_ids\": [56],\n      \"line_item_ids\": [226, 228],\n      \"bill_address_id\": 460\n    },\n    // ...\n  ],\n  \"stock_locations\": [\n    {\n      \"id\": 1,\n      \"name\": \"default\"\n    }\n  ],\n  \"zones\": [\n    {\n      \"id\": 1,\n      \"name\": \"Brasil\",\n      \"description\": \"Todos estados brasileiros\"\n    }\n  ],\n  \"shipping_categories\": [\n    {\n      \"id\": 2,\n      \"name\": \"Correios\"\n    }\n  ],\n  \"shipping_methods\": [\n    {\n      \"id\": 1,\n      \"name\": \"Sedex\",\n      \"zone_ids\": [\n        1\n      ],\n      \"shipping_category_ids\": [\n        2\n      ]\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Sedex 10\",\n      \"zone_ids\": [\n        1\n      ],\n      \"shipping_category_ids\": [\n        2\n      ]\n    },\n    {\n      \"id\": 3,\n      \"name\": \"PAC\",\n      \"zone_ids\": [\n        1\n      ],\n      \"shipping_category_ids\": [\n        2\n      ]\n    }\n  ],\n  \"shipping_rates\": [\n    {\n      \"id\": 2962,\n      \"name\": \"Sedex\",\n      \"cost\": \"5.0\",\n      \"selected\": true,\n      \"display_cost\": \"R$5,00\",\n      \"shipping_method_id\": 1\n    },\n    // ...\n  ],\n  \"images\": [\n    {\n      \"id\": 31,\n      \"position\": 1,\n      \"attachment_content_type\": \"image/jpeg\",\n      \"attachment_file_name\": \"ror_stein.jpeg\",\n      \"attachment_updated_at\": \"2015-05-18T14:37:21.490-03:00\",\n      \"attachment_width\": null,\n      \"attachment_height\": null,\n      \"alt\": null,\n      \"viewable_id\": 14,\n      \"mini_url\": \"...\",\n      \"small_url\": \"...\",\n      \"product_url\": \"...\",\n      \"large_url\": \"...\"\n    },\n    // ...\n  ],\n  \"variants\": [\n    {\n      \"id\": 14,\n      \"name\": \"Ruby on Rails Stein\",\n      \"sku\": \"ROR-00016\",\n      \"weight\": \"0.0\",\n      \"height\": null,\n      \"width\": null,\n      \"depth\": null,\n      \"is_master\": true,\n      \"slug\": \"ruby-on-rails-stein\",\n      \"description\": \"Ratione non sint aut ipsa harum non. Corporis vel velit sed aut consectetur. Voluptas at esse impedit sed. Tenetur nostrum voluptates eum a est temporibus occaecati aut. Velit id reprehenderit qui asperiores fugit.\",\n      \"track_inventory\": true,\n      \"options_text\": \"\",\n      \"can_supply\": true,\n      \"price\": \"R$14,00\",\n      \"raw_price\": 14,\n      \"cost_price\": \"R$15,00\",\n      \"raw_cost_price\": 15,\n      \"discount_price\": \"R$0,00\",\n      \"raw_discount_price\": 0,\n      \"installments\": [\n        {\n          \"name\": \"Cartão de crédito\",\n          \"installments\": {\n            \"1\": {\n              \"tax\": false,\n              \"raw\": 14,\n              \"display\": \"R$14,00\"\n            },\n            \"2\": {\n              \"tax\": false,\n              \"raw\": 7,\n              \"display\": \"R$7,00\"\n            },\n            // ....\n          }\n        }\n      ],\n      \"has_installments\": true,\n      \"image_ids\": [31, 32]\n    },\n    // ...\n  ],\n  \"line_items\": [\n    {\n      \"id\": 226,\n      \"quantity\": 2,\n      \"price\": \"14.0\",\n      \"single_display_amount\": \"R$14,00\",\n      \"display_amount\": \"R$28,00\",\n      \"total\": \"28.0\",\n      \"insufficient_stock\": false,\n      \"variant_id\": 14\n    },\n    // ...\n  ],\n  \"shipments\": [\n    {\n      \"id\": 988,\n      \"tracking\": null,\n      \"number\": \"H08788875056\",\n      \"cost\": \"5.0\",\n      \"shipped_at\": null,\n      \"state\": \"pending\",\n      \"selected_shipping_rate_id\": 2962,\n      \"stock_location_id\": 1,\n      \"shipping_rate_ids\": [\n        2962,\n        2963,\n        2964\n      ],\n      \"line_item_ids\": [\n        226,\n        228\n      ]\n    },\n    // ...\n  ],\n  \"payment_methods\": [\n    {\n      \"id\": 6,\n      \"name\": \"Cartão de crédito\",\n      \"description\": null,\n      \"method_type\": \"azpay_card\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": 50,\n      \"state\": \"completed\",\n      \"payment_method_id\": 6\n    }\n  ],\n  \"states\": [\n    {\n      \"id\": 1,\n      \"name\": \"Acre\",\n      \"abbr\": \"AC\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Alagoas\",\n      \"abbr\": \"AL\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Amapá\",\n      \"abbr\": \"AP\"\n    },\n    // ...\n  ],\n  \"countries\": [\n    {\n      \"id\": 28,\n      \"iso_name\": \"BRAZIL\",\n      \"iso\": \"BR\",\n      \"iso3\": \"BRA\",\n      \"name\": \"Brazil\",\n      \"numcode\": 76,\n      \"states_required\": true,\n      \"state_ids\": [1, 2, 4, 3, 5]\n    }\n  ],\n  \"addresses\": [\n    {\n      \"id\": 460,\n      \"firstname\": \"joao\",\n      \"lastname\": \"antonio\",\n      \"address1\": \"casa\",\n      \"address2\": \"minha\",\n      \"city\": \"mogi das cruzes\",\n      \"zipcode\": \"08773380\",\n      \"phone\": \"1123478999\",\n      \"state_name\": null,\n      \"alternative_phone\": null,\n      \"company\": null,\n      \"state_id\": 26,\n      \"country_id\": 28\n    },\n    // ...\n  ],\n  \"meta\": {\n    \"total_pages\": 1,\n    \"total_count\": 3,\n    \"current_page\": 1\n  }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]}},"editedParams":true,"slug":"orders","updates":[],"user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","__v":3,"body":"Retorna todas as `Orders` de um usuário.","createdAt":"2016-02-04T18:29:40.583Z","parentDoc":null,"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

get/orders


Query Params

token:
required
string
Token do usuário, dono das `Orders`
page:
string1
Número da página da listagem
per_page:
string25
Quantidade de `Orders` por pagina
complete:
boolean
Retorna apenas `Orders` completas
incomplete:
boolean
Retorna apenas `Orders` incompletas
Retorna todas as `Orders` de um usuário.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Retorna todas as `Orders` de um usuário.
{"_id":"56b39ace0709630d002a0151","type":"get","editedParams2":true,"excerpt":"","link_external":false,"parentDoc":null,"sync_unique":"","user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","__v":2,"body":"Retorna uma  `Order` do usuário.","category":"56b3983b50f85b0d00bf1326","link_url":"","project":"56af5752b4ddab0d008c5802","slug":"ordersnumber","title":"/orders/:number","updates":[],"api":{"examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  token: '...'\n};\n\n// ...\nYeboSDK.Store.fetch('orders/' + number, options).then(function(res) {\n  // ...\n});","language":"javascript"}]},"method":"get","params":[{"_id":"56b398947c04042100b61386","required":true,"desc":"Token do usuário, dono das `Orders`","default":"","type":"string","name":"token","in":"query","ref":""},{"required":false,"desc":"Número da `Order`","default":"1","type":"string","name":"number","in":"path","_id":"56b398b67c04042100b61388","ref":""},{"name":"complete","in":"query","_id":"56b39bc850f85b0d00bf1329","required":false,"desc":"Retorna apenas se a `Order` for completa","default":"","type":"boolean","ref":""},{"desc":"Retorna apenas se a `Order` for incompleta","default":"","type":"boolean","name":"incomplete","in":"query","_id":"56b39bc850f85b0d00bf1328","required":false,"ref":""}],"results":{"codes":[{"name":"","code":"{\n  \"order\": {\n    \"id\": \"R481536094\",\n    \"number\": \"R481536094\",\n    \"item_total\": \"60.0\",\n    \"display_item_total\": \"R$60,00\",\n    \"total\": \"60.6\",\n    \"display_total\": \"R$60,60\",\n    \"state\": \"complete\",\n    \"adjustment_total\": \"-4.4\",\n    \"display_adjustment_total\": \"-R$4,40\",\n    \"user_id\": 1,\n    \"completed_at\": \"2016-02-04T16:23:16.879-02:00\",\n    \"ship_address_id\": 459,\n    \"payment_total\": \"0.0\",\n    \"shipping_method_id\": null,\n    \"shipment_state\": \"pending\",\n    \"payment_state\": \"balance_due\",\n    \"email\": \"...\",\n    \"special_instructions\": null,\n    \"created_at\": \"2016-02-01T23:53:40.514-02:00\",\n    \"updated_at\": \"2016-02-04T16:23:16.879-02:00\",\n    \"currency\": \"BRL\",\n    \"last_ip_address\": null,\n    \"created_by_id\": null,\n    \"shipment_total\": \"5.0\",\n    \"display_shipment_total\": \"R$5,00\",\n    \"additional_tax_total\": \"1.6\",\n    \"display_additional_tax_total\": \"R$1,60\",\n    \"promo_total\": \"0.0\",\n    \"display_promo_total\": \"R$0,00\",\n    \"channel\": \"spree\",\n    \"included_tax_total\": \"0.0\",\n    \"display_included_tax_total\": \"R$0,00\",\n    \"item_count\": 4,\n    \"approver_id\": null,\n    \"approved_at\": null,\n    \"confirmation_delivered\": true,\n    \"considered_risky\": false,\n    \"guest_token\": \"...\",\n    \"checkout_steps\": [\n      \"address\",\n      \"delivery\",\n      \"payment\",\n      \"complete\"\n    ],\n    \"discounts\": [\n      {\n        \"name\": \"Boleto\",\n        \"raw\": 54.6,\n        \"display\": \"R$54,60\"\n      },\n      // ...\n    ],\n    \"has_discounts\":false, \n    \"shipment_ids\": [988],\n    \"payment_ids\": [56],\n    \"line_item_ids\": [226, 228],\n    \"bill_address_id\": 460\n  },\n  \"stock_locations\": [\n    {\n      \"id\": 1,\n      \"name\": \"default\"\n    },\n    // ...\n  ],\n  \"zones\": [\n    {\n      \"id\": 1,\n      \"name\": \"Brasil\",\n      \"description\": \"Todos estados brasileiros\"\n    },\n    // ...\n  ],\n  \"shipping_categories\": [\n    {\n      \"id\": 2,\n      \"name\": \"Correios\"\n    },\n    // ...\n  ],\n  \"shipping_methods\": [\n    {\n      \"id\": 1,\n      \"name\": \"Sedex\",\n      \"zone_ids\": [\n        1\n      ],\n      \"shipping_category_ids\": [\n        2\n      ]\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Sedex 10\",\n      \"zone_ids\": [\n        1\n      ],\n      \"shipping_category_ids\": [\n        2\n      ]\n    },\n    {\n      \"id\": 3,\n      \"name\": \"PAC\",\n      \"zone_ids\": [\n        1\n      ],\n      \"shipping_category_ids\": [\n        2\n      ]\n    },\n    // ...\n  ],\n  \"shipping_rates\": [\n    {\n      \"id\": 2962,\n      \"name\": \"Sedex\",\n      \"cost\": \"5.0\",\n      \"selected\": true,\n      \"display_cost\": \"R$5,00\",\n      \"shipping_method_id\": 1\n    },\n    // ...\n  ],\n  \"images\": [\n    {\n      \"id\": 31,\n      \"position\": 1,\n      \"attachment_content_type\": \"image/jpeg\",\n      \"attachment_file_name\": \"ror_stein.jpeg\",\n      \"attachment_updated_at\": \"2015-05-18T14:37:21.490-03:00\",\n      \"attachment_width\": null,\n      \"attachment_height\": null,\n      \"alt\": null,\n      \"viewable_id\": 14,\n      \"mini_url\": \"...\",\n      \"small_url\": \"...\",\n      \"product_url\": \"...\",\n      \"large_url\": \"...\"\n    },\n    // ...\n  ],\n  \"variants\": [\n    {\n      \"id\": 14,\n      \"name\": \"Ruby on Rails Stein\",\n      \"sku\": \"ROR-00016\",\n      \"weight\": \"0.0\",\n      \"height\": null,\n      \"width\": null,\n      \"depth\": null,\n      \"is_master\": true,\n      \"slug\": \"ruby-on-rails-stein\",\n      \"description\": \"Ratione non sint aut ipsa harum non. Corporis vel velit sed aut consectetur. Voluptas at esse impedit sed. Tenetur nostrum voluptates eum a est temporibus occaecati aut. Velit id reprehenderit qui asperiores fugit.\",\n      \"track_inventory\": true,\n      \"options_text\": \"\",\n      \"can_supply\": true,\n      \"price\": \"R$14,00\",\n      \"raw_price\": 14,\n      \"cost_price\": \"R$15,00\",\n      \"raw_cost_price\": 15,\n      \"discount_price\": \"R$0,00\",\n      \"raw_discount_price\": 0,\n      \"installments\": [\n        {\n          \"name\": \"Cartão de crédito\",\n          \"installments\": {\n            \"1\": {\n              \"tax\": false,\n              \"raw\": 14,\n              \"display\": \"R$14,00\"\n            },\n            \"2\": {\n              \"tax\": false,\n              \"raw\": 7,\n              \"display\": \"R$7,00\"\n            },\n            // ...\n          }\n        }\n      ],\n      \"has_installments\": true,\n      \"image_ids\": [31, 32]\n    },\n    // ...\n  ],\n  \"line_items\": [\n    {\n      \"id\": 226,\n      \"quantity\": 2,\n      \"price\": \"14.0\",\n      \"single_display_amount\": \"R$14,00\",\n      \"display_amount\": \"R$28,00\",\n      \"total\": \"28.0\",\n      \"insufficient_stock\": false,\n      \"variant_id\": 14\n    },\n    // ...\n  ],\n  \"shipments\": [\n    {\n      \"id\": 988,\n      \"tracking\": null,\n      \"number\": \"H08788875056\",\n      \"cost\": \"5.0\",\n      \"shipped_at\": null,\n      \"state\": \"pending\",\n      \"selected_shipping_rate_id\": 2962,\n      \"stock_location_id\": 1,\n      \"shipping_rate_ids\": [\n        2962,\n        2963,\n        2964\n      ],\n      \"line_item_ids\": [\n        226,\n        228\n      ]\n    },\n    // ...\n  ],\n  \"payment_methods\": [\n    {\n      \"id\": 6,\n      \"name\": \"Cartão de crédito\",\n      \"description\": null,\n      \"method_type\": \"azpay_card\"\n    },\n    // ...\n  ],\n  \"payments\": [\n    {\n      \"id\": 50,\n      \"state\": \"completed\",\n      \"payment_method_id\": 6\n    },\n    // ...\n  ],\n  \"states\": [\n    {\n      \"id\": 1,\n      \"name\": \"Acre\",\n      \"abbr\": \"AC\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Alagoas\",\n      \"abbr\": \"AL\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"Amapá\",\n      \"abbr\": \"AP\"\n    },\n    // ...\n  ],\n  \"countries\": [\n    {\n      \"id\": 28,\n      \"iso_name\": \"BRAZIL\",\n      \"iso\": \"BR\",\n      \"iso3\": \"BRA\",\n      \"name\": \"Brazil\",\n      \"numcode\": 76,\n      \"states_required\": true,\n      \"state_ids\": [1, 2, 4, 3, 5]\n    }\n  ],\n  \"addresses\": [\n    {\n      \"id\": 460,\n      \"firstname\": \"joao\",\n      \"lastname\": \"antonio\",\n      \"address1\": \"casa\",\n      \"address2\": \"minha\",\n      \"city\": \"mogi das cruzes\",\n      \"zipcode\": \"08773380\",\n      \"phone\": \"1123478999\",\n      \"state_name\": null,\n      \"alternative_phone\": null,\n      \"company\": null,\n      \"state_id\": 26,\n      \"country_id\": 28\n    },\n    // ...\n  ],\n  \"meta\": {\n    \"total_pages\": 1,\n    \"total_count\": 3,\n    \"current_page\": 1\n  }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","url":"/v:version/orders/:number","auth":"required"},"createdAt":"2016-02-04T18:39:10.507Z","editedParams":true,"githubsync":"","hidden":false,"order":1,"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

get/orders/:number


Path Params

number:
string1
Número da `Order`

Query Params

token:
required
string
Token do usuário, dono das `Orders`
complete:
boolean
Retorna apenas se a `Order` for completa
incomplete:
boolean
Retorna apenas se a `Order` for incompleta
Retorna uma `Order` do usuário.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Retorna uma `Order` do usuário.
{"_id":"56b3a55317c0400d00ed47d4","sync_unique":"","title":"/users","updates":[],"user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","api":{"params":[{"type":"object","name":"user","_id":"580fc386497aed0f00972c6d","ref":"","in":"body","required":true,"desc":"Informações do usuário","default":""},{"required":true,"desc":"Email do usuário","default":"","type":"string","name":"user[email]","_id":"56b3a55317c0400d00ed47d7","ref":"","in":"body"},{"required":true,"type":"string","_id":"56b3a55317c0400d00ed47d6","default":"","desc":"Senha do usuário","in":"body","name":"user[password]","ref":""},{"name":"user[password_confirmation]","ref":"","required":true,"type":"string","_id":"56b3a55317c0400d00ed47d5","default":"","desc":"Confirmação da senha do usuário","in":"body"}],"results":{"codes":[{"name":"","code":"{\n  \"user\": {\n    \"email\": \"dev@yebo.com.br\",\n    \"token\": \"...\",\n    \"order\": {\n      \"number\": null,\n      \"linked\": false\n    }\n  }\n}","language":"json","status":201}]},"settings":"","url":"/v:version/users","auth":"required","examples":{"codes":[{"language":"javascript","code":"// Criando usuário\nYeboSDK.Users.register('dev@yebo.com.br', '1235', '1235').then(function(res) {\n  // ...\n});"}]},"method":"post"},"createdAt":"2016-02-04T19:24:03.949Z","githubsync":"","link_url":"","next":{"description":"","pages":[]},"project":"56af5752b4ddab0d008c5802","body":"Método utilizado para a criação de usuário.","editedParams2":true,"isReference":false,"parentDoc":null,"excerpt":"","link_external":false,"hidden":false,"order":0,"slug":"users","type":"post","__v":3,"category":"56b39fb550f85b0d00bf1338","editedParams":true,"childrenPages":[]}

post/users


Body Params

user:
required
object
Informações do usuário
user[email]:
required
string
Email do usuário
user[password]:
required
string
Senha do usuário
user[password_confirmation]:
required
string
Confirmação da senha do usuário
Método utilizado para a criação de usuário.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Método utilizado para a criação de usuário.
{"_id":"56b3a65d0709630d002a0168","body":"Login de usuário.","link_external":false,"link_url":"","parentDoc":null,"sync_unique":"","title":"/users/login","type":"post","user":"56af52dabc304a0d00ace11e","api":{"auth":"required","examples":{"codes":[{"language":"javascript","code":"// Criando usuário\nYeboSDK.Users.login('dev@yebo.com.br', '1235').then(function(res) {\n  // ...\n});"}]},"method":"post","params":[{"ref":"","in":"body","required":true,"desc":"Email do usuário","default":"","type":"string","name":"user","_id":"56b3a55317c0400d00ed47d7"},{"default":"","type":"string","name":"password","_id":"56b3a55317c0400d00ed47d6","ref":"","in":"body","required":true,"desc":"Senha do usuário"},{"default":"","type":"string","name":"order_token","_id":"5810a3998a4aed0f00d67571","ref":"","in":"body","required":false,"desc":"Número de Order a ser relacionada ao usuário"}],"results":{"codes":[{"name":"","code":"{\n  \"user\": {\n    \"id\":1,\n    \"email\": \"dev@yebo.com.br\",\n    \"token\": \"...\",\n    \"order\": {\n      \"number\": null,\n      \"linked\": false\n    }\n  }\n}","language":"json","status":201}]},"settings":"","url":"/v:version/users/login"},"category":"56b39fb550f85b0d00bf1338","excerpt":"","githubsync":"","project":"56af5752b4ddab0d008c5802","__v":3,"createdAt":"2016-02-04T19:28:29.188Z","editedParams":true,"order":1,"slug":"userslogin","version":"56af5752b4ddab0d008c5805","editedParams2":true,"hidden":false,"isReference":false,"updates":[],"next":{"description":"","pages":[]},"childrenPages":[]}

post/users/login


Body Params

user:
required
string
Email do usuário
password:
required
string
Senha do usuário
order_token:
string
Número de Order a ser relacionada ao usuário
Login de usuário.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Login de usuário.
{"_id":"56b3a8743ccec63700a7ac58","parentDoc":null,"user":"56af52dabc304a0d00ace11e","version":"56af5752b4ddab0d008c5805","body":"Solicita alteração de senha.","category":"56b39fb550f85b0d00bf1338","editedParams":true,"__v":0,"api":{"auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  email: 'dev@yebo.com.br',\n  store_url: 'http://...'\n};\n\n// ...\nYeboSDK.Store.fetch('users/reset', options, 'POST').then(function() {\n  // ...\n});","language":"javascript"}]},"method":"post","params":[{"in":"body","_id":"56b3a55317c0400d00ed47d7","required":true,"desc":"Email do usuário","default":"","type":"string","name":"email"},{"type":"string","name":"store_url","in":"body","_id":"56b3a55317c0400d00ed47d6","required":true,"desc":"A URL de recuperação que será enviada por email","default":""}],"results":{"codes":[{"name":"","code":"","language":"json","status":204}]},"settings":"","url":"/v:version/users/reset"},"slug":"usersreset","updates":[],"sync_unique":"","title":"/users/reset","editedParams2":true,"excerpt":"","link_url":"","project":"56af5752b4ddab0d008c5802","order":3,"type":"post","createdAt":"2016-02-04T19:37:24.790Z","githubsync":"","hidden":false,"link_external":false,"childrenPages":[]}

post/users/reset


Body Params

email:
required
string
Email do usuário
store_url:
required
string
A URL de recuperação que será enviada por email
Solicita alteração de senha.

Definition

{{ api_url }}{{ page_api_url }}

Examples



Solicita alteração de senha.
{"_id":"56b3a9630e4c450d00699d24","category":"56b39fb550f85b0d00bf1338","link_external":false,"project":"56af5752b4ddab0d008c5802","slug":"usersresetreset","editedParams2":true,"order":4,"parentDoc":null,"user":"56af52dabc304a0d00ace11e","__v":0,"body":"Muda a senha do usuário.","createdAt":"2016-02-04T19:41:23.676Z","title":"/users/reset/reset","type":"post","updates":[],"api":{"method":"post","params":[{"type":"string","name":"token","in":"body","_id":"56b3a55317c0400d00ed47d6","required":true,"desc":"Token que foi enviado por email","default":""},{"_id":"56b3a55317c0400d00ed47d7","required":true,"desc":"Email do usuário","default":"","type":"string","name":"email","in":"body"},{"_id":"56b3a9630e4c450d00699d26","required":true,"desc":"Senha do usuário","default":"","type":"string","name":"password","in":"body"},{"_id":"56b3a9630e4c450d00699d25","required":true,"desc":"Confirmação da senha do usuário","default":"","type":"string","name":"password_confirmation","in":"body"}],"results":{"codes":[{"name":"","code":"","language":"json","status":204}]},"settings":"","url":"/v:version/users/reset/reset","auth":"required","examples":{"codes":[{"code":"// SDK não possui método especifico para essa operção\n// mas ela pode ser feita através do `Store` do SDK\n\n// Opções da requisição\nvar options = {\n  token: '...',\n  email: 'dev@yebo.com.br',\n  password: '1235',\n  password_confirmation: '1235'\n};\n\n// ...\nYeboSDK.Store.fetch('users/reset/reset', options, 'POST').then(function() {\n  // ...\n});","language":"javascript"}]}},"editedParams":true,"githubsync":"","sync_unique":"","excerpt":"","hidden":false,"link_url":"","version":"56af5752b4ddab0d008c5805","childrenPages":[]}

post/users/reset/reset


Body Params

token:
required
string
Token que foi enviado por email
email:
required
string
Email do usuário
password:
required
string
Senha do usuário
password_confirmation:
required
string
Confirmação da senha do usuário
Muda a senha do usuário.

Definition

{{ api_url }}{{ page_api_url }}

Examples



Muda a senha do usuário.