Store

Module webhooks

• store.order.cancelled

• store.order.created

• store.order.fulfilled

• store.order.paid

• store.order.refunded

Payload Format

Name	Type	Description
id	String	Order id. Format: UUID.
userId	String	User id. Format: UUID.
amount	String	Order amount. Format: Number.
assetCode	String	Order currency.
trackingId	String	Tracking id.
paidAmount	String	Order current paid amount. Format: Number.
orderStatus	String	Order status. Enum: ['canceled', 'draft', 'fulfilled', 'unfulfilled'].
paymentStatus	String	Payment status. Enum: ['fully_paid', 'fully_refunded', 'partially_paid', 'partially_refunded', 'unpaid'].
metadata	Object	Metadata.
reference	String	Reference code.
canceledAt	Date	Date of cancelation.
paidAt	Date	Date of payment.
fulfilledAt	Date	Date of fulfilment.
netAmount	String	Value of order products (no fees or shipping). Format: Number.
walletId	String	Wallet id. Format: UUID.

Payload example

{
  "id": "3a3b10e1-80ed-4f2b-b60a-59e0aa0764e4",
  "userId": null,
  "bonus": "0.00000000",
  "amount": "20.00000000",
  "assetCode": "4uh8xu8gg53",
  "bonusAssetCode": null,
  "trackingId": null,
  "paidAmount": "5.00000000",
  "orderStatus": "fulfilled",
  "paymentStatus": "partially_refunded",
  "metadata": {
    "refundAmount": "15.00000000",
    "refundReason": { "code": "foobar" }
  },
  "reference": "AYJZAWH76X",
  "customData": {},
  "canceledAt": null,
  "paidAt": null,
  "fulfilledAt": null,
  "createdAt": "2024-10-28T13:52:23.900Z",
  "updatedAt": "2024-10-28T13:52:23.900Z",
  "netAmount": "79.00000000",
  "walletId": "9109f615-eeb1-443a-9141-455f5e22b468"
}

store.order.cancelled

Cancelation of an order webhook event.

store.order.created

Creation of an order webhook event.

store.order.fulfilled

Fulfilment of an order webhook event.

store.order.paid

Payment of an order webhook event.

store.order.refunded

Refund of an order webhook event.