Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Mandatory field

Adopted values

Default value

Description

orderNumber

Yes

String 128  characters


Order number

merchant_Id

Yes

Number


The enterprise identifier in IPS Assist

login

Yes

8-20 characters


Login (Latin letters, digits and symbol _)

password

Yes

8-20 characters


Password (Latin letters and digits)

startYear

No

Year in "2011" format

Minus three days from the current date

Sampling start date (GMT)

startMonth

No

1-12

Minus three days from the current date

startDay

No

1-31

Minus three days from the current date

startHour

No

0-23

Minus three days from the current date

StartMinstartMin

No

0-59

Minus three days from the current date

EndYearendYear

No

Year in "2011" format

Current year

Sampling end date (GMT)

EndMonthendMonth

No

1-12

Current month

EndDayendDay

No

1-31

Current day

EndHourendHour

No

0-23

Current hour

EndMinendMin

No

0-59

Current minute

Formatformat

No

1 – CSV
3 – XML
4 - SOAP
5 - JSON

4

Format of the results output. Passed only for a request in POST format (by default, the response will be in SOAP format). For other formats, the response is returned in the same format in which the request was made.

Note

All request parameters are automatically validated. The validation rules are given in the table "table The validation rules for input parameters".

An example of HTTP POST request for receiving a status of order 1001-01 whose payment started on July 6, 2016 (GMT):

Code Block
languagexml
<FORM ACTION="https://<SERVER-NAME>/orderstate/orderstate.cfm" METHOD="POST">
<INPUT TYPE="HIDDEN" NAME="OrdernumberorderNumber" VALUE="1001-01">
<INPUT TYPE="HIDDEN" NAME="Merchant_ID" VALUE="Your Merchant_ID">
<INPUT TYPE="HIDDEN" NAME="Login" VALUE="Your login">
<INPUT TYPE="HIDDEN" NAME="Password" VALUE="Your password">
<INPUT TYPE="HIDDEN" NAME="Startyear" VALUE="2016">
<INPUT TYPE="HIDDEN" NAME="Startmonth" VALUE="07">
<INPUT TYPE="HIDDEN" NAME="Startday" VALUE="06">
<INPUT TYPE="HIDDEN" NAME="Starthour" VALUE="00">
<INPUT TYPE="HIDDEN" NAME="Startmin" VALUE="00">
<INPUT TYPE="HIDDEN" NAME="Endyear" VALUE="2016">
<INPUT TYPE="HIDDEN" NAME="Endmonth" VALUE="07">
<INPUT TYPE="HIDDEN" NAME="Endday" VALUE="07">
<INPUT TYPE="HIDDEN" NAME="Endhour" VALUE="00">
<INPUT TYPE="HIDDEN" NAME="Endmin" VALUE="00">
<INPUT TYPE="HIDDEN" NAME="Format" VALUE="3">
<INPUT TYPE="SUBMIT" NAME="Submit" VALUE="Submit">
</FORM>

...