Relevant Enums

Tour status

public enum TourStatusEnum
{
    TourScheduled = 0,
    TourPlanning = 1,
    TourPlanned = 2,
    TourReleased = 3,
    TourReReleased = 4,
    TourInRevision = 5,
    TourRevised = 6,
    TourInExecution = 7,
    TourCompleteFinished = 8,
    TourIncompleteFinished = 9,
    Undefined = 10,
    TourPause = 11,
    TourInRevisionAfterExecution = 12,
    TourRevisedAfterExecution = 13,
    TourInRevisionAfterPause = 14,
    TourRevisedAfterPause = 15,
    TourInExecutionAfterUpdate = 16,
    TourCompleteFinishedAfterUpdate = 17,
    TourIncompleteFinishedAfterUpdate = 18,
    TourPauseAfterUpdate = 19,
    TourInRevisionAfterUpdate = 20,
    TourEmptyReleased = 21,                   //rare
    TourCommissioned = 22,                    //rare
}

Shipment status

public enum ShipmentStatusEnum
{
    Editing = 5,
    Unallocated = 10,
    Allocated = 20,
    PickupCompleted = 70,
    DropoffCompleted = 110,
    QuantitySplit = 1000,            //rare
    WaySplit = 1001,                 //rare
    Completed = 1002,                //rare
    CompletedWithErrors = 1003,      //rare
    Reopened = 1004,                 //rare
    TruckloadProcessSplit = 1005,    //rare
}

Fiscal status / Order status

The fiscal status is a status of the order that is separate from the transport, primarily intended to control the release. Using this status, sales can, for example, pre-record the order for planning and only release the order for actual delivery after the purchase contract has been concluded, so that, for example, the tour can be released.

public enum OrderStatusEnum
{
    Undefined = 0,
    InProcess = 1,
    Offer = 2,
    Intended = 3,
    Confirmed = 4,
    Updated = 5,
    Deleted = 6,
    Cancelled = 7,
    Completed = 8,
    Incompletely = 9,
    ReadyForBilling = 10,
    BillingInProgress = 11,
    Billed = 12
}

Shipment type

The shipment type returns what kind of shipment it is.

public enum ShipmentTypeEnum
{
    InitialLeg = 0,      // Pickup, customer to depot
    MainLeg = 1,         // Main leg, depot to depot
    FinalLeg = 2,        // Delivery, depot to customer
    Direct = 3,          // Direct transport, customer to customer
    Undefined = 4        // Undefined, e.g. no pickup/delivery address
}

Order and shipment kind

The order and shipment kind defines how the order or shipment should be interpreted in X4fleet. By default, 0 is set; the other values are only relevant to you if you are explicitly informed about them within the scope of the project.

public enum ShipmentKindEnum
{
    Shipment = 0,            // normal shipment
    Measurement = 1,         // wrapper for weight measurements
    Flushing = 2,            // wrapper for flushing orders
    ProposalShipment = 3,    // wrapper for offers
    ExternalShipment = 4,    // wrapper for externally executed shipments
}

public enum OrderTypeEnum
{
    TransportOrder = 0,      // normal order
    Order = 1,               // wrapper for collective orders
    Commercial = 2,          // wrapper for offers
    ExternalShipment = 3,    // wrapper for externally executed orders
}

Skip process type

For skip orders, the skip process type indicates which process is involved. For shipments without a skip order, the value is null.

public enum TroughProcessTypeEnum
{
    Place = 0,
    Empty = 1,
    Change = 2,
    Fetch = 3
}

Site kind

The site kind defines what kind of site the site should be defined as in X4fleet. As a rule, SPS (1) and Depot (2) are used.

public enum PoiKindEnum
{
    ServiceProvisioningSite = 1,    // Customer
    Depot = 2,                      // Depot
    VehicleSite = 3,                // Vehicle location
    VehicleCleaning = 4,            // Vehicle washing station
    Customs = 5,                    // Customs
    MeetingPlace = 6,               // Meeting point
    TechnicalStop = 7,              // Technical stop
    EnergyStop = 8,                 // Energy stop, charging station
    CollectionPlace = 9,            // Collection point
}

Business partner role

public enum ClientRoleEnum
{
    None = 0, 
    Client = 1,
    Purchaser = 2,
    Both = 3
}

Creditworthiness

public enum CreditRatingEnum
{
    Undefined = 0,
    Good = 1,
    Medium = 2,
    Bad = 3
}

Payment type

public enum PaymentTypeEnum
{
    Undefind = 0,
    CashOnDelivery = 1,
    CreditCard = 2,
    TransactionInvoice = 3,
    WeeklyInvoice = 4,
    MonthlyInvoice = 5,
    Voucher = 6,
    Other = 7,
    QuarterlyInvoicePrepay = 10
}

Language

public enum LanguageEnum
{
    German = 1,
    English = 2,
    French = 3,
    Italian = 4,
    Spanish = 5
}

For business partners, the language is transmitted as text in the language field. The following values are accepted (not case-sensitive):

All other values are treated as German. When a business partner is retrieved, the language is returned written out in full, e.g. "Spanish".

Product type

The product type defines which type of product the line item is.

public enum ProductTypeEnum
{
    Product,     // piece goods and bulk goods
    Service,     // service
    Tool,        // load carrier
    Container,   // package, allows the nesting of products
    Franco       // franco line item, a combination of product and service, mainly used in the circular economy with complex billing procedures
}

Product unit

The product unit defines in which unit the quantity of the product is to be evaluated. Not all units are available for all product types. Via the interface, usually not the number but the name is transmitted as the RefID (e.g. "unit": "Ton").

public enum ProductUnitEnum
{
    EuroPalet,
    EinwegPalet,
    Halfpallet,
    Gitterbox,
    Colis,
    Apparat,
    Barrel,
    Bundle,
    Unit,

    Kilo,
    Ton,
    CubicMeters,
    Liter,
    Hours,
    Flat,
    Bag,
    BigBag,
    Container,
    Tin,

    Bottle,
    Carton,
    Cassette,
    Kettle,
    RunningMeters,
    Millimeter,
    Minutes,
    Pair,
    Parcel,
    Plate,

    Poster,
    SquareMeters,
    Tube,
    Coil,
    Set,
    Diverse,
    Pole,
    Packaging,
    Kilometer,
    LoadingMeters,

    Meters,
    Centimeters,
    Bale,
    Canister,
    SquareCentimeters,
    CubicCentimeter,
    CubicDecimeters,
    Gram,
    Cartridge,
    Ring,

    Days,
    P10,
    P20,
    P50,
    P100,
    Deciliter,
    Pallet,
    
    Rollbox,
    CollectionContainer,
    Kilometers,
    Person,
    Month,
}

Tour generation model

public enum TourGenerationModelEnum
{
    Classic = 0,
    LoadingOrders = 1,
    LoadingAndUnloadingOrdersSeparate = 2,
    UnloadingOrders = 3
}