book_order
Book a Royal Mail shipment via Click & Drop. Provide service, weight, recipient details, and optional parameters. Returns an order identifier to retrieve the postage label.
Instructions
Book a Royal Mail shipment via Click & Drop. Returns an orderIdentifier used to retrieve the label.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| service | Yes | Royal Mail / Parcelforce service. Defaults to first-class (OLP1) if omitted. Raw Service Register codes (e.g. OLP1, TOLP24, PFE48) are also accepted. | |
| packageFormat | No | Package format. Determines which services are available and pricing | small-parcel |
| weightGrams | Yes | Total weight in grams (e.g. 500 for 500g) | |
| recipient | Yes | Recipient / delivery address | |
| sender | No | Sender address. Omit to use the address saved in your Click & Drop account | |
| reference | No | Your internal order or job reference | |
| subtotal | No | Order subtotal in GBP (used for customs/insurance) | |
| shippingCost | No | Shipping cost charged to recipient in GBP | |
| total | No | Order total in GBP | |
| despatchDate | No | Planned despatch date YYYY-MM-DD. Omit if your account does not allow future-dated orders | |
| requireSignature | No | Request signature on delivery | |
| safePlace | No | Safe place instructions e.g. "leave in porch" | |
| notifyEmail | No | Email address for delivery notifications | |
| notifyPhone | No | Mobile number for SMS delivery notifications | |
| dimensions | No | Package dimensions in mm (optional) | |
| goodsDescription | No | Brief description of contents | |
| specialInstructions | No | Special handling instructions |