curl -H "X-API-Key: $GOMRY_RETAIL_API_KEY" \
"https://integration.example.com/api/vendor/v1/fulfilment?vendorKey=acme&vendorOrderId=ord_551204"
{
"vendorOrderId": "ord_551204",
"state": "ready",
"method": "eticket",
"tickets": [
{ "barcodeRef": "tkt_551204_1", "seat": "118-12-7" },
{ "barcodeRef": "tkt_551204_2", "seat": "118-12-8" }
]
}
{
"vendorOrderId": "ord_551377",
"state": "shipped",
"method": "physical",
"tickets": [],
"shipment": {
"carrier": "FedEx",
"trackingRef": "771234567890",
"shippedAt": "2026-10-02T15:10:00Z",
"eta": "2026-10-05T20:00:00Z"
}
}
{ "vendorOrderId": "ord_551204", "state": "pending", "tickets": [] }
Delivery
Fulfilment
Report whether an accepted order’s tickets can be retrieved yet
curl -H "X-API-Key: $GOMRY_RETAIL_API_KEY" \
"https://integration.example.com/api/vendor/v1/fulfilment?vendorKey=acme&vendorOrderId=ord_551204"
{
"vendorOrderId": "ord_551204",
"state": "ready",
"method": "eticket",
"tickets": [
{ "barcodeRef": "tkt_551204_1", "seat": "118-12-7" },
{ "barcodeRef": "tkt_551204_2", "seat": "118-12-8" }
]
}
{
"vendorOrderId": "ord_551377",
"state": "shipped",
"method": "physical",
"tickets": [],
"shipment": {
"carrier": "FedEx",
"trackingRef": "771234567890",
"shippedAt": "2026-10-02T15:10:00Z",
"eta": "2026-10-05T20:00:00Z"
}
}
{ "vendorOrderId": "ord_551204", "state": "pending", "tickets": [] }
Fulfilment
Answers one question about an accepted order: where is the actual ticket? Retail polls this every 10 minutes for every accepted order that has not been delivered, which is the window where a buyer has paid and holds nothing. Each system releases tickets differently: a document, a list of barcodes per seat, a transfer into an account, a parcel. Your integration translates that into one of the states below.References here, never the credential. This endpoint is polled and its results are logged. Return a pointer in
barcodeRef (an id or URL you can resolve later), never the scannable barcode itself. The barcode goes out once, through Credentials.Query Parameters
string
required
Your supplier identifier.
string
required
Your order id, from Place order.
404 if you do not know this order. Retail reads that as “not yet” and asks again. Any other failure is reported as a failure, never as “nothing to deliver”.
Response
string
required
The order asked about.
string
required
| Value | Meaning | What Retail does |
|---|---|---|
pending | Your system has the order, nothing is retrievable yet. Normal for hours. | Asks again later. |
ready | Tickets can be retrieved now. tickets must not be empty. | Marks the order delivered. The barcodes are then fetched through Credentials. |
not_retrievable | This delivery method never yields a credential Retail can hold, for example a transfer completed inside the box office’s own app. Not a failure. | Stops polling. |
shipped | A physical ticket is with a carrier. shipment must be present. | Records the tracking, keeps polling until delivery. |
delivered_physically | The carrier confirmed delivery. | Closes the order. |
unknown | You could not determine the state. | Changes nothing, asks again. |
array
default:"[]"
One entry per admission credential. Required and non-empty when
state is ready. Retail refuses a ready with no tickets, because that would mark an order delivered with nothing delivered.object
Required when
state is shipped.Show Shipment object
Show Shipment object
string
required
Carrier name, for example
FedEx.string
required
The tracking number. Never an admission credential. Do not put a tracking number in
barcodeRef: it would be rendered as a scannable code that admits nobody.string
ISO 8601 time the parcel was handed to the carrier.
string
ISO 8601 estimated arrival, if the carrier gives one.
string
The delivery format actually used, with the same values as
format on Listings. Kept for the audit trail.any
Your system’s payload, as evidence. Must not contain barcodes or buyer data.
curl -H "X-API-Key: $GOMRY_RETAIL_API_KEY" \
"https://integration.example.com/api/vendor/v1/fulfilment?vendorKey=acme&vendorOrderId=ord_551204"
{
"vendorOrderId": "ord_551204",
"state": "ready",
"method": "eticket",
"tickets": [
{ "barcodeRef": "tkt_551204_1", "seat": "118-12-7" },
{ "barcodeRef": "tkt_551204_2", "seat": "118-12-8" }
]
}
{
"vendorOrderId": "ord_551377",
"state": "shipped",
"method": "physical",
"tickets": [],
"shipment": {
"carrier": "FedEx",
"trackingRef": "771234567890",
"shippedAt": "2026-10-02T15:10:00Z",
"eta": "2026-10-05T20:00:00Z"
}
}
{ "vendorOrderId": "ord_551204", "state": "pending", "tickets": [] }