XpressConnect
  • Introduction
  • Version History
  • Overview
    • How It Works
    • Server
    • API Request/Response
    • Authentication
  • API Endpoints
    • Courier
      • List
    • Declaration
      • Submit
      • Query
      • Attach
    • Commodity
      • List
    • Claim
      • Submit
      • Query
      • Update
      • Attach Document
      • Detach Document
  • Models
    • Courier
    • Declaration
    • Item
    • Commodity
    • Claim
    • Claim Document
  • Reference
    • Example PHP Code
    • Country
    • Errors
Powered by GitBook
On this page
  • Success Response Params
  • Error Response Params

Was this helpful?

  1. Overview

API Request/Response

All requests are made using HTTP POST method. Request data is formatted in JSON format. Regardless of success/error response, data is always formatted in JSON format, HTTP status code always 200.

All API requests must contain "Content-Type: application/json" HTTP header. If there is no request parameter, the request body must contain an empty JSON object, "{}". Empty request body will result in error.

Success Response Params

Name

Description

Type

status

Status

string ( 100 )

...

Successful Response Params

Example success response:

{
  "status":"SUCCESS"
  ...
}

Error Response Params

Name

Description

Type

status

Status

string ( 100 )

error_code

Error Code

integer

error_msg

Error Message

string ( 255 )

errors

Extra Error Information

array

Example error response:

{
  "status":"ERROR",
  "err_code": "404",
  "err_msg": "Not found",
  "errors": []
}

Note: Each error code defines a different error (e.g. validation, authentication, data format).

PreviousServerNextAuthentication

Last updated 1 year ago

Was this helpful?