Create a prepared shipment (no label)
shipcloud_create_prepared_shipmentWRITE: save a shipment in shipcloud WITHOUT buying a label (create_shipping_label=false). Nothing is charged and no carrier is contacted; a prepared shipment can be deleted any time. Returns the shipment id. To buy the label use shipcloud_create_shipment_with_label. POST /shipments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Recipient full address (company or last_name needed). Read a saved address first to copy its fields. | |
| from | No | Sender full address. If omitted, shipcloud uses the default sender address of the account. | |
| carrier | Yes | Carrier acronym (shipcloud_list_carriers shows the ones this account can use). | |
| service | No | Service (default standard). Which services a carrier offers: shipcloud_list_carriers. | |
| packages | Yes | The packages (one entry for a single parcel). Several packages: only UPS supports them. | |
| description | No | Contents. Mandatory for UPS international/non-standard and DHL Express. Shipments that need a customs declaration (outside the EU) are not supported here: create them in the shipcloud backoffice. | |
| label_format | No | Label format, e.g. pdf_a6 or zpl2_4x6in_203dpi; carriers support different ones (shipcloud_list_carriers shows them per service). | |
| reference_number | No | Your own reference (max 30 characters), searchable later. | |
| notification_email | No | shipcloud emails this address on tracking updates. |