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.

AttributeTypeDescription
order_referencestringIdentifier for the order in the user's system.
tracking_numberstringTracking number, consignment number, or barcode of the order.
carrier_namestringName of the carrier used for shipment pickup and delivery.
sender_accountstringSender account held with the target carrier.
receiver_accountstringReceiver account held with the target carrier when payer is receiver.
pickup_timeslot_startdatetimeEarliest time the order can be picked up in UTC.
pickup_timeslot_enddatetimeLatest time the order can be picked up in UTC. Ignored by some carriers.
pickup_timezone_idstringWindows timezone identifier for the pickup location.
special_instructionsstringPickup instructions, for example Use side door.
sender_addressPickup Address ModelAddress where the order is being sent from.
collection_addressPickup Address ModelAddress where the order is being collected from.
receiver_addressPickup Address ModelAddress where the order is to be delivered.
packaging_codestringPackaging code, for example Satchel, Bag, or Carton.
service_codestringCarrier service code for the pickup.
dangerous_goodsbooleanIndicates if the shipment contains dangerous goods.
dangerous_goods_unstringUN number related to dangerous goods.
dangerous_goods_packing_groupstringPacking group related to dangerous goods.
payerstringWho pays for delivery of the order, sender or receiver.
package_countintegerTotal number of packages being collected.
consignment_countintegerTotal number of consignments being collected.
total_weightdecimalTotal combined weight of packages being collected.
max_package_lengthdecimalLength of the largest package in centimetres.
max_package_widthdecimalWidth of the largest package in centimetres.
max_package_heightdecimalHeight of the largest package in centimetres.
max_package_weightdecimalWeight of the largest package in kilograms.
shipment_idsinteger listShipment ids to pass when the carrier needs shipment information for pickup.
is_returnbooleanIndicates if the request is for a return order.