API Reference

Create point reservation

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/point-reservations/actions/reserve-points

This endpoint allows you to reserve customer points. It is usually used when you are not sure if a customer will really use the point or when you waiting for his confirmation of the point usage. It prevents point frauds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The external unique ID of the point reservation. You can use your own ID (could be an order ID or reservation ID from your system/application) that will help you identify and filter the point reservation later.

string
required

The unique ID of the customer.

float
required

The number of reserved points.

string

Date and time of the point reservation expiration. (YYYY-MM-DD HH:MM:SS)

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses
204

No Content

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated over 1 year ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago