Skip to content

Templates

Contents 26 pages

A template is a shipment you send again and again: a lane and its freight, saved from a quote. It is the same list as Templates in the web app and in the ShipEasy app inside Shopify admin. A template never keeps a pickup day, a price or the consignee's details, and you can hold up to 100.

Rate one with Rate a template, and a past shipment with ship again.

Reading needs quotes:read; rating needs quotes:write; saving, renaming and deleting need addresses:write, as they need the address book permission in the web app. Both web app organizations and Shopify stores have templates.

List templates#

GET/api/v1/templatesScope quotes:read
Request
curl https://app.shipeasyco.com/api/v1/templates \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"
Response
{
	"object": "list",
	"data": [
		{
			"object": "template",
			"id": "cm5t2pl8x…",
			"name": "Weekly pallets to Rome",
			"lane": {
				"origin": {
					"label": "LA warehouse",
					"city": "Los Angeles",
					"state": "CA",
					"postal_code": "90021",
					"residential": false
				},
				"destination": {
					"city": "Rome",
					"state": "GA",
					"postal_code": "30165",
					"residential": false
				}
			},
			"handling_units": [
				{
					"package_type": "pallet",
					"quantity": "2",
					"length_in": "48",
					"width_in": "40",
					"height_in": "52",
					"weight_lbs": "650",
					"description": "Furniture"
				}
			],
			"created_at": "2026-11-12T16:20:05.000Z",
			"updated_at": "2026-11-12T16:20:05.000Z"
		}
	],
	"has_more": false,
	"next_cursor": null
}

Every template comes back in one page, newest edit first. lane is null when the saved request lacks a state or ZIP for either end.

Read one#

GET/api/v1/templates/{templateId}Scope quotes:read
Shell
curl https://app.shipeasyco.com/api/v1/templates/cm5t2pl8x… \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"

Save a template#

POST/api/v1/templatesScope addresses:write
Shell
curl https://app.shipeasyco.com/api/v1/templates \
  -H "Authorization: Bearer $SHIPEASY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quote_id": "cm5q0rate1…", "name": "Weekly pallets to Rome"}'

Any quote of yours works, booked or not: the template keeps the lane and freight it was rated for. A name is up to 80 characters. Holding 100 already is refused with validation_failed; delete one first.

Rename or delete#

PATCH/api/v1/templates/{templateId}Scope addresses:write
DELETE/api/v1/templates/{templateId}Scope addresses:write

PATCH takes {"name": "…"}; the lane and freight never change. DELETE removes the template for good; quotes already made from it keep their own copy.

Rate a template#

POST/api/v1/templates/{templateId}/quoteScope quotes:write
Shell
curl https://app.shipeasyco.com/api/v1/templates/cm5t2pl8x…/quote \
  -H "Authorization: Bearer $SHIPEASY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pickup_date": "2026-11-24"}'

Today's rates for the template's lane and freight, answered exactly as POST /quotes answers them and counted against the same daily quote budget. Both fields are optional: send {} for the earliest pickup day, and include_all_carriers: true to see every carrier's rate per service. Book a rate the way you book any other quote.

A template saved before its request could be read back is refused with validation_failed; quote the lane with POST /quotes instead.

In an AI app#

The tools are list_templates, get_template, save_template, rename_template, delete_template and quote_from_template (AI agents).