Service Level and Shipment Management Parameters
Each integration has additional parameters associated with the service level, as well as those used for managing the shipment by the shipper.
For the specific case of the service level, there are two dates. The shipperDropoffDate field indicates the approximate date when the package will be delivered to the last-mile distribution center of Cargamos. The expectedDeliveryDate field refers to the delivery promise, i.e., the date by which Cargamos is expected to deliver the package to the final recipient.
If the dates conform to the parameters, but the delivery is made outside the specified time, this leads to other logistical flows that must be coordinated with the commercial department.
For the case of management information, you can provide an optional batch ID (lotId) that suggests that packages with the same (lotId) value will arrive together (not consolidated) at the last-mile distribution center of Cargamos. It's not necessary to provide a lotId, but if applicable, it can help optimize delivery times. Additionally, there's the shipmentTrackingId field where the shipper indicates the value that will be scanned on the package label once it's delivered to Cargamos last-mile distribution center. In other words, the value is encoded in the barcode of the label (e.g., encoded in QR code or code128). This value is optional; if not supplied, it's assumed that the shipper will use (place a label with) the trackingId value provided in the integration response.
It's important that the package has a scannable barcode (e.g., QR code or code128 are supported at this time). This scannable barcode MUST match either the shipmentTrackingId if provided at the time of integration or the trackingId generated by Cargamos in the integration response. If you don't have a barcode label with either of these two values, IT IS NOT POSSIBLE TO DELIVER THE PACKAGE.
Fields
| Field | Data type | Required | Default |
|---|---|---|---|
| shipperDropoffDate | String | No | Integration date + 24hrs |
| expectedDeliveryDate | String | No | Integration date + 24hrs |
- A text string representing a timestamp in
ISO 8601-1:2019format expressed in Coordinated Universal Time (UTC).
shipperDropoffDate
Date on which the package is expected to be delivered (in custody) at the Cargamos last-mile distribution center. ISO 8601-1:2019 expressed in UTC coordinated universal time must be adhered to.
Example:
2023-06-10T16:18:05Z
The ISO 8601-1:2019 standard expressed in UTC coordinated universal time does not use time zones but expresses any time in Greenwich or Zulu time. The text string ends in a 'Z'.
expectedDeliveryDate
Date/time in which you want the delivery to be made to the final recipient. Its accuracy depends on parameters signed in the service level agreement with Cargamos. ISO 8601-1:2019 expressed in UTC coordinated universal time must be adhered to.
Example:
2023-06-10T16:18:05Z
The ISO 8601-1:2019 standard expressed in UTC coordinated universal time does not use time zones but expresses any time in Greenwich or Zulu time. The text string ends in a 'Z'.
Table. Fields for shipment management provided by the shipper
| Field | Data type | Required | Default |
| ----------------- | ------------ | --------- | ------- |
| lotId | String | NO | |
| shipperTrackingId | String | NO | |
### lotId
Grouping value that indicates that the packages will arrive at the <em>Cargamos</em> last-mile distribution center together. This is not a consolidation indicator. If you have several consolidated packages, for practical purposes these packages are a single package. This field suggests that a single vehicle with X number of packages will arrive at the same time. All of these packages would ideally have the same lotId. This field is optional and makes optimization easier. It does not affect compliance with the agreed level of service.
1
### shipperTrackingId
As mentioned earlier in this subsection, this is a scannable identifier, meaning it is printed on a label stamped on the package. An alternate scannable Id to the trackingId; is the one for <em>We load</em> (<em>trackingId</em>) if that's convenient for you. However, it is necessary to take into account that **THE SHOULD ALWAYS BE A LABEL WITH EITHER THE SHIPPERTRACKINGID OR THE TRACKINGID**.
Example:
MYID0001
::::caution[Note]
If the shipper already has a label on the package and does not wish to print an additional label, this field should always be supplied.
::::