Add more shipments to an existing batch. The batch must not be validating, processing or completed. Batch returns to 'validating' while new items are checked.

Book a previously created pickup order with the carrier. Returns the pickup confirmation number (prn). May charge your balance depending on carrier. Requires confirm=true.

Purchase a previously quoted insurance by insurance_id. THIS CHARGES YOUR BALANCE. Requires confirm=true.

Return your organisation's current Deftship balance and currency. Useful before shipping to confirm there are enough funds.

Create a shipment batch (beta; own-USPS-account only) with up to 1,000 shipments that share a shipper and service. Items are validated asynchronously; poll deftship_get_batch until status is 'ready', then deftship_ship_batch. Does not spend money yet.

Create a draft freight order visible on the Open Orders page. Does not purchase. Returns the shipment_order_id. Pass shipment_order_id to update an existing draft.

Create a draft parcel order that appears on the Open Orders page in the dashboard. Does not purchase a label. Returns the shipment_order_id. Pass shipment_order_id to update an existing draft.

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.

Open a support ticket against existing shipments (e.g. a claim or issue) by tracking number. Some ticket types carry a fee. Provide ticket_type_id, a reference, a message and the related tracking numbers.

Fetch your saved addresses. Use destination 'from' for sender addresses or 'to' for recipient addresses. Returns address records with their ids for use as from_address_id / to_address_id.

Fetch a batch's status, validation results, per-item details and (when completed) merged label PDF URLs. Optionally filter items by status: valid, invalid, completed, failed.

Check the current operational status of a carrier (e.g. known outages or degraded service).

Fetch a freight order's BOL number, label, POD and confirmed pickup window, either by shipment_order_id or by bol_number. Provide exactly one identifier.

Quote LTL/FTL freight rates from all allowed carriers. Returns rates each with an id (rate_id) to ship, carrier, service, final_price, load_type (ltl/ftl), is_guaranteed, and has_enough_credits. Does not spend money.

Quote insurance for a shipment. Creates an insurance record and returns its id (insurance_id) and price. Use deftship_book_insurance with the id to purchase. Does not spend money.

Fetch a parcel order's status, tracking numbers and label URL, either by shipment_order_id or by tracking_number. Use this to poll for a label after shipping and to track a shipment. Provide exactly one of the two identifiers.

Quote parcel shipping rates from all allowed carriers for a given from/to address and package list. Returns a list of rates, each with an id (rate_id) used to ship, carrier, service, final_price, eta, and has_enough_credits. Does not spend money. Optionally pass carrier to restrict to one carrier and speed up the response.

Fetch a previously created pickup order by id, including pieces and status.

Quote a carrier pickup. Returns the pickup order id plus base_price, fuel_price and final_price. Does not spend money.

List available carrier services and their service codes. Use type 'shipment' for parcel/freight services or 'pickup' for pickup services.

List draft parcel orders imported from connected e-commerce platforms (50 per page). Supports optional date range, platform and order_number filters. Rate limited to 20/min.

Mark draft orders as shipped outside of Deftship (e.g. shipped with another provider). Optionally push fulfillment back to the connected e-commerce platform. Each order is identified by id or ecommerce_id (not both).

Merge multiple already-generated parcel labels into a single PDF. Returns the merged label URL. Only works for labels that already exist.

Remove specific items from a batch by their item hash ids (max 10,000). Also deletes the associated shipment orders. The batch must not be validating, processing or completed.

Ship all valid items in a batch. The batch must be in 'ready' status. THIS CHARGES YOUR BALANCE for every item in the batch. Processing is asynchronous; poll deftship_get_batch for labels. Requires confirm=true.

Book a freight shipment using a rate_id from deftship_get_freight_rates. THIS CHARGES YOUR BALANCE. The BOL and label are delivered asynchronously to your token's webhook, or retrieved later with deftship_get_freight. Requires confirm=true.

Purchase a parcel label using a rate_id from deftship_get_parcel_rates. THIS CHARGES YOUR BALANCE. The label and tracking numbers are delivered asynchronously to your token's webhook, or retrieved later with deftship_get_parcel. Requires confirm=true.

Validate an address before shipping to avoid correction surcharges. Returns suggested/corrected address candidates and whether the address is residential.

Void a previously created freight order by shipment_order_id. May incur a void_fee. Requires confirm=true.

Void a previously booked insurance by insurance_id. Requires confirm=true.

Void a previously created parcel order by shipment_order_id. May incur a void fee (returned as void_fee). Requires confirm=true.

Void a previously created pickup order by id. Requires confirm=true.