CoDeliver External API

Το external API χρησιμοποιείται από εγκεκριμένα τρίτα συστήματα (π.χ. POS / order-taking) για δημιουργία και διαχείριση delivery requests στο CoDeliver.

Τα credentials δίνονται ιδιωτικά στο onboarding.
Το authentication γίνεται με shared secret στο header Authorization.
Τρέχον production base URL: https://d9p03pgzcl.execute-api.eu-west-1.amazonaws.com/prod.

Τι προορίζεται να καλύπτει το API

Το API είναι σχεδιασμένο για server-to-server integration ώστε το σύστημά σου να περνά στο CoDeliver τα γεγονότα του κύκλου ζωής μιας παραγγελίας διανομής.

Pre-calculate: προαιρετική εκτίμηση κόστους/χρόνου πριν τη δημιουργία delivery request.
Create request: δημιουργία του delivery request από το order σου.
Pickup ready: ενημέρωση ότι η παραγγελία είναι έτοιμη για παραλαβή.
Cancel: ακύρωση όταν το order δεν πρέπει να εκτελεστεί.

Τι δεν είναι το External API

Δεν είναι public client API για browser/mobile app calls με ευαίσθητα κλειδιά.
Δεν αντικαθιστά το POS/ERP domain logic σου (pricing, stock, invoicing).
Δεν χρησιμοποιείται για κοινοποίηση ιδιωτικών στοιχείων onboarding δημόσια.

Προτεινόμενη ροή υλοποίησης

Κάνεις mapping των καταστημάτων σου με group / store_id.
(Προαιρετικά) καλείς estimate για checkout εμπειρία.
Δημιουργείς request με σταθερό request_id για idempotent retries.
Χρησιμοποιείς vendor_reference_id για traceability με το δικό σου order id.
Στέλνεις pickup-ready/cancel events μόνο όταν αλλάζει πράγματι η κατάσταση του order.

API reference

Η πλήρης τεκμηρίωση ReDoc ανοίγει σε ξεχωριστή υποσελίδα για καλύτερη εμπειρία ανάγνωσης.

Άνοιγμα API reference Raw OpenAPI YAML Download Postman Collection

Παραδείγματα payloads (γρήγορο start)

Τα παρακάτω examples δείχνουν το ελάχιστο payload που χρειάζεται συνήθως για ένα βασικό flow.

Create request (request body)

{
  "group": "demo",
  "store_id": "S1",
  "request_id": "demo_R1",
  "vendor_reference_id": "POS-10342",
  "mobile": "6900000000",
  "grand_total": 12.3,
  "userLat": 37.98,
  "userLng": 23.72
}

Create request (ενδεικτικό response)

{
  "ok": true,
  "message": "request_created",
  "data": {
    "request_id": "demo_R1",
    "status": "created"
  }
}

Pickup ready (request body)