A BasketSession is an internal entity that temporarily stores basket items while a customer is checking out on the Members Portal. It is not intended for direct use via the API or CLI.
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 BasketSession-Create role.
Request Body
Required Fields
Unique session identifier linking the basket to the customer’s browser session.
Optional Fields
JSON-serialised basket contents including selected products, quantities, and pricing.
Code Examples
curl -X POST \
"https://spaces.nexudus.com/api/billing/basketsessions" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"BusinessId": 0,
"SessionId": ""
}'
Response
200
HTTP status code. 200 on success.
A human-readable message confirming the creation.
Contains the Id of the newly created record.
true if the basketsession was created successfully.
{
"Status" : 200 ,
"Message" : "BasketSession was successfully created." ,
"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
A summary of the validation error(s), in the format PropertyName: error message.
null on validation failure.
Array of validation errors. The value that was submitted for the field, or null if missing.
The validation error message.
The name of the property that failed validation.
false when the request fails validation.
{
"Message" : "SessionId: is a required field" ,
"Value" : null ,
"Errors" : [
{
"AttemptedValue" : null ,
"Message" : "is a required field" ,
"PropertyName" : "SessionId"
}
],
"WasSuccessful" : false
}