SPL APIs

PUDO Delivery Models

Points to consider:

  1. The delivery model in the shipment creation should be one of three options: "DoortoRetail", "RetailtoDoor", "RetailtoRtail"

  2. For the three options, the customers can utilize our endpoint "GetSPLOffice" to obtain the full address for that SPL Office/Parcel Location, including the Mowahhad's ID stored in the external code

    1. DoortoRetail: the Office or Parcel location address details should be provided in the consignee address details

    2. RetailtoDoor: the Office or Parcel location address details should be provided in the shipper address details

    3. RetailtoRtail: the Office or Parcel location address details should be provided in the shipper and consignee addresses

  3. To differentiate the SPL Office from the Parcel Locations in the "GetSPLOffice" API response, the customers can use the field "IsParcelLocation"

  4. It's also important to have the correct address type ID passed for the shipper and consignee address, where (3 for Parcel Locations and 4 for SPL Offices)