Add-on requirements configuration

GoLocal API add-ons are supplementary components and features enhancing the core functionalities of the GoLocal API. Add-ons are designed to extend the capabilities or add additional features to the GoLocal APIs, allowing for customization.

GoLocal add-ons can come in the form of extra code libraries, tools, or services that are integrated into the base API. They are typically optional; the base API can function without them, but they offer added benefits or conveniences for those who choose to use them.

The GoLocal add-ons have their own set of methods, events, and properties, just like an API, that defines how they work and how they can be used.

This document outlines the required attribute settings for various delivery add-on scenarios. Any attribute not explicitly required for a given scenario, should be set to false. Combinations of add-ons are allowed, unless otherwise noted.

1. Signature required
   When a signature is required for a delivery, set the following attribute setting:

 proofOfDelivery”: true "signature": true "attendedDelivery": true

2. One-Time Password (OTP) required
   When an OTP is required for drop-off, set the attributes to:

 "attendedDelivery": true "isDropOffOTPRequired": true_

📘

Note: For attended deliveries, you must choose either a signature or an OTP, but not both. Do not set “signature”: true and “isDropOffOTPRequired”: true at the same time.

3. Photo proof of Delivery required
   When photo proof of delivery is required, set the attributes to:

 "proofOfDelivery": true "capturePhotoProof": true

4. Chain of Custody required
   When chain of custody is required, set the attribute to:

 "chainOfCustody": true

5. Combining add-ons
   You can combine multiple add-ons if they are not mutually exclusive. For example, if both a signature and photo proof of the delivery order are required, set the attributes to:

 "signature": true "attendedDelivery": true "proofOfDelivery": true "capturePhotoProof": true

5. Ensure that conflicting configurations (like “signature” and “isDropOffOTPRequired” together) are avoided.
   Returnable is set to true as the default setting.