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": "e706d18f-bed0-4ded-9b5e-122fcb879405",
  "BulkBreakingInformation": null,
  "IsQuoteUnderApproval": false,
  "AdvancedDateMode": false,
  "PickupSchedules": null,
  "DeliverySchedules": null,
  "DelegateOrdererCode": null,
  "AdditionalEmailsOnQuoteCreation": null,
  "TrackingUrl": null,
  "IsFinalizedQuote": false
}