POST api/agent-sales/v2?token={token}

Seller sales in partner role

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

string

Required

Body Parameters

PartnerSalesV2Request

PartnerSalesV2Request
NameDescriptionTypeAdditional information
product_ids

product identifiers as an array. if not specified, returns statistics for all products

Collection of integer

None.

date_start

start date yyyy-MM-dd HH:mm:ss

string

None.

date_finish

end date yyyy-MM-dd HH:mm:ss

string

None.

returned

refunds 0 - include refunds; 1 - exclude refunds; 2 - refunds only

integer

None.

page

page number (if not specified, the first page is displayed)

integer

None.

rows

number of records per page (default 10, maximum 5000)

integer

None.

sign

signature sha256({id_partner}{product_ids}{date_start}{date_finish}{returned}{page}{rows}{seller_secret}) lowercase

string

None.

Request Formats

application/json, text/json

Sample:
{
  "product_ids": [
    1,
    2
  ],
  "date_start": "sample string 2",
  "date_finish": "sample string 3",
  "returned": 4,
  "page": 5,
  "rows": 6,
  "sign": "sample string 7"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:
<digiseller.request>
  <product_ids>
    <id>1</id>
    <id>2</id>
  </product_ids>
  <date_start>sample string 2</date_start>
  <date_finish>sample string 3</date_finish>
  <returned>4</returned>
  <page>5</page>
  <rows>6</rows>
  <sign>sample string 7</sign>
</digiseller.request>

Response Information

Resource Description

SalesResponse

SalesResponse
NameDescriptionTypeAdditional information
retval

request execution code 0 — request completed successfully request validation error codes: 1 - invalid id_seller parameter; 2 - invalid page parameter; 3 - invalid rows parameter; 9 - invalid returned parameter; 10 - invalid sign parameter; 11 - invalid date_start parameter; 12 - invalid date_finish parameter.

integer

None.

retdesc

execution code description

string

None.

total_rows

total number of records

integer

None.

pages

total number of pages

integer

None.

page

page number

integer

None.

Rows

list of sales

SalesRows

None.

Response Formats

application/json, text/json

Sample:
{
  "retval": 1,
  "retdesc": "sample string 2",
  "total_rows": 3,
  "pages": 4,
  "page": 5,
  "rows": [
    {
      "id_seller": 1,
      "invoice_id": 2,
      "product_id": 3,
      "product_name": "",
      "product_entry_id": 4,
      "date_pay": "sample string 6",
      "email": "sample string 7",
      "wmid": "sample string 8",
      "amount_in": 9.0,
      "amount_currency": "sample string 11",
      "amount_in_usd": 12.0,
      "method_pay": "sample string 13",
      "aggregator_pay": "sample string 14",
      "ip": "sample string 15",
      "partner_percent": 17.0,
      "partner_amount": 18.0,
      "lang": "sample string 19",
      "returned": 20,
      "referer": "sample string 21",
      "owner": 22
    },
    {
      "id_seller": 1,
      "invoice_id": 2,
      "product_id": 3,
      "product_name": "",
      "product_entry_id": 4,
      "date_pay": "sample string 6",
      "email": "sample string 7",
      "wmid": "sample string 8",
      "amount_in": 9.0,
      "amount_currency": "sample string 11",
      "amount_in_usd": 12.0,
      "method_pay": "sample string 13",
      "aggregator_pay": "sample string 14",
      "ip": "sample string 15",
      "partner_percent": 17.0,
      "partner_amount": 18.0,
      "lang": "sample string 19",
      "returned": 20,
      "referer": "sample string 21",
      "owner": 22
    }
  ]
}

application/xml, text/xml

Sample:
<digiseller.response>
  <retval>1</retval>
  <retdesc>sample string 2</retdesc>
  <total_rows>3</total_rows>
  <pages>4</pages>
  <page>5</page>
  <rows cnt="2">
    <row>
      <id_seller>1</id_seller>
      <invoice_id>2</invoice_id>
      <product_id>3</product_id>
      <product_name><![CDATA[]]></product_name>
      <product_entry_id>4</product_entry_id>
      <date_pay>sample string 6</date_pay>
      <email>sample string 7</email>
      <wmid>sample string 8</wmid>
      <amount_in>9</amount_in>
      <amount_currency>sample string 11</amount_currency>
      <amount_in_usd>12</amount_in_usd>
      <method_pay>sample string 13</method_pay>
      <aggregator_pay>sample string 14</aggregator_pay>
      <ip>sample string 15</ip>
      <partner_percent>17</partner_percent>
      <partner_amount>18</partner_amount>
      <lang>sample string 19</lang>
      <returned>20</returned>
      <referer>sample string 21</referer>
      <owner>22</owner>
    </row>
    <row>
      <id_seller>1</id_seller>
      <invoice_id>2</invoice_id>
      <product_id>3</product_id>
      <product_name><![CDATA[]]></product_name>
      <product_entry_id>4</product_entry_id>
      <date_pay>sample string 6</date_pay>
      <email>sample string 7</email>
      <wmid>sample string 8</wmid>
      <amount_in>9</amount_in>
      <amount_currency>sample string 11</amount_currency>
      <amount_in_usd>12</amount_in_usd>
      <method_pay>sample string 13</method_pay>
      <aggregator_pay>sample string 14</aggregator_pay>
      <ip>sample string 15</ip>
      <partner_percent>17</partner_percent>
      <partner_amount>18</partner_amount>
      <lang>sample string 19</lang>
      <returned>20</returned>
      <referer>sample string 21</referer>
      <owner>22</owner>
    </row>
  </rows>
</digiseller.response>