Update a Delivery Instruction | Zippd API

curl -X PATCH https://sandbox-api.deliveryapp.com/api/v1/deliveries/deliveryId/instruction \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instruction": "address"
}'

{
  "data": {
    "id": 1,
    "order_location_id": 1,
    "instruction": "address",
    "instruction_details": "string",
    "status": "order-received",
    "tracking_code": "DA6A3U7U-13447",
    "web_tracking_url": "https://www.zippd.com/tracking/?code=DA6A3U7U-13447&email=receipient@example.com",
    "recipient_address": {
      "address_line_1": "123 Grovesby Road",
      "address_line_2": "Billingham House, Flat 45",
      "city": "Manchester",
      "postcode": "M1 2AB",
      "latitude": 53.477582,
      "longitude": -2.255331
    },
    "recipient_details": {
      "contact_name": "Jane Doe",
      "phone_number": "07123456789",
      "email": "recipient@example.com",
      "company_name": "Example Company"
    },
    "sender_details": {
      "company_name": "Example Company",
      "logo_url": "https://yourcompany.com/assets/logo.png"
    },
    "driver": {
      "details": {
        "first_name": "string",
        "full_name": "string",
        "profile_image": "string",
        "has_uploaded_profile_image": true,
        "total_deliveries": 1,
        "average_rating": 4.56
      },
      "recent_location": {
        "latitude": 53.477582,
        "longitude": -2.255331
      },
      "distance": 12.84
    },
    "milestones": {
      "order-received": {
        "datetime": "2023-02-02 08:52:11"
      },
      "driver-on-the-way-to-pickup": {
        "datetime": "2023-02-02 10:21:35"
      },
      "driver-arrived-at-first-pickup": {
        "datetime": "2023-02-02 10:21:35"
      },
      "out-for-delivery": {
        "datetime": "2023-02-02 10:21:35",
        "driver_expected_from": "2023-02-02 13:12:00",
        "driver_expected_to": "2023-02-02 13:42:00"
      },
      "delivered": {
        "datetime": "2023-02-02 13:35:40",
        "proof_of_delivery": {
          "photo": "string",
          "signature": "string",
          "signer_name": "Jane Doe"
        }
      },
      "delivery-partially-successful": {
        "datetime": "2023-02-02 13:35:40",
        "undeliverables": {
          "[item barcode]": {
            "item_code": "DA003175021383000253",
            "reason": "Damaged in transit"
          }
        },
        "undeliverable_item_count": 1,
        "deliverable_item_count": 2,
        "total_item_count": 3,
        "proof_of_delivery": {
          "photo": "string",
          "signature": "string",
          "signer_name": "Jane Doe"
        }
      },
      "delivery-unsuccessful": {
        "datetime": "2023-02-02 13:35:40",
        "undeliverables": {
          "[item barcode]": {
            "item_code": "DA003175021383000253",
            "reason": "Damaged in transit"
          }
        }
      }
    },
    "review": {
      "rating": 5,
      "message": "string",
      "reviewer_name": "string",
      "created_at": "2023-03-09 16:08:45"
    }
  },
  "meta": {
    "all_safe_places": [
      "string"
    ],
    "all_statuses": [
      "string"
    ]
  }
}

Authentication

AuthorizationBearer

Path parameters

deliveryIdstringRequired

Request

instructionenumRequired

The key of the instruction to update this delivery to.

address: attempt delivery at the address provided.
safe-place: leave the items at the safe place given in the details field.

Allowed values:

detailsstringOptional<=255 characters

Details relevant to the instruction. For example, for safe-place, you would provide the details of the safe place; for address, you might include a gate code for the driver.

This field is required when instruction is safe-place. It can be set to null otherwise.

Response

dataobject

metaobject

Errors

404

Not Found Error

422

Unprocessable Entity Error