Skip to main content
POST
/
events
/
guest-lists
Create Guest List
curl --request POST \
  --url https://api.nuwebgroup.com/v1/events/guest-lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventId": 1,
  "saleItemData": {
    "pricing": [],
    "totalStock": 500,
    "parentSaleItemId": null,
    "timeslots": [],
    "minOrderQuantity": 1,
    "maxOrderQuantity": 5,
    "scanningGracePeriod": 2,
    "multiplesOf": 2,
    "onSaleFrom": "2021-01-01T12:00:00.000000Z",
    "onSaleUntil": "2021-01-01T12:00:00.000000Z",
    "validFrom": "2021-01-01T12:00:00.000000Z",
    "validUntil": "2021-01-01T12:00:00.000000Z",
    "additionalInformation": "Lorem ipsum dolor sit amet"
  },
  "itemData": {
    "id": null,
    "name": "Lorem ipsum",
    "description": "Lorem ipsum dolor sit amet",
    "totalStock": 500,
    "hasUnlimitedStock": false,
    "requiresApproval": true
  }
}
'
{
  "data": {
    "type": "saleItems",
    "id": 1,
    "attributes": {
      "totalStock": 500,
      "currentStock": 500,
      "onSaleFrom": "2021-11-22T11:59:00.000000Z",
      "onSaleTo": "2021-11-22T11:59:00.000000Z",
      "validFrom": "2021-11-22T11:59:00.000000Z",
      "validUntil": "2021-11-22T11:59:00.000000Z",
      "scanningGracePeriod": 2,
      "minOrderQuantity": 1,
      "maxOrderQuantity": 5,
      "multiplesOf": 1,
      "orderColumn": null,
      "additionalInformation": "Lorem ipsum dolor sit amet",
      "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": 1
        }
      }
    }
  },
  "included": [
    {
      "type": "items",
      "id": 1,
      "attributes": {
        "type": "guest_list",
        "name": "Lorem ipsum",
        "description": "Lorem ipsum dolor sit amet",
        "totalStock": 500,
        "currentStock": 500,
        "hasUnlimitedStock": false,
        "requiresApproval": true,
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "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.

Body

application/json

Request body for creating a guest list sale item.

eventId
integer
saleItemData
object
itemData
object

Response

Successfully created the sale item.

data
object
included
object[]