Skip to main content

Shipments table

In this section:

The Shipments table contains information about ongoing and finished shipments - e.g. origin, destination, configuration, excursion threshold and inspection status.

Data type legend

Data type

Description

bigint

Big integer, large number.

decimal

Number with decimal point, in 11,7 format: 11 digits before decimal point, 7 digits after decimal point.

double

Double; 8-byte double-precision floating point numbers.

hex

Hexadecimal value. See more. Hidden as it was only used for logger_id, which now uses string

int

Integer, whole number.

string

String, text.

ts

Timestamp, in YYYY-MM-DDTHH:MM:SSZ format.

Table 1. Shipments

Item

  • Data source

Data type

Description

customer_id

  • acm_shipments.customer_id

int

Unique reference to customer in Controlant database.

This is internal only and hidden from customers

shipment_reference

  • acm_shipments.ref_id

string

Reference to unique identifier of shipment in customer's system.

Primary key.

description

  • acm_shipments.description

string

Description of shipment.

Blank if no description was included when shipment was created.

timestamp_deliver_by

  • acm_shipments.deliver_by_ts

ts

Date shipment should be delivered by, in YYYY-MM-DDTHH:MM:SSZ format. qq - Description ok?

timestamp_created

  • acm_shipments.create_ts

ts

Date shipment was created in database, inYYYY-MM-DDTHH:MM:SSZ format.

timestamp_shipped

  • acm_shipments.shipped_ts

ts

Date shipment was shipped, in YYYY-MM-DDTHH:MM:SSZ format.

Blank if shipment has not been shipped.

timestamp_delivered

  • acm_shipments.delivered_ts

ts

Date shipment was delivered to destination, in YYYY-MM-DDTHH:MM:SSZ format.

Blank if shipment has not been delivered.

timestamp_closed

  • acm_shipments.closed_ts

ts

Date shipment was marked as closed post delivery, in YYYY-MM-DDTHH:MM:SSZ format.

Blank if shipment has not been closed.

Origin location

from_location_reference

  • acm_shipments.from_ref_id

string

Origin location - customer defined name for location.

from_description

QQ HIDDEN FOR NOW

  • from_description

string

Description of origin location.

from_name

  • from_name

string

Name of shipment origin location.

If source is empty, the value of from_location_reference will be used as location name.

from_phone

  • from_phone

string

Phone number of shipment origin location.

from_address_line_1

  • from_address_1

string

Postal address of shipment origin location, line 1.

from_address_line_2

  • from_address_2

string

Postal address of shipment origin location, line 2.

from_address_line_3

  • from_address_3

string

Postal address of shipment origin location, line 3.

from_city

  • from_city

string

City of shipment origin location.

from_region

  • from_region

string

Region of shipment origin location.

from_postcode

string

Postcode of shipment origin location.

from_country

  • from_country

string

Country code for country of shipment origin location.

from_latitude

  • from_latitude

decimal

Latitude coordinates for the shipment origin location's center-mass.

Must adhere to the World Geodetic System 1984 (WGS 84) standard.

from_longitude

  • from_longitude

decimal

Latitude coordinates for the shipment origin location's center-mass.

Must adhere to the World Geodetic System 1984 (WGS 84) standard.

from_radius

bigint

Radius of shipment origin location's center-mass. If shipment is found within this radius of shipment location's center-mass, it is considered at origin location.

Destination location

to_location_reference

  • acm_shipments.to_ref_id

string

Destination location - customer defined name for location.

to_description

QQ HIDDEN FOR NOW

  • to_description

string

Description of destination location.

to_name

  • to_name

string

Name of shipment destination location.

If source is empty, the value of to_location_reference will be used as location name.

to_phone

  • to_phone

string

Phone number of shipment destination location.

to_address_line_1

  • to_address_1

string

Postal address of shipment destination location, line 1.

to_address_line_2

  • to_address_2

string

Postal address of shipment destination location, line 2.

to_address_line_3

  • to_address_3

string

Postal address of shipment destination location, line 3.

to_city

  • to_city

string

City of shipment destination location.

to_region

  • to_region

string

Region of shipment destination location.

to_postcode

string

Postcode of shipment destination location.

to_country

  • to_country

string

Country code for country of shipment destination location.

to_latitude

  • to_latitude

decimal

Latitude coordinates for the shipment destination location's center-mass.

Must adhere to the World Geodetic System 1984 (WGS 84) standard.

to_longitude

  • to_longitude

decimal

Latitude coordinates for the shipment destination location's center-mass.

Must adhere to the World Geodetic System 1984 (WGS 84) standard.

to_radius

bigint

Radius of shipment destination location's center-mass. If shipment is found within this radius of shipment location's center-mass, it is considered at destination location.

Shipment details

status

  • acm_shipments.status

    + mapping table

string

Current status of shipment:

delivery_method was closure_type

  • acm_shipments.closure_type

    + mapping table

string

Stop method of shipment:

  • Geofence and Button - Shipment closed when button has been pressed AND logger has left the configured geofence location.

  • Geofence - Shipment closed when logger has left the configured geofence location.

  • Geofence or Button - Shipment closed when button has been pressed OR logger has left the configured geofence location.

  • Button - Shipment closed when button has been pressed.

  • Time - Shipment closed on the date and time configured.

shipping_method was open_type

  • acm_shipments.open_type

string

Start method of shipment:

  • Geofence - Shipment started when logger left the configured geofence location.

  • Button - Shipment started when button has been pressed

  • Geofence or Button - Shipment started when button has been pressed OR logger has left the configured geofence location.

  • Time - Shipment started on the date and time configured.

inspection_status

  • acm_shipments.inspection

    + mapping table

string

The status of the shipment inspection process after arriving at destination:

  • NotInspected

  • UnderInspection

  • Inspected

inspection_quality

  • acm_shipments.quality

    + mapping table

string

Quality of the shipment contents determined during inspection:

  • Released

  • Undecided

  • Rejected

  • PartlyReleased

inspection_comment

  • acm_shipments.inspection_comment

string

Comments or details related to the shipment inspection.

Blank if no comment or detail.

excursion_severity - skip this

  • excursion_severity

    + mapping table

int

Hidden everywhere

Excursion severity currently assigned to the shipment:

  • NoExcursion

  • Level1

  • Level2

  • Level3

excursion_severity_threshold

  • excursion_severity_threshold

string

Threshold for raising alerts for this shipment:

  • NoExcursion

  • Level1

  • Level2

  • Level3

warning_ignore_period_start

  • warning_ignore_period

bigint

A period (in seconds) at the beginning of shipment where the alarm functionality is inactive.

Note

Temperature data is recorded during the ignore period and will be available, but no alarms will be triggered for excursions.

warning_ignore_period_end

  • warning_ignore_period_end

bigint

A period (in seconds) at the end of shipment where the alarm functionality is inactive.

Note

Temperature data is recorded during the ignore period and will be available, but no alarms will be triggered for excursions.