Objets métiers

ActionReference

Référence d'un colis à mettre à jour

Propriété	Type	Ordre	Obligatoire	Description
Action	String	0	False	Nom de l'action à exécuter(ex: add, update, remove)
Index	Int32	1	False	Index de la référence à modifier
Value	String	2	False	Valeur à remplacer

{
  "Action": null,
  "Index": 0,
  "Value": null
}

ActionTotalBulkSize

Quantité par unité d'un colis à mettre à jour

Propriété	Type	Ordre	Obligatoire	Description
Action	String	0	False	Nom de l'action à exécuter(ex: add, update, remove)
UnitCode	String	1	False	Code de l'unité à modifier
Value	Double	2	False	Valeur à remplacer

{
  "Action": null,
  "UnitCode": null,
  "Value": 0.0
}

Address

Adresse (enlèvement, livraison, autre ...) Address (Pickup, delivery, other...)

Propriété	Type	Ordre	Obligatoire	Description
Name	String	0	False	Nom taille(50)
AddressLine1	String	1	False	Ligne d'adresse 1 taille(50)
AddressLine2	String	2	False	Ligne d'adresse 2 taille(50)
No	String	3	False	Numéro de rue taille(10)
Street	String	4	False	Rue taille(30)
PostalCode	String	5	True	Code postal taille(10) [obligatoire]
City	String	6	True	Libellé de ville taille(50) [obligatoire]
CityID	Int32 nullable	7	False	Id de ville Dispatch (utiliser Json/Cities pour obtenir cet id)
Sector	String	8	False	Code secteur de ville Dispatch (utiliser getcities pour obtenir ce code)
Country	String	9	False	Code pays taille(5)
Contact	String	10	False	Nom du contact taille(50)
Telephone1	String	11	False	Telephone 1 taille(30)
Telephone2	String	12	False	Telephone 2 taille(30)
Telephone3	String	13	False	Telephone 3 taille(50)
EMail	String	14	False	Email taille(1000)
Fax	String	15	False	Fax taille(30)
GeoXY	GeoData	16	False	Coordonnées géographiques
SaveToAdressBook	Boolean	17	False	Sauvegarder l'adresse dans les adresses favorites du client, l'id adresse est ensuite disponible dans la mission renvoyé par CreateShipment
ExternCode	String	18	False	Code d'identification externe de l'adresse taille(20)
CustomCommentFields	Nullable`1[]	19	False	Liste des champs commentaires 1 à 8 visible pour l'adresse (Mode enlèvement ou livraison)
AdditionalAddressLine1	String	20	False	Champs d'adresse supplémentaire 1 taille(50)
AdditionalAddressLine2	String	21	False	Champs d'adresse supplémentaire 2 taille(50)
AdditionalAddressLine3	String	22	False	Champs d'adresse supplémentaire 3 taille(50)
AdditionalAddressLine4	String	23	False	Champs d'adresse supplémentaire 4 taille(50)
AdditionalAddressLabel1	String	24	False	Libellé du champs d'adresse supplémentaire 1
AdditionalAddressLabel2	String	25	False	Libellé du champs d'adresse supplémentaire 2
AdditionalAddressLabel3	String	26	False	Libellé du champs d'adresse supplémentaire 3
AdditionalAddressLabel4	String	27	False	Libellé du champs d'adresse supplémentaire 4
AddressId	Int32 nullable	28	False	Numéro d'identification interne de l'adresse
InternalShipmentAddressId	Int32 nullable	29	False	Numéro d'identification interne de l'adresse quand elle est liée à une mission : ID PASSAGE
OperationZoneCode	String	30	False	Code de la zone d'exploitation pour l'attribution (sousmis à Licence)
ByPassCityCheck	Boolean	31	False	Quand ce paramètre est à true, Dispatch laisse passer la ville en création de mission même si elle n'existe pas dans Dispatch, le code secteur utilisé si il n'est pas fournit correspond au 2 premiers caractères du code postal pour la France sinon il correspond au code pays

{
  "PostalCode": null,
  "City": null,
  "CityID": null,
  "Sector": null,
  "SaveToAdressBook": false,
  "CustomCommentFields": null
}

AddressSuggestion

Suggestion d'adresse utilisée pour les recherches

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse suggérée
LocationId	String	1	False	Identifiant correspondant à la suggestion et devant être transmis à la méthode Json/GetAddressByLocationId
MatchLevel	MatchLevel	2	False	Indique le niveau de précision de la suggestion (ex: city, postalCode...)

{}

AlertOnShipmentProgress

Permet de configurer les alertes le suivi d'une mission

Propriété	Type	Ordre	Obligatoire	Description
AlertByEmail	Boolean	0	False	Les alertes sont envoyées par email
AlertBySMS	Boolean	1	False	Les alertes sont envoyées par SMS
AdditionalEmailAddress	List`1 - String	2	False	Liste des emails qui recevront l'alerte
AdditionalPhoneNumber	List`1 - String	3	False	Liste des numéros de téléphone qui recevront l'alerte
AlertOnShipmentConfirmation	Boolean	4	False	Recevoir une alerte à la confirmation de la commande
AlertOnPickup	Boolean	5	False	Recevoir une alerte à l'enlèvement
AlertOnDelivery	Boolean	6	False	Recevoir une alerte à la livraison

{
  "AlertByEmail": false,
  "AlertBySMS": false,
  "AdditionalEmailAddress": [],
  "AdditionalPhoneNumber": [],
  "AlertOnShipmentConfirmation": false,
  "AlertOnPickup": false,
  "AlertOnDelivery": false
}

AnnouncedPackageEvent

Evènement d'historique de colis annoncés trackés

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Identifiant unique de l'évènement
UtcDate	DateTime	1	False	Date utc de l'évènement (Format WCF)
Barcode	String	2	False	Code à barre du colis
AnomalyCode	String	3	False	Code de l'anomlie du colis tracké
ProofOfDelivery	String	4	False	Signature de la preuve de livraison
Address	Address	5	False	Lieu où a été effectué l'évènement
Driver	Driver	6	False	Chauffeur ayant effectué l'action
Round	String	7	False	Tournée dans laquelle a été effectuée l'évènement
RegularTransportCode	String	8	False	Code de l'ordre de transport régulier dans lequel a été effectué l'évènement

{
  "Id": 0,
  "Barcode": null,
  "AnomalyCode": null,
  "ProofOfDelivery": null,
  "Address": null,
  "Driver": null,
  "Round": null,
  "RegularTransportCode": null
}

Anomaly

Anomalie de transport Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code Anomalie Dispatch
Label	String	1	False	Libellé Anomalie Dispatch
Comment	String	2	False	Commentaire sur l'anomalie(Chauffeur ou exploitant)
AnomalyType	Int32	3	False	Type d'anomalie

{
  "Code": null,
  "Label": null,
  "Comment": null,
  "AnomalyType": 0
}

AnomalyType

Type d'anomalie de transport Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code Anomalie Dispatch
Label	String	1	False	Libellé Anomalie Dispatch

{
  "Code": null,
  "Label": null
}

AppointmentTimeSlot

Créneaux de rendez vous

Propriété	Type	Ordre	Obligatoire	Description
Begin	Date	0	False	Début de créneaux
End	Date	1	False	Fin de créneaux

{}

ApprobationOrderer

Représentation d'un donneur d'ordre pour le processus d'approbation

Propriété	Type	Ordre	Obligatoire	Description
Type	TypeApprobationOrderer	0	False	Type du donneur d'ordre: dépendant de l'approbation / approbateur
Name	String	1	True	Nom du donnneur d'ordre
Code	String	2	True	Code du donneur d'ordre

{
  "Type": 0,
  "Name": null,
  "Code": null
}

AutoTransportEngineModeEnum

Mode d'activation du plan de transport

Nom	Valeur
None	0
Customer	1
Default	2

Bill

Facture Dispatch

Propriété	Type	Ordre	Obligatoire	Description
InternalBillId	Int32	0	False	Numéro interne de facture Dispatch
BillNumber	String	1	False	Numéro de facture Dispatch
EmissionUtcDate	Date	2	False	Date d'emission de la facture
ExpiredUtcDate	Date	3	False	Date d'échéance de paiement
ExcludingTaxesAmount	Decimal	3	False	Montant hors taxe
IncludingTaxesAmount	Decimal	3	False	Montant TTC
OverduePayment	Decimal	4	False	Reste à payer
PaymentAvailable	Boolean	5	False	Réglement disponible
BillDocumentAvailable	Boolean	6	False	Facture électronique disponible au format PDF
InternalCompanyCode	String	7	False	Code société rattaché à la facture (usage interne)
BillState	EBillState	8	False	Etat courant de la facture
BillType	EBillType	9	False	Type de facture
AgencyCode	String	10	False	Agence Dispatch émetrice
BillDocumentTrackId	String	11	False	Identifiant permettant de télécharger la facture

{
  "InternalBillId": 0,
  "BillNumber": null,
  "EmissionUtcDate": null,
  "ExpiredUtcDate": null,
  "ExcludingTaxesAmount": 0.0,
  "IncludingTaxesAmount": 0.0,
  "OverduePayment": 0.0,
  "PaymentAvailable": false,
  "BillDocumentAvailable": false,
  "InternalCompanyCode": null,
  "BillState": 0,
  "BillType": 0,
  "AgencyCode": null,
  "BillDocumentTrackId": null
}

BulkBreaking

Informations sur la rupture de charge

Propriété	Type	Ordre	Obligatoire	Description
HasBulkBreaking	Boolean	0	True	Le transport est sousmis à une rupture de charge (lecture seule)
IsRootShipment	Boolean	1	True	Dans le cas d'une rupture de charge il s'agit du fragment parent (lecture seule)
IsChildShipment	Boolean	1	True	Dans le cas d'une rupture de charge il s'agit d'un fragment enfant (lecture seule)

{
  "HasBulkBreaking": false,
  "IsRootShipment": false,
  "IsChildShipment": false
}

City

Ville Dispatch

Propriété	Type	Ordre	Obligatoire	Description
PostalCode	String	0	False	Code Postal
CityName	String	1	False	Libellé ville
Country	String	2	False	Code Pays
Sector	String	3	False	Secteur de tarification Dispatch
CityId	Int32	4	False	Id ville Dispatch
GeoXY	GeoData	5	False	Coordonnées géographiques de la ville (Lecture seule)
Agency	String	6	False	Indique le code agence pour lequel la ville est disponible

{
  "PostalCode": null,
  "CityName": null,
  "Country": null,
  "Sector": null,
  "CityId": 0,
  "GeoXY": null,
  "Agency": null
}

ClientServiceImport

Prestation spécifique au client

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code client associé à la prestion, indique que la prestation est spécifique à ce client
ServiceCode	String	1	True	Code de la prestation
OpenHour	DateTime	2	False	Heure d'ouverture de la prestation
CloseHour	DateTime	3	False	Heure de la fermeture de la prestation
Index	Int32	4	False	Index d'apparition de la prestation si elle est retournée par liste
ActiveOnMonday	Boolean	5	False	Prestation accessible le lundi
ActiveOnTuesday	Boolean	6	False	Prestation accessible le mardi
ActiveOnWednesday	Boolean	7	False	Prestation accessible le mercredi
ActiveOnThursday	Boolean	8	False	Prestation accessible le jeudi
ActiveOnFriday	Boolean	9	False	Prestation accessible le vendredi
ActiveOnSaturday	Boolean	10	False	Prestation accessible le samedi
ActiveOnSunday	Boolean	11	False	Prestation accessible le dimanche
ActiveOnHoliday	Boolean	12	False	Prestation accessible les jours fériés

{
  "CustomerCode": null,
  "ServiceCode": null,
  "Index": 0,
  "ActiveOnMonday": false,
  "ActiveOnTuesday": false,
  "ActiveOnWednesday": false,
  "ActiveOnThursday": false,
  "ActiveOnFriday": false,
  "ActiveOnSaturday": false,
  "ActiveOnSunday": false,
  "ActiveOnHoliday": false
}

CommentVisibilityConfig

Visibilité des champs commentaires de l'ordre les valeurs possibles pour chaque champs : 'private': le champs ne doit pas être visible, 'general': le champs est affiché où l'on veut, 'pickup': le champs est liée à l'adresse d'enlèvement, 'delivery': ke champs est lié à l'adresse de livraison

Propriété	Type	Ordre	Obligatoire	Description
Label	String	0	False	Libellé du commentaire
AreaVisibility	String	1	False	Zone de visibilité du commentaire

{
  "Label": "",
  "AreaVisibility": "private"
}

CommunicationModeImport

Modes de communication

Propriété	Type	Ordre	Obligatoire	Description
Email	Boolean nullable	0	False	Communications par email
Fax	Boolean nullable	1	False	Communications par fax
SMS	Boolean nullable	2	False	Communications par SMS

{}

CompanyParameters

Paramètres généraux de l'API

Propriété	Type	Ordre	Obligatoire	Description
ClientEBusinessCode	String	0	False	Code du client eCommerce pour les particuliers
DefaultCountryCode	String	1	False	Code pays par défaut
MandatoryAddressFields	eMandatoryAddressFields	2	False	Champs d'adresse obligatoire (obsolete : utiliser la classe ShipmentCreationConfiguration pour récupérer la configuration de création de mission)
ForcingStepByStepMode	Boolean	3	False	Paramètre obsolete
ConditionOfUse	String	4	False	URL des CGV
UseAddressNormalization	Boolean	5	False	Normaliser lse adresses d'enlèvement livraison (option soumise à licence cartorgraphique) (obsolete : utiliser la classe ShipmentCreationConfiguration pour récupérer la configuration de création de mission)
AddressNormalizationRequired	Boolean	6	False	Normalisation d'adresse obligatoire (obsolete : utiliser la class ShipmentCreationConfiguration pour récupérer la configuration de création de mission)
UseAddressNormalizationIneBusiness	Boolean	7	False	Normaliser lse adresses d'enlèvement livraison pour le ecommerce (option soumise à licence cartorgraphique)(obsolete : utiliser la classe ShipmentCreationConfiguration pour récupérer la configuration de création de mission)
AddressNormalizationRequiredIneBusiness	Boolean	8	False	Normalisation d'adresse obligatoire pour le ecommerce
ClientEBusinessCodeProfessionnal	String	9	False	Code du client eCommerce pour les professionels
EBusinessMandatoryFields	eMandatoryAddressFields	10	False	Champs d'adrese obligatoires pour le ecommerce
OrdererCodeEBusiness	List`1 - String	11	False	Code du donneur d'ordre Dispatch utilisé pour la saisie de mission ecommerce des clients particuliers
OrdererCodeEBusinessProfessional	List`1 - String	12	False	Code du donneur d'ordre Dispatch utilisé pour la saisie de mission ecommerce des clients professionnels
ECommerceGeneralConditionURL	String	13	False	URL des CGV ecComemrce
EBusinessShowPackageStep	Boolean	14	False	Le colisage doit être saisi dans le ecommerce
Coment1Mode	eComentMode	15	False	Mode d'affichage du commentaire 1 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment2Mode	eComentMode	16	False	Mode d'affichage du commentaire 2 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment3Mode	eComentMode	17	False	Mode d'affichage du commentaire 3 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment4Mode	eComentMode	18	False	Mode d'affichage du commentaire 4 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment5Mode	eComentMode	19	False	Mode d'affichage du commentaire 5 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment6Mode	eComentMode	20	False	Mode d'affichage du commentaire 6 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment7Mode	eComentMode	21	False	Mode d'affichage du commentaire 7 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
Coment8Mode	eComentMode	22	False	Mode d'affichage du commentaire 8 (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)
VisibleAddressFields	eVisibleAddressFields	23	False	Champs d'adresses affichées par défaut en saisie et suivi de mission (obsolete : utiliser la classe ShipmentCreationConfiguration pour récupérer la configuration de création de mission)
TrackingPackagesSearchMaxPeriodInMonths	Int32	24	False	Période max. de recherche des colis trackés (nombre de mois)
TrackingPackagesSearchIgnoreBarcodeWhiteSpaces	Boolean	25	False	Ignore les espaces dans les codes à barres des colis trackés
TrackingPackageSearchMinCharNbForAutocompletion	Int32	26	False	Nb de charactères min. pour déclencher l'autocompletion sur les codes à barres des colis trackés
WeightDisplayUnit	String	27	False	Unité de poids affiché (différente de l'unité de poids par défaut KG)(usage interne)
DefaultSizeUnit	String	28	False	Unité de dimensions de colisage (Llh) par défaut (mm/cm/m/...)
GazEmissionEnabled	Boolean	29	False	Dispatch calcule le CO2
SearchRestrictionSettings	SearchRestrictionSettings	30	False	Restrictions pour les champs concernant la recherche de missions
HideBarCodeOnMissionDetails	Boolean	31	False	Conditionne l'affichage de la colonne code à barres en détail de suivi de mission (colisage)
TrackIdFeatureEnabled	Boolean	32	False	La fonctionnalité de suivi via trackid est activée
DefaultCountryForOrderHistory	String	33	False	Code pays par défaut utilisé pour le suivi de mission. Si non paramétrée vaut 'ALL'
CircuitAddressesSetEnabled	Boolean	34	False	Les puits sont configurés
TransportSearchResultLimit	UInt32	35	False	Nombre de jours limit pour la recherche dans le suivi de mission
ReceiptLabel	String	36	False	Libellé du récépissé
IsAirWaybillModuleEnabled	Boolean	37	False	Module de lettre de transport aérien disponible
TrackyParameters	TrackyParameters	38	False	Tracky parameters
LoginPageUrl	String	39	False	Login page url
HomePageMessage	String	40	False	Home page message
TrackyUrl	String	41	False	Public tracking interface base url

{
  "ClientEBusinessCode": null,
  "DefaultCountryCode": null,
  "MandatoryAddressFields": 0,
  "ForcingStepByStepMode": false,
  "ConditionOfUse": null,
  "UseAddressNormalization": false,
  "AddressNormalizationRequired": false,
  "UseAddressNormalizationIneBusiness": false,
  "AddressNormalizationRequiredIneBusiness": false,
  "ClientEBusinessCodeProfessionnal": null,
  "EBusinessMandatoryFields": 0,
  "OrdererCodeEBusiness": null,
  "OrdererCodeEBusinessProfessional": null,
  "ECommerceGeneralConditionURL": null,
  "EBusinessShowPackageStep": false,
  "Coment1Mode": 0,
  "Coment2Mode": 0,
  "Coment3Mode": 0,
  "Coment4Mode": 0,
  "Coment5Mode": 0,
  "Coment6Mode": 0,
  "Coment7Mode": 0,
  "Coment8Mode": 0,
  "VisibleAddressFields": 0,
  "TrackingPackagesSearchMaxPeriodInMonths": 0,
  "TrackingPackagesSearchIgnoreBarcodeWhiteSpaces": false,
  "TrackingPackageSearchMinCharNbForAutocompletion": 0,
  "WeightDisplayUnit": null,
  "DefaultSizeUnit": null,
  "GazEmissionEnabled": false,
  "SearchRestrictionSettings": null,
  "HideBarCodeOnMissionDetails": false,
  "TrackIdFeatureEnabled": false,
  "DefaultCountryForOrderHistory": null,
  "CircuitAddressesSetEnabled": false,
  "TransportSearchResultLimit": 0,
  "ReceiptLabel": null,
  "IsAirWaybillModuleEnabled": false,
  "TrackyParameters": null,
  "LoginPageUrl": null,
  "HomePageMessage": null,
  "TrackyUrl": null
}

Country

Pays Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code pays Dispatch
Label	String	1	False	Libellé Pays Dispatch
UnknownCityAccepted	Boolean	2	False	Indication sur le fait que le pays accepte la saisie de villes inconnues
FamilyCode	String	3	False	Code de la famille du pays

{
  "Code": null,
  "Label": null,
  "UnknownCityAccepted": false,
  "FamilyCode": null
}

Credential

Objet d'identification à l'API

Propriété	Type	Ordre	Obligatoire	Description
License	String	0	True	Code Licence DISPATCH
Login	String	1	False	Login donneur d'ordre Dispatch (taille max 320 caractères)
Password	String	2	False	Mot de passe du donneur d'ordre Dispatch
EMail	String	3	False	Email du donneur d'ordre
Language	String	4	False	Code langue à utiliser de type fr-FR, en-EN..
ConnectionToken	String	5	False	Token de connexion renvoyé par l'API, évite de repasser les identifiants tant qu'une session est valide, accélère l'authentification
OrdererCode	String	6	False	Code du donneur d'ordre Dispatch
DelegateToken	String	7	False	Token du donneur d'ordre délégué empruntant l'identité du donneur d'ordres actuel (délégateur)
ConsumerOrdererCode	String	8	False	Consumer orderer code
ConsumerKey	String	9	False	Consumer Key
Sso	SsoAuthentication	10	False	SSO information

{
  "License": null,
  "Login": null,
  "Password": null,
  "EMail": null,
  "Language": null,
  "ConnectionToken": null,
  "OrdererCode": null,
  "DelegateToken": null,
  "ConsumerOrdererCode": null,
  "ConsumerKey": null,
  "Sso": null
}

CustomField

Paramètre personnalisé

Propriété	Type	Ordre	Obligatoire	Description
ConfigName	String	0	False	Nom de la configuration
Id	Int32	1	True	Id champs
Value	String	2	True	Valeur
FieldType	CustomFieldType	3	False	Type de la valeur
Label	String	4	False	Libellé
Mandatory	Boolean	5	False	Champs obligatoire ?
DefaultValue	String	6	False	Valeur par défaut
ForcePreRegistredValues	Boolean	7	False	Forcer l'utilisation des valeurs pré-enregistrées
PreRegistredValues	List`1 - String	8	False	Valeurs pré-enregistrées, le controle utilisateur doit être de type liste déroulante
ReadOnly	Boolean	9	False	Lecture seule
Code	String	10	False	Code champs
FreeInput	Boolean	11	False	Saisie libre

{
  "ConfigName": null,
  "Id": 0,
  "Value": null,
  "FieldType": 0,
  "Label": null,
  "Mandatory": false,
  "DefaultValue": null,
  "ForcePreRegistredValues": false,
  "PreRegistredValues": null,
  "ReadOnly": false,
  "Code": null,
  "FreeInput": false
}

CustomMissionsViewColumnDescription

Paramétrage d'afficahge personnalisé d'une colonne utilisée dans la recherche de mission

Propriété	Type	Ordre	Obligatoire	Description
CssClass	String	0	False	Class CSS
Name	String	1	False	Nom de la colonne (HTML)
HeaderText	String	2	False	En tête de la colonne
Field	String	3	False	Champs lié en base
Width	Int32 nullable	4	False	Largeur en pixel
Sortable	Boolean	5	False	Colonne triable ?

{
  "CssClass": null,
  "Name": null,
  "HeaderText": null,
  "Field": null,
  "Width": null,
  "Sortable": false
}

Customer

Client Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	True	Code client obligatoire taille (11)
Label	String	1	False	Libellé client taille (50)
Agency	String	2	False	Code Agence Disaptch (10)
LabelAddressComplement1	String	3	False	Libellé adresse complémentaire 1 (1000)
LabelAddressComplement2	String	4	False	Libellé adresse complémentaire 2 (1000)
LabelAddressComplement3	String	5	False	Libellé adresse complémentaire 3 (1000)
LabelAddressComplement4	String	6	False	Libellé adresse complémentaire 4 (1000)
CustomParametersConfigName	String	7	False	Nom de la configuration de paramètres personnalisés associée au client
LabelComent1	String	8	False	Libellé commentaire 1 (20)
LabelComent2	String	9	False	Libellé commentaire 2 (20)
LabelComent3	String	10	False	Libellé commentaire 3 (20)
LabelComent4	String	11	False	Libellé commentaire 4 (20)
LabelComent5	String	12	False	Libellé commentaire 5 (20)
LabelComent6	String	13	False	Libellé commentaire 6 (20)
LabelComent7	String	14	False	Libellé commentaire 7 (20)
LabelComent8	String	15	False	Libellé commentaire 8 (20)
ReferenceLabel1	String	15	False	Libellé du champs référence 1 (30)
ReferenceLabel2	String	15	False	Libellé du champs référence 2 (30)
ReferenceLabel3	String	15	False	Libellé du champs référence 3 (30)
CustomerVoucherInfo	CustomerVoucherInfo	16	False	Informations sur la facturation en bon du client (visible uniquement si le donneur d'ordre a le droit voir le solde de bon)
CustomFields	List`1 - CustomField	17	False	Liste des paramètres personnalisés (EDI) associés au compte client, non chargé par défaut,
Billable	Boolean	18	False	Vrai si le client est facturable (lecture seule)
DueDayOfPayment	Int32	19	False	Nombre de jours avant échéance de paiement (lecture seule)
CurrencyCode	String	20	False	Devise client (EUR,USD,...) (lecture seule)
FamilyCode	String	21	False	Family client code
FamilyName	String	22	False	Family client name
IsSubjectToFuelSurcharge	Boolean	23	False	Vrai si la surtaxe carburant est appliquable (lecture seule)
IntraCommunityVatNumber	String	24	False	Client intra-community VAT number (size 53)
CustomerTags	List`1 - CustomerTag	25	False	Customer tag list

{
  "Code": null,
  "Label": null,
  "Agency": null,
  "LabelAddressComplement1": null,
  "LabelAddressComplement2": null,
  "LabelAddressComplement3": null,
  "LabelAddressComplement4": null,
  "CustomParametersConfigName": null,
  "LabelComent1": null,
  "LabelComent2": null,
  "LabelComent3": null,
  "LabelComent4": null,
  "LabelComent5": null,
  "LabelComent6": null,
  "LabelComent7": null,
  "LabelComent8": null,
  "ReferenceLabel1": null,
  "ReferenceLabel2": null,
  "ReferenceLabel3": null,
  "CustomerVoucherInfo": null,
  "CustomFields": null,
  "Billable": false,
  "DueDayOfPayment": 0,
  "CurrencyCode": null,
  "FamilyCode": null,
  "FamilyName": null,
  "IsSubjectToFuelSurcharge": false,
  "IntraCommunityVatNumber": null,
  "CustomerTags": null
}

CustomerBillingImport

Partie facturation du client à importer

Propriété	Type	Ordre	Obligatoire	Description
PaymentCode	String	0	False	Code réglement
IsBillable	Boolean nullable	1	False	Facturable
BillingAddress	Address	2	False	Adresse de facturation
PricingScaleCode	String	3	False	Code grille de tarification
GeneralAccount	String	4	False	Compte général
AuxiliaryAccount	String	5	False	Compte auxiliaire
VouchersBillingMode	Char nullable	6	False	Mode de bon de facturation Valeurs possibles : B : Vente de carnet de bons U : Facturation sur relevé d'unités V : Vente de crédits de bons X : Mode non selectionné
VoucherPrice	Double nullable	7	False	Prix du bon
EIN	String	8	False	Siret
EuropeanVAT	String	9	False	TVA Communautaire
EnableOilSurcharge	Boolean nullable	10	False	Appliquer une surchage carburant
OilSurchargeRate	Double nullable	11	False	Taux de la surchage carburant (1 == 100%)
OilSurchargeReferenceIndex	Double nullable	12	False	Indice de référence de la surchage carburant

{}

CustomerCommunicationImport

Partie communication du client à importer

Propriété	Type	Ordre	Obligatoire	Description
ActivateOnStateChange	CommunicationModeImport	0	False	Activer l'envoi sur changement d'état
OnEntry	CommunicationModeImport	1	False	Activer l'envoi de la confirmation de prise en charge à la saisie, l'option ActivateOnStateChange doit être activé également
OnAssigment	CommunicationModeImport	2	False	Activer l'envoi de la confirmation de prise en charge à l'attribution, l'option ActivateOnStateChange doit être activé également
OnPickUp	CommunicationModeImport	3	False	Activer l'envoi de la confirmation d'enlèvement, l'option ActivateOnStateChange doit être activé également
OnDelivery	CommunicationModeImport	4	False	Activer l'envoi de la confirmation de livraison, l'option ActivateOnStateChange doit être activé également
OnConclusion	CommunicationModeImport	5	False	Activer l'envoi de la confirmation de livraison lors de la terminaison, l'option ActivateOnStateChange doit être activé également
OnAppointement	CommunicationModeImport	6	False	Activer l'envoi de confirmation de rendez-vous, l'option ActivateOnStateChange doit être activé également
OnDelays	CommunicationModeImport	7	False	Activer l'envoi de l'annonce de retard au point de passage, l'option ActivateOnStateChange doit être activé également
Invoices	CommunicationModeImport	8	False	Activer l'envoi des factures

{}

CustomerCustomField

Paramètre personnalisé client

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	True	Id champs
Value	String	1	True	Valeur
FieldType	CustomerCustomFieldType	2	True	Type de la valeur
Label	String	3	True	Libellé
Mandatory	Boolean	4	True	Champs obligatoire ?
DefaultValue	String	5	False	Valeur par défaut
CodeCustomerCustomField	String	6	False	Code d'équivalence client

{
  "Id": 0,
  "Value": null,
  "FieldType": 0,
  "Label": null,
  "Mandatory": false,
  "DefaultValue": null,
  "CodeCustomerCustomField": null
}

CustomerGeneralImport

Partie générale du client à importer

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	False	Code du client (11)
CustomerLabel	String	1	False	Libellé du client
PickupDeliveryAddress	Address	2	False	Adresse d'enlévement/livraison
AgencyCode	String	3	False	Code de l'agence du client
TransportOrganisationCode	String	4	False	Code du plan de transport : Un plan de transport permet d'attribuer automatiquement un chauffeur ou un sous-traitant, l'option ActivateAutoTransportEngine doit être activée
SalesRepresentativeCode	String	5	False	Code du commercial gérant le client
AutoTransportEngineMode	AutoTransportEngineModeEnum nullable	6	False	Active l'option plan de transport : Un plan de transport permet d'attribuer automatiquement un chauffeur ou un sous-traitant

{
  "CustomerCode": null
}

CustomerIdentity

Client

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	False	Code du client
CustomerName	String	1	False	Nom du client
Address	Address	2	False	Adresse enlèvement/livraison du client

{
  "CustomerCode": null,
  "CustomerName": null,
  "Address": null
}

CustomerImport

Client Dispatch à importer ou modifier

Propriété	Type	Ordre	Obligatoire	Description
General	CustomerGeneralImport	0	False	Partie générale du client à importer
Operation	CustommerOperationImport	1	False	Partie exploitation du client à importer
Billing	CustomerBillingImport	2	False	Partie facturation du client à importer
Communication	CustomerCommunicationImport	3	False	Partie communication du client à importer
References	CustommerReferencesImport	4	False	Partie référence du client à importer

{}

CustomerTag

Tag client

Propriété	Type	Ordre	Obligatoire	Description
Id	Guid	0	True	Id du tag
Label	String	1	False	Libellé tag taille (100)

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Label": null
}

CustomerVoucherInfo

Information sur les crédit/solde de bon d'un client

Propriété	Type	Ordre	Obligatoire	Description
VoucherBillMode	eVoucherBillMode	0	True	Mode de facturation des bons
VoucherCredit	Decimal nullable	1	False	Solde de crédit de bons restants pour le client
VirtualVoucherCredit	Decimal nullable	2	False	Solde de crédit de bons virtuels restants pour le client

{
  "VoucherBillMode": 88,
  "VoucherCredit": null,
  "VirtualVoucherCredit": null
}

CustommerOperationImport

Partie exploitation du client à importer

Propriété	Type	Ordre	Obligatoire	Description
PricesCatalogCode	String	0	False	Code de la série de trajets
CustomerCallbackOnDelivery	Boolean nullable	1	False	Le client doit être rappelé lors de la livraison
CustomerCallbackOnDelay	Boolean nullable	2	False	Le client doit être rappelé lors d'un retard
CustomerFamilyCode	String	3	False	Famille de clients
EDICustomerIdentifier	String	4	False	Identifiant client EDI

{}

CustommerReferencesImport

Partie référence du client à importer

Propriété	Type	Ordre	Obligatoire	Description
Reference1Label	String	0	False	Libellé de la référence 1
Reference2Label	String	1	False	Libellé de la référence 2
Reference3Label	String	2	False	Libellé de la référence 3
Reference1Mandatory	Boolean nullable	3	False	Référence 1 obligatoire
Reference2Mandatory	Boolean nullable	4	False	Référence 2 obligatoire
Reference3Mandatory	Boolean nullable	5	False	Référence 3 obligatoire

{}

DailyGeoDeviceReport

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
GeoDeviceId	Int32	0	False	Identifiant du boitier GPS
DateToExport	DateTime	1	True	Date de la journée a exporter du boitier GPS
IdModel	Int32	2	True	Identifiant du model
LabelModel	String	3	True	Nom du model
FileType	FileType	4	True	Type de sortie
GeoDeviceGuid	Guid	5	False	Identifiant unique du boitier GPS (valable à partir de la version Dispatch 3.47)

{
  "GeoDeviceId": 0,
  "DateToExport": "\/Date(-62135596800000)\/",
  "IdModel": 0,
  "LabelModel": null,
  "FileType": 0,
  "GeoDeviceGuid": "00000000-0000-0000-0000-000000000000"
}

DailyTrackHistory

Feuille de route d'un boitier gps

Propriété	Type	Ordre	Obligatoire	Description
GeoDeviceId	Int32	0	False	Identifiant unique d'un boitier
CustomLabel	String	1	False	Libellé personnalisé
Day	Date	2	True	Date de la trace
Distance	Double	3	True	Distance parcouru en km
DrivingDurationString	String	4	True	Temps de conduite
DrivingDurationInMinutes	Int32	5	True	Temps de conduite en minutes
StopDurationString	String	6	True	Temps des arrêts
StopDurationInMinutes	Int32	7	True	Temps des arrêts en minutes
StopCount	Int32	8	True	Nombres d'arrêts
Track	GeoDeviceTrack	9	False	Trace du boitier
GeoDeviceGuid	Guid	10	False	Identifiant unique du boitier GPS (valable à partir de la version Dispatch 3.47)

{
  "GeoDeviceId": 0,
  "CustomLabel": null,
  "Day": null,
  "Distance": 0.0,
  "DrivingDurationString": null,
  "DrivingDurationInMinutes": 0,
  "StopDurationString": null,
  "StopDurationInMinutes": 0,
  "StopCount": 0,
  "Track": null,
  "GeoDeviceGuid": "00000000-0000-0000-0000-000000000000"
}

Date

Classe date qui permet de s'abstraire des problème de conversion d'objet c# en javascript en proposant des dates sous forme de chaine

Propriété	Type	Ordre	Obligatoire	Description
Value	DateTime nullable	0	False	Valeur c# de la date
StringFullDate	String	1	False	Date sous forme de chaine au format dd/MM/yyyy HH:mm
StringDate	String	2	False	Date sous forme de chaine au format dd/MM/yyyy (lecture seule)
StringHour	String	3	False	Date sous forme de chaine HH:mm (lecture seule)
JsonDateTime	String	4	False	Date sous forme de chaine au format JSON WCF \/Date(1297293089984-0800)\/ (lecture seule)
Tick	Int64 nullable	5	False	Tick (lecture seule)
UnixTimeSpan	String	6	False	UnixTime timestamp (lecture seule)
IsDateWithoutHour	Boolean	7	False	La date ne contient pas d'heure

{
  "Value": null,
  "StringFullDate": null,
  "StringDate": null,
  "StringHour": null,
  "JsonDateTime": null,
  "UnixTimeSpan": null,
  "IsDateWithoutHour": false
}

DelegateOrderer

Représentation d'un donneur d'ordre délégué

Propriété	Type	Ordre	Obligatoire	Description
Name	String	0	True	Nom du donnneur d'ordre
Code	String	1	True	Code du donneur d'ordre
ExternalIdentifier	String	2	False	Identifiant externe du donneur d'ordre

{
  "Name": null,
  "Code": null,
  "ExternalIdentifier": null
}

DelegationOrderer

Représentation d'un donneur d'ordre pour le processus de délégation

Propriété	Type	Ordre	Obligatoire	Description
Name	String	0	True	Nom du donnneur d'ordre
Code	String	1	True	Code du donneur d'ordre
ExternalIdentifier	String	2	False	Identifiant externe du donneur d'ordre

{
  "Name": null,
  "Code": null,
  "ExternalIdentifier": null
}

DelegatorOrderer

Représentation d'un donneur d'ordre délégateur

Propriété	Type	Ordre	Obligatoire	Description
Name	String	0	True	Nom du donnneur d'ordre
Code	String	1	True	Code du donneur d'ordre
ExternalIdentifier	String	2	False	Identifiant externe du donneur d'ordre

{
  "Name": null,
  "Code": null,
  "ExternalIdentifier": null
}

Dispute

Litige Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code litige
Label	String	1	False	Libellé litige

{
  "Code": null,
  "Label": null
}

Driver

Chauffeur Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Name	String	0	False	Nom du chauffeur
Photo	Byte[]	1	False	Photo du chauffeur Dispatch

{
  "Name": null,
  "Photo": null
}

DriverIdentity

Chauffeur

Propriété	Type	Ordre	Obligatoire	Description
DriverId	Int32	0	False	Identifiant du chauffeur
DriverName	String	1	False	Nom du chauffeur
DriverKind	Int32	2	False	Type du chauffeur (0: subcontractor, 1: subcontractor employee, 2: driver, 3: commercial)

{
  "DriverId": 0,
  "DriverName": null,
  "DriverKind": 0
}

EBillState

Etat courant d'une facture

Nom	Valeur
PreBilled	1
Billed	2
Purged	3
Generated	4
Canceled	5
Closed	6
TotalyPayed	7
PartialyPayed	8
CreditNote	9

ECommerceCredential

Identifiants eCommerce

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	0	True	Identifiants API
Type	CredentialType	1	True	Type d'accès : Particulier ou Professionel
ClientCode	String	2	False	Code client Dispatch
OrdererCode	String	3	False	Code donneur d'ordre Dispatch
CSSURLDirectory	String	4	False	Url de la css
WebAccessCustomerCodes	List`1 - String	5	False	Liste des codes clients liés avec accès web

{
  "Credential": null,
  "Type": 0,
  "ClientCode": null,
  "OrdererCode": null,
  "CSSURLDirectory": null,
  "WebAccessCustomerCodes": null
}

EPaperOrientation

Valeurs possibles pour le paramètre Orientation des options papier (ReportPaperOptions)

Nom	Valeur
Default	0
Portrait	1
Landscape	2

EPaperSizeType

Valeurs possibles pour le paramètre SizeType des options papier (ReportPaperOptions)

Nom	Valeur
Default	0
PaperLetter	1
PaperLetterSmall	2
PaperTabloid	3
PaperLedger	4
PaperLegal	5
PaperStatement	6
PaperExecutive	7
PaperA3	8
PaperA4	9
PaperA4Small	10
PaperA5	11
PaperB4	12
PaperB5	13
PaperFolio	14
PaperQuarto	15
Paper10x14	16
Paper11x17	17
PaperNote	18
PaperEnvelope9	19
PaperEnvelope10	20
PaperEnvelope11	21
PaperEnvelope12	22
PaperEnvelope14	23
PaperCsheet	24
PaperDsheet	25
PaperEsheet	26
Sticker10x20cm	27
Sticker10x20cm	27
PaperEnvelopeC5	28
PaperEnvelopeC3	29
PaperEnvelopeC4	30
Sticker10x15cm	31
Sticker10x15cm	31
PaperEnvelopeC65	32
PaperEnvelopeB4	33
PaperEnvelopeB5	34
PaperEnvelopeB6	35
PaperEnvelopeItaly	36
PaperEnvelopeMonarch	37
PaperEnvelopePersonal	38
PaperFanfoldUS	39
PaperFanfoldStdGerman	40
PaperFanfoldLegalGerman	41

ExportModel

Modèle d'export

Propriété	Type	Ordre	Obligatoire	Description
IdModel	Int32 nullable	0	False	Id de ImpressionModeles par report sinon null si par recherche d'ordre
Label	String	1	True	Libellé du model d'export
TypeExportModel	eTypeExportModel	2	True	Type d'export

{
  "IdModel": null,
  "Label": null,
  "TypeExportModel": 0
}

FileCategory

Catégorie de fichier

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	True	Code de la catégorie
Label	String	1	True	Libellé de la catégorie

{
  "Code": null,
  "Label": null
}

FileShipmentInformation

Fichier rattaché à un ordre de transport en attente de transfert au serveur Dispatch

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	False	Numéro de l'ordre de transport
Guid	String	1	False	Guid temporaire du fichier
TemporaryShipmentGuid	String	2	True	Guid temporaire de l'ordre de transport
FileName	String	3	True	Nom original du fichier
CodeCategory	String	4	True	Code catégorie du fichier
LabelCategory	String	5	False	Libellé catégorie du fichier
OrdererCode	String	6	False	Code du donneur d'ordre
Id	Int32	7	False	Identifiant du fichier sur le serveur Dispatch
StateTransfer	FileShipmentInformationState	8	True	Etat du fichier sur le serveur DispatchWeb
IsClientDocument	Boolean	9	False	Défini si le document est un document administratif client
FileExtension	String	10	False	Extension du fichier (dans le cas ou l'extension est 'url' ca donne une url de téléchargement de fichier)
FileLabel	String	11	True	Nom du fichier

{
  "InternalShipmentId": 0,
  "Guid": null,
  "TemporaryShipmentGuid": null,
  "FileName": null,
  "CodeCategory": null,
  "LabelCategory": null,
  "OrdererCode": null,
  "Id": 0,
  "StateTransfer": 0,
  "IsClientDocument": false,
  "FileExtension": null,
  "FileLabel": null
}

FileShipmentInformationState

Etat d'avancement du rattachement du fichier à l'ordre de transport

Nom	Valeur
New	0
Successful	1
Failed	2

FileType

Format de sortie pour les report, ATTENTION, tous les formats ne sont pas disponibles pour tous les reports

Nom	Valeur
CrystalReport	1
RichText	2
WordForWindows	3
Excel	4
PortableDocFormat	5
HTML32	6
HTML40	7
ExcelRecord	8
Text	9
CharacterSeparatedValues	10
TabSeperatedText	11
EditableRTF	12

GeoData

Position géographique

Propriété	Type	Ordre	Obligatoire	Description
Latitude	Double	0	False	Latitude
Longitude	Double	1	False	Longitude
GPSUTCDateTime	Date	2	False	Date d'acquisition UTC
GPSServerLocalDateTime	Date	3	False	Date d'acquisition de la position en heure locale

{
  "Latitude": 0.0,
  "Longitude": 0.0,
  "GPSUTCDateTime": null,
  "GPSServerLocalDateTime": null
}

GeoDeviceAlertRevocation

Correspond aux alertes de suppression

Propriété	Type	Ordre	Obligatoire	Description
AlertType	GeoDeviceAlertType	0	False	Type d'alerte (temperature)
Date	DateTime nullable	1	False	Date de l'événement (Format C# /(timespan)/
Reason	String	2	False	Raison de l'alerte
LocalDate	Date	3	False	Date de l'événement format de l'API

{
  "AlertType": 0,
  "Date": null,
  "Reason": null,
  "LocalDate": {
    "Value": null,
    "StringFullDate": null,
    "StringDate": null,
    "StringHour": null,
    "JsonDateTime": null,
    "UnixTimeSpan": null,
    "IsDateWithoutHour": false
  }
}

GetStatisticsFilter

Filtre pour le téléchargement de statistiques

Propriété	Type	Ordre	Obligatoire	Description
CustomerCodes	List`1 - String	0	False	Listes de codes clients
DateUtcFrom	DateTime	1	False	Date de début de demande
DateUtcTo	DateTime	2	False	Date de fin de demande
ShowCA	Boolean	3	False	Afficher le chiffre d'affaire, uniquement utilisable si le donneur d'ordre a le droit de voir les tarifs
ShowDetails	Boolean	4	False	Affiche les détails
ShowDiagram	Boolean	5	False	Affiche le diagramme
ShowMargin	Boolean	6	False	Affiche la marge
ShowPurchase	Boolean	7	False	Affiche les achats
ShowWebMission	Boolean	8	False	Affiche les missions saisies sur le web
Sort	SortType	9	False	Enumeration des types de tri
AddressesId	List`1 - Int32	10	False	Liste d’identifiant adresse

{
  "CustomerCodes": null,
  "ShowCA": false,
  "ShowDetails": false,
  "ShowDiagram": false,
  "ShowMargin": false,
  "ShowPurchase": false,
  "ShowWebMission": false,
  "Sort": 0,
  "AddressesId": null
}

ImportShipmentsDetailedStatus

Statut détaillé d'un import d'une mission

Propriété	Type	Ordre	Obligatoire	Description
ImportSuccess	Boolean	0	False	Si true, l'import de l'ordre a réussi
ShipmentId	Int32	1	False	Numéro l'ordre de mission
InternalShipmentId	Int32	2	False	Numéro interne de l'ordre de mission champs ID_OT dans Dispatch
ExternalIdentifiers	List`1 - String	3	False	Identifiants de missions externes (fournis dans le fichier importé)
Error	String	4	False	Chaine d'erreur de l'import
TrackId	String	5	False	Track Id, utilisé pour la génération du lien de téléchargement

{
  "ImportSuccess": false,
  "ShipmentId": 0,
  "InternalShipmentId": 0,
  "ExternalIdentifiers": null,
  "Error": null,
  "TrackId": null
}

ImportShipmentsStatus

Statut d'un import de missions

Propriété	Type	Ordre	Obligatoire	Description
ShipmentsImportId	Int32	0	False	Identifiant permettant le suivi de l'import de missions
Status	Byte	1	False	Statut de l'import
ErrorMessages	List`1 - String	2	False	Messages d'erreurs
ProgressPercent	Byte nullable	3	False	Progression de l'import en pourcentage
CreatedShipmentsCount	Int32	4	False	Nombre de mission créées
UtcRequestDateTime	DateTime	5	False	Date de demande d'import
UtcCompletionDateTime	DateTime nullable	6	False	Date de fin d'import
InternalShipmentsIds	List`1 - Int32	7	False	Liste des numéros internes des ordres de mission champs ID_OT dans Dispatch
DetailedStatus	List`1 - ImportShipmentsDetailedStatus	8	False	Statuts détaillés par ordre
DateInformation	String	9	False	Information relative à la date de demande d'import

{
  "ShipmentsImportId": 0,
  "Status": 0,
  "ErrorMessages": null,
  "ProgressPercent": null,
  "CreatedShipmentsCount": 0,
  "InternalShipmentsIds": null,
  "DetailedStatus": null,
  "DateInformation": null
}

Language

Langue supportée par Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	True	Code Langue
Label	String	1	True	Libellé langue

{
  "Code": null,
  "Label": null
}

ListPagination

Configuration de la pagination d'une liste

Propriété	Type	Ordre	Obligatoire	Description
PageIndex	Int32	0	False	Index de la page (valeur minimale : 1)
PageSize	Int32	1	False	Taille de la page

{
  "PageIndex": 0,
  "PageSize": 0
}

ListPaginationResult

Résultat de la pagination d'une liste

Propriété	Type	Ordre	Obligatoire	Description
PageIndex	Int32	0	False	Index de la page (valeur minimale : 1)
TotalCount	Int32	1	False	Nombre total de résultat possible
ResultsCountWanted	Int32	2	False	Nombre de résultat demandé pour la page

{
  "PageIndex": 0,
  "TotalCount": 0,
  "ResultsCountWanted": 0
}

Log

Représente les informations de debug

Propriété	Type	Ordre	Obligatoire	Description
Message	String	0	False	Message

{
  "Message": null
}

LoginType

Search orderer by login, mail or phone

Propriété	Type	Ordre	Obligatoire	Description
Login	String	0	False	Search orderer by login
Email	String	1	False	Search orderer by mail
Phone	String	2	False	Search orderer by phone

{
  "Login": null,
  "Email": null,
  "Phone": null
}

MatchLevel

Représente le niveau de précision de la suggestion d'adresse

Nom	Valeur
Exact	1
Poi	10
Street	20
PostalCode	30
City	40
Undetermined	100

OrderHistoryPublicConfig

Droits utilisateurs pour la page publique

Propriété	Type	Ordre	Obligatoire	Description
DisplayPickupAddressOnMap	Boolean	0	False	Afficher l'adresse d'enlèvement sur la carte de la page de tracking publique
DisplayDeliveryAddressOnMap	Boolean	1	False	Afficher l'adresse de livraison sur la carte de la page de tracking publique
DisplayMissionHistoryOnPublicTrackingPage	Boolean	2	False	Afficher l'historique de mission sur la page de tracking publique
DisplayContractualScheduleOnPublicTrackingPage	Boolean	3	False	Afficher les horaires contractuels sur la page de tracking publique
DisplayMissionFilesOnPublicTrackingPage	Boolean	4	False	Rendre visible les fichiers de mission (POD) sur la page de tracking publique
IsAllowedToDownloadSlipsWaybillOnPublicTrackingPage	Boolean	5	False	Rendre disponible le téléchargement du report Lettre de Voiture
DisplayPlannedScheduleOnPublicTrackingPage	Boolean	6	False	Afficher les horaires planifiés sur la page de tracking publique

{
  "DisplayPickupAddressOnMap": false,
  "DisplayDeliveryAddressOnMap": false,
  "DisplayMissionHistoryOnPublicTrackingPage": false,
  "DisplayContractualScheduleOnPublicTrackingPage": false,
  "DisplayMissionFilesOnPublicTrackingPage": false,
  "IsAllowedToDownloadSlipsWaybillOnPublicTrackingPage": false,
  "DisplayPlannedScheduleOnPublicTrackingPage": false
}

OrdererGeoDevice

Boitier associé à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
GeoDeviceId	Int32	0	False	Identifiant du boitier gps
Label	String	1	False	Libellé du boitier gps
ConstructorModel	String	2	False	Type de boitier : NS90, Dams, PDA/Android, NaoCom, Ornicar, TomTom, ...
CustomLabel	String	3	False	Libellé personnalisé associé au boitier
Registration	String	4	False	Immatriculation du véhicule associé au boitier
Latitude	Double nullable	5	True	Valeur de la latitude
Longitude	Double nullable	6	True	Valeur de la longitude
Precision	Int32 nullable	7	False	Degré de précision
LastChangeString	String	8	False	Temps en minute, heure ou jour de la dernière position reçue
DriverName	String	9	False	Nom du chauffeur associé au boitier
StartUtcDateVisibility	DateTime	10	False	Date de début de visibilité du boitier
EndUtcDateVisibility	DateTime	11	False	Date de fin de visibilité du boitier
GeoDeviceGuid	Guid	12	False	Identifiant unique du boitier GPS (valable à partir de la version Dispatch 3.47)

{
  "GeoDeviceId": 0,
  "Label": null,
  "ConstructorModel": null,
  "CustomLabel": null,
  "Registration": null,
  "Latitude": null,
  "Longitude": null,
  "Precision": null,
  "LastChangeString": null,
  "DriverName": null,
  "StartUtcDateVisibility": "\/Date(-62135596800000)\/",
  "EndUtcDateVisibility": "\/Date(-62135596800000)\/",
  "GeoDeviceGuid": "00000000-0000-0000-0000-000000000000"
}

OrdererRound

Tournée d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Identifiant de la tournée
Label	String	1	False	Libellé de la tournée
DriverId	Int32 nullable	2	False	Identifiant du chauffeur
DriverLabel	String	3	False	Libellé du chauffeur
ReferenceLocalDateTime	DateTime nullable	4	False	Date de réference de la tournée
Status	OrdererRoundStatus	5	False	Statut de la tournée
EstimatedStartLocalDateTime	DateTime nullable	6	False	Date estimée de début de la tournée
EstimatedEndLocalDateTime	DateTime nullable	7	False	Date estimée de fin de la tournée
StepCount	Int32	8	False	Nombre d'étapes
ProgressPercentage	Single	9	False	Pourcentage d'avancement
LastStepLateStatus	OrdererRoundLateStatus	10	False	Statut de retard du dernier point de passage effectué
LateStatus	OrdererRoundLateStatus	10	False	Statut de retard global de la tournée (au moins un des points a été réalisé en retard)
TransportSteps	List`1 - OrdererRoundTransportStep	11	False	Liste des étapes de la tournée

{
  "Id": 0,
  "Label": null,
  "DriverId": null,
  "DriverLabel": null,
  "ReferenceLocalDateTime": null,
  "Status": 0,
  "EstimatedStartLocalDateTime": null,
  "EstimatedEndLocalDateTime": null,
  "StepCount": 0,
  "ProgressPercentage": 0.0,
  "LastStepLateStatus": 0,
  "LateStatus": 0,
  "TransportSteps": null
}

OrdererRoundLateStatus

Statut de retard d'une tournée d'un donneur d'ordre

Nom	Valeur
Undetermined	0
NotLate	1
LateContractual	2
LatePlanning	3

OrdererRoundStatus

Statut d'une tournée d'un donneur d'ordre

Nom	Valeur
Planned	0
InProgress	1
Over	2

OrdererRoundTransportStep

Etape d'une tournée d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
TransportId	Int32	1	False	Identifiant du transport
TransportMissionId	Int32	2	False	Identifiant de la mission
TransportOrdererCode	String	3	False	Code donneur d'ordre du transport
TransportCustomerCode	String	4	False	Code client du transport
TransportStatus	String	5	False	Statut du transport
TransportSubstateCode	String	6	False	Code du sous-état courant du transport
TransportReference1	String	7	False	Référence 1 du transport
TransportReference2	String	8	False	Référence 2 du transport
TransportReference3	String	9	False	Référence 3 du transport
RoundTransportStepLateStatus	OrdererRoundLateStatus	10	False	Statut de retard du point de passage
RoundTransportStepId	Int32	11	False	Identifiant de l'étape
RoundTransportStepIsPickup	Boolean nullable	12	False	L'étape est un enlèvement
RoundTransportStepRowNumber	Int32	13	False	Numéro de l'étape
RoundTransportStepLabel	String	14	False	Label de l'étape de la tournée
RoundTransportStepStreetLabel	String	15	False	nom de la rue de l'étape
RoundTransportStepPostalCode	String	16	False	Code postal de l'étape
RoundTransportStepCity	String	17	False	Ville de l'étape
RoundTransportStepCountry	String	18	False	Code pays de l'étape
RoundTransportStepAddressId	Int32 nullable	19	False	Identifiant de l'adresse de l'étape
RoundTransportStepLatitude	Decimal nullable	20	False	Latitude de l'étape
RoundTransportStepLongitude	Decimal nullable	21	False	Longitude de l'étape
RoundTransportStepEstimatedLocalDateTime	DateTime nullable	22	False	Date estimée de réalisation de l'étape
RoundTransportStepRealizedLocalDateTime	DateTime nullable	23	False	Date de réalisation effective de l'étape
RoundTransportStepContractualLocalDateTime	DateTime nullable	24	False	Date prévue/contractuelle de réalisation de l'étape
RoundTransportNbPoints	Int32	25	False	Nombre de points regroupés pour l'étape

{
  "TransportId": 0,
  "TransportMissionId": 0,
  "TransportOrdererCode": null,
  "TransportCustomerCode": null,
  "TransportStatus": null,
  "TransportSubstateCode": null,
  "TransportReference1": null,
  "TransportReference2": null,
  "TransportReference3": null,
  "RoundTransportStepLateStatus": 0,
  "RoundTransportStepId": 0,
  "RoundTransportStepIsPickup": null,
  "RoundTransportStepRowNumber": 0,
  "RoundTransportStepLabel": null,
  "RoundTransportStepStreetLabel": null,
  "RoundTransportStepPostalCode": null,
  "RoundTransportStepCity": null,
  "RoundTransportStepCountry": null,
  "RoundTransportStepAddressId": null,
  "RoundTransportStepLatitude": null,
  "RoundTransportStepLongitude": null,
  "RoundTransportStepEstimatedLocalDateTime": null,
  "RoundTransportStepRealizedLocalDateTime": null,
  "RoundTransportStepContractualLocalDateTime": null,
  "RoundTransportNbPoints": 0
}

OrderingParty

Donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code interne du donneur d'ordre
Name	String	1	False	Nom du donneur d'ordre
Login	String	2	False	Identifiant du donneur d'ordre
Password	String	3	False	Mot de passe du donneur d'ordre
Email	String	4	False	Email du donneur d'ordre
Reference1	String	5	False	Valeur forcée de la référence 1
Reference2	String	6	False	Valeur forcée de la référence 2
Reference3	String	7	False	Valeur forcée de la référence 3
DefaultAgencyCode	String	8	False	Code agence par défaut (Lecture seule)
Telephone1	String	9	False	Téléphone 1
Telephone2	String	10	False	Téléphone 2
Telephone3	String	11	False	Téléphone 3
Fax	String	12	False	Fax
Lang	String	13	False	Langue
WebProfileList	List`1 - UserWebProfile	14	False	Liste des profils de droit du donneur d'ordre
CustomerWebAccount	List`1 - String	15	False	Liste des comptes clients rattachés au donneur d'ordre utilisable sur Dispatch Web
DefaultAddress	Address	16	False	Adresse par défaut du donneur d'ordre
EurekaMapsAccess	Boolean	17	False	Le donneur d'ordre est autorisé à afficher une carte (lecture seule)
SpecialServicesLinkedList	List`1 - Service	18	False	Prestations associées spécialement au donneur d'ordre en plus de celles déjà associées au client
OrderingPartiesDependentOfApproval	List`1 - ApprobationOrderer	19	False	Liste des donneurs d'ordres dépendants de l'approbation du donneur d'ordre actuel
OrderingPartiesApprovers	List`1 - ApprobationOrderer	20	False	Liste des donneurs d'ordres auquel le donneur d'ordre actuel est soumis à l'approbation
ApprovalOnRequest	Boolean	21	False	Défini la possibilité pour le donneur d'ordre de demander une approbation lors de la saisie d'un ordre de mission
IsApprover	Boolean	22	False	Défini la possibilité pour le donneur d'ordre d'être approbateur
IsUnderApproval	Boolean	23	False	Défini la possibilité pour le donneur d'ordre d'être soumis à l'approbation
BeingTheDelegateOf	List`1 - DelegatorOrderer	24	False	Liste des donneurs d'ordres délégateurs du donneur d'ordre actuel
GiveTheDelegationTo	List`1 - DelegateOrderer	25	False	Liste des donneurs d'ordres délégués du donneur d'ordre actuel
IsBeingDelegate	Boolean	26	False	Défini si le donneur d'ordre est délégué d'un autre donneur d'ordre
HasGivenDelegation	Boolean	27	False	Défini si le donneur d'ordre est délégateur d'un autre donneur d'ordre
IsPublic	Boolean	28	False	Défini si le donneur d'ordre est utilisé en tant que donneur d'ordre public
IsECommerce	Boolean	29	False	Défini si le donneur d'ordre est lié à un client e-commerce

{
  "Code": null,
  "Name": null,
  "Login": null,
  "Password": null,
  "Email": null,
  "Reference1": null,
  "Reference2": null,
  "Reference3": null,
  "DefaultAgencyCode": null,
  "Telephone1": null,
  "Telephone2": null,
  "Telephone3": null,
  "Fax": null,
  "Lang": null,
  "WebProfileList": null,
  "CustomerWebAccount": null,
  "DefaultAddress": null,
  "EurekaMapsAccess": false,
  "SpecialServicesLinkedList": null,
  "OrderingPartiesDependentOfApproval": null,
  "OrderingPartiesApprovers": null,
  "ApprovalOnRequest": false,
  "IsApprover": false,
  "IsUnderApproval": false,
  "BeingTheDelegateOf": null,
  "GiveTheDelegationTo": null,
  "IsBeingDelegate": false,
  "HasGivenDelegation": false,
  "IsPublic": false,
  "IsECommerce": false
}

POI

Point d'intéret cartographique

Propriété	Type	Ordre	Obligatoire	Description
Identifier	String	0	True	Identifiant de la POI dans une famille de POI
Latitude	Double	1	True	Latitude de la POI
Longitude	Double	2	True	Longitude de la POI
AddressId	Int32 nullable	3	True	Identifiant de l'adresse de la POI

{
  "Identifier": null,
  "Latitude": 0.0,
  "Longitude": 0.0,
  "AddressId": null
}

POIFamily

Famille de point d'interet

Propriété	Type	Ordre	Obligatoire	Description
FamilyId	Int32	0	True	Identifiant de la famille de POI
Name	String	1	True	Nom de la famille de POI
HasCustomIcon	Boolean	2	False	Une icone spécifique peut $etre téléchargée via la méthode Json/DownloadPOIFamilyIcon
POIList	List`1 - POI	3	False	POI rattachées à la famille

{
  "FamilyId": 0,
  "Name": null,
  "HasCustomIcon": false,
  "POIList": null
}

Package

Colis

Propriété	Type	Ordre	Obligatoire	Description
Name	String	0	True	Nature de colis
NumberOfPackage	Int32	1	True	Nombre de colis avec la même nature
PackageWeight	Double	2	False	Poids du colis par défaut en KG, sinon unité renseigné dans PackageWeightUnit
PackageWeightUnit	String	2	False	Unité du poids du colis
Reference	String	3	False	(Obsolete, ne plus utiliser) Référence du colis
Barcode	String	4	False	Code barre du colis
Length	Double	5	False	Longueur en unité par défaut de Dispatch
Width	Double	6	False	Largeur en unité par défaut de Dispatch
Height	Double	7	False	Longueur en unité par défaut de Dispatch
PackageCode	String	8	False	Code colis
PackageFamilly	String	9	False	Famille de colis
InternalPackageId	Int32	10	False	Id colis créé par Dispatch, 0 pour un nouveau colis
CurrentTrackingCode	String	11	False	Code de tracking courant du colis (lecture seule)
PackageNatureId	Int32 nullable	12	False	Clé d'identification d'une nature de colis (lecture seule)
PackageTotalWeight	Double	13	False	Poids total du colis par défaut en KG, sinon poids unitaire renseigné dans PackageWeightUnit
PackageUnitsByQuantity	List`1 - UnitQuantity	14	False	Quantité par unité, si null alors l'API remplira cette liste avec une unité KG et la valeur du poids
MeasurementUnit	String	15	False	Unité de mesure des dimensions de la nature de colis
PackageReferences	List`1 - PackageReference	16	False	Liste des références associées au colis, optionnelle
IsAtLeastOnePackageReferenceMandatory	Boolean	17	False	Indique si, parmi les références colis obligatoires, au moins une est nécessaire

{
  "Name": null,
  "NumberOfPackage": 0,
  "PackageWeight": 0.0,
  "PackageWeightUnit": null,
  "Reference": null,
  "Barcode": null,
  "Length": 0.0,
  "Width": 0.0,
  "Height": 0.0,
  "PackageCode": null,
  "PackageFamilly": null,
  "InternalPackageId": 0,
  "CurrentTrackingCode": null,
  "PackageNatureId": null,
  "PackageTotalWeight": 0.0,
  "PackageUnitsByQuantity": null,
  "MeasurementUnit": null,
  "PackageReferences": null,
  "IsAtLeastOnePackageReferenceMandatory": false
}

PackageEvent

Evenement d'historique d'information colis

Propriété	Type	Ordre	Obligatoire	Description
Date	DateTime	0	False	Date de l'événement (Format WCF)
EventCode	String	1	False	Code de l'événement
EventDetail	String	2	False	Détail de l'événement
Comment	String	3	False	Commentaire de l'événement
LocalDate	Date	4	False	Date de l'événement (Format API)

{
  "EventCode": null,
  "EventDetail": null,
  "Comment": null,
  "LocalDate": {
    "Value": null,
    "StringFullDate": null,
    "StringDate": null,
    "StringHour": null,
    "JsonDateTime": null,
    "UnixTimeSpan": null,
    "IsDateWithoutHour": false
  }
}

PackageFamily

Famille de Colis exemple : pli, palette, ...

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	True	Code famille
Label	String	1	True	Libellé famille
AllowPackageFamilyAccumulation	Boolean	2	True	Indique si les colis de cette famille peuvent être transporté en même temps que d'autre familel de colis

{
  "Code": null,
  "Label": null,
  "AllowPackageFamilyAccumulation": false
}

PackageReference

Référence d'un colis

Propriété	Type	Ordre	Obligatoire	Description
Value	String	0	True	Valeur de la référence colis
Index	Int32	1	True	Index de la référence colis
Label	String	2	True	Label de la référence colis, dépendant de la nature colis et de l'index de la référence (lecture seule)
IsMandatory	Boolean	3	True	Défini la nécessité de renseigner une valeur pour cette référence
IsWebVisible	Boolean	4	True	Défini la possibilité de visualiser la référence de nature colis sur DispatchWeb
IsValueChoiceForced	Boolean	5	False	Défini si la valeur de la référence doit être sélectionnée depuis la liste des valeurs paramétrée (obligatoire)
ValuesCount	Int32	6	False	Nombre de valeurs disponibles dans la liste de valeurs (obligatoire)

{
  "Value": null,
  "Index": 0,
  "Label": null,
  "IsMandatory": false,
  "IsWebVisible": false,
  "IsValueChoiceForced": false,
  "ValuesCount": 0
}

Packing

Ligne de colis

Propriété	Type	Ordre	Obligatoire	Description
PackageCode	String	0	False	Code du colis
Name	String	1	False	Nom du colis
Barcode	String	2	False	CodeBarre du colis
NumberOfPackage	Int32 nullable	3	False	Nombre de colis
Dimensions	PackingDimension	4	False	Dimensions du colis
PackageReferences	List`1 - ActionReference	5	False	Liste des références à mettre à jour
UnitsByQuantity	List`1 - ActionTotalBulkSize	6	False	Liste des quantité par unité à mettre à jour

{
  "PackageCode": null,
  "Name": null,
  "Barcode": null,
  "NumberOfPackage": null,
  "Dimensions": null,
  "PackageReferences": null,
  "UnitsByQuantity": null
}

PackingDimension

Dimension d'un colis à mettre à jour

Propriété	Type	Ordre	Obligatoire	Description
Length	Double	0	False	Définit la longueur du colis
Width	Double	1	False	Définit la largeur du colis
Height	Double	2	False	Définit la hauteur du colis

{
  "Length": 0.0,
  "Width": 0.0,
  "Height": 0.0
}

PackingReferenceValue

Valeur d'une référence de nature colis

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Id de la valeur
Label	String	1	False	Label de valeur

{
  "Id": 0,
  "Label": null
}

Pagination

Résultat de la pagination

Propriété	Type	Ordre	Obligatoire	Description
PrevLink	String	0	False	Lien vers la page précédente
NextLink	String	1	False	Lien vers la page suivante
PageCount	Int32	2	False	Nombre de pages
TotalItemCount	Int32	3	False	Nombre total d'éléments
PageNumber	Int32	4	False	Numéro de page (commence à 1)
PageSize	Int32	5	False	Nombre d'éléments par page
HasPreviousPage	Boolean	6	False	Une page précédente est disponible
HasNextPage	Boolean	7	False	Une page suivante est disponible
IsFirstPage	Boolean	8	False	La page récupérée est la première page
IsLastPage	Boolean	9	False	La page récupérée est la dernière page
FirstItemOnPage	Int32	10	False	Index du premier élément de la page
LastItemOnPage	Int32	11	False	Index du dernier élément de la page

{
  "PrevLink": null,
  "NextLink": null,
  "PageCount": 0,
  "TotalItemCount": 0,
  "PageNumber": 0,
  "PageSize": 0,
  "HasPreviousPage": false,
  "HasNextPage": false,
  "IsFirstPage": false,
  "IsLastPage": false,
  "FirstItemOnPage": 0,
  "LastItemOnPage": 0
}

Payment

Règlement d'une facture

Propriété	Type	Ordre	Obligatoire	Description
InternalId	Int32	0	True	Identifiant interne d'un règlement
Label	String	1	False	Libellé d'un règlement
UtcDate	DateTime	2	True	Date de réception d'un règlement
DividedAmount	Decimal	3	True	Montant réparti sur la facture associée au règlement
BankTransactionNumber	String	4	False	Numéro de transaction banquaire

{
  "DividedAmount": 0.0
}

PaymentTerm

Moyen de paiement

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Identifiant du moyen de paiement
Label	String	1	False	Libellé du moyen de paiement

{
  "Id": 0,
  "Label": null
}

PointOfInterestDetails

Détails d'un Point d'intéret

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Identifiant unique de la POI
Name	String	1	False	Nom associé à la POI
Country	String	2	False	Pays de la POI
City	String	3	False	Ville de la POI
PostalCode	String	4	False	Code postal de la POI
StreetNumber	String	5	False	Numéro de la rue de la POI
Street	String	6	False	Rue de la POI
FamilyId	Int32	7	False	identifiant de la Famille de la POI
CityId	Int32	8	False	Identifiant de la ville
Latitude	Double nullable	9	False	Latitude du POI
Longitude	Double nullable	10	False	Longitude du POI
GeoCoding	Int32	11	False	Niveau de géo codage
AddressId	Int32	12	False	Identifiant de l'addresse
FamilyIdToUpdate	Int32	13	False	Nouveau identifiant de la famille de cette poi
AddressNormalized	Boolean	14	False	Addresse normalisée par dispatch

{
  "Id": 0,
  "Name": null,
  "Country": null,
  "City": null,
  "PostalCode": null,
  "StreetNumber": null,
  "Street": null,
  "FamilyId": 0,
  "CityId": 0,
  "Latitude": null,
  "Longitude": null,
  "GeoCoding": 0,
  "AddressId": 0,
  "FamilyIdToUpdate": 0,
  "AddressNormalized": false
}

ProofOfDelivery

Preuves d'enlèvement / livraison Dispatch : Photo, document scanné, pdf

Propriété	Type	Ordre	Obligatoire	Description
CodeCategorie	String	0	False	Code catégorie du fichier
LibelleCategorie	String	1	False	Libellé de la catégorie du fichier
LibelleFichier	String	2	False	Nom original du fichier
DocName	String	3	False	Nom du document (avec l'extention)
DocID	Int32	4	False	Id interne du document

{
  "CodeCategorie": null,
  "LibelleCategorie": null,
  "LibelleFichier": null,
  "DocName": null,
  "DocID": 0
}

QuotationApprovalError

Type de l'erreur remontée par l'approbation de mission

Nom	Valeur
None	0
UnexpectedError	1
PickupDateExpired	2
DeliveryDateExpired	3
ServiceIsNotAllowedForSelectedPickupDate	4
UnableToSave	5
UnableToLoadQuotation	6
MissionApprovalIsImpossibleOnAnArchivedQuotation	7
ZeroPricedMissionEntryNotAllowed	8
DurationLessMissionEntryNotAllowed	9
QuotationApprovalUnauthorized	10
BadLoginPassword	11
InternalErrorProcessingServiceFiles	12
MissingServiceFiles	13

QuoteValidationError

Type de l'erreur remontée par la validation de devis

Nom	Valeur
None	0
UnexpectedError	1
PickupDateExpired	2
DeliveryDateExpired	3
ServiceIsNotAllowedForSelectedPickupDate	4
UnableToSave	5
UnableToLoadQuotation	6
QuoteValidationIsImpossibleOnAnArchivedQuotation	7
ZeroPricedMissionEntryNotAllowed	8
DurationLessMissionEntryNotAllowed	9
QuoteValidationUnauthorized	10
BadLoginPassword	11
InternalErrorProcessingServiceFiles	12
MissingServiceFiles	13

Reference

Référence d'ordre de mission Dispatch présent dans les champs reference 1,2,3 de Shipment

Propriété	Type	Ordre	Obligatoire	Description
IdReference	Int32 nullable	0	False	Id unique d'une référence unique enregistré dans Dispatch
Type	Int32	1	True	Type de la référence 1,2,3
Label	String	2	True	Libellé de la référence

{
  "IdReference": null,
  "Type": 0,
  "Label": null
}

RegularOrdersGroup

Représente les informations principales d'un groupe d'ordres réguliers

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Identifiant
Code	String	1	False	Code
Libelle	String	2	False	Libelle
IsDefaultGroup	Boolean	3	False	Is default group

{
  "Id": 0,
  "Code": null,
  "Libelle": null,
  "IsDefaultGroup": false
}

RegularTransport

Ordre régulier

Propriété	Type	Ordre	Obligatoire	Description
Identity	RegularTransportIdentity	0	False	Identifiants de l'ordre régulier
Details	RegularTransportDetails	1	False	Détails de l'ordre régulier

{
  "Identity": null,
  "Details": null
}

RegularTransportDetails

Détails sur l'ordre régulier

Propriété	Type	Ordre	Obligatoire	Description
ExecutionDays	RegularTransportExecutionDays	0	False	Jours d'exécution de l'ordre régulier

{
  "ExecutionDays": null
}

RegularTransportExecutionDays

Jours d'exécution d'un ordre régulier

Propriété	Type	Ordre	Obligatoire	Description
EnabledOnMonday	Boolean	0	False	Exécuté le lundi
EnabledOnTuesday	Boolean	1	False	Exécuté le mardi
EnabledOnWednesday	Boolean	2	False	Exécuté le mercredi
EnabledOnThursday	Boolean	3	False	Exécuté le jeudi
EnabledOnFriday	Boolean	4	False	Exécuté le vendredi
EnabledOnSaturday	Boolean	5	False	Exécuté le samedi
EnabledOnSunday	Boolean	6	False	Exécuté le dimanche
EnabledOnBankHolidays	Boolean	7	False	Exécuté les jours fériés
IsWeeklyExecuted	Boolean	8	False	Exécuté toutes les semaines

{
  "EnabledOnMonday": false,
  "EnabledOnTuesday": false,
  "EnabledOnWednesday": false,
  "EnabledOnThursday": false,
  "EnabledOnFriday": false,
  "EnabledOnSaturday": false,
  "EnabledOnSunday": false,
  "EnabledOnBankHolidays": false,
  "IsWeeklyExecuted": false
}

RegularTransportIdentity

Identifiants d'un ordre régulier

Propriété	Type	Ordre	Obligatoire	Description
RegularTransportId	Int32	0	False	Identifiant unique de l'ordre régulier
RegularTransportCode	String	1	False	Code unique de l'ordre régulier
RegularTransportLabel	String	2	False	Libellé de l'ordre régulier

{
  "RegularTransportId": 0,
  "RegularTransportCode": null,
  "RegularTransportLabel": null
}

RejectedService

Prestation accessible au donneur d'ordre mais rejettée par le comparateur de tarif car elle ne respecte pas les règles métiers

Propriété	Type	Ordre	Obligatoire	Description
ServiceCode	String	0	False	Code de la prestation
ServiceLabel	String	1	False	Libellé de la prestation
RejectedReason	String	2	False	Raison du rejet
FamilyServiceCode	String	3	False	Code de la famille de prestation
FamilyServiceLabel	String	4	False	Libellé de la famille de prestation
RejectedType	ERejectedType	5	False	Type de rejet de la prestation

{
  "ServiceCode": null,
  "ServiceLabel": null,
  "RejectedReason": null,
  "FamilyServiceCode": null,
  "FamilyServiceLabel": null,
  "RejectedType": 0
}

ReportModel

Model de report

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32 nullable	0	False	Id unique d'un model de report
Label	String	1	True	Nom du model de report
ModelPath	String	2	True	Chemin du model de report

{
  "Id": null,
  "Label": null,
  "ModelPath": null
}

ReportPaperOptions

Options papier utilisées pour la requête d'initialisation de génération de documents de transport

Propriété	Type	Ordre	Obligatoire	Description
SizeType	Int32 nullable	0	False	Type de papier à utiliser, les valeurs possibles sont décrites dans l'énumération EPaperSizeType
Orientation	Int32 nullable	1	False	Orientation de la page, les valeurs possibles sont décrites dans l'énumération EPaperOrientation
BottomMargin	Int32 nullable	2	False	Marge de bas de la page, en millième de pouce (1000 = 1 pouce ~= 2.5cm)
LeftMargin	Int32 nullable	3	False	Marge de gauche de la page, en millième de pouce (1000 = 1 pouce ~= 2.5cm)
TopMargin	Int32 nullable	4	False	Marge de haut de la page, en millième de pouce (1000 = 1 pouce ~= 2.5cm)
RightMargin	Int32 nullable	5	False	Marge de droite de la page, en millième de pouce (1000 = 1 pouce ~= 2.5cm)

{
  "SizeType": null,
  "Orientation": null,
  "BottomMargin": null,
  "LeftMargin": null,
  "TopMargin": null,
  "RightMargin": null
}

RouteStep

Etape d'une trace chauffeur

Propriété	Type	Ordre	Obligatoire	Description
Step	Int32	0	True	Numéro de l'étape
StopUtcDate	Date	1	False	Date de l'arret de l'étape
GoUtcDate	Date	2	False	Date de départ de l'étape
Address	String	3	False	Adresse d'arret
StepKm	Double nullable	4	False	Kilométrage depuis le point de départ pour le calcul en cours
WaitingDurationInSec	Int32	5	False	Temps d'arret sur l'étape en seconde
DrivingDurationInSec	Int32	6	False	Temps de roulage sur l'étape en seconde
Latitude	Double	7	False	Latitude d'arret de l'étape
Longitude	Double	8	False	Longitude d'arret de l'étape

{
  "Step": 0,
  "StopUtcDate": null,
  "GoUtcDate": null,
  "Address": null,
  "StepKm": null,
  "WaitingDurationInSec": 0,
  "DrivingDurationInSec": 0,
  "Latitude": 0.0,
  "Longitude": 0.0
}

SatisfactionSurvey

champs d'une enquête de satisfaction

Propriété	Type	Ordre	Obligatoire	Description
ConfigName	String	0	False	Nom du questionaire
Id	Int32	1	True	Id question
Response	String	2	True	Réponse
FieldType	CustomFieldType	3	False	Type de la réponse attendue
Question	String	4	False	Question
Mandatory	Boolean	5	False	Champs obligatoire ?
DefaultResponse	String	6	False	Réponse par défaut
ForcePreRegistredValues	Boolean	7	False	Forcer l'utilisation des valeurs pré-enregistrées
PreRegistredValues	List`1 - SatisfactionSurveyPreRegistredValue	8	False	Valeurs pré-enregistrées
ReadOnly	Boolean	9	False	Lecture seule
Code	String	10	False	Code champs

{
  "ConfigName": null,
  "Id": 0,
  "Response": null,
  "FieldType": 0,
  "Question": null,
  "Mandatory": false,
  "DefaultResponse": null,
  "ForcePreRegistredValues": false,
  "PreRegistredValues": null,
  "ReadOnly": false,
  "Code": null
}

SatisfactionSurveyPreRegistredValue

champs d'une réponse de l'enquête de satisfaction

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	True	Identifiant
Value	String	1	False	Valeur
Comment	String	2	False	Commentaire

{
  "Id": 0,
  "Value": null,
  "Comment": null
}

Search

Critère de recherche de mission Dispatch

Propriété	Type	Ordre	Obligatoire	Description
FromDate	DateTime	0	False	A partir de la date (si aucune date n'est passée la recherche se fait sur les 3 derniers mois)
ToDate	DateTime	1	False	Jusqu'à la date
TrackIdList	List`1 - String	2	False	Liste des trackid
IdList	List`1 - Int32	3	False	Liste de numéro de mission
ClientList	List`1 - String	4	False	Liste de code client
ServiceCodeList	List`1 - String	5	False	Liste de code prestation
LoginList	List`1 - String	6	False	(Obsolète) Liste de login donneur d'ordre
StatusList	List`1 - Status	7	False	Liste d'état d'avancement de mission
Reference1	String	8	False	Référence 1
Reference2	String	9	False	Référence 2
Reference3	String	10	False	Référence 3
ReceiptNumberList	List`1 - String	11	False	Liste des récépissés
FromPostalCodeList	List`1 - String	12	False	Liste de code postaux d'adresse d'enlèvement
FromCityList	List`1 - String	13	False	Liste de libellés de ville d'adresse d'enlèvement
FromCityIdList	List`1 - Int32	47	False	Liste des ids de ville d'adresse d'enlèvement (API version >= 52)
ToPostalCodeList	List`1 - String	14	False	Liste de code postaux d'adresse de livraison
ToCityList	List`1 - String	15	False	Liste de libellés de ville d'adresse de livraison
ToCityIdList	List`1 - Int32	48	False	Liste des ids de ville d'adresse de livraison (API version >= 52)
Quote	Boolean	16	False	Rechercher uniquement des devis
ParcelCodes	List`1 - String	17	False	Code colis interne Dispatch
BarCodes	List`1 - String	18	False	Pas de description
ParcelTypes	List`1 - String	19	False	Nature de colis
OrdererCodes	List`1 - String	20	False	Code donneur d'ordre
BaseDate	List`1 - BaseActionDate	21	False	Pas de description
PickUpName	String	22	False	Nom d'enlèvement
DeliveryName	String	23	False	Nom de livraison
HasAttachements	Boolean nullable	24	False	Uniquement Avec/ou sans pièce jointe, si null prends tous les ordres
ShowWebMissions	Boolean nullable	25	False	Uniquement les missions saisies via le web(DispatchWeb, API, Web services)
ValidateQuote	Boolean	26	False	Recherche également les devis archivé : transformé en course
HasProofOfDelivery	Boolean nullable	27	False	Uniquement Avec/ou sans preuve de livraison, si null prends tous les ordres
Reference1List	List`1 - String	28	False	Liste de référence 1
Reference2List	List`1 - String	29	False	Liste de référence 2
Reference3List	List`1 - String	30	False	Liste de référence 3
OrdererNames	List`1 - String	31	False	Nom/libellé donneur d'ordre
FromCountryList	List`1 - String	32	False	Liste de code pays d'adresse d'enlèvement
ToCountryList	List`1 - String	33	False	Liste de code pays d'adresse de livraison
PackageReference1	String	34	False	Référence colis numéro 1
PackageReference2	String	35	False	Référence colis numéro 2
PackageReference3	String	36	False	Référence colis numéro 3
PackageReference4	String	37	False	Référence colis numéro 4
QuoteIsApprobation	Boolean	38	False	Rechercher uniquement les devis en demande d'approbation (dépendant du paramètre Quote)
CircuitAddressesSet	String	39	False	Code du puit associé à l'ordre
BillNumber	String	40	False	Numéro de facture
PackageReference5	String	41	False	Référence colis numéro 5
AirWaybillNumber	String	42	False	Numéro de lta de lettre de transport aérien
PackageReference6	String	43	False	Référence colis numéro 6
PackageReference7	String	44	False	Référence colis numéro 7
PackageReference8	String	45	False	Référence colis numéro 8
ServiceCodeListToHide	List`1 - String	46	False	Liste de code prestation à ne pas afficher

{}

SearchRestrictionSettings

Paramètres de restriction pour la recherche de missions

Propriété	Type	Ordre	Obligatoire	Description
ContainsResearchMinCharacters	Int32	0	True	Nombre minimum de caractères non-spéciaux requis dans un champ pour effectuer une recherche en mode 'contient'
ContainsResearchMaxDays	Int32	1	True	Nombre maximum de jours autorisé depuis lesquel une recherche en mode 'contient' peut être effectuée

{
  "ContainsResearchMinCharacters": 0,
  "ContainsResearchMaxDays": 0
}

Service

Prestation Dispatch permet de définir un tarif et de décrire le type de transport

Propriété	Type	Ordre	Obligatoire	Description
FamilyServiceCode	String	0	False	Code de la famille de prestation
FamilyServiceLabel	String	1	False	Libellé de la famille de prestation
CustomerCode	String	2	False	Code client associé à la prestion, indique que la prestation est spécifique à ce client
ServiceCode	String	3	False	Code de la prestation
OpenHour	DateTime	4	False	Heure d'ouverture de la prestation
CloseHour	DateTime	5	False	Heure de la fermeture de la prestation
Index	Int32	6	False	Index d'apparition de la prestation si elle est retournée par liste
Label	String	7	False	Libellé de la prestation
Price	Double	8	False	Prix HT de la prestation
Comment	String	9	False	Commentaire descritpif
BackgroundColor	String	10	False	Couleur de fond Code couleur sous forme d'entier
ForegroundColor	String	11	False	Couleur de la police Code couleur sous forme d'entier
BeginPickupEstimatedDatetime	DateTime nullable	12	False	Heure de début d'enlèvement estimée
EndPickupEstimatedDatetime	DateTime nullable	13	False	Heure de fin d'enlèvement estimée
BeginDeliveryEstimatedDatetime	DateTime nullable	14	False	Heure de début de livraison estimée
EndDeliveryEstimatedDatetime	DateTime nullable	15	False	Heure de fin de livraison estimée
ActiveOnMonday	Boolean	16	False	Prestation accessible le lundi
ActiveOnTuesday	Boolean	17	False	Prestation accessible le mardi
ActiveOnWednesday	Boolean	18	False	Prestation accessible le mercredi
ActiveOnThursday	Boolean	19	False	Prestation accessible le jeudi
ActiveOnFriday	Boolean	20	False	Prestation accessible le vendredi
ActiveOnSaturday	Boolean	21	False	Prestation accessible le samedi
ActiveOnSunday	Boolean	22	False	Prestation accessible le dimanche
ActiveOnHoliday	Boolean	23	False	Prestation accessible les jours fériés
PriceWithoutTaxes	Decimal	24	False	Prix TTC
GasEmission	Decimal	25	False	Emission de CO2
CustomParametersConfigName	String	26	False	Nom de la configuration de paramètres personnalisés associée à la prestation
QuoteMandatory	Boolean	27	False	La sélection de cette prestation déclenchera obligatoirement la sauvegarde d'un devis
IsFileNeeded	Boolean	28	False	La sélection de cette prestation nécessite l'ajout d'au moins un fichier joint à la mission par catégorie définie dans la propriété FilesCategoriesCodes
FilesCategories	List`1 - FileCategory	29	False	Codes des catégories de fichiers à joindre lors de la sélection de ce tarif si la propriété FileMandatory est renseignée

{
  "FamilyServiceCode": null,
  "FamilyServiceLabel": null,
  "CustomerCode": null,
  "ServiceCode": null,
  "OpenHour": "\/Date(-62135596800000)\/",
  "Index": 0,
  "Label": null,
  "Price": 0.0,
  "Comment": null,
  "BackgroundColor": null,
  "ForegroundColor": null,
  "BeginPickupEstimatedDatetime": null,
  "EndPickupEstimatedDatetime": null,
  "BeginDeliveryEstimatedDatetime": null,
  "EndDeliveryEstimatedDatetime": null,
  "ActiveOnMonday": false,
  "ActiveOnTuesday": false,
  "ActiveOnWednesday": false,
  "ActiveOnThursday": false,
  "ActiveOnFriday": false,
  "ActiveOnSaturday": false,
  "ActiveOnSunday": false,
  "ActiveOnHoliday": false,
  "PriceWithoutTaxes": 0.0,
  "GasEmission": 0.0,
  "CustomParametersConfigName": null,
  "QuoteMandatory": false,
  "IsFileNeeded": false,
  "FilesCategories": null
}

ServiceFamilly

Famille de prestation, permet de catégoriser les prestations

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code de la famille de prestation
Label	String	1	False	Libellé de la famille de prestation
Description	String	2	False	Description de la famille de prestation

{
  "Code": null,
  "Label": null,
  "Description": null
}

ServicePrice

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
FamilyServiceCode	String	0	False	Code de la catégorie de service
FamilyServiceLabel	String	1	False	Libellé de la catégorie de service
CustomerCode	String	2	False	Code client pour lequel le prix a été calculé
ServiceCode	String	3	False	Code du service proposé
OpenHour	DateTime	4	False	Heure d'ouverture du service
CloseHour	DateTime	5	False	Heure de fermeture du service
Index	Int32	6	False	Ordre d'affichage du service
Label	String	7	False	Libellé du service
Price	Double	8	False	Prix TTC
Comment	String	9	False	Descriptif additionel
BackgroundColor	String	10	False	Couleur de fond en hexadecimal de la prestation dans Dispatch (usage interne)
ForegroundColor	String	11	False	Couleur de la police en hexadecimal de la prestation dans Dispatch (usage interne)
PriceWithoutTaxes	Decimal	12	False	Prix hors taxe
GasEmission	Decimal	13	False	Emission de CO2
PickupEstimatedDateBegin	Date	14	False	Date heure d'enlèvement calculée
PickupEstimatedDateEnd	Date	15	False	Date heure de fin enlèvement calculé, si null alors la date d'enlèvement est PickupEstimatedDateBegin
DeliveryEstimatedDateBegin	Date	16	False	Date heure de livraison calculée
DeliveryEstimatedDateEnd	Date	17	False	Date heure de fin enlèvement calculée, si null alors la date de livraison est DeliveryEstimatedDateBegin
PriceWithoutVAT	Decimal	18	False	Montant total hors TVA, inclus la surcharge carburant
OilChargePrice	Decimal	19	False	Montant de la surcharge carburant
EcoTaxePrice	Decimal	20	False	Montant de l'éco taxe (obsolete)
CurrencyCode	String	21	False	Code devise
SubServices	List`1 - SubService	22	False	Liste des sous prestations associées à la prestation
ServiceIncludeReturn	Boolean	23	False	La prestation inclus l'aller et le retour
UserCanSetAReturn	Boolean	24	False	L'utilisateur peut choisir un retour sur cette prestation
CustomFields	List`1 - CustomField	25	False	Liste des paramètres personnalisés (EDI) associés à la prestation, non chargée par défaut
Distance	Double	25	False	Distance trouvée pour ce type de prestation (tient compte du véhicule utilisé)
HourDurationPart	Int32	26	False	Durée du transport partie heure
MinuteDurationPart	Int32	27	False	Durée du transport partie minute
QuoteMandatory	Boolean	28	False	La sélection de cette prestation déclenchera obligatoirement la sauvegarde d'un devis
PickupStartCondition	Int32	29	False	Condition horaire d'enlèvement estimée par le calcul de tarif valeurs possibles : 0 = avant, 1 = à, 2 = à partir de
DeliveryStartCondition	Int32	30	False	Condition horaire de livraison estimée par le calcul de tarif valeurs possibles : 0 = avant, 1 = à, 2 = à partir de
PickupIsWindows	Boolean	31	False	Le calcul de tarif a estimé que l'enlèvement se fera entre PickupEstimatedDateBegin et PickupEstimatedDateEnd
DeliveryIsWindow	Boolean	32	False	Le calcul de tarif a estimé que la livraison se fera entre DeliveryEstimatedDateBegin et DeliveryEstimatedDateEnd
IsFileNeeded	Boolean	33	False	La sélection de cette prestation nécessite l'ajout d'au moins un fichier joint à la mission par catégorie définie dans la propriété FilesCategoriesCodes
FilesCategories	List`1 - FileCategory	34	False	Codes des catégories de fichiers à joindre lors de la sélection de ce tarif si la propriété FileMandatory est renseignée

{
  "FamilyServiceCode": null,
  "FamilyServiceLabel": null,
  "CustomerCode": null,
  "ServiceCode": null,
  "Index": 0,
  "Label": null,
  "Price": 0.0,
  "Comment": null,
  "BackgroundColor": null,
  "ForegroundColor": null,
  "PriceWithoutTaxes": 0.0,
  "GasEmission": 0.0,
  "PickupEstimatedDateBegin": null,
  "PickupEstimatedDateEnd": null,
  "DeliveryEstimatedDateBegin": null,
  "DeliveryEstimatedDateEnd": null,
  "PriceWithoutVAT": 0.0,
  "OilChargePrice": 0.0,
  "EcoTaxePrice": 0.0,
  "CurrencyCode": null,
  "SubServices": null,
  "ServiceIncludeReturn": false,
  "UserCanSetAReturn": false,
  "CustomFields": null,
  "Distance": 0.0,
  "HourDurationPart": 0,
  "MinuteDurationPart": 0,
  "QuoteMandatory": false,
  "PickupStartCondition": 0,
  "DeliveryStartCondition": 0,
  "PickupIsWindows": false,
  "DeliveryIsWindow": false,
  "IsFileNeeded": false,
  "FilesCategories": null
}

Shipment

Représente une mission de transport

Propriété	Type	Ordre	Obligatoire	Description
TrackId	String	0	False	Numéro de tracking généré par Dispatch (lecture seule)
Id	Int32 nullable	1	False	Numéro de mission/devis Dispatch (lecture seule)
ClientCode	String	2	True	Code client Dispatch (Obligatoire)
CustomerHasEquivalence	Boolean	3	False	Le code client passé doit être transformé grâce à une équivalence
ClientDescription	String	4	False	Libellé du client (lecture seule)
BillAddress	Address	5	False	Adresse de facturation
FromAddress	Address	6	True	Adresse d'enlèvement
FromDate	DateTime	7	False	(Obsolète, remplacé par (PickupSchedules.ContractualStartDate) depuis Dispatch 2.4.4
ToAddress	Address	8	True	Adresse de livraison (Obligatoire)
ToDate	DateTime	9	False	(Obsolète, remplacé par (DeliverySchedules.ContractualStartDate) depuis Dispatch 2.4.4
Reference1	String	10	False	Champs Référence 1
Reference2	String	11	False	Champs Référence 2
Reference3	String	12	False	Champs Référence 3
ServiceCode	String	13	False	Code Prestation Dispatch
ServiceHasEquivalence	Boolean	14	False	Le code prestation doit être transformé en équivalence Dispatch
ShipmentIsRoundTrip	Boolean	15	False	La mission est à faire en aller/retour
Price	Double	16	False	Montant Hors TVA de la mission (Lecture seule) comprend la surcharge carburant, la remise client (lecture seule)
PriceWithTaxes	Double	17	False	Montant toutes taxes de la mission (Lecture seule)
Units	List`1 - String	18	False	Liste des unités de sous prestations liées à l'ordre (Lecture seule)
Packages	List`1 - Package	19	False	Colisage de la mission
ShipmentStatus	Status	20	False	Etat d'avancement de livraison de la mission (lecture seule)
ReceiptNumber	String	21	False	Récépissé (lecture seule)
ShipmentEventList	List`1 - ShipmentEvent	22	False	Historique des différents états de la mission (lecture seule)
Comment1	String	23	False	Champs commentaire 1
Comment2	String	24	False	Champs commentaire 2
Comment3	String	25	False	Champs commentaire 3
Comment4	String	26	False	Champs commentaire 4
Comment5	String	27	False	Champs commentaire 5
Comment6	String	28	False	Champs commentaire 6
Comment7	String	29	False	Champs commentaire 7
Comment8	String	30	False	Champs commentaire 8
TransactionID	String	31	False	Pas de description
ShipmentStatusCode	String	32	False	Code état Dispatch courant de la mission (Lecture seule)
ShipmentStatusLabel	String	33	False	Libellé état Dispatch courant de la mission (Lecture seule)
DriverCode	String	34	False	Code du chauffeur affecté à la mission (Lecture seule)
DriverName	String	35	False	Libellé du chauffeur affecté à la mission (Lecture seule)
QuoteId	Int32 nullable	36	False	Numéro de devis (Lecture seule)
InternalId	Int32 nullable	37	False	Numéro interne de l'ordre de mission champs ID_OT dans Dispatch (lecture seule)
CustomFieldList	List`1 - CustomerCustomField	38	False	OBSOLETE - Utiliser CustomerCustomFieldsList (obsolète depuis la 2.2.0.0)
CreationDate	DateTime nullable	39	False	Date de saisie de l'ordre (Lecture seule)
Notes	String	40	False	Champs notes (lecture seule)
PickupAnomaly	Anomaly	41	False	Anomalie à l'enlèvement (Lecture seule)
DeliveryAnomaly	Anomaly	42	False	Anomalie à la livraison (Lecture seule)
CustomCommentFields	Nullable`1[]	43	False	Liste des champs commentaires 1 à 8 visibles pour la mission (Mode général)
FromArrivalDate	DateTime nullable	44	False	Obsolète : remplacé par PickupSchedules.OnSiteDate depuis Dispatch 2.4.4
ToArrivalDate	DateTime nullable	45	False	Obsolète : remplacé par DeliverySchedules.OnSiteDate depuis Dispatch 2.4.4
ServiceAllowsMapTracking	Boolean	46	False	La mission peut être affichée sur une carte (lecture seule)
ServiceLabel	String	47	False	Libellé de la prestation (lecture seule)
Reference1Label	String	48	False	Libellé de la référence13 (lecture seule)
Reference2Label	String	49	False	Libellé de la référence 2 (lecture seule)
Reference3Label	String	50	False	Libellé de la référence 3 (lecture seule)
Dispute	Dispute	51	False	Litige associé à la mission (lecture seule)
ServiceRequiredRDV	Boolean	52	False	La prestation nécessite un rendez vous (lecture seule)
RDVHasBeenTaken	Boolean	53	False	Indique si un rendez vous a été pris (lecture seule)
DistributionMode	Boolean nullable	54	False	Indique le mode de distribution utilisé null indique que la course n'est pas en distribution false indique que l'on est en enlèvement true indique que l'on est en livraison (lecture seule)
LocalFromDate	Date	55	False	Obsolète remplacé par PickupSchedules.ContractualStartDate depuis Dispatch 2.4.4
LocalToDate	Date	56	False	Obsolète remplacé par DeliverySchedules.ContractualStartDate depuis Dispatch 2.4.4
FromDateCondition	Int32 nullable	57	False	Obsolète remplacé par PickupSchedules.ContractualStartDateCondition depuis Dispatch 2.4.4
ToDateCondition	Int32 nullable	58	False	Obsolète remplacé par DeliverySchedules.ContractualStartDateCondition depuis Dispatch 2.4.4
FromEndDate	Date	59	False	Obsolète remplacé par PickupSchedules.ContractualEndDate depuis Dispatch 2.4.4
ToEndDate	Date	60	False	Obsolète remplacé par DeliverySchedules.ContractualEndDate depuis Dispatch 2.4.4
HasDeliveryTimeSlot	Boolean	61	False	Obsolète remplacé par DeliverySchedules.IsWindow depuis Dispatch 2.4.4
TotalSizeByUnit	List`1 - UnitQuantity	62	False	Encombrement total par unité de colis
OrdererName	String	63	False	Nom du donneur d'ordre
OrdererCode	String	64	False	Code du donneur d'ordre
ServiceComment	String	65	False	Commentaire descriptif de la prestation (Lecture seule)
Index	Int32	66	False	Index de position de l'ordre dans le cas d'un ordre unique ou d'une fragmentation (Lecture seule)
GazEmission	Decimal	67	False	Emission CO2 en kg (Lecture seule)
HourDurationPart	Int32	68	False	Durée du transport partie heure (Lecture seule)
MinuteDurationPart	Int32	69	False	Durée du transport partie minute (Lecture seule)
PriceWithOilSurcharg	Double	70	False	Montant HT avec surcharge carburant (Lecture seule)
SubServices	List`1 - SubService	71	False	Sous prestations / options tarifaires
ServiceCustomFieldList	List`1 - CustomerCustomField	72	False	OBSOLETE - Utiliser ServiceCustomFieldsList (obsolète depuis la 2.2.0.0)
PickupAppointmentTimeSlot1	AppointmentTimeSlot	73	False	1er créneau d'enlèvement (lecture seule)
PickupAppointmentTimeSlot2	AppointmentTimeSlot	74	False	2ème créneau d'enlèvement (lecture seule)
DeliveryAppointmentTimeSlot1	AppointmentTimeSlot	75	False	1er créneau de livraison (lecture seule)
DeliveryAppointmentTimeSlot2	AppointmentTimeSlot	76	False	2ème créneau de livraison (lecture seule)
Distance	Double nullable	77	False	Distance estimée en km du transport, peut inclure une distance d'approche et de retour d'agence (lecture seule)
AlertOnShipmentProgress	AlertOnShipmentProgress	78	False	Recevoir des notifications par Email/SMS suivant l'état d'avancement d'une mission
SecretCode	String	79	False	Si le code secret est renseigné, la mission ne peut être livrée sur Dispatch mobile sans que celui-ci ne soit renseigné
HasCashOnDelivery	Boolean	80	False	Un contre remboursement est il présent?
CashOnDeliveryAmount	Double	81	False	Montant du contre remboursement
CashOnDeliveryAmountPaimentMode	Int32	82	False	Méthode de paiement du contre remboursement
CashOnDeliveryLabel	String	83	False	Libellé du contre remboursement
SubContractorTrakingUrl	String	84	False	Url de suivis du sous-traitant (Lecture seule)
SignAtPickup	String	85	False	Emargé à l'enlèvement (Lecture seule)
SignAtDelivery	String	86	False	Emargé à la livraison (Lecture seule)
OilSurcharge	Double	87	False	Coût de la surcharge carburant (Lecture seule)
EcoTaxe	Double	88	False	(Obsolète) Coût de l'éco taxe (Lecture seule)
CustomerCustomFieldsList	List`1 - CustomField	89	False	Paramètres personnalisés du client
ServiceCustomFieldsList	List`1 - CustomField	90	False	Paramètres personnalisés de la prestation
Billed	Boolean	91	False	La mission a été facturée, elle n'est plus modifiables, la fature peut être téléchargée via la méthode Bill(Lecture seule)
BillDownLoadId	String	92	False	Numéro de téléchargement de la facture Bill?TrackId={BillDownLoadId} (Lecture seule)
AgencyCode	String	93	False	Code agence de rattachement de la mission (lecture seule)
CurrencyCode	String	94	False	Code de la devise de la mission(lecture seule)
RegularOrderInfo	ShipmentRegularOrderInfo	95	False	Informations sur la tournée régulière ayant générée la mission, null si la mission ne vient pas d'une tournée régulière (lecture seule)
CashOnDeliveryLabelAmountPaimentMode	String	96	False	Libelle du mode de règlement du contre remboursement
EstimatedDatesByComputePrice	ShipmentEstimatedDateByComputePrice	97	False	Obsolète, remplacé par (PickupSchedules.Estimated* / DeliverySchedules.Estimated*
TemperaturesGraphicsUrl	String	98	False	Url d'affichage des courbes de température d'un transport. (lecture seule et dépend de la configuration du fournisseur d'alerte de température)
GuidTemporaryShipment	String	99	False	Guid temporaire d'un ordre de transport. (Utilisé pour l'ajout de fichier sur une mission non enregistrée)
BulkBreakingInformation	BulkBreaking	100	False	Informations sur la rupture de charge, cas d'un ordre fragmenté, null si l'ordre n'est pas fragmenté ou l'information n'est pas disponible (lecture seule)
SubcontractorTrackId	String	101	False	Numéro de tracking chez le sous traitant pour les missions D2D permettant de récupérer la photo du chauffeur (lecture seule)
IsQuoteUnderApproval	Boolean	102	False	La mission (=devis) est en attente d'approbation
AdvancedDateMode	Boolean	103	False	La mission utilise le mode avancé de définition des dates (API version > 46), si true alors les propriétés PickupSchedules et DeliverySchedules sont utilisées pour envoyer des données à Dispatch, les autres champs dates et conditions horaires sont ignorés
PickupSchedules	ShipmentSchedule	104	False	Horaires d'enlèvements (Contractuels, Estimés, Réalisés)
DeliverySchedules	ShipmentSchedule	105	False	Horaires de livraison (Contractuels, Estimés, Réalisés)
DelegateOrdererCode	String	106	False	Code du donneur d'ordre qui a saisi la mission
GeoDeviceAlertRevocations	List`1 - GeoDeviceAlertRevocation	107	False	Listes des suppressions d'alertes
TransportAirData	TransportAirData	108	False	Transport air data for LTA
BankData	TransportBankData	109	False	Données bancaires rattachées à l'ordre de transport (ne sert qu'en écriture)
HasBankData	Boolean	110	False	Indication sur la présence de données bancaire (ne sert qu'en lecture)
AdditionalEmailsOnQuoteCreation	List`1 - String	111	False	Liste des emails additionnels pour l'envoi du devis lors de son édition. Ces emails sont utilisés en complément de l'email du donneur d'ordre (si défini)
TrackingUrl	String	112	False	Shipment public tracking url
IsFinalizedQuote	Boolean	113	False	La mission (=devis) est finalisée

{
  "Id": null,
  "ClientCode": null,
  "CustomerHasEquivalence": false,
  "FromAddress": {
    "PostalCode": null,
    "City": null,
    "CityID": null,
    "Sector": null,
    "SaveToAdressBook": false,
    "CustomCommentFields": null
  },
  "ToAddress": {
    "PostalCode": null,
    "City": null,
    "CityID": null,
    "Sector": null,
    "SaveToAdressBook": false,
    "CustomCommentFields": null
  },
  "ServiceCode": null,
  "ServiceHasEquivalence": false,
  "ShipmentIsRoundTrip": false,
  "Price": 0.0,
  "PriceWithTaxes": 0.0,
  "ShipmentStatus": 0,
  "ShipmentEventList": [],
  "TransactionID": null,
  "ShipmentStatusCode": null,
  "ShipmentStatusLabel": null,
  "DriverCode": null,
  "DriverName": null,
  "QuoteId": null,
  "InternalId": null,
  "CustomFieldList": null,
  "CreationDate": null,
  "Notes": null,
  "PickupAnomaly": null,
  "DeliveryAnomaly": null,
  "CustomCommentFields": null,
  "FromArrivalDate": null,
  "ToArrivalDate": null,
  "ServiceAllowsMapTracking": false,
  "ServiceLabel": null,
  "Reference1Label": null,
  "Reference2Label": null,
  "Reference3Label": null,
  "Dispute": null,
  "ServiceRequiredRDV": false,
  "RDVHasBeenTaken": false,
  "DistributionMode": null,
  "LocalFromDate": {
    "Value": null,
    "StringFullDate": null,
    "StringDate": null,
    "StringHour": null,
    "JsonDateTime": null,
    "UnixTimeSpan": null,
    "IsDateWithoutHour": false
  },
  "LocalToDate": {
    "Value": null,
    "StringFullDate": null,
    "StringDate": null,
    "StringHour": null,
    "JsonDateTime": null,
    "UnixTimeSpan": null,
    "IsDateWithoutHour": false
  },
  "FromDateCondition": null,
  "ToDateCondition": null,
  "FromEndDate": null,
  "ToEndDate": null,
  "HasDeliveryTimeSlot": false,
  "TotalSizeByUnit": null,
  "OrdererName": null,
  "OrdererCode": null,
  "ServiceComment": null,
  "Index": 0,
  "GazEmission": 0.0,
  "HourDurationPart": 0,
  "MinuteDurationPart": 0,
  "PriceWithOilSurcharg": 0.0,
  "SubServices": null,
  "ServiceCustomFieldList": null,
  "PickupAppointmentTimeSlot1": null,
  "PickupAppointmentTimeSlot2": null,
  "DeliveryAppointmentTimeSlot1": null,
  "DeliveryAppointmentTimeSlot2": null,
  "Distance": null,
  "AlertOnShipmentProgress": {
    "AlertByEmail": false,
    "AlertBySMS": false,
    "AdditionalEmailAddress": [],
    "AdditionalPhoneNumber": [],
    "AlertOnShipmentConfirmation": false,
    "AlertOnPickup": false,
    "AlertOnDelivery": false
  },
  "SecretCode": null,
  "HasCashOnDelivery": false,
  "CashOnDeliveryAmount": 0.0,
  "CashOnDeliveryAmountPaimentMode": 0,
  "CashOnDeliveryLabel": null,
  "SubContractorTrakingUrl": null,
  "SignAtPickup": null,
  "SignAtDelivery": null,
  "OilSurcharge": 0.0,
  "EcoTaxe": 0.0,
  "CustomerCustomFieldsList": null,
  "ServiceCustomFieldsList": null,
  "Billed": false,
  "BillDownLoadId": null,
  "AgencyCode": null,
  "CurrencyCode": null,
  "RegularOrderInfo": null,
  "CashOnDeliveryLabelAmountPaimentMode": null,
  "EstimatedDatesByComputePrice": null,
  "TemperaturesGraphicsUrl": null,
  "GuidTemporaryShipment": "07568adf-d98c-4b1a-96c0-e6d7e2a0eef4",
  "BulkBreakingInformation": null,
  "IsQuoteUnderApproval": false,
  "AdvancedDateMode": false,
  "PickupSchedules": null,
  "DeliverySchedules": null,
  "DelegateOrdererCode": null,
  "AdditionalEmailsOnQuoteCreation": null,
  "TrackingUrl": null,
  "IsFinalizedQuote": false
}

ShipmentAddressInfo

Paramétrage d'un champs d'adresse (visibilité, champs obligatoire, libellé, ...)

Propriété	Type	Ordre	Obligatoire	Description
Visible	Boolean	0	False	Le champs est visible en saisie
Mandatory	Boolean	1	False	Le champs est obligatoire en saisie
Label	String	2	False	Libellé / placeholder décrivant le champs
TriggerGeocoding	Boolean	3	False	Une modification sur ce champs d'adresse doit déclencher une modification du géocodage

{
  "Visible": false,
  "Mandatory": false,
  "Label": null,
  "TriggerGeocoding": false
}

ShipmentCommentConfig

Paramétrage des champs commentaires de l'ordre

Propriété	Type	Ordre	Obligatoire	Description
Comment1	CommentVisibilityConfig	0	False	Champs commentaire 1
Comment2	CommentVisibilityConfig	1	False	Champs commentaire 2
Comment3	CommentVisibilityConfig	2	False	Champs commentaire 3
Comment4	CommentVisibilityConfig	3	False	Champs commentaire 4
Comment5	CommentVisibilityConfig	4	False	Champs commentaire 5
Comment6	CommentVisibilityConfig	5	False	Champs commentaire 6
Comment7	CommentVisibilityConfig	6	False	Champs commentaire 7
Comment8	CommentVisibilityConfig	7	False	Champs commentaire 8

{
  "Comment1": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment2": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment3": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment4": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment5": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment6": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment7": {
    "Label": "",
    "AreaVisibility": "private"
  },
  "Comment8": {
    "Label": "",
    "AreaVisibility": "private"
  }
}

ShipmentCreationAddressConfiguration

Paramétrage d'adresse liés à la création de mission

Propriété	Type	Ordre	Obligatoire	Description
Name	ShipmentAddressInfo	0	False	Paramétrage du nom de l'adresse
StreetNumber	ShipmentAddressInfo	1	False	Paramétrage du numéro de rue de l'adresse
Street	ShipmentAddressInfo	2	False	Paramétrage de la rue de l'adresse
Address1	ShipmentAddressInfo	3	False	Paramétrage de la ligne 1 de l'adresse
Address2	ShipmentAddressInfo	4	False	Paramétrage de la ligne 2 de l'adresse
Zip	ShipmentAddressInfo	5	False	Paramétrage du code postal de l'adresse
City	ShipmentAddressInfo	6	False	Paramétrage de la ville de l'adresse
Country	ShipmentAddressInfo	7	False	Paramétrage du pays de l'adresse
Contact	ShipmentAddressInfo	8	False	Paramétrage du contact de l'adresse
Email	ShipmentAddressInfo	9	False	Paramétrage de l'email de l'adresse
Phone1	ShipmentAddressInfo	10	False	Paramétrage du téléphone 1 de l'adresse
Phone2	ShipmentAddressInfo	11	False	Paramétrage du téléphone 2 de l'adresse
Phone3	ShipmentAddressInfo	12	False	Paramétrage du téléphone 3 de l'adresse
AdditionalAddressInformation1	ShipmentAddressInfo	13	False	Champs d'adresse additionel 1, paramètrable par fiche client, exemple Code porte
AdditionalAddressInformation2	ShipmentAddressInfo	14	False	Champs d'adresse additionel 2, paramètrable par fiche client, exemple étage
AdditionalAddressInformation3	ShipmentAddressInfo	15	False	Champs d'adresse additionel 3, paramètrable par fiche client, exemple batiment
AdditionalAddressInformation4	ShipmentAddressInfo	16	False	Champs d'adresse additionel 4, paramètrable par fiche client, exemple escalier
UseAddressNormalization	Boolean	17	False	Normaliser les adresses d'enlèvement livraison (option soumise à licence cartorgraphique)
AddressNormalizationRequired	Boolean	18	False	Normalisation d'adresse obligatoire
StartMapPosition	GeoData	19	False	Coordonnées d'affichage de la carte par défaut
DefaultAddressMustBeUsedOnPickup	Boolean	20	False	L'adresse par défaut doit être utilisée à l'enlèvement, il peut sagir de l'adresse du client ou l'adresse par défaut du donneur d'ordre
DefaultAddressMustBeUsedOnDelivery	Boolean	21	False	L'adresse par défaut doit être utilisée à la livraison, il peut sagir de l'adresse du client ou l'adresse par défaut du donneur d'ordre
CustomerAddress	Address	22	False	Adresse Enlèvement/Livraison du client
DefaultOrdererAddress	Address	23	False	Adresse du donneur d'ordre
UserCanFindAddressByAutoComplete	Boolean	24	False	L'utilisateur a accès à la liste de ses adresses via autocompletion (usage interne)
UserCanSeeAddressesOnMap	Boolean	25	False	L'utilisateur peut voir une carte positionnant les adresses d'enlèvement et livraison (usage interne)
IsPickupAddressHidden	Boolean	26	False	L'adresse d'enlèvement est masquée en saisie
IsDeliveryAddressHidden	Boolean	27	False	L'adresse de livraison est masquée en saisie

{
  "Name": null,
  "StreetNumber": null,
  "Street": null,
  "Address1": null,
  "Address2": null,
  "Zip": null,
  "City": null,
  "Country": null,
  "Contact": null,
  "Email": null,
  "Phone1": null,
  "Phone2": null,
  "Phone3": null,
  "AdditionalAddressInformation1": null,
  "AdditionalAddressInformation2": null,
  "AdditionalAddressInformation3": null,
  "AdditionalAddressInformation4": null,
  "UseAddressNormalization": false,
  "AddressNormalizationRequired": false,
  "StartMapPosition": null,
  "DefaultAddressMustBeUsedOnPickup": false,
  "DefaultAddressMustBeUsedOnDelivery": false,
  "CustomerAddress": null,
  "DefaultOrdererAddress": null,
  "UserCanFindAddressByAutoComplete": false,
  "UserCanSeeAddressesOnMap": false,
  "IsPickupAddressHidden": false,
  "IsDeliveryAddressHidden": false
}

ShipmentCreationCommonOptions

Paramètres divers sur la création de mission

Propriété	Type	Ordre	Obligatoire	Description
ReceiptEntryAllowed	Boolean	0	False	Saisie du récépissé autorisée
ReceiptLabel	String	1	False	Libellé de description du récépissé
AutoScrollToNextStep	Boolean	2	False	Dans le mode de saisie rapide, la saisie passe automatiquement à l'étape suivante dès que les informations obligatoires sont renseignées (usage interne)
MailOnExploitationStateChangeEnabled	Boolean	3	False	L'option de suivie de commande par email est disponible
MissionMustBePayOnSaving	Boolean	4	False	Les missions doivent être payées à la sauvegarde de l'ordre
UserShouldAskApproval	Boolean	5	False	L'utilisateur est sousmis à l'approbation, ses commandes seront enregistrées en tant que devis avant d'être approuvée ultérieurement
UserCanOnlyCreateQuote	Boolean	6	False	L'utilisateur ne peut saisir que des devis
UserCanCreateQuote	Boolean	7	False	L'utilisateur peut saisir des devis
AllowToAddAttachmentFileToMission	Boolean	8	False	Autorise l’ajout de fichier joint à la mission
UserCanCreateMission	Boolean	9	False	L'utilisateur peut saisir une mission
AllowToPostponeReturnFromDate	Boolean	10	False	Conditionne le fait de pouvoir différer la date/heure d'enlèvement retour
DisplayForcedReferences	Boolean	11	False	Affichage des références forcées par donneur d'ordre
AllowToAddAttachmentFileToServices	Boolean	12	False	Autorise l'ajout de fichier joint pour les prestations

{
  "ReceiptEntryAllowed": false,
  "ReceiptLabel": null,
  "AutoScrollToNextStep": false,
  "MailOnExploitationStateChangeEnabled": false,
  "MissionMustBePayOnSaving": false,
  "UserShouldAskApproval": false,
  "UserCanOnlyCreateQuote": false,
  "UserCanCreateQuote": false,
  "AllowToAddAttachmentFileToMission": false,
  "UserCanCreateMission": false,
  "AllowToPostponeReturnFromDate": false,
  "DisplayForcedReferences": false,
  "AllowToAddAttachmentFileToServices": false
}

ShipmentCreationConfiguration

Paramètres liés à la création de mission

Propriété	Type	Ordre	Obligatoire	Description
AddressConfiguration	ShipmentCreationAddressConfiguration	0	False	Paramétrage d'une adresse
PackageConfiguration	ShipmentCreationPackageConfiguration	1	False	Paramétrage du colisage
GeneralSaleCondition	ShipmentCreationGeneralConditionOfSaleConfiguration	2	False	Paramétrage des conditions générales de vente
PickupDateConfiguration	ShipmentDateConfiguration	3	False	Paramétrage de saisie de la date d'enlèvement
DeliveryDateConfiguration	ShipmentDateConfiguration	4	False	Paramétrage de saisie de la date de livraison
PricingConfiguration	ShipmentCreationPricingConfiguration	5	False	Paramétrage de la tarification
CommentConfiguration	ShipmentCommentConfig	6	False	Paramétrage des champs commentaire 1 à 8
CommonOption	ShipmentCreationCommonOptions	7	False	Paramètrage divers
EcommerceOptions	ShipmentCreationEcommerceOptions	8	False	Paramètrage E-Commerce

{
  "AddressConfiguration": null,
  "PackageConfiguration": null,
  "GeneralSaleCondition": null,
  "PickupDateConfiguration": null,
  "DeliveryDateConfiguration": null,
  "PricingConfiguration": null,
  "CommentConfiguration": null,
  "CommonOption": null,
  "EcommerceOptions": null
}

ShipmentCreationEcommerceOptions

Paramétrage E-Commerce liés à la création de mission

Propriété	Type	Ordre	Obligatoire	Description
CreateOrdererToSaveUserCoordinates	Boolean	0	False	Créer un compte utilisateur pour conserver les coordonnées de l’utilisateur
EnableSimplifiedQuotationIfNoPrice	Boolean	1	False	[Obsolete]Ce champs n'est plus renseigné à partir de la version 3.11 de Dispatch
SuggestUserCreationAfterPayment	Boolean	2	False	[Obsolete]Ce champs n'est plus renseigné à partir de la version 3.11 de Dispatch
ShowCo2Emissions	Boolean	3	False	Afficher les émissions de CO2
AskUserCoordinates	Boolean	4	False	Demander les coordonnées de l'utilisateur
AllowOrderWithoutPickupAddress	Boolean	5	False	Autoriser la saisie d'ordre sans adresse d'enlèvement
HidePickupAddress	Boolean	6	False	Ne pas afficher l'adresse d'enlèvement
AllowOrderWithoutDeliveryAddress	Boolean	7	False	Autoriser la saisie d'ordre sans adresse de livraison
HideDeliveryAddress	Boolean	8	False	Ne pas afficher l'adresse de livraison

{
  "CreateOrdererToSaveUserCoordinates": false,
  "EnableSimplifiedQuotationIfNoPrice": false,
  "SuggestUserCreationAfterPayment": false,
  "ShowCo2Emissions": false,
  "AskUserCoordinates": false,
  "AllowOrderWithoutPickupAddress": false,
  "HidePickupAddress": false,
  "AllowOrderWithoutDeliveryAddress": false,
  "HideDeliveryAddress": false
}

ShipmentCreationGeneralConditionOfSaleConfiguration

Paramétrage des conditions générales de vente

Propriété	Type	Ordre	Obligatoire	Description
Url	String	0	False	Url de visibilité des conditions générales de vente
UserMustAcceptConditions	Boolean	1	False	L'utilisateur doit accepter les conditions générales de vente

{
  "Url": null,
  "UserMustAcceptConditions": false
}

ShipmentCreationPackageConfiguration

Paramétrage du colisage liés à la création de mission

Propriété	Type	Ordre	Obligatoire	Description
PackageAllowed	Boolean	0	False	L'utilisateur peut saisir du colisage
PackageMandatory	Boolean	1	False	L'utilisateur doit saisir au moins un colis
FreePackageNatureIsAllowed	Boolean	2	False	L'utilisateur peut saisir une nature libre de colis
DefaultSizeUnit	String	3	False	Unité par défaut des dimensions du colisage
WeightIsMandatory	Boolean	4	False	Poids obligatoire
FillByPackageFamily	Boolean	5	False	Saisie du colisage par famille de colis
FillByBarcodeScan	Boolean	6	False	Saisie du colisage par scan du code barre
InputPackageReferenceIsAllowed	Boolean	7	False	Possibilité d'afficher et de renseigner les références colis
SizeIsMandatory	Boolean	8	False	Taile obligatoire

{
  "PackageAllowed": false,
  "PackageMandatory": false,
  "FreePackageNatureIsAllowed": false,
  "DefaultSizeUnit": null,
  "WeightIsMandatory": false,
  "FillByPackageFamily": false,
  "FillByBarcodeScan": false,
  "InputPackageReferenceIsAllowed": false,
  "SizeIsMandatory": false
}

ShipmentCreationPricingConfiguration

Paramétrage de la tarification

Propriété	Type	Ordre	Obligatoire	Description
UserCanSeePrices	Boolean	0	False	L'utilisateur a accès aux tarifs de vente
UserCanAddSubServices	Boolean	1	False	L'utilisateur peut ajouter des sous prestations (Assurance, options)
UserCanSelectCashOnDelivery	Boolean	2	False	L'utilisateur peut renseigner un contre remboursement
ShipmentWithoutPriceAreNotAllowed	Boolean	3	False	L'utilisateur ne peut pas saisir de mission sans tarif
CashOnDeliveryIsAllowed	Boolean	4	False	L'utilisateur peut saisir un contre remboursement
CashOnDeliveryPaymentTerm	List`1 - PaymentTerm	4	False	Liste des moyens de paiement autorisés pour le contre remboursement
RoundTripMustCreateTwoShipments	Boolean	5	False	Les commandes avec aller-retour doivent déclencher deux ordres de transports
UserCanSeeTotalDistance	Boolean	6	False	L'utilisateur a accès à la distance estimée du transport
UseDispatchServiceColor	Boolean	7	False	Les couleurs prestations Dispatch doivent être utilisées dans l'interface graphique

{
  "UserCanSeePrices": false,
  "UserCanAddSubServices": false,
  "UserCanSelectCashOnDelivery": false,
  "ShipmentWithoutPriceAreNotAllowed": false,
  "CashOnDeliveryIsAllowed": false,
  "CashOnDeliveryPaymentTerm": null,
  "RoundTripMustCreateTwoShipments": false,
  "UserCanSeeTotalDistance": false,
  "UseDispatchServiceColor": false
}

ShipmentDateConfiguration

Paramétrage de la saisie de date à la création de mission

Propriété	Type	Ordre	Obligatoire	Description
UserCanSetDate	Boolean	0	False	L'utilisateur peut saisir une date particulère
DefaultDateCondition	Int32	1	False	Condition horaire par défaut 0 : avant, 1 : à, 2 : à partir de
UserCanSetAsPossibleDate	Boolean	2	False	L'utilisateur peut sélectionner la condition horaire dès que possible
UserCanSetBeforeDateCondition	Boolean	3	False	L'utilisateur peut sélectionner la condition horaire 'avant une date'
UserCanSetAtDateCondition	Boolean	4	False	L'utilisateur peut sélectionner la condition horaire 'à une date'
UserCanSetAfterDateCondition	Boolean	5	False	L'utilisateur peut sélectionner la condition horaire 'à partir d'une date'
UserCanSetADateSlot	Boolean	6	False	L'utilisateur peut saisir un créneau horaire

{
  "UserCanSetDate": false,
  "DefaultDateCondition": 0,
  "UserCanSetAsPossibleDate": false,
  "UserCanSetBeforeDateCondition": false,
  "UserCanSetAtDateCondition": false,
  "UserCanSetAfterDateCondition": false,
  "UserCanSetADateSlot": false
}

ShipmentEstimatedDateByComputePrice

Dates renseignées suite à un calcul de tarif

Propriété	Type	Ordre	Obligatoire	Description
LocalPickupDate	Date	0	False	Date d'enlèvement estimée par Dispatch
LocalDeliveryDate	Date	1	False	Date de livraison estimée par Dispatch

{
  "LocalPickupDate": null,
  "LocalDeliveryDate": null
}

ShipmentEvent

Correspond aux actions effectuées dans Dispatch, enlèvement,livraison etc

Propriété	Type	Ordre	Obligatoire	Description
Status	Status	0	False	Type d'événement (saisi, enlevé, livré)
Date	DateTime nullable	1	False	Date de l'événement (Format C# /(timespan)/
Detail	String	2	False	Description de l'événement
Comment	String	3	False	Commentaire associé à l'événement (source : chauffeur, exploitant, edi)
GPSData	GeoData	4	False	Coordonnées géographique de l'événement
SubstateCode	String	5	False	Code sous état associé
LocalDate	Date	6	False	Date de l'événement format de l'API
EventName	String	7	False	Nom de l'événement dans la langue de l'appelant
DispatchStatusCode	String	8	False	Code Etat Ordre Dispatch

{
  "Status": 0,
  "Date": null,
  "Detail": null,
  "Comment": null,
  "GPSData": null,
  "SubstateCode": null,
  "LocalDate": {
    "Value": null,
    "StringFullDate": null,
    "StringDate": null,
    "StringHour": null,
    "JsonDateTime": null,
    "UnixTimeSpan": null,
    "IsDateWithoutHour": false
  },
  "EventName": null,
  "DispatchStatusCode": null
}

ShipmentInformation

Représente des informations d'un transport

Propriété	Type	Ordre	Obligatoire	Description
InternalId	Int32	0	False	Identifiant de transport
IsFragmented	Boolean	1	False	Information sur la fragmentation

{
  "InternalId": 0,
  "IsFragmented": false
}

ShipmentRegularOrderInfo

Informations sur la tournée régulière

Propriété	Type	Ordre	Obligatoire	Description
RegularOrderId	Int32	0	False	Numéro de l'ordre régulier lié
TrackingMode	Int32	1	False	Mode de tracling (0: pas de tracking, 1: tracking enlévement livraison, 2: tracking par point de passage
RegularOrderCode	String	2	False	Code de l'ordre régulier
RegularOrderLabel	String	3	False	Libellé de l'ordre régulier

{
  "RegularOrderId": 0,
  "TrackingMode": 0,
  "RegularOrderCode": null,
  "RegularOrderLabel": null
}

ShipmentSchedule

Informations d'horaire d'enlèvement/livraison

Propriété	Type	Ordre	Obligatoire	Description
ContractualStartDate	Date	0	False	Date de début d'action souhaitée par le client (null si l'action est à réalisée dès que possible)
ContractualEndDate	Date	1	False	Date de fin souhaitée par le client dans le cas de définition d'un créneau (null si pas de créneau)
ContractualStartCondition	Int32 nullable	2	False	Condition horaire pour une action à une date particulière, dans le cas d'un créneau cette condition est forcée à partir de, valeurs possibles : 0 = avant, 1 = à, 2 = à partir de
IsWindow	Boolean	3	False	Indique que l'horaire est un créneau (ContractualEndDate doit être rempli)
EstimatedStartDate	Date	4	False	(lecture seule) Date de début d'action estimée par Dispatch (Distancier/ paramétrage de prestation/ trajet)
EstimatedEndDate	Date	5	False	(lecture seule) Date de fin d'action estimée par Dispatch
EstimatedIsWindow	Boolean	6	False	(lecture seule) Vrai si Dispatch a calculé un créneau de livraison
EstimatedStartCondition	Int32	7	False	(lecture seule) Condition horaire estimée par Dispatch valeurs possibles : 0 = avant, 1 = à, 2 = à partir de
CompletionDate	Date	8	False	(lecture seule) Date de réalisation effective de l'action
OnSiteDate	Date	9	False	(lecture seule) Date d'arrivée sur site
CompletionStartDate	Date	10	False	(lecture seule) Date de début de réalisation de l'action
CompletionEndDate	Date	11	False	(lecture seule) Date de fin de réalisation de l'action

{
  "ContractualStartDate": null,
  "ContractualEndDate": null,
  "ContractualStartCondition": null,
  "IsWindow": false,
  "EstimatedStartDate": null,
  "EstimatedEndDate": null,
  "EstimatedIsWindow": false,
  "EstimatedStartCondition": 0,
  "CompletionDate": null,
  "OnSiteDate": null,
  "CompletionStartDate": null,
  "CompletionEndDate": null
}

ShuttleRoad

Représente un point de passage d'une navette

Propriété	Type	Ordre	Obligatoire	Description
PickupAddressId	Int32	0	False	Identifiant de l'adresse d'enlèvement
DeliveryAddressId	Int32	1	False	Identifiant de l'adresse de livraison
PickupAddressLabel	String	2	False	Label de l'adresse d'enlèvement
DeliveryAddressLabel	String	3	False	Label de l'adresse de livraison
PickupDate	Date	4	False	Date d'enlèvement
DeliveryDate	Date	5	False	Date de livraison
ComplementInfo	String	6	False	Complément d'information

{
  "PickupAddressId": 0,
  "DeliveryAddressId": 0,
  "PickupAddressLabel": null,
  "DeliveryAddressLabel": null,
  "PickupDate": null,
  "DeliveryDate": null,
  "ComplementInfo": null
}

ShuttleSchedule

Représente les informations horaire d'une navette

Propriété	Type	Ordre	Obligatoire	Description
PickupDate	Date	0	False	Date d'enlèvement
DeliveryDate	Date	1	False	Date de livraison
IsAlternativeShuttle	Boolean	2	False	Navette alternative (Ne respecte pas la date fournie)
ShuttleRoadmap	List`1 - ShuttleRoad	3	False	Feuille de route de la navette
Logs	List`1 - Log	4	False	Logs de calcul de route de la navette

{
  "PickupDate": null,
  "DeliveryDate": null,
  "IsAlternativeShuttle": false,
  "ShuttleRoadmap": null,
  "Logs": null
}

StatisticsModel

Model de statistiques

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32 nullable	0	False	Id unique d'un model de report
Label	String	1	True	Nom du model de report
ModelPath	String	2	False	Chemin du model de report
TypeExportModel	eTypeReportModel	2	True	Type de report

{
  "Id": null,
  "Label": null,
  "ModelPath": null,
  "TypeExportModel": 0
}

Status

Etat d'avancement de livraison de la mission

Nom	Valeur
Confirmed	0
Affected	1
PickedUp	2
Delivered	3
Canceled	4
Issued	5
ArriveDelivrySite	6
ArrivePickUpSite	7
PickedUpWithAnomaly	8
DeliveredWithAnomaly	9
Error	400

SubService

Sous prestation (option du transport), Exemple Assurance, Point Relais

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code unique de la sousprestation
Label	String	1	False	Libellé de la sous presatation
Quantity	Double	2	False	Quantité associée à la sous prestation
Price	Decimal	3	False	Prix calculé par Dispatch grâce à la méthode ComputePrice
AmountWithTaxes	Decimal	4	False	Prix calculé par Dispatch grâce à la méthode ComputePrice en TTC
Unit	String	5	False	Unité servant au calcul du montant de la sous prestation : KG, KM, B, Devise, etc
CustomerComment	String	6	False	Description détaillée de la sous prestation
QuantityDescriptionLabel	String	7	False	Libellé décrivant la valeur à renseigner
QuantityMustBeSelected	Boolean	8	False	L'appelant doit obligatoirement remplir une quantité
QuantityCanBeOverride	Boolean	9	False	L'appelant peut modifier la quantité
RestrictedQuantityList	List`1 - Double	10	False	Liste des quantités restreintes sélectionnables, null si pas de restriction
DefaultQuantity	Double	11	False	Quantité par défaut
TriggerACashOnDelivery	Boolean	12	False	La sous prestation est liée au contre remboursement

{
  "Code": null,
  "Label": null,
  "Quantity": 0.0,
  "Price": 0.0,
  "AmountWithTaxes": 0.0,
  "Unit": null,
  "CustomerComment": null,
  "QuantityDescriptionLabel": null,
  "QuantityMustBeSelected": false,
  "QuantityCanBeOverride": false,
  "RestrictedQuantityList": null,
  "DefaultQuantity": 0.0,
  "TriggerACashOnDelivery": false
}

SubcontractorEmployee

Represent a subcontractor employee

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Subcontractor employee code
Name	String	1	False	Subcontractor employee name
DownloadUrl	String	2	False	Subcontractor employee download photo url

{
  "Code": null,
  "Name": null,
  "DownloadUrl": null
}

TemperaturesSensor

Données de température

Propriété	Type	Ordre	Obligatoire	Description
SensorName	String	0	False	Nom du capteur
Temperatures	List`1 - KeyValuePair`2	1	False	Liste des températures par date
MaximumTemperatureAllowed	Decimal nullable	2	False	Température maximale
MinimumTemperatureAllowed	Decimal nullable	3	False	Température minimale

{
  "SensorName": null,
  "Temperatures": null,
  "MaximumTemperatureAllowed": null,
  "MinimumTemperatureAllowed": null
}

TrackIdPageSettings

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
DynamicMapEnabled	Boolean	0	False	Pas de description
ShowMapOnlyAfterPickup	Boolean	1	False	Pas de description
ShowMapAfterDelivery	Boolean	2	False	Pas de description
MapUrlSuffix	String	3	False	Pas de description

{
  "DynamicMapEnabled": false,
  "ShowMapOnlyAfterPickup": false,
  "ShowMapAfterDelivery": false,
  "MapUrlSuffix": null
}

TrackedMission

Mission trackée

Propriété	Type	Ordre	Obligatoire	Description
MissionId	Int32	0	False	Identifiant de la mission
MissionStateCode	String	1	False	Code état de la mission
ScheduledPickupdUtcDate	Date	2	False	Dete prévue d'enlèvement (UTC)
CustomerCode	String	3	False	Code client
Driver	DriverIdentity	4	False	Chauffeur de la mission
RegularTransport	RegularTransportIdentity	5	False	Ordre régulier

{
  "MissionId": 0,
  "MissionStateCode": null,
  "ScheduledPickupdUtcDate": null,
  "CustomerCode": null,
  "Driver": null,
  "RegularTransport": null
}

TrackedMissionDetails

Mission trackée

Propriété	Type	Ordre	Obligatoire	Description
MissionId	Int32	0	False	Identifiant de la mission
MissionStateCode	String	1	False	Code état de la mission
ScheduledPickupdUtcDate	Date	2	False	Dete prévue d'enlèvement (UTC)
Customer	CustomerIdentity	3	False	Code client
Driver	DriverIdentity	4	False	Chauffeur de la mission
RegularTransport	RegularTransport	5	False	Ordre régulier
TrackingCode	String	6	False	Code tracking

{
  "MissionId": 0,
  "MissionStateCode": null,
  "ScheduledPickupdUtcDate": null,
  "Customer": null,
  "Driver": null,
  "RegularTransport": null,
  "TrackingCode": null
}

TrackedPackage

Point de passage tracké

Propriété	Type	Ordre	Obligatoire	Description
Barcode	String	0	False	Code barres du colis
WayPoints	List`1 - TrackedPackageWayPoint	1	False	Point de passage du colis
TheoricalDeliveryUtcDate	Date	2	False	Date de l'évènement
TheoricalDeliveryAddress	Address	3	False	Date de l'évènement

{
  "Barcode": null,
  "WayPoints": null,
  "TheoricalDeliveryUtcDate": null,
  "TheoricalDeliveryAddress": null
}

TrackedPackageEvent

Evènement d'historique de colis tracké

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	False	Identifiant unique de l'évènement
Date	DateTime	1	False	Date de l'évènement (Format WCF)
Barcode	String	2	False	Code à barre du colis
EventType	TrackedPackageEventType	3	False	Type l'évènement
AnomalyCode	String	4	False	Code de l'anomlie du colis tracké
ProofOfDelivery	String	5	False	Signature de la preuve de livraison
Address	Address	6	False	Lieu où a été effectué l'évènement
Driver	Driver	7	False	Chauffeur ayant effectué l'action
Round	String	8	False	Tournée dans laquelle a été effectuée l'évènement
RegularTransportCode	String	9	False	Ordre régulier dans lequel a été effectué l'évènement

{
  "Id": 0,
  "Barcode": null,
  "EventType": 0,
  "AnomalyCode": null,
  "ProofOfDelivery": null,
  "Address": null,
  "Driver": null,
  "Round": null,
  "RegularTransportCode": null
}

TrackedPackageWayPoint

Point de passage d'un colis tracké

Propriété	Type	Ordre	Obligatoire	Description
Barcode	String	0	False	Code barres du colis
RegularTransport	RegularTransportIdentity	1	False	Ordre régulier
ActionUtcDate	Date	2	False	Date de l'évènement
Action	TrackedPackageAction	3	False	Action sur le colis
WayPointId	Int32	4	False	Identifiant du point de passage
WayPointAddress	Address	5	False	Adresse du point de passage
Latitude	Decimal nullable	6	False	Latitude du point de passage
Longitude	Decimal nullable	7	False	Longitude du point de passage
Anomaly	Anomaly	8	False	Anomalie sur le colis
ClientCode	String	9	False	Code client rattaché à l'ordre régulier du colis
WayPointTrackId	String	10	False	Trackid utilisé pour télécharger le tdr

{
  "Barcode": null,
  "RegularTransport": null,
  "ActionUtcDate": null,
  "Action": 0,
  "WayPointId": 0,
  "WayPointAddress": null,
  "Latitude": null,
  "Longitude": null,
  "Anomaly": null,
  "ClientCode": null,
  "WayPointTrackId": null
}

TrackedPackagesSummary

Représente les statistiques de tracking d'un ordre

Propriété	Type	Ordre	Obligatoire	Description
HandledPackages	Int32	0	False	Nombre de colis traités
PickedupPackagesNotDelivered	Int32	1	False	Nombre de colis enlevés non livrés
DeliveredPackagesNotPickedup	Int32	2	False	Nombre de colis livrés non enlevés
PackagesWithAnomalies	Int32	3	False	Nombre de colis en anomalie

{
  "HandledPackages": 0,
  "PickedupPackagesNotDelivered": 0,
  "DeliveredPackagesNotPickedup": 0,
  "PackagesWithAnomalies": 0
}

TrackedRegularTransport

Ordre régulier tracké

Propriété	Type	Ordre	Obligatoire	Description
RegularTransport	RegularTransportIdentity	0	False	Identifiants de l'ordre régulier
ExecutionDays	RegularTransportExecutionDays	1	False	Jour d'exécution de l'ordre régulier
Driver	DriverIdentity	2	False	Identifiant du chauffeur
StartUtcDate	Date	3	False	Date d'activation
EndUtcDate	Date	4	False	Date de fin
Customer	CustomerIdentity	5	False	Code client

{
  "RegularTransport": null,
  "ExecutionDays": null,
  "Driver": null,
  "StartUtcDate": null,
  "EndUtcDate": null,
  "Customer": null
}

TrackingClient

Propriété	Type	Ordre	Obligatoire
Code	String	0	False
Libelle	String	1	False
NumeroAdresseFacturation	String	2	False
RueAdresseFacturation	String	3	False
Adresse1Facturation	String	4	False
Adresse2Facturation	String	5	False
CodePostalFacturation	String	6	False
VilleFacturation	String	7	False

{
  "Code": null,
  "Libelle": null,
  "NumeroAdresseFacturation": null,
  "RueAdresseFacturation": null,
  "Adresse1Facturation": null,
  "Adresse2Facturation": null,
  "CodePostalFacturation": null,
  "VilleFacturation": null
}

TrackingOrder

Représente les informations principales d'un ordre tracké

Propriété	Type	Ordre	Obligatoire
IdOm	Int32	0	False
DatePrevuEnlevement	Date	1	False
Subcontractor	TrackingSubcontractor	2	False

{
  "IdOm": 0,
  "DatePrevuEnlevement": null,
  "Subcontractor": null
}

TrackingRegularOrder

Propriété	Type	Ordre	Obligatoire
IdOr	Int32	0	False
CodeOr	String	1	False
LibelleOr	String	2	False
IsLundi	Boolean	3	False
IsMardi	Boolean	4	False
IsMercredi	Boolean	5	False
IsJeudi	Boolean	6	False
IsVendredi	Boolean	7	False
IsSamedi	Boolean	8	False
IsDimanche	Boolean	9	False
IsJourFerie	Boolean	10	False
Client	TrackingClient	11	False
TrackedDates	Dictionary`2 - Date	11	False

{
  "IdOr": 0,
  "CodeOr": null,
  "LibelleOr": null,
  "IsLundi": false,
  "IsMardi": false,
  "IsMercredi": false,
  "IsJeudi": false,
  "IsVendredi": false,
  "IsSamedi": false,
  "IsDimanche": false,
  "IsJourFerie": false,
  "Client": null,
  "TrackedDates": null
}

TrackingSubcontractor

Propriété	Type	Ordre	Obligatoire
Code	String	0	False
Libelle	String	1	False
NoLicence	String	2	False
Siret	String	3	False
TvaIntracom	String	4	False
NumeroImmatriculation	String	5	False

{
  "Code": null,
  "Libelle": null,
  "NoLicence": null,
  "Siret": null,
  "TvaIntracom": null,
  "NumeroImmatriculation": null
}

TrackingSummary

Représente le résumé du tracking d'un ordre

Propriété	Type	Ordre	Obligatoire	Description
PackagesWithTypologySummary	Dictionary`2 - String	0	False	Statistiques de tracking par typologie colis
PackagesWithoutTypologySummary	TrackedPackagesSummary	1	False	Statistiques de tracking pour les colis sans typologie
AllPackagesSummary	TrackedPackagesSummary	2	False	Statistiques de tracking globales
SubTotalWithoutTypology	TrackedPackagesSummary	Pas de description

{
  "PackagesWithTypologySummary": {},
  "PackagesWithoutTypologySummary": null,
  "AllPackagesSummary": {
    "HandledPackages": 0,
    "PickedupPackagesNotDelivered": 0,
    "DeliveredPackagesNotPickedup": 0,
    "PackagesWithAnomalies": 0
  }
}

TrackyParameters

Tracky parameters

Propriété	Type	Ordre	Obligatoire	Description
TransportInactivityTimeBeforeCutoffInMinutes	Int32	0	False	Transport inactivity time before cutoff in minutes
TransportRefreshRateInMinutes	Int32	1	False	Transport refresh rate in minutes
TransportDelayAlertLevelLessThanMinutes	Int32	2	False	Transport delay alert level less than X minutes
TransportDelayAlertLevelGreaterThanMinutes	Int32	3	False	Transport delay alert level greater than X minutes

{
  "TransportInactivityTimeBeforeCutoffInMinutes": 0,
  "TransportRefreshRateInMinutes": 0,
  "TransportDelayAlertLevelLessThanMinutes": 0,
  "TransportDelayAlertLevelGreaterThanMinutes": 0
}

TransportBankData

Données bancaire rattachées à un ordre de transport

Propriété	Type	Ordre	Obligatoire	Description
BankResponse	String	0	True	Réponse de la banque stockée sous la forme d'une chaîne de caractères
PaymentTermCode	String	1	True	Code du moyen de paiement Dispatch

{
  "BankResponse": null,
  "PaymentTermCode": null
}

TypeApprobationOrderer

Représentation du type de donneur d'ordre pour le processus d'approbation

Nom	Valeur
DependentOfApproval	0
Approver	1

UnitQuantity

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Unit	String	0	False	Unité exemple KG, L, ML, PV
Quantity	Double	1	False	Quantité d'unité
ForcedByUser	Boolean	2	False	La quantité est forcée par l'utilisateur et ne doit pas être écrasée par un calcul automatique
NoEquivalenceDone	Boolean	3	False	Indique si un calcul d'équivalence a été fait (intervient lorsque l'unité de référence à une contenance paramétrée à 0)

{
  "Unit": null,
  "Quantity": 0.0,
  "ForcedByUser": false,
  "NoEquivalenceDone": false
}

UnitTest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description

{}

UserCustomerAssociated

Client associé à l'utilisateur

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	False	Code client
VisibleOnDispatchWeb	Boolean	1	False	Visible sur Dispatch Web

{}

UserDispatchWebImport

Partie Dispatch Web de l'utilisateur à importer

Propriété	Type	Ordre	Obligatoire	Description
EnableDispatchWeb	Boolean nullable	0	False	Activer Dispatch Web
Login	String	1	False	Identifiant Dispatch Web
Password	String	2	False	Mode de passe Dispatch Web
UserRightsProfilsIds	List`1 - Int32	3	False	Identifiants des profils de droits web à rattacher à l'utilisateur
SpecialServicesLinkedList	List`1 - Service	4	False	Prestations associées spécialement au donneur d'ordre en plus de celles déjà associées au client

{}

UserGeneralImport

Partie générale de l'utilisateur à importer

Propriété	Type	Ordre	Obligatoire	Description
UserCode	String	0	True	Code de l'utilisateur
UserLabel	String	1	False	Libellé de l'utilisateur
Phone1	String	2	False	Numéro de téléphone 1
Phone2	String	3	False	Numéro de téléphone 2
Phone3	String	4	False	Numéro de téléphone 3 (Numéro du téléphone mobile)
Fax	String	5	False	Numéro de Fax
EMail	String	6	False	Adresse email
Reference1	String	7	False	Forcer la référence 1 avec cette valeur
Reference2	String	8	False	Forcer la référence 2 avec cette valeur
Reference3	String	9	False	Forcer la référence 3 avec cette valeur
Lang	String	10	False	Langue de l'utilisateur
AllowedCommunicationModes	CommunicationModeImport	11	False	Modes de communication autorisés
ApprovalOnRequest	Boolean	12	False	Défini la possibilité pour le donneur d'ordre de demander une approbation lors de la saisie d'un ordre de mission
IsApprover	Boolean nullable	13	False	Défini si le donneur d'ordre peut être approbateur d'autres donneurs d'ordres
IsUnderApproval	Boolean nullable	14	False	Défini si le donneur d'ordre peut être soumis à l'approbation d'autres donneurs d'ordres

{
  "ApprovalOnRequest": false,
  "IsApprover": null,
  "IsUnderApproval": null
}

UserImport

Utilisateur Dispatch à importer ou modifier

Propriété	Type	Ordre	Obligatoire	Description
General	UserGeneralImport	0	True	Partie générale de l'utilisateur à importer
DispatchWeb	UserDispatchWebImport	1	False	Partie Dispatch Web de l'utilisateur à importer
AssociatedCustomers	List`1 - UserCustomerAssociated	2	False	Clients associés à l'utilisateur

{}

UserRights

Droits utilisateurs

Propriété	Type	Ordre	Obligatoire	Description
IsAllowedToCancelShipment	Boolean	0	False	L'utilisateur peut annuler une mission avant qu'elle soit attribuée ou facturée
IsAllowedToCreateShipment	Boolean	1	False	L'utilisateur peut créer des missions
IsAllowedToCheckPrice	Boolean	2	False	L'utilisateur peut voir les tarifs des missions
IsAllowedToSaveQuote	Boolean	3	False	L'utilisateur peut enregistrer une mission en tant que devis
IsAllowedToCheckAnomalies	Boolean	4	False	L'utilisateur peut consulter les anomalies sur ses missions
IsAllowedToCheckDriver	Boolean	5	False	L'utilisateur peut voir le chauffeur affecté à une mission
IsAllowedToAddPackage	Boolean	6	False	L'utilisateur peut saisir du colisage dans une mission
IsAllowedToAddEnterFreeKindPackage	Boolean	7	False	L'utilisateur peut saisir ses propres natures de colis
PackageIsMandatory	Boolean	8	False	L'utilisateur doit saisir au moins un colis par mission
PackageWeightIsMandatory	Boolean	9	False	La saisie du poids d'un colis est obligatoire
IsAllowedToCreateBookmarkedAddressForCustomer	Boolean	10	False	L'utilisateur peut enregistrer des adresses favorites pour un compte client
IsAllowedToCreateBookmarkedAddressForHimself	Boolean	11	False	L'utilisateur peut enregistrer des adresses favorites pour son compte utilisateur
IsAllowedToAddSubService	Boolean	12	False	L'utilisateur peut ajouter/saisir des sous prestations dans une mission
IsAllowedToCheckMissionFile	Boolean	13	False	L'utilisateur peut voir les preuves de livraison
IsAllowedToCheckSubcontractorTracking	Boolean	14	False	L'utilisateur a accès au lien de tracking du sous traitant
IsAllowedToViewOrderOnMap	Boolean	15	False	L'utilisateur peut afficher la mission sur une carte
IsAllowedToDownloadStick	Boolean	16	False	L'utilisateur peut télécharger une étiquette transport
IsApprover	Boolean	17	False	[Deprecated, à ne plus utiliser] L'utilisateur peut approuver des missions
IsSubjectToApproval	Boolean	18	False	[Deprecated, à ne plus utiliser] L'utilisateur est sousmis à approbation, il ne peut saisir de mission directement
IsAllowedToUpdateShipment	Boolean	19	False	L'utilisateur peut modifier les informations de la mission avant son attribution à un chauffeur
IsAllowedToAccessBill	Boolean	20	False	L'utilisateur peut accéder aux factures
IsPaymentIsMandatoryToOrder	Boolean	21	False	Le paiement de la mission est obligatorie pour valider la mission
IsAllowedToManageOrderingParty	Boolean	22	False	L'utilisateur peut accéder à la gestion de donneur d'ordre
IsAllowedToManageReference	Boolean	23	False	L'utilisateur peut accéder à la gestion des références clients
IsAllowedToManageBookmarkedAddresses	Boolean	24	False	L'utilisateur peut accéder à la gestion des adresses favorites
IsAllowedToManageWebUserRightProfile	Boolean	25	False	L'utilisateur peut accéder à la gestion des profils de droit donneur d'ordre
IsAdministrator	Boolean	26	False	L'utilisateur peut accéder à l'écran d'administration
IsAllowedToAccessToDriverTrack	Boolean	27	False	L'utilisateur peut voir la trace GPS d'un chauffeur sur une mission
IsAllowedToAccessToDefaultTrack	Boolean	28	False	L'utilisateur peut voir l'itinéraire théorique sur une mission
SmoothDriverTrack	Boolean	29	False	La trace GPS d'un chauffeur est affiné par un calcul routier
PhoneNumberMustMatchInternationalRules	Boolean	30	False	Les numéros de téléphones doivent être valide (+33 6 00 00 00 00)
IsAllowedToAccessToOrderHistory	Boolean	31	False	Le donneur peut accéder au suivi des missions
IsAllowedToAccesToRegularOrderTracking	Boolean	32	False	Le donneur peut accéder au tracking des ordres réguliers
IsAllowedToAccessToVoucherCredit	Boolean	33	False	Le donneur peut accéder au solde de bon
IsAllowedToOrderVoucherCredit	Boolean	34	False	Le donneur peut commander des carnets de bon
IsAllowedToRetreiveAddressByExternalCode	Boolean	35	False	Le donneur peut rechercher une adresse par son code externe en saisie de mission
HasEurekaMapsAccess	Boolean	36	False	Le donneur peut se servir des services cartographie EurekaMaps
AutomaticSlipDownload	Boolean	37	False	Le donneur télécharge automatiquement les borderaux après la saisie
AutomaticStickDownload	Boolean	38	False	Le donneur télécharge automatiquement les étiquettes après la saisie
IsNotAllowedToSeeLastShipmentAddress	Boolean	39	False	Le donneur ne peut pas accéder aux dernières adresses saisies
CommandOnePageMode	Boolean	40	False	Le donneur d'ordre peut accéder au mode de saisie rapide (Usage interne)
CommandMultiPageMode	Boolean	41	False	Le donneur d'ordre peut accéder au mode de saisie multipage (Usage interne)
DisplayMapOnCommandPage	Boolean	42	False	Le donneur d'ordre peut accéder à la carte en saisie de mission (Usage interne)
IsAllowedToAddAttachmentFileToMission	Boolean	43	False	Le donneur d'ordre peut ajouter des fichier à la mission
IsAllowedToPayBill	Boolean	44	False	Le donneur d'ordre peut payer ses factures en ligne
IsAllowedToDisplayPicture	Boolean	45	False	Le donneur d'ordre peut voir la photo du chauffeur
IsAllowedToViewDriverPhone	Boolean	46	False	Le donneur d'ordre a accès au téléphone du chauffeur
IsAllowedToContactDriverBySms	Boolean	47	False	Le donneur d'ordre peut envoyer un sms au chauffeur depuis son mobile
IsAllowedToDisplayCanceldOrder	Boolean	48	False	Le donneur d'ordre peut voir les ordres annulés
IsAllowedToDisplayCommentPage	Boolean	49	False	Le donneur d'ordre peut voir la page commentaire
InputQuoteOnServicesPricedZeroIsMandatory	Boolean	50	False	Le donneur ordre doit saisir un devis dans le cas où la prestation choisie n'est pas tarifée
IsAllowedToUpdateQuote	Boolean	51	False	Le donneur ordre est autorisé à modifier un devis avant sa validation
DisplayDriverLinkedGeoDevice	Boolean	52	False	Le donneur d'ordre peut voir les photos des chauffeurs associés aux boitiers
PointsOfInterestManagement	Boolean	53	False	Le donneur d'ordre peut gérer les POIs
IsAllowedToSeeAllShipment	Boolean	54	False	Le donneur d'ordre peut voir les missions des autres donneurs d'ordre ou celle de Dispatch en plus des siennes
IsAllowedToSeeTransportTemperatures	Boolean	55	False	Le donneur d'ordre peut voir les courbes de temperatures mesurées sur un transport
OrderHistoryPublicConfig	OrderHistoryPublicConfig	56	False	Droits utilisateurs pour la page publique
ValidateQuoteOnRestrictedService	Boolean	57	False	Le donneur d'ordre peut valider un devis dont la prestation ne lui est pas autorisée en saisie d'ordre
IsAllowedToDisplaySubcontractorEmployeesPictures	Boolean	58	False	Le donneur d'ordre peut voir les photos des salariés d'un sous-traitant
IsAllowedToAddAttachmentFileToServices	Boolean	59	False	Le donneur d'ordre peut ajouter des fichiers pour les prestations
DisplayPickupAddressOnMap	Boolean	60	False	Afficher l'adresse d'enlèvement sur la carte en détail de suivi de mission
DisplayDeliveryAddressOnMap	Boolean	61	False	Afficher l'adresse de livraison sur la carte en détail de suivi de mission
IsAllowedToDownloadSlipsWaybill	Boolean	62	False	Le donneur d'ordre a accès au téléchargement du report Lettre de Voiture
DisplayPricesUnfinalizedQuotes	Boolean	63	False	Le donneur d'ordre peut voir les tarifs des devis non finalisés
IsAllowedToAccessEdi	Boolean	64	False	Le donneur d'ordre peut accéder à l'onglet EDI
DisplayPlannedSchedule	Boolean	65	False	Le donneur d'ordre peut voir les horaires planifiés
BestFamilyPriceShouldBeSuggested	Boolean	66	False	Le meilleur tarif d'une famille de prestation devrait être suggéré en saisie de mission
IsAllowedToDownloadRoundSheet	Boolean	67	False	Le donneur d'ordre peut télécharger les feuilles de tournée
IsAllowedToDisplayRealizedAndEstimatedHours	Boolean	68	False	Le donneur d'ordre peut voir les horaires d'enlèvement et de livraison réalisés

{
  "IsAllowedToCancelShipment": false,
  "IsAllowedToCreateShipment": false,
  "IsAllowedToCheckPrice": false,
  "IsAllowedToSaveQuote": false,
  "IsAllowedToCheckAnomalies": false,
  "IsAllowedToCheckDriver": false,
  "IsAllowedToAddPackage": false,
  "IsAllowedToAddEnterFreeKindPackage": false,
  "PackageIsMandatory": false,
  "PackageWeightIsMandatory": false,
  "IsAllowedToCreateBookmarkedAddressForCustomer": false,
  "IsAllowedToCreateBookmarkedAddressForHimself": false,
  "IsAllowedToAddSubService": false,
  "IsAllowedToCheckMissionFile": false,
  "IsAllowedToCheckSubcontractorTracking": false,
  "IsAllowedToViewOrderOnMap": false,
  "IsAllowedToDownloadStick": false,
  "IsApprover": false,
  "IsSubjectToApproval": false,
  "IsAllowedToUpdateShipment": false,
  "IsAllowedToAccessBill": false,
  "IsPaymentIsMandatoryToOrder": false,
  "IsAllowedToManageOrderingParty": false,
  "IsAllowedToManageReference": false,
  "IsAllowedToManageBookmarkedAddresses": false,
  "IsAllowedToManageWebUserRightProfile": false,
  "IsAdministrator": false,
  "IsAllowedToAccessToDriverTrack": false,
  "IsAllowedToAccessToDefaultTrack": false,
  "SmoothDriverTrack": false,
  "PhoneNumberMustMatchInternationalRules": false,
  "IsAllowedToAccessToOrderHistory": false,
  "IsAllowedToAccesToRegularOrderTracking": false,
  "IsAllowedToAccessToVoucherCredit": false,
  "IsAllowedToOrderVoucherCredit": false,
  "IsAllowedToRetreiveAddressByExternalCode": false,
  "HasEurekaMapsAccess": false,
  "AutomaticSlipDownload": false,
  "AutomaticStickDownload": false,
  "IsNotAllowedToSeeLastShipmentAddress": false,
  "CommandOnePageMode": false,
  "CommandMultiPageMode": false,
  "DisplayMapOnCommandPage": false,
  "IsAllowedToAddAttachmentFileToMission": false,
  "IsAllowedToPayBill": false,
  "IsAllowedToDisplayPicture": false,
  "IsAllowedToViewDriverPhone": false,
  "IsAllowedToContactDriverBySms": false,
  "IsAllowedToDisplayCanceldOrder": false,
  "IsAllowedToDisplayCommentPage": false,
  "InputQuoteOnServicesPricedZeroIsMandatory": false,
  "IsAllowedToUpdateQuote": false,
  "DisplayDriverLinkedGeoDevice": false,
  "PointsOfInterestManagement": false,
  "IsAllowedToSeeAllShipment": false,
  "IsAllowedToSeeTransportTemperatures": false,
  "OrderHistoryPublicConfig": null,
  "ValidateQuoteOnRestrictedService": false,
  "IsAllowedToDisplaySubcontractorEmployeesPictures": false,
  "IsAllowedToAddAttachmentFileToServices": false,
  "DisplayPickupAddressOnMap": false,
  "DisplayDeliveryAddressOnMap": false,
  "IsAllowedToDownloadSlipsWaybill": false,
  "DisplayPricesUnfinalizedQuotes": false,
  "IsAllowedToAccessEdi": false,
  "DisplayPlannedSchedule": false,
  "BestFamilyPriceShouldBeSuggested": false,
  "IsAllowedToDownloadRoundSheet": false,
  "IsAllowedToDisplayRealizedAndEstimatedHours": false
}

UserWebProfile

Profil de droit utilisateur Dispatch Web

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	True	Identifiant du profil
Label	String	1	True	Nom du profil
WebUserRightList	List`1 - WebUserRight	2	True	Ensemble des droits web rattachés au profil

{}

VoucherPricingScale

Ligne de tarification d'une grille de tarification en bon

Propriété	Type	Ordre	Obligatoire	Description
UnitPriceExcludingTaxes	Decimal	0	False	Montant HT
UnitPriceIncludingTaxes	Decimal	1	False	Montant TTC
VoucherUnitRange	Double	2	False	Quantité maximum de bon applicable pour ce tarif
VatRate	Decimal	3	False	Taux de TVA

{
  "UnitPriceExcludingTaxes": 0.0,
  "UnitPriceIncludingTaxes": 0.0,
  "VoucherUnitRange": 0.0,
  "VatRate": 0.0
}

WayPoint

Objet représentant un point de passage

Propriété	Type	Ordre	Obligatoire	Description
WayPointId	Int32	0	False	Identifiant du point de passage
Identity	WayPointIdentity	1	False	Permet d'identifier le point de passage dans Dispatch
WayPointAddress	Address	2	False	Objet représentant l'adresse du point de passage dans Dispatch
IsOptional	Boolean	3	False	Indique si ce point de passage est optionnel dans Dispatch
Order	Int32	4	False	Indique l'ordre de passage au sein de la mission de Dispatch
ScheduledBeginUtcDate	Date	5	False	Date et heure de passage prévue au format UTC
ScheduledBeginDateCondition	Int32	6	False	Condition sur la date et l'heure de passage prévue
MinuteDelay	Int32	7	False	Délai à appliquer sur le point de passage en minute
ScheduledEndUtcDate	Date	8	False	Date et heure de passage prévue au format UTC
EstimatedBeginUtcDate	Date	9	False	Date et heure de passage estimé au format UTC
EstimatedEndUtcDate	Date	10	False	Date et heure de passage estimé au format UTC
Details	WayPointDetails	11	False	Détail du point de passage
Packages	List`1 - WayPointPackage	12	False	Colis traités sur ce point de passage
AnnouncedPackages	List`1 - WayPointAnnouncedPackage	13	False	Colis annoncés sur ce point de passage
OperationZoneCode	String	14	False	Code de la zone d'exploitation associée au point de passage dans Dispatch
ReferenceUtcDate	Date	15	False	Date de référence du point de passage

{
  "WayPointId": 0,
  "Identity": null,
  "WayPointAddress": null,
  "IsOptional": false,
  "Order": 0,
  "ScheduledBeginUtcDate": null,
  "ScheduledBeginDateCondition": 0,
  "MinuteDelay": 0,
  "ScheduledEndUtcDate": null,
  "EstimatedBeginUtcDate": null,
  "EstimatedEndUtcDate": null,
  "Details": null,
  "Packages": [],
  "AnnouncedPackages": null,
  "OperationZoneCode": null,
  "ReferenceUtcDate": null
}

WayPointAnnouncedPackage

Objet représentant une annonce de colis sur point de passage

Propriété	Type	Ordre	Obligatoire	Description
WayPointAnnouncedPackageId	Int32	0	False	Identifiant de l'annonce de colis
Barcode	String	1	False	Code-barres du colis
DisposalUtcDate	Date	2	False	Date de mise à disposition du colis
ScheduledDeliveryUtcDate	Date	3	False	Date de livraison prévue
RegularOrderId	Int32 nullable	4	False	Identifiant interne de l'ordre régulier
PickupAddress	Address	5	False	Adresse d'enlèvement
DeliveryAddress	Address	6	False	Adresse de livraison
WayPointId	Int32 nullable	7	False	Identifiant du point de passage

{
  "WayPointAnnouncedPackageId": 0,
  "Barcode": null,
  "DisposalUtcDate": null,
  "ScheduledDeliveryUtcDate": null,
  "RegularOrderId": null,
  "PickupAddress": null,
  "DeliveryAddress": null,
  "WayPointId": null
}

WayPointDetails

Détail du point de passage

Propriété	Type	Ordre	Obligatoire	Description
DriverBeginningTransitUtcDate	Date	0	False	Date et l'heure à laquelle le chauffeur a commencé son travail sur point de passage au format UTC
DriverEndingTransitUtcDate	Date	1	False	Date et l'heure à laquelle le chauffeur a terminé son travail sur point de passage au format UTC
Anomaly	Anomaly	2	False	Anomalie sur le point de passage
Signer	String	3	False	Nom de l'émargé
Base64PngSignature	String	4	False	Signature de l'émargé au format PNG encodé en base 64
Barcode	String	5	False	Code-barres du point de passage
Latitude	Decimal nullable	6	False	Latitude du point de passage
Longitude	Decimal nullable	7	False	Longitude du point de passage
Comment1	String	8	False	Commentaire 1
Comment2	String	9	False	Commentaire 2
Comment3	String	10	False	Commentaire 3
Comment4	String	11	False	Commentaire 4
Comment5	String	12	False	Commentaire 5
Comment6	String	13	False	Commentaire 6
Comment7	String	14	False	Commentaire 7
Comment8	String	15	False	Commentaire 8

{
  "DriverBeginningTransitUtcDate": null,
  "DriverEndingTransitUtcDate": null,
  "Anomaly": null,
  "Signer": null,
  "Base64PngSignature": null,
  "Barcode": null,
  "Latitude": null,
  "Longitude": null,
  "Comment1": null,
  "Comment2": null,
  "Comment3": null,
  "Comment4": null,
  "Comment5": null,
  "Comment6": null,
  "Comment7": null,
  "Comment8": null
}

WayPointIdentity

Objet représentant l'identité d'un point de passage dans Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Kind	DispatchWayPointKindEnum	0	False	Indique qu'il s'agit d'un point de ramasage ou de dépot
MissionId	Int32	1	False	Numéro de mission de Dispatch
InternalTransportId	Int32	2	False	Numéro d'ordre de transport
RoundId	Int32	3	False	Identifiant de la tournée dans Dispatch
MutualizedRegularOrderCode	String	4	False	Code de l'ordre régulier mutualisé dans Dispatch
RegularOrderCode	String	5	False	Code de l'ordre régulier dans Dispatch
RegularOrderId	Int32	6	False	Identifiant interne de l'ordre régulier dans Dispatch
RegularOrderLabel	String	7	False	Libellé de l'ordre régulier dans Dispatch
CustomerCode	String	8	False	Code client de la mission

{
  "Kind": 0,
  "MissionId": 0,
  "InternalTransportId": 0,
  "RoundId": 0,
  "MutualizedRegularOrderCode": null,
  "RegularOrderCode": null,
  "RegularOrderId": 0,
  "RegularOrderLabel": null,
  "CustomerCode": null
}

WayPointPackage

Colis traité au sein du point de passage

Propriété	Type	Ordre	Obligatoire	Description
WayPointPackageId	Int32	0	False	Identifiant interne du colis sur le point de passage
WayPointId	Int32	1	False	Identifiant du point de passage
Barcode	String	2	False	Code-barres du colis
ForcedByDriver	Boolean	3	False	Indique si le chauffeur à forcé l'ajout du colis sur le point de passage bien que celui-ci n'y était pas destiné
ActionUtcDate	Date	4	False	Date et heure du premier traitement du colis sur le point de passage au format UTC
Anomaly	Anomaly	5	False	Anomalie sur le colis dans Dispatch
PackageType	String	6	False	Code de la typologie du colis dans Dispatch
Action	WayPointPackageAction	7	False	Indique l'action réalisé sur le colis sur le point de passage

{
  "WayPointPackageId": 0,
  "WayPointId": 0,
  "Barcode": null,
  "ForcedByDriver": false,
  "ActionUtcDate": null,
  "Anomaly": null,
  "PackageType": null,
  "Action": 0
}

WebUser

Utilisateur Web utilisé pour créer un donneur ordre

Propriété	Type	Ordre	Obligatoire	Description
Code	String	0	False	Code du donneur d'ordre (Lecture seule - généré automatiquement)
Name	String	1	False	Nom du donneur d'ordre
Firstname	String	2	False	Prénom du donneur d'ordre
Company	String	3	False	Société du donneur d'ordre
Phone	String	4	False	Téléphone du donneur d'ordre
Cellular	String	5	False	Téléphone portable du donneur d'ordre
Email	String	6	False	Email du donneur d'ordre
ZipCode	String	7	False	Code postal du donneur d'ordre
City	String	8	False	Ville du donneur d'ordre
Street	String	9	False	Rue du donneur d'ordre
StreetNumber	String	10	False	Numéro de rue du donneur d'ordre
Address1	String	11	False	Adresse 1 du donneur d'ordre
Address2	String	12	False	Adresse 2 du donneur d'ordre
CivilTitle	Int32	13	False	Civilité
CityId	Int32	14	False	Id ville du donneur d'ordre
CountryCode	String	15	False	Code du pays du donneur d'ordre

{
  "Code": null,
  "Name": null,
  "Firstname": null,
  "Company": null,
  "Phone": null,
  "Cellular": null,
  "Email": null,
  "ZipCode": null,
  "City": null,
  "Street": null,
  "StreetNumber": null,
  "Address1": null,
  "Address2": null,
  "CivilTitle": 0,
  "CityId": 0,
  "CountryCode": null
}

WebUserRight

Description d'un droit utilisateur DispatchWeb

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	True	Id du droit (lecture seule)
LocalizedLabel	String	1	False	Libellé (lecture seule)
LocalizedCategory	String	2	False	Catégorie (lecture seule)
LocalizedSubCategory	String	3	False	Sous catégorie (lecture seule)

{}

eComentMode

Mode d'affichage du commentaire (Aucun affichage, affichage général, affichage en enlévement ou affichage en livraison)

Nom	Valeur
None	0
Common	1
Pickup	2
Delivery	3

eVoucherBillMode

Mode de facturation des bons (monnaie virtuelle du monde de la course parisienne)

Nom	Valeur
VoucherCredit	66
ChargedAtLaterDateVoucher	85
VirtualVoucherCredit	86
NoVoucher	88

Objets utilisés pour les paramètres de requête API

AddPoiFamilyRequest

Requète pour ajouter une famille de poi

Propriété	Type	Ordre	Obligatoire	Description
NewFamilyName	String	0	True	Nom de la nouvelle famille de poi à ajouter
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "NewFamilyName": null
}

ApprovalForcedDateCondition

Utilisé pour approuver un devis ou une mission en forçant les conditions et les dates

Propriété	Type	Ordre	Obligatoire	Description
UtcDate	DateTime nullable	0	False	Nouvelle date au format utc
Condition	Int32	1	False	Condition horaire par défaut 0 : avant, 1 : à, 2 : à partir de

{
  "UtcDate": null,
  "Condition": 0
}

ApproveQuotationRequest

Permet d'approuver une mission en attente d'approbation

Propriété	Type	Ordre	Obligatoire	Description
QuoteId	Int32	0	True	Numéro de Devis
ForcedPickupDate	ApprovalForcedDateCondition	1	False	Nouvelle date d'enlèvement d'approbation
ForcedDeliveryDate	ApprovalForcedDateCondition	2	False	Nouvelle date de livraison d'approbation
OriginalOrdererCode	String	3	False	Code du donneur d'ordre ayant saisi la mission
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "QuoteId": 0,
  "ForcedPickupDate": null,
  "ForcedDeliveryDate": null,
  "OriginalOrdererCode": null
}

AskApprovalRequest

Permet de transformer un devis en demande d'approbation

Propriété	Type	Ordre	Obligatoire	Description
QuoteId	Int32	0	False	Numéro de devis à transformer en approbation
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "QuoteId": 0
}

AskForPasswordResetLinkRequest

Send password reset link

Propriété	Type	Ordre	Obligatoire	Description
LoginType	LoginType	0	True	Login type
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "LoginType": null
}

AttachFileToShipmentRequest

Requete pour ajouter un fichier à un ordre de transport.

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	False	Numéro de l'ordre de transport
GuidTemporaryShipment	String	1	True	Guid temporaire de l'ordre de transport
ContentDocument	Byte[]	2	True	Flux du document à rattacher à l'ordre de transport
FileName	String	3	True	Nom du fichier à rattacher à l'ordre de transport
CategoryCode	String	4	False	Catégorie du fichier à rattacher à l'ordre de transport
Label	String	5	False	Libellé du fichier à rattacher à l'ordre de transport
IdMission	Int32	5	False	Numéro de mission
QuoteId	Int32	6	False	Numéro de devis
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalShipmentId": 0,
  "GuidTemporaryShipment": null,
  "ContentDocument": null,
  "FileName": null,
  "CategoryCode": null,
  "Label": null,
  "IdMission": 0,
  "QuoteId": 0
}

AttachShipmentFileRequest

Requete permettant de rattacher un fichier à un ordre de transport.

Propriété	Type	Ordre	Obligatoire	Description
GuidTemporaryShipment	String	0	True	Guid temporaire de l'ordre de transport
Base64Content	String	2	True	Contenu du document à rattacher à l'ordre de transport
FileName	String	3	True	Nom du fichier à rattacher à l'ordre de transport
InternalShipmentId	Int32	4	False	Numéro de l'ordre de transport
CategoryCode	String	5	False	Catégorie du fichier à rattacher à l'ordre de transport
Label	String	6	False	Libellé du fichier à rattacher à l'ordre de transport
IdMission	Int32	7	False	Numéro de mission
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GuidTemporaryShipment": null,
  "Base64Content": null,
  "FileName": null,
  "InternalShipmentId": 0,
  "CategoryCode": null,
  "Label": null,
  "IdMission": 0
}

AuthentificationRequest

Paramètre d'authentification à l'API

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

AutoCompleteStreetRequest

Permet de faire de l'autocomplétion sur des noms de rue

Propriété	Type	Ordre	Obligatoire	Description
Street	String	0	True	Début du nom de la rue, 2 caractères minimum
PostalCode	String	1	False	Code Postal
City	String	2	False	Nom de la ville
Country	String	3	True	Pays (obligatorie)
MaxResult	Int32	4	True	Nombre de résultat maximum retourné, Valeur Max (50)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Street": null,
  "PostalCode": null,
  "City": null,
  "Country": null,
  "MaxResult": 15
}

BecomePartnerRequest

Requête pour l'envoi d'un email de demande de partenariat

Propriété	Type	Ordre	Obligatoire	Description
Contact	String	0	True	Champ contenant les informations de contact basiques (nom - prénom - téléphone par exemple)
Email	String	1	True	Email de contact
Message	String	2	True	Champ contenant le message à envoyer (descriptif des prestations proposées par exemple)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Contact": null,
  "Email": null,
  "Message": null
}

BillAndPayShipmentRequest

Transforme un devis en mission, le règle et le facture

Propriété	Type	Ordre	Obligatoire	Description
QuoteId	Int32	0	True	Numéro de devis à transformer en mission (obligatoire)
PaymentAmount	Double	1	True	Montant du réglement (obligatoire)
InternalTransactionId	String	2	False	Numéro de transaction interne à l'appelant
PaymentBankId	String	3	True	Numéro de paiement fournit par la banque (obligatoire)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "QuoteId": 0,
  "PaymentAmount": 0.0,
  "InternalTransactionId": null,
  "PaymentBankId": null
}

CancelShipmentRequest

Paramètre la méthode permettant l'annulation d'une mission

Propriété	Type	Ordre	Obligatoire	Description
ShipmentId	Int32	0	True	Numéro de la mission à annuler
IsQuote	Boolean	1	True	Indique si le numéro correspond à un devis
TransportId	Int32 nullable	2	False	Précise l'ordre de transport de la mission à annuler (API version >= 52)
NewQuoteId	Int32 nullable	3	False	Si précisé, c'est que la mission identifiée par ShipmentId est annulée pour permettre de créer le nouveau devis identifié par NewQuoteId. Des informations seront ajoutées dans l'historique.
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ShipmentId": 0,
  "IsQuote": false,
  "TransportId": null,
  "NewQuoteId": null
}

CheckResetTokenValidityRequest

Check validity of the resettoken

Propriété	Type	Ordre	Obligatoire	Description
TrackId	String	0	True	TrackId
ResetToken	String	1	False	ResetToken
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "TrackId": null,
  "ResetToken": null
}

CityRequest

Autocomplétion sur les villes Dispatch

Propriété	Type	Ordre	Obligatoire	Description
Prefix	String	0	True	Début du nom de la ville ou du code postal
Agency	String	1	False	Code agence du demandeur
Country	String	2	True	Pays de la ville recherchée
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Prefix": null,
  "Agency": null,
  "Country": null
}

ComparePricesRequest

Permet d'obtenir des prix et délais

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Shipment	0	True	Mission concernée par la recherche de tarif
LoadSubServiceOptions	Boolean	1	False	Le comparateur de tarif retourne les sous prestations autorisées pour chaque prestation (assurance, point relais, etc)
LoadCustomFields	Boolean	2	False	Le comparateur de tarif retourne les paramètres personnalisés (paramètre EDI) pour chaque prestation
ReturnRejectedSevices	Boolean	3	False	Le comparateur de prix retourne les prestations rejetées pour raison métier (hors délais, sans tarif, ...)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Shipment": null,
  "LoadSubServiceOptions": false,
  "LoadCustomFields": false,
  "ReturnRejectedSevices": false
}

ComputePriceRequest

Permet d'obtenir des estimations tarifaire

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Shipment	0	True	Transport aller
ReturnShipment	Shipment	1	False	Transport retour
ByPassCityControl	Boolean	2	False	Les villes des missions ne sont pas vérifier par Dispatch, si aucune ville ne correspond il se peut que Dispatch ne trouve pas de tarif
ComputePriceWithTaxes	Boolean	3	False	Le TTC sera calculé par Dispatch et la propriété PriceWithTaxe de Shipment sera renseignée
SkipDistanceComputing	Boolean	4	False	Le calcul de distance est ignoré (usage interne)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Shipment": null,
  "ReturnShipment": null,
  "ByPassCityControl": false,
  "ComputePriceWithTaxes": false,
  "SkipDistanceComputing": false
}

CreatePackagesCareRequest

Permet de créer une demande de prise en charge de colis

Propriété	Type	Ordre	Obligatoire	Description
Packages	List`1 - PackageCare	0	True	Liste des colis à prendre en charge (obligatoire au moins une prise en charge de colis)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Packages": null
}

CreateReferenceRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ReferenceToCreate	Reference	0	False	Reference entity to create
CustomerCode	String	1	False	Customer code associated to the reference
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ReferenceToCreate": null,
  "CustomerCode": null
}

CreateShipmentRequest

Permet de créer, des devis, des missions, d'obtenir des estimations tarifaire

Propriété	Type	Ordre	Obligatoire	Description
Quote	Boolean	0	True	Permet d'enregistrer le Shipment en tant que devis si la valeur est à true
Save	Boolean	1	True	La mission ou devis sera sauvegardée dans Dispatch
Shipment	Shipment	2	True	Transport aller
ByPassCityControl	Boolean	3	False	Les villes des missions ne sont pas vérifier par Dispatch, si aucune ville ne correspond il se peut que Dispatch ne trouve pas de tarif
ComputePriceWithTaxes	Boolean	4	False	Le TTC sera calculé par Dispatch et la propriété PriceWithTaxe de Shipment sera renseignée
ReturnShipment	Shipment	5	False	Transport retour
SkipDistanceComputing	Boolean	6	False	Le calcul de distance est ignoré (usage interne)
IsUnderApprobation	Boolean	7	False	Défini si l'ordre de mission (=devis) est en attente d'approbation. N'est possible qu'avec l'option 'Quote' active
IsUnderDelegation	Boolean	8	False	Défini si l'ordre de mission (ou devis) est saisi par un délégué
UpdateComment	String	9	False	Commentaire à insérer dans l'historique de l'ordre
ReturnUpdateComment	String	10	False	Commentaire à insérer dans l'historique de l'ordre pour le transport retour
ApplyDefaultValuesFromPackageNature	Boolean	11	False	Permet d'ajouter les valeurs par défaut sur le colisage (unité, encombrement, reférences
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Quote": false,
  "Save": false,
  "Shipment": null,
  "ByPassCityControl": false,
  "ComputePriceWithTaxes": false,
  "ReturnShipment": null,
  "SkipDistanceComputing": false,
  "IsUnderApprobation": false,
  "IsUnderDelegation": false,
  "UpdateComment": null,
  "ReturnUpdateComment": null,
  "ApplyDefaultValuesFromPackageNature": false
}

CreateTrackIdPageSessionRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

DateSearchSelectorType

Type de date de recherche

Nom	Valeur
None	0
RoundReferenceDate	1
RoundEstimatedStartDate	2
RoundEstimatedEndDate	3
RoundEstimatedStartAndEndDate	4

DeleteAPoiFamillyRequest

Requète pour supprimer une famille de poi en la remplacant par une existant déjà

Propriété	Type	Ordre	Obligatoire	Description
FamilyIdToDelete	Int32	0	True	Identifiant de la famille de poi à supprimer
FamilyIdToReplace	Int32	1	True	Identifiant de la famille de poi pour associé les poi de la famille supprimé
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "FamilyIdToDelete": 0,
  "FamilyIdToReplace": 0
}

DeleteBookmarkedAddressRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code client sur 10 caractères
AddressId	Int32	1	True	Id de l'adresse à supprimer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null,
  "AddressId": 0
}

DeleteClientSpecificServiceRequest

Requete de suppression d'une prestations autorisée spécifiquement pour le client choisi

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Pas de description
ServiceCode	String	1	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null,
  "ServiceCode": null
}

DeleteManageableOrdererRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrdererCode	String	0	False	Orderer code to delete
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OrdererCode": null
}

DeleteOrdererFavoriteAddressRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrdererCode	String	0	True	Code donneur d'ordre
AddressId	Int32	1	True	Id de l'adresse à supprimer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OrdererCode": null,
  "AddressId": 0
}

DeletePointOfInterestRequest

Requète pour supprimer un poi

Propriété	Type	Ordre	Obligatoire	Description
PoiId	Int32	0	True	Identifiant du poi à supprimer
AddressId	Int32	1	True	Identifiant de l'adresse de la poi
FamilyId	Int32	2	True	Identifiant de la famille de la poi
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PoiId": 0,
  "AddressId": 0,
  "FamilyId": 0
}

DeleteReferenceRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ReferenceId	Int32	0	False	Reference to delete identifier
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ReferenceId": 0
}

DeleteWebProfileRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ProfileId	Int32	0	False	Profile id to delete
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ProfileId": 0
}

EDIRequest

Requête d'import de fichier EDI

Propriété	Type	Ordre	Obligatoire	Description
ConfigurationCode	String	0	True	Code configuration EDI
FileToIntegrate	Byte[]	1	True	Fichier à intégrer
OptionalName	String	2	False	Nom optionnel
DontWaitForProcessResponse	Boolean	3	False	Ne pas attendre la fin d'execution du process. Le retour s'effectue une fois la demande EDI transmise
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ConfigurationCode": null,
  "FileToIntegrate": null,
  "OptionalName": null,
  "DontWaitForProcessResponse": false
}

ESortMode

Mode de tri des factures

Nom	Valeur
Date	1
BillNumber	2

EnsureEmailIsLinkedToQuoteRequest

Requete savoir si le numéro de devis et l'email envoyé sont bien associés au même ordre de transport

Propriété	Type	Ordre	Obligatoire	Description
QuoteId	Int32	0	True	Id du devis a chercher
ClientEmail	String	1	True	Email associé au devis
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "QuoteId": 0,
  "ClientEmail": null
}

ExistCustomerRequest

Requête de la méthode ExistCustomer

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code du client
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

ExistUserRequest

Requête de la méthode ExistUser

Propriété	Type	Ordre	Obligatoire	Description
UserToCheckCode	String	0	True	Code de l'utilisateur
AlsoCheckWebIdentifier	Boolean	1	True	Vérifier aussi l'identifiant WEB
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "UserToCheckCode": null,
  "AlsoCheckWebIdentifier": false
}

FamilyServicePicto

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
PictoName	String	0	False	Nom du pictogramme ('Avion, Camion, Véhicule léger, Moto, Scooter, Bateau,...')
ServiceFamilyCode	List`1 - String	1	False	Liste des codes de famille de prestation associés

{
  "PictoName": null,
  "ServiceFamilyCode": []
}

FavoritesOrderingPartyRequest

Requete de récupération des adresses favorites d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
OrderingPartyCode	String	-1	True	Code du donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "OrderingPartyCode": null,
  "Credential": null
}

FavoritesUserAddressRequest

Requete de récupération des adresses favorites d'un client

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	-1	True	Code du client
Credential	Credential	-1	True	Objet d'identification

{
  "CustomerCode": null,
  "Credential": null
}

FindAddressByGeocodingRequest

Requête permettant d'obtenir des suggestions d'adresses à l'aide de coordonnées géographiques

Propriété	Type	Ordre	Obligatoire	Description
Latitude	Single	0	False	Latitude
Longitude	Single	1	False	Longitude
MaxResults	Int32	2	False	Nombre maximum de résultats à retourner
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Latitude": 0.0,
  "Longitude": 0.0,
  "MaxResults": 0
}

FindAddressSuggestionsRequest

Requête permettant d'obtenir des suggestions d'adresses à l'aide d'une chaîne de caractère

Propriété	Type	Ordre	Obligatoire	Description
CountryCode	String	0	False	Code pays
Query	String	1	False	Chaîne de caractère utilisée pour la recherche (commence par)
MaxResults	Int32	2	False	Nombre maximum de résultats à retourner
GeoXY	GeoData	3	False	Coordonnées géospaciales permettant de focus une zone géographique
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CountryCode": null,
  "Query": null,
  "MaxResults": 0
}

GenerateReportRequest

Génération de reporting Dispatch

Propriété	Type	Ordre	Obligatoire	Description
ReportType	Int32	0	True	Pas de description
ReportConf	String	1	True	Pas de description
GZipped	Boolean	2	True	Pas de description
Reserved	String	-1	False	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Reserved": null,
  "Credential": null,
  "ReportType": 0,
  "ReportConf": null,
  "GZipped": false
}

GeocodeAddressRequest

Requete d'appel à la méthode GeocodeAddress permettant de récupérer la latitude et longitude d'une adresse

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	True	Addresse à géocoder
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Address": null
}

GetAddressByLocationIdRequest

Requête de récupération d'une adresse à l'aide de son identifiant

Propriété	Type	Ordre	Obligatoire	Description
LocationId	String	0	False	Identifiant de la suggestion d'adresse récupéré via la méthode Json/FindAddressSuggestions
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "LocationId": null
}

GetAddressFromExternCodeRequest

Requete de récupération d'une adresse par code externe

Propriété	Type	Ordre	Obligatoire	Description
AgencyCode	String	-1	True	Code agence de l'adresse
ExternCode	String	-1	True	Code externe de l'adresse
Credential	Credential	-1	True	Objet d'identification

{
  "AgencyCode": null,
  "ExternCode": null,
  "Credential": null
}

GetAllClientRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
LoadCustomCustomerParameters	Boolean	0	False	permet de charger les paramètres personnalisé directement dans les objets customer
LoadOnlyCodeAndLabel	Boolean	1	False	Ne charge que les codes et libellés des clients rattachés au donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "LoadCustomCustomerParameters": false,
  "LoadOnlyCodeAndLabel": false
}

GetAllowedFilesTypesRequest

Requête de récupération des types de fichiers autorisés lors des processus de téléversement

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

GetAllowedPackageConfigRequest

Paramètre de la requete de récupération de l'ensemble des familles et natures de colis accessible à un client

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code client Dispatch
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetAnnouncedPackagesHistoryRequest

Requête de recherche dans l'historique des colis annoncé

Propriété	Type	Ordre	Obligatoire	Description
FromAnnouncedPackageId	Int32 nullable	0	False	Identifiant à partir duquel récupérer les entrées de l'historique de colis annoncé
FromDate	DateTime nullable	0	False	Date début de la recherche dans l'historique de colis annoncé
ToDate	DateTime nullable	0	False	Date de fin de la recherche dans l'historique de colis annoncé
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

GetApiBaseUrlRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

GetAssociatedPODRequest

Récupération d'une preuve de livraison

Propriété	Type	Ordre	Obligatoire	Description
IdOt	Int32	0	False	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "IdOt": 0
}

GetAttachedFilesShipmentRequest

Requete pour récupérer la liste des fichiers rattachés à un ordre de transport en attentes de transfert au serveur Dispatch.

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	False	Numéro de l'ordre de transport
GuidTemporaryShipment	String	1	True	Guid temporaire de l'ordre de transport
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalShipmentId": 0,
  "GuidTemporaryShipment": null
}

GetBestShuttleScheduleRequest

Requête de recherche des horaires de la meilleure navettes correspondant aux critères

Propriété	Type	Ordre	Obligatoire	Description
GroupId	Int32	0	False	Identifiant du groupe d'ordres réguliers
PickupAddressId	Int32	1	False	Identifiant de l'adresse d'enlèvement
DeliveryAddressId	Int32	2	False	Identifiant de l'adresse de livraison
ScheduledPickupDate	DateTime	3	False	Date d'enlèvement du colis
ScheduledDeliveryDate	DateTime	4	False	Date de livraison du colis
ScheduledDateMode	ShuttleScheduleDateMode	5	False	Mode de rechercherche de la meilleure navette
LoadShuttleRoadmap	Boolean	6	False	Chargement de la feuille de route de la navette
LoadShuttleLogs	Boolean	7	False	Chargement des logs de calcul de route de la navette
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GroupId": 0,
  "PickupAddressId": 0,
  "DeliveryAddressId": 0,
  "ScheduledDateMode": 0
}

GetBillPaymentsRequest

Permet de récupérer les règlements d'une facture

Propriété	Type	Ordre	Obligatoire	Description
InternalBillId	Int32	0	True	Identifiant de la facture (obligatoire)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalBillId": 0
}

GetBillReportRequest

Requête de récupération de relevé de facture

Propriété	Type	Ordre	Obligatoire	Description
BillSheetId	Int32	0	True	Identifiant interne de facture
ReportType	String	1	False	Type de report pdf/xls (par défault pdf)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "BillSheetId": 0,
  "ReportType": null
}

GetBillRequest

Requête de récupération d'une facture

Propriété	Type	Ordre	Obligatoire	Description
BillSheetId	Int32	0	True	Identifiant interne de facture
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "BillSheetId": 0
}

GetClientAdressRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Pas de description
CheckAgencyAddress	Boolean	1	False	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null,
  "CheckAgencyAddress": false
}

GetClientCustomFieldRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code client
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetClientEDIBuilderConfRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetClientPOIRequest

Requete de récupération des POI d'un client

Propriété	Type	Ordre	Obligatoire	Description
ClientCodeList	List`1 - String	0	True	Liste des codes client attachés aux POI (obligatoire)
FamillyIdList	List`1 - Int32	1	False	Restreindre la recherche à certaines familles de POI
MaxPOIToReturn	Int32 nullable	2	False	Nombre de POI maximum à retourner (borné à 10 000 si pas de valeur)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ClientCodeList": null,
  "FamillyIdList": null,
  "MaxPOIToReturn": null
}

GetClientReferencesRequest

Paramètre de récupération des références clients

Propriété	Type	Ordre	Obligatoire	Description
ClientCode	String	0	True	Code du client avec référence assossiée aux références (Obligatoire)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ClientCode": null
}

GetClientRegularOrdersGroupsRequest

Requête de recherche des groupes d'ordres réguliers d'un client

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	False	Code du client
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetClientRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Pas de description
LoadCustomFields	Boolean	1	False	Charge le paramètre personnalisés lié au client
LoadCustomerTags	Boolean	2	False	Charge les tags liés au client
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null,
  "LoadCustomFields": false,
  "LoadCustomerTags": false
}

GetClientServiceRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	False	Pas de description
PackageType	String	1	False	Pas de description
Date	DateTime nullable	2	False	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null,
  "PackageType": null,
  "Date": null
}

GetClientSpecificServicesRequest

Requete de récupération des prestations autorisées spécifiquement pour le client choisi

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetCustomFieldsConfigRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ConfigName	String	0	True	Nom de la configuration à charger
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ConfigName": null
}

GetCustomMissionsViewProfileRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Profile	MissionsProfileType	0	False	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Profile": 1
}

GetCustomerVoucherPricingScaleRequest

Paramètre de récupération d'une grille tarifaire en bon d'un client

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	False	Code du client
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetDailyTrackHistoryFromIdRequest

Requète pour récupérer une à plusieurs feuille de route journalière pour un boitier GPS

Propriété	Type	Ordre	Obligatoire	Description
GeoDeviceId	Int32	0	False	Identifiant du boitier GPS
StartRoadMapUtcDate	DateTime	1	True	Premier jour de récupération des feuilles de route
EndRoadMapUtcDate	DateTime	2	True	Dernier jour de récupération des feuilles de route
LoadSteps	Boolean	3	True	Charger chacune des étapes de la feuille de route en plus de synthèse (A n'utiliser qu'en cas de besoin car cela peut provoquer une charge importante sur le serveur)
GeoDeviceGuid	Guid	4	False	Identifiant unique du boitier GPS (valable à partir de la version Dispatch 3.47)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GeoDeviceId": 0,
  "StartRoadMapUtcDate": "\/Date(-62135596800000)\/",
  "EndRoadMapUtcDate": "\/Date(-62135596800000)\/",
  "LoadSteps": false,
  "GeoDeviceGuid": "00000000-0000-0000-0000-000000000000"
}

GetDelegatorRequest

Requête permettant d'obtenir le token de session d'un donneur d'ordre délégateur à l'aide des credentials d'un de ses donneurs d'ordres délégué

Propriété	Type	Ordre	Obligatoire	Description
DelegatorOrdererCode	String	0	True	Code du donneur d'ordre délégateur
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "DelegatorOrdererCode": null
}

GetDonneurOrdreClientsRequest

Requête de recherche des clients d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

GetECommerceCredentialsRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ECommerceKey	String	0	True	Pas de description
AgencyCode	String	1	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ECommerceKey": null,
  "AgencyCode": null
}

GetExportModelRequest

Paramètre de récupération des models d'export client

Propriété	Type	Ordre	Obligatoire	Description
ClientList	List`1 - String	0	True	Liste des clients dont on veut récupérer la listes des exports disponibles
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ClientList": null
}

GetGeoDeviceTrackFromIdRequest

Requète pour récupérer tout les points d'une trace d'un boitier sur une période

Propriété	Type	Ordre	Obligatoire	Description
GeoDeviceId	Int32	0	False	Identifiant du boitier
StartTrackUtcDate	DateTime	1	True	Date de début de la période de la trace
EndTrackUtcDate	DateTime	2	True	Date de fin de la période de la trace
SmoothRoad	Boolean	3	False	La trace est affiné via calcul d'itinéraire routier
GeoDeviceGuid	Guid	4	False	Identifiant unique du boitier GPS (valable à partir de la version Dispatch 3.47)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GeoDeviceId": 0,
  "StartTrackUtcDate": "\/Date(-62135596800000)\/",
  "EndTrackUtcDate": "\/Date(-62135596800000)\/",
  "SmoothRoad": false,
  "GeoDeviceGuid": "00000000-0000-0000-0000-000000000000"
}

GetGroupeOrdresReguliersAdressesRequest

Requête de recherche des adresses liées à un groupe d'ordres réguliers

Propriété	Type	Ordre	Obligatoire	Description
GroupId	Int32	0	False	Identifiant du groupe
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GroupId": 0
}

GetImportShipmentsStatusRequest

Permet d'obtenir le statut d'un import de missions

Propriété	Type	Ordre	Obligatoire	Description
OnlySpecifiedImportIds	List`1 - Int32	0	False	Si présent, permet de récupérer uniquement les statuts des imports spécifiés
IncludeInternalShipmentsIdsInResponse	Boolean	1	False	Inclure les identifiants de missions internes dans la réponse
IncludeDetailedStatus	Boolean	2	False	Permet de récupérer le statut déttaillé pour chaque ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OnlySpecifiedImportIds": null,
  "IncludeInternalShipmentsIdsInResponse": false,
  "IncludeDetailedStatus": false
}

GetInternalReportGenerationResultRequest

Permet de télécharger le report généré à partir de la méthode InitInternalGenerateReport

Propriété	Type	Ordre	Obligatoire	Description
PrivateKey	String	0	True	Clé permettant l'accès à cet appel
Token	String	1	True	Token obtenu avec la méthdode InitInternalGenerateReport
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PrivateKey": null,
  "Token": null
}

GetLastAddressRequest

Paramètre de la méthode GetLastAddress

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Compte client utilisé qui a commandé les missions (obligatoire)
MaxAddressToReturn	Int32	1	False	Nombre d'adresse maximum à retourner (75 par défaut=, ce nombre ne peut dépasser 300
TypePickDel	Int32	2	False	Adresse utilisée à l'enlèvement : 0, Adresse utilisée à la livraison 1
ReturnCompleteAddress	Boolean	3	False	Vrai : retourne une adresse complete, faux retourne uniquement l'id et le nom de l'adresse
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null,
  "MaxAddressToReturn": 0,
  "TypePickDel": 0,
  "ReturnCompleteAddress": false
}

GetOrdererGeoDevicesRequest

Requète pour récupérer tout les boitiers associés à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

GetOrdererPointOfInterestDetailsRequest

Requète pour récupérer l'adresse formatée d'un POI associée à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Identifier	String	0	True	Identifiant du POI
FamilyId	Int32	1	True	Id de la famille associée à la POI
AddressId	Int32	2	True	Id de l'adresse associée à la POI
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Identifier": null,
  "FamilyId": 0,
  "AddressId": 0
}

GetOrdererPointsOfInterestRequest

Requète pour récupérer la liste des familles de POI associé à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
MaxPointsOfInterestToReturn	Int32 nullable	0	False	Nombre max de POI retourné
LoadOnlyFamilies	Boolean	1	False	Charge seulement l'id et le nom des famille de POI
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "MaxPointsOfInterestToReturn": null,
  "LoadOnlyFamilies": false
}

GetOrdererRoundSheetRequest

Requête de génération d'une feuille de tournée

Propriété	Type	Ordre	Obligatoire	Description
RoundId	Int32	0	False	Id de la tournée
OrdererCode	String	1	False	Code du donneur d'ordre
CustomerCodes	List`1 - String	2	False	Liste des codes clients
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "RoundId": 0,
  "OrdererCode": null,
  "CustomerCodes": null
}

GetOrdererRoundsRequest

Requête de recherche de tournées

Propriété	Type	Ordre	Obligatoire	Description
PageNumber	Int32	0	False	Index de la page
ResultLimit	Int32	1	False	Nombre maximum de résultats
SortBy	String	2	False	Clé d'ordonnancement
SortAsc	Boolean	3	False	Sens de l'ordonnancement
RoundId	Int32 nullable	4	False	Id de la tournée
RoundLabel	String	5	False	Libellé de la tournée
RoundDriverId	Int32 nullable	6	False	Identifiant du chauffeur
RoundIsLate	Boolean nullable	7	False	Rechercher uniquement les tournées en retard ou non
RoundStatuses	List`1 - OrdererRoundStatus	8	False	Liste des status des tournées
DateSearchSelector	DateSearchSelectorType	9	False	Filtre de recherche sur les dates de tournée
StartRoundReferenceLocalDateTime	DateTime nullable	10	False	Date de référence de départ des tournées
EndRoundReferenceLocalDateTime	DateTime nullable	11	False	Date de référence de fin des tournées
StartRoundEstimatedStartLocalDateTime	DateTime nullable	12	False	Filtre sur la date de début estimée du départ des tournées
EndRoundEstimatedStartLocalDateTime	DateTime nullable	13	False	Filtre sur la date de fin estimée du départ des tournées
StartRoundEstimatedEndLocalDateTime	DateTime nullable	14	False	Filtre sur la date de début d'arrivée estimée des tournées
EndRoundEstimatedEndLocalDateTime	DateTime nullable	15	False	Filtre sur la date de fin d'arrivée estimée des tournées
TransportMissionId	Int32 nullable	16	False	Identifiant du transport
TransportOrdererCode	String	17	False	Filtre sur le code donneur d'ordre défini sur le transport
TransportCustomerCodes	List`1 - String	18	False	Liste des codes clients des transports
TransportReference1	String	19	False	Référence 1 des transports
TransportReference2	String	20	False	Référence 2 des transports
TransportReference3	String	21	False	Référence 3 des transports
TransportPickupStepLabel	String	22	False	Libellé de l'enlèvement des étapes
TransportPickupStepStreetLabel	String	23	False	Libellé de la rue de l'enlèvement des étapes
TransportPickupStepPostalCode	String	24	False	Code postal de l'enlèvement des étapes
TransportPickupStepCity	String	25	False	Ville d'enlèvement des étapes
TransportPickupStepCountry	String	26	False	Pays de l'enlèvement des étapes
TransportPickupStepAddressId	Int32 nullable	27	False	Identifiant de l'addresse d'enlèvement des étapes
TransportDeliveryStepLabel	String	28	False	Libellé de livraison des étapes de transport
TransportDeliveryStepStreetLabel	String	29	False	Libellé de la rue de livraison des étapes
TransportDeliveryStepPostalCode	String	30	False	Code postal de livraison des étapes
TransportDeliveryStepCity	String	31	False	Ville de livraison des étapes
TransportDeliveryStepCountry	String	32	False	Pays de livraison des étapes
TransportDeliveryStepAddressId	Int32 nullable	33	False	Identifiant de l'adresse de livraison des étapes
PackageCode	String	34	False	Code du colis
PackageBarcode	String	35	False	Code-à-barres du colis
PackageNature	String	36	False	Nature du colis
PackageReference1	String	37	False	Référence 1 du colis
PackageReference2	String	38	False	Référence 2 du colis
PackageReference3	String	39	False	Référence 3 du colis
PackageReference4	String	40	False	Référence 4 du colis
PackageReference5	String	41	False	Référence 5 du colis
PackageReference6	String	42	False	Référence 6 du colis
PackageReference7	String	43	False	Référence 7 du colis
PackageReference8	String	44	False	Référence 8 du colis
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PageNumber": 0,
  "ResultLimit": 0,
  "SortBy": null,
  "SortAsc": false,
  "RoundId": null,
  "RoundLabel": null,
  "RoundDriverId": null,
  "RoundIsLate": null,
  "RoundStatuses": null,
  "DateSearchSelector": 0,
  "StartRoundReferenceLocalDateTime": null,
  "EndRoundReferenceLocalDateTime": null,
  "StartRoundEstimatedStartLocalDateTime": null,
  "EndRoundEstimatedStartLocalDateTime": null,
  "StartRoundEstimatedEndLocalDateTime": null,
  "EndRoundEstimatedEndLocalDateTime": null,
  "TransportMissionId": null,
  "TransportOrdererCode": null,
  "TransportCustomerCodes": null,
  "TransportReference1": null,
  "TransportReference2": null,
  "TransportReference3": null,
  "TransportPickupStepLabel": null,
  "TransportPickupStepStreetLabel": null,
  "TransportPickupStepPostalCode": null,
  "TransportPickupStepCity": null,
  "TransportPickupStepCountry": null,
  "TransportPickupStepAddressId": null,
  "TransportDeliveryStepLabel": null,
  "TransportDeliveryStepStreetLabel": null,
  "TransportDeliveryStepPostalCode": null,
  "TransportDeliveryStepCity": null,
  "TransportDeliveryStepCountry": null,
  "TransportDeliveryStepAddressId": null,
  "PackageCode": null,
  "PackageBarcode": null,
  "PackageNature": null,
  "PackageReference1": null,
  "PackageReference2": null,
  "PackageReference3": null,
  "PackageReference4": null,
  "PackageReference5": null,
  "PackageReference6": null,
  "PackageReference7": null,
  "PackageReference8": null
}

GetOrderingPartiesForCustomerRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code du client sur 10 caractères
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetOrderingPartyRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrdererCodeToLoad	String	0	True	Code du donneur d'ordre à charger
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OrdererCodeToLoad": null
}

GetPOIDetailsRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Identifier	String	0	True	Identifiant du POI
FamilyId	Int32	1	True	Id de la famille associée à la POI
CustomerCode	String	2	True	Code client rattaché à la famille de POI
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Identifier": null,
  "FamilyId": 0,
  "CustomerCode": null
}

GetPackageRouteInfoRequest

Requete de récupération de la trace GPS d'un colis

Propriété	Type	Ordre	Obligatoire	Description
PackageBarcode	String	0	True	Code barre du colis
ClientCode	String	1	True	Code client rattaché au colis
SmoothRoute	Boolean	2	False	Calcul de l'itinéraire affiné par distancier
EstimateArrivalDate	Boolean	3	False	Non actif pour le moment
DateUtcFrom	DateTime nullable	4	False	Date à partir de laquelle on souhaite télécharger la trace
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PackageBarcode": null,
  "ClientCode": null,
  "SmoothRoute": false,
  "EstimateArrivalDate": false,
  "DateUtcFrom": null
}

GetPackageTypeRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	-1	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "CustomerCode": null,
  "Credential": null
}

GetParameterCompanyRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
LicenceCode	String	0	True	Pas de description
AgencyCode	String	1	False	Pas de description

{
  "LicenceCode": null,
  "AgencyCode": null
}

GetPointsOfInterestRawDataRequest

Requète pour récupérer l'adresse formatée d'un POI associée à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
FamilyId	Int32	0	True	Id de la famille associée à la POI
MaxResult	Int32	1	True	Nombre de résultat maximum par request
PoiPartToStartSearch	String	2	False	Commence la recherche à partir de cet index
LastPoiLoaded	Int32	3	False	Dernier poi chargé dans le cas d'un scroll
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "FamilyId": 0,
  "MaxResult": 0,
  "PoiPartToStartSearch": null,
  "LastPoiLoaded": 0
}

GetPublicMarketCredentialRequest

Requête permettant d'obtenir les informations d'identification d'un donneur d'ordre ECommerce

Propriété	Type	Ordre	Obligatoire	Description
MarketKey	String	0	True	Clé ECommerce
AgencyCode	String	1	True	Code agence du ECommerce
CredentialType	CredentialType	2	True	Type d'utilisateur ECommerce (0 = professionnel, 1 = particulier)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "MarketKey": null,
  "AgencyCode": null,
  "CredentialType": 0
}

GetReferenceRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ReferencePart	String	0	True	partie de la référence recherchée (Obligatoire)
ClientCode	String	1	True	Code du client avec référence assossiée aux références (Obligatoire)
DispatchUserCode	String	2	False	Code du donneur avec référence associée aux références
TypeReference	Int32	3	False	Type de référence 1,2 ou 3
MaxResult	Int32	4	False	Nombre de résultat maximum retourné (Default 30)
ReferenceMustExactlyMatch	Boolean	5	False	La référence doit correspondre exactement : on fait une recherche d'égalité stricte
ReferenceLabelToStartSearch	String	6	False	Libellé de référence à partir du quel récupérer les MaxResult résults prochains résultats, utile pour faire de l'inifinite scroll
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ReferencePart": null,
  "ClientCode": null,
  "DispatchUserCode": null,
  "TypeReference": 0,
  "MaxResult": 0,
  "ReferenceMustExactlyMatch": false,
  "ReferenceLabelToStartSearch": null
}

GetRegularTransportsListRequest

Requête de la méthode GetRegularOrdersList permettant de récuperer la liste des ordres réguliers d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
CustomerCodesList	List`1 - String	0	False	Liste des codes clients pour lesquels récupérer les ordres réguliers (null == tout les ordres réguliers du donneur d'ordre)
StartDate	DateTime nullable	1	False	Filtrage des ordres réguliers actifs sur une période : Date de début de la période
EndDate	DateTime nullable	2	False	Filtrage des ordres réguliers actifs sur une période : Date de fin de la période
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCodesList": null,
  "StartDate": null,
  "EndDate": null
}

GetReportModelRequest

Paramètre de récupération des models de report client

Propriété	Type	Ordre	Obligatoire	Description
ClientList	List`1 - String	0	True	Liste des clients dont on veut récupérer la listes des reports disponibles
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ClientList": null
}

GetRevokedGeoDeviceAlertsRequest

Requète pour récupérer l'historique des suppressions d'alertes

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	True	Identifiant interne de mission (Numéro de transport)
AlertType	GeoDeviceAlertType	1	False	Types d'alerte (temperature
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalShipmentId": 0,
  "AlertType": 0
}

GetShipmentCreationConfigurationRequest

Requete de chargement de la configuration de saisie d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
CustomerCode	String	0	True	Code client sélectionné pour crée la mission (Obligatoire)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCode": null
}

GetShipmentInformationListByMissionRequest

Requête de la méthode GetShipmentInformationListByMission

Propriété	Type	Ordre	Obligatoire	Description
MissionId	Int32	0	False	Identifiant de mission
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "MissionId": 0
}

GetShipmentRouteInfoRequest

Requete permettant de récupérer la trace du chauffeur sur une mission

Propriété	Type	Ordre	Obligatoire	Description
InternalOrderId	Int32 nullable	0	False	ID_OT / Shipment.InternalId
DateUtcFrom	DateTime nullable	1	False	(Possibilité d'utiliser la propriété FromSeconds pour un usage plus aisé en javascript) Restreindre la récupération des données à partir d'une date pour accèlérer la récupération, cas ou l'on a déjà récupéré la trace et que l'on veut juste un suivi temps réeel
SmoothRoute	Boolean	2	False	Si true alors la trace GPS est lissée via un calcul d'itinéraire cartographique
ShipmentId	Int32 nullable	3	False	Numéro de mission
FromSeconds	Int32 nullable	4	False	Only retreive position from last seconds
NextApproachComputationDate	Date	5	False	Send last NextApproachComputationDate result, if null a new approach computation is returned if possible
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalOrderId": null,
  "DateUtcFrom": null,
  "SmoothRoute": false,
  "ShipmentId": null,
  "FromSeconds": null,
  "NextApproachComputationDate": null
}

GetShipmentStatusRequest

Requète de récupération de statut d'une mission

Propriété	Type	Ordre	Obligatoire	Description
MissionId	Int32	0	True	Numéro de mission
InternalMissionId	Int32 nullable	1	False	Numéro interne de la mission (à utiliser dans le cas de suivi de mission en plusieurs parties (aller-retour))
IsQuote	Boolean	2	False	MissionId correspond à un numéro de devis
TrackId	String	3	False	TrackId de la mission
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "MissionId": 0,
  "InternalMissionId": null,
  "IsQuote": false,
  "TrackId": null
}

GetStatisticsRequest

Paramètre de request pour le téléchargement de statistiques

Propriété	Type	Ordre	Obligatoire	Description
StatisticsModel	StatisticsModel	0	False	Model de report utilisé
OutputFormat	eOutputExportOrderType	1	False	Enumération du type de fichier de sortie
StatsFilter	GetStatisticsFilter	3	False	Filtre pour le téléchargement de statistiques
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "StatisticsModel": null,
  "OutputFormat": 0,
  "StatsFilter": null
}

GetSubServicesRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ServiceCode	String	0	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ServiceCode": null
}

GetSubcontractorEmployeesRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
SubcontractorId	Int32	0	False	Identifiant du sous-traitant
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "SubcontractorId": 0
}

GetTrackedMissionDetailsRequest

Requête de recherche du détail de tracking d'un OR

Propriété	Type	Ordre	Obligatoire	Description
RegularOrderId	Int32	0	False	Identifiant de l'ordre régulier
ExecutionUtcDate	DateTime	1	False	Date d'exécution du tracking
MissionId	Int32 nullable	2	False	Permet de charger les informations de tracking grâce au numéro de mission plustot que par l'id d'ordre régulier
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "RegularOrderId": 0,
  "ExecutionUtcDate": "\/Date(-62135596800000)\/",
  "MissionId": null
}

GetTrackedMissionsRequest

Requête de recherche des missions trackées

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Codes des clients
StartUtcDate	DateTime nullable	1	False	Date de début de recherche
EndUtcDate	DateTime nullable	2	False	Date de fin de recherche
RoundsIds	List`1 - Int32	3	False	Identifiant des ordres réguliers à filtrer
AddressesIds	List`1 - Int32	4	False	Identifiants des adresses à filtrer
CitiesIds	List`1 - Int32	5	False	Identifiants des villes à filtrer
AnomaliesCodes	List`1 - String	6	False	Code des anomalies à filtrer
Pagination	ListPagination	7	False	Configuration de la pagination du résultat
MissionStateCodes	List`1 - String	8	False	Codes état de mission
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "StartUtcDate": null,
  "EndUtcDate": null,
  "RoundsIds": null,
  "AddressesIds": null,
  "CitiesIds": null,
  "AnomaliesCodes": null,
  "Pagination": null,
  "MissionStateCodes": null
}

GetTrackedPackagesHistoryRequest

Requête de recherche dans l'historique des colis tracké

Propriété	Type	Ordre	Obligatoire	Description
FromTrackedPackageId	Int32 nullable	0	False	Identifiant à partir duquel récupérer les entrées de l'historique de colis trackés
FromDate	DateTime nullable	0	False	Date début de la recherche dans l'historique de colis tracké
ToDate	DateTime nullable	0	False	Date de fin de la recherche dans l'historique de colis tracké
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

GetTrackedPackagesRequest

Requête de recherche des colis trackés

Propriété	Type	Ordre	Obligatoire	Description
WayPointPackageStartUtcDate	DateTime nullable	1	False	Début date de scan sur les colis
WayPointPackageEndUtcDate	DateTime nullable	2	False	Fin date de scan sur les colis
PackagesBarcodes	List`1 - String	3	False	Codes barres des colis
CustomersCodes	List`1 - String	4	False	Codes clients
PackagesIds	List`1 - Int32	5	False	Idendifiants des colis
Pagination	ListPagination	6	False	Configuration de la pagination du résultat
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "WayPointPackageStartUtcDate": null,
  "WayPointPackageEndUtcDate": null,
  "PackagesBarcodes": null,
  "CustomersCodes": null,
  "PackagesIds": null,
  "Pagination": null
}

GetTrackedRegularOrdersReportModelRequest

Paramètre de récupération des models de report client

Propriété	Type	Ordre	Obligatoire	Description
ClientList	List`1 - String	0	False	Liste des clients dont on veut récupérer la listes des reports disponibles
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ClientList": null
}

GetTrackedRegularTransportsRequest

Requête de recherche des ordres réguliers trackés

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Codes des clients
RegularTransportsIds	List`1 - Int32	0	False	Identifiant des ordres réguliers à filtrer
Pagination	ListPagination	0	False	Configuration de la pagination du résultat
OnlyActive	Boolean	0	False	Seulement les ordres réguliers actifs
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "RegularTransportsIds": null,
  "Pagination": null,
  "OnlyActive": false
}

GetTrackedWayPointsRequest

Requête de recherche des points de passage trackés

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Codes clients
MissionExecutionStartUtcDate	DateTime nullable	1	False	Début date d'exécution de la mission
MissionExecutionEndUtcDate	DateTime nullable	2	False	Fin date d'exécution de la mission
WayPointStartUtcDate	DateTime nullable	3	False	Début date de scan sur les points de passage
WayPointEndUtcDate	DateTime nullable	4	False	Fin date de scan sur les points de passage
RegularTransportsIds	List`1 - Int32	5	False	Identifiants ordres réguliers
AddressesIds	List`1 - Int32	6	False	Identifiants d'adresses
CitiesIds	List`1 - Int32	7	False	Identifiants de villes
AnomaliesCodes	List`1 - String	8	False	Codes anomalies
DriversIds	List`1 - Int32	9	False	Identifiants chauffeurs
MissionsIds	List`1 - Int32	10	False	Identifiants de missions
LoadAnnouncedPackages	Boolean	11	False	Charge les annonces de colis dans le résultat
MissionStateCodes	List`1 - String	12	False	Codes états de mission
OrderingPartyCode	String	13	False	Code du donneur d'ordre
LanguageCode	String	14	False	Code langage utilisateur
WayPointPackageStartUtcDate	DateTime nullable	15	False	Début date de scan sur les colis
WayPointPackageEndUtcDate	DateTime nullable	16	False	Fin date de scan sur les colis
PackagesBarcodes	List`1 - String	17	False	Codes barres des colis
LoadAnnouncedPackagesOnlyForLoadedWayPointPackages	Boolean	18	False	Charge uniquement les annonces de colis correspondants aux colis remontés dans le résultat
Pagination	ListPagination	19	False	Configuration de la pagination du résultat
LoadOrderingPartyFavoriteWaypoints	Boolean	20	False	Charge les points de passage passant par les adresses favorites du donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "MissionExecutionStartUtcDate": null,
  "MissionExecutionEndUtcDate": null,
  "WayPointStartUtcDate": null,
  "WayPointEndUtcDate": null,
  "RegularTransportsIds": null,
  "AddressesIds": null,
  "CitiesIds": null,
  "AnomaliesCodes": null,
  "DriversIds": null,
  "MissionsIds": null,
  "LoadAnnouncedPackages": false,
  "MissionStateCodes": null,
  "OrderingPartyCode": null,
  "LanguageCode": null,
  "WayPointPackageStartUtcDate": null,
  "WayPointPackageEndUtcDate": null,
  "PackagesBarcodes": null,
  "LoadAnnouncedPackagesOnlyForLoadedWayPointPackages": false,
  "Pagination": null,
  "LoadOrderingPartyFavoriteWaypoints": false
}

GetTrackyPictoForServiceRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ServiceCode	String	0	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ServiceCode": null
}

GetTranslationsRequest

Requête de recherche des groupes d'ordres réguliers d'un client

Propriété	Type	Ordre	Obligatoire	Description
LocalizationStrings	List`1 - String	0	False	Liste des traductions voulues sous la forme de 'localization string'
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "LocalizationStrings": null
}

GetTransportTemperaturesRequest

Requête de la méthode GetTransportTemperatures

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	False	Identifiant interne du transport
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalShipmentId": 0
}

GetUserWebProfileRequest

Paramètre de la requete de chargement d'un profil web

Propriété	Type	Ordre	Obligatoire	Description
IdProfil	Int32	0	True	Numéro du profil
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "IdProfil": 0
}

GetWebUserRightRequest

Paramètre de la requête permettant de récupérer les droits

Propriété	Type	Ordre	Obligatoire	Description
GetOnlyRightForUser	Boolean	0	False	Retourne uniquement les droits de l'utilisateur si vrai, sinon retourne la liste complète des droits
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GetOnlyRightForUser": false
}

ImportClientSpecificServiceRequest

Permet d'ajouter ou de modifier une prestation sélectionnable par le client

Propriété	Type	Ordre	Obligatoire	Description
Service	ClientServiceImport	0	True	Prestation à importer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Service": null
}

ImportCustomerRequest

Permet de créer ou de modifier un client

Propriété	Type	Ordre	Obligatoire	Description
CustomerToImport	CustomerImport	0	True	Client à importer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerToImport": null
}

ImportShipmentsRequest

Requête pour importer des missions

Propriété	Type	Ordre	Obligatoire	Description
ImportConfigurationName	String	0	True	Nom de la configuration d'import
DataToImport	Byte[]	1	True	Données à importer
Filename	String	2	False	Nom du fichier à importer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ImportConfigurationName": null,
  "DataToImport": null,
  "Filename": null
}

ImportUserRequest

Permet de créer ou de modifier un utilisateur

Propriété	Type	Ordre	Obligatoire	Description
UserToImport	UserImport	0	True	User à importer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "UserToImport": null
}

InitDailyGeoDeviceReportRequest

Paramètre de demande pour un report sur un geo device

Propriété	Type	Ordre	Obligatoire	Description
DailyGeoDeviceReport	DailyGeoDeviceReport	0	False	Paramétrage de la demande
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "DailyGeoDeviceReport": null
}

InitGetRegularTransportStatisticsDocumentRequest

Propriété	Type	Ordre	Obligatoire	Description
UtcDateFrom	DateTime	0	False	Date de début de recherche (UTC)
UtcDateTo	DateTime	1	False	Date de fin de recherche (UTC)
CustomerCodes	List`1 - String	2	False	Codes clients
DriverCodes	List`1 - String	3	False	Codes chauffeurs
RegularOrderCodes	List`1 - String	4	False	Codes ordres réguliers
CompanyCodes	List`1 - String	5	False	Codes sociétés
AgencyCodes	List`1 - String	6	False	Codes agences
ActiveOrders	Boolean	7	False	Filtrer sur les ordres actifs
DeprecatedOrders	Boolean	8	False	Prendre en compte les ordres périmés
AllOrders	Boolean	9	False	Prendre en compte tous les ordres
ScEveryDay	Boolean	10	False	Planifié tous les jours
ScMonday	Boolean	11	False	Planifié le lundi
ScTuesday	Boolean	12	False	Planifié le mardi
ScWednesday	Boolean	13	False	Planifié le mercredi
ScThursday	Boolean	14	False	Planifié le jeudi
ScFriday	Boolean	15	False	Planifié le vendredi
ScSaturday	Boolean	16	False	Planifié le samedi
ScSunday	Boolean	17	False	Planifié le dimanche
ShowDetails	Boolean	18	False	Voir les détails
IdModel	Int32	19	False	Identifiant du modèle de statistiques
LabelModel	String	20	False	Libellé du modèle de statistiques
FileType	Int32	21	False	Type de fichier (WORD : 3, EXCEL : 4, PDF : 5)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCodes": null,
  "DriverCodes": null,
  "RegularOrderCodes": null,
  "CompanyCodes": null,
  "AgencyCodes": null,
  "ActiveOrders": false,
  "DeprecatedOrders": false,
  "AllOrders": false,
  "ScEveryDay": false,
  "ScMonday": false,
  "ScTuesday": false,
  "ScWednesday": false,
  "ScThursday": false,
  "ScFriday": false,
  "ScSaturday": false,
  "ScSunday": false,
  "ShowDetails": false,
  "IdModel": 0,
  "LabelModel": null,
  "FileType": 0
}

InitInternalGenerateReportRequest

Usage interne

Propriété	Type	Ordre	Obligatoire	Description
PrivateKey	String	0	True	Clé permettant l'accès à cet appel
ReportType	Int32	1	True	Type de report
SerializedReportConfiguration	String	2	True	Configuration du report serialisée
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PrivateKey": null,
  "ReportType": 0,
  "SerializedReportConfiguration": null
}

InitOrderExportRequest

Paramètre de demande d'export d'ordre

Propriété	Type	Ordre	Obligatoire	Description
ExportModel	ExportModel	0	True	Model d'export utilisé
OutputFormat	eOutputExportOrderType	1	True	Format de sortie
OrderFilter	Search	2	False	Filtre de recherche d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ExportModel": null,
  "OutputFormat": 0,
  "OrderFilter": null
}

InitOrderReportGenerationRequest

Paramètre de la requete d'initialisation de génération de documents de transport

Propriété	Type	Ordre	Obligatoire	Description
InternalOrderId	List`1 - Int32	0	False	Liste des Id Ordres de transport (internalShipmentId) pour lesquels générer le document (50 entités au maximum)
ReportType	Int32	1	False	Type de document à générer: 3 pour bordereau de prise en charge, 165 pour une étiquette colis, 4 pour un bordereau lettre de voiture, 0 pour avoir un bordereau transport en fonction de l'état d'avancement de la mission
PaperOptions	ReportPaperOptions	2	False	Options pour le format de papier (taille, orientation, marges) à utiliser lors la génération du document
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalOrderId": null,
  "ReportType": 0,
  "PaperOptions": null
}

InitRegularTransportReportGenerationRequest

Paramètre de la requete d'initialisation de téléchargement de document lié aux ordres réguliers

Propriété	Type	Ordre	Obligatoire	Description
ReportType	Int32	0	False	Type de report à utiliser 172 : feuille de tournée, 179 : document d'une adresse trackée
MissionId	Int32	1	False	Numéro de mission des reports à générer
IdTrackedWayPoint	Int32	2	False	Identifiant de l'adresse trackée
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ReportType": 0,
  "MissionId": 0,
  "IdTrackedWayPoint": 0
}

LegacyCreateShipmentRequest

Legacy create shipment

Propriété	Type	Ordre	Obligatoire	Description
Orderer	OrderingParty	0	True	Pas de description
Shipment	Shipment	1	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Orderer": null,
  "Shipment": null
}

LoadAddressRequest

requete de chargement d'adresse

Propriété	Type	Ordre	Obligatoire	Description
AddressId	Int32	0	True	Identifiant Dispatch de l'adresse (Obligatoire)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "AddressId": 0
}

LoadLikeAddressRequest

requete de recherche d'adresse

Propriété	Type	Ordre	Obligatoire	Description
SearchField	eSearchField	0	False	Champs utilisé pour la recherche Nom, une partie des lignes d'adresse, la rue, (Valeur par défaut Name)
ClientCode	String	1	False	Code client pour rechercher les adresses favorites d'un client (si non spécifié alors c'est le premier client associé au donneur d'ordre qui est utilisé
OrdererCode	String	2	False	Code donneur d'ordre pour rechercher les adresses favorties d'un donneur d'ordre (si non spécifié alors le code du donneur d'ordre spécifié dans le crédential qui est utilisé
MaxResult	Int32 nullable	3	False	Nombre de résultats à retourner (Valeur par défaut 30)
AddressPartMustExactlyMatch	Boolean	4	False	(inutile pour le moment)
AddressPartToStartSearch	String	5	False	Terme utilisé pour la gestion d'infinite scroll
AddressPart	String	6	False	Terme recherche dans le champs SearchField
LoadFullAddressObject	Boolean	7	True	Indique si l'on souhaite obtenir un objet adresse complet (plus lent), ou juste les champs Id, Name, Street
AddressIdToStartSearch	Int32 nullable	8	False	Permet de continuer la recherche sur un infinite scroll dans le cas où le jeux de données est identiques pour le range voulu exemple : 50 fois le même nom d'adresse
OnlyOrdererTrackedAddresses	Boolean	9	False	Permet de charger les adresses trackées d'un donneur d'ordres
OnlyCustomerAddresses	Boolean	10	False	Permet de charger uniquement les adresses clients
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "SearchField": 1,
  "ClientCode": null,
  "OrdererCode": null,
  "MaxResult": 30,
  "AddressPartMustExactlyMatch": false,
  "AddressPartToStartSearch": null,
  "AddressPart": null,
  "LoadFullAddressObject": false,
  "AddressIdToStartSearch": null,
  "OnlyOrdererTrackedAddresses": false,
  "OnlyCustomerAddresses": false
}

LoadLikeAnomaliesTypesRequest

Requête de recherche de types d'anomalies

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Codes clients
MaxResultToReturn	Int32 nullable	1	False	Nombre maximum de résultats retournés
StepAnomaly	String	2	False	Anomaly à partir de laquelle on commence la recherche
SearchedAnomaly	String	3	False	Anomaly recherchée
AnomalySearchMode	SearchMode	4	False	Mode de recherche
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "MaxResultToReturn": 30,
  "StepAnomaly": null,
  "SearchedAnomaly": null,
  "AnomalySearchMode": 1
}

LoadLikeBarcodesRequest

Requête de recherche de codes à barres

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Code clients
MaxResultToReturn	Int32 nullable	1	False	Nombre maximum de résultats retournés
StepBarcode	String	2	False	Code à barres à partir duquel commencer la recherche
SearchedBarcode	String	3	False	Code à barre (ou partie du code à barres) recherché
BarcodeSearchMode	SearchMode	4	False	Mode de recherche
IgnoreSpaces	Boolean	5	False	Ignore les espaces dans le code à barres recherché
StartUtcDate	DateTime nullable	6	False	Début de la période de recherche (UTC)
EndUtcDate	DateTime nullable	7	False	Fin de la période de recherche (UTC)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "MaxResultToReturn": 30,
  "StepBarcode": null,
  "SearchedBarcode": null,
  "BarcodeSearchMode": 1,
  "IgnoreSpaces": false,
  "StartUtcDate": null,
  "EndUtcDate": null
}

LoadLikeDelegatorOrderersRequest

Requete pour le chargement (= recherche) de donneur d'ordres délégateurs permettant un infinite scroll

Propriété	Type	Ordre	Obligatoire	Description
MaxResults	Int32	0	True	Nombre de résultats maximum à retourner
SearchField	eSearchField nullable	1	True	Champs utilisé pour la recherche
SearchType	eSearchType nullable	2	True	Type de recherche à effectuer
Query	String	3	True	Terme à rechercher dans le champs SearchField
LastOrdererCode	String	4	True	Code du dernier donneur d'ordre de la liste (utilisé pour la gestion de l'infinite scroll)
LastOrdererName	String	5	True	Nom du dernier donneur d'ordre de la liste (utilisé pour la gestion de l'infinite scroll)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "MaxResults": 0,
  "SearchField": null,
  "SearchType": null,
  "Query": "",
  "LastOrdererCode": null,
  "LastOrdererName": null
}

LoadLikeLastShipmentAddressRequest

requete de recherche des dernières adresses utilisées en saisie de mission

Propriété	Type	Ordre	Obligatoire	Description
SearchField	eSearchField	0	False	Champs utilisé pour la recherche Nom, id passage
ClientCode	String	1	True	Code client rattaché aux commandes (obligatoire)
OrdererCode	String	2	True	Code donneur d'ordre rattaché aux commandes (obligatoire)
MaxResult	Int32 nullable	3	False	Nombre de résultats à retourner (Valeur par défaut 50)
ShipmentAddressPartMustExactlyMatch	Boolean	4	False	(inutile pour le moment)
ShipmentAddressPartToStartSearch	String	5	False	Terme utilisé pour la gestion d'infinite scroll
ShipmentAddressPart	String	6	False	Terme recherche dans le champs SearchField
GetDeliveryAddress	Boolean	7	False	Faux si il faut chercher dans les adresses d'enlèvement sinon la recherche s'effectue dans les adresses de livraison
LoadFullShipmentAddressObject	Boolean	7	False	Retourne une addrese complète si vrai sinon ne retourne qu'un ID et un nom
ShipmentAddressIdToStartSearch	Int32 nullable	7	False	Permet de continuer la recherche sur un infinite scroll dans le cas où le jeux de données est identiques pour le range voulu exemple : 50 fois le même nom d'adresse
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "SearchField": 1,
  "ClientCode": null,
  "OrdererCode": null,
  "MaxResult": 50,
  "ShipmentAddressPartMustExactlyMatch": false,
  "ShipmentAddressPartToStartSearch": null,
  "ShipmentAddressPart": null,
  "GetDeliveryAddress": false,
  "LoadFullShipmentAddressObject": false,
  "ShipmentAddressIdToStartSearch": null
}

LoadLikeTrackedAddressesRequest

Requête de recherche d'adresses

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Code clients
MaxResultToReturn	Int32 nullable	1	False	Nombre maximum de résultats retournés
StepAddress	String	2	False	Adresse à partir de laquelle commencer la recherche
SearchedAddress	String	3	False	Nom de l'adresse (ou partie du nom) recherché
AddressSearchMode	SearchMode	4	False	Mode de recherche
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "MaxResultToReturn": 30,
  "StepAddress": null,
  "SearchedAddress": null,
  "AddressSearchMode": 1
}

LoadLikeTrackedCitiesRequest

Requête de recherche de villes

Propriété	Type	Ordre	Obligatoire	Description
CustomersCodes	List`1 - String	0	False	Code clients
MaxResultToReturn	Int32 nullable	1	False	Nombre maximum de résultats retournés
StepCity	String	2	False	Ville à partir de laquelle commencer la recherche
SearchedCity	String	3	False	Nom de la ville (ou partie du nom) recherché
CitySearchMode	SearchMode	4	False	Mode de recherche
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomersCodes": null,
  "MaxResultToReturn": 30,
  "StepCity": null,
  "SearchedCity": null,
  "CitySearchMode": 1
}

LoadPackageFamilyRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
PackageFamilyCode	List`1 - String	0	True	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PackageFamilyCode": null
}

LoadPackingReferenceValuesRequest

Requête pour la recherche de valeurs d'une référence de nature colis permettant l'infinite scroll

Propriété	Type	Ordre	Obligatoire	Description
PackingNatureId	Int32	0	True	Id de la nature de colis
ReferenceIndex	Int32	1	True	Index de la référence pour laquelle rechercher des valeurs (0 à 4), l'index 0 correspondant à la référence 1.
MaxResults	Int32	2	True	Nombre de résultats maximum à retourner
SearchType	PackingReferencesSearchTypes nullable	3	True	Type de recherche à effectuer (contient / commence par)
Query	String	4	True	Terme à rechercher dans les valeurs de la référence
LastValueLabel	String	6	True	Label de la dernière valeur de la liste (utilisé pour la gestion de l'infinite scroll)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PackingNatureId": 0,
  "ReferenceIndex": 0,
  "MaxResults": 30,
  "SearchType": null,
  "Query": null,
  "LastValueLabel": null
}

LoadShipmentAddressRequest

requete de chargement d'adresse utilisée dans une mission

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentAddressId	Int32	0	True	Identifiant Dispatch de l'adresse utilisée dans un shipment (ID_PASSAGE) (Obligatoire)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalShipmentAddressId": 0
}

LoadShipmentsRequest

Requête de chargement d'une mission en vue d'une duplication

Propriété	Type	Ordre	Obligatoire	Description
Id	Int32	0	True	Numéro de mission ou de devis
IsQuote	Boolean	1	True	Indique si la demande de chargement concerne un devis
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

NormalizeAddressRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
AddressToNormalize	Address	0	False	Pas de description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "AddressToNormalize": null
}

OpenFileShipmentRequest

Requete pour ouvrir un fichier d'un ordre de transport.

Propriété	Type	Ordre	Obligatoire	Description
GuidTemporaryFile	String	0	True	Guid temporaire du fichier de l'ordre de transport
destinationName	String	1	False	Nom de destination du fichier
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "GuidTemporaryFile": null,
  "destinationName": null
}

OrdererDefaultAddressRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrdererCode	String	0	True	Code du donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OrdererCode": null
}

PackageCare

Colis pour demande de prise en charge de colis

Propriété	Type	Ordre	Obligatoire	Description
PackageCode	String	0	True	Code barre du colis (obligatoire)
PickupAddressExternalCode	String	1	False	Code externe de l'adresse d'enlévement (obligatoire si PickupAddressId n'est pas renseigné
DeliveryAddressExternalCode	String	2	True	Code externe de l'adresse de livraison (obligatoire)
IdRegularServicesGroup	Int32	3	True	Identifiant du groupe de prestation régulières (obligatoire)
PickupAddressId	Int32	4	False	Code externe de l'adresse d'enlévement (obligatoire si {nameof(PackageCare.PickupAddressId)} n'est pas renseigné
CustomerCode	String	5	False	Code du client associé à la demande de prise en charge (obligatoire)

{
  "PackageCode": null,
  "PickupAddressExternalCode": null,
  "DeliveryAddressExternalCode": null,
  "IdRegularServicesGroup": 0,
  "PickupAddressId": 0,
  "CustomerCode": null
}

PackageFamilyPicto

Association Picogramme css et code de famille de colis

Propriété	Type	Ordre	Obligatoire	Description
PictoName	String	0	False	Nom du pictogramme ('Plis,Colis,Encombrant,Palette,Autre,...')
FamilyPackageCode	List`1 - String	1	False	Liste des codes de familles de colis associés

{
  "PictoName": null,
  "FamilyPackageCode": []
}

PunchoutAuthenticationRequest

Requête d'authentification dispatch web Punch out

Propriété	Type	Ordre	Obligatoire	Description
SetupRequestHeader	String	0	True	Complet setup request from xml
PayLoadId	String	1	True	PayLoadId
BuyerCookie	String	2	True	BuyerCookie
BrowserFormPost	String	3	True	Url to call for shoppingcard
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "SetupRequestHeader": null,
  "PayLoadId": null,
  "BuyerCookie": null,
  "BrowserFormPost": null
}

PutUpdateApprobationLinkRequest

Requete pour mettre à jour une liaison d'approbation pour un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
OrdererCodeToUpdate	String	0	True	Code du donneur d'ordre à mettre à jour
Link	ApprobationOrderer	1	True	Association à ajouter/supprimer pour le donneur d'ordre à mettre à jour
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OrdererCodeToUpdate": null,
  "Link": null
}

RemoveTemporaryAttachedFileToShipmentRequest

Requete pour supprimer un fichier temporaire attaché à un ordre de transport.

Propriété	Type	Ordre	Obligatoire	Description
TemporaryAttachedFileGuid	String	0	True	Guid temporaire du fichier
IdAttachedFile	Int32	0	True	Id du fichier sur le serveur Dispatch
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "TemporaryAttachedFileGuid": null,
  "IdAttachedFile": 0
}

RenamePoiFamilyRequest

Requète pour renommer une famille de poi

Propriété	Type	Ordre	Obligatoire	Description
FamilyIdToRename	Int32	0	True	Identifiant de la famille de poi à renommer
NewFamilyName	String	1	True	Nouveau nom pour la famille de POI
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "FamilyIdToRename": 0,
  "NewFamilyName": null
}

RequestType

Paramètre mère de tous les paramètres request de l'API

Propriété	Type	Ordre	Obligatoire	Description
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null
}

SaveBookmarkAddressRequest

Requete de savegarde d'adresse favorite

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	True	Adresse a rataché au client
ClientCode	String	1	True	Code du client à qui doit être rataché l'adresse favorite
SaveToOrdererBook	Boolean	2	False	Si faux l'adresse est sauvegardée dans le carnet client si vrai dans le carnet du donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Address": null,
  "ClientCode": null,
  "SaveToOrdererBook": false
}

SaveFavoriteAddressForManagedOrdererRequest

Requete de savegarde d'adresse favorite

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	True	Adresse a rattacher au client
CustomerCode	String	1	True	Code client auquel rattacher l'adresse favorite
OrdererCode	String	2	True	Code donneur d'ordre pour lequel l'adresse est ajoutée au carnet d'adresse
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Address": null,
  "CustomerCode": null,
  "OrdererCode": null
}

SaveNewPasswordWithResetTokenRequest

Save new password with reset link

Propriété	Type	Ordre	Obligatoire	Description
TrackId	String	0	False	TrackId
ResetToken	String	1	True	ResetToken
NewPassword	String	2	True	New Password to save
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "TrackId": null,
  "ResetToken": null,
  "NewPassword": null
}

SaveSatisfactionSurveyRequest

Requète pour sauvegarder une enquête de satisfaction

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	True	Identifiant interne de mission (Numéro de transport)
SatisfactionSurveyResponses	List`1 - SatisfactionSurvey	1	True	Liste des réponses de l'enquête de satisfaction
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalShipmentId": 0,
  "SatisfactionSurveyResponses": null
}

SaveWebUserRightProfileRequest

Requete de sauvegarde des droits donneur d'ordre d'un profil

Propriété	Type	Ordre	Obligatoire	Description
UserWebProfile	UserWebProfile	0	True	Droit donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "UserWebProfile": null
}

SearchBillRequest

Paramètre de recherche de facture

Propriété	Type	Ordre	Obligatoire	Description
CustomerCodeList	List`1 - String	0	False	Liste des codes clients rattachés aux factures
FromEmissionUtcDate	Date	1	False	Début de la période d'emission de facture
ToEmissionUtcDate	DateTime nullable	2	False	Fin de la période d'emission de facture
BillState	List`1 - EBillState	3	False	Etats courant des factures
InternalIdBillList	List`1 - Int32	4	False	identifiants interne de facture
MaxResult	Int32	5	False	Nombre de résultat maximum retournés (Defaut = 100, Max =500)
SortMode	ESortMode	6	False	Mode tri
SortAsc	Boolean	7	False	Tri croissant
BillNumberList	List`1 - String	8	False	Numéro de facture (disponible à partir de la version API 46)
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "CustomerCodeList": null,
  "FromEmissionUtcDate": null,
  "ToEmissionUtcDate": null,
  "BillState": null,
  "InternalIdBillList": null,
  "MaxResult": 100,
  "SortMode": 1,
  "SortAsc": true,
  "BillNumberList": null
}

SearchRequest

Requête de recherche de mission

Propriété	Type	Ordre	Obligatoire	Description
SearchParams	Search	0	True	Critère de recherches
PageNumber	Int32	1	False	Numéro de page demandé (0 étant la première page)
ResultLimit	Int32	2	False	Nombre de résultat maximum
SortOrder	String	3	False	Ordre de tri : Desc, Asc
SortField	String	4	False	Champs de tri
LoadShipmentHistory	Boolean	5	False	Charger l'historique de mission avec les mission, traitement lourd et volumineux si il y a beaucoup de mission
LoadRevokedGeoDeviceAlerts	Boolean	6	False	Charger l'historique des suppressions d'alertes
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "SearchParams": {}
}

SecureTransportRequest

Requete de sécurisation d'une mission

Propriété	Type	Ordre	Obligatoire	Description
InternalMissionId	Int32	0	True	Identifiant interne de la mission
IsTransportSecured	Boolean	1	True	Indique l'état de sécurité du transport
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalMissionId": 0,
  "IsTransportSecured": false
}

SendCSSDemandRequest

Envoi les informations de choix de css à Eureka

Propriété	Type	Ordre	Obligatoire	Description
Client	String	0	False	Client demandeur
Contact	String	1	False	Nom/ numéro de téléphone, email
CSS	String	2	False	Nom de la css standard
PackageFamilyPictos	List`1 - PackageFamilyPicto	3	False	Liste des pictos à utiliser pour les familles de colis
ServicePictos	List`1 - ServicePicto	4	False	Liste des pictos à utiliser pour les prestations
AdditionalComment	String	5	False	Commentaire additionel
CompanyLogo	Byte[]	6	False	Logo société
CompanyLogoFileName	String	7	False	Nom du fichier du logo société
ServiceFamilyPictos	List`1 - FamilyServicePicto	8	False	Liste des pictos à utiliser pour les famille de prestations

{
  "Client": null,
  "Contact": null,
  "CSS": null,
  "PackageFamilyPictos": null,
  "ServicePictos": null,
  "AdditionalComment": null,
  "CompanyLogo": null,
  "CompanyLogoFileName": null,
  "ServiceFamilyPictos": null
}

SendPasswordToLoginRequest

Permet d'envoyer les identifiants à un donneur d'ordre par email

Propriété	Type	Ordre	Obligatoire	Description
UserLoginToSendPasswordEmail	String	0	True	Login utilisateur qui recevra l'email avec ses identifiants
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "UserLoginToSendPasswordEmail": null
}

ServicePicto

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
PictoName	String	0	False	Nom du pictogramme ('Avion, Camion, Véhicule léger, Moto, Scooter, Bateau,...')
ServiceCode	List`1 - String	1	False	Liste des codes de prestation associés

{
  "PictoName": null,
  "ServiceCode": []
}

SetCustomParametersRequest

Requete de sauvegarde de paramètre personnalisé pour une mission

Propriété	Type	Ordre	Obligatoire	Description
InternalMissionId	Int32	0	True	Identifiant interne de la mission
ServiceParams	List`1 - CustomField	1	False	Liste des paramètres personnalisés d'une prestation
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "InternalMissionId": 0,
  "ServiceParams": null
}

ShuttleScheduleDateMode

Mode de rechercherche de la meilleure navette

Nom	Valeur
DepartureDate	0
ArrivalDate	1
PreviousDate	2
NextDate	3

UpdateOrdererDefaultAddressRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrdererCode	String	0	True	Code du donneur d'ordre
AddressId	Int32	1	True	Identifiant de l'adresse par défaut du donneur d'ordre
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OrdererCode": null,
  "AddressId": 0
}

UpdateOrdererPointOfInterestDetailsRequest

Requète pour récupérer mettre à jour un POI associé à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
PointOfInterestDetails	PointOfInterestDetails	0	True	Details d'un POI
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "PointOfInterestDetails": null
}

UpdatePackageLineRequest

Requete de mise à jour d'une ligne de colis

Propriété	Type	Ordre	Obligatoire	Description
SearchKey	String	0	False	Clé de recherche
SearchValue	String	1	False	Valeur à rechercher
InternalId	Int32	2	True	Id de la mission
Package	Packing	3	True	Description du colis à mettre à jour
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "SearchKey": null,
  "SearchValue": null,
  "InternalId": 0,
  "Package": null
}

UpdatePasswordRequest

Requete de changement de mot de passe de donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
OldPassword	String	0	True	Mot de passe avant le changement pour une vérification
NewPassword	String	1	True	Nouveau mot de passe à enregistrer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "OldPassword": null,
  "NewPassword": null
}

UpdateReferenceRequest

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ReferenceToUpdate	Reference	0	False	Reference entity to update
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "ReferenceToUpdate": null
}

UpdateShipmentRequest

Requête pour la modification d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Shipment	0	True	Transport aller
ReturnShipment	Shipment	1	False	Transport retour
ByPassCityControl	Boolean	2	False	Les villes des missions ne sont pas vérifier par Dispatch, si aucune ville ne correspond il se peut que Dispatch ne trouve pas de tarif
ComputePriceWithTaxes	Boolean	3	False	Le TTC sera calculé par Dispatch et la propriété PriceWithTaxe de Shipment sera renseignée
SkipDistanceComputing	Boolean	4	False	Le calcul de distance est ignoré (usage interne)
UpdateComment	String	5	False	Commentaire à insérer dans l'historique de l'ordre
ReturnUpdateComment	String	6	False	Commentaire à insérer dans l'historique de l'ordre pour le transport retour
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "Shipment": null,
  "ReturnShipment": null,
  "ByPassCityControl": false,
  "ComputePriceWithTaxes": false,
  "SkipDistanceComputing": false,
  "UpdateComment": null,
  "ReturnUpdateComment": null
}

ValidateQuotationRequest

Permet de valider un devis

Propriété	Type	Ordre	Obligatoire	Description
QuoteId	Int32	0	True	Numéro de Devis
ForcedPickupDate	ApprovalForcedDateCondition	1	False	Nouvelle date d'enlèvement d'approbation
ForcedDeliveryDate	ApprovalForcedDateCondition	2	False	Nouvelle date de livraison d'approbation
OriginalOrdererCode	String	3	False	Code du donneur d'ordre ayant saisi la mission
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "QuoteId": 0,
  "ForcedPickupDate": null,
  "ForcedDeliveryDate": null,
  "OriginalOrdererCode": null
}

VoucherOrderRequest

Requete de commande directe de carnet de bon (sans paiement comptant)

Propriété	Type	Ordre	Obligatoire	Description
VoucherQuantity	Int32	0	True	Quantité de bon à commander
CustomerCode	String	1	True	Code du client à créditer
Credential	Credential	-1	True	Objet d'identification

{
  "Credential": null,
  "VoucherQuantity": 0,
  "CustomerCode": null
}

Objets utilisés pour les réponses de l'API

AddPoiFamilyResponse

Réponse pour ajouter une famille de POI

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

ApproveQuotationResponse

Réponse de la méthode ApproQuotation qui permet d'approuver une mission en attente d'approbation

Propriété	Type	Ordre	Obligatoire	Description
ShipmentId	Int32	0	False	Numéro de la mission validée dans Dispatch
TrackId	String	1	False	Numéro de tracking de la mission validée dans Dispatch
QuotationApprovalErrorType	QuotationApprovalError	2	False	Type de l'erreur remontée par l'approbation de mission
MissingServiceFileCategories	List`1 - FileCategory	3	False	Catégories de fichiers pour lesquelles au moins un fichier est manquant pour la validation de la prestation
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentId": 0,
  "Errors": [],
  "TrackId": null,
  "Status": 200,
  "QuotationApprovalErrorType": 0,
  "MissingServiceFileCategories": null
}

AskApprovalResponse

Réponse de la méthode AskApproval qui permet de transformer un devis en demande d'approbation

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

AttachFileToShipmentResponse

Réponse à la méthode AttachFileToShipment

Propriété	Type	Ordre	Obligatoire	Description
GuidFileOnServerWeb	String	0	False	Guid permettant identifier le fichier sur le serveur web.
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "GuidFileOnServerWeb": null,
  "Errors": [],
  "Status": 200
}

AuthentificationResponse

Type de retour de l'authentification

Propriété	Type	Ordre	Obligatoire	Description
Authentified	Boolean	0	False	Indique si l'authentification a réussi
Clients	List`1 - String	1	False	Liste des clients associés au donneur d'ordre
ConnectionToken	String	2	False	Token de connection qui évite de s'authentifier à chaque appel de méthode, la validitée est de 24h
Language	String	3	False	Langue du donneur d'ordre
UserRights	UserRights	4	False	Ensemble des droits d'accès de l'utilisateur sur l'API
ASPNetSessionId	String	5	False	Ensemble des droits d'accès de l'utilisateur sur l'API
Orderer	OrderingParty	6	False	Informations sur le donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Authentified": false,
  "Errors": [],
  "Clients": null,
  "Status": 200,
  "ConnectionToken": null,
  "Language": null,
  "UserRights": null,
  "ASPNetSessionId": null,
  "Orderer": null
}

AutoCompleteStreetResponse

Réponse à la méthode AutoCompleteStreet, retourne une liste d'adresse correspondant à un début de nom de rue

Propriété	Type	Ordre	Obligatoire	Description
MatchAddress	List`1 - Address	0	False	Adresses trouvées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "MatchAddress": [],
  "Errors": [],
  "Status": 200
}

BillAndPayShipmentResponse

Réponse à la méthode BillAndPay qui permet de facturer et régler une mission

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Int32	0	False	Numéro de la mission suite à sa validation
TrackId	String	1	False	Track ID de la mission
BillNumber	String	2	False	Numéro de la facture Dispatch
DispatchPaymentId	String	3	False	Numéro de réglement Dispatch
BillDownLoadId	String	4	False	Identifiant de téléchargement de la facture
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Shipment": 0,
  "Errors": [],
  "TrackId": null,
  "Status": 200,
  "BillNumber": null,
  "DispatchPaymentId": null,
  "BillDownLoadId": null
}

CityResponse

Réponse à la méthode City

Propriété	Type	Ordre	Obligatoire	Description
CityList	List`1 - City	0	False	Liste des villes trouvées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "CityList": null,
  "Errors": [],
  "Status": 200
}

Classification

Représentation d'un score de géocoding

Nom	Valeur
NotClassified	0
NoResult	1
NoInput	2
Low	3
Medium	4
High	5
PartiallyExact	6
Exact	7

ComparePricesResponse

Réponse à la méthode comapre price

Propriété	Type	Ordre	Obligatoire	Description
ServiceList	List`1 - ServicePrice	0	False	Service pouvant être sélectionnés par le client
Distance	Decimal	1	False	[Obsolete] Distance en mètre, voir la distance directement dans le Service
Duration	Double	2	False	[Obsolete] Voir la durée directement dans le service
ServiceFamillyList	List`1 - ServiceFamilly	3	False	Liste exaustive des familles de prestation disponibles
RejectedServices	List`1 - RejectedService	4	False	Liste des prestations rejetées pour raison métier (hors délais/ sans tarifs, ...)
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ServiceList": null,
  "Errors": [],
  "Distance": 0.0,
  "Status": 200,
  "Duration": 0.0,
  "ServiceFamillyList": null,
  "RejectedServices": null
}

ComputePriceResponse

Réponse à la méthode Compute Price

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Shipment	0	False	Mission Aller, seules les informations tarifaires et délais sont renseignées
ReturnShipment	Shipment	1	False	Mission Retour, seules les informations tarifaires et délais sont renseignées
TotalAmountWithTaxes	Double	2	False	Montant total de la comande TTC
TotalAmountWithoutTaxes	Double	3	False	Montant total de la comande HT
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Shipment": null,
  "Errors": [],
  "ReturnShipment": null,
  "Status": 200,
  "TotalAmountWithTaxes": 0.0,
  "TotalAmountWithoutTaxes": 0.0
}

CountryResponse

Réponse à la méthode country

Propriété	Type	Ordre	Obligatoire	Description
CountryList	List`1 - Country	0	False	Liste des pays
DefaultCountry	String	1	False	Pays par défaut pour la saisie (un paramétre général éxiste pour le suivi de mission)
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "CountryList": null,
  "Errors": [],
  "DefaultCountry": null,
  "Status": 200
}

CreateReferenceResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Reference	Reference	0	False	Created reference
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Reference": null,
  "Errors": [],
  "Status": 200
}

CreateShipmentResponse

Réponse à la méthode createshipment

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Shipment	0	False	Mission Aller
ReturnShipment	Shipment	1	False	Mission Retour
TotalAmountWithTaxes	Double	2	False	Montant total de la comande TTC
TotalAmountWithoutTaxes	Double	3	False	Montant total de la comande HT
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Shipment": null,
  "Errors": [],
  "ReturnShipment": null,
  "Status": 200,
  "TotalAmountWithTaxes": 0.0,
  "TotalAmountWithoutTaxes": 0.0
}

CreateTrackIdPageSessionResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
SessionToken	String	0	False	Pas de description
Culture	String	1	False	Pas de description
PageSettings	TrackIdPageSettings	2	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "SessionToken": null,
  "Errors": [],
  "Culture": null,
  "Status": 200,
  "PageSettings": null
}

CustomMissionsViewProfileResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Columns	List`1 - CustomMissionsViewColumnDescription	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Columns": null,
  "Errors": [],
  "Status": 200
}

DeleteAPoiFamillyResponse

Réponse de la supression d'une famille de POI

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

DeletePointOfInterestResponse

Réponse pour supprimer un POI

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

EDIResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
EDIStatus	EDIStatusEnum	0	False	Pas de description
IntegratedCodes	List`1 - String	1	False	Pas de description
IntegratedInternalIds	List`1 - Int32	2	False	Pas de description
IntegratedIds	List`1 - Int32	3	False	Pas de description
EDIErrors	List`1 - String	4	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "EDIStatus": 0,
  "Errors": [],
  "IntegratedCodes": null,
  "Status": 200,
  "IntegratedInternalIds": null,
  "IntegratedIds": null,
  "EDIErrors": null
}

EDocumentDownloadStatus

Statut de téléchargement du document

Nom	Valeur
DocumentIsDownloadingFromCarrier	1
PendingDocumentDownloadFromSubcontractor	2
PendingSubcontractorAssignment	3
InternalError	-1

ExistCustomerResponse

Réponse de la méthode ExistCustomer

Propriété	Type	Ordre	Obligatoire	Description
Exist	Boolean	0	False	Le client existe
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Exist": false,
  "Errors": [],
  "Status": 200
}

ExistUserResponse

Réponse de la méthode ExistUser

Propriété	Type	Ordre	Obligatoire	Description
Exist	Boolean	0	False	L'utilisateur existe
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Exist": false,
  "Errors": [],
  "Status": 200
}

FavoritesUserAddressResponse

Réponse à la méthode FavoritesUserAddress

Propriété	Type	Ordre	Obligatoire	Description
Addresses	List`1 - Address	0	False	Liste des adresses associées à l'utilisateur
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Addresses": null,
  "Errors": [],
  "Status": 200
}

FindAddressByGeocodingResponse

Réponse obtenue suite à l'appel à la méthode Json/FindAddressByGeocoding

Propriété	Type	Ordre	Obligatoire	Description
Addresses	List`1 - Address	0	False	Adresses trouvées pour les coordonnées géographiques fournies
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Addresses": null,
  "Errors": [],
  "Status": 200
}

FindAddressSuggestionsResponse

Réponse obtenue suite à l'appel à la méthode Json/FindAddressSuggestions

Propriété	Type	Ordre	Obligatoire	Description
AddressSuggestions	List`1 - AddressSuggestion	0	False	Suggestions d'adresses trouvées pour la chaîne de caractères fournie
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "AddressSuggestions": null,
  "Errors": [],
  "Status": 200
}

GenerateReportResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ReportFile	Byte[]	1	False	Pas de description
IsGZipped	Boolean	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "IsGZipped": false,
  "Errors": [],
  "ReportFile": null,
  "Status": 200
}

GeocodeAddressResponse

Reponse d'appel à la méthode GeocodeAddress contenant les coordonnées GPS de l'adresse à géocoder

Propriété	Type	Ordre	Obligatoire	Description
AddressToGeocode	Address	0	False	Adresse initiale à géocoder
Coordinates	GeoData	1	False	Coordonnées GPS de l'adresse à géocoder
Scores	GeocodingScores	2	False	Scores de géocoding pour les différentes parties de l'adresse donnée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "AddressToGeocode": null,
  "Errors": [],
  "Coordinates": null,
  "Status": 200,
  "Scores": null
}

GetAddressByLocationIdResponse

Réponse obtenue suite à l'appel à la méthode Json/GetAddressByLocationId

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse correspondante à l'identifant de suggestion fournie
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "Status": 200
}

GetAddressFromExternCodeResponse

Réponse à la méthode GetAddressFromExternCode

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse correspondante au code externe
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "Status": 200
}

GetAllClientResponse

Réponse à la méthode GetAllClient

Propriété	Type	Ordre	Obligatoire	Description
CustomersList	List`1 - Customer	0	False	Client(s) chargé(s)
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "CustomersList": null,
  "Errors": [],
  "Status": 200
}

GetAllowedFilesTypesResponse

Réponse de la méthode GetAllowedFilesTypes

Propriété	Type	Ordre	Obligatoire	Description
AllowedTypes	List`1 - String	0	False	Types de fichiers autorisés lors des processus de téléversement
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "AllowedTypes": null,
  "Errors": [],
  "Status": 200
}

GetAllowedPackageConfigResponse

Réponse de la requete de récupération de l'ensemble des familles et natures de colis accessible à un client

Propriété	Type	Ordre	Obligatoire	Description
PackageNatureList	List`1 - Package	0	False	Liste des natures de colis accessibles au client
PackageFamillyList	List`1 - PackageFamily	1	False	Liste des familles de colis accessibles au client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PackageNatureList": null,
  "Errors": [],
  "PackageFamillyList": null,
  "Status": 200
}

GetAnnouncedPackagesHistoryResponse

Réponse de la méthode GetTrackingOrder

Propriété	Type	Ordre	Obligatoire	Description
HistoryEntries	List`1 - AnnouncedPackageEvent	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

GetApiBaseUrlResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
BaseUrl	String	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "BaseUrl": null,
  "Errors": [],
  "Status": 200
}

GetAssociatedPODResponse

Réponse de l'appel à la méthode GetPODList

Propriété	Type	Ordre	Obligatoire	Description
PODList	List`1 - ProofOfDelivery	0	False	Liste des preuves de livraison de la mission
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PODList": [],
  "Errors": [],
  "Status": 200
}

GetAttachedFilesShipmentResponse

Réponse de l'appel à la méthode GetAllFilesShipmentByIdTransportOrder

Propriété	Type	Ordre	Obligatoire	Description
FileShipmentAwaitingList	List`1 - FileShipmentInformation	0	False	Liste des fichiers rattachés à un ordre de transport en attentes de transfert au serveur Dispatch
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "FileShipmentAwaitingList": null,
  "Errors": [],
  "Status": 200
}

GetBestShuttleScheduleResponse

Réponse de la méthode GetBestShuttleSchedule

Propriété	Type	Ordre	Obligatoire	Description
ShuttleSchedule	ShuttleSchedule	0	False	Horaires de la navette correspondant au mieux aux critères de recherche
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShuttleSchedule": null,
  "Errors": [],
  "Status": 200
}

GetBillPaymentsResponse

Réponse de la méthode GetBillPayments

Propriété	Type	Ordre	Obligatoire	Description
Payments	List`1 - Payment	0	False	Liste de règlements d'une facture
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Payments": null,
  "Errors": [],
  "Status": 200
}

GetBillReportResponse

Réponse à la méthode GetBillReport

Propriété	Type	Ordre	Obligatoire	Description
BillDataBase64String	String	0	False	Contenu du fichier encodée sous la forme d'une chaine de caractères en base 64
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "BillDataBase64String": null,
  "Errors": [],
  "Status": 200
}

GetBillResponse

Réponse à la méthode GetBill

Propriété	Type	Ordre	Obligatoire	Description
BillDataBase64String	String	0	False	Contenu du fichier encodée sous la forme d'une chaine de caractères en base 64
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "BillDataBase64String": null,
  "Errors": [],
  "Status": 200
}

GetClientAdressResponse

Réponse à la méthode GetClientAdress

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse du compte client
BillAddress	Address	1	False	Adresse de facturation du compte client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "BillAddress": null,
  "Status": 200
}

GetClientCustomFieldResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomFieldList	List`1 - CustomerCustomField	0	False	Liste des paramètres personnalisés du client
Reference1Label	String	1	False	Libellé de la référence 1
Reference1Value	String	2	False	Valeur de la référence 1
Reference1Mandatory	Boolean	3	False	Réference 1 obligatoire dans la saisie d'ordre
Reference2Label	String	5	False	Libellé de la référence 2
Reference2Value	String	6	False	Valeur de la référence 2
Reference2Mandatory	Boolean	7	False	Réference 2 obligatoire dans la saisie d'ordre
Reference3Label	String	9	False	Libellé de la référence 3
Reference3Value	String	10	False	Valeur de la référence 3
Reference3Mandatory	Boolean	11	False	Réference 3 obligatoire dans la saisie d'ordre
Reference1Forced	Boolean	13	False	La valeur de la référence 1 doit faire partie des références du client
Reference2Forced	Boolean	14	False	La valeur de la référence 2 doit faire partie des références du client
Reference3Forced	Boolean	15	False	La valeur de la référence 3 doit faire partie des références du client
PreRegisteredReference1	List`1 - String	4	False	Pas de description
PreRegisteredReference2	List`1 - String	8	False	Pas de description
PreRegisteredReference3	List`1 - String	12	False	Pas de description
CountReference1ValuesEnable	Int32	16	False	Nombre de valeur disponible pour référence 1 par rapport au donneur d'ordre
CountReference2ValuesEnable	Int32	17	False	Nombre de valeur disponible pour référence 2 par rapport au donneur d'ordre
CountReference3ValuesEnable	Int32	18	False	Nombre de valeur disponible pour référence 3 par rapport au donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "CustomFieldList": null,
  "Errors": [],
  "Reference1Label": null,
  "Status": 200,
  "Reference1Value": null,
  "Reference1Mandatory": false,
  "PreRegisteredReference1": null,
  "Reference2Label": null,
  "Reference2Value": null,
  "Reference2Mandatory": false,
  "PreRegisteredReference2": null,
  "Reference3Label": null,
  "Reference3Value": null,
  "Reference3Mandatory": false,
  "PreRegisteredReference3": null,
  "Reference1Forced": false,
  "Reference2Forced": false,
  "Reference3Forced": false,
  "CountReference1ValuesEnable": 0,
  "CountReference2ValuesEnable": 0,
  "CountReference3ValuesEnable": 0
}

GetClientEDIBuilderConfResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Codes	List`1 - String	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Codes": null,
  "Errors": [],
  "Status": 200
}

GetClientPOIResponse

Résultat de la récupération des POI d'un client

Propriété	Type	Ordre	Obligatoire	Description
POIList	List`1 - POIFamily	0	False	POI associés aux clients
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "POIList": null,
  "Errors": [],
  "Status": 200
}

GetClientReferencesResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Reference1Label	String	1	False	Libellé de la référence 1
Reference1Value	String	2	False	Valeur forcée de la référence 1 par rapport au donneur d'ordre
Reference1Mandatory	Boolean	3	False	Réference 1 obligatoire dans la saisie d'ordre
Reference2Label	String	5	False	Libellé de la référence 2
Reference2Value	String	6	False	Valeur forcée de la référence 2 par rapport au donneur d'ordre
Reference2Mandatory	Boolean	7	False	Réference 2 obligatoire dans la saisie d'ordre
Reference3Label	String	9	False	Libellé de la référence 3
Reference3Value	String	10	False	Valeur forcée de la référence 3 par rapport au donneur d'ordre
Reference3Mandatory	Boolean	11	False	Réference 3 obligatoire dans la saisie d'ordre
Reference1Forced	Boolean	13	False	La valeur de la référence 1 doit provenir de la liste des références associées aux clients
Reference2Forced	Boolean	14	False	La valeur de la référence 2 doit provenir de la liste des références associées aux clients
Reference3Forced	Boolean	15	False	La valeur de la référence 3 doit provenir de la liste des références associées aux clients
CountReference1ValuesEnable	Int32	16	False	Nombre de valeur disponible pour référence 1 par rapport au donneur d'ordre
CountReference2ValuesEnable	Int32	17	False	Nombre de valeur disponible pour référence 2 par rapport au donneur d'ordre
CountReference3ValuesEnable	Int32	18	False	Nombre de valeur disponible pour référence 3 par rapport au donneur d'ordre
AtLeastOneReferenceMandatory	Boolean	19	False	au moin une référence est obligatoire dans la saisie d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Reference1Label": null,
  "Status": 200,
  "Reference1Value": null,
  "Reference1Mandatory": false,
  "Reference2Label": null,
  "Reference2Value": null,
  "Reference2Mandatory": false,
  "Reference3Label": null,
  "Reference3Value": null,
  "Reference3Mandatory": false,
  "Reference1Forced": false,
  "Reference2Forced": false,
  "Reference3Forced": false,
  "CountReference1ValuesEnable": 0,
  "CountReference2ValuesEnable": 0,
  "CountReference3ValuesEnable": 0,
  "AtLeastOneReferenceMandatory": false
}

GetClientRegularOrdersGroupsResponse

Réponse de la méthode GetClientRegularOrdersGroups

Propriété	Type	Ordre	Obligatoire	Description
RegularOrdersGroups	List`1 - RegularOrdersGroup	0	False	Groupes d'ordres réguliers d'un client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "RegularOrdersGroups": null,
  "Errors": [],
  "Status": 200
}

GetClientResponse

Réponse à la méthode GetClient

Propriété	Type	Ordre	Obligatoire	Description
Customer	Customer	0	False	Client trouvé
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Customer": null,
  "Errors": [],
  "Status": 200
}

GetClientServiceResponse

Réponse à la méthode GetClientService

Propriété	Type	Ordre	Obligatoire	Description
ServiceList	List`1 - Service	0	False	Liste des prestations autorisées pour le client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ServiceList": null,
  "Errors": [],
  "Status": 200
}

GetClientSpecificServicesResponse

Réponse de la méthode GetClientSpecificServices

Propriété	Type	Ordre	Obligatoire	Description
ServiceList	List`1 - Service	0	False	Liste des prestations autorisées pour le client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ServiceList": null,
  "Errors": [],
  "Status": 200
}

GetCompanyParameterResponse

Réponse à la méthode GetCompanyParameter

Propriété	Type	Ordre	Obligatoire	Description
Parameters	CompanyParameters	0	False	Paramètres de l'API
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Parameters": {
    "ClientEBusinessCode": null,
    "DefaultCountryCode": null,
    "MandatoryAddressFields": 0,
    "ForcingStepByStepMode": false,
    "ConditionOfUse": null,
    "UseAddressNormalization": false,
    "AddressNormalizationRequired": false,
    "UseAddressNormalizationIneBusiness": false,
    "AddressNormalizationRequiredIneBusiness": false,
    "ClientEBusinessCodeProfessionnal": null,
    "EBusinessMandatoryFields": 0,
    "OrdererCodeEBusiness": null,
    "OrdererCodeEBusinessProfessional": null,
    "ECommerceGeneralConditionURL": null,
    "EBusinessShowPackageStep": false,
    "Coment1Mode": 0,
    "Coment2Mode": 0,
    "Coment3Mode": 0,
    "Coment4Mode": 0,
    "Coment5Mode": 0,
    "Coment6Mode": 0,
    "Coment7Mode": 0,
    "Coment8Mode": 0,
    "VisibleAddressFields": 0,
    "TrackingPackagesSearchMaxPeriodInMonths": 0,
    "TrackingPackagesSearchIgnoreBarcodeWhiteSpaces": false,
    "TrackingPackageSearchMinCharNbForAutocompletion": 0,
    "WeightDisplayUnit": null,
    "DefaultSizeUnit": null,
    "GazEmissionEnabled": false,
    "SearchRestrictionSettings": null,
    "HideBarCodeOnMissionDetails": false,
    "TrackIdFeatureEnabled": false,
    "DefaultCountryForOrderHistory": null,
    "CircuitAddressesSetEnabled": false,
    "TransportSearchResultLimit": 0,
    "ReceiptLabel": null,
    "IsAirWaybillModuleEnabled": false,
    "TrackyParameters": null,
    "LoginPageUrl": null,
    "HomePageMessage": null,
    "TrackyUrl": null
  },
  "Errors": [],
  "Status": 200
}

GetCustomFieldsConfigResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
CustomFieldList	List`1 - CustomField	0	False	Id champs
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "CustomFieldList": null,
  "Errors": [],
  "Status": 200
}

GetCustomerVoucherPricingScaleResponse

Réponse de la récupération d'une grille de tarif en bon pour un client

Propriété	Type	Ordre	Obligatoire	Description
VoucherPricingScaleList	List`1 - VoucherPricingScale	0	False	Grille de tarification en bon
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "VoucherPricingScaleList": null,
  "Errors": [],
  "Status": 200
}

GetDailyTrackHistoryFromIdResponse

Réponse contenant les feuilles de route journalière d'un boitier gps

Propriété	Type	Ordre	Obligatoire	Description
DailyTrackHistory	List`1 - DailyTrackHistory	0	False	Liste des Feuilles de route par jour d'un boitier
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DailyTrackHistory": null,
  "Errors": [],
  "Status": 200
}

GetDelegatorResponse

Réponse d'appel à la méthode GetDelegatorToken contenant le token du donneur d'ordre délégateur

Propriété	Type	Ordre	Obligatoire	Description
DelegatorToken	String	0	False	Token de session du donneur d'ordre délégateur
Delegator	OrderingParty	1	False	Donneur d'ordre délégateur
OrdererRights	UserRights	2	False	Droits du donneur d'ordre délégateur
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DelegatorToken": null,
  "Errors": [],
  "Delegator": null,
  "Status": 200,
  "OrdererRights": null
}

GetDonneurOrdreClientsResponse

Réponse de la méthode GetDonneurOrdreClients

Propriété	Type	Ordre	Obligatoire	Description
Clients	List`1 - Customer	0	False	Liste des clients du donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Clients": null,
  "Errors": [],
  "Status": 200
}

GetECommerceCredentialsResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ValidCredentials	List`1 - ECommerceCredential	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ValidCredentials": null,
  "Errors": [],
  "Status": 200
}

GetEurekaMapsCredentialResponse

Réponse à la méthode GetEurekaMapsCredential

Propriété	Type	Ordre	Obligatoire	Description
EurekaMapsUrl	String	0	False	Url de l'API EurekaMaps
EurekaMapsToken	String	1	False	Token de session EurekaMaps
EurekaMapsCopyright	String	2	False	Copyright EurekaMaps
EurekaMapsRestApiUrl	String	3	False	Url de l'API REST EurekaMaps
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "EurekaMapsUrl": null,
  "Errors": [],
  "EurekaMapsToken": null,
  "Status": 200,
  "EurekaMapsCopyright": null,
  "EurekaMapsRestApiUrl": null
}

GetExportModelResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ExportModelList	List`1 - ExportModel	0	True	Liste des models accessible au client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ExportModelList": null,
  "Errors": [],
  "Status": 200
}

GetGeoDeviceTrackFromIdResponse

Réponse contenant tout les points d'une trace d'un boitier gps

Propriété	Type	Ordre	Obligatoire	Description
DailyTrackHistory	List`1 - DailyTrackHistory	0	False	Liste des historiques de trace par jour d'un boitier
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DailyTrackHistory": null,
  "Errors": [],
  "Status": 200
}

GetGroupeOrdresReguliersAdressesResponse

Réponse de la méthode GetGroupeOrdresReguliersAdresses

Propriété	Type	Ordre	Obligatoire	Description
Addresses	List`1 - Address	0	False	Groupes d'ordres réguliers d'un client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Addresses": null,
  "Errors": [],
  "Status": 200
}

GetHandledLanguagesResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Languages	List`1 - Language	-1	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Languages": null,
  "Errors": [],
  "Status": 200
}

GetImportsShipmentsStatusResponse

Réponse à la méthode GetImportsShipmentsStatus

Propriété	Type	Ordre	Obligatoire	Description
ImportsStatus	List`1 - ImportShipmentsStatus	0	False	Statuts des imports de missions
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ImportsStatus": null,
  "Errors": [],
  "Status": 200
}

GetInternalReportGenerationResultResponse

Réponse de la requete GetInternalReportGenerationResultResponse

Propriété	Type	Ordre	Obligatoire	Description
ReportGenerated	Byte[]	0	False	Report généré
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ReportGenerated": null,
  "Errors": [],
  "Status": 200
}

GetLastAddressResponse

Réponse à la méthode GetLastAddress

Propriété	Type	Ordre	Obligatoire	Description
LastAddressList	List`1 - Address	0	False	Dernières adresses utilisées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "LastAddressList": [],
  "Errors": [],
  "Status": 200
}

GetListFilesCategoriesCodesResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
FileCategories	List`1 - FileCategory	0	False	List des catégories de fichier
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "FileCategories": null,
  "Errors": [],
  "Status": 200
}

GetManageableOrderersResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Orderers	List`1 - OrderingParty	0	False	Manageable orderers
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Orderers": [],
  "Errors": [],
  "Status": 200
}

GetNewTokenResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
NewToken	String	0	False	Nouveau token
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "NewToken": null,
  "Errors": [],
  "Status": 200
}

GetOrdererGeoDevicesResponse

Réponse contenant tout les boitiers associés à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
OrdererGeoDevices	List`1 - OrdererGeoDevice	0	False	Liste des boitiers gps associés à un donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "OrdererGeoDevices": null,
  "Errors": [],
  "Status": 200
}

GetOrdererPointOfInterestDetailsResponse

Réponse contenant les informations détaillées d'un POI associé à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
PointOfInterestDetails	PointOfInterestDetails	0	False	Détails d'un point d'interet
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PointOfInterestDetails": null,
  "Errors": [],
  "Status": 200
}

GetOrdererPointsOfInterestResponse

Réponse contenant la liste de famille de POI

Propriété	Type	Ordre	Obligatoire	Description
PointsOfInterest	List`1 - POIFamily	0	False	POI associé à un Donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PointsOfInterest": null,
  "Errors": [],
  "Status": 200
}

GetOrdererRoundSheetResponse

Réponse de la demande de génération d'une feuille de tournée

Propriété	Type	Ordre	Obligatoire	Description
Sheet	Byte[]	0	False	Feuille de tournée (tableau d'octets)
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Sheet": null,
  "Errors": [],
  "Status": 200
}

GetOrdererRoundsResponse

Réponse de la demande de recherche de tournées

Propriété	Type	Ordre	Obligatoire	Description
OrdererRounds	List`1 - OrdererRound	0	False	Liste des tournées du donneur d'ordre ayant effectué la recherche
Pagination	Pagination	1	False	Informations sur la pagination
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "OrdererRounds": null,
  "Errors": [],
  "Pagination": null,
  "Status": 200
}

GetOrderingPartiesForCustomerResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrderingParties	List`1 - OrderingParty	0	False	Liste de donneurs d'ordres
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "OrderingParties": null,
  "Errors": [],
  "Status": 200
}

GetOrderingPartyResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
OrderingParty	OrderingParty	0	False	Donneur d'ordre chargé
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "OrderingParty": null,
  "Errors": [],
  "Status": 200
}

GetPOIDetailsResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
FormattedAddress	String	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "FormattedAddress": null,
  "Errors": [],
  "Status": 200
}

GetPackageRouteInfoResponse

Requete de récupération de la trace GPS d'un colis

Propriété	Type	Ordre	Obligatoire	Description
RouteSteps	List`1 - RouteStep	0	False	Etapes, permet de distinguer les stop et les périodes de roulage
RouteCoordinates	List`1 - GeoData	1	False	Coordonnées GPS de la trace
Distance	Double	2	False	Distance totale de la trace en Kilomètres
DrivingDurationInSec	Int32	3	False	Durée de roulage en seconde
StopDurationInSec	Int32	4	False	Durée d'arret en seconde
StopCount	Int32	5	False	Nombre d'arret
FromUtcDate	Date	6	False	Date de début de la trace
ToUtcDate	Date	7	False	Date de fin de la trace
PrevisionalArriveUtcDate	Date	8	False	Date prévue d'arrivée (non calculée pour le moment)
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "RouteSteps": [],
  "Errors": [],
  "RouteCoordinates": [],
  "Status": 200,
  "Distance": 0.0,
  "DrivingDurationInSec": 0,
  "StopDurationInSec": 0,
  "StopCount": 0,
  "FromUtcDate": null,
  "ToUtcDate": null,
  "PrevisionalArriveUtcDate": null
}

GetPackageTypeResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
PackageTypeList	List`1 - Package	-1	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PackageTypeList": null,
  "Errors": [],
  "Status": 200
}

GetPointsOfInterestRawDataResponse

Réponse contenant les informations détaillées d'un POI associé à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
PointsOfInterestDetails	List`1 - PointOfInterestDetails	0	False	Détails d'un point d'interet
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PointsOfInterestDetails": null,
  "Errors": [],
  "Status": 200
}

GetReferenceResponse

Type de retour de la méthode GetReference et GetClientReferences

Propriété	Type	Ordre	Obligatoire	Description
ReferenceList	List`1 - Reference	0	False	Références trouvées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ReferenceList": [],
  "Errors": [],
  "Status": 200
}

GetRegularTransportsListResponse

Réponse de la méthode GetRegularTransportsList permettant de récuperer la liste des ordres réguliers d'un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
RegularTransportsList	List`1 - RegularTransportIdentity	0	False	La liste des ordres réguliers d'un donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "RegularTransportsList": null,
  "Errors": [],
  "Status": 200
}

GetReportModelResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
ReportModelList	List`1 - ReportModel	0	False	Liste des models de report accessible au client
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ReportModelList": null,
  "Errors": [],
  "Status": 200
}

GetRevokedGeoDeviceAlertsResponse

Réponse de la requète pour récupérer l'historique des suppression d'alertes de temperature

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentId	Int32	0	False	Identifiant interne de mission (Numéro de transport)
GeoDeviceAlertRevocations	List`1 - GeoDeviceAlertRevocation	1	False	Liste des suppresions d'alertes mobile
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "InternalShipmentId": 0,
  "Errors": [],
  "GeoDeviceAlertRevocations": null,
  "Status": 200
}

GetSatisfactionSurveyResponse

Réponse contenant les champs d'une enquête de satisfaction

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentId": 0,
  "Errors": [],
  "CustomerQuestions": null,
  "Status": 200,
  "ServiceQuestions": null,
  "SubContractorQuestions": null
}

GetShipmentCreationConfigurationResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Configuration	ShipmentCreationConfiguration	0	False	Configuration de saisie d'un donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Configuration": null,
  "Errors": [],
  "Status": 200
}

GetShipmentInformationListByMissionResponse

Reponse pour la méthode GetShipmentInformationListByMission

Propriété	Type	Ordre	Obligatoire	Description
ShipmentInformations	List`1 - ShipmentInformation	0	False	Liste d'informations des transports d'une mission
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentInformations": null,
  "Errors": [],
  "Status": 200
}

GetShipmentRouteInfoResponse

Trace d'un chauffeur pour une mission

Propriété	Type	Ordre	Obligatoire	Description
RouteSteps	List`1 - RouteStep	0	False	Etapes, permet de distinguer les stop et les périodes de roulage
RouteCoordinates	List`1 - GeoData	1	False	Coordonnées GPS de la trace
Distance	Double	2	False	Distance totale de la trace en Kilomètres
DrivingDurationInSec	Int32	3	False	Durée de roulage en seconde
StopDurationInSec	Int32	4	False	Durée d'arret en seconde
StopCount	Int32	5	False	Nombre d'arret
FromUtcDate	Date	6	False	Date de début de la trace
ToUtcDate	Date	7	False	Date de fin de la trace
PrevisionalArriveUtcDate	Date	8	False	Date prévue d'arrivée
ShipmentStatus	Status	9	False	Etat d'avancement de livraison de la mission
RemainingDistanceInMetersBeforeArrival	Int32 nullable	10	False	Remaining distance in meters before arrival
RemainingTimeInSecondsBeforeArrival	Int32 nullable	11	False	Remaining time in seconds before arrival
LastApproachModificationUtcDatetime	Date	12	False	Last approach modification datetime (UTC)
ResultComputationUtcDatetime	Date	13	False	Result computation datetime (UTC)
ApproachCoordinates	List`1 - GeoData	14	False	Track to draw itinerary from last approach computation location to destination
NextApproachComputationDate	Date	15	False	NextApproachComputation datetime (UTC)
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "RouteSteps": [],
  "Errors": [],
  "RouteCoordinates": [],
  "Status": 200,
  "Distance": 0.0,
  "DrivingDurationInSec": 0,
  "StopDurationInSec": 0,
  "StopCount": 0,
  "FromUtcDate": null,
  "ToUtcDate": null,
  "PrevisionalArriveUtcDate": null,
  "ShipmentStatus": 0,
  "RemainingDistanceInMetersBeforeArrival": null,
  "RemainingTimeInSecondsBeforeArrival": null,
  "LastApproachModificationUtcDatetime": null,
  "ResultComputationUtcDatetime": null,
  "ApproachCoordinates": null,
  "NextApproachComputationDate": null
}

GetShipmentStatusResponse

Réponse à la méthode GetShipmentStatus

Propriété	Type	Ordre	Obligatoire	Description
PickupSchedules	ShipmentSchedule	0	False	Horaires d'enlèvements (Contractuels, Estimés, Réalisés)
DeliverySchedules	ShipmentSchedule	1	False	Horaires de livraison (Contractuels, Estimés, Réalisés)
Events	List`1 - ShipmentEvent	2	False	Liste des événements de la mission
SubContractorTrackingUrl	String	3	False	Lien de suivi vers un transporteur externe dans le cas d'une sous-traitance
StatusCode	String	4	False	Code état Dispatch courant de la mission
StatusLabel	String	5	False	Libellé état Dispatch courant de la mission
DriverCode	String	6	False	Code du chauffeur affecté à la mission
DriverName	String	7	False	Libellé du chauffeur affecté à la mission
DriverPhotoUrl	String	8	False	Url de la photo du chauffeur
SignAtPickup	String	9	False	Emargé à l'enlèvement
SignAtDelivery	String	10	False	Emargé à la livraison
TrackId	String	11	False	Numéro de tracking
HasBankData	Boolean	12	False	Indique si la mission possède des données bancaires issues d'un paiement
BillDownLoadId	String	13	False	Numéro de téléchargement de la facture associée à la mission
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PickupSchedules": null,
  "Errors": [],
  "DeliverySchedules": null,
  "Status": 200,
  "Events": null,
  "SubContractorTrackingUrl": null,
  "StatusCode": null,
  "StatusLabel": null,
  "DriverCode": null,
  "DriverName": null,
  "DriverPhotoUrl": null,
  "SignAtPickup": null,
  "SignAtDelivery": null,
  "TrackId": null,
  "HasBankData": false,
  "BillDownLoadId": null
}

GetStatisticsResponse

Réponse de la requete GetStatistics

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid permettant de télécharger un document généré sur le serveur à partir de InitOrderReport valable 30min
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "Status": 200
}

GetSubServicesResponse

Réponse à la méthode GetSubServices

Propriété	Type	Ordre	Obligatoire	Description
SubServices	List`1 - SubService	0	False	Liste des sous prestations associées à la prestation
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "SubServices": null,
  "Errors": [],
  "Status": 200
}

GetSubcontractorEmployeesResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
SubcontractorEmployees	List`1 - SubcontractorEmployee	0	False	Subcontractor employees associated to subcontractor
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "SubcontractorEmployees": null,
  "Errors": [],
  "Status": 200
}

GetTrackedMissionDetailsResponse

Réponse de la méthode GetTrackedMissionDetails

Propriété	Type	Ordre	Obligatoire	Description
TrackedMissionDetails	TrackedMissionDetails	0	False	Details de la mission trackée
WayPoints	List`1 - WayPoint	1	False	Liste des points de passages traqués
TrackingOrderSummary	TrackingSummary	2	False	Résumé du tracking
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "TrackedMissionDetails": null,
  "Errors": [],
  "WayPoints": null,
  "Status": 200,
  "TrackingOrderSummary": null
}

GetTrackedMissionsResponse

Résultat de recherche des missions trackées

Propriété	Type	Ordre	Obligatoire	Description
TrackedMissions	List`1 - TrackedMission	0	False	Missions trackées correspondant à la recherche
PaginationResult	ListPaginationResult	1	False	Résultat de la pagination
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "TrackedMissions": null,
  "Errors": [],
  "PaginationResult": null,
  "Status": 200
}

GetTrackedPackagesHistoryResponse

Réponse de la méthode GetTrackedPackagesHistory

Propriété	Type	Ordre	Obligatoire	Description
HistoryEntries	List`1 - TrackedPackageEvent	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

GetTrackedPackagesResponse

Réponse de la méthode GetTrackedPackages

Propriété	Type	Ordre	Obligatoire	Description
TrackedPackages	List`1 - TrackedPackage	0	False	Liste des colis traqués
PaginationResult	ListPaginationResult	1	False	Résultat de la pagination
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "TrackedPackages": null,
  "Errors": [],
  "PaginationResult": null,
  "Status": 200
}

GetTrackedRegularTransportsResponse

Résultat de recherche des ordres réguliers trackés

Propriété	Type	Ordre	Obligatoire	Description
TrackedRegularTransports	List`1 - TrackedRegularTransport	0	False	Ordre régulier trackés correspondant à la recherche
PaginationResult	ListPaginationResult	1	False	Résultat de la pagination
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "TrackedRegularTransports": null,
  "Errors": [],
  "PaginationResult": null,
  "Status": 200
}

GetTrackedWayPointsResponse

Réponse de la méthode GetTrackedWayPoints

Propriété	Type	Ordre	Obligatoire	Description
WayPoints	List`1 - WayPoint	0	False	Liste des points de passages traqués
PaginationResult	ListPaginationResult	1	False	Résultat de la pagination
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "WayPoints": null,
  "Errors": [],
  "PaginationResult": null,
  "Status": 200
}

GetTrackyPictoForServiceResponse

Réponse à la méthode GetTrackyPictoForService

Propriété	Type	Ordre	Obligatoire	Description
PictoBase64	String	0	False	Pictogramme Tracky pour une prestation en base 64
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PictoBase64": null,
  "Errors": [],
  "Status": 200
}

GetTranslationsResponse

Réponse de la méthode GetTranslations

Propriété	Type	Ordre	Obligatoire	Description
Translations	Dictionary`2 - String	0	False	Codes des chaines de texte localisées et leurs traductions
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Translations": null,
  "Errors": [],
  "Status": 200
}

GetTransportTemperaturesResponse

Reponse pour la méthode GetTransportTemperatures

Propriété	Type	Ordre	Obligatoire	Description
RawData	String	0	False	Données retournées par le fournisseur de températures
TemperaturesSensors	List`1 - TemperaturesSensor	1	False	Données retournées par le fournisseur de températures
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "RawData": null,
  "Errors": [],
  "TemperaturesSensors": null,
  "Status": 200
}

GetUserWebProfileResponse

Réponse de la requête permettant de charger un profil

Propriété	Type	Ordre	Obligatoire	Description
UserWebProfile	UserWebProfile	0	False	Profil chargé
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "UserWebProfile": null,
  "Errors": [],
  "Status": 200
}

GetVersionResponse

Réponse à la méthode GetVersion

Propriété	Type	Ordre	Obligatoire	Description
DispatchVersion	String	0	False	Version de Dispatch du transporteur
ApiVersion	Int32	1	False	Numéro de version de l'API
DispatchWebVersion	String	2	False	Version de DispatchWeb
DispatchWebVirtualHost	String	3	False	Répertoire virtuel de DispatchWeb
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DispatchVersion": null,
  "Errors": [],
  "ApiVersion": 0,
  "Status": 200,
  "DispatchWebVersion": null,
  "DispatchWebVirtualHost": null
}

GetWebUserRightResponse

Réponse de la requête permettant de récupérer les droits

Propriété	Type	Ordre	Obligatoire	Description
ListWebUserRight	List`1 - WebUserRight	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ListWebUserRight": [],
  "Errors": [],
  "Status": 200
}

ImportCustomerResponse

Réponse à la méthode ImportCustomer

Propriété	Type	Ordre	Obligatoire	Description
CustomerImported	CustomerImport	0	False	Client importé
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "CustomerImported": null,
  "Errors": [],
  "Status": 200
}

ImportShipmentsResponse

Réponse à la méthode ImportShipments

Propriété	Type	Ordre	Obligatoire	Description
ShipmentImportId	Int32	0	False	Identifiant permettant le suivi de l'import de missions
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentImportId": 0,
  "Errors": [],
  "Status": 200
}

ImportUserResponse

Réponse à la méthode ImportUser

Propriété	Type	Ordre	Obligatoire	Description
UserImported	UserImport	0	False	Utilisateur importé
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "UserImported": null,
  "Errors": [],
  "Status": 200
}

InitDailyGeoDeviceReportResponse

Réponse de la requete DailyGeoDeviceReport

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid qui permet de télécharger un document généré sur le serveur à partir de DailyGeoDeviceReport valable 30min
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "Status": 200
}

InitGetRegularTransportStatisticsDocumentResponse

Réponse de la requete InitGetRegularTransportStatisticsDocument

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid qui permet de télécharger un document généré sur le serveur à partir de InitOrderExport valable 30min
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "Status": 200
}

InitInternalGenerateReportResponse

Réponse de la requete InitInternalGenerateReportResponse

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid qui permet de télécharger un document généré sur le serveur à partir de InitInternalGenerateReportResponse valable 30min
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "Status": 200
}

InitOrderExportResponse

Réponse de la requete InitOrderExport

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid qui permet de télécharger un document généré sur le serveur à partir de InitOrderExport valable 30min
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "Status": 200
}

InitOrderReportGenerationResponse

Réponse de la requete InitOrderReportGeneration

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid qui permet de télécharger un document généré sur le serveur à partir de InitOrderReportGeneration valable 30min
DocumentDownloadStatus	EDocumentDownloadStatus	1	False	Status de téléchargement du document
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "DocumentDownloadStatus": 1,
  "Status": 200
}

InitTransportOrderReportGenerationResponse

Réponse de la requete InitRegularOrderReportGeneration

Propriété	Type	Ordre	Obligatoire	Description
DownloadGuid	String	0	False	Guid qui permet de télécharger un document généré sur le serveur à partir de InitRegularOrderReportGenerationResponse valable 30min
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DownloadGuid": null,
  "Errors": [],
  "Status": 200
}

LoadAddressResponse

réponse de chargement d'adresse

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse chargée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "Status": 200
}

LoadLikeAddressResponse

Réponse des méthodes LoadLikeAddress et LoadLikeLastShipmentAddressRequest

Propriété	Type	Ordre	Obligatoire	Description
AddressList	List`1 - Address	0	False	Adresses trouvée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "AddressList": [],
  "Errors": [],
  "Status": 200
}

LoadLikeAnomaliesTypesResponse

Réponse des méthodes LoadLikeAnomaliesTypes

Propriété	Type	Ordre	Obligatoire	Description
Anomalies	List`1 - AnomalyType	0	False	Types d'anomalies trouvés
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Anomalies": [],
  "Errors": [],
  "Status": 200
}

LoadLikeBarcodesResponse

Réponse des méthodes LoadLikeBarcodes

Propriété	Type	Ordre	Obligatoire	Description
Barcodes	List`1 - String	0	False	Codes à barres trouvés
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Barcodes": [],
  "Errors": [],
  "Status": 200
}

LoadLikeDelegatorOrderersResponse

Réponse d'appel à la méthode LoadLikeDelegatorOrderers contenant la liste des donneurs d'ordres délégateurs

Propriété	Type	Ordre	Obligatoire	Description
Delegators	List`1 - DelegatorOrderer	0	False	Délégateurs trouvés
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Delegators": [],
  "Errors": [],
  "Status": 200
}

LoadLikeTrackedAddressesResponse

Réponse des méthodes LoadLikeTrackedAddresses

Propriété	Type	Ordre	Obligatoire	Description
Addresses	List`1 - Address	0	False	Adresses trouvées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Addresses": [],
  "Errors": [],
  "Status": 200
}

LoadLikeTrackedCitiesResponse

Réponse des méthodes LoadLikeTrackedCities

Propriété	Type	Ordre	Obligatoire	Description
Cities	List`1 - City	0	False	Villes trouvées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Cities": [],
  "Errors": [],
  "Status": 200
}

LoadPackageFamilyResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
PackageFamilyList	List`1 - PackageFamily	0	True	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "PackageFamilyList": null,
  "Errors": [],
  "Status": 200
}

LoadPackingReferenceValuesResponse

Réponse d'appel à la méthode LoadPackingReferenceValues contenant la liste des valeurs de la référence

Propriété	Type	Ordre	Obligatoire	Description
Values	List`1 - PackingReferenceValue	0	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Values": [],
  "Errors": [],
  "Status": 200
}

LoadShipmentAddressResponse

réponse de chargement d'adresse

Propriété	Type	Ordre	Obligatoire	Description
InternalShipmentAddress	Address	0	False	Adresse chargée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "InternalShipmentAddress": null,
  "Errors": [],
  "Status": 200
}

LoadShipmentsResponse

Réponse d'une demande de chargement de mission

Propriété	Type	Ordre	Obligatoire	Description
ShipmentList	List`1 - Shipment	0	False	Liste des ordres de transport de la mission
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentList": null,
  "Errors": [],
  "Status": 200
}

NormalizeAddressResponse

Réponse à la méthode NormalizeAddress

Propriété	Type	Ordre	Obligatoire	Description
AddressToNormalize	Address	0	False	Adresse initiale
IsAddressNormalizedFounded	Boolean	1	False	Indique si une adresse a été trouvée
AddressNormalized	List`1 - Address	2	False	Liste des adresses correspondantes à l'adresse initiale de la plus précise à la moins précise
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "AddressToNormalize": null,
  "Errors": [],
  "IsAddressNormalizedFounded": false,
  "Status": 200,
  "AddressNormalized": []
}

OrdererDefaultAddressResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse par défaut du donneur d'ordre
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "Status": 200
}

PunchoutAuthenticationResponse

Réponse à la méthode PunchoutSetupRequest

Propriété	Type	Ordre	Obligatoire	Description
DispatchWebUrl	String	0	False	Url de la page de saisie de mission DispatchWeb
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "DispatchWebUrl": null,
  "Errors": [],
  "Status": 200
}

RawDataSearchResponse

Pas de description pour cette classe

Propriété	Type	Ordre	Obligatoire	Description
Data	List`1 - JsonableHashTable`1	0	False	Pas de description
PageNumber	Int32	1	False	Pas de description
PageCount	Int32	2	False	Pas de description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Data": null,
  "Errors": [],
  "PageNumber": 0,
  "Status": 200,
  "PageCount": 0
}

RenamePoiFamilyResponse

Réponse pour renommer une famille de POI

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

ResponseType

Type de réponse de base de l'API

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

SaveBookmarkAddressResponse

Réponse de la methide SaveBookmarkAddress

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse sauvegardée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "Status": 200
}

SaveSatisfactionSurveyResponse

Réponse de la sauvegarde d'une enquête de satisfaction

Propriété	Type	Ordre	Obligatoire	Description
Address	Address	0	False	Adresse sauvegardée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Address": null,
  "Errors": [],
  "Status": 200
}

SaveWebUserRightProfileResponse

Réponse de la methode SaveWebUserRightProfile

Propriété	Type	Ordre	Obligatoire	Description
UserWebProfile	UserWebProfile	0	False	Profil droits donneur d'ordre sauvegardée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "UserWebProfile": null,
  "Errors": [],
  "Status": 200
}

SearchBillResponse

Type de réponse sur la recherche de facture

Propriété	Type	Ordre	Obligatoire	Description
BillList	List`1 - Bill	0	False	Liste des factures trouvées
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "BillList": null,
  "Errors": [],
  "Status": 200
}

SearchResponse

Réponse de la méthode search

Propriété	Type	Ordre	Obligatoire	Description
ShipmentList	List`1 - Shipment	0	False	Liste des missions trouvées
Pagination	ListPaginationResult	1	False	Objet de pagination
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentList": null,
  "Errors": [],
  "Pagination": null,
  "Status": 200
}

SecureTransportResponse

Réponse de la méthode SecureTransport

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

SetCustomParametersResponse

Réponse de la méthode SetCustomParameters

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

UpdateOrdererPointOfInterestDetailsResponse

Réponse pour la mise à jour d'un POI associé à un donneur d'ordre

Propriété	Type	Ordre	Obligatoire	Description
Latitude	Double nullable	0	False	Latitude calculée par dispatch du point d'interet
Longitude	Double nullable	1	False	Longitude calculée par dispatch du point d'interet
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Latitude": null,
  "Errors": [],
  "Longitude": null,
  "Status": 200
}

UpdatePackageLineResponse

Réponse de la méthode UpdatePackageLine

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

UpdatePasswordResponse

Réponse de la méthode UpdatePassword

Propriété	Type	Ordre	Obligatoire	Description
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Errors": [],
  "Status": 200
}

UpdateShipmentResponse

Réponse à la méthode Update shipment

Propriété	Type	Ordre	Obligatoire	Description
Shipment	Shipment	0	False	Mission Aller, seules les informations tarifaires et délais sont renseignées
ReturnShipment	Shipment	1	False	Mission Retour, seules les informations tarifaires et délais sont renseignées
TotalAmountWithTaxes	Double	2	False	Montant total de la comande TTC
TotalAmountWithoutTaxes	Double	3	False	Montant total de la comande HT
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "Shipment": null,
  "Errors": [],
  "ReturnShipment": null,
  "Status": 200,
  "TotalAmountWithTaxes": 0.0,
  "TotalAmountWithoutTaxes": 0.0
}

ValidateQuotationResponse

Réponse de la méthode ValidateQuotation qui permet de valider un devis

Propriété	Type	Ordre	Obligatoire	Description
ShipmentId	Int32	0	False	Numéro de la mission validée dans Dispatch
TrackId	String	1	False	Numéro de tracking de la mission validée dans Dispatch
QuoteValidationErrorType	QuoteValidationError	2	False	Type de l'erreur remontée par la validation de devis
MissingServiceFileCategories	List`1 - FileCategory	3	False	Catégories de fichiers pour lesquelles au moins un fichier est manquant pour la validation de la prestation
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "ShipmentId": 0,
  "Errors": [],
  "TrackId": null,
  "Status": 200,
  "QuoteValidationErrorType": 0,
  "MissingServiceFileCategories": null
}

VoucherOrderResponse

Réponse de commande directe de carnet de bon (sans paiement comptant)

Propriété	Type	Ordre	Obligatoire	Description
TotalAmountWithTaxes	Decimal	0	False	Montant TTC de la commande
InternalBillNumber	Int32 nullable	1	False	Numéro interne de la facture générée
Errors	List`1 - String	0	False	Liste des erreur rencontrées, null si pas d'erreur
Status	ResponseStatus	1	True	Statut de la réponse

{
  "TotalAmountWithTaxes": 0.0,
  "Errors": [],
  "InternalBillNumber": null,
  "Status": 200
}