younifyd
Menu

/api/shipment/tracking/rhp/containerList/{saRefNo} (Get Container List Base on Shipment Advice RefNo)

Get Container List Base on Shipment Advice RefNo.

GET/api/shipment/tracking/rhp/containerList/{saRefNo}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/shipment/tracking/rhp/containerList/{saRefNo} (Get Container List Base on Shipment Advice RefNo) action (under ShipmentTrackingRhpController).
  3. Fill in the fields below, then reference the result from later steps as {{apiShipmentTrackingRhpContainerlistSarefnoGetContainerListBaseOnShipmentAdviceRefno.response.data}}.

Request

Path parameters

saRefNostringrequired

Query parameters

vpoShipmentTrackingRhpDtoobjectrequired
vpoNostring
savListarray<object>7 fields
data_identifystring

One ofVPOSAMILESTONE

roll_up_status_at_vpostring

One ofNONEERRORCOMPLETEDON_TIMEAT_RISKLATE

country_of_originobject7 fields
country_of_destinationobject7 fields
last_updatestring (date-time)

Response

Returns 200 with an object. Read it in later steps with {{apiShipmentTrackingRhpContainerlistSarefnoGetContainerListBaseOnShipmentAdviceRefno.response.data.<field>}}.

vpoNostring
savListarray<object>
savNostring
vpoNoListarray<string>
containerListarray<object>6 fields
roll_up_status_at_savstring

One ofNONEERRORCOMPLETEDON_TIMEAT_RISKLATE

est_arrival_datestring (date)
country_of_destinationobject7 fields
last_updatestring (date-time)
data_identifystring

One ofVPOSAMILESTONE

roll_up_status_at_vpostring

One ofNONEERRORCOMPLETEDON_TIMEAT_RISKLATE

country_of_originobject
cityobject

(schema truncated: exceeded maximum nesting depth)

countryobject

(schema truncated: exceeded maximum nesting depth)

facilityobject

(schema truncated: exceeded maximum nesting depth)

geolocationobject

(schema truncated: exceeded maximum nesting depth)

nameobject

(schema truncated: exceeded maximum nesting depth)

stateobject

(schema truncated: exceeded maximum nesting depth)

unlocodeobject

(schema truncated: exceeded maximum nesting depth)

country_of_destinationobject
cityobject

(schema truncated: exceeded maximum nesting depth)

countryobject

(schema truncated: exceeded maximum nesting depth)

facilityobject

(schema truncated: exceeded maximum nesting depth)

geolocationobject

(schema truncated: exceeded maximum nesting depth)

nameobject

(schema truncated: exceeded maximum nesting depth)

stateobject

(schema truncated: exceeded maximum nesting depth)

unlocodeobject

(schema truncated: exceeded maximum nesting depth)

last_updatestring (date-time)
json
{
  "vpoNo": "string",
  "savList": [
    {
      "savNo": "string",
      "vpoNoList": [
        "string"
      ],
      "containerList": [
        {
          "containerNo": "string",
          "milestoneInfo": {
            "savNo": "string",
            "containerId": "string",
            "referenceId": "string",
            "vpoNoList": [
              null
            ],
            "onTimeStatus": "NONE",
            "milestoneDetailList": [
              null
            ],
            "last_location": {
              "city": null,
              "country": null,
              "facility": null,
              "geolocation": null,
              "name": null,
              "state": null,
              "unlocode": null
            },
            "last_milestone_desc": "string",
            "origin_port": {
              "city": null,
              "country": null,
              "facility": null,
              "geolocation": null,
              "name": null,
              "state": null,
              "unlocode": null
            },
            "destination_port": {
              "city": null,
              "country": null,
              "facility": null,
              "geolocation": null,
              "name": null,
              "state": null,
              "unlocode": null
            },
            "last_update": "2025-01-01T00:00:00Z",
            "error_message": "string"
          },
          "last_update": "2025-01-01T00:00:00Z",
          "container_time_status": "NONE",
          "last_location": {
            "city": "string",
            "country": "string",
            "facility": "string",
            "geolocation": {
              "latitude": null,
              "longitude": null
            },
            "name": "string",
            "state": "string",
            "unlocode": "string"
          },
          "last_milestone_desc": "string"
        }
      ],
      "roll_up_status_at_sav": "NONE",
      "est_arrival_date": "2025-01-01",
      "country_of_destination": {
        "city": {},
        "country": {},
        "facility": {},
        "geolocation": {},
        "name": {},
        "state": {},
        "unlocode": {}
      },
      "last_update": "2025-01-01T00:00:00Z"
    }
  ],
  "data_identify": "VPO",
  "roll_up_status_at_vpo": "NONE",
  "country_of_origin": {
    "city": {},
    "country": {},
    "facility": {},
    "geolocation": {},
    "name": {},
    "state": {},
    "unlocode": {}
  },
  "country_of_destination": {
    "city": {},
    "country": {},
    "facility": {},
    "geolocation": {},
    "name": {},
    "state": {},
    "unlocode": {}
  },
  "last_update": "2025-01-01T00:00:00Z"
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.