Skip to content

Get canonical shipping status for a ticket

GET
/projects/{id}/tickets/{ticketId}/shipping
curl --request GET \
--url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tickets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/shipping \
--header 'Authorization: Bearer <token>'

Returns merge, deploy, and GitHub issue state for a ticket. Same JSON shape as the MCP ticket_shipping resource.

id
required
string format: uuid

Project UUID

ticketId
required
string format: uuid

Ticket UUID

Shipping status

Media type application/json
object
merged_at
required
string | null format: date-time
merge_sha
required
string | null
github_issue_state
required
string | null
github_issue_number
required
integer | null
github_issue_url
required
string | null
stage
required
string
status
required
string
deployed_at
required
string | null format: date-time
deploy_failed_at
required
string | null format: date-time
shipping_summary
required
string
merge_status_label
required

Human-readable merge state for UI and agents (e.g. Awaiting merge, No PR linked, Merged (abc1234)).

string

Not authenticated

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number
reconnect

True if re-linking GitHub may fix the issue

boolean

Forbidden

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number

Ticket not found