Build from a job

Quick Starts

Pick the job you are trying to complete. Each quick start explains when to use the route, what IDs are required, what appears in the app afterward, common errors, and the next route to call.

POST/api/datasynch/locations/import

Import Locations from JSON

Load facilities, customers, warehouses, service zones, or delivery locations into a manifest.

When to use it

Use this when a source system or spreadsheet has location master data that should appear in DataSynch.

Required IDs
  • manifestId
  • records[]
What appears in the app afterward

Location records become visible under DataSynch → Locations and can be reused by geofences and telemetry.

Common errors
  • Missing manifestId
  • Empty records array
  • Latitude/longitude stored as strings that cannot be parsed
Next step

Create geofences around key locations or import telemetry events.

POST/api/datasynch/crm/import

Import CRM Accounts

Import customer, prospect, partner, or account records into the CRM master table.

When to use it

Use this when CRM data needs to be mapped to locations, territories, or supply-chain activity.

Required IDs
  • manifestId
  • records[]
What appears in the app afterward

CRM records become available under DataSynch → CRM and can support account/location matching.

Common errors
  • Missing manifestId
  • Wrong field names
  • No stable externalId
Next step

Run XREF matching or import related locations.

POST/api/datasynch/geofences

Create a Geofence Around a Distribution Center

Create a point-radius geofence that can trigger enter, exit, dwell, wrong-site, and proximity events.

When to use it

Use this after importing a known facility or when defining operational zones by coordinate.

Required IDs
  • manifestId
  • name
  • geometryType
  • latitude
  • longitude
  • radiusMiles
What appears in the app afterward

The geofence appears under DataSynch → Geofences and can be used by telemetry or mobile tracking events.

Common errors
  • Missing geometryType
  • Radius not provided for point_radius
  • Latitude/longitude reversed
Next step

Send a geofence event or configure notification dispatch.

POST/api/datasynch/telemetry/events

Send a Truck Arrival Telemetry Event

Send a logistics event that can be connected to locations, geofences, exceptions, and dispatch rules.

When to use it

Use this when a carrier, EDI process, mobile device, or partner system reports shipment status.

Required IDs
  • manifestId
  • eventCode or eventDescription
  • eventTime
What appears in the app afterward

The event appears in telemetry views and can be evaluated against geofence and exception rules.

Common errors
  • Missing eventTime
  • No shipmentId or equipmentId
  • Coordinate precision too low for geofence matching
Next step

Evaluate geofence event logic or dispatch a notification.

POST/api/datasynch/xref/evaluate

Evaluate XREF Rules Before Import

Check incoming records against cross-reference rules before committing records.

When to use it

Use this when IDs, SKUs, GLNs, partner codes, or location aliases must be matched before import.

Required IDs
  • manifestId
  • records[]
  • rules[] or profileId
What appears in the app afterward

Matched and unmatched records can be reviewed before import or routed to exceptions.

Common errors
  • No rules provided
  • Source field names do not match normalized fields
  • Lookup table missing
Next step

Import accepted records or create business exceptions for unresolved records.

POST/api/datasynch/notification-dispatch

Dispatch a Webhook When a Geofence Event Occurs

Send a downstream webhook, email, Slack message, internal notification, or CSV export request.

When to use it

Use this when events or rules should trigger downstream action.

Required IDs
  • manifestId
  • dispatchType
  • payload
What appears in the app afterward

The dispatch request and result appear in dispatch logs.

Common errors
  • Missing dispatchType
  • Webhook target not configured
  • Payload not tied to a traceable event
Next step

Review dispatch logs and run status.

Keep exploring

Keep exploring from quick starts

After a quick start, jump to related solution pages, API examples, or the full DataSynch Developer Center.

Back to map