Cvent Orders API
Orders represent a collection of order items purchased by an attendee. Use these APIs to get information about orders and order items.
Orders represent a collection of order items purchased by an attendee. Use these APIs to get information about orders and order items.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cvent-orders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.0.2
info:
title: Cvent REST APIs — Orders
version: ea
description: Orders represent a collection of order items purchased by an attendee. Use these APIs to get information about
orders and order items.
contact:
name: Cvent Development Platform
url: https://developers.cvent.com/
externalDocs:
description: Cvent REST API documentation
url: https://developers.cvent.com/documentation
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Orders
description: Orders represent a collection of order items purchased by an attendee. Use these APIs to get information about
orders and order items.
paths:
/orders:
get:
security:
- OAuth2.clientCredentials:
- event/orders:read
- OAuth2.authorizationCode:
- event/orders:read
summary: List Account Orders
description: 'Gets a paginated list of orders in the account. Results are returned in ascending `lastModified` order,
with a stable internal tie-breaker applied to guarantee a deterministic total order across pages. Ordering is not
client-configurable. Newly created or updated orders may not be immediately reflected in the response.
'
operationId: getAccountOrders
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|--------------|------------------------------------|
| id | `eq`, `ne` |
| attendee.id | `eq`, `ne` |
| event.id | `eq`, `ne` |
| type | `eq`, `ne` |
| created | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |
| lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |
The following logical operators are supported for combining filters:
* and
* or
'
schema:
type: string
example: filter=event.id eq '7e8a9c45-2f1b-4d3e-9a67-8b5c4f2e1a90'
- $ref: '#/components/parameters/deleted'
tags:
- Orders
responses:
'200':
description: Successfully retrieved a Paginated list of Orders in the account.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/order-details-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'429':
$ref: '#/components/responses/TooManyRequests1'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/orders/{orderId}:
get:
security:
- OAuth2.clientCredentials:
- event/orders:read
- OAuth2.authorizationCode:
- event/orders:read
summary: Get Order
description: Gets the order for a given orderId. Newly created or updated orders may not be immediately reflected in
the response.
operationId: getAccountOrderById
parameters:
- $ref: '#/components/parameters/orderId'
tags:
- Orders
responses:
'200':
description: Successfully retrieved the order for a given orderId.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/order-detail'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'404':
$ref: '#/components/responses/NotFound1'
'429':
$ref: '#/components/responses/TooManyRequests1'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/orders/{orderId}/items:
get:
security:
- OAuth2.clientCredentials:
- event/orders:read
- OAuth2.authorizationCode:
- event/orders:read
summary: List Account Order Items
description: 'Gets a paginated list of order items for a given orderId in the account. Results are returned in ascending
`lastModified` order, with a stable internal tie-breaker applied to guarantee a deterministic total order across pages.
Ordering is not client-configurable. Newly created or updated order items may not be immediately reflected in the
response.
'
operationId: getAccountOrderItemsByOrderId
parameters:
- $ref: '#/components/parameters/orderId'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|--------------|------------------------------------|
| id | `eq`, `ne` |
| product.id | `eq`, `ne` |
| product.type | `eq`, `ne` |
| created | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |
| lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |
The following logical operators are supported for combining filters:
* and
* or
'
schema:
type: string
example: id eq 'f82ea335-3844-47bf-92f6-4e00d60f7800' AND (created lt '2025-08-19T20:43:13.000Z' OR created gt '2023-08-19T20:43:13.000Z')
- $ref: '#/components/parameters/deleted'
tags:
- Orders
responses:
'200':
description: Successfully retrieved a Paginated list of order items for a given orderId in the account.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/order-items-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'404':
$ref: '#/components/responses/NotFound1'
'429':
$ref: '#/components/responses/TooManyRequests1'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/orders/{orderId}/items/{orderItemId}:
get:
security:
- OAuth2.clientCredentials:
- event/orders:read
- OAuth2.authorizationCode:
- event/orders:read
summary: Get Order Item
description: Gets a order item for a given orderItemId in the account. Newly created or updated order items may not
be immediately reflected in the response.
operationId: getAccountOrderItem
parameters:
- $ref: '#/components/parameters/orderId'
- $ref: '#/components/parameters/orderItemId'
tags:
- Orders
responses:
'200':
description: Successfully retrieved an order item for a given orderItemId for a given orderId in the account.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/order-item-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'404':
$ref: '#/components/responses/NotFound1'
'429':
$ref: '#/components/responses/TooManyRequests1'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
components:
schemas:
Link:
title: Link
required:
- href
type: object
description: Represents a link to a related resource.
properties:
href:
type: string
description: A url provided that can be followed for linking
example: ?token=90c5f062-76ad-4ea4-aa53-00eb698d9262
order-item-response:
title: OrderItem
type: object
description: This is used to denote an item in the order
allOf:
- $ref: '#/components/schemas/Audit'
properties:
id:
$ref: '#/components/schemas/uuid-property'
order:
$ref: '#/components/schemas/OrderRef'
event:
$ref: '#/components/schemas/Event'
attendee:
$ref: '#/components/schemas/Attendee'
guest:
type: boolean
description: Indicates if an attendee is a guest
example: true
guestDetail:
$ref: '#/components/schemas/Guest'
product:
$ref: '#/components/schemas/ProductOrderItem'
active:
type: boolean
description: Indicates if the order item is active
example: true
name:
type: string
description: This denotes the name of the item
maxLength: 100
example: Dinner Session
price:
type: number
description: Price of the item
example: 15.35
fee:
$ref: '#/components/schemas/Fee'
quantity:
type: integer
description: Quantity of item purchased by an attendee.
example: 2
amountOrdered:
type: number
description: Total amount for the item purchased by the attendee.
example: 35.35
amountPaid:
type: number
description: Amount paid by the attendee.
example: 10.15
amountDue:
type: number
description: Amount due on the order item.
example: 25.2
productPriceTierAmount:
type: number
description: Cost of item at current/early bird price
example: 15.35
tiered:
type: boolean
description: Indicates if the order item is tiered
example: true
generalLedgerItems:
type: array
description: The list of general ledger details in an order item.
items:
$ref: '#/components/schemas/GeneralLedger'
discounts:
type: array
description: The list of discount details.
items:
$ref: '#/components/schemas/DiscountDetail'
deleted:
type: boolean
description: True indicates the order item has been deleted.
example: false
Attendee:
type: object
description: The reference to the attendee. Contains only the ID of the attendee.
title: Attendee
required:
- id
properties:
id:
type: string
format: uuid
description: Unique identifier of the primary invitee for the current attendee's registration.
example: 5b0e8d1f-8fd6-4ebe-977a-602b4a1f9c43
uuid-property:
title: UUID Property
description: A string that has to be a format matching the industry standard uuid
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
ProductOrderItem:
title: ProductOrderItem
type: object
description: This is used to denote the product details in an order item
properties:
id:
$ref: '#/components/schemas/uuid-property'
type:
$ref: '#/components/schemas/ProductType'
Fee:
title: Fee
type: object
description: Fee for a product.
properties:
id:
readOnly: true
type: string
format: uuid
description: A unique ID representing the fee.
example: 28FEA0CD-A8B8-4A51-96C1-DDD5EAD642C6
name:
readOnly: true
type: string
description: Name of the fee.
maxLength: 100
example: Orientation Session Registration Fee
Guest:
type: object
description: The reference to the guest. Contains only the ID of the guest.
title: Guest
required:
- id
properties:
id:
type: string
format: uuid
description: Unique identifier of a guest.
example: 07c1cf32-a603-4736-8b77-749c3cee3107
DiscountType:
title: DiscountType
enum:
- Amount
- Percentage
- FlatPrice
type: string
description: This is used to denote the type of discount
example: Amount
order-details-paginated-response:
title: OrderDetailsPaginatedResponse
description: The response from a request to list of orders. This includes the paging object as well.
required:
- paging
- data
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
data:
type: array
items:
$ref: '#/components/schemas/order-detail'
description: Collection of order details.
DiscountDetail:
title: DiscountDetail
type: object
description: This is used to denote the discount details
properties:
id:
type: string
format: uuid
example: e7fd2027-5b26-4965-9ddf-b5db78ebcfec
description: A unique identifier for the discount.
name:
type: string
description: This denotes the name of the discount applied.
maxLength: 50
example: SRV Discount Code
code:
type: string
description: This denotes the code of the discount applied.
maxLength: 30
example: HALF_OFF
type:
$ref: '#/components/schemas/DiscountType'
value:
type: number
description: This denotes the value specified for the discount. How the value applies varies by `type`. For `FlatPrice`
discounts, this field represents the final price after the discount has been applied. For `Amount` discounts,
this field represents the amount to be discounted. For `Percentage` discounts, this field represents the percentage
to be discounted.
example: 50
amount:
type: number
description: The total discount applied to the order via the order or order items. Represents the amount saved due
to the discounts.
example: 15
ProductType:
title: ProductType
enum:
- AdmissionItem
- Track
- Session
- QuantityItem
- DonationItem
- GroupItem
- HotelItem
- MembershipItem
- GroupFlight
- RegistrantTypeServiceFee
- PaymentTypeServiceFee
- Tax
- Appointment
type: string
default: Session
description: This is used to denote the product type.
example: Session
readOnly: true
ErrorResponseBase1:
title: ErrorResponseBase
type: object
description: Represents an error response with no additional details.
required:
- code
- message
properties:
code:
type: integer
description: The HTTP status code representing the error.
example: 400
message:
type: string
description: A brief description of the error.
example: Bad Request
target:
type: string
description: The target resource of the error.
example: example target
OrderType:
title: OrderType
enum:
- Authorization
- Online Charge
- Online Refund
- Offline Charge
- Offline Refund
type: string
description: This is used to denote the type of order made by an attendee.
example: Online Refund
OrderRef:
title: OrderRef
type: object
description: Represents an order by its ID and includes the order type.
properties:
id:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
description: The unique identifier of the order.
type:
$ref: '#/components/schemas/OrderType'
GeneralLedger:
title: GeneralLedger
type: object
description: This is used to denote the general ledger detail in an order item
properties:
id:
type: string
format: uuid
example: a6b6c1bc-e410-48da-86c2-80478ecf60f9
description: A unique identifier for the general ledger.
name:
type: string
description: This denotes the name of the general ledger.
maxLength: 50
example: Other Accounts Receivable
code:
type: string
description: This denotes the code of the general ledger.
maxLength: 100
example: '123445'
description:
type: string
description: This denotes the description of the general ledger.
maxLength: 300
example: Other Accounts Receivable; Leg. Accounts Receivable
allocationPercentage:
type: number
description: This denotes the percentage allocation of the general ledger code for an order item.
minimum: 1
maximum: 100
example: 50
Event:
type: object
description: The reference to the event. Contains only the ID of the event.
title: Event
required:
- id
properties:
id:
type: string
format: uuid
description: Unique identifier of the event.
example: 4a0e8d1f-8fd6-4ebe-977a-602b4a1f9c56
PaginationLinks:
title: PaginationLinks
type: object
description: Represents pagination links for navigating between pages of data.
properties:
next:
$ref: '#/components/schemas/Link'
self:
$ref: '#/components/schemas/Link'
prev:
$ref: '#/components/schemas/Link'
order-detail:
title: OrderDetail
type: object
description: This is used to denote the details of the order made by an attendee.
allOf:
- $ref: '#/components/schemas/Audit'
properties:
id:
$ref: '#/components/schemas/uuid-property'
event:
$ref: '#/components/schemas/Event'
attendee:
$ref: '#/components/schemas/Attendee'
number:
type: string
description: Order number for this order
maxLength: 18
example: PZNK2PKZH4N
cancelled:
type: boolean
description: This denotes if an order is cancelled or not.
example: false
type:
$ref: '#/components/schemas/OrderType'
invoiceNumber:
type: string
description: This denotes the invoice number of this order
maxLength: 300
example: 112021-0017
amountOrdered:
type: number
description: Total amount for items purchased by the attendee.
example: 35.35
amountPaid:
type: number
description: Amount paid by the attendee.
example: 10.15
amountDue:
type: number
description: Amount due on the order.
example: 25.2
discounts:
type: array
description: The list of discount details.
items:
$ref: '#/components/schemas/DiscountDetail'
paymentMethod:
type: string
description: This denotes the payment method used for transaction
example: Mastercard
referenceNumber:
type: string
description: This denotes the reference number of the transaction
maxLength: 30
example: 112021-0017
deleted:
type: boolean
description: True indicates the order has been deleted.
example: false
Paging:
title: Paging
required:
- _links
type: object
description: Represents pagination information for a collection of resources.
properties:
previousToken:
type: string
description: The pagination token for the previous page, if one exists. You can use this token to navigate to the
previous page of data.
example: 1a2b3c4d5e6f7g8h9i10j11k
nextToken:
type: string
description: The pagination token for the next page. If this value is present in the response, there is another
page of data you can fetch.
example: 1a2b3c4d5e6f7g8h9i10j11k
currentToken:
type: string
description: The pagination token for the current page.
example: 1a2b3c4d5e6f7g8h9i10j11k
limit:
type: integer
description: The number of records to return on the page. Not to exceed 200.
example: 100
totalCount:
type: integer
description: The total number of records available. This field may return blank, even if there are more records.
To confirm if there are more records, check the `nextToken` field.
example: 2
_links:
$ref: '#/components/schemas/PaginationLinks'
Audit:
title: Audit
description: Audit information
type: object
properties:
created:
type: string
format: date-time
description: The ISO 8601 zoned date time when this record was created.
readOnly: true
example: '2017-01-02T02:00:00Z'
createdBy:
type: string
description: The identifier of the user that created this record.
readOnly: true
example: hporter
lastModified:
type: string
format: date-time
description: The ISO 8601 zoned date time when this record was updated.
readOnly: true
example: '2019-02-12T03:00:00Z'
lastModifiedBy:
type: string
description: The identifier of the user that last updated this record.
readOnly: true
example: hporter
order-items-paginated-response:
title: OrderItemsPaginatedResponse
description: The response from a request to list of order items. This includes the paging object as well.
required:
- paging
- data
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
data:
type: array
items:
$ref: '#/components/schemas/order-item-response'
description: Collection of order items.
ErrorResponse-12:
title: ErrorResponse
description: Represents an error response with additional details of cascading error messages.
allOf:
- $ref: '#/components/schemas/ErrorResponseBase1'
type: object
required:
- code
- message
properties:
details:
type: array
items:
$ref: '#/components/schemas/ErrorResponseBase1'
description: Additional details of cascading error messages.
responses:
NotFound1:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 404
message: Not found
BadRequest1:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 400
message: Bad Request
TooManyRequests1:
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 429
message: Limit Exceeded
Unauthorized1:
description: Bad or expired token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 401
message: Unauthorized
Forbidden1:
description: You do not have access to the resource
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 403
message: Access Forbidden
parameters:
after:
name: after
required: false
description: Used to query records that have been added or updated after this time point. Default to the beginning of
time of the data store.
in: query
schema:
type: string
format: date-time
example: '2017-01-02T02:00:00Z'
deleted:
name: deleted
in: query
required: false
description: When `true`, includes soft-deleted records in the response. Defaults to `false`.
schema:
type: boolean
default: false
before:
name: before
required: false
in: query
description: Used to query records that have been added or updated before this time point.
schema:
type: string
format: date-time
example: '2017-01-02T02:00:00Z'
orderItemId:
in: path
name: orderItemId
description: Unique ID of an Order Item.
required: true
schema:
$ref: '#/components/schemas/uuid-property'
token:
name: token
in: query
description: 'The continuation token returned from a previous class. This must be a valid UUID v4 if provided.
This will override any other pageable parameters provided.
'
style: form
explode: true
schema:
type: string
example: 0e28af57-511f-47ab-ae46-46cd1ca51a1a
orderId:
in: path
name: orderId
description: Unique ID of an Order.
required: true
schema:
$ref: '#/components/schemas/uuid-property'
limit:
name: limit
in: query
description: The maximum number of records to return per page.
style: form
explode: true
schema:
maximum: 200
minimum: 1
type: integer
default: 100
example: 100
securitySchemes:
OAuth2.clientCredentials:
type: oauth2
description: OAuth2 Client Credentials Flow.
flows:
clientCredentials:
tokenUrl: https://api-platform.cvent.com/ea/oauth2/token
scopes:
account/hooks:delete: Allows the deletion of hooks.
account/hooks:read: Allows the reading of hooks.
account/hooks:write: Allows the creation/updation of hooks.
account/user-groups:delete: Allows deletion for user groups
account/user-groups:read: Allows the reading of user groups
account/user-groups:write: Allows the writing of user groups
account/users:delete: Allows the deletion of User
account/users:read: Allows the reading of User, User Group
account/users:write: Allows the creation/updating of User
appointments/appointment-attendees:read: Allows the reading of appointment attendees and their related entities.
appointments/appointment-events:read: Allows the reading of appointment events and their related entities.
appointments/appointment-types:read: Allows the reading of appointment types and their related entities.
appointments/appointments:read: Allows the reading of appointment and their related entities.
appointments/appointments:write: Allows the writing of appointments and their related entities.
appointments/available-times:read: Allows the reading of availability times.
appointments/locations:read: Allows the reading of appointment locations and their related entities.
attendee-insights/attendee-insights:read: Allows the reading of engagement scores (attendee insights).
attendee-insights/scores:read: Allows the reading of scores.
attendee-insights/stats:read: Allows the reading of engagement score (attendee insight) stats.
budget/budget-items:delete: Allows the deletion of budget items
budget/budget-items:read: Allows the reading of all budget items
budget/budget-items:write: Allows creation/updation of budget item
budget/budget-totals:read: Allows the reading of all event budget totals
budget/budget-vendors:read: Allows reading of account-level budget vendors.
budget/cards:read: Allows the reading of cards
budget/currency-conversion-rate:delete: Allows deletion of currency conversion rate for currency.
budget/currency-conversion-rate:read: Allows reading of currency conversion rate for currency.
budget/currency-conversion-rate:write: Allows creation/update of currency conversion rate for currency.
budget/payments:delete: Allows deletion of payments.
budget/payments:read: Allows reading of payment for budget item.
budget/payments:write: Allows creation of payment in a budget item.
budget/transactions:delete: Allows delete card transactions.
budget/transactions:read: Allows the reading of all card's transactions
budget/transactions:write: Allows creation of card transactions.
bulk/bulk-jobs:read: Allows the reading of bulk job related entities
bulk/bulk-jobs:write: Allows the creation, update and deletion of bulk job related entities
business-transient/bids:read: Allows the reading of Business Transient Bid data
business-transient/proposals:read: Allows the reading of Business Transient Proposal data
business-transient/supplier-brands:read: Allows the reading of a supplier brand or a list of travel supplier brands.
business-transient/supplier-chains:read: Allows the reading of a travel supplier chain or a list of travel supplier
chains.
business-transient/supplier-properties:read: Allows the reading of a travel supplier property or a list of travel
supplier properties.
business-transient/supplier-property-rooms:read: Allows the reading of a list of travel supplier property rooms.
business-transient/travel-accounts:read: Allows the reading of business transient travel account data.
business-transient/travel-program-questions:read: Allows the reading of business transient travel program question
data.
business-transient/travel-programs:read: Allows the reading of business transient travel program data.
business-transient/travel-supplier-accounts:read: Allows the reading of business transient travel supplier account
data.
business-travel/bids:read: Allows the reading of Business Travel Bid data
business-travel/proposals:read: Allows the reading of Business Travel Proposal data
business-travel/travel-accounts:read: Allows the reading of business travel account data.
business-travel/travel-program-questions:read: Allows the reading of business travel program question data.
business-travel/travel-programs:read: Allows the reading of business travel program data.
compliance/communications:read: Allows the reading of communication compliance
compliance/communications:write: Allows the writing of communication compliance
email/bounces:read: Allow the reading of email bounces.
email/email-status:read: All
# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent/refs/heads/main/openapi/cvent-orders-api-openapi.yml