Skip to main content

Box (Package & Parcel Delivery)

Box tools handle parcel and package delivery services. All tools are prefixed box_. Only delivery (business_type=send) is enabled for now — buy (Box Purchase) is a documented value but not yet live.

ToolPurposeKey parameters
box_get_vehicle_typesAvailable vehicle types for delivery (returns cct_id per type)pickup_latitude, pickup_longitude, dropoff_latitude, dropoff_longitude, business_type (send)
box_pre_checkoutPre-checkout validation, pricing, and available payment methodspickup_latitude, pickup_longitude, dropoff_latitude, dropoff_longitude, cct_id (from box_get_vehicle_types), optional pickup_location_id?, dropoff_location_id?, pickup_name?, dropoff_name?, instructions?, package_category_id?
box_get_configService configuration and settingslatitude, longitude, business_type (send)
box_get_categoriesAvailable parcel categories (returns id per category to use as package_category_id)latitude, longitude, business_type (send)
box_create_order ⚠️Create a parcel delivery orderpickup_latitude, pickup_longitude, pickup_location_id, dropoff_location_id, cct_id, payment_type (cash | card | wallet), optional instructions?, package_category_id?, payment_id? (required when payment_type is card)
Flow
  1. box_get_config — confirm service_status is AVAILABLE for the pickup area (business_type=send) before going further.
  2. box_get_vehicle_types — list vehicle types for the pickup_latitude/pickup_longitude + dropoff_latitude/dropoff_longitude pair; get each option's cct_id.
  3. box_get_categories (optional) — list parcel categories; get the chosen category's id to use as package_category_id.
  4. box_pre_checkout — pass the chosen cct_id (+ package_category_id if set) to get pricing and user_available_payment_methods; let the user pick a payment method, never auto-select.
  5. box_create_order ⚠️ — place the order with the same cct_id, pickup_location_id/dropoff_location_id, and the chosen payment_type (+ payment_id if card).