API reference

Webhook events

Every event is a POST with { id, event, mode, createdAt, data }, signed in X-MarkitMall-Signature. How to receive them is in the Webhooks guide.

`order.received`#

The order reached MarkitMall (and, for a prepaid order, was paid).

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—

The customer confirmed by call/WhatsApp, or no confirmation was needed.

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—

Cancelled by you, the customer or us; cancellationReason says why.

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—

Handed to the courier; tracking holds the courier and number.

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—

Delivered; includes margin and marginReleaseAt.

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—

type: rto (refused at the door) or type: return (after delivery), with charge / credit.

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—

Price, title, images or variants changed — update your listing.

data

`productId` string	—
`importId` string	—
`externalProductId` string \| null	—
`product` Product \| null	—
`changes` string[]	—

Stock changed, including to zero — hide or show the listing.

data

`productId` string	—
`importId` string	—
`externalProductId` string \| null	—
`product` Product \| null	—
`changes` string[]	—

No longer available for dropshipping — unpublish it.

data

`productId` string	—
`importId` string	—
`externalProductId` string \| null	—
`product` Product \| null	—
`changes` string[]	—

A margin moved to Available; amount is what was credited.

data

`id` string	—
`externalOrderId` string	—
`externalOrderName` string \| null	—
`parcel` object	—
`parcel.part` integer	—
`parcel.of` integer	—
`orderNumber` string \| null	—
`status` OrderStatus	—
`paymentMode` enum	— `CODPREPAID`
`codAmount` integer	—
`wholesaleTotal` integer	—
`shippingCost` integer	—
`margin` integer	—
`marginStatus` enum	— `NONEPENDINGRELEASEDREVERSED`
`marginReleaseAt` string \| null · date-time	—
`rtoCharge` integer	—
`returnCredit` integer	—
`items` object[]	—
`tracking` object \| null	—
`tracking.number` string	—
`tracking.courier` string	—
`tracking.url` string \| null	—
`cancellationReason` string \| null	—