Developers
English
English
  • 👋Welcome
  • 🛒E-commerce
    • Introduction
    • Shopify
      • Functionalities
      • Steps to integrate
      • User guide
      • FAQs
    • Mercado Livre
      • Functionalities
      • Steps to integrate
      • FAQs
    • Vtex
      • Funcionalities
      • Steps to integrate
      • FAQs
    • Beetrack
      • Funcionalities
      • Steps to integrate
      • FAQs
    • Prestashop
      • Functionalities
      • Steps to integrate
      • FAQs
  • 👨‍💻Integration Guide
    • Basic processes
      • Delivery creation
        • Dash
        • Import
        • Zapier
        • API
        • SFTP
        • Custom
      • Status update
        • Webhook subscriptions
        • Continuous Polling
        • Statuses
    • Advanced process
      • Interactive delivery tracking
      • Security
        • [2FA] Two Factor Authentication Method
        • Activate SAML SSO for a Company
  • 📄Shippify Api
    • First steps
    • Deliveries
      • Delivery creation
      • Delivery Quotes
      • Get delivery information
      • Update pickup point
      • Update delivery
      • Change delivery statuses
      • Assign driver
      • Print delivery labels
      • Get a tracking link
      • Attach documents to a delivery
    • Routes
      • Create route
      • Get route information
      • Add a delivery
      • Remove a delivery
      • Break a route
      • Change the status of a route
  • 📝Processes
    • Create a Shippify account
Con tecnología de GitBook
En esta página
  1. Shippify Api
  2. Routes

Change the status of a route

You can use this endpoint to change the status of all deliveries within a route.

AnteriorBreak a routeSiguienteCreate a Shippify account

Última actualización hace 12 meses

Use cases

Cancel a route
{
    "status": "canceled",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "developers@shippify.co"
    }
}
Complete a route
{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "developers@shippify.co"
    }
}
📄
  • PATCHUpdate the status of a route
  • Use cases

Update the status of a route

patch

Update the status of a route, including all its deliveries.

Autorizaciones
Parámetros de ruta
idstringRequerido

Identifier of the route to change its status.

Cuerpo
statusstring · enumRequerido

New status of the route

Example: hold_by_courierValores posibles:
commentstringRequerido

Comment of the change

Example: Dangerous area
Respuestas
200
Successful operation
application/json
401
Unauthorized
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: 209

{
  "status": "hold_by_courier",
  "comment": "Dangerous area",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "DANGEROUS AREA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "developers@shippify.co"
  }
}
{
  "code": "OK",
  "message": "Success"
}