Introduce Address Delivery Instructions
🔍 Problem Statement
As a fulfillment user, I experience issues where customers’ specific delivery preferences (e.g., “leave at back door” or “place under awning”) cannot be recorded or communicated through the platform, which results in missed or incorrect deliveries and lower customer satisfaction.
💡 User Story
As an end user, I want to add delivery instructions to each shipping address so that fulfillment teams and drivers can follow these preferences accurately during delivery operations.
🎯 Definition of Done (DoD)
✔ Given a shipping address record, when a user edits or creates it, then a new text field called delivery_instructions is available and saved with the address.
✔ This change will impact API, Dashboard UI, and SDKs, specifically:
Core API & Open API:
POST /addressesandPATCH /addresses/:idmust accept a newdelivery_instructionsfield (string, nullable).GET /addressesandGET /addresses/:idmust return the field.The field must be fully documented in both the Core API and Open API specifications.
Dashboard UI:
Add an editable text area labeled Delivery Instructions under shipping address management screens.
JS-SDK & ReactJS Elements:
Expose
delivery_instructionsin relevant address methods and UI components to ensure full support for read/write operations.Exports:
Include the field in List & Fulfillment exports (CSV/Excel).
Webhooks:
Include
delivery_instructionsin address.created and address.updated payloads only (excluded from fulfillment events).
✔ This solution will include the following limitations:
Only available for shipping addresses, not billing addresses.
Character limit: 500 characters max.
Not required; field is optional.
Field is text only, no formatting or attachments supported.
Log in to comment and vote
Comments1
Michael Ghattas
Apr 2
This has been released:
https://docs.pelcro.com/changelog#-platform-delivery-instructions-for-shipping-addresses