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. Deliveries

Change delivery statuses

AnteriorUpdate deliverySiguienteAssign driver

Última actualización hace 12 meses

You can use this endpoint to change the status of a delivery. Here you can add comments or include reasons for issues previously created in the system. To learn more about Shippify's statuses

Use cases

Update status by referenceId

You can use the delivery's reference ID in the URL of the request to change its status.

Cancel delivery
{
    "status": "canceled",
    "comment": "TEST",
    "author": {
        "email": "test@shippify.co",
        "id": 999,
        "name": "Test operator",
        "type": "operator"
    }
}
Change the status to "hold by courier" with a reason for the problem
{
    "status": "hold_by_courier",
    "comment": "South of the city",
    "reasonByCompany": [
        {
            "companyId": "9065",
            "reasonId": 67,
            "reason": "Risky area"
        }
    ],
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "developers@shippify.co"
    }
}
Complete a delivery
{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "developers@shippify.co"
    }
}
📄
click here.
  • PATCHUpdate the status of a delivery
  • Use cases

Update the status of a delivery

patch

Update the status of a delivery by its ID or reference.

Autorizaciones
Parámetros de ruta
idstringRequerido

Identifier or reference ID of the delivery to change 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/deliveries/{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"
}