Sub-resources of customers

All available methods for the sub-resources of the resource customer.

Get customer source records

Get information about all customer account source records.
[badge-blue GET] /customers/{customer_id}/customer-source-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
customer_source_records CustomerSourceRecord[] List of the customer source records
total_items integer Count of all found customer source records


Add a source to a customer

Add one of the customer sources to a customer account
[badge-green POST] /customers/{customer_id}/customer-source-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Request

Parameter name Type Description Mandatory (Yes/No)
customer_source_record CustomerSourceRecord Customer source record Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
customer_source_record_id string The unique id for the property record


Get a collection of properties

Get information about all property records on a customer account
[badge-blue GET] /customers/{customer_id}/property-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
property_records PropertyRecord[] List of property records
total_items integer Count of all found customer sources


Add a property to a customer

Add a new specific customer property record to a customer account
[badge-green POST] /customers/{customer_id}/property-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Request

Parameter name Type Description Mandatory (Yes/No)
property_record PropertyRecord Customer property record Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
property_record_id string The unique id for property record


Update a property on an account

Update a specific customer property record on a customer account
[badge-grey PUT] /customers/{customer_id}/property-records/{property_record_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes
property_record_id string The unique id for the property record Yes

Request

Parameter name Type Description Mandatory (Yes/No)
property_record PropertyRecord Customer property record Yes

Response

Status code: 204 No Content


Delete a property on an account

Delete a specific customer property record on a customer account
[badge-red DELETE] /customers/{customer_id}/property-records/{property_record_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes
property_record_id string The unique id for property record Yes

Response

Status code: 204 No Content


Get a collection of interest records

Get information about all interest records on a customer account
[badge-blue GET] /customers/{customer_id}/interest-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
interest_records InterestRecord[] List of interest records
total_items integer Count of all found intertest records


Add an interest record to a customer

Add a new specific customer interest record to a customer account
[badge-green POST] /customers/{customer_id}/interest-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Request

Parameter name Type Description Mandatory (Yes/No)
interest_record InterestRecord Customer interest record Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
interest_record_id string The unique id for the interest record


Update an interest record on an account

Update a specific customer interest record on a customer account
[badge-grey PUT] /customers/{customer_id}/interest-records/{interest_record_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes
interest_record_id string The unique id for the interest record Yes

Request

Parameter name Type Description Mandatory (Yes/No)
interest_record InterestRecord Customer interest record Yes

Response

Status code: 204 No Content


Delete an interest record on an account

Delete a specific customer interest record on a customer account
[badge-red DELETE] /customers/{customer_id}/interest-records/{interest_record_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes
interest_record_id string The unique id for interest record Yes

Response

Status code: 204 No Content


Get a collection of segment records

Get information about all segment records on a customer account
[badge-blue GET] /customers/{customer_id}/segment-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
segment_records SegmentRecord[] List of segment records
total_items integer Count of all found segment records


Get a collection of status records

Get information about all status records on a customer account
[badge-blue GET] /customers/{customer_id}/status-records

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
valid_now boolean Status validity. Just one status can be valid in the time.
Possible values are: True for valid status / False for status not valid
No

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
status_records StatusRecord[] List of status records
total_items integer Count of all found status records


Get a collection of recommendation records

Get information about all recommendation records on a customer account
[badge-blue GET] /customers/{customer_id}/recommendation-records

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Search recommendations by name No

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
recommendation_records Recommendation[] List of Recomendation records
total_items integer Count of all found segment records

Get all customer purchases

Get information about all customer account purchases.
[badge-blue GET] /customers/{customer_id}/purchases

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
store_id string The unique id for the store where purchase was made No
type_id integer Purchase type No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
purchases Purchase[] List of purchases
total_items integer Count of all found purchases

Get all customer point records

Get information about all customer point records.
[badge-blue GET] /customers/{customer_id}/points

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
point_type_id string The unique id of a point type No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
points Point[] List of the point records
total_items integer Count of all found point records

Get all customer vouchers

Get information about all customer vouchers.
[badge-blue GET] /customers/{customer_id}/vouchers

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
store_id string The unique id for the store where the reward can be applied. No
is_valid boolean Filter for valid vouchers.
Possible values: true - all vouchers in validity range, false - all vouchers before or after validity range
No
is_applied boolean Filter voucher by the application condition.
Possible values: true - all applied vouchers, false - all vouchers, that have not been applied yet
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
vouchers Voucher[] List of all recent vouchers
total_items integer Count of all recent vouchers

Get all customer rewards

Get information about all customer rewards.
[badge-blue GET] /customers/{customer_id}/rewards

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string The name or a part of the name of the reward No
store_id string The unique id for the store where customer can apply the reward No
is_valid boolean Filter for valid rewards.
Possible values: true - all rewards in validity range / false - all rewards before or after validity range / no value - all rewards
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
vouchers Reward[] List of all recent rewards
total_items integer Count of all recent rewards

Get all customer cards

Get information about all customer cards.
[badge-blue GET] /customers/{customer_id}/cards

Path parameters

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the Customer Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
customer_id string The unique id for the customer No
card_number string Number of the customer card No
card_type_id string The unique id for the card type No
is_valid boolean If in validity range - true, before or after validity range - false No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
cards Card[] Collection of customer cards
total_items integer Count of all found customer cards