Skip to main content
GET
/
sale-items
Retrieve Sale Items
curl --request GET \
  --url https://api.nuwebgroup.com/v1/sale-items \
  --header 'Authorization: Bearer <token>'
{
  "saleItems": [
    {
      "id": 1,
      "externalId": "VNU-243",
      "itemId": 123,
      "eventId": 5,
      "eventTimeslotId": 1,
      "eventPriceBandId": null,
      "type": "ticket",
      "name": "Ticket",
      "description": "Quas fuga odio in fuga enim.",
      "basePrice": 500,
      "totalPrice": 500,
      "resellerFee": 0,
      "processingFee": 0,
      "currencyId": 1,
      "currencySymbol": "Ā£",
      "currencyCode": "GBP",
      "allPrices": [
        {
          "id": 92,
          "currencyId": 1,
          "currencySymbol": "Ā£",
          "currencyCode": "GBP",
          "basePrice": 500,
          "totalPrice": 500,
          "resellerFee": 0,
          "processingFee": 0
        }
      ],
      "totalStock": 500,
      "sold": 0,
      "reserved": 0,
      "validFrom": null,
      "validUntil": "2021-11-22T11:59:00.000000Z",
      "minOrderQuantity": 0,
      "maxOrderQuantity": 99,
      "multiplesOf": 0,
      "hideProcessingFee": false,
      "hideResellerFee": false,
      "hideFromBoxOffice": false,
      "hideFromShop": false,
      "hideWhenOffSale": false,
      "hideWhenOutOfStock": false,
      "onSaleFrom": "2021-11-23T10:00:00.000000Z",
      "onSaleUntil": "2021-11-26T17:00:00.000000Z",
      "orderColumn": 1,
      "currentStock": 100,
      "onSale": true,
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z",
      "deletedAt": null
    }
  ],
  "timeslots": [
    {
      "id": 1,
      "name": "et non consequatur",
      "startAt": "2021-01-01T12:00:00.000000Z",
      "endAt": "2021-01-01T12:00:00.000000Z",
      "createdAt": "2021-01-01T12:00:00.000000Z",
      "updatedAt": "2021-01-01T12:00:00.000000Z",
      "deletedAt": null,
      "tickets": [
        [
          1
        ]
      ]
    }
  ],
  "links": {
    "first": "http://api.willms.com/v1/sale-items?page=1",
    "last": "http://api.willms.com/v1/sale-items?page=5",
    "prev": "http://api.willms.com/v1/sale-items?page=2",
    "next": "http://api.willms.com/v1/sale-items?page=5",
    "self": "http://api.willms.com/v1/sale-items?page=3"
  },
  "meta": {
    "total": 50
  }
}

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

ā€‹
itemId
integer

The inventory item ID you wish to retrieve sale items for.

ā€‹
eventId
integer

The event ID you wish to retrieve tickets for. If both eventID and shopID are omitted, all sale items will be returned based on whether the user can view events and/or shops. Where event related sale items are returned, timeslots will be filtered to those associated with the tickets returned on the current page.

ā€‹
shopId
integer

The shop ID you wish to retrieve products for. If both eventID and shopID are omitted, all sale items will be returned based on whether the user can view events and/or shops. Where event related sale items are returned, timeslots will be filtered to those associated with the tickets returned on the current page.

ā€‹
types
enum<string>[]

The types of sale item to return.

Available options:
ticket,
product,
guest_list,
charity,
season_ticket,
cashless_product,
cashless_topup
ā€‹
page
integer

The page you wish to retrieve sale items items. If not specified, by default pagination is handled by offset.

ā€‹
offset
integer

The offset - e.g 2 for listing sale items starting with the 2nd sale item. Offset will always take precedence over page.

ā€‹
limit
integer

The number of sale items to retrieve per page. The maximum (and default) is 25 per page.

ā€‹
lastUpdated
string

Date/Time for retrieving sale items who's associated database records (sale items, inventory item and pricing) 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.

ā€‹
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. saleItems.type,eventTimeslots.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. saleItems.type,eventTimeslots.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successful request to fetch sale items.

ā€‹
saleItems
object[]
ā€‹
timeslots
object[]
ā€‹
links
object
ā€‹
meta
object