Skip to navigation

Create an Economy order

View as Markdown
Place an order for an Economy delivery. Provide one delivery location. Zippd selects the Economy hub that serves the delivery postcode and adds it as the collection location. Delivery is scheduled after all parcels have been scanned at the hub.

Authentication

AuthorizationBearer

Request

This endpoint expects an object.
payment_methodenumRequired
Select the method the API should use to process payment for this order.
Allowed values:
order_locationslist of objectsRequired
Provide exactly one delivery location. Zippd adds the collection location automatically.
itemslist of objectsRequired
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.
barcode_generationobjectOptional
Use this to prompt the system to generate barcodes as soon as the order is placed.
brandingobject or nullOptional
Provide basic branding details. If provided, these will be displayed on our delivery tracking screens.

Response

Created. The order awaits scans at the Economy hub before delivery is scheduled.
dataobject
The details of a delivery request placed by a user that sends items using the platform.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error