Skip to main content

SHIPMENT_STOP — Oracle Transportation Management Reference

Shipment stop locations for pickup and delivery points.

This page documents the SHIPMENT_STOP table in Oracle Transportation Management (OTM) -- columns, primary key, incremental cursor, and the exact REST API endpoints used to extract it. This is one of 18 OTM tables that Supaflow's Oracle Transportation Management connector syncs natively into Snowflake, Databricks, BigQuery, Redshift, or Postgres.

Overview

AttributeValue
OTM export table nameSHIPMENT_STOP
OTM metadata resource nameshipmentStops
Composite primary keySHIPMENT_GID, STOP_NUM
Incremental cursor fieldUPDATE_DATE
CategoryShipment children

OTM REST API endpoints

OTM exposes every table through the logistics REST API. Paths depend on the authentication method you use.

Export API (fetch rows)

POST one of the following URLs, depending on your OTM authentication mode:

  • OAuth 2.0 (IDCS): https://{your-otm-host}/logisticsRestApi/data/v1/exportRequests/
  • Basic Auth: https://{your-otm-host}/logisticsRestApi/data-int/v1/exportRequests/

Example request body for SHIPMENT_STOP:

{
"schema": "PRIMARY",
"contentType": "text/plain",
"tables": {
"items": [
{ "tableName": "SHIPMENT_STOP", "partSize": 5000 }
]
}
}

To pull only rows updated after a given timestamp (the recommended pattern for incremental sync), add a rangeAfter block:

{
"schema": "PRIMARY",
"contentType": "text/plain",
"rangeAfter": { "value": "2026-04-01T00:00:00Z" },
"tables": {
"items": [
{ "tableName": "SHIPMENT_STOP", "partSize": 5000 }
]
}
}

The response is a CSV payload with the table name on line 1, column headers on line 2, and data rows starting on line 3.

Metadata catalog (fetch schema)

GET the schema for SHIPMENT_STOP:

  • OAuth 2.0: https://{your-otm-host}/logisticsRestApi/resources/v2/metadata-catalog/shipmentStops
  • Basic Auth: https://{your-otm-host}/logisticsRestApi/resources-int/v2/metadata-catalog/shipmentStops
note

The OTM metadata-catalog endpoint returns HTTP 400 for several tables. If you receive a 400 here, fall back to data-driven type inference by sampling rows from the Export API. See the OTM integration guide for the full pattern.

Columns

ColumnTypeNullablePKForeign key
SHIPMENT_GIDVARCHAR2(101)YesSHIPMENT
STOP_NUMNUMBERYes
LOCATION_GIDVARCHAR2(101)LOCATION
LOCATION_ROLE_GIDVARCHAR2(101)YesLOCATION_ROLE
PLANNED_ARRIVALDATEYes
ESTIMATED_ARRIVALDATEYes
IS_FIXED_ARRIVALCHAR(1)
ACTUAL_ARRIVALDATEYes
PLANNED_DEPARTUREDATEYes
ESTIMATED_DEPARTUREDATEYes
IS_FIXED_DEPARTURECHAR(1)
ACTUAL_DEPARTUREDATEYes
WAIT_TIMENUMBER()Yes
WAIT_TIME_UOM_CODEVARCHAR2(64)Yes
WAIT_TIME_BASENUMBER()Yes
REST_TIMENUMBER()Yes
REST_TIME_UOM_CODEVARCHAR2(64)Yes
REST_TIME_BASENUMBER()Yes
DRIVE_TIMENUMBER()Yes
DRIVE_TIME_UOM_CODEVARCHAR2(64)Yes
DRIVE_TIME_BASENUMBER()Yes
DIST_FROM_PREV_STOPNUMBER()Yes
DIST_FROM_PREV_STOP_UOM_CODEVARCHAR2(64)Yes
DIST_FROM_PREV_STOP_BASENUMBER()Yes
ACTIVITY_TIMENUMBER()Yes
ACTIVITY_TIME_UOM_CODEVARCHAR2(64)Yes
ACTIVITY_TIME_BASENUMBER()Yes
IS_PERMANENTVARCHAR2(1) Y/N
IS_DEPOTVARCHAR2(1) Y/N
APPOINTMENT_PICKUPDATEYes
APPOINTMENT_DELIVERYDATEYes
ACCESSORIAL_TIMENUMBER()Yes
ACCESSORIAL_TIME_UOM_CODEVARCHAR2(64)Yes
ACCESSORIAL_TIME_BASENUMBER()Yes
PARENT_LOCATION_GIDVARCHAR2(101)YesLOCATION
LOCATION_OVERRIDE_GIDVARCHAR2(101)YesLOCATION_OVERRIDE
STOP_REQUIREMENT_TYPEVARCHAR2(50) MANDATORY/OPTIONALYes
RATE_SERVICE_GIDVARCHAR2(101)YesRATE_SERVICE
ARBITRARY_TYPEVARCHAR2(10) SOURCE/DESTYes
IS_FIXED_DISTANCEVARCHAR2(1) Y/N
EXT_SEQ_NONUMBERYes
RUSH_HOUR_TIMENUMBER()Yes
RUSH_HOUR_TIME_UOM_CODEVARCHAR2(64)Yes
RUSH_HOUR_TIME_BASENUMBER()Yes
VOYAGE_GIDVARCHAR2(101)YesVOYAGE
IS_MOTHER_VESSELVARCHAR2(1) Y/N
FLIGHT_INSTANCE_IDNUMBERYesFLIGHT_INSTANCE
REPETITION_SCHEDULE_GIDVARCHAR2(101)YesREPETITION_SCHEDULE
STOP_TYPEVARCHAR2(16) P/D/PD/O/NFR/TYes
SLACK_VARIANCENUMBER()Yes
DRIVER_NON_PAYABLEVARCHAR2(1) Y/N
REPETITION_SCHED_STOP_NUMBERNUMBERYes
DISTANCE_TYPEVARCHAR2(1)Yes
DOMAIN_NAMEVARCHAR2(50)
INSERT_USERVARCHAR2(128)
INSERT_DATEDATE
UPDATE_USERVARCHAR2(128)Yes
UPDATE_DATEDATEYes
ATTRIBUTE1VARCHAR2(150)Yes
ATTRIBUTE2VARCHAR2(150)Yes
ATTRIBUTE3VARCHAR2(150)Yes
ATTRIBUTE4VARCHAR2(150)Yes
ATTRIBUTE5VARCHAR2(150)Yes
ATTRIBUTE6VARCHAR2(150)Yes
ATTRIBUTE7VARCHAR2(150)Yes
ATTRIBUTE8VARCHAR2(150)Yes
ATTRIBUTE9VARCHAR2(150)Yes
ATTRIBUTE10VARCHAR2(150)Yes
ATTRIBUTE11VARCHAR2(150)Yes
ATTRIBUTE12VARCHAR2(150)Yes
ATTRIBUTE13VARCHAR2(150)Yes
ATTRIBUTE14VARCHAR2(150)Yes
ATTRIBUTE15VARCHAR2(150)Yes
ATTRIBUTE16VARCHAR2(150)Yes
ATTRIBUTE17VARCHAR2(150)Yes
ATTRIBUTE18VARCHAR2(150)Yes
ATTRIBUTE19VARCHAR2(150)Yes
ATTRIBUTE20VARCHAR2(150)Yes
ATTRIBUTE_NUMBER1NUMBER()Yes
ATTRIBUTE_NUMBER2NUMBER()Yes
ATTRIBUTE_NUMBER3NUMBER()Yes
ATTRIBUTE_NUMBER4NUMBER()Yes
ATTRIBUTE_NUMBER5NUMBER()Yes
ATTRIBUTE_NUMBER6NUMBER()Yes
ATTRIBUTE_NUMBER7NUMBER()Yes
ATTRIBUTE_NUMBER8NUMBER()Yes
ATTRIBUTE_NUMBER9NUMBER()Yes
ATTRIBUTE_NUMBER10NUMBER()Yes
ATTRIBUTE_DATE1DATEYes
ATTRIBUTE_DATE2DATEYes
ATTRIBUTE_DATE3DATEYes
ATTRIBUTE_DATE4DATEYes
ATTRIBUTE_DATE5DATEYes
ATTRIBUTE_DATE6DATEYes
ATTRIBUTE_DATE7DATEYes
ATTRIBUTE_DATE8DATEYes
ATTRIBUTE_DATE9DATEYes
ATTRIBUTE_DATE10DATEYes
APPOINTMENT_WINDOW_STARTDATEYes
APPOINTMENT_WINDOW_ENDDATEYes
RATE_DISTANCE_GIDVARCHAR2(101)YesRATE_DISTANCE
ROUTE_CODE_GIDVARCHAR2(101)YesROUTE_CODE
RUNNING_WEIGHTNUMBER()Yes
RUNNING_WEIGHT_UOM_CODEVARCHAR2(64)Yes
RUNNING_WEIGHT_BASENUMBER()Yes
RUNNING_LENGTHNUMBER()Yes
RUNNING_LENGTH_BASENUMBER()Yes
RUNNING_LENGTH_UOM_CODEVARCHAR2(64)Yes
RUNNING_WIDTHNUMBER()Yes
RUNNING_WIDTH_BASENUMBER()Yes
RUNNING_WIDTH_UOM_CODEVARCHAR2(64)Yes
RUNNING_HEIGHTNUMBER()Yes
RUNNING_HEIGHT_BASENUMBER()Yes
RUNNING_HEIGHT_UOM_CODEVARCHAR2(64)Yes
LEFT_WIDTH_OOGNUMBER()Yes
LEFT_WIDTH_OOG_BASENUMBER()Yes
LEFT_WIDTH_OOG_UOM_CODEVARCHAR2(64)Yes
RIGHT_WIDTH_OOGNUMBER()Yes
RIGHT_WIDTH_OOG_BASENUMBER()Yes
RIGHT_WIDTH_OOG_UOM_CODEVARCHAR2(64)Yes
FWD_LENGTH_OOGNUMBER()Yes
FWD_LENGTH_OOG_BASENUMBER()Yes
FWD_LENGTH_OOG_UOM_CODEVARCHAR2(64)Yes
REAR_LENGTH_OOGNUMBER()Yes
REAR_LENGTH_OOG_BASENUMBER()Yes
REAR_LENGTH_OOG_UOM_CODEVARCHAR2(64)Yes
ATTRIBUTE_NUMBER11NUMBER()Yes
ATTRIBUTE_NUMBER12NUMBER()Yes
ATTRIBUTE_NUMBER13NUMBER()Yes
ATTRIBUTE_NUMBER14NUMBER()Yes
ATTRIBUTE_NUMBER15NUMBER()Yes
ATTRIBUTE_NUMBER16NUMBER()Yes
ATTRIBUTE_NUMBER17NUMBER()Yes
ATTRIBUTE_NUMBER18NUMBER()Yes
ATTRIBUTE_NUMBER19NUMBER()Yes
ATTRIBUTE_NUMBER20NUMBER()Yes
ATTRIBUTE_DATE11DATEYes
ATTRIBUTE_DATE12DATEYes
ATTRIBUTE_DATE13DATEYes
ATTRIBUTE_DATE14DATEYes
ATTRIBUTE_DATE15DATEYes
ATTRIBUTE_DATE16DATEYes
ATTRIBUTE_DATE17DATEYes
ATTRIBUTE_DATE18DATEYes
ATTRIBUTE_DATE19DATEYes
ATTRIBUTE_DATE20DATEYes
PREDICTED_ARRIVALDATEYes
PREDICTED_ARRIVAL_LOWDATEYes
PREDICTED_ARRIVAL_HIGHDATEYes
EXTERNAL_VOYAGE_CODEVARCHAR2(80)Yes
APPOINTMENT_DURATIONNUMBER()Yes
APPOINTMENT_DURATION_BASENUMBER()Yes
APPOINTMENT_DURATION_UOM_CODEVARCHAR2(64)Yes
NFR_STOP_TYPEVARCHAR2(101) WA/RESTYes
Column list source

The column list above is extracted from Oracle's OTM data dictionary included with the February 2025 release snapshot of this connector. Oracle publishes an updated dictionary with every Transportation and Global Trade Management release; for the current version, consult Oracle's Transportation and Global Trade Management documentation.

Incremental sync

The SHIPMENT_STOP table supports incremental sync via the UPDATE_DATE cursor. Supaflow's connector handles:

  • Server-side clock skew -- measured once from OTM's RFC 1123 Date header and applied to every cursor comparison.
  • Late-arriving updates -- configurable lookback window (recommended 300-600 seconds in production) re-scans the tail of the previous window.
  • Identical-timestamp batches -- tracks record count at the maximum cursor timestamp so batch updates that stamp thousands of rows with the same UPDATE_DATE don't cause missed or duplicated rows.

Full pattern: The Complete Guide to Oracle Transportation Management Integration.

Sync SHIPMENT_STOP with Supaflow

Supaflow's Oracle Transportation Management connector syncs SHIPMENT_STOP -- along with 17 other OTM tables -- into your cloud data warehouse with:

  • Sync and async (Object Storage PAR) export modes
  • Proactive OAuth token refresh (60-second safety margin on IDCS tokens)
  • Composite primary key preservation for tables with multi-field keys
  • Automatic handling of the five OTM-specific data quirks (metadata 400s, "0" temporal sentinels, Z-suffixed date fields, 1 MB sync-mode truncation, _TEXT / _COMMENT column type overrides)
  • Predictable connector-based pricing -- not per-row, not per MAR

Next steps: