Retrieve Orders

{ "orders": [ { "id": 1, "totalExTax": 4227, "tax": 0, "paid": 4227, "fees": 630, "discount": 0, "refunded": 0, "total": 4227, "currencyId": 1, "currencySymbol": "£", "currencyCode": "GBP", "feeCurrencyId": 1, "feeCurrencySymbol": "£", "feeCurrencyCode": "GBP", "reference": "RO7PMGED2N", "date": "2021-11-22T11:59:00.000000Z", "notes": null, "downloadUrl": "https://ticketing-download.com/order-1?signature=1jk23n2kj2jk432kln23l4n2lk3b5jk4k2j34lkn34l3n4lknjkb", "appleWalletPassUrl": "https://ticketing-download.com/order-1?mode=apple-wallet&signature=1jk23n2kj2jk432kln23l4n2lk3b5jk4k2j34lkn34l3n4lknjkb", "transactionIds": [ 1 ], "pointOfSale": { "type": "online", "name": "Ticket Shop" }, "fullDownloadUrl": "https://ticketing-download.com/order-1?signature=1jk23n2kj2jk432kln23l4n2lk3b5jk4k2j34lkn34l3n4lknjkb", "items": [ { "id": 1, "saleItemId": 1, "customerId": 1, "itemSaleName": "Ticket 1", "itemName": "Ticket 1", "itemType": "ticket", "itemTypeName": "Ticket", "fullSpaceName": "T2-3 (Blue)", "barcode": "97WG2VGJK2", "price": 500, "refunded": 0, "protectionStatus": "unprotected", "validFrom": null, "validTo": null, "eventStartDate": "2021-11-22T11:59:00.000000Z", "eventEndDate": "2021-11-25T11:59:00.000000Z", "eventId": 10, "eventName": "Weekly Comedy Show #4", "ticketName": "Standard Ticket", "notes": null, "historicBarcodes": [ { "id": 1, "orderItemId": 1, "oldBarcode": "97WG2VGJK2", "newBarcode": "97WG2VGJK2", "changedAt": "2021-11-22T11:59:00.000000Z" } ], "venue": { "id": 1, "name": "alias quo", "address": "629 Mante Centers", "city": "possimus", "region": null, "latitude": null, "longitude": null, "postcode": "72043-7529", "countryIso": "GB", "countryIso3": "GBR" } } ], "customer": { "id": 123, "externalId": null, "name": "John Doe", "title": "Mr", "firstName": "John", "surname": "Doe", "email": "john.doe@example.com", "phone": "7710101010", "phoneCode": 44, "fullPhoneNumber": "+447710101010", "locale": "en", "dob": "1990-10-10T00:00:00.000000Z", "nationalityId": 1, "vatNumber": "123456789", "vatCountryVerified": false, "img": "", "addressLine1": "Address Line 1", "addressLine2": "Address Line ", "cityId": "23", "city": "London", "region": "London", "country": "United Kingdom", "postcode": "SW1A 0AA", "createdAt": "2020-01-01T10:00:00.000000Z", "updatedAt": "2020-01-01T10:00:00.000000Z", "deletedAt": null }, "transactions": [ { "id": 1, "total": 4227, "externalFee": null, "orderId": 1, "metadata": [], "externalApplicationFeeId": null, "createdAt": "2024-04-22T14:52:47.000000Z", "updatedAt": "2024-04-22T14:52:47.000000Z", "paymentGateway": null, "status": "Success", "type": "cash" } ] } ], "customers": [ { "id": 123, "externalId": null, "name": "John Doe", "title": "Mr", "firstName": "John", "surname": "Doe", "email": "john.doe@example.com", "phone": "7710101010", "phoneCode": 44, "fullPhoneNumber": "+447710101010", "locale": "en", "dob": "1990-10-10T00:00:00.000000Z", "nationalityId": 1, "vatNumber": "123456789", "vatCountryVerified": false, "img": "", "addressLine1": "Address Line 1", "addressLine2": "Address Line ", "cityId": "23", "city": "London", "region": "London", "country": "United Kingdom", "countryIso": "GB", "countryIso3": "GBR", "postcode": "SW1A 0AA", "createdAt": "2020-01-01T10:00:00.000000Z", "updatedAt": "2020-01-01T10:00:00.000000Z", "deletedAt": null } ], "discountCodes": [ { "id": 1, "type": "fixed", "code": "DISCOUNT_CODE", "CPT10OFF": 1000, "maximumUses": null, "maxUsesPerCustomer": null, "minimumSpend": null, "validFrom": null, "validTo": null, "boxOfficeOnly": false, "maxUsesPerOrder": 2, "disabledAt": null, "createdAt": "2024-04-29T11:59:00.000000Z", "updatedAt": "2024-04-29T11:59:00.000000Z", "deletedAt": null } ], "accessCodes": [ { "id": 1, "companyId": 1, "parentId": null, "code": "ACCESS_CODE", "maximumUses": null, "maxUsesPerCustomer": null, "validFrom": null, "validTo": null, "hideUnrestrictedItems": false, "hideRestrictedItemsAfterValidityPeriod": false, "createdAt": "2024-04-29T11:59:00.000000Z", "updatedAt": "2024-04-29T11:59:00.000000Z", "disabledAt": null, "deletedAt": null } ], "deliveryAddresses": [ { "id": 1, "addressLine1": "Address Line 1", "addressLine2": "Address Line 2", "cityId": 1, "city": "London", "region": "London", "country": "United Kingdom", "countryIso": "GB", "countryIso3": "GBR", "postcode": "SW1A 0AA", "createdAt": "2020-01-01T10:00:00.000000Z", "updatedAt": "2020-01-01T10:00:00.000000Z", "deletedAt": null } ], "meta": { "total": 1, "listEndTime": "2022-07-04T15:23:33.000000Z", "cursor": "2022-07-04T15:23:33.000000Z_1353", "hasMore": false }, "links": { "first": "http://api.willms.com/v1/customers?page=1", "last": "http://api.willms.com/v1/customers?page=5", "prev": "http://api.willms.com/v1/customers?page=2", "next": "http://api.willms.com/v1/customers?page=5", "self": "http://api.willms.com/v1/customers?page=3" } }

Authorizations

Authorization

string

header

required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Headers

X-NU-COMPANY-ID

integer

The ID of the company this operation should be performed against.

Accept-Language

string

Sets the preferred language for localised response content (e.g. en, fr, de). If the requested language is not supported by the company, the company fallback language will be assumed.

Query Parameters

withReservations

boolean

Whether to include orders that are in a reservation state, often awaiting customer actions (such as payment via invoice or on-site). Default state is false.

limit

integer

Limits the number of orders returned.

offset

integer

The offset - e.g 10 for listing orders starting with the 10th order with the most recent completed at date.

page

integer

The page in which you wish to retrieve orders. You will only be able to paginate by page if you do not specify an offset.

customerName

string

When present, orders will be filterd where the cutsomer name contains this value.

reference

string

When present, orders will be filterd where the order reference contains this value.

include

enum<string>[]

A list of related resources you wish to include in the response. Values can be a url encoded array, or comma separated string.

Available options:

orderItems,

customers,

billingAddresses,

deliveryAddresses,

discountCodes,

accessCodes,

transactions,

spaces,

historicBarcodes

contains

enum<string>[]

A list of commera separated item types that the order must contain. Where orders contain item types not listed here, alongside item types that are listed here, the order will be returned.

Available options:

ticket,

product,

guest_list,

season_ticket,

charity,

cashless_topup,

cashless_product

containsResale

boolean

When true, only orders containing resale items will be returned, while false will prevent orders containing resale items from being returned.

containsOrderModification

boolean

When true, only orders containing items from order modification will be returned, while false will prevent orders containing items from order modification from being returned.

lastUpdated

string | null

Date/Time for retrieving orders who's associated database records (order items, data capture responses and data capture response options) have been updated after the given lastUpdated time. Accepted formats:

YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z

Date formats that do not include the timezone must be in UTC.

cursor

string

The cursor to retrieve the next page of data when using lastUpdated. After the first request specifying a lastUpdated parameter, you should use the resulting cursor for subsequent requests.

query

string

Allows you to filter the orders by email, full name, order reference or event name.

eventId

integer

Allows you to filter for orders that contain items from the given event ID.

withTrashed

enum<string>

Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.

true to include deleted records
false to exclude deleted records (or leave blank)

Available options:

true,

false

only

string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. orders.id,orderItems.saleItemId,venues.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

except

string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. orders.id,orderItems.saleItemId,venues.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successfully retrieved orders.

orders

object[]

Show child attributes

customers

object[]