Create pickup order
deftship_create_pickup_orderCreate a pickup order with carrier, addresses, and package details. Returns the order object with ID, ready for booking via arrange pickup.
Instructions
Create a pickup order visible on the Pickup Orders page. Returns the full pickup order object including its id. Use deftship_arrange_pickup to actually book it with the carrier.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Existing pickup order id to update. | |
| pieces | Yes | Pickup pieces. | |
| carrier | Yes | Pickup carrier, e.g. 'ups', 'usps', 'dhl'. | |
| close_time | No | Closing time H:i. Required for UPS. | |
| ready_time | No | Opening time H:i. Required for UPS. | |
| pickup_date | No | Proposed pickup date, format Y-m-d. Not required when carrier is 'dhl'. | |
| from_address | No | Sender address. Required if from_address_id is not given. | |
| from_address_id | No | Saved sender address id. Provide this OR from_address. |