GET Express List

Shipper API gives interface access to our clients for retrieving or pulling Express List Data API from Shipper Order/Warehouse Management System

Specification

Field	Endpoint
GET	/v3/fulfillment/express

Query Parameter

Field	Data Type	Description	Mandatory / Optional
express_code	String	Courier code information Example: express_code=AnterAja	Optional
express_name	String	Courier name information Example: express_code=AnterAja	Optional
express_type	String	Express type information Example: OMS	Optional
page	Integer	Page Number of searching, if there is no available data on desired page or page is larger than total returned page, empty array will be returned instead. Example: page=1	Optional
limit	Integer	Limit data Items per Page Example: limit=10	Optional

Sample Query Parameter

Header	How to fill
x-api-key	Shipper API Key

express_code=AnterAja
express_name=AnterAja
express_type=WMS
page=1
limit=10

page=1
limit=10
express_type=WMS

Sample Response

Field	How to fill
x-request-id	Request ID generated from Shipper for tracking purposes

{
  "metadata": {
    "path": "/v3/fulfillment/express?express_code=AnterAja&express_type=WMS",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1652320577
  },
  "data": {
    "express": [
      {
        "express_code": "ANTERAJA",
        "express_name": "Anteraja"
      }
    ]
  },
  "pagination": {
    "current_page": 1,
    "current_elements": 1,
    "total_pages": 1,
    "total_elements": 1
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/express?express_code=AnterAja&express_type=WMS",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1652320577
  },
  "data": {
    "express": [
      {
        "express_code": "ANTERAJA",
        "express_name": "Anteraja"
      }
    ]
  },
  "pagination": {
    "current_page": 1,
    "current_elements": 1,
    "total_pages": 1,
    "total_elements": 1
  }
}

{
  "metadata": {
      "path": "/v3/fulfillment/express","http_status_code": 500,
      "http_status": "Internal Server Error",
      "errors": [
          {
              "code": 10003,
              "message": "Internal Server Error. Please Call Administrator."
          }
      ],
      "timestamp": 1650860120
  }
}