Skip to main content
GET
/
order-item
Retrieve Specific Purchased Item
curl --request GET \
  --url https://api.nuwebgroup.com/v1/order-item \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "orderItems",
    "id": 1,
    "attributes": {
      "eventId": 123,
      "barcode": "97WG2VGJK2",
      "nfcId": "0x0C27069B10A92615528F",
      "saleName": "Standard Guest List",
      "name": "Standard Guest List",
      "type": "ticket",
      "typeName": "Ticket",
      "saleItemId": 633,
      "basePrice": 500,
      "currencyId": 1,
      "currencySymbol": "Ā£",
      "currencyCode": "GBP",
      "feeCurrencyId": 1,
      "feeCurrencySymbol": "Ā£",
      "feeCurrencyCode": "GBP",
      "processingFee": 0,
      "resellerFee": 0,
      "hideProcessingFee": false,
      "hideResellerFee": false,
      "discount": 0,
      "total": 500,
      "variablePrice": false,
      "refunded": 0,
      "deferredPayment": false,
      "requiresApproval": false,
      "approvedAt": "2021-11-22T11:59:00.000000Z",
      "rejectedAt": null,
      "cancelledAt": null,
      "validFrom": "2021-11-22T11:59:00.000000Z",
      "validTo": "2021-11-26T11:59:00.000000Z",
      "pointOfSale": {
        "type": "online",
        "name": "Ticket Shop"
      },
      "replacedOrderItem": {
        "type": "resale",
        "orderItemId": 123,
        "orderId": 52
      },
      "fullSpaceName": "A-1 (Block A)",
      "createdAt": "2021-11-26T11:59:00.000000Z",
      "updatedAt": "2021-11-26T11:59:00.000000Z",
      "deletedAt": null
    },
    "meta": {
      "lastUpdated": "2021-11-26T11:59:00.000000Z"
    },
    "relationships": {
      "customers": {
        "data": {
          "type": "customers",
          "id": 1
        }
      },
      "events": {
        "data": {
          "type": "events",
          "id": 1
        }
      },
      "orders": {
        "data": {
          "type": "orders",
          "id": 1
        }
      },
      "notes": {
        "data": {
          "type": "notes",
          "id": 1
        }
      },
      "transactions": {
        "data": {
          "type": "transactions",
          "id": 1
        }
      },
      "priceBands": {
        "data": {
          "type": "priceBands",
          "id": 1
        }
      },
      "spaces": {
        "data": {
          "type": "spaces",
          "id": 1
        }
      },
      "spaceAreas": {
        "data": {
          "type": "spaceAreas",
          "id": 1
        }
      },
      "spaceBlocks": {
        "data": {
          "type": "spaceBlocks",
          "id": 1
        }
      },
      "spaceRows": {
        "data": {
          "type": "spaceRows",
          "id": 1
        }
      },
      "spaceStands": {
        "data": {
          "type": "spaceStands",
          "id": 1
        }
      },
      "spaceTables": {
        "data": {
          "type": "spaceTables",
          "id": 1
        }
      },
      "spaceGates": {
        "data": [
          {
            "type": "spaceGates",
            "id": 1
          }
        ]
      },
      "discountCodes": {
        "data": {
          "type": "discountCodes",
          "id": 1
        }
      },
      "accessCodes": {
        "data": {
          "type": "accessCodes",
          "id": 1
        }
      },
      "historicBarcodes": {
        "data": {
          "type": "historicBarcodes",
          "id": 1
        }
      }
    },
    "links": {
      "self": "http://api.willms.com/v1/customer?id=5"
    }
  },
  "included": [
    {
      "type": "customers",
      "id": 1,
      "attributes": {
        "name": "Stone Dach",
        "email": "[email protected]",
        "phone": null,
        "phoneCode": null,
        "fullPhoneNumber": null,
        "img": null,
        "locale": null,
        "dob": null,
        "addressLine1": null,
        "addressLine2": null,
        "postcode": null,
        "countryIso": null,
        "countryIso3": null,
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z"
      }
    },
    {
      "type": "events",
      "id": 1,
      "attributes": {
        "name": "ut",
        "description": "Qui nisi tempore illum aliquam.",
        "startDate": "2021-11-22T11:59:00.000000Z",
        "endDate": "2021-11-25T11:59:00.000000Z",
        "activatedAt": null,
        "organiserName": "John Doe",
        "organiserEmail": "[email protected]",
        "organiserPhone": "+1-836-852-7192"
      }
    },
    {
      "type": "items",
      "id": 22,
      "attributes": {
        "type": "ticket",
        "name": "Ticket 3",
        "description": "Quia recusandae nam qui quia.",
        "totalStock": 500,
        "currentStock": 495,
        "hasUnlimitedStock": false,
        "requiresApproval": false,
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z"
      }
    },
    {
      "type": "notes",
      "id": 1,
      "attributes": {
        "note": "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Eligendi non quis exercitationem culpa nesciunt nihil aut nostrum explicabo reprehenderit optio amet ab temporibus asperiores quasi cupiditate. Voluptatum ducimus voluptates voluptas?",
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z",
        "deletedAt": null
      }
    },
    {
      "type": "priceBands",
      "id": 1,
      "attributes": {
        "name": "Group 1"
      }
    },
    {
      "type": "spaces",
      "id": 1,
      "attributes": {
        "areaId": null,
        "blockId": null,
        "standId": null,
        "rowId": null,
        "tableId": null,
        "timeslotId": null,
        "name": "1"
      }
    },
    {
      "type": "spaceAreas",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Area"
      }
    },
    {
      "type": "spaceBlocks",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Block"
      }
    },
    {
      "type": "spaceRows",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Row"
      }
    },
    {
      "type": "spaceStands",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Stand"
      }
    },
    {
      "type": "spaceTables",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Table"
      }
    },
    {
      "type": "spaceGates",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Gate"
      }
    },
    {
      "type": "spaceStairs",
      "id": 1,
      "attributes": {
        "id": 1,
        "name": "Stairs"
      }
    },
    {
      "type": "orders",
      "id": 1,
      "attributes": {
        "reference": "RO3PMNGE1N",
        "totalExTax": 500,
        "tax": 0,
        "fees": 0,
        "discount": 0,
        "refunded": 0,
        "total": 500,
        "processingAttempts": 1,
        "recoveredFrom": null,
        "expiresAt": "2021-11-22T11:59:00.000000Z",
        "completedAt": "2021-11-22T11:59:00.000000Z",
        "currencyId": 1,
        "currencySymbol": "Ā£",
        "currencyCode": "GBP",
        "feeCurrencyId": 1,
        "feeCurrencySymbol": "Ā£",
        "feeCurrencyCode": "GBP"
      }
    },
    {
      "type": "saleItems",
      "id": 633,
      "attributes": {
        "totalStock": 100,
        "currentStock": 95,
        "onSaleFrom": null,
        "onSaleUntil": null,
        "validFrom": null,
        "validUntil": null,
        "priceBandId": null,
        "scanningGracePeriod": 0,
        "minOrderQuantity": 0,
        "maxOrderQuantity": 99,
        "multiplesOf": 0,
        "orderColumn": null,
        "additionalInformation": null,
        "attractsDiscount": true,
        "canBeDownloaded": true,
        "canAccessStream": false,
        "hideWhenOffSale": false,
        "hideWhenOutOfStock": false,
        "hideFromBoxOffice": false,
        "hideFromShop": false,
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z"
      },
      "relationships": {
        "items": {
          "data": {
            "type": "items",
            "id": 22
          }
        }
      }
    },
    {
      "type": "transactions",
      "id": 1,
      "attributes": {
        "externalApplicationFeeId": null,
        "externalFee": null,
        "metadata": [],
        "orderId": 1,
        "paymentGateway": null,
        "status": "Success",
        "total": 10,
        "type": "cash",
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z"
      }
    },
    {
      "type": "discountCodes",
      "id": 1,
      "attributes": {
        "id": 1,
        "type": "fixed",
        "code": "DISCOUNT_CODE",
        "amount": 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
      }
    },
    {
      "type": "accessCodes",
      "id": 1,
      "attributes": {
        "companyId": 1,
        "parentId": null,
        "code": "ACCESS_CODE",
        "maximumUses": null,
        "maxUsesPerCustomer": 2,
        "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
      }
    },
    {
      "type": "historicBarcodes",
      "id": 1,
      "attributes": {
        "orderItemId": 1,
        "old_barcode": "97WG2VGJK1",
        "new_barcode": "97WG2VGJK2",
        "changedAt": "2021-11-22T11:59:00.000000Z"
      }
    }
  ]
}

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

ā€‹
id
integer

The ID of the order item you wish to retrieve. Required when barcode and nfcId are empty.

ā€‹
barcode
string

The barcode of the order item you wish to retrieve. Required when the ID and nfcId are empty.

ā€‹
nfcId
string

The NFC id of the order item you wish to retrieve. Required when the ID and barcode are empty.

ā€‹
include
enum<string>[]

A list of related resources you wish to include in the response. Values can be an array, or comma separated string. When including any of the spaces resources, the spaces include is required.

Available options:
orders,
customers,
wallets,
events,
shops,
saleItems,
giftaid,
dataCaptureResponses,
dataCaptureFields,
dataCaptureQuestions,
notes,
discountCodes,
accessCodes,
transactions,
spaces,
spaceAreas,
spaceBlocks,
spaceGates,
spaceRows,
spaceStairs,
spaceStands,
spaceTables,
historicBarcodes
ā€‹
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. orderItems.customerId,orders.reference,customers.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. orderItems.customerId,orders.reference,customers.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successfully retrieved the order item.

ā€‹
data
object
ā€‹
included
object[]