GET merchant/promo-list?top={top}&pageSize={pageSize}&page={page}&status={status}&companyRef={companyRef}

Request Information

URI Parameters

Name	Type	Additional information
top	integer	Default value is 0
pageSize	integer	Default value is 20
page	integer	Default value is 1
status	integer	Default value is 1
companyRef	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

ResponseDefault

Name	Type	Additional information
status	string	None.
message	string	None.
data	Object	None.
paging	Paging	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "message": "sample string 2",
  "data": {},
  "paging": {
    "page": 1,
    "pageSize": 2,
    "totalData": 3,
    "totalPage": 4
  }
}

application/xml, text/xml

Sample:

<ResponseDefault xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SYNERGYHUB_SERVICES.DataModels">
  <data />
  <message>sample string 2</message>
  <paging>
    <page>1</page>
    <pageSize>2</pageSize>
    <totalData>3</totalData>
    <totalPage>4</totalPage>
  </paging>
  <status>sample string 1</status>
</ResponseDefault>