Developers
Português
Português
  • 👋Bem vindos
  • 🛒E-commerce
    • Introdução
    • Shopify
      • Funcionalidades
      • Passos para integrar
      • Manual de Usuario
      • Perguntas frequentes
    • Mercado Livre
      • Funcionalidades
      • Passos para integrar
      • Perguntas frequentes
    • Vtex
      • Funcionalidades
      • Passos para integrar
      • Perguntas frequentes
    • Beetrack
      • Funcionalidades
      • Passos para integrar
      • Perguntas frequentes
    • Prestashop
      • Funcionalidades
      • Passos para integrar
      • Perguntas frequentes
  • 👨‍💻Guia de Integração
    • Processos Básicos
      • Criação de entregas
        • Dash
        • Importando
        • Zapier
        • API
        • SFTP
        • Personalizada
      • Atualização de estados
        • Subscrições a webhooks
        • Polling Contínuo
        • Estados
    • Processos Avançados
      • Rastreamento interativo das entregas
      • Segurança
        • [2FA] Método de autenticação de dois fatores
        • Ativar SAML SSO para uma Empresa
  • 📄Shippify Api
    • Primeiros passos
    • Entregas
      • Criação de entregas
      • Cotação de entregas
      • Obter informação de uma entrega
      • Modificar coleta
      • Modificar entrega
      • Alterar estados de entrega
      • Atrelar motorista
      • Imprimir etiquetas da entrega
      • Obter link de rastreamento
      • Anexar documentos à entrega
    • Rotas
      • Criar rota
      • Obter informação da rota
      • Adicionar entrega
      • Eliminar entrega
      • Quebrar rota
      • Alteração de estado da rota
  • 📝Procesos
    • Criando uma conta Shippify
Con tecnología de GitBook
En esta página
  1. Shippify Api
  2. Rotas

Alteração de estado da rota

Você pode usar este endpoint para alterar o estado de todas as entregas de uma rota.

AnteriorQuebrar rotaSiguienteCriando uma conta Shippify

Última actualización hace 10 meses

Casos de uso

Cancelar rota
{
    "status": "canceled",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "developers@shippify.co"
    }
}
Completar rota
{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "developers@shippify.co"
    }
}
📄
  • PATCHAtualiza o estado de uma rota
  • Casos de uso

Atualiza o estado de uma rota

patch

Atualiza o estado de uma rota, incluindo todas suas entregas.

Autorizaciones
Parámetros de ruta
idstringRequerido

Identificador da rota a alterar o estado.

Cuerpo
statusstring · enumRequerido

Novo estado da rota.

Example: hold_by_courierValores posibles:
commentstringRequerido

Comentário da alteração

Example: Zona de perigo.
Respuestas
200
Operação bem sucedida.
application/json
401
Não autorizado
application/json
patch
PATCH /v1/routes/{id}/status HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "status": "hold_by_courier",
  "comment": "Zona de perigo.",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "ZONA  DE PERIGO"
    }
  ],
  "author": {
    "type": "operador",
    "id": 1149,
    "name": "Developers",
    "email": "developers@shippify.co"
  }
}
{
  "code": "OK",
  "message": "Successo"
}