Identifier Reference¶
Several fields across the API are called id or end in ...Id / ...Number, and they refer to different things at different stages of the flow. This page explains what each identifier means, where it comes from, and how it is labelled in the Evocative Ops portal, so you can map API values to the portal and troubleshoot more easily.
Identifiers along the booking flow¶
Each step of the Search → Quote → Book flow produces the identifier used by the next step:
| Stage | Identifier | Produced by | Consumed by |
|---|---|---|---|
| Search | package.id (a.k.a. packageId) | GET /api/v2/search / packages endpoints — the id on each package/rate | POST /api/v2/quote as packageId |
| Quote | packageBookingId | POST /api/v2/quote | POST /api/v2/book as packageBookingId |
| Book | booking.id (the order ID) | POST /api/v2/book | Bookings API, cancellation |
Booking identifiers¶
Once a booking is created, several identifiers describe it. They are not interchangeable except where noted:
| API field | Also known as | What it is | Evocative Ops portal |
|---|---|---|---|
booking.id | orderId, reservationId | The Evocative order identifier (GUID). Globally unique across all partners. This is "your order ID" — the value used as orderId in the Bookings API and in cancellation. reservationId (Order API) and orderId are the same value and are interchangeable. | Order / reservation |
booking.customerOrderId | customerOrderId, external reference | Your own order identifier, supplied by you (optionally) at the book step as customerOrderId. Also acts as an idempotency key. | Reference Number |
Look up a booking by your own ID or ours
GET /api/bookings/{orderId} accepts either the Evocative order ID (booking.id) or your own customerOrderId in the path — it also resolves referenceNumber and supplierReferenceNumber. Provide a unique customerOrderId per booking so a lookup by it returns a single result.
Property identifiers¶
| API field | What it is |
|---|---|
evocativeId | The current unique property identifier (e.g. R:54321). Use this everywhere a property is referenced — search ids, the packages path parameter, etc. |
hotel.id / property.id | DEPRECATED legacy numeric property identifier (e.g. 12345). Retained for backwards compatibility and will be removed in a future update; use evocativeId instead. |