Skip to content

Support

Contents 26 pages

Your conversations with ShipEasy's team, the same ones as Help in the web app and in the ShipEasy app inside Shopify admin: read them, open one, and reply. Feedback, a White Glove ask and the bell's notices live here too.

Reading needs support:read; opening, replying, feedback, White Glove and marking notices read need support:write. Both web app organizations and Shopify stores have them.

An organization's key opens cases, replies and sends feedback as the member behind it, so our team's replies reach that person by email, as on the web app. A key with no member behind it posts under the organization's name, and nobody is emailed.

List cases#

GET/api/v1/support/casesScope support:read
Request
curl https://app.shipeasyco.com/api/v1/support/cases \
  -H "Authorization: Bearer $SHIPEASY_API_KEY"
Response
{
	"object": "list",
	"data": [
		{
			"object": "support_case",
			"id": "cm6c1as9e…",
			"reference": "CASE-4KQ7",
			"category": "delivery_delay",
			"status": "awaiting_merchant",
			"shipment_id": "cm2k8x7d2…",
			"shipment_reference": "SHP-7KD2Q",
			"created_at": "2026-11-17T14:02:11.000Z",
			"last_message_at": "2026-11-18T09:40:03.000Z",
			"message_count": 3,
			"awaiting_you": true
		}
	],
	"has_more": false,
	"next_cursor": null
}

The recent 50, newest activity first. awaiting_you is true when our team replied last and waits on your answer.

Read one#

GET/api/v1/support/cases/{caseId}Scope support:read

The case plus messages, oldest first, each with from (you or shipeasy), body and created_at. A message never names who wrote it.

Open a case#

POST/api/v1/support/casesScope support:write
Shell
curl https://app.shipeasyco.com/api/v1/support/cases \
  -H "Authorization: Bearer $SHIPEASY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category": "delivery_delay", "shipment_id": "cm2k8x7d2…", "message": "It was due Tuesday and has not moved since."}'

category is one of delivery_delay, missed_pickup, damage_claim, wrong_address, change_cancel, tracking, billing_question, manual_quote (a quote no carrier rates, such as Hawaii or Alaska) and other. shipment_id is optional. Each case or reply reaches our team at once, so there are at most 10 in five minutes; over it, 429 rate_limit_exceeded. The Idempotency-Key is required: a retry never posts twice.

Reply#

POST/api/v1/support/cases/{caseId}/messagesScope support:write

Takes {"message": "…"} and answers the case as it now stands. Replying on a resolved case opens it again.

Feedback#

POST/api/v1/feedbackScope support:write

ratings holds 1 to 5 for any of ease_of_use, rate_accuracy and the other areas the app asks about, and comment anything else.

Ask for White Glove#

POST/api/v1/white_glove_requestsScope support:write

The questions the web app asks before White Glove is opened: assembly_profile, categories, other_description (when categories holds other) and catalog_url. Some answers decline at once, and the answer says why in reasons; the rest go to our team, and status is pending. Asking again while one is pending or approved changes nothing.

Notices#

GET/api/v1/notificationsScope support:read
POST/api/v1/notifications/readScope support:write

The bell's feed, the recent 50, each with a title in words, and read_at while read. POST /notifications/read takes ids, or all: true. A store's key reads the store's feed. A web app notice belongs to one person, so an organization's key reads the feed of the member behind it, with what the key's scopes allow; a key with no member behind it gets insufficient_scope.

In an AI app#

The tools are list_support_cases, get_support_case, open_support_case, reply_support_case, send_feedback, request_white_glove, list_notifications and mark_notifications_read (AI agents).