API Reference

Assign customer

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/purchases/actions/assign-customer

The method assigns customer to the existing purchase. If customer could collect points, he is going to gain corresponding amount of points.
⚠️ Endpoint is available only in the Enterprise interface.

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

ID of the store.

string
required

A unique identifier for an existing purchase in the production system (e.g., E-commerce, POS, ERP). This ID must be unique within the system and reference an actual purchase or order.

If the purchase was created in CareCloud using the CareCloud API, use the same value as the bill_id parameter from the POST /send-purchase endpoint.

string

Number of the customer card. Parameter is mandatory only if customer_id is not set.

string

The unique ID of the customer. Parameter is mandatory only if card_number is not set.

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 3 months 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 3 months ago