Update Product

PUT

api

billing

products

Update Product

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/products \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "SystemProductType": 123,
  "Description": "<string>",
  "DisplayOrder": 123,
  "Price": 123,
  "CurrencyId": 123,
  "AvailableAs": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/products"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "SystemProductType": 123,
    "Description": "<string>",
    "DisplayOrder": 123,
    "Price": 123,
    "CurrencyId": 123,
    "AvailableAs": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    SystemProductType: 123,
    Description: '<string>',
    DisplayOrder: 123,
    Price: 123,
    CurrencyId: 123,
    AvailableAs: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing Product record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Product-Edit role.

Enums

eProductType — SystemProductType values

Value	Name
0	None
1	DayPass
2	CreditBundle
3	Stationery
4	BookingFeature
5	BookingProducts
99	Other

eRecurrentProductOptions — AvailableAs values

Value	Name
0	None
1	RecurrentOrOneOff
2	OnlyRecurrent
3	OnlyOneOff

Request Body

Required Fields

integer

required

The Id of the Product record to update.

integer

required

ID of the business linked to this record.

string

required

Product name.

integer

required

Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.

string

required

Product description.

integer

required

Display order.

number

required

Product price.

integer

required

ID of the currency linked to this record.

integer

required

Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).

Optional Fields

string

Custom text shown on the invoice line instead of the product name.

string

SKU code.

string

Comma-separated tags for categorising and filtering.

boolean

Whether the product is visible to customers on the members portal and mobile app.

boolean

Whether the product is visible to customers in the NexKiosk app.

boolean

Whether this product is available to any AI channels (Email, Chat or WhatsApp) for recommendations for day passes;.

string

Additional notes about the product that are included in AI channel recommendations and responses to provide more context to customers.

boolean

Whether to show the price of this product in AI channel recommendations and responses based on users’ budget preferences.

number

Override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used).

boolean

Sync to Square Point of Sale.

integer

ID of the tax rate linked to this record.

integer

ID of the reduced tax rate linked to this record.

integer

ID of the exempt tax rate linked to this record.

integer

ID of the financial account linked to this record.

boolean

Restrict purchase to contacts (customers without an active contract).

boolean

Restrict purchase to customers with an active contract (members).

integer[]

List of tariffs linked to this record.

integer[]

The added tariffs value for this product.

integer[]

The removed tariffs value for this product.

boolean

Whether the product is archived. Archived products cannot be sold but existing charges remain active.

boolean

Mark the product as featured or highlighted.

boolean

Enable stock tracking for this product. When enabled, each sale reduces the stock count.

boolean

Allow sales to continue even when stock reaches zero.

integer

Stock level at which a low-stock alert is triggered.

boolean

Whether to pro-rate the price when the product is added or removed part-way through a billing period.

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

boolean

Whether to invoice the customer directly rather than their company or team.

boolean

Sync to NexKiosk.

boolean

Automatically create a delivery record for the customer when this product is purchased.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/products" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "SystemProductType": 0,
    "Description": "",
    "DisplayOrder": 0,
    "Price": 0,
    "CurrencyId": 0,
    "AvailableAs": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/products',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      SystemProductType: 0,
      Description: '',
      DisplayOrder: 0,
      Price: 0,
      CurrencyId: 0,
      AvailableAs: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/products',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'SystemProductType': 0,
        'Description': '',
        'DisplayOrder': 0,
        'Price': 0,
        'CurrencyId': 0,
        'AvailableAs': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the product was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Product was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Delete ProductDelete an existing Product record by its Id.

Update Product

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/products \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "SystemProductType": 123,
  "Description": "<string>",
  "DisplayOrder": 123,
  "Price": 123,
  "CurrencyId": 123,
  "AvailableAs": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/products"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "SystemProductType": 123,
    "Description": "<string>",
    "DisplayOrder": 123,
    "Price": 123,
    "CurrencyId": 123,
    "AvailableAs": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    SystemProductType: 123,
    Description: '<string>',
    DisplayOrder: 123,
    Price: 123,
    CurrencyId: 123,
    AvailableAs: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400