Add a Location to an Order | Zippd API

curl -X POST https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "address": {
    "address_line_1": "123 Grovesby Road",
    "city": "Manchester",
    "postcode": "M1 2AB",
    "latitude": 53.477582,
    "longitude": -2.255331,
    "contact_name": "Jane Doe",
    "phone_number": "07123456789",
    "email": "recipient@example.com"
  }
}'

{
  "data": {
    "id": 24013,
    "delivery_id": 5146,
    "time_from": "11:00:00",
    "time_to": "11:30:00",
    "tracking_code": "DA6A3U7U-13447",
    "web_tracking_url": "https://www.zippd.com/tracking/?code=DA6A3U7U-13447&email=recipient@example.com",
    "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
    },
    "contact_details": {
      "contact_name": "Jane Doe",
      "phone_number": "07123456789",
      "email": "contact@example.com",
      "company_name": "Example Company"
    },
    "driver_arriving_time": "2023-01-11 11:15:08",
    "driver_leaving_time": "2023-01-11 11:21:37",
    "requires_handballing": true,
    "total_items": 1,
    "instruction": "address",
    "instruction_details": "string",
    "what3words": "issued.assure.courier",
    "client_system_delivery_id": "string",
    "barcodes": [
      {
        "code": "DA021758014227000253",
        "code_formatted": "DA 021758 014227 000253",
        "order_location_id": 1,
        "pickup_latitude": 53.477582,
        "pickup_longitude": -2.255331,
        "pickup_datetime": "2023-01-09 11:05:55",
        "drop_off_latitude": 53.612242,
        "drop_off_longitude": -2.152356,
        "drop_off_datetime": "2023-01-09 12:36:27",
        "undeliverable": true,
        "undeliverable_reason": "Could not gain access to location",
        "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/barcode/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/DA021758014227000253",
        "created_at": "2023-01-05 09:00:00",
        "updated_at": "2023-01-05 09:00:00"
      }
    ],
    "printable_label_url": "https://sandbox-api.deliveryapp.com/package-label/print/location/5c1a370d-26eb-4afe-b18a-6f531dd00eb1/24013",
    "proof_of_delivery": {
      "photo": "string",
      "signature": "string",
      "signer_name": "Jane Doe",
      "coordinates": {
        "latitude": 53.477582,
        "longitude": -2.255331
      }
    }
  },
  "links": {
    "[link_object_id]": {
      "rel": "package-label",
      "href": "https://sandbox-api.deliveryapp.com/api/v1/package-label/print/location/120",
      "method": "GET"
    }
  }
}

Authentication

AuthorizationBearer

Path parameters

orderIdstringRequired

Request

This endpoint expects an object.

addressobjectRequired

item_countintegerOptional0-15

The total number of items being delivered to this location.

cost_of_goodsintegerOptional>=100

The total value (or a rough estimate) of all goods being delivered to this location. Value must be in lowest unit of currency, i.e. in pence for GBP.

Defaults to 0 if not provided. Required if item_count is not empty.

Response

dataobject

The data of a location that has been added as a point to an order.

linksobject

Errors

403

Forbidden Error

422

Unprocessable Entity Error