Manage resellers

All the reseller related APIs are encapsulated in the class com.pax.market.api.sdk.java.api.reseller.ResellerApi.

User can customize the additional attributes for reseller. To add/delete/update reseller's additional entity attributes please using marketplace admin login and go to page via General Setting -> Entity Attribute Setting.

Constructors of ResellerAPI

public ResellerApi(String baseUrl, String apiKey, String apiSecret);

Constructor parameters description

Name	Type	Description
baseUrl	String	the base url of REST API
apiKey	String	the apiKey of marketplace, get this key from PAXSTORE admin console, refer to chapter Apply access rights
apiSecret	String	apiSecret, get api secret from PAXSTORE admin console, refer to chapter Apply access rights

Search resellers

API

public Result<ResellerPageDTO>  searchReseller(int pageNo, int pageSize, ResellerSearchOrderBy orderBy, String name, ResellerStatus status)

Input parameter(s) description

Name	Type	Nullable	Description
pageNo	int	false	page number, value must >=1
pageSize	int	false	the record number per page, range is 1 to 100
orderBy	ResellerSearchOrderBy	true	the field name of sort order by, if it is null the search result will sort by id by default, and the value of the parameter can be one of ResellerSearchOrderBy.Name, ResellerSearchOrderBy.Phone and ResellerSearchOrderBy.Contact
name	String	true	search filter by reseller name
status	ResellerStatus	true	the reseller status the value can be ResellerStatus.Active, ResellerStatus.Inactive, ResellerStatus.Suspend

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<ResellerPageDTO> result = resellerApi.searchReseller(1, 10, null, "super", ResellerStatus.Suspend);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["pageSize:must be greater than or equal to 1"]
}

Successful sample result(JSON formatted)

{
	"businessCode": 0,
	"pageInfo": {
		"pageNo": 1,
		"limit": 10,
		"totalCount": 2,
		"hasNext": false,
		"dataSet": [{
			"id": 17850,
			"name": "FVFFF",
			"phone": "87879696",
			"country": "CN",
			"contact": "FFF",
			"email": "FF@1234.COM",
			"status": "S"
		}, {
			"id": 8736,
			"name": "Max",
			"phone": "123",
			"country": "CN",
			"postcode": "123",
			"contact": "Max",
			"email": "zhihao_w@qq.com",
			"status": "S"
		}]
	}
}

The type in dataSet of is ResellerPageDTO. And the structure shows like below.

Property Name	Type	Description
id	Long	the id of reseller
name	String	the name of reseller
phone	String	the phone number of reseller
country	String	the country code, please refer to Country Codes
postcode	String	the postcode of reseller
email	String	the email of reseller
status	String	the status of reseller, value can be one of A(Active), P(Pendding) and S(Suspend)

Possible client validation errors

pageSize:must be greater than or equal to 1
pageNo:must be greater than or equal to 1
pageSize:must be less than or equal to 100

Get a reseller

Get reseller by reseller id.

API

public Result<ResellerDTO>  getReseller(Long resellerId)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerId	Long	false	the id of reseller

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<ResellerDTO> result = resellerApi.getReseller(17850L);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["Parameter resellerId cannot be null and cannot be less than 1!"]
}

Server side validation failed sample result(JSON formatted)

{
	"businessCode": 1760,
	"message": "Reseller name already exists"
}

Successful sample result(JSON formatted)

{
	"businessCode": 0,
	"data": {
		"entityAttributeValues": {
			"111": "hello"
		},
		"parent": {
			"id": 4151,
			"name": "New York"
		},
		"id": 17850,
		"name": "FVFFF",
		"phone": "87879696",
		"country": "CN",
		"contact": "FFF",
		"email": "sum@gmail.com",
		"status": "S"
	}
}

The type of data is ResellerDTO, and the structure shows below.

Name	Type	Description
id	Long	the id of reseller
name	String	the name of reseller
phone	String	the phone number of reseller
country	String	the country code, please refer to Country Codes
postcode	String	the postcode of reseller
email	String	the email of reseller
status	String	the status of reseller, value can be one of A(Active), P(Pendding) and S(Suspend)
parent	SimpleResellerDTO	reseller's parent
entityAttributeValues	LinkedHashMap<String, String>	dynamic attributes

Structure of SimpleResellerDTO

Name	Type	Description
id	Long	the id of reseller
name	String	the name of reseller

Possible client validation errors

Parameter resellerId cannot be null and cannot be less than 1!

Possible business codes

Business Code	Message	Description
1759	Reseller doesn't exist

Create a reseller

API

public Result<ResellerDTO>  createReseller(ResellerCreateRequest resellerCreateRequest)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerCreateRequest	ResellerCreateRequest	false	the create request object, the structure like below

Structure of class ResellerCreateRequest

Property Name	Type	Nullable	Description
name	String	false	Name of reseller, max length is 64.
email	String	false	Email of reseller, max length is 255.
country	String	false	the country code, please refer to Country Codes
contact	String	false	contact of reseller, max length is 64.
phone	String	false	Phone number of reseller, max length is 32. Sample value 400-86554555.
postcode	String	true	Post code, max length is 32. Sample value 510250.
address	String	true	Address of reseller, max length is 255.
company	String	true	Company of reseller, max length is 255.
parentResellerName	String	true	Parent reseller name, if it is empty will set the root reseller of current marketplace as the parent reseller
entityAttributeValues	LinkedHashMap<String, String>	false	Dynamic attributes. Whether the attributes is required or not depends on the attributes configuration.
activateWhenCreate	Boolean	true	Whether to activate the reseller when create, default value is false

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
ResellerCreateRequest request = new ResellerCreateRequest();
request.setName("reseller_abc");
request.setContact("Sam");
request.setCountry("CN");
request.setEmail("sam@gmail.com");
request.setPhone("87879696");
request.setParentResellerName("New York");
LinkedHashMap<String,String> attrs = new LinkedHashMap<String,String>();
attrs.put("code", "ABC");
request.setEntityAttributeValues(attrs);
Result<ResellerDTO> result = resellerApi.createReseller(request);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["email:may not be empty", "country:may not be empty"]
}

Server side validation failed sample result(JSON formatted)

{
	"businessCode": 1760,
	"message": "Reseller name already exists"
}

Successful sample result(JSON formatted)

{
	"businessCode": 0,
	"data": {
		"entityAttributeValues": {
			"111": "tan2"
		},
		"parent": {
			"id": 4151,
			"name": "New York"
		},
		"id": 51741,
		"name": "reseller_abc",
		"phone": "87879696",
		"country": "CN",
		"contact": "Sam",
		"email": "sam@gmail.com",
		"status": "P"
	}
}

Type of data is ResellerDTO, same as the API get reseller.

Possible client validation errors

Parameter resellerCreateRequest cannot be null!
contact:may not be empty
email:may not be empty
name:may not be empty
country:may not be empty
name:length must be between 0 and 64
email:length must be between 0 and 255
country:length must be between 0 and 64
contact:length must be between 0 and 64
phone:may not be empty
phone:length must be between 0 and 32
postcode:length must be between 0 and 16
address:length must be between 0 and 255
company:length must be between 0 and 255
parentResellerName:length must be between 0 and 64
email:not a well-formed email address

Possible business codes

Business Code	Message	Description
1778	Parent reseller not found
1779	Parent reseller is not active
1782	At most 10 level resellers are supported
1760	Reseller name already exists
1762	Reseller name is mandatory
1763	Reseller contact is mandatory
1764	Reseller phone is mandatory
1765	Reseller email is mandatory
1606	Country is mandatory
1767	Reseller name is too long
1768	Reseller contact is too long
1769	Reseller phone is too long
1770	Reseller email is too long
1618	Postcode is too long
1619	Address is too long
1771	Reseller company is too long
1105	Email is invalid
1112	Phone No. is invalid
1624	The name cannot contain special characters	Name can contain the characters 0-9, a-z, A-Z, space, Chinese characters,(,),_,.
3400	Country code is invalid

Update a reseller

API

public Result<ResellerDTO>  updateReseller(Long resellerId, ResellerUpdateRequest resellerUpdateRequest)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerId	Long	false	Reseller's id.
resellerUpdateRequest	ResellerUpdateRequest	false	The update request object, the structure like below

Structure of class ResellerUpdateRequest

Property Name	Type	Nullable	Description
name	String	false	Name of reseller, max length is 64.
email	String	true	Email of reseller, max length is 255. Only the pending reseller can update the email. For other reseller change email please call replaceResellerEmail API. If email is empty API won't update the email.
country	String	false	the country code, please refer to Country Codes
contact	String	false	contact of reseller, max length is 64.
phone	String	false	Phone number of reseller, max length is 32. Sample value 400-86554555.
postcode	String	true	Post code, max length is 32. Sample value 510250.
address	String	true	Address of reseller, max length is 255.
company	String	true	Company of reseller, max length is 255.
parentResellerName	String	true	Do not suggest set value for this property. If set value please keep the parentResellerName same as the original parentResellerName. Otherwise API will return a 1830 business code.
entityAttributeValues	LinkedHashMap<String, String>	false	Dynamic attributes. Whether the attributes is required or not depends on the attributes configuration.

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
ResellerUpdateRequest request = new ResellerUpdateRequest();
request.setName("FVFFF");
request.setContact("FFF");
request.setCountry("CN");
request.setEmail("FF@1234.COM");
request.setPhone("87879696");
LinkedHashMap<String,String> attrs = new LinkedHashMap<String,String>();
attrs.put("code", "XY");
request.setEntityAttributeValues(attrs);
Result<ResellerDTO> result = resellerApi.updateReseller(17850L, request);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["country:may not be empty", "contact:may not be empty", "name:may not be empty"]
}

Server side validation failed sample result(JSON formatted)

{
	"businessCode": 12000,
	"message": "code is mandatory"
}

Note: the code in message is the dynamic attribute for the above failed sample result

Successful sample result(JSON formatted)

{
	"businessCode": 0,
	"data": {
		"entityAttributeValues": {
			"code": "XY"
		},
		"parent": {
			"id": 4151,
			"name": "New York"
		},
		"id": 17850,
		"name": "FVFFF",
		"phone": "87879696",
		"country": "CN",
		"contact": "FFF",
		"email": "FF@1234.COM",
		"status": "S"
	}
}

Type of data is ResellerDTO, same as the API get reseller.

Possible client validation errors

Parameter resellerId cannot be null and cannot be less than 1!
Parameter resellerUpdateRequest cannot be null!
contact:may not be empty
name:may not be empty
country:may not be empty
name:length must be between 0 and 64
email:length must be between 0 and 255
country:length must be between 0 and 64
contact:length must be between 0 and 64
phone:may not be empty
phone:length must be between 0 and 32
postcode:length must be between 0 and 16
address:length must be between 0 and 255
company:length must be between 0 and 255
email:not a well-formed email address
parentResellerName:length must be between 0 and 64

Possible business codes

Business Code	Message	Description
1759	Reseller doesn't exist
1762	Reseller name is mandatory
1764	Reseller phone is mandatory
1606	Country is mandatory
1763	Reseller contact is mandatory
1767	Reseller name is too long
1769	Reseller phone is too long
1768	Reseller contact is too long
1618	Postcode is too long
1619	Address is too long
1771	Reseller company is too long
1770	Reseller email is too long
1105	Email is invalid
1112	Phone No. is invalid
1624	The name cannot contain special characters	Name can contain the characters 0-9, a-z, A-Z, space, Chinese characters,(,),_,.
3400	Country code is invalid
1925	The reseller is not inactive,reseller email cannot be updated!	The update reseller API can only update the email for the inactive reseller. To change the email for other resellers please use the replaceResellerEmail API
1830	Cannot update reseller's parent	Cannot change the reseller's parent when updating a reseller

Activate a reseller

API

If activate reseller successfully there's not response content from remote server. So the data field in result is null whether activate sucessfully not not.

public Result<String> activateReseller(Long resellerId)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerId	Long	false	The reseller's id.

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<String> result = resellerApi.activateReseller(51739L);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["Parameter resellerId cannot be null and cannot be less than 1!"]
}

Server side validation failed sample result(JSON formaatted)

{
	"businessCode": 1891,
	"message": "The reseller has already been activated!"
}

Succssful sample result(JSON formatted)

{
	"businessCode": 0
}

Possible client validation errors

Parameter resellerId cannot be null and cannot be less than 1!

Possible business codes

BusinessCode	Message	Description
1759	Reseller doesn't exist	The input reseller id not correct.
1891	The reseller has already been activated!
1894	The reseller's parent is not active

Disable a reseller

API

If disable successfully there's no response content from remote server. So the data field in result is null whether disable successfully or not.

public Result<String> disableReseller(Long resellerId)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerId	Long	false	The reseller's id.

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<String> result = resellerApi.disableReseller(51739L);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["Parameter resellerId cannot be null and cannot be less than 1!"]
}

Server side validation failed sample result(JSON formatted)

{
	"businessCode": 1886,
	"message": "The reseller is not active,unable to disable!"
}

Successful sample result(JSON formatted)

{
	"businessCode": 0
}

Possible client validation errors

Parameter resellerId cannot be null and cannot be less than 1!

Possible business codes

BusinessCode	Message	Description
1759	Reseller doesn't exist	The input reseller id not correct.
1886	The reseller is not active,unable to disable!
1793	The reseller has active merchants
1794	The reseller has active terminals
1795	The reseller has active terminal groups
1781	The reseller has active sub-resellers

Delete a reseller

API

If delete reseller successfully there's not response content from remote server. And the data field in result is always null.

public Result<String> deleteReseller(Long resellerId)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerId	Long	false	The reseller's id.

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<String> result = resellerApi.deleteReseller(51739L);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["Parameter resellerId cannot be null and cannot be less than 1!"]
}

Server side validation failed sample result(JSON formatted)

{
	"businessCode": 1759,
	"message": "Reseller doesn't exist"
}

Successful sample result

{
	"businessCode": 0
}

Possible client validation errors

Parameter resellerId cannot be null and cannot be less than 1!

Possible business codes

BusinessCode	Message	Description
1759	Reseller doesn't exist	The input reseller id not correct.
1875	The reseller is active,unable to delete!
1775	Not allowed to delete the reseller of current user
1761	Reseller has been used by merchant
1785	The reseller has been used by terminal
1788	The reseller has been used by terminal group
1780	The reseller has sub-resellers

Replace reseller email

API

This API is used to update email of the active resellers

public Result<String> replaceResellerEmail(Long resellerId, String email)

Input parameter(s) description

Parameter Name	Type	Nullable	Description
resellerId	Long	false	The reseller's id.
email	String	false	The new email address.

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<String> result = resellerApi.replaceResellerEmail(51739L, "zhangsan@pax.com");

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["Parameter resellerId cannot be null and cannot be less than 1!"]
}

Server side validation failed sample result(JSON formatted)

{
	"businessCode": 1759,
	"message": "Reseller doesn't exist"
}

Successful sample result

{
	"businessCode": 0
}

Possible client validation errors

Parameter resellerId cannot be null and cannot be less than 1! Parameter email format invalid! Parameter email is too long, maxlength is 255!

Possible business codes

BusinessCode	Message	Description
1759	Reseller doesn't exist	The input reseller id not correct.
131	Insufficient access right	This may caused by updating the root reseller's email
1932	The reseller is not active,unable to replace user!	This API can only the active reseller's email
1105	Email is invalid	Email address is not valid
1933	The user email not update.	The inputted email address is same as the original email

Search reseller RKI key template list

API

public Result<ResellerRkiKeyPageDTO> searchResellerRkiKeyList(Long resellerId, int pageNo, int pageSize, String rkiKey)

Input parameter(s) description

Name	Type	Nullable	Description
resellerId	Long	false	The reseller's id.
pageNo	int	false	page number, value must >=1
pageSize	int	false	the record number per page, range is 1 to 1000
rkiKey	String	true	search filter by RKI key

Sample codes

ResellerApi resellerApi = new  ResellerApi("https://api.whatspos.com/p-market-api", "RCA9MDH6YN3WSSGPW6TJ", "TUNLDZVZECHNKZ4FW07XFCKN2W0N8ZDEA5ENKZYN");
Result<ResellerRkiKeyPageDTO> resultRkiKey = resellerApi.searchResellerRkiKeyList(51739L, 1, 10, null);

Client side validation failed sample result(JSON formatted)

{
	"businessCode": -1,
	"validationErrors": ["pageSize:must be greater than or equal to 1"]
}

Successful sample result(JSON formatted)

{
	"businessCode": 0,
	"pageInfo": {
		"pageNo": 1,
		"limit": 10,
		"totalCount": 2,
		"hasNext": false,
		"dataSet": [{
			"keyId": "TMK_TEST"
		}, {
			"keyId": "Test_new_versionT2"
		}]
	}
}

The type in dataSet of is ResellerRkiKeyPageDTO. And the structure shows like below.

Property Name	Type	Description
keyId	String	the identifier of RKI key template

Possible client validation errors

pageSize:must be greater than or equal to 1
pageNo:must be greater than or equal to 1
pageSize:must be less than or equal to 1000

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RESELLER_API.md

RESELLER_API.md

Manage resellers

Search resellers

Get a reseller

Create a reseller

Update a reseller

Activate a reseller

Disable a reseller

Delete a reseller

Replace reseller email

Search reseller RKI key template list

Files

RESELLER_API.md

Latest commit

History

RESELLER_API.md

File metadata and controls

Manage resellers

Search resellers

Get a reseller

Create a reseller

Update a reseller

Activate a reseller

Disable a reseller

Delete a reseller

Replace reseller email

Search reseller RKI key template list