Skip to main content
Shipping tools are write tools. They create and cancel real records and can charge your FreightPOP account.

​
freightpop_create_shipment

Books a real shipment with a carrier through your FreightPOP account. Two ways to call it:
  • With a quote: pass the quote ID and rate ID from a prior get_rates call. This is the normal path.
  • Without a quote: pass a carrier ID, line items, and a payment term to ship directly.
Details:
  • Type: Write
  • Example prompt: “Book the cheapest quote from that list.”
  • Example prompt: “Ship this with XPO, prepaid, and email the notification to ops@example.com.”

​
What happens on success

  • A shipment record is created in FreightPOP.
  • The selected carrier receives the booking.
  • Your account is charged per your normal FreightPOP billing terms.
  • Tracking becomes available via get_tracking once the carrier posts the first event.
  • If you asked for one, a ZPL shipping label is returned in the response.

​
freightpop_cancel_shipment

Cancels an existing shipment by its FreightPOP shipment ID.
  • Type: Write (destructive)
  • Example prompt: “Cancel shipment 1234567890.”
If the cancellation fails, the response says so rather than silently doing nothing. Check the shipment in the FreightPOP web app before retrying.