medusa-plugin-quickink-logistics

This README documents plugin purpose, setup, APIs, and CSV import behavior.

Quickink logistics plugin for Medusa.
It manages serviceability by pincode with CRUD APIs and CSV import.

Module key

• QUICKINK_LOGISTICS_MODULE = "quickink_logistics"

Data model

Table: quickink_pincode

• id
• pincode
• cod_delivery
• prepaid_delivery
• pickup
• reverse_pickup
• created_at
• updated_at
• deleted_at

Install in Medusa app

Add plugin and module in your Medusa app medusa-config.ts:

plugins: [
  {
    resolve: "medusa-plugin-quickink-logistics",
  },
],
modules: [
  {
    resolve: "medusa-plugin-quickink-logistics/modules/quickink-logistics",
  },
]

Then run:

npx medusa db:migrate

Required for CSV bulk import: migrations must install the partial unique index IDX_quickink_pincode_pincode_active_unique on ("pincode") WHERE "deleted_at" IS NULL so upsert can run and soft-deleted pincodes can be re-created. If import fails with no unique or exclusion constraint matching the ON CONFLICT specification, run npx medusa db:migrate again.

Admin APIs

• GET /admin/quickink-logistics/pincodes
• GET /admin/quickink-logistics/pincodes/:id
• POST /admin/quickink-logistics/pincodes (rejects duplicate active pincode with DUPLICATE_ERROR)
• PUT /admin/quickink-logistics/pincodes/:id
• DELETE /admin/quickink-logistics/pincodes/:id
• PUT /admin/quickink-logistics/pincodes/pincode/:pincode (update by pincode value; active row only)
• DELETE /admin/quickink-logistics/pincodes/pincode/:pincode (soft-delete by pincode value; active row only)
• POST /admin/quickink-logistics/pincodes/import

Admin UI

After building the plugin, the Medusa Admin includes a Qikink serviceability page (Extensions) for CSV import, search, filters, pagination (50 per page), inline boolean toggles, create/edit modals, and soft-delete per row.

List query params

• limit (default 20)
• offset (default 0)
• pincode (optional contains search)
• deleteonly (true returns only soft-deleted rows; prefer list_scope below)
• list_scope: active | deleted | all (default: derive from deleteonly when unset)
• cod_delivery, prepaid_delivery, pickup, reverse_pickup (optional exact true/false filters)

CSV import

Endpoint:

curl -X POST http://localhost:9000/admin/quickink-logistics/pincodes/import \
  -H "Cookie: connect.sid=..." \
  -F "[email protected]"

Expected CSV headers:

Pincode,COD Delivery,Prepaid Delivery,Pickup,Reverse Pickup
737102,true,true,true,true
737137,true,true,true,false

Notes:

• Header names are matched case-insensitively.
• Boolean values accept true/false, 1/0, yes/no.
• If a pincode appears multiple times in one CSV, the last row wins.
• Import upserts by pincode. Rows not in the CSV stay unchanged.
• Large imports use batched INSERT ... ON CONFLICT (PostgreSQL). Tune with QUICKINK_CSV_UPSERT_BATCH_SIZE (default 2000).