Event Orders

Event Orders

The event orders API allows you to view particular event orders information.

Order properties

AttributeTypeDescriptionPermission
idintegerUnique identifier for the object.READ-ONLY
parent_idintegerParent order ID.
numberstringOrder number.READ-ONLY
order_keystringOrder key.READ-ONLY
created_viastringShows where the order was created.READ-ONLY
versionstringVersion of WooCommerce which last updated the order.READ-ONLY
statusstringOrder status. Options: pending ,processing, on-hold, completed, cancelled, refunded, failed and trash .
Default is pending .
currencystringCurrency the order was created with, in ISO format. Options: AED , AFN , ALL , AMD , ANG , AOA , ARS , AUD , AWG , AZN , BAM , BBD , BDT , BGN , BHD , BIF , BMD , BND , BOB , BRL , BSD , BTC , BTN , BWP , BYR , BZD , CAD , CDF , CHF , CLP , CNY , COP , CRC , CUC , CUP , CVE , CZK , DJF , DKK , DOP , DZD , EGP , ERN , ETB , EUR , FJD , FKP , GBP , GEL , GGP , GHS , GIP , GMD , GNF , GTQ , GYD , HKD , HNL , HRK , HTG , HUF , IDR , ILS , IMP , INR , IQD , IRR , IRT , ISK , JEP , JMD , JOD , JPY , KES , KGS , KHR , KMF , KPW , KRW , KWD , KYD , KZT , LAK , LBP , LKR , LRD , LSL , LYD , MAD , MDL , MGA , MKD , MMK , MNT , MOP , MRO , MUR , MVR , MWK , MXN , MYR , MZN , NAD , NGN , NIO , NOK , NPR , NZD , OMR , PAB , PEN , PGK , PHP , PKR , PLN , PRB , PYG , QAR , RON , RSD , RUB , RWF , SAR , SBD , SCR , SDG , SEK , SGD , SHP , SLL , SOS , SRD , SSP , STD , SYP , SZL , THB , TJS , TMT , TND , TOP , TRY , TTD , TWD , TZS , UAH , UGX , USD , UYU , UZS , VEF , VND , VUV , WST , XAF , XCD , XOF , XPF , YER , ZAR and ZMW . Default is USD .
date_createddate-timeThe date the order was created, in the site’s timezone.READ-ONLY
date_created_gmtdate-timeThe date the order was created, as GMT.READ-ONLY
date_modifieddate-timeThe date the order was last modified, in the site’s timezone.READ-ONLY
date_modified_gmtdate-timeThe date the order was last modified, as GMT.READ-ONLY
discount_totalstringTotal discount amount for the order.READ-ONLY
discount_taxstringTotal discount tax amount for the order.READ-ONLY
shipping_totalstringTotal shipping amount for the order.READ-ONLY
shipping_taxstringTotal shipping tax amount for the order.READ-ONLY
cart_taxstringSum of line item taxes only.READ-ONLY
totalstringGrand total.READ-ONLY
total_taxstringSum of all taxes.READ-ONLY
prices_include_taxbooleanTrue the prices included tax during checkout.READ-ONLY
customer_idintegerUser ID who owns the order. 0 for guests. Default is 0 .
customer_ip_addressstringCustomer’s IP address.READ-ONLY
customer_user_agentstringUser agent of the customer.READ-ONLY
customer_notestringNote left by customer during checkout.
billingobjectBilling address.
shippingobjectShipping address.
payment_methodstringPayment method ID.
payment_method_titlestringPayment method title.
transaction_idstringUnique transaction ID.
date_paiddate-timeThe date the order was paid, in the site’s timezone.READ-ONLY
date_paid_gmtdate-timeThe date the order was paid, as GMT.READ-ONLY
date_completeddate-timeThe date the order was completed, in the site’s timezone.READ-ONLY
date_completed_gmtdate-timeThe date the order was completed, as GMT.READ-ONLY
cart_hashstringMD5 hash of cart items to ensure orders are not modified.READ-ONLY
meta_dataarrayMeta data.
line_itemsarrayLine items data.
tax_linesarrayTax lines data.READ-ONLY
shipping_linesarrayShipping lines data.
fee_linesarrayFee lines of data.
coupon_linesarrayCoupons line data.
refundsarrayList of refunds.READ-ONLY
attendeesarrayAttendee registration data.
currency_symbolstringCurrency symbol the order was created with.

Order – Billing properties

AttributeTypeDescription
first_namestringFirst name.
last_namestringLast name.
companystringCompany name.
address_1stringAddress line 1
address_2stringAddress line 2
citystringCity name.
statestringISO code or name of the state, province or district.
postcodestringPostal code.
countrystringCountry code in ISO 3166-1 alpha-2 format.
emailstringEmail address.
phonestringPhone number.

Order – Shipping properties

AttributeTypeDescription
first_namestringFirst name.
last_namestringLast name.
companystringCompany name.
address_1stringAddress line 1
address_2stringAddress line 2
citystringCity name.
statestringISO code or name of the state, province or district.
postcodestringPostal code.
countrystringCountry code in ISO 3166-1 alpha-2 format.
phonestringPhone number.

Order – Meta data properties

AttributeTypeDescription
idintegerMeta ID.READ-ONLY
keystringMeta key.
valuestringMeta value.

Order – Line items properties

AttributeTypeDescriptionPermission
idintegerItem ID.READ-ONLY
namestringProduct name.
product_idintegerProduct ID.
variation_idintegerVariation ID, if applicable.
quantityintegerQuantity ordered.
tax_classstringSlug of the tax class of product.
subtotalstringLine subtotal (before discounts).
subtotal_taxstringLine subtotal tax (before discounts).READ-ONLY
totalstringLine total (after discounts).
total_taxstringLine total tax (after discounts).READ-ONLY
taxesarrayLine taxes.READ-ONLY
meta_dataarrayMeta data
skustringProduct SKU.READ-ONLY
pricestringProduct price.READ-ONLY

Order – Tax lines properties

AttributeTypeDescriptionPermission
idintegerItem ID.READ-ONLY
rate_codestringTax rate code.READ-ONLY
rate_idintegerTax rate ID.READ-ONLY
labelintegerTax rate label.READ-ONLY
compoundbooleanShow if is a compound tax rate.READ-ONLY
tax_totalstringTax total (not including shipping taxes).READ-ONLY
shipping_tax_totalstringShipping tax total.READ-ONLY
meta_dataarrayMeta data

Order – Shipping lines properties

AttributeTypeDescriptionPermission
idintegerItem ID.READ-ONLY
method_titlestringShipping method name.
method_idstringShipping method ID.
totalstringLine total (after discounts).
total_taxstringLine total tax (after discounts).READ-ONLY
taxesarrayTax total (not including shipping taxes).READ-ONLY
meta_dataarrayMeta data

Order – Fee lines properties

AttributeTypeDescriptionPermission
idintegerItem ID.READ-ONLY
namestringFee name.
tax_classstringTax class of fee.
tax_statusstringTax status of fee. Options: taxable and none .
totalstringLine total (after discounts).
total_taxstringLine total tax (after discounts).READ-ONLY
taxesarrayTax total (not including shipping taxes).READ-ONLY
meta_dataarrayMeta data

Order – Coupon lines properties

AttributeTypeDescriptionPermission
idintegerItem ID.READ-ONLY
codestringCoupon code.
discountstringDiscount total.READ-ONLY
discount_taxstringDiscount total tax.READ-ONLY
meta_dataarrayMeta data

Order – Refunds properties

AttributeTypeDescriptionPermission
idintegerItem ID.READ-ONLY
reasonstringRefund reason.READ-ONLY
totalstringRefund total.READ-ONLY

Order – Attendees properties

AttributeTypeDescriptionPermission
idintegerRegistration ID.READ-ONLY
namestringAttendee name.
_event_registered_forstringEvent Name.
_attendee_emailstringAttendee email address.
_attendee_namestringAttendee name.
_attendee_user_idstringAttendee user id.READ-ONLY
_registration_sourcestringRegistration source.
_ticket_typearrayEvent ticket type(paid, free, donation).
_ticket_idarrayProduct Id.
_order_idstringAttendee order id.
_total_ticket_pricestringTotal ticket price.
_total_ticketstringTotal ticket quantity.
_registration_typebooleanDefault value 0(“false”), if attendee registered with buyer only option then will “1”(true).
_check_inbooleanDefault value 0(“false”), if attendee already checkedin then will “1”(true).
_checkin_sourcestringCheck-in source(app, web).
_checkin_device_idstringCheck-in device id.
_checkin_device_namestringCheck-in device name.
_checkin_timedate-timeThe date the order was created, as GMT.READ-ONLY

Get Event orders

This API helps you to get particular event orders.

HTTP request
Method : GET
URL : /wp-json/wpem/events/<event_id>/orders/


    • Related Articles

    • Event Ticket Sales Report

      The event sales report API allows you to view event ticket sales information. Event ticket sale properties Attribute Type Description total_sales string Total sale amount. net_sales string Net sales amount. average_sales string Average sales amount. ...

    • Event Tickets

      The event ticket API allows you to view event ticket information. Event ticket properties Attribute Type Description Permission id integer Unique identifier for the object. READ-ONLY name string Event ticket name. MANDATORY slug string Event ticket ...

    • Events

      The events API allows you to view and delete individual, or a batch, of events. Event properties Attribute Type Description Permission id int Unique identifier for the object. READ-ONLY name string Event name. MANDATORY slug string Event slug. ...

    • Scan QRCode

      The scan QRCode API allows you to scan QRCode of tickets of attendees. Scan QRCode properties Attribute Type Description Permission message string Message for attendee ticket scan READ-ONLY event_title string Event name. attendee_name string Attendee ...

    • Attendee

      The attendee API allows you to view, checkin, checkout and delete an individual, or a batch, of attendee. Attendee properties Attribute Type Description Permission id integer Unique identifier for the object. READ-ONLY name string Attendee name. ...