Partner implementation checklist

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Use this checklist to confirm that your integration implements the same contract as the Nector reference integration.

Contract requirements

• Adapter methods: Expose getUser, registerUser, updateUser, getWalletDetails, calculateLoyaltyPoints, calculateDiscount, createOrder, cancelOrder, addPoints, and testConnection. Resolve customers by mobile number.
• Idempotent, reversible holds: Accept <salesChannelId>:<cartId> as the redemption reference. Support perform, confirm, and revert operations against the same key.
• Auto-revert timer: Release a hold that is not confirmed by an order-placed event within the agreed window. The Engage native default is 15 minutes.
• Webhook consumers: Handle order-placed, shipment-update, user-create, and user-update events. Resolve the cart through cart_object_id and act on current_shipment_status.
• Shipment-level accounting: Credit points on qualifying delivery statuses. Reverse points against shipment-level loyalty_discount for cancellations and the separate return shipment.
• Connection credential: Provide the integration identifier required for Engage to authenticate with the partner APIs. The reference implementation uses a per-channel webhookId sent as a header.

Readiness review

Before enabling live traffic, confirm that:

• Customer lookup works with a mobile number.
• Wallet balance is returned in real time and mapped to the Engage schema.
• Preview requests do not create a redemption hold.
• Redemption perform, confirm, and revert operations use the same cart-based reference.
• The automatic reversion window is configured and tested.
• Webhook processing is idempotent.
• Shipment statuses produce the correct credit, deduction, refund, or informational action.
• Coupon rewards use the Fynd Commerce API and coupon webhooks.
• Connection credentials are stored and transmitted securely.
• The testConnection operation succeeds.