Set Pickup Default Data Request

The SetPickupDefaultDataRequest API enables MOL users to configure default pickup parameters that will be automatically applied to automatic bulk pickup shipments. These settings serve as templates for pickup requests, eliminating the need to specify pickup details for each individual shipment in automated workflows. 

In details:

• The value of the field Cutoff can be either MORNING or AFTERNOON (case insensitive).

  • By selecting Morning, pickup requests will be automatically sent to the couriers for same-day pickup, but only for shipments created by the morning cut-off time (e.g., 8:00 a.m.). Shipments created after this cut-off will be scheduled for pickup on the next business day.

  • Similarly, by selecting Afternoon, shipments created by the cut-off time (e.g., 10:00 p.m.) will be picked up the next business day, while those created after this time will be scheduled for pickup on the following business day.
    
    

• The value PreferredFrom requires a HH:MM format and it's the starting time of the preferred pickup window. Must be a valid time format and logically before PreferredTo
  
  

• The value PreferredTo requires a HH:MM format and it's the end time of the preferred pickup window. Must be a valid time format and logically later than PreferredTo
  
  

• The optional fields are:

  • Notes: standard instructions or special requirements for pickups (e.g., Contact before arrival)

  • Alternative from: start time HH:MM format of alternative pickup window. This is a backup option if preferred window is unavailable, and should not overlap with preferred window and logically before AlternativeTo

  • AlternativeTo: end time HH:MM format of alternative pickup window. This is a backup option if preferred window is unavailable, and should not overlap with preferred window and logically later than AlternativeFrom

The response status interpretation is as follows:

• CREATED: first-time configuration of default pickup data for the user

• UPDATED:,Modification of existing default pickup data

If an invalid value is inserted, an error will occur, specifying the allowed values: