View Orders GET

/order/order/
Request Example

Development Endpoint:

https://api.int.janio.asia/api/order/order/

Production Endpoint:

https://api.janio.asia/api/order/order/

// Query parameters will be appended to the end of the endpoint as shown below

GET

https://api.int.janio.asia/api/order/order/?secret_key=SECRETKEY&with_items=true

Query Parameters

secret_key

* required

String

Unique secret key provided by Janio for API access. Approach Janio for production credentials.

with_items

String

Fetches orders with or without item information.

date_from

String

Filter by earliest datetime. ISO8601 format.

date_to

String

Filter by latest datetime. ISO8601 format.

service_id

String

Every Service ID refers to a particular route, and every particular route may have multiple Service IDs. For example, SIN-ID might have service_id of "1" while ID-SIN will have "2", and SIN-TH will have "3”, and so on. Please request Janio for the Service IDs.

shipper_order_id

String

Filter by Shipper Order ID.

upload_batch_no

String

Filter by Upload Batch Number. Every order submission will return a unique Upload Batch Number.

page

String

Server-side pagination, fetches maximum 50 orders per query.

Response Examples

Success 200 

{
  "order_id": 12,
  "service_id": 1,
  "tracking_no": "TRACKINGNUMBER1",
  "agent_id": 4,
  "agent_application_id": 23,
  "hawb_no": null,
  "shipper_sub_account_id": "shipper ABC",
  "shipper_order_id": "ORDERNUM123",
  "store_id": null,
  "consignee_name": "Susan",
  "consignee_number": "+6591234567",
  "consignee_country": "Singapore",
  "consignee_address": "Jurong West Ave 1",
  "consignee_postal": 640534,
  "consignee_state": "Singapore State",
  "consignee_city": null,
  "consignee_province": null,
  "consignee_email": "susan123@email.com",
  "order_length": 0,
  "order_width": 0,
  "order_height": 0,
  "order_weight": 0,
  "pickup_contact_name": "Jackson",
  "pickup_contact_number": "+6291234567891",
  "pickup_country": "Indonesia",
  "pickup_address": "Pos 5 security komp perumahan PT INALUM tanjung gading., Jln berangin.",
  "pickup_postal": "12420",
  "pickup_state": "Daerah Khusus Ibukota Jakarta",
  "pickup_city": "Jakarta Selatan",
  "pickup_province": "Cilandak",
  "payment_type": "cod",
  "delivery_note": "string",
  "cod_amt_to_collect": 40.5,
  "order_label_url": "string",
  "status_code": null,
  "tracker_status_code": "SUCCESS",
  "tracker_main_text": "Delivery successfuly completed by Courier.",
  "upload_batch_no": "string",
  "created_on": "2018-07-02T06:25:41.338681Z",
  "updated_on": "2018-07-02T06:25:41.338726Z"
}

Failure 400 

// Errors are sorted by the index of order submission, for e.g., the 2nd order submitted will always be index 1.

{
    "orders": [
      {
        "fieldname_as_key": [
          "Enter a valid email address."
        ]
      }
    ]
}