Aller au contenu principal

Update Booking Proof of Delivery

Available Statuses​

Possible statuses associated to a booking.

  • accepted
  • arrived_dropoff
  • arrived_pickup
  • at_collection_depot
  • at_final_depot
  • at_shift_depot
  • attempted_delivery
  • available_for_collection
  • broken_data
  • cny_dropoff_failed
  • cny_overflow_availability
  • cny_overflow_size
  • cancelled
  • collection_customer_not_home
  • collection_summary_received
  • completed
  • completed_left_safe
  • completed_left_with_neighbour
  • customer_not_home
  • customer_no_show
  • customer_viewed_codes
  • damaged_goods
  • declined
  • delivery_expired
  • extended_window
  • failed_delivery
  • failed_delivery_customer_not_home
  • failed_delivery_damaged_goods
  • items_not_loaded
  • left_depo
  • missing_goods
  • nothing_to_collect
  • on_route_to_collection_depot
  • on_route_to_dropoff
  • on_route_to_pickup
  • on_route
  • pending
  • pending_arrival
  • refused_missing_goods
  • scheduled
  • unserviceable
  • upgraded_to_delivery

Authorisation​

Authentication is performed by Bearer token in the Authorization HTTP header. 'Authorization: Bearer <your_token>'

replace <your_token> with a token generated as follows

base64("<email>:<password>") where these are you normal user credentials

Request Example​

Method: POST

URL: https://api.shift.online/public-updates/update-booking

Body:

status: string (one of available statuses)

id: string (ID reference of booking)

file: file (images only accepted)

Request Example

curl --location 'https://api.shift.online/public-updates/update-booking' \
--header 'Authorization: Bearer YmVuamFtaW4uc2hlcGhlcmRAc2hpZnQub25saW5lOjEyMzQ1Ng==' \
--form 'status="on_route_to_dropoff"' \
--form 'file=@"/Users/your_username/ExampleFile.jpg' \
--form 'id="REPLACE_WITH_BOOKING_ID"'

Response Successful

Status Code: 200

Response Body:

{
    "status": 1
}

Response Unauthorized

Status Code: 401

Response Body:

{
   "message": "Unauthorized (401)"
}

Response Validation Error

Status Code: 422

Response Body Example:

{
    "message": "The given data was invalid.",
    "errors": {
        "file": [
            "The file must be an image."
        ]
    }
}

Response Unknown Error

Status Code: 500

Response Body:

{
   "message": "Something went wrong."
}