Document API

Get status of Orders

Description

This API operation allows you to get a status of order on VietnamCredit. Based on the results, you may decide to download the information.

Url request: api.vietnamcredit.com.vn/api/Orders/getOrderStatus

Method: GET

Request Parameters

The following are common parameters used with list order for customer.

Name Description Required
orderIds

List Id of the order, example: [1,2,3,4]

Type: List of integers

 Yes

Response

The following are common elements that are returned.

Name Description
Success

True: success

False: fail
Message

Notification returned

Data

Container for item information, including Id, Name, Status, ReportTypeId and CustomerDueDate.

Status field:
1：The report is done
2：The report has been canceled
3：The report has been updated

ReportTypeId field:
2：Company Profile
3：Financial Statement Report
4：Comprehensive Report
6：Simple Report
8：Light Report

Example Requests and Responses

Example Request

api.vietnamcredit.com.vn/api/Orders/getOrderStatus?orderIds=1&orderIds=2

Example Responses

{
  "message": null,
  "success": true,
  "data": [
    {
      "id": 734,
      "name": "ASIA PAINT VIETNAM COMPANY LIMITED - CONG TY TNHH SON A CHAU VIET NAM",
      "status": 1,
      "reportTypeId": 4,
      "customerDueDate": "2010-11-26T00:00:00"
    },
    {
      "id": 3754,
      "name": "THONG NHAT ELECTROMECHANICAL LIMITED COMPANY",
      "status": 3,
      "reportTypeId": null,
      "customerDueDate": "2010-11-26T00:00:00"
    }
  ]
}