Integrate Real Commerce into your App

Easily connect your agents and customers to the value chain of leading FMCG suppliers in your territory. You'll find comprehensive guides and documentation to help you start working with the ShopTopUp CommerceAPI as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Order Dispatched

This event is fired when an order is dispatched for delivery. The dispatch event is triggered by the delivery driver starting his trip. This event provides an opportunity to notify the user about the incoming delivery as well as contact details of the incoming delivery driver

Callback Webhook

Register a callback webhook URL on the developer console. This webhook is called when the event is fired.

Payload

The webhook URL is called with the following payload

const doc = {
      amount: data.total,
      createdAt: data.createdAt,
      shippingStatus: data.shippingStatus,
      transactionId: data._id,
      extUserId: data.extUserId,
      deliveryAssigneeName: data.deliveryAssigneeName,
      deliveryAssigneePhone: data.deliveryAssigneePhone
    };

📘

Retrieving full transaction details

To retrieve full details of the created order including items ordered, quantities, price, etc. or a list previous transactions, you can call the respective APIs with the transactionId or extUserId respectively

Updated 8 days ago

Order Dispatched


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.