What's new in V1.6

New Endpoints: 3

POST /cancelMissions
POST /finishRoutes
POST /sendSlotBookingMessage

Deleted Endpoints: None

Modified Endpoints: 34

POST /addMissionsToRoute

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: route
        
        Properties changed
        
        New property: initialDeliveryMissions
        
        New property: loadedDeliveryMissions
        
        New property: preparationEndTime
        
        New property: routeEndSurveyId
        
        New property: routeStartSurveyId

POST /addUser

New header param: ProfileFieldRepresentation

POST /addZonesToStudy

Summary changed from 'Create a study' to 'Add zones to a study'
Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: zones
        
        Items changed
        
        Properties changed
        
        New property: countryCode

POST /assignRoute

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: route
        
        Properties changed
        
        New property: initialDeliveryMissions
        
        New property: loadedDeliveryMissions
        
        New property: preparationEndTime
        
        New property: routeEndSurveyId
        
        New property: routeStartSurveyId

POST /batchOptimization

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: filter
        
        Properties changed
        
        New property: excludeWaitingMissions
        
        Modified property: options
        
        Properties changed
        
        New property: noImprovementTimeout

POST /createContractors

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: contractors
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: contractors
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId
        
        Modified property: contractorsNotImported
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId

POST /createMissions

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: freeMotive
        
        New property: motiveId
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'
        
        Modified property: missionsNotImported
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'

POST /createRoute

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: routeEndSurveyId
        
        New property: routeStartSurveyId
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: route
        
        Properties changed
        
        New property: initialDeliveryMissions
        
        New property: loadedDeliveryMissions
        
        New property: preparationEndTime
        
        New property: routeEndSurveyId
        
        New property: routeStartSurveyId

POST /createStudy

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: zones
        
        Items changed
        
        Properties changed
        
        New property: countryCode

POST /createSubcontractors

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: subcontractors
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: subcontractors
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId
        
        Modified property: subcontractorsNotImported
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId

POST /createTicket

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: ticket
        
        Properties changed
        
        New property: role

GET /history

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: changes
        
        Items changed
        
        Properties changed
        
        New property: sector

POST /listContractors

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: contractors
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId

POST /listMissions

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'

POST /listRoutes

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: unfinishedRoutesOnly
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: routes
        
        Items changed
        
        Properties changed
        
        New property: preparationEndTime
        
        Modified property: zoneId
        
        Type changed from 'object' to 'string'
        
        Properties changed
        
        Deleted property: id
        
        Deleted property: rules

POST /listStudies

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: zones
        
        Items changed
        
        Properties changed
        
        New property: countryCode

POST /listSubcontractors

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: subcontractors
        
        Items changed
        
        Properties changed
        
        New property: missionsEditConfigurationId

POST /listTickets

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: tickets
        
        Items changed
        
        Properties changed
        
        New property: role

GET /listUsers

New header param: ProfileFieldRepresentation

POST /listZones

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: studyId
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: zones
        
        Items changed
        
        Properties changed
        
        New property: countryCode

GET /missionByCode/{missionId}

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: changes
        
        Items changed
        
        Properties changed
        
        New property: sector

POST /reverseLogistics

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: initialStatus
        
        New property: newMissionType
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        New property: notSupportMissions
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'

GET /study/{studyId}

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: zone
        
        Properties changed
        
        New property: countryCode

POST /updateContractor

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: response
        
        Properties changed
        
        New property: missionsEditConfigurationId

POST /updateMission

New header param: recomputeNotificationConfig
New header param: recomputeStatusConfig
Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: freeMotive
        
        New property: motiveId
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'
        
        Modified property: missionsNotImported
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'

POST /updateMissions

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: geocodingThreshold
        
        New property: overrideGeoThreshold
        
        New property: recomputeNotificationConfig
        
        New property: recomputeStatusConfig
        
        New property: updateZone
        
        Modified property: fields
        
        Example changed from [containerType priority origin scheduledDeliverer notificationConfig statusCustomizationType missionDuration oneTimePasswordType allSkillsRequired requiredSkills key deliverBeforePickup maxTimeSpacing productType length width height weight volume packageValue comment quantities customfield_key1 customfield_key2..] to [containerType priority origin scheduledDeliverer notificationConfig statusCustomizationType missionDuration oneTimePassword oneTimePasswordPolicy pudoPolicy allSkillsRequired requiredSkills key deliverBeforePickup maxTimeSpacing productType length width pickupPudoAddressId deliveryPudoAddressId pickupAddress consignee updateZone deliveryAskedDate deliveryAskedEndDate pickupAskedDate pickupAskedEndDate height weight volume packageValue comment quantities customfield_key1 customfield_key2..]
        
        Items changed
        
        Example changed from '["containerType","priority","origin","scheduledDeliverer","notificationConfig","statusCustomizationType","missionDuration","oneTimePasswordType","allSkillsRequired","requiredSkills","key","deliverBeforePickup","maxTimeSpacing","productType","length","width","height","weight","volume","packageValue","comment","quantities","customfield_key1","customfield_key2.."]' to '["containerType","priority","origin","scheduledDeliverer","notificationConfig","statusCustomizationType","missionDuration","oneTimePassword","oneTimePasswordPolicy","pudoPolicy","allSkillsRequired","requiredSkills","key","deliverBeforePickup","maxTimeSpacing","productType","length","width","pickupPudoAddressId","deliveryPudoAddressId","pickupAddress","consignee","updateZone","deliveryAskedDate","deliveryAskedEndDate","pickupAskedDate","pickupAskedEndDate","height","weight","volume","packageValue","comment","quantities","customfield_key1","customfield_key2.."]'
        
        Modified property: missionInfo
        
        Properties changed
        
        New property: freeMotive
        
        New property: motiveId
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'
        
        Modified property: missionsNotUpdated
        
        Type changed from 'array' to 'object'
        
        Items changed
        
        Schema deleted
        
        AdditionalProperties changed
        
        Schema added

POST /updateMultiLegStatusInformation

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: missions
        
        Items changed
        
        Properties changed
        
        New property: deliveryPudoType
        
        New property: pickupPudoType
        
        New property: substatus
        
        Modified property: deliveryAskedDate
        
        Nullable changed from false to true
        
        Modified property: deliveryAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: notificationConfig
        
        Description changed from 'Notification configuration identifier.' to 'Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.'
        
        Modified property: pickupAskedDate
        
        Nullable changed from false to true
        
        Modified property: pickupAskedEndDate
        
        Nullable changed from false to true
        
        Modified property: statusCustomizationType
        
        Description changed from 'Type of sub-status configuration to be applied to this mission.' to 'Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.'

POST /updateRoute

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: routeEndSurveyContent
        
        New property: routeEndSurveyId
        
        New property: routeStartSurveyContent
        
        New property: routeStartSurveyId
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: route
        
        Properties changed
        
        New property: initialDeliveryMissions
        
        New property: loadedDeliveryMissions
        
        New property: preparationEndTime
        
        New property: routeEndSurveyId
        
        New property: routeStartSurveyId

POST /updateSubcontractor

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: response
        
        Properties changed
        
        New property: missionsEditConfigurationId

PUT /updateTicket

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: ticket
        
        Properties changed
        
        New property: role

PUT /updateUser

New header param: ProfileFieldRepresentation

POST /updateZone

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        Modified property: zone
        
        Properties changed
        
        New property: countryCode
Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: zone
        
        Properties changed
        
        New property: countryCode

GET /zone/{zoneId}

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: zone
        
        Properties changed
        
        New property: countryCode

GET /zones

Responses changed
- Modified response: default
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: zones
        
        Items changed
        
        Properties changed
        
        New property: countryCode