For the complete documentation index, see llms.txt.
Models
Starshipit API model
Book Pickup Request Model
Field names, types, and descriptions for this shared API model.
27 fields
Referenced models
These fields use another model for their nested structure.
| Attribute | Type | Description |
|---|---|---|
| order_reference | string | Identifier for the order in the user's system. |
| tracking_number | string | Tracking number, consignment number, or barcode of the order. |
| carrier_name | string | Name of the carrier used for shipment pickup and delivery. |
| sender_account | string | Sender account held with the target carrier. |
| receiver_account | string | Receiver account held with the target carrier when payer is receiver. |
| pickup_timeslot_start | datetime | Earliest time the order can be picked up in UTC. |
| pickup_timeslot_end | datetime | Latest time the order can be picked up in UTC. Ignored by some carriers. |
| pickup_timezone_id | string | Windows timezone identifier for the pickup location. |
| special_instructions | string | Pickup instructions, for example Use side door. |
| sender_address | Pickup Address Model | Address where the order is being sent from. |
| collection_address | Pickup Address Model | Address where the order is being collected from. |
| receiver_address | Pickup Address Model | Address where the order is to be delivered. |
| packaging_code | string | Packaging code, for example Satchel, Bag, or Carton. |
| service_code | string | Carrier service code for the pickup. |
| dangerous_goods | boolean | Indicates if the shipment contains dangerous goods. |
| dangerous_goods_un | string | UN number related to dangerous goods. |
| dangerous_goods_packing_group | string | Packing group related to dangerous goods. |
| payer | string | Who pays for delivery of the order, sender or receiver. |
| package_count | integer | Total number of packages being collected. |
| consignment_count | integer | Total number of consignments being collected. |
| total_weight | decimal | Total combined weight of packages being collected. |
| max_package_length | decimal | Length of the largest package in centimetres. |
| max_package_width | decimal | Width of the largest package in centimetres. |
| max_package_height | decimal | Height of the largest package in centimetres. |
| max_package_weight | decimal | Weight of the largest package in kilograms. |
| shipment_ids | integer list | Shipment ids to pass when the carrier needs shipment information for pickup. |
| is_return | boolean | Indicates if the request is for a return order. |