Skip to content

Provider exchange process

API POST: Incoming Manifest

Description

This API allows you to execute an incoming flow for a specific logistics company and a given translator. The parameters logisticsCompanyId and translatorCode are dynamic and must be provided in the URL.

URL

Full URL

https://api.dev.e4cars.io/api/v1/3pl/{logisticsCompanyId}/incoming-flows/execute/{translatorCode}?token={TOKEN}

METHOD

  • /POST

PATH parameters

  • logisticsCompanyId (string, required): Unique identifier for the logistics company.
  • translatorCode (string, required): Code for the translator executing the incoming flow. The default standard translator is STD_IN_MANIFEST.

QUERY parameters

  • token (string, required): API key for authentication for the call. (see the authentication section)
  • dry_run (string, optional, default=false): Allows you to run the translator for testing. Only the translation will be triggered, and the result will not be processed.
    • true: Runs only the translation, not the processing.
    • false: Runs both the translation and the processing of the translated flow.

REQUEST parameters

  • body (JSON Object, required): Contains a JSON object that will then be transformed into an IncomingManifestPivot structure, e4Cars' internal format.

    The object contained in body can therefore be an ad hoc object corresponding to the specific needs of the caller or to an existing communication API.

    In this case, as with e4Cars' incoming flows, you will need to contact e4Cars integration teams (integration@e4cars.com) to send them the body you wish to receive in the calls.

    They will produce an ad hoc translator that will be used to transmit orders to your APIs based on the outgoing IncomingManifestPivot data.

Standard Flow Translator Case: translatorCode=STD_IN_MANIFEST

If you decide to use the standard flow translator (STD_IN_MANIFEST), you must follow the standard incoming manifest schema IncomingManifestPivot below.

IncomingManifestPivot schema
IncomingManifestPivot.ts
        interface IncomingManifestPivot {
            header: {
                message_no: string;
                issuing_date: string;
                issuer: {
                    provider: {
                        code: string;
                        name?: string;
                        logistics_company: {
                            code: string;
                            name?: string
                        }
                    }
                };
                movement_type: string;
                receiver: {
                    origin_software: string
                };
            }
            trip: {
                trip_no?: string;
                provider_trip_no?: string;
                transport_mode: string;
                means_kind: string;
                vehicles_number: number;
                sales?: {
                    amount: string;
                    currency: string;
                };
                road_mean?: {
                    license_plate: string;
                    simplified_license_plate?: string;
                    driver_name?: string;
                };
                rail_mean?: {
                    train_no: string;
                    wagon_no: string;
                };
                sea_mean?: {
                    vessel_name: string;
                    vessel_no: string;
                };
                manifest: {
                    manifest_no: string,
                    vehicles_number: number;
                    pickup: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    delivery: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    vehicles: [
                        {
                            vin: string;
                            license_plate: string;
                            simplified_license_plate: string;
                            operation_no: string;
                        }
                    ];
                };
            };
        }

        export class InLocalDate {
          date?: string;
          utc_date?: Date;
        }

        export class InStartEndDates {
          target_date?: InLocalDate;
          planned_date?: InLocalDate;
          real_date?: InLocalDate;
        }
Example of Body IncomingManifestPivot
JSON
    {
        "header": {
            "message_no": "BER-MES-1829238048082",
            "movement_type": "declare",
            "issuing_date": "2024-12-12T06:01:02",
            "issuer": {
                "provider": {
                    "code": "BER",
                    "name": "BERT & YOU",
                    "logistics_company": {
                        "code": "BER",
                        "name": "BERT & YOU"
                    }
                }
            },
            "receiver": {
                "origin_software": "E4_3PL"
            }
        },
        "logistics_company": {
            "code": "BER",
            "name": "BERT & YOU"
        },
        "trip": {
            "trip_no": "TP-BER-20241212-00463",
            "provider_trip_no": "BERT-TRIP-20241211-00463",
            "sales": {
                "currency": "EUR",
                "amount": "400"
            },
            "transport_mode": "road",
            "means_kind": "truck",
            "vehicles_number": 3,
            "road_mean": {
                "license_plate": "VJ-439-PB",
                "driver_name": "John Doe driver"
            },
            "manifest": {
                "manifest_no": "M-CEV-20250310-00522",
                "vehicles_number": "1",
                "pickup": {
                    "planned_date": {
                        date: "2024-12-12T17:46:34"
                    }
                },
                "delivery": {
                    "planned_date": {
                        date: "2024-12-15T18:21:22",
                        utc_date: "2024-12-15T17:21:22"
                    }
                },
                "vehicles": [
                    {
                        "vin": "NMN347XYS1YWJLDV3",
                        "operation_no": "OP-BER-20241212-70410"
                    }
                ]
            }
        }
    }

Ad hoc Incoming Flow Translator

The object contained in body may be an ad hoc object corresponding to the specific needs of an existing API.

In this case, as with the outgoing flows from e4Cars, you will need to contact the e4Cars integration teams (integration@e4cars.com) to send them the body you wish to send to create a logistics event.

They will produce an ad hoc translator that will be used when transmitting vehicle creation orders to produce an IncomingManifestPivot object from the ad hoc information.


Example URL

POST /api/v1/3pl/BER/incoming-flows/execute/STD_IN_MANIFEST?token=18498cae876943a9aa2c72971645b75b94f801cf08054238977947b169f6cdd5


NAME NATURE TYPE PLACE VALUE
LOGISTIC_COMPANY_CODE CONSTANT string Path param Default value
ID_TRANSLATOR CONSTANT String Path param Default value
TOKEN CONSTANT string Query param Default value
"header.issuer" CONSTANT JSON object Body Default value
"header.receiver" CONSTANT JSON object Body Default value
"logistics_company" CONSTANT JSON object Body Default value
NAME NATURE TYPE PLACE VALUE
"header.movment_type" VARIABLE String Body Dynamic
"trip.trip_no" VARIABLE String Body Dynamic
"trip.transport_mode" VARIABLE String Body Dynamic
"trip.means_kind" VARIABLE String Body Dynamic
"vehicles.operation_no" VARIABLE String Body Dynamic
"vehicles.vin" VARIABLE String Body Dynamic
"vehicles.license_plate" VARIABLE String Body Dynamic
"manifest.pickup.zip" VARIABLE String Body Dynamic
"manifest.pickup.city" VARIABLE String Body Dynamic
"manifest.pickup.country_code" VARIABLE String Body Dynamic
"manifest.pickup.name" VARIABLE String Body Dynamic
"manifest.delivery.zip" VARIABLE String Body Dynamic
"manifest.delivery.city" VARIABLE String Body Dynamic
"manifest.delivery.country_code" VARIABLE String Body Dynamic
"manifest.delivery.name" VARIABLE String Body Dynamic

Date value

All date (IN or OUT) are Locale

Below is the list of all accepted date formats:

  • YYYY-MM-DDTHH24:MI:SS
  • YYYY-MM-DDTHH24:MI:SSZ
  • YYYY-MM-DDTHH24:MI
  • YYYY-MM-DDTHH24:MI:SS.ms
  • YYYY-MM-DDTHH24:MI:SS.msZ

The POST request requires a body in JSON format that contains the necessary information to execute the incoming flow. Here's an example of the body structure:

Example of JSON Body
JSON
    {
        "header": {
            "message_no": "BER-MES-1829238048082",
            "movement_type": "declare",
            "issuing_date": "2024-12-12T06:01:02",
            "issuer": {
                "provider": {
                    "code": "BER",
                    "name": "BERT & YOU",
                    "logistics_company": {
                        "code": "BER",
                        "name": "BERT & YOU"
                    }
                }
            },
            "receiver": {
                "origin_software": "E4_3PL"
            }
        },
        "logistics_company": {
            "code": "BER",
            "name": "BERT & YOU"
        },
        "trip": {
            "trip_no": "TP-BER-20241212-00463",
            "provider_trip_no": "BERT-TRIP-20241211-00463",
            "sales": {
                "currency": "EUR",
                "amount": "400"
            },
            "transport_mode": "road",
            "means_kind": "truck",
            "vehicles_number": 3,
            "road_mean": {
                "license_plate": "VJ-439-PB",
                "driver_name": "John Doe driver"
            },
            "manifest": {
                "manifest_no": "M-CEV-20250310-00522",
                "vehicles_number": "1",
                "pickup": {
                    "planned_date": {
                        date: "2024-12-12T17:46:34"
                    }
                },
                "delivery": {
                    "planned_date": {
                        date: "2024-12-15T18:21:22",
                        utc_date: "2024-12-15T17:21:22"
                    }
                },
                "vehicles": [
                    {
                        "vin": "NMN347XYS1YWJLDV3",
                        "operation_no": "OP-BER-20241212-70410"
                    }
                ]
            }
        }
    }
Code Description Example Response
200 Success, the flow was executed correctly. { "status": "success", "message": "Incoming flow executed successfully." }
401 Unauthorized, missing or invalid authentication. { "status": "error", "message": "Unauthorized. Please authenticate." }
403 Forbidden, insufficient permissions. { "status": "error", "message": "Forbidden. You do not have the necessary permissions to execute this flow." }
400 Bad request, invalid body or parameters. { "status": "error", "message": "Invalid request. Ensure all parameters are correctly provided." }

Trip Planification

When should this information be transmitted?

e4cars can receive a message from the carrier via a trip manifest:

  • When a resource is assigned
  • And/or when a planned departure date is entered
  • And/or when a planned delivery date is entered

What information should be transmitted?

A message for the trip manifest contains:

  • The trip reference e4cars (mandatory)
  • The manifest reference e4cars (mandatory)
  • The resource: truck plate, driver's name
  • List of vehicles (VIN, registration) and the corresponding e4cars operation references (mandatory)
  • The planned pickup date
  • The planned delivery date

Standard message case (IncomingManifestPivot format)

Movement type: Plan

For planning, the attribute header.movement_type must be set to the value declare

Reminder of allowed values for header.movement_type

  • declare: Planning of transport operations
  • cancellation: Cancellation of transport operations
  • pickup: Pickup declaration
  • delivery: Delivery declaration
IncomingManifestPivot schema
IncomingManifestPivot.ts
        interface IncomingManifestPivot {
            header: {
                message_no: string;
                issuing_date: string;
                issuer: {
                    provider: {
                        code: string;
                        name?: string;
                        logistics_company: {
                            code: string;
                            name?: string
                        }
                    }
                };
                movement_type: string;
                receiver: {
                    origin_software: string
                };
            }
            trip: {
                trip_no?: string;
                provider_trip_no?: string;
                transport_mode: string;
                means_kind: string;
                vehicles_number: number;
                sales?: {
                    amount: string;
                    currency: string;
                };
                road_mean?: {
                    license_plate: string;
                    simplified_license_plate?: string;
                    driver_name?: string;
                };
                rail_mean?: {
                    train_no: string;
                    wagon_no: string;
                };
                sea_mean?: {
                    vessel_name: string;
                    vessel_no: string;
                };
                manifest: {
                    manifest_no: string,
                    vehicles_number: number;
                    pickup: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    delivery: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    vehicles: [
                        {
                            vin: string;
                            license_plate: string;
                            simplified_license_plate: string;
                            operation_no: string;
                        }
                    ];
                };
            };
        }

        export class InLocalDate {
          date?: string;
          utc_date?: Date;
        }

        export class InStartEndDates {
          target_date?: InLocalDate;
          planned_date?: InLocalDate;
          real_date?: InLocalDate;
        }
Example of IncomingManifestPivot planning body
JSON
    {
        "header": {
            "message_no": "BER-MES-1829238048082",
            "movement_type": "declare",
            "issuing_date": "2024-12-12T06:01:02",
            "issuer": {
                "provider": {
                    "code": "BER",
                    "name": "BERT & YOU",
                    "logistics_company": {
                        "code": "BER",
                        "name": "BERT & YOU"
                    }
                }
            },
            "receiver": {
                "origin_software": "E4_3PL"
            }
        },
        "logistics_company": {
            "code": "BER",
            "name": "BERT & YOU"
        },
        "trip": {
            "trip_no": "TP-BER-20241212-00463",
            "provider_trip_no": "BERT-TRIP-20241211-00463",
            "sales": {
                "currency": "EUR",
                "amount": "400"
            },
            "transport_mode": "road",
            "means_kind": "truck",
            "vehicles_number": 3,
            "road_mean": {
                "license_plate": "VJ-439-PB",
                "driver_name": "John Doe driver"
            },
            "manifest": {
                "manifest_no": "M-CEV-20250310-00522",
                "vehicles_number": "1",
                "pickup": {
                    "planned_date": {
                        date: "2024-12-12T17:46:34"
                    }
                },
                "delivery": {
                    "planned_date": {
                        date: "2024-12-15T18:21:22",
                        utc_date: "2024-12-15T17:21:22"
                    }
                },
                "vehicles": [
                    {
                        "vin": "NMN347XYS1YWJLDV3",
                        "operation_no": "OP-BER-20241212-70410"
                    }
                ]
            }
        }
    } 

Manifest

In e4cars, a manifest corresponds to a trip's origin/destination pair.

Withdrawal of Operations from the Trip

When should this information be transmitted?

e4Cars receives from the carrier a message per trip manifest about the withdrawal of one or more operations.

What information should be transmitted?

A message per trip manifest contains:

  • The trip reference e4cars (mandatory)
  • The manifest reference e4cars (mandatory)
  • The resource: truck plate, driver’s name
  • The list of vehicles (VIN, license plate) and the e4Cars operation reference (mandatory) that should be removed from the trip

Case of the standard message (format IncomingManifestPivot)

Movement Type: Cancel

In the case of removing vehicles from the trip, the attribute header.movement_type should be set to the value cancellation

Reminder of allowed values for header.movement_type

  • declare: assignment to a resource; trip planning
  • cancellation: removal of a transport operation from the trip
  • pickup: declaration of the actual pickup
  • delivery: declaration of the actual delivery
IncomingManifestPivot schema
IncomingManifestPivot.ts
        interface IncomingManifestPivot {
            header: {
                message_no: string;
                issuing_date: string;
                issuer: {
                    provider: {
                        code: string;
                        name?: string;
                        logistics_company: {
                            code: string;
                            name?: string
                        }
                    }
                };
                movement_type: string;
                receiver: {
                    origin_software: string
                };
            }
            trip: {
                trip_no?: string;
                provider_trip_no?: string;
                transport_mode: string;
                means_kind: string;
                vehicles_number: number;
                sales?: {
                    amount: string;
                    currency: string;
                };
                road_mean?: {
                    license_plate: string;
                    simplified_license_plate?: string;
                    driver_name?: string;
                };
                rail_mean?: {
                    train_no: string;
                    wagon_no: string;
                };
                sea_mean?: {
                    vessel_name: string;
                    vessel_no: string;
                };
                manifest: {
                    manifest_no: string,
                    vehicles_number: number;
                    pickup: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    delivery: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    vehicles: [
                        {
                            vin: string;
                            license_plate: string;
                            simplified_license_plate: string;
                            operation_no: string;
                        }
                    ];
                };
            };
        }

        export class InLocalDate {
          date?: string;
          utc_date?: Date;
        }

        export class InStartEndDates {
          target_date?: InLocalDate;
          planned_date?: InLocalDate;
          real_date?: InLocalDate;
        }
Example of Body IncomingManifestPivot cancellation
JSON
    {
        "header": {
            "message_no": "BER-MES-1829238048082",
            "movement_type": "cancellation",
            "issuing_date": "2024-12-12T06:01:02",
            "issuer": {
                "provider": {
                    "code": "BER",
                    "name": "BERT & YOU",
                    "logistics_company": {
                        "code": "BER",
                        "name": "BERT & YOU"
                    }
                }
            },
            "receiver": {
                "origin_software": "E4_3PL"
            }
        },
        "logistics_company": {
            "code": "BER",
            "name": "BERT & YOU"
        },
        "trip": {
            "trip_no": "TP-BER-20241212-00463",
            "provider_trip_no": "BERT-TRIP-20241211-00463",
            "sales": {
                "currency": "EUR",
                "amount": "400"
            },
            "transport_mode": "road",
            "means_kind": "truck",
            "vehicles_number": 3,
            "road_mean": {
                "license_plate": "VJ-439-PB",
                "driver_name": "John Doe driver"
            },
            "manifest": {
                "manifest_no": "M-CEV-20250310-00522",
                "vehicles_number": "1",
                "vehicles": [
                    {
                        "vin": "NMN347XYS1YWJLDV3",
                        "operation_no": "OP-BER-20241212-70410"
                    }
                ]
            }
        }
    }

Manifest

In e4Cars, a manifest corresponds to a trip’s origin/destination pair.

Actual Pickup Declaration from a Trip Pickup Point

When should this information be transmitted?

e4Cars receives a publication from the carrier with a message per trip manifest at the actual pickup of at least one vehicle leaving the trip’s origin location.

What information should be transmitted?

A message per trip manifest containing:

  • The trip reference e4cars (mandatory)
  • The manifest reference e4cars (mandatory)
  • The resource: truck plate, driver’s name
  • List of vehicles (VIN, registration) and corresponding e4Cars operation references (mandatory)
  • The actual pickup date (mandatory)
  • The planned delivery date

Case of the standard message (IncomingManifestPivot format)

Movement Type: Pickup

In the case of actual pickup, the header.movement_type attribute should be set to the value pickup

Reminder of authorized values for header.movement_type

  • declare: assignment to a resource; trip planning
  • cancellation: removal of a transport operation from the trip
  • pickup: declaration of the actual pickup
  • delivery: declaration of the actual delivery
IncomingManifestPivot schema
IncomingManifestPivot.ts
        interface IncomingManifestPivot {
            header: {
                message_no: string;
                issuing_date: string;
                issuer: {
                    provider: {
                        code: string;
                        name?: string;
                        logistics_company: {
                            code: string;
                            name?: string
                        }
                    }
                };
                movement_type: string;
                receiver: {
                    origin_software: string
                };
            }
            trip: {
                trip_no?: string;
                provider_trip_no?: string;
                transport_mode: string;
                means_kind: string;
                vehicles_number: number;
                sales?: {
                    amount: string;
                    currency: string;
                };
                road_mean?: {
                    license_plate: string;
                    simplified_license_plate?: string;
                    driver_name?: string;
                };
                rail_mean?: {
                    train_no: string;
                    wagon_no: string;
                };
                sea_mean?: {
                    vessel_name: string;
                    vessel_no: string;
                };
                manifest: {
                    manifest_no: string,
                    vehicles_number: number;
                    pickup: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    delivery: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    vehicles: [
                        {
                            vin: string;
                            license_plate: string;
                            simplified_license_plate: string;
                            operation_no: string;
                        }
                    ];
                };
            };
        }

        export class InLocalDate {
          date?: string;
          utc_date?: Date;
        }

        export class InStartEndDates {
          target_date?: InLocalDate;
          planned_date?: InLocalDate;
          real_date?: InLocalDate;
        }
Example of Body IncomingManifestPivot pickup
JSON
    {
        "header": {
            "message_no": "BER-MES-1829238048082",
            "movement_type": "pickup",
            "issuing_date": "2024-12-12T06:01:02",
            "issuer": {
                "provider": {
                    "code": "BER",
                    "name": "BERT & YOU",
                    "logistics_company": {
                        "code": "BER",
                        "name": "BERT & YOU"
                    }
                }
            },
            "receiver": {
                "origin_software": "E4_3PL"
            }
        },
        "logistics_company": {
            "code": "BER",
            "name": "BERT & YOU"
        },
        "trip": {
            "trip_no": "TP-BER-20241212-00463",
            "provider_trip_no": "BERT-TRIP-20241211-00463",
            "sales": {
                "currency": "EUR",
                "amount": "400"
            },
            "transport_mode": "road",
            "means_kind": "truck",
            "vehicles_number": 3,
            "road_mean": {
                "license_plate": "VJ-439-PB",
                "driver_name": "John Doe driver"
            },
            "manifest": {
                "manifest_no": "M-CEV-20250310-00522",
                "vehicles_number": "1",
                "pickup": {
                    "real_date": {
                        date: "2024-12-12T17:55:34"
                    }
                },
                "delivery": {
                    "planned_date": {
                        utc_date: "2024-12-15T19:21:22"
                    }
                },
                "vehicles": [
                    {
                        "vin": "NMN347XYS1YWJLDV3",
                        "operation_no": "OP-BER-20241212-70410"
                    }
                ]
            }
        }
    } 

Manifest

In e4Cars, a manifest corresponds to an origin/destination pair of a trip.

Actual Delivery Declaration at a Trip Destination Point

When should this information be transmitted?

e4Cars receives a message from the carrier for each manifest of a trip, upon the actual delivery of at least one vehicle arriving at the destination point of the manifest.

What information should be transmitted?

A message per trip manifest contains:

  • The trip reference e4cars (mandatory)
  • The manifest reference e4cars (mandatory)
  • The resource: truck plate, driver's name
  • The list of vehicles (VIN, registration) and the corresponding e4Cars operation references (mandatory)
  • The actual delivery date

Standard message case (format IncomingManifestPivot)

Movement type: Delivery

For actual delivery, the header.movement_type attribute should be set to the value delivery

Reminder of allowed values for header.movement_type

  • declare: assignment to a resource; trip planning
  • cancellation: removal of a transport operation from the trip
  • pickup: declaration of the actual pickup
  • delivery: declaration of the actual delivery
IncomingManifestPivot schema
IncomingManifestPivot.ts
        interface IncomingManifestPivot {
            header: {
                message_no: string;
                issuing_date: string;
                issuer: {
                    provider: {
                        code: string;
                        name?: string;
                        logistics_company: {
                            code: string;
                            name?: string
                        }
                    }
                };
                movement_type: string;
                receiver: {
                    origin_software: string
                };
            }
            trip: {
                trip_no?: string;
                provider_trip_no?: string;
                transport_mode: string;
                means_kind: string;
                vehicles_number: number;
                sales?: {
                    amount: string;
                    currency: string;
                };
                road_mean?: {
                    license_plate: string;
                    simplified_license_plate?: string;
                    driver_name?: string;
                };
                rail_mean?: {
                    train_no: string;
                    wagon_no: string;
                };
                sea_mean?: {
                    vessel_name: string;
                    vessel_no: string;
                };
                manifest: {
                    manifest_no: string,
                    vehicles_number: number;
                    pickup: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    delivery: {
                        platform?: {
                            code: string;
                            name: string;
                        };
                        name?: string;
                        place_name?: string;
                        zip?: string;
                        city?: string;
                        country_code?: string;
                        timezone?: string;
                        geo_point?: {
                            type: string;
                            coordinates: {
                                longitude: string;
                                latitude: string;
                            };
                        };
                        instructions?: string;
                        target_date?: InStartEndDates;
                        planned_date?: InStartEndDates;
                        real_date?: InStartEndDates;
                    };
                    vehicles: [
                        {
                            vin: string;
                            license_plate: string;
                            simplified_license_plate: string;
                            operation_no: string;
                        }
                    ];
                };
            };
        }

        export class InLocalDate {
          date?: string;
          utc_date?: Date;
        }

        export class InStartEndDates {
          target_date?: InLocalDate;
          planned_date?: InLocalDate;
          real_date?: InLocalDate;
        }
Example of IncomingManifestPivot Body for delivery
JSON
    {
        "header": {
            "message_no": "BER-MES-1829238048082",
            "movement_type": "delivery",
            "issuing_date": "2024-12-12T06:01:02",
            "issuer": {
                "provider": {
                    "code": "BER",
                    "name": "BERT & YOU",
                    "logistics_company": {
                        "code": "BER",
                        "name": "BERT & YOU"
                    }
                }
            },
            "receiver": {
                "origin_software": "E4_3PL"
            }
        },
        "logistics_company": {
            "code": "BER",
            "name": "BERT & YOU"
        },
        "trip": {
            "trip_no": "TP-BER-20241212-00463",
            "provider_trip_no": "BERT-TRIP-20241211-00463",
            "sales": {
                "currency": "EUR",
                "amount": "400"
            },
            "transport_mode": "road",
            "means_kind": "truck",
            "vehicles_number": 3,
            "road_mean": {
                "license_plate": "VJ-439-PB",
                "driver_name": "John Doe driver"
            },
            "manifest": {
                "manifest_no": "M-CEV-20250310-00522",
                "vehicles_number": "1",
                "pickup": {
                    "real_date": {
                        date: "2024-12-12T17:55:34"
                    }
                },
                "delivery": {
                    "real_date": {
                        utc_date: "2024-12-15T19:21:22"
                    }
                },
                "vehicles": [
                    {
                        "vin": "NMN347XYS1YWJLDV3",
                        "operation_no": "OP-BER-20241212-70410"
                    }
                ]
            }
        }
    }

Manifest

In e4Cars, a manifest corresponds to an origin/destination pair of a journey.