member
GET /member
To get a specific member.
/member?token=XXXXX&member_code_365=00100001&is_secondary_code=no
POST /member
To create a member.
{
"api_credentials": {
"token": "XXXX"
},
"member": {
"member_code": "SAP2",
"is_company": false,
"company_name": "",
"last_name": "Doe",
"first_name": "John",
"store_code_365": "100",
"active": true,
"date_of_birth": "1980-05-23 00:00:00",
"gender": "M",
"tel_1": "22445566",
"tel_2": "22001122",
"fax": "22332211",
"mobile": "99008877",
"sms": "99008877",
"email": "jdoe@test.com",
"website": "www.johndoe.com",
"category_code_365_1": "",
"category_code_365_2": "",
"credit_limit_amount": 99999.99,
"vat_registration_number": "VAT100",
"member_id": "ID800523",
"remarks": "notes about John Doe",
"address_line_1": "10 Main Street",
"address_line_2": "",
"address_line_3": "",
"postal_code": "1640",
"town": "Nicosia",
"country_code_iso2": "CY",
"contact_last_name": "",
"contact_first_name": "",
"default_price": 0,
"loyalty_factor": 1.0,
"text_field_1_value": "text_field_1_value",
"text_field_2_value" : "text_field_2_value",
"text_field_3_value" : "text_field_3_value",
"text_field_4_value" : "text_field_4_value",
"text_field_5_value" : "text_field_5_value",
"number_field_1_value":1.1,
"number_field_2_value":1.2,
"number_field_3_value":1.3,
"number_field_4_value":1.4,
"number_field_5_value":1.5,
"date_field_1_value": "2017-01-01",
"date_field_2_value": "2017-01-02",
"date_field_3_value": "2017-01-03",
"date_field_4_value": "2017-01-04",
"date_field_5_value": "2017-01-05",
"registration_date": "2017-06-07",
"expire_date": "2017-12-31",
"renew_date": "2017-06-07",
"pin": "1234567890",
"card_number": "008",
"number_visits": 0,
"remaining_visits": 120,
"main_account": "yes",
"linked_account_code_365": ""
}
}
| field |
type |
description |
| api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| member
|
| member_code |
string |
The unique code of the member in your system. |
| is_company |
bool |
If the member is a company then true. If the member is a person then false. |
| company_name |
string |
If is_company == true, then the company name, else "". |
| last_name |
string |
If is_company == false, then the surname of the person, else "". |
| first_name |
string |
If is_company == false, then the first name of the person, else "". |
| store_code_365 |
string |
The store code in 365 to which this member belongs to. |
| active |
bool |
If the member is active, then true, else false. |
| date_of_birth |
string |
If there is a date of birth, then pass the date as a string in the required format. Else "" |
| gender |
string |
M - male, or F - female, or "" - none |
| tel_1 |
string |
The telephone 1 of the member. Pass "" if none. |
| tel_2 |
string |
The telephone 2 of the member. Pass "" if none. |
| fax |
string |
The fax of the member. Pass "" if none. |
| mobile |
string |
The mobile number of the member. Pass "" if none. |
| sms |
string |
The mobile which the member receives sms messages. Pass "" if none. |
| email |
string |
The email address of the member. Pass "" if none. |
| website |
string |
The website address of the member. Pass "" if none. |
| category_code_1_365 |
string |
The category code 1 in 365 to which this member belongs to. Pass "" if none. |
| category_code_2_365 |
string |
The category 2 code in 365 to which this member belongs to. Pass "" if none. |
| category_code_3_365 |
string |
The category 3 code in 365 to which this member belongs to. Pass "" if none. |
| credit_limit_amount |
decimal |
If the member is not allowed to buy on credit, pass 0.00. If the member is allowed to buy on credit, then pass the maximum amount that he is allowed to buy on credit. |
| vat_registration_number |
string |
The VAT registration number of the member. Pass "" if none. |
| member_id |
string |
If is_company== true, then pass the registration number of the company. If is_company==false, then pass the personal identification number of the member. Pass "" if none. |
| tax_office |
string |
The tax office of the member. Pass "" if none. |
| remarks |
string |
Any notes about the member. Pass "" if none. |
| address_line_1 |
string |
The address line 1.eg. Street number and name. Pass "" if none. |
| address_line_2 |
string |
The address line 2. Pass "" if none. |
| address_line_3 |
string |
The address line 3. Pass "" if none. |
| postal_code |
string |
The postal code of the member. Pass "" if none. |
| town |
string |
The town of the member. Pass "" if none. |
| country_code_iso2 |
string |
The 2 digit ISO code of the country. eg CY for Cyprus. Pass "" if none. |
| contact_last_name |
string |
Any relevant contact person. Their last name. Pass "" if none. |
| contact_first_name |
string |
Any relevant contact person. Their first name. Pass "" if none. |
| default_price |
int |
0-10. The default price indicator which this member gets charged for an item. 0 = member gets charged the store default price. 1-10, the member gets charged the specific price. |
| loyalty_factor |
decimal |
The loyalty factor for this member. If the member earns the same loyalty as the item loyalty factor, pass 1. If the member does not earn points, then pass 0. Otherwise, pass the loyalty factor required. |
| text_field_1_value |
string |
The extra text field 1 for this member. Not required. |
| text_field_2_value |
string |
The extra text field 2 for this member. Not required. |
| text_field_3_value |
string |
The extra text field 3 for this member. Not required. |
| text_field_4_value |
string |
The extra text field 4 for this member. Not required. |
| text_field_5_value |
string |
The extra text field 5 for this member. Not required. |
| number_field_1_value |
decimal |
The extra number field 1 for this member. Not required. |
| number_field_2_value |
decimal |
The extra number field 2 for this member. Not required. |
| number_field_3_value |
decimal |
The extra number field 3 for this member. Not required. |
| number_field_4_value |
decimal |
The extra number field 4 for this member. Not required. |
| number_field_5_value |
decimal |
The extra number field 5 for this member. Not required. |
| date_field_1_value |
string |
The extra date field 1 for this member. Not required. |
| date_field_2_value |
string |
The extra date field 2 for this member. Not required. |
| date_field_3_value |
string |
The extra date field 3 for this member. Not required. |
| date_field_4_value |
string |
The extra date field 4 for this member. Not required. |
| date_field_5_value |
string |
The extra date field 5 for this member. Not required. |
| registration_date |
string |
The registration date for this member. Not required. |
| expire_date |
string |
The expiration date for this member. Not required. |
| renew_date |
string |
The renewel date for this member. Not required. |
| pin |
string |
The personal identification number for this member. Not required. |
| card_number |
string |
The card number number for this member. Not required. |
| number_visits |
integer |
The number of visits for this member. Not required. |
| remaining_visits |
integer |
The remaining of visits for this member. Not required. |
| main_account |
string |
If the member account is main or linked. Required. Only 'yes' and 'no' values are accepted. |
| linked_account_code_365 |
string |
If the member account is a linked account then the 365 account code to which member is linked must be provided. Required in case that main account has value 'no'. |
Returns
The standard api_response object. In the response_id it is returned a semicolon list of the 365 member code and 365 account code.
PUT /member
To modify an existing member.
{
"api_credentials": {
"token": "XXXX"
},
"member": {
"member_code": "SAP2",
"is_company": false,
"company_name": "",
"last_name": "Doe",
"first_name": "John",
"store_code_365": "100",
"active": true,
"date_of_birth": "1980-05-23 00:00:00",
"gender": "M",
"tel_1": "22445566",
"tel_2": "22001122",
"fax": "22332211",
"mobile": "99008877",
"sms": "99008877",
"email": "jdoe@test.com",
"website": "www.johndoe.com",
"category_code_365_1": "",
"category_code_365_2": "",
"credit_limit_amount": 99999.99,
"vat_registration_number": "VAT100",
"member_id": "ID800523",
"remarks": "notes about John Doe",
"address_line_1": "10 Main Street",
"address_line_2": "",
"address_line_3": "",
"postal_code": "1640",
"town": "Nicosia",
"country_code_iso2": "CY",
"contact_last_name": "",
"contact_first_name": "",
"default_price": 0,
"loyalty_factor": 1.0,
"text_field_1_value": "text_field_1_value",
"text_field_2_value" : "text_field_2_value",
"text_field_3_value" : "text_field_3_value",
"text_field_4_value" : "text_field_4_value",
"text_field_5_value" : "text_field_5_value",
"number_field_1_value":1.1,
"number_field_2_value":1.2,
"number_field_3_value":1.3,
"number_field_4_value":1.4,
"number_field_5_value":1.5,
"date_field_1_value": "2017-01-01",
"date_field_2_value": "2017-01-02",
"date_field_3_value": "2017-01-03",
"date_field_4_value": "2017-01-04",
"date_field_5_value": "2017-01-05",
"registration_date": "2017-06-07",
"expire_date": "2017-12-31",
"renew_date": "2017-06-07",
"pin": "1234567890",
"card_number": "008",
"number_visits": 0,
"remaining_visits": 120,
"main_account": "yes",
"linked_account_code_365": ""
}
}
| field |
type |
description |
| api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| member
|
| member_code |
string |
The unique code of the member in your system. |
| is_company |
bool |
If the member is a company then true. If the member is a person then false. |
| company_name |
string |
If is_company == true, then the company name, else "". |
| last_name |
string |
If is_company == false, then the surname of the person, else "". |
| first_name |
string |
If is_company == false, then the first name of the person, else "". |
| store_code_365 |
string |
The store code in 365 to which this member belongs to. |
| active |
bool |
If the member is active, then true, else false. |
| date_of_birth |
string |
If there is a date of birth, then pass the date as a string in the required format. Else "" |
| gender |
string |
M - male, or F - female, or "" - none |
| tel_1 |
string |
The telephone 1 of the member. Pass "" if none. |
| tel_2 |
string |
The telephone 2 of the member. Pass "" if none. |
| fax |
string |
The fax of the member. Pass "" if none. |
| mobile |
string |
The mobile number of the member. Pass "" if none. |
| sms |
string |
The mobile which the member receives sms messages. Pass "" if none. |
| email |
string |
The email address of the member. Pass "" if none. |
| website |
string |
The website address of the member. Pass "" if none. |
| category_code_1_365 |
string |
The category code 1 in 365 to which this member belongs to. Pass "" if none. |
| category_code_2_365 |
string |
The category 2 code in 365 to which this member belongs to. Pass "" if none. |
| category_code_3_365 |
string |
The category 3 code in 365 to which this member belongs to. Pass "" if none. |
| credit_limit_amount |
decimal |
If the member is not allowed to buy on credit, pass 0.00. If the member is allowed to buy on credit, then pass the maximum amount that he is allowed to buy on credit. |
| vat_registration_number |
string |
The VAT registration number of the member. Pass "" if none. |
| member_id |
string |
If is_company== true, then pass the registration number of the company. If is_company==false, then pass the personal identification number of the member. Pass "" if none. |
| tax_office |
string |
The tax office of the member. Pass "" if none. |
| remarks |
string |
Any notes about the member. Pass "" if none. |
| address_line_1 |
string |
The address line 1.eg. Street number and name. Pass "" if none. |
| address_line_2 |
string |
The address line 2. Pass "" if none. |
| address_line_3 |
string |
The address line 3. Pass "" if none. |
| postal_code |
string |
The postal code of the member. Pass "" if none. |
| town |
string |
The town of the member. Pass "" if none. |
| country_code_iso2 |
string |
The 2 digit ISO code of the country. eg CY for Cyprus. Pass "" if none. |
| contact_last_name |
string |
Any relevant contact person. Their last name. Pass "" if none. |
| contact_first_name |
string |
Any relevant contact person. Their first name. Pass "" if none. |
| default_price |
int |
0-10. The default price indicator which this member gets charged for an item. 0 = member gets charged the store default price. 1-10, the member gets charged the specific price. |
| loyalty_factor |
decimal |
The loyalty factor for this member. If the member earns the same loyalty as the item loyalty factor, pass 1. If the member does not earn points, then pass 0. Otherwise, pass the loyalty factor required. |
| text_field_1_value |
string |
The extra text field 1 for this member. Not required. |
| text_field_2_value |
string |
The extra text field 2 for this member. Not required. |
| text_field_3_value |
string |
The extra text field 3 for this member. Not required. |
| text_field_4_value |
string |
The extra text field 4 for this member. Not required. |
| text_field_5_value |
string |
The extra text field 5 for this member. Not required. |
| number_field_1_value |
decimal |
The extra number field 1 for this member. Not required. |
| number_field_2_value |
decimal |
The extra number field 2 for this member. Not required. |
| number_field_3_value |
decimal |
The extra number field 3 for this member. Not required. |
| number_field_4_value |
decimal |
The extra number field 4 for this member. Not required. |
| number_field_5_value |
decimal |
The extra number field 5 for this member. Not required. |
| date_field_1_value |
string |
The extra date field 1 for this member. Not required. |
| date_field_2_value |
string |
The extra date field 2 for this member. Not required. |
| date_field_3_value |
string |
The extra date field 3 for this member. Not required. |
| date_field_4_value |
string |
The extra date field 4 for this member. Not required. |
| date_field_5_value |
string |
The extra date field 5 for this member. Not required. |
| registration_date |
string |
The registration date for this member. Not required. |
| expire_date |
string |
The expiration date for this member. Not required. |
| renew_date |
string |
The renewel date for this member. Not required. |
| pin |
string |
The personal identification number for this member. Not required. |
| card_number |
string |
The card number number for this member. Not required. |
| number_visits |
integer |
The number of visits for this member. Not required. |
| remaining_visits |
integer |
The remaining of visits for this member. Not required. |
| main_account |
string |
If the member account is main or linked. Required. Only 'yes' and 'no' values are accepted. |
| linked_account_code_365 |
string |
If the member account is a linked account then the 365 account code to which member is linked must be provided. Required in case that main account has value 'no'. |
Returns
The standard api_response object. In the response_id it is returned the 365 member code.