Place an Order | Zippd API

curl -X POST https://sandbox-api.deliveryapp.com/api/v1/orders-non-dedicated \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "product_code": "string",
  "payment_method": "da-credit",
  "order_locations": [
    {
      "is_collection": true,
      "address": {
        "phone_number": "07123456789",
        "email": "recipient@example.com"
      }
    }
  ]
}'

{
  "id": "string",
  "code": "DA9N3B6P",
  "type": "request",
  "fulfilment_date": "2023-01-15",
  "internal_ref": "string",
  "status": "accepted",
  "sub_status": "on-my-way",
  "total_items": 1,
  "started_at": "2023-01-11 08:30:15",
  "completed_at": "2023-01-11 08:30:15",
  "canceled_at": "2023-01-11 08:30:15",
  "additional_notes": "string",
  "cost_of_goods": 123456,
  "locations": [
    {
      "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",
      "delivery_instructions": "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
        }
      }
    }
  ],
  "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/order/5c1a370d-26eb-4afe-b18a-6f531dd00eb1"
}

Authentication

AuthorizationBearer

Request

This endpoint expects an object.

product_codestring or nullRequired<=250 characters

A product reference provided by your account manager.

payment_methodenumRequired

Select the method the API should use to process payment for this order.

Allowed values:

order_locationslist of objectsRequired

These are the pickup and drop-off locations for your delivery: the first object being pickup, the second is drop-off. Both are required.

internal_refstring or nullOptional<=250 characters

An order reference provided by your systems.

additional_notesstring or nullOptional

Additional information that will be seen by the delivery driver during order fulfilment.

itemslist of objectsOptional

barcode_generationobjectOptional

Use this to prompt the system to generate barcodes as soon as the order is placed.

brandingobjectOptional

Provide basic branding details. If provided, these will be displayed on our delivery tracking screens.

Response

Created

idstringOptionalformat: "uuid"

The ID of the order.

codestringOptional

Zippd's short ID code for the order. Unique, and always starts with two letter, e.g. "DA", "RE" etc.

typeenumOptional

The order type.

fulfilment_datedateOptional

The date on which the order will be fulfilled by the driver.

internal_refstring or nullOptional

An order reference provided by your systems.

statusenumOptional

The current status of the order.

sub_statusenum or nullOptional

The current sub-status of the order. The va sub_status will always be relative to the value of the status field.

total_itemsintegerOptional

The total number of items (or parcels) attributed to this delivery request.

started_atdatetime or nullOptional

Date/time when the delivery driver began fulfilling the delivery.

completed_atdatetime or nullOptional

Date/time when the delivery driver completed fulfilling the delivery.

canceled_atdatetime or nullOptional

Date/time when the delivery was cancelled.

additional_notesstringOptional

Additional information that will be seen by the delivery driver before and during order fulfilment.

cost_of_goodsintegerOptional

The total cost of goods being delivered. This will be in lowest unit of currency, e.g. in pence for GBP.

locationslist of objectsOptional

All locations relating to this order's deliveries. The first item is always the location where the driver will pickup the parcels to be delivered.

barcodeslist of objectsOptional

A list of barcodes (parcels) that are to be delivered on with this order.

printable_label_urlstring or nullOptional

An absolute URL to a PDF with all package labels for this order.

Errors

422

Unprocessable Entity Error