Skip to main content
GET
/
order
Retrieve Order
curl --request GET \
  --url https://api.nuwebgroup.com/v1/order \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "total": 1000,
  "paid": 1000,
  "currencyId": 1,
  "currencySymbol": "Ā£",
  "currencyCode": "GBP",
  "feeCurrencyId": 1,
  "feeCurrencySymbol": "Ā£",
  "feeCurrencyCode": "GBP",
  "reference": "RO3PMNGE1N",
  "date": "2021-11-22T11:59:00.000000Z",
  "paymentMethod": [
    "Cash"
  ],
  "notes": null,
  "pointOfSale": {
    "type": "online",
    "name": "Ticket Shop"
  },
  "discountCodeIds": [
    1
  ],
  "accessCodeIds": [
    1
  ],
  "customer": {
    "id": 123,
    "externalId": null,
    "title": "Mr",
    "name": "John Doe",
    "firstName": "John",
    "surname": "Doe",
    "email": "[email protected]",
    "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
  },
  "deliveryAddress": {
    "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
  },
  "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,
      "validFrom": null,
      "validTo": null,
      "eventStartDate": "2021-11-22T11:59:00.000000Z",
      "eventEndDate": "2021-11-25T11:59:00.000000Z",
      "createdAt": "2021-11-25T11:59:00.000000Z",
      "updatedAt": "2021-11-25T11:59:00.000000Z",
      "deletedAt": "2021-11-25T11:59:00.000000Z",
      "eventId": 10,
      "eventName": "Weekly Comedy Show #4",
      "ticketName": "Standard Ticket",
      "notes": null,
      "replacedOrderItem": {
        "type": "resale",
        "orderItemId": 123,
        "orderId": 52
      },
      "historicBarcodes": [
        {
          "id": 1,
          "orderItemId": 1,
          "oldBarcode": "97WG2VGJK1",
          "newBarcode": "97WG2VGJK2",
          "changedAt": "2021-11-25T11: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"
      }
    }
  ],
  "transactions": [
    {
      "id": 1,
      "total": 1000,
      "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"
    }
  ],
  "discountCodes": [
    {
      "id": 1,
      "type": "fixed",
      "code": "DISCOUNT_CODE",
      "CPT10OFF": 1000,
      "maximumUses": null,
      "maxUsesPerCustomer": null,
      "minimumSpend": null,
      "validFrom": null,
      "validTo": null,
      "boxOfficeOnly": false,
      "maxUsesPerOrder": null,
      "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
    }
  ]
}

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.

Query Parameters

ā€‹
orderId
integer

The order ID. Basket IDs and Order IDs can be used interchangeably.

ā€‹
orderReference
string

The order reference. Basket references and Order references can be used interchangeably. Will take precedent over orderId parameter.

ā€‹
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)
Important Note: when set to true, this endpoint will include items that were removed from the users order/basket pre and/or post-sale.

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.

ā€‹
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:
customer,
billingAddress,
deliveryAddress,
discountCodes,
accessCodes,
transactions,
spaces,
historicBarcodes

Response

Successfully retrieved order.

ā€‹
id
integer
ā€‹
total
integer
ā€‹
paid
integer
ā€‹
currencyId
integer
ā€‹
currencySymbol
string
ā€‹
currencyCode
string
ā€‹
feeCurrencyId
integer
ā€‹
feeCurrencySymbol
string
ā€‹
feeCurrencyCode
string
ā€‹
reference
string
ā€‹
date
string
ā€‹
customerId
integer
ā€‹
customerName
string
deprecated

This parameter will be removed in a future version of the API. You should use customer.name instead.

ā€‹
customerEmail
string
deprecated

This parameter will be removed in a future version of the API. You should use customer.email instead.

ā€‹
notes
string
ā€‹
status
string

The human readable form of the status slug - can be displayed directly to users.

ā€‹
statusSlug
string

Can be one of: active, valid, processing, complete, requires_approval, rejected, approved, cancelled, expired,partially_refunded, awaiting_payment_link, awaiting_onsite_payment, awaiting_invoice, awaiting_approval, awaiting_local_payment

ā€‹
statusId
integer
ā€‹
reserverName
string

The reserver name override set at the order level for this order

ā€‹
pointOfSale
object[]
ā€‹
downloadUrl
string

The customer facing download URL from which their event media can be retrieved for the order items owned by them.

ā€‹
fullDownloadUrl
string

The download URL from which event media can be retrieved for the whole order, regardless of item holder.

ā€‹
paymentMethod
any[]
ā€‹
discountCodeIds
integer[]

Optionally included via the include parameter.

ā€‹
accessCodeIds
integer[]

Optionally included via the include parameter.

ā€‹
customer
object

Optionally included via the include parameter.

ā€‹
deliveryAddress
object

Optionally included via the include parameter.

ā€‹
items
object[]
ā€‹
transactions
object[]

Optionally included via the include parameter.

ā€‹
discountCodes
object[]

Optionally included via the include parameter.

ā€‹
accessCodes
object[]

Optionally included via the include parameter.