OEXPRESS API DOCUMENTATION
    OEXPRESS API DOCUMENTATION
    • Introduction
    • Webhoook - Tracking
    • Webhook - Ticket Message
    • Tickets
      • Get Ticket & Details
        GET
      • Update Ticket Messages
        POST
      • Create/Update Ticket
        POST
      • Update Status Ticket
        PUT
      • Get Group Status Ticket
        GET
    • Wallets
      • Get Balance
        GET
    • Auth
      • Me
        GET
    • List Couriers
      GET
    • Get Subdistrict
      GET
    • Get Shipping Cost
      GET
    • Get Shipping Cost All
      GET
    • Create Order
      POST
    • Cancel Order
      POST
    • Retry Order
      POST
    • [Sandbox Only] Update Status
      POST
    • Track Order
      GET
    • Get Shipping Label
      GET
    • Logistic RTS
      GET
    • List Shipment
      GET
    • Detail Shipment
      GET

      List Shipment

      GET
      /open/1.0/shipment
      Last modified:2025-03-17 08:37:51

      Request

      Query Params
      sort
      string 
      optional
      Example:
      pickup_time
      order
      string 
      optional
      Example:
      asc
      logistic-names
      string 
      optional
      Example:
      IDExpress
      limit
      string 
      optional
      Example:
      10
      offset
      string 
      optional
      Example:
      0
      start-date
      string 
      optional
      UTC
      Example:
      1738281600
      end-date
      string 
      optional
      UTC
      Example:
      1738367999
      Header Params
      X-API-KEY
      string 
      optional
      Example:
      {{ApiKey}}

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET '/open/1.0/shipment'

      Responses

      🟢200OK
      application/json
      Body
      data
      object 
      required
      list
      array [object {20}] 
      required
      pagination
      object 
      required
      message
      string 
      required
      error_code
      integer 
      required
      Example
      {
        "data": {
          "list": [
            {
              "id": "677f9a017865fb1e4e2f461e",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142227",
              "awbNumber": "OEX1142227",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 57223,
              "receiverName": "John Doe 5",
              "receiverPhone": "+6268912345639",
              "receiverCity": "Kota Jakarta Pusat",
              "isLabelPrinted": false,
              "shipmentPrice": 6221.6,
              "senderAddressName": "Jakarta Pusat",
              "weight": 1000
            },
            {
              "id": "677f9a017865fb1e4e2f461f",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142228",
              "awbNumber": "OEX1142228",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 50000,
              "receiverName": "John Doe 6",
              "receiverPhone": "+6268912345630",
              "receiverCity": "Kota Bandung",
              "isLabelPrinted": false,
              "shipmentPrice": 84000,
              "senderAddressName": "Jakarta Pusat",
              "weight": 10000
            },
            {
              "id": "677f9a017865fb1e4e2f4620",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142229",
              "awbNumber": "OEX1142229",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 50000,
              "receiverName": "John Doe 7",
              "receiverPhone": "+6268912345677",
              "receiverCity": "Kota Bandung",
              "isLabelPrinted": false,
              "shipmentPrice": 84000,
              "senderAddressName": "Jakarta Pusat",
              "weight": 10000
            },
            {
              "id": "677f9a017865fb1e4e2f4621",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142230",
              "awbNumber": "OEX1142230",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 500001,
              "receiverName": "John Doe 8",
              "receiverPhone": "+6268912345543",
              "receiverCity": "Kota Bandung",
              "isLabelPrinted": false,
              "shipmentPrice": 84000,
              "senderAddressName": "Jakarta Pusat",
              "weight": 10000
            },
            {
              "id": "677f9a017865fb1e4e2f4622",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142231",
              "awbNumber": "OEX1142231",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 395001,
              "receiverName": "John Doe 9",
              "receiverPhone": "+6268912345123",
              "receiverCity": "Kota Bandung",
              "isLabelPrinted": false,
              "shipmentPrice": 84000,
              "senderAddressName": "Jakarta Pusat",
              "weight": 10000
            },
            {
              "id": "677f9a017865fb1e4e2f4624",
              "referenceNumber": "",
              "shipmentOrderNumber": "",
              "awbNumber": "OEX1142232",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "JNE",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "submission-failed",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 50000,
              "receiverName": "John Doe 2",
              "receiverPhone": "+6268912345631",
              "receiverCity": "Kab. Sumedang",
              "isLabelPrinted": false,
              "shipmentPrice": 14400,
              "senderAddressName": "Jakarta Pusat",
              "weight": 1000
            },
            {
              "id": "677f9a017865fb1e4e2f4626",
              "referenceNumber": "",
              "shipmentOrderNumber": "",
              "awbNumber": "OEX1142233",
              "pickupTime": "2025-01-10T18:03:00Z",
              "logisticName": "SAP Logistic",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "failed-request",
              "created_at": "2025-01-09T09:42:25Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 50000,
              "receiverName": "John Doe 3",
              "receiverPhone": "+6268912345632",
              "receiverCity": "Kab. Sumedang",
              "isLabelPrinted": false,
              "shipmentPrice": 15200,
              "senderAddressName": "Jakarta Pusat",
              "weight": 1000
            },
            {
              "id": "677f9bba7865fb1e4e2f462c",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142234",
              "awbNumber": "OEX1142234",
              "pickupTime": "2025-01-10T19:47:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:49:46Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 34446,
              "receiverName": "John Doe",
              "receiverPhone": "+6268912345678",
              "receiverCity": "Kota Jakarta Pusat",
              "isLabelPrinted": false,
              "shipmentPrice": 12443.2,
              "senderAddressName": "Jakarta Pusat",
              "weight": 2000
            },
            {
              "id": "677f9bba7865fb1e4e2f462d",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142235",
              "awbNumber": "OEX1142235",
              "pickupTime": "2025-01-10T19:47:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:49:46Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 35000,
              "receiverName": "John Doe 3",
              "receiverPhone": "+6268912345632",
              "receiverCity": "Kab. Sumedang",
              "isLabelPrinted": false,
              "shipmentPrice": 12000,
              "senderAddressName": "Jakarta Pusat",
              "weight": 1000
            },
            {
              "id": "677f9bbb7865fb1e4e2f462e",
              "referenceNumber": "",
              "shipmentOrderNumber": "ORDVOOEX1142236",
              "awbNumber": "OEX1142236",
              "pickupTime": "2025-01-10T19:47:00Z",
              "logisticName": "Ninja Xpress",
              "logisticRate": "reguler",
              "logisticLogo": "todo",
              "status": "void",
              "created_at": "2025-01-09T09:49:47Z",
              "expired_at": "Todo what is this?",
              "shipmentType": "PICKUP",
              "transactionValue": 57223,
              "receiverName": "John Doe 5",
              "receiverPhone": "+6268912345639",
              "receiverCity": "Kota Jakarta Pusat",
              "isLabelPrinted": false,
              "shipmentPrice": 6221.6,
              "senderAddressName": "Jakarta Pusat",
              "weight": 1000
            }
          ],
          "pagination": {
            "total": 2006,
            "perPage": 10,
            "currentPage": 21,
            "lastPage": 201
          }
        },
        "message": "success",
        "error_code": 0
      }
      Previous
      Logistic RTS
      Next
      Detail Shipment
      Built with