{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c8c2c606-fc47-4f7b-bc0a-0b88ebb35779","name":"#02 - Deeliv Api v1 (pública)","description":"Que bom que está interessado na integração através da nossa API, o modelo de integração entre plataformas torna o dia a dia do estabelecimento mais prático e fácil. Preparamos uma API para que os dados sejam coletados e movimentados de forma rápida e eficiente, evitando erro humano durante o processo de lançamento de pedidos.\n\n**Endereço da API:** [https://www.deeliv.app/apiv1](https://www.deeliv.app/apiv1)\n\n## Requests HTTPs permitidos\n\n- **GET:** Para carregar.\n    \n- **POST:** Para incluir.\n    \n- **PUT:** Para editar.\n    \n- **DELETE:** Para excluir.\n    \n\n## Descrição de responses disponíveis\n\n- 200 `OK` - O request foi bem sucedido.\n    \n- 201 `Created` - O request foi bem sucedido e um novo recurso foi criado.\n    \n- 204 `No Content` - O request foi bem sucedido porém não existe response..\n    \n- 400 `Bad Request` - O request falhou, os dados obrigatórios podem conter erros.\n    \n- 401 `Unauthorized` - A autenticação falhou.\n    \n- 403 `Forbidden` - Não autorizado.\n    \n- 404 `Not Found` - Não encontrado.\n    \n- 405 `Method Not Allowed` - O request não fornece suporte para este recurso.\n    \n\n## Dados para teste\n\nPara facilitar o seu processo de desenvolvimento criamos um estabelecimento de teste dentro da plataforma, o token para autenticação é\n\n**`DQYW6Y07G80STVYFNS2T31UKV7IAUTFDIOVJ3DRFU8ZTS6JRS1`**\n\nPara realizar pedidos dentro do estabelecimento de teste da API você deve acessar os links abaixo:\n\n- **Cardápio digital:** [https://apitester.deeliv.app](https://apitester.deeliv.app/)\n    \n- **Robô no WhatsApp:** [https://www.deeliv.app/h/FXKJKC](https://www.deeliv.app/h/FXKJKC)\n    \n\nRecomendamos que acesse os links pelo Smartphone para uma experiência mais amigável.\n\n## Postman\n\nO Postman é uma ferramenta que tem como objetivo testar serviços RESTful (Web APIs) por meio do envio de requisições HTTP e da análise do seu retorno. Com ele é possível consumir facilmente serviços locais e na internet, enviando dados e efetuando testes sobre as respostas das requisições. O uso de Web APIs vem crescendo e o Postman auxilia nos testes desse tipo de projeto, bem como permite a desenvolvedores analisarem o funcionamento de serviços externos, a fim de saber como consumi-los.\n\n- Collections: [https://www.deeliv.app/public/postman/collections.json](https://www.deeliv.app/public/postman/collections.json)\n    \n- Environment: [https://www.deeliv.app/public/postman/environment.json](https://www.deeliv.app/public/postman/environment.json)\n    \n\n## Webhooks\n\nPara plataformas em núvem a utilização de webhooks é de suma importância para evitar eventos de pooling, com isso a carga de requests é realizada somente quando necessário.\n\nO cadastramento da URL para recebimento de webhooks é feita dentro do gestor de pedidos da plataforma, na aba de ESTABELECIMENTS > CONFIGURAÇÕES > \"Api webhook url\".\n\nRegras de funcionamento do webhook\n\n- Tempo de execução (timeout) de 5 segundos.\n    \n- O header do retorno esperado é 200.\n    \n- Caso não seja retornado 200 as retentativas serão feitas em 15s / 30s / 60s /120s / 300s.\n    \n- A partir da quinta tentativa os novos envios serão realizados a casa 600s.\n    \n- O tempo de vida do webhook é de 48 horas.\n    \n\nA estrutura do JSON enviada pelo webhook contém 3 chaves \"grupo\", \"acao\", \"dados\", segue as especificações:\n\n### grupo\n\npedidos = você está recebendo dados de um pedido.  \npedidos_status = você está recebendo status de um pedido.  \npedidos_pagamentos_online_status = você está recebendo o status de um pagamento online de um pedido.\n\n### acao\n\ninserir = você está recebendo os dados referente a inclusão de um registro.  \neditar = você está recebendo os dados referente a edição do registro.\n\n### dados\n\nSão os dados estruturados em JSON de acordo com a request, você pode consultar as possibilidades dentro da especificação dos endpoints da API.\n\n# Autenticação\n\nPara ter acesso aos endpoints da API é necessário que o Auth-Token seja passado no header. Este token deve ser gerado dentro do perfil do estabelecimento.\n\nPara gerar o token siga os passo a passo abaixo:\n\n1. Faça o login em [https://www.deeliv.app/estabelecimento](https://www.deeliv.app/estabelecimento)\n    \n2. Clique sobre o nome do seu estabelecimento no topo do lado direito.\n    \n3. Clique sobre a sessão MEU PERFIL.\n    \n4. Procure por API TOKEN e clique em GERAR TOKEN.\n    \n\n**Importante:** Verifique se o estabelecimento possui um plano contratado que permita acesso a API, caso contrário o token não será gerado, ou em caso de downgrade ele deixa de funcionar.\n\n# Mapeamento das ENUMs da API\n\nConsulte a tabela abaixo para conhecer todos os enums disponíveis que podem retornar nas requests da API.\n\n## Webhooks\n\n### `grupo`\n\n| Valor | Descrição |\n| --- | --- |\n| `pedidos` | Você está recebendo dados de um pedido |\n| `pedidos_status` | Você está recebendo status de um pedido |\n| `pedidos_pagamentos_online_status` | Você está recebendo o status de um pagamento online de um pedido |\n\n### `acao`\n\n| Valor | Descrição |\n| --- | --- |\n| `inserir` | Você está recebendo os dados referentes à inclusão de um registro |\n| `editar` | Você está recebendo os dados referentes à edição do registro |\n\n## Entregadores\n\n### `ent_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `SUS` | Suspenso |\n| `ATI` | Ativo |\n\n## Pedidos\n\n### `ped_tipo`\n\n| Valor | Descrição |\n| --- | --- |\n| `BAL` | Balcão |\n| `MES` | Mesa |\n| `RET` | Retirada |\n| `CON` | Consumo no local |\n| `DRI` | Drive-thru |\n| `ENT` | Entrega |\n\n### `ped_origem`\n\n> A especificação lista os códigos, mas não detalha a legenda de cada um. \n  \n\n| Valor | Descrição |\n| --- | --- |\n| `PAI` | Não detalhado na especificação |\n| `WEB` | Não detalhado na especificação |\n| `APP` | Não detalhado na especificação |\n| `WHA` | Não detalhado na especificação |\n| `TEL` | Não detalhado na especificação |\n| `MES` | Não detalhado na especificação |\n| `INS` | Não detalhado na especificação |\n| `IFO` | Não detalhado na especificação |\n\n### `ped_formapagamento` e `div_formapagamento`\n\n| Valor | Descrição |\n| --- | --- |\n| `indefinido` | Indefinido |\n| `dinheiro` | Dinheiro |\n| `cheque` | Cheque |\n| `boleto` | Boleto |\n| `voucher` | Voucher |\n| `convenio` | Convênio |\n| `transferencia` | Transferência |\n| `pix` | Pix |\n| `cartao_debito` | Cartão de débito |\n| `cartao_credito` | Cartão de crédito |\n| `cartao_mumbuca` | Cartão mumbuca |\n| `cartao_pat` | Pat |\n| `cartao_debito_visa` | Cartão de débito - Visa |\n| `cartao_debito_visaelectron` | Cartão de débito - Visa electron |\n| `cartao_debito_mastercard` | Cartão de débito - Mastercard |\n| `cartao_debito_amex` | Cartão de débito - Amex |\n| `cartao_debito_elo` | Cartão de débito - Elo |\n| `cartao_debito_diners` | Cartão de débito - Diners |\n| `cartao_visa` | Cartão de crédito - Visa |\n| `cartao_mastercard` | Cartão de crédito - Mastercard |\n| `cartao_amex` | Cartão de crédito - Amex |\n| `cartao_elo` | Cartão de crédito - Elo |\n| `cartao_diners` | Cartão de crédito - Diners |\n| `cartao_discover` | Cartão de crédito - Discover |\n| `cartao_jcb` | Cartão de crédito - Jcb |\n| `cartao_aura` | Cartão de crédito - Aura |\n| `cartao_hipercard` | Cartão de crédito - Hipercard |\n| `cartao_banricompras` | Cartão de crédito - Banricompras |\n| `cartao_goodcard` | Cartão de crédito - Goodcard |\n| `cartao_credishop` | Cartão de crédito - Credishop |\n| `cartao_avancard` | Cartão de crédito - Avancard |\n| `cartao_cabal` | Cartão de crédito - Cabal |\n| `cartao_banescard` | Cartão de crédito - Banescard |\n| `cartao_nugo` | Cartão de crédito - Nugo |\n| `cartao_senff` | Cartão de crédito - Senff |\n| `picpay_offline` | PicPay Local |\n| `vale_aleloalimentacao` | Vale - Alelo alimentação |\n| `vale_alelorefeicao` | Vale - Alelo refeição |\n| `vale_benalimentacao` | Vale - Ben alimentação |\n| `vale_benrefeicao` | Vale - Ben refeição |\n| `vale_coopercard` | Vale - Cooper card |\n| `vale_greencard` | Vale - Green card |\n| `vale_refeisul` | Vale - Refeisul |\n| `vale_sodexoalimentacao` | Vale - Sodexo alimentação |\n| `vale_sodexorefeicao` | Vale - Sodexo refeição |\n| `vale_ticketrestaurante` | Vale - Ticket restaurante |\n| `vale_ticketalimentacao` | Vale - Ticket alimentação |\n| `vale_ticketrefeicao` | Vale - Ticket refeição |\n| `vale_usecredalimentacao` | Vale - Usecred alimentação |\n| `vale_usecredrefeicao` | Vale - Usecred refeição |\n| `vale_valecard` | Vale - Vale card |\n| `vale_verocardalimentacao` | Vale - Verocard alimentação |\n| `vale_verocardrefeicao` | Vale - Verocard refeição |\n| `vale_vralimentacao` | Vale - Vr alimentação |\n| `vale_vrrefeicao` | Vale - Vr refeição |\n| `vale_upalimentacao` | Vale - Up alimentação |\n| `vale_uprefeicao` | Vale - Up refeição |\n| `vale_personalalimentacao` | Vale - Personal alimentação |\n| `vale_personalrefeicao` | Vale - Personal refeição |\n| `vale_nutricardalimentacao` | Vale - Nutricard alimentação |\n| `vale_nutricardrefeicao` | Vale - Nutricard refeição |\n| `vale_banricardalimentacao` | Vale - Banricard alimentação |\n| `vale_banricardrefeicao` | Vale - Banricard refeição |\n| `vale_utilalimentacao` | Vale - Util alimentação |\n| `vale_utilrefeicao` | Vale - Util refeição |\n| `vale_pluxeealimentacao` | Vale - Pluxee alimentação |\n| `vale_pluxeerefeicao` | Vale - Pluxee refeição |\n| `vale_senffalimentacao` | Vale - Senff alimentação |\n| `vale_senffrefeicao` | Vale - Senff refeição |\n| `ifood` | Ifood |\n| `whatsapppay` | WhatsApp Pay |\n| `mercadopago_cartao` | Cartão de crédito - Mercado Pago |\n| `pagseguro` | Cartão de crédito - Pagseguro |\n| `picpay_online` | Cartão de crédito - PicPay E-commerce |\n| `cielo` | Cartão de crédito - Cielo |\n| `getnet_credito` | Cartão de crédito - Getnet |\n| `getnet_debito` | Cartão de débito - Getnet |\n| `stone` | Pix - Stone |\n| `infopago` | Pix - Infopago |\n| `stripe` | Carteira (Google Pay/Apple Pay) - Stripe |\n| `pontos_acumulados` | Pontos acumulados |\n\n### `ped_formapagamento_label` e `div_formapagamento_label`\n\n| Valor retornado | Equivale ao enum técnico |\n| --- | --- |\n| `Indefinido` | `indefinido` |\n| `Dinheiro` | `dinheiro` |\n| `Cheque` | `cheque` |\n| `Boleto` | `boleto` |\n| `Voucher` | `voucher` |\n| `Convênio` | `convenio` |\n| `Transferência` | `transferencia` |\n| `Pix` | `pix` |\n| `Cartão de débito` | `cartao_debito` |\n| `Cartão de crédito` | `cartao_credito` |\n| `Cartão mumbuca` | `cartao_mumbuca` |\n| `Pat` | `cartao_pat` |\n| `Cartão de débito - Visa` | `cartao_debito_visa` |\n| `Cartão de débito - Visa electron` | `cartao_debito_visaelectron` |\n| `Cartão de débito - Mastercard` | `cartao_debito_mastercard` |\n| `Cartão de débito - Amex` | `cartao_debito_amex` |\n| `Cartão de débito - Elo` | `cartao_debito_elo` |\n| `Cartão de débito - Diners` | `cartao_debito_diners` |\n| `Cartão de crédito - Visa` | `cartao_visa` |\n| `Cartão de crédito - Mastercard` | `cartao_mastercard` |\n| `Cartão de crédito - Amex` | `cartao_amex` |\n| `Cartão de crédito - Elo` | `cartao_elo` |\n| `Cartão de crédito - Diners` | `cartao_diners` |\n| `Cartão de crédito - Discover` | `cartao_discover` |\n| `Cartão de crédito - Jcb` | `cartao_jcb` |\n| `Cartão de crédito - Aura` | `cartao_aura` |\n| `Cartão de crédito - Hipercard` | `cartao_hipercard` |\n| `Cartão de crédito - Banricompras` | `cartao_banricompras` |\n| `Cartão de crédito - Goodcard` | `cartao_goodcard` |\n| `Cartão de crédito - Credishop` | `cartao_credishop` |\n| `Cartão de crédito - Avancard` | `cartao_avancard` |\n| `Cartão de crédito - Cabal` | `cartao_cabal` |\n| `Cartão de crédito - Banescard` | `cartao_banescard` |\n| `Cartão de crédito - Nugo` | `cartao_nugo` |\n| `Cartão de crédito - Senff` | `cartao_senff` |\n| `Cartão de crédito - PicPay Local` | `picpay_offline` |\n| `Vale - Alelo alimentação` | `vale_aleloalimentacao` |\n| `Vale - Alelo refeição` | `vale_alelorefeicao` |\n| `Vale - Ben alimentação` | `vale_benalimentacao` |\n| `Vale - Ben refeição` | `vale_benrefeicao` |\n| `Vale - Cooper card` | `vale_coopercard` |\n| `Vale - Green card` | `vale_greencard` |\n| `Vale - Refeisul` | `vale_refeisul` |\n| `Vale - Sodexo alimentação` | `vale_sodexoalimentacao` |\n| `Vale - Sodexo refeição` | `vale_sodexorefeicao` |\n| `Vale - Ticket restaurante` | `vale_ticketrestaurante` |\n| `Vale - Ticket alimentação` | `vale_ticketalimentacao` |\n| `Vale - Ticket refeição` | `vale_ticketrefeicao` |\n| `Vale - Usecred alimentação` | `vale_usecredalimentacao` |\n| `Vale - Usecred refeição` | `vale_usecredrefeicao` |\n| `Vale - Vale card` | `vale_valecard` |\n| `Vale - Verocard alimentação` | `vale_verocardalimentacao` |\n| `Vale - Verocard refeição` | `vale_verocardrefeicao` |\n| `Vale - Vr alimentação` | `vale_vralimentacao` |\n| `Vale - Vr refeição` | `vale_vrrefeicao` |\n| `Vale - Up alimentação` | `vale_upalimentacao` |\n| `Vale - Up refeição` | `vale_uprefeicao` |\n| `Vale - Personal alimentação` | `vale_personalalimentacao` |\n| `Vale - Personal refeição` | `vale_personalrefeicao` |\n| `Vale - Nutricard alimentação` | `vale_nutricardalimentacao` |\n| `Vale - Nutricard refeição` | `vale_nutricardrefeicao` |\n| `Vale - Banricard alimentação` | `vale_banricardalimentacao` |\n| `Vale - Banricard refeição` | `vale_banricardrefeicao` |\n| `Vale - Util alimentação` | `vale_utilalimentacao` |\n| `Vale - Util refeição` | `vale_utilrefeicao` |\n| `Vale - Pluxee alimentação` | `vale_pluxeealimentacao` |\n| `Vale - Pluxee refeição` | `vale_pluxeerefeicao` |\n| `Vale - Senff alimentação` | `vale_senffalimentacao` |\n| `Vale - Senff refeição` | `vale_senffrefeicao` |\n| `Ifood` | `ifood` |\n| `WhatsApp Pay` | `whatsapppay` |\n| `Cartão de crédito - Mercado Pago` | `mercadopago_cartao` |\n| `Cartão de crédito - Pagseguro` | `pagseguro` |\n| `Cartão de crédito - PicPay E-commerce` | `picpay_online` |\n| `Cartão de crédito - Cielo` | `cielo` |\n| `Cartão de crédito - Getnet` | `getnet_credito` |\n| `Cartão de débito - Getnet` | `getnet_debito` |\n| `Pix - Stone` | `stone` |\n| `Pix - Infopago` | `infopago` |\n| `Carteira (Google Pay/Apple Pay) - Stripe` | `stripe` |\n| `Pontos acumulados` | `pontos_acumulados` |\n\n### `ped_status` em consultas e listagens\n\n| Valor | Descrição |\n| --- | --- |\n| `ABE` | Aberto |\n| `AJU` | Ajuda |\n| `PEN` | Pendente |\n| `ACE` | Aceito |\n| `PRE` | Preparado |\n| `LOC` | No local |\n| `ENT` | Entregue |\n| `RET` | Retirado |\n| `COM` | Completo |\n| `AVA` | Avaliado |\n| `REJ` | Rejeitado |\n| `REG` | Região não atendida |\n| `DES` | Desistência |\n\n### `ped_status` em `PUT /pedidos_status/{ped_id}`\n\n| Valor | Descrição |\n| --- | --- |\n| `ABA` | Abandonado |\n| `ACE` | Aceito |\n| `PRE` | Preparado |\n| `LOC` | No local |\n| `ENT` | Entregue |\n| `RET` | Retirado |\n| `REJ` | Rejeitado |\n| `DES` | Desistência |\n\n### `ped_mercadopago_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `approved` | Aprovado |\n| `in_process` | Em processamento |\n| `rejected` | Rejeitada |\n\n### `ped_picpay_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `created` | Criado |\n| `expired` | Expirado |\n| `analysis` | Em análise |\n| `paid` | Pago |\n| `completed` | Completo |\n| `refunded` | Reembolsado |\n| `chargeback` | Chargeback |\n\n### `ped_pagseguro_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `1` | Aguardando pagamento |\n| `2` | Em análise |\n| `3` | Paga |\n| `4` | Disponível |\n| `5` | Em disputa |\n| `6` | Devolvida |\n| `7` | Cancelada |\n\n### `ped_cielo_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `0` | Não finalizada |\n| `1` | Autorizada |\n| `2` | Capturada |\n| `3` | Negada |\n| `10` | Cancelada |\n| `11` | Reembolsada |\n| `12` | Pendente |\n| `13` | Abortada |\n| `20` | Recorrência |\n\n### `ped_getnet_credito_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `0` | Não aprovada |\n| `1` | Aprovada |\n\n### `ped_getnet_debito_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `0` | Não aprovada |\n| `1` | Aprovada |\n\n### `ped_stone_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `processed` | Pendente |\n| `expired` | Expirado |\n| `paid` | Pago |\n| `failed` | Falhou |\n\n### `ped_infopago_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `processed` | Pendente |\n| `expired` | Expirado |\n| `paid` | Pago |\n| `failed` | Falhou |\n\n### `ped_stripe_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `processing` | Processando |\n| `refused` | Recusado |\n| `succeeded` | Pago |\n\n## Itens do pedido\n\n### `ite_modo_preco`\n\n| Valor | Descrição |\n| --- | --- |\n| `PAD` | Padrão |\n| `MED` | Média ponderada |\n| `MAI` | Maior preço |\n\n### `ite_modo_cadastro`\n\n| Valor | Descrição |\n| --- | --- |\n| `SIM` | Simplificado |\n| `AVA` | Avançado |\n\n### `ite_tipo_item`\n\n| Valor | Descrição |\n| --- | --- |\n| `NOR` | Item normal |\n| `PIZ` | Item pizza |\n\n### `per_formato`\n\n| Valor | Descrição |\n| --- | --- |\n| `UNI` | Única |\n| `MUL` | Múltipla |\n| `DIV` | Divisora |\n| `LIV` | Livre |\n\n## Fechamentos\n\n### `fec_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `PRE` | Pré-fechamento |\n| `EFE` | Efetuado |\n\n### `order_by`\n\n| Valor | Descrição |\n| --- | --- |\n| `fec_datacadastral` | Data cadastral |\n\n> Observação: no exemplo do endpoint aparece `fec-datacadastral`, mas a enumeração documentada usa `fec_datacadastral`. \n  \n\n### `order_direction`\n\n| Valor | Descrição |\n| --- | --- |\n| `ASC` | Ordenamento crescente |\n| `DESC` | Ordenamento decrescente |\n\n## Cardápio\n\n### `status` em `/cardapio_sku_status/{sku}` e `/cardapio_sku_status_lote`\n\n| Valor | Descrição |\n| --- | --- |\n| `ATI` | Ativo |\n| `SUS` | Suspenso |\n| `DES` | Desativado |\n| `BLO` | Bloqueado |\n\n## Conexões\n\n### `con_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `conectado` | Conectado |\n| `desconectado` | Desconectado |\n\n### `con_provedor`\n\n| Valor | Descrição |\n| --- | --- |\n| `WAPI` | WhatsApp Web Api |\n| `WABA_CLOUD` | WhatsApp Cloud Api |\n\n## Mensagens\n\n### `men_formato`\n\n| Valor | Descrição |\n| --- | --- |\n| `text` | Envio de texto simples |\n| `image` | Envio de imagem com texto |\n| `video` | Envio de vídeo com texto |\n| `audio` | Envio de áudio |\n| `voice` | Envio de voz |\n| `document` | Envio de documentos |\n\n## Afiliados\n\n### `est_status`\n\n| Valor | Descrição |\n| --- | --- |\n| `NOV` | Novo |\n| `FAL` | Falha |\n| `ATI` | Ativo |\n| `SUS` | Suspenso |\n| `BLO` | Bloqueado |\n| `CAN` | Cancelado |\n\n# Suporte técnico\n\nEm caso de dúvidas entre em contato por e-mail através do e-mail [<u>integracao@deeliv.app</u>](https://mailto:integracao@deeliv.app)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13864163","team":2244208,"collectionId":"c8c2c606-fc47-4f7b-bc0a-0b88ebb35779","publishedId":"2sA3JJ7h9i","public":true,"publicUrl":"https://documenter-api.postman.tech/view/13864163/2sA3JJ7h9i","privateUrl":"https://go.postman.co/documentation/13864163-c8c2c606-fc47-4f7b-bc0a-0b88ebb35779","customColor":{"top-bar":"E9EDF0","right-sidebar":"2E3C47","highlight":"20EB68"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/83f4e8dd-5707-467d-a91a-4844e1c09a18/ZmF2aWNvbiAoMTUpLnBuZw==","colors":{"top-bar":"2E3C47","right-sidebar":"2E3C47","highlight":"20EB68"}},{"name":"light","logo":"https://content.pstmn.io/83f4e8dd-5707-467d-a91a-4844e1c09a18/ZmF2aWNvbiAoMTUpLnBuZw==","colors":{"top-bar":"E9EDF0","right-sidebar":"2E3C47","highlight":"20EB68"}}]}},"version":"8.10.1","publishDate":"2026-03-13T20:46:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/83f4e8dd-5707-467d-a91a-4844e1c09a18/ZmF2aWNvbiAoMTUpLnBuZw==","logoDark":"https://content.pstmn.io/83f4e8dd-5707-467d-a91a-4844e1c09a18/ZmF2aWNvbiAoMTUpLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/041d24131923e2eb74d93580c9f2ea985f51d2a73be37f9c482bb7b08645dd45","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3JJ7h9i"}