Objects

Every schema the API returns or accepts, with its properties and a generated example.

On this page

Error
Money
OrderStatus
SettableOrderStatus
PaymentStatus
WebhookTopic
WebhookEnvelope
Order
OrderItem
OrderCustomer
FulfillmentLine
Fulfillment
RefundLine
Refund
OrderReference
OrderAttributes
OrderAttributesPatch
OrderDetail
Variant
VariantDetail
VariantList
ProductCategory
Product
Store
Discount
Movement
WebhookSubscription
Installation
WebhookTestEvent
OrderPage
ProductPage
DiscountPage
MovementPage
CreateOrderItem
CreateOrderRequest
UpdateOrderRequest
UpdateOrderStatusRequest
CreateFulfillmentRequest
UpdateFulfillmentRequest
CreateRefundRequest
CreateInventoryMovementRequest
UpsertWebhookSubscriptionRequest
CreateWebhookTestEventRequest
OrderCreatedEventData
OrderStatusChangedEventData
OrderPaidEventData
ProductCreatedEventData
ProductUpdatedEventData
ProductDeletedEventData
InventoryMovementCreatedEventData
FulfillmentRequestedEventData
FulfillmentCreatedEventData
FulfillmentUpdatedEventData
RefundCreatedEventData
AppUninstalledEventData

`Error`#

Every non-2xx response. 5xx bodies carry only internal_error and the request id.

Name	Type	Description
`error`Required	`object`
`code`Required	`string`	Stable machine code: invalid_request, unauthorized, forbidden, not_found, conflict, payload_too_large, rate_limited, internal_error, or a more specific code named on the operation.
`message`Required	`string`
`request_id`	`string`	Echo of X-Request-Id; quote it when reporting a problem.
`details`	`object`

Example

{
  "error": {
    "code": "invalid_request",
    "message": "A human-readable explanation",
    "request_id": "req_01J8Z1K5X9",
    "details": {}
  }
}

`Money`#

Integer minor units plus the exponent that scales them. Never a float.

Name	Type	Description
`amount_minor`Required	`integer`
`currency`Required	`string`
`decimals`Required	`integer`	Minor-unit exponent for THIS amount. Dukkan deviates from ISO 4217 (SYP is zero-decimal), so always scale by this field, never by an ISO currency table.

Example

{
  "amount_minor": 275000,
  "currency": "SYP",
  "decimals": 0
}

`OrderStatus`#

Order lifecycle state. Transitions follow the server matrix; money-bearing states are reachable only through refunds.

Values:placedapprovedprocessingshippeddelivereddelivered_failedreturnedcancelledcompletedpartially_refundedrefunded

Example

"placed"

`SettableOrderStatus`#

Statuses an app may set through PATCH /orders/{id}/status. Money-bearing statuses are reachable only through refunds.

Values:placedapprovedprocessingshippeddelivereddelivered_failedreturnedcancelled

Example

"placed"

`PaymentStatus`#

Ledger-projected payment state. Independent of the delivery status: a delivered COD order is unpaid until the remittance is confirmed.

Values:not_requiredunpaidpendingauthorizedpartially_paidpaidpartially_refundedrefundedfailed

Example

"not_required"

`WebhookTopic`#

Webhook topic. Subscribing needs the read scope that governs the payload; app.uninstalled needs none and still delivers after revocation.

Values:order.createdorder.status_changedorder.paidproduct.createdproduct.updatedproduct.deletedinventory.movement_createdfulfillment.requestedfulfillment.createdfulfillment.updatedrefund.createdapp.uninstalled

Example

"order.created"

`WebhookEnvelope`#

Signed store event. Verify X-Dukkan-Hmac-Sha256 over {X-Dukkan-Timestamp}.{raw body} with the install's signing secret before parsing.

Name	Type	Description
`id`Required	`string`	Event id. Deduplicate on this signed value, never on the delivery header.
`api_version`Required	`"v1"`
`topic`Required	WebhookTopic	Webhook topic. Subscribing needs the read scope that governs the payload; `app.uninstalled` needs none and still delivers after revocation. Values:`order.createdorder.status_changedorder.paidproduct.createdproduct.updatedproduct.deletedinventory.movement_createdfulfillment.requestedfulfillment.createdfulfillment.updatedrefund.createdapp.uninstalled`
`store_id`Required	`string`
`install_id`Required	`string`	The install this delivery was fanned out to. Verify the signature with THIS install's secret and refuse a store mismatch.
`sequence`Required	`integer`	Strictly increasing per store with gaps. Order by it; never count on contiguity.
`occurred_at`Required	`string`
`test`	`boolean`	Present and true only for sandbox test deliveries (POST /webhooks/test). Absent in production traffic.
`data`Required	`object`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "api_version": "v1",
  "topic": "order.created",
  "store_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "install_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "sequence": 1661,
  "occurred_at": "2026-08-18T16:00:00Z",
  "test": true,
  "data": {}
}

`Order`#

PII-free order. Customer contact fields appear only on the detail endpoint with the clients:read scope.

Name	Type	Description
`id`Required	`string`
`order_number`Required	`string`
`status`Required	OrderStatus	Order lifecycle state. Transitions follow the server matrix; money-bearing states are reachable only through refunds. Values:`placedapprovedprocessingshippeddelivereddelivered_failedreturnedcancelledcompletedpartially_refundedrefunded`
`payment_status`Required	PaymentStatus	Ledger-projected payment state. Independent of the delivery status: a delivered COD order is `unpaid` until the remittance is confirmed. Values:`not_requiredunpaidpendingauthorizedpartially_paidpaidpartially_refundedrefundedfailed`
`source`Requirednullable	`string`	Sales channel that created the order (`storefront`, `pos`, `admin`, ...).
`line_pricing`Required	`string`	How line totals relate to order totals. "gross": sum of line totals equals subtotal and the discount lives on the order. "net" (POS orders): line totals are net of the applied promo, so sum of line totals plus discount equals subtotal. Branch on this field when reconciling, never on `source`. Values:`netgross`
`subtotal`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`discount`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`shipping`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`tax`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`total`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`paid`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`refunded`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`exchange_rate`Requirednullable	`object`	Snapshot of the rate applied when the order was priced in a non-store currency: rate = scaled / 10^scale.
`scaled`Required	`integer`
`scale`Required	`integer`
`tags`Required	`string[]`	Merchant and app tags (see PATCH /orders/{id}).
`created_at`Required	`string`
`updated_at`Required	`string`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_number": "1042",
  "status": "placed",
  "payment_status": "not_required",
  "source": "online",
  "line_pricing": "net",
  "subtotal": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "discount": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "shipping": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "tax": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "total": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "paid": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "refunded": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "exchange_rate": {
    "scaled": 1300000,
    "scale": 4
  },
  "tags": [
    "string"
  ],
  "created_at": "2026-08-18T16:00:00Z",
  "updated_at": "2026-08-18T16:00:00Z"
}

`OrderItem`#

Immutable line snapshot.

Name	Type	Description
`id`Required	`string`
`variant_id`Requirednullable	`string`	Null for custom lines.
`kind`Required	`string`	`custom` lines have no catalog link: they never touch inventory and refund by amount only. Values:`variantcustom`
`name`Required	`string`	Product name snapshot at order time.
`quantity`Required	`integer`
`unit_price`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`total`Required	Money	Integer minor units plus the exponent that scales them. Never a float.

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "kind": "variant",
  "name": "Olive oil 1 L",
  "quantity": 2,
  "unit_price": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "total": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  }
}

`OrderCustomer`#

Customer contact details. Requires the clients:read scope.

Name	Type	Description
`first_name`Requirednullable	`string`
`last_name`Requirednullable	`string`
`email`Requirednullable	`string`
`phone`Requirednullable	`string`

Example

{
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string"
}

`FulfillmentLine`#

Name	Type	Description
`order_item_id`Required	`string`
`quantity`Required	`integer`

Example

{
  "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "quantity": 2
}

`Fulfillment`#

A shipment covering some or all lines of an order.

Name	Type	Description
`id`Required	`string`
`provider`Requirednullable	`string`
`tracking_number`Requirednullable	`string`
`status`Required	`string`	Values:`pendingshippeddeliveredcancelled`
`created_at`Required	`string`
`updated_at`Required	`string`
`lines`Required	FulfillmentLine[]

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "provider": "Aramex",
  "tracking_number": "RX123456789SY",
  "status": "pending",
  "created_at": "2026-08-18T16:00:00Z",
  "updated_at": "2026-08-18T16:00:00Z",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2
    }
  ]
}

`RefundLine`#

Name	Type	Description
`order_item_id`Requirednullable	`string`
`quantity`Required	`integer`
`amount_minor`Required	`integer`

Example

{
  "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "quantity": 2,
  "amount_minor": 275000
}

`Refund`#

An append-only refund against captured funds.

Name	Type	Description
`id`Required	`string`
`amount`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`reason`Requirednullable	`string`
`created_at`Required	`string`
`lines`Required	RefundLine[]

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "amount": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "reason": "correction",
  "created_at": "2026-08-18T16:00:00Z",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2,
      "amount_minor": 275000
    }
  ]
}

`OrderReference`#

Link from an order back to the app's own record.

Name	Type	Description
`kind`Required	`string`	Record type in the app, e.g. `quote`.
`number`Required	`string`	Human-readable record number, e.g. `Q-1042`.
`url`nullable	`string`	Deep link into the app. Must be https on the app's registered origin; otherwise 422. Default:`null`

Example

{
  "kind": "string",
  "number": "string",
  "url": null
}

`OrderAttributes`#

Up to 20 keys ([a-z0-9_.-]{1,64}), scalar values up to 1000 UTF-8 bytes, 8192 bytes in total. Private to the calling app.

Example

{}

`OrderAttributesPatch`#

Merged into the app's namespace; a null value deletes that key.

Example

{}

`OrderDetail`#

Order with its immutable line snapshots and reconciliation collections.

Name	Type	Description
`id`Required	`string`
`order_number`Required	`string`
`status`Required	OrderStatus	Order lifecycle state. Transitions follow the server matrix; money-bearing states are reachable only through refunds. Values:`placedapprovedprocessingshippeddelivereddelivered_failedreturnedcancelledcompletedpartially_refundedrefunded`
`payment_status`Required	PaymentStatus	Ledger-projected payment state. Independent of the delivery status: a delivered COD order is `unpaid` until the remittance is confirmed. Values:`not_requiredunpaidpendingauthorizedpartially_paidpaidpartially_refundedrefundedfailed`
`source`Requirednullable	`string`	Sales channel that created the order (`storefront`, `pos`, `admin`, ...).
`line_pricing`Required	`string`	How line totals relate to order totals. "gross": sum of line totals equals subtotal and the discount lives on the order. "net" (POS orders): line totals are net of the applied promo, so sum of line totals plus discount equals subtotal. Branch on this field when reconciling, never on `source`. Values:`netgross`
`subtotal`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`discount`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`shipping`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`tax`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`total`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`paid`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`refunded`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`exchange_rate`Requirednullable	`object`	Snapshot of the rate applied when the order was priced in a non-store currency: rate = scaled / 10^scale.
`scaled`Required	`integer`
`scale`Required	`integer`
`tags`Required	`string[]`	Merchant and app tags (see PATCH /orders/{id}).
`created_at`Required	`string`
`updated_at`Required	`string`
`items`Required	OrderItem[]
`fulfillments`Required	Fulfillment[]
`refunds`Required	Refund[]
`note`Requirednullable	`string`	Order note (merchant or app).
`attributes`Required	OrderAttributes	The CALLING app's own attributes on this order. Other apps' namespaces are never returned.
`customer`	OrderCustomer	Present only when the install holds the `clients:read` scope (customer-PII scope, DPA-gated). Absent entirely otherwise.
`shipping_address`nullable	`object`	Free-form delivery address snapshot. Present only with the `clients:read` scope; absent entirely otherwise. May be null when the order has no delivery address (e.g. POS sales).

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_number": "1042",
  "status": "placed",
  "payment_status": "not_required",
  "source": "online",
  "line_pricing": "net",
  "subtotal": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "discount": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "shipping": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "tax": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "total": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "paid": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "refunded": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "exchange_rate": {
    "scaled": 1300000,
    "scale": 4
  },
  "tags": [
    "string"
  ],
  "created_at": "2026-08-18T16:00:00Z",
  "updated_at": "2026-08-18T16:00:00Z",
  "items": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "kind": "variant",
      "name": "Olive oil 1 L",
      "quantity": 2,
      "unit_price": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "total": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      }
    }
  ],
  "fulfillments": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "provider": "Aramex",
      "tracking_number": "RX123456789SY",
      "status": "pending",
      "created_at": "2026-08-18T16:00:00Z",
      "updated_at": "2026-08-18T16:00:00Z",
      "lines": [
        {
          "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
          "quantity": 2
        }
      ]
    }
  ],
  "refunds": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "amount": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "reason": "correction",
      "created_at": "2026-08-18T16:00:00Z",
      "lines": [
        {
          "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
          "quantity": 2,
          "amount_minor": 275000
        }
      ]
    }
  ],
  "note": "Stock count 2026-08-18",
  "attributes": {},
  "customer": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string"
  },
  "shipping_address": {}
}

`Variant`#

Name	Type	Description
`id`Required	`string`
`product_id`Required	`string`
`sku`Requirednullable	`string`
`price`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`status`Required	`string`
`name`Required	`string`	Variant label (e.g. `أحمر / L`).
`attributes`Required	`object`	Option name → value, e.g. { color: 'أحمر', size: 'L' }.
`barcode`Requirednullable	`string`
`compare_at_price`Requirednullable	Money	Higher strike-through price when set.
`image_url`Requirednullable	`string`	Main image for this variant (own image, else the product's).
`weight_gram`Requirednullable	`integer`
`available_quantity`Requirednullable	`integer`	Stock minus reservations across the store's locations. Null when the product is not inventory-managed or the install lacks inventory:read.

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "sku": "OIL-1L",
  "price": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "status": "placed",
  "name": "Olive oil 1 L",
  "attributes": {},
  "barcode": "string",
  "compare_at_price": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "image_url": "string",
  "weight_gram": 1,
  "available_quantity": 1
}

`VariantDetail`#

Variant with its product's name and status (GET /products/variants).

Name	Type	Description
`id`Required	`string`
`product_id`Required	`string`
`sku`Requirednullable	`string`
`price`Required	Money	Integer minor units plus the exponent that scales them. Never a float.
`status`Required	`string`
`name`Required	`string`	Variant label (e.g. `أحمر / L`).
`attributes`Required	`object`	Option name → value, e.g. { color: 'أحمر', size: 'L' }.
`barcode`Requirednullable	`string`
`compare_at_price`Requirednullable	Money	Higher strike-through price when set.
`image_url`Requirednullable	`string`	Main image for this variant (own image, else the product's).
`weight_gram`Requirednullable	`integer`
`available_quantity`Requirednullable	`integer`	Stock minus reservations across the store's locations. Null when the product is not inventory-managed or the install lacks inventory:read.
`product_name`Required	`string`
`product_status`Required	`string`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "sku": "OIL-1L",
  "price": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "status": "placed",
  "name": "Olive oil 1 L",
  "attributes": {},
  "barcode": "string",
  "compare_at_price": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "image_url": "string",
  "weight_gram": 1,
  "available_quantity": 1,
  "product_name": "string",
  "product_status": "string"
}

`VariantList`#

Batch variant lookup. Unknown ids are omitted, never errors.

Name	Type	Description
`data`Required	VariantDetail[]

Example

{
  "data": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "sku": "OIL-1L",
      "price": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "status": "placed",
      "name": "Olive oil 1 L",
      "attributes": {},
      "barcode": "string",
      "compare_at_price": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "image_url": "string",
      "weight_gram": 1,
      "available_quantity": 1,
      "product_name": "string",
      "product_status": "string"
    }
  ]
}

`ProductCategory`#

Name	Type	Description
`id`Required	`string`
`name`Required	`string`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "name": "Olive oil 1 L"
}

`Product`#

Name	Type	Description
`id`Required	`string`
`dsin`Required	`string`	Dukkan store item number: the merchant-facing product code.
`name`Required	`string`
`status`Required	`string`
`updated_at`Requirednullable	`string`
`image_url`Requirednullable	`string`	Main product image.
`image_color`Requirednullable	`string`	Dominant colour of the main image (#rrggbb) for placeholders.
`brand`Requirednullable	`string`
`category`Requirednullable	ProductCategory
`description`Requirednullable	`string`	Plain text, at most 500 characters.
`images`	`string[]`	Gallery, present on GET /products/{id} only.
`variants`Required	Variant[]

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "dsin": "D7Q2K9",
  "name": "Olive oil 1 L",
  "status": "placed",
  "updated_at": "2026-08-18T16:00:00Z",
  "image_url": "string",
  "image_color": "string",
  "brand": "string",
  "category": {
    "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
    "name": "Olive oil 1 L"
  },
  "description": "string",
  "images": [
    "string"
  ],
  "variants": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "sku": "OIL-1L",
      "price": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "status": "placed",
      "name": "Olive oil 1 L",
      "attributes": {},
      "barcode": "string",
      "compare_at_price": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "image_url": "string",
      "weight_gram": 1,
      "available_quantity": 1
    }
  ]
}

`Store`#

Public identity and checkout facts of the token's store.

Name	Type	Description
`id`Required	`string`
`slug`Required	`string`
`name`Required	`string`
`description`Requirednullable	`string`
`logo_url`Requirednullable	`string`
`banner_urls`Required	`string[]`
`storefront_url`Required	`string`	Public https origin; a connected custom domain wins over the platform subdomain.
`whatsapp_number`Requirednullable	`string`
`phone`Requirednullable	`string`
`address`Requirednullable	`string`
`accent_color`Requirednullable	`string`	Published theme accent, or the store's primary colour.
`locale`Required	`string`
`timezone`Required	`string`
`country`Requirednullable	`string`
`pricing_currency`Required	`object`	The currency catalog prices are stored in.
`code`Required	`string`
`decimals`Required	`integer`
`storefront_currencies`Required	`object`	Currencies a customer may pay in; POST /orders accepts these only.
`allowed`Required	`string[]`
`default`Required	`string`
`fx`Requirednullable	`object`	Store-adjusted rates from the pricing currency, exactly what checkout applies; includes the base at identity. Null when no rate table is available.
`base`Required	`string`
`as_of`Required	`string`
`rates`Required	`object`
`payment_methods`Required	`object[]`	Enabled manual payment methods.
`id`Required	`string`	Values:`codshamcash_manual`
`shamcash_id`	`string`	Present for shamcash_manual: the pay-to id shown at checkout.
`provinces`Required	`object[]`	Accepted `shipping_address.province` values with labels.
`value`Required	`string`
`ar`Required	`string`
`en`Required	`string`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "slug": "string",
  "name": "Olive oil 1 L",
  "description": "string",
  "logo_url": "string",
  "banner_urls": [
    "string"
  ],
  "storefront_url": "string",
  "whatsapp_number": "string",
  "phone": "string",
  "address": "string",
  "accent_color": "string",
  "locale": "string",
  "timezone": "string",
  "country": "string",
  "pricing_currency": {
    "code": "invalid_request",
    "decimals": 0
  },
  "storefront_currencies": {
    "allowed": [
      "string"
    ],
    "default": "string"
  },
  "fx": {
    "base": "string",
    "as_of": "2026-08-18T16:00:00Z",
    "rates": {}
  },
  "payment_methods": [
    {
      "id": "cod",
      "shamcash_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b"
    }
  ],
  "provinces": [
    {
      "value": "string",
      "ar": "string",
      "en": "string"
    }
  ]
}

`Discount`#

Read-only view of a discount. Redemption accounting stays first-party.

Name	Type	Description
`id`Required	`string`
`method`Required	`string`	Values:`codeautomatic`
`code`Requirednullable	`string`
`title`Requirednullable	`string`
`value_type`Required	`string`	Values:`percentagefixed_amountfree_shippingbuy_x_get_y`
`target`Required	`string`	Values:`orderproductscategories`
`percent`Requirednullable	`number`	Set only for percentage discounts; `amount` only for fixed_amount.
`amount`Requirednullable	Money	Integer minor units plus the exponent that scales them. Never a float.
`is_active`Required	`boolean`
`usage_limit_total`Requirednullable	`integer`
`used_count`Required	`integer`
`applies_to_pos`Required	`boolean`
`applies_to_online`Required	`boolean`
`starts_at`Requirednullable	`string`
`ends_at`Requirednullable	`string`
`created_at`Required	`string`
`updated_at`Requirednullable	`string`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "method": "code",
  "code": "invalid_request",
  "title": "Summer sale",
  "value_type": "percentage",
  "target": "order",
  "percent": 15,
  "amount": {
    "amount_minor": 275000,
    "currency": "SYP",
    "decimals": 0
  },
  "is_active": true,
  "usage_limit_total": 100,
  "used_count": 12,
  "applies_to_pos": true,
  "applies_to_online": true,
  "starts_at": "2026-08-18T16:00:00Z",
  "ends_at": "2026-08-18T16:00:00Z",
  "created_at": "2026-08-18T16:00:00Z",
  "updated_at": "2026-08-18T16:00:00Z"
}

`Movement`#

One append-only stock movement.

Name	Type	Description
`id`Required	`string`
`sequence`Required	`integer`	Monotonic insert sequence; the stable sort key for what happened in which order.
`variant_id`Requirednullable	`string`
`location_id`Required	`string`
`delta`Required	`integer`
`stock_after`Required	`integer`
`reason`Required	`string`
`occurred_at`Required	`string`

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "sequence": 1661,
  "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "location_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "delta": -2,
  "stock_after": 38,
  "reason": "correction",
  "occurred_at": "2026-08-18T16:00:00Z"
}

`WebhookSubscription`#

One subscription per install; PUT is a full replace.

Name	Type	Description
`id`Required	`string`
`endpoint_url`Required	`string`
`topics`Required	WebhookTopic[]
`status`Required	`string`	`disabled` = quarantined after sustained delivery failures; re-PUT the subscription to resume. Values:`activedisabled`
`consecutive_failures`Required	`integer`
`activated_at`Required	`string`	Events that occurred before this instant are never delivered to this subscription.
`disabled_at`Requirednullable	`string`
`secret`	`string`	Present only on the PUT response that minted or rotated it. Store it immediately; it can never be read back.

Example

{
  "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "endpoint_url": "string",
  "topics": [
    "order.created"
  ],
  "status": "active",
  "consecutive_failures": 1,
  "activated_at": "2026-08-18T16:00:00Z",
  "disabled_at": "2026-08-18T16:00:00Z",
  "secret": "string"
}

`Installation`#

The install and the store it is bound to, as the platform sees them.

Name	Type	Description
`install`Required	`object`
`id`Required	`string`
`app_id`Required	`string`
`status`Required	`string`	A token only resolves for an active install; `suspended` is reserved for billing holds surfaced through this document. Values:`activesuspended`
`granted_scopes`Required	`string[]`	Scopes the merchant consented to.
`effective_scopes`Required	`string[]`	Granted scopes intersected with the grantor's live permissions. This is what every request is checked against.
`distribution_channel`Required	`string`	Values:`developmentprivatepublic`
`installed_at`Required	`string`
`api_version`Required	`string`	Dated v1 revision this server speaks (same value as X-Dukkan-Api-Version).
`webhook`Requirednullable	`object`	The active subscription, or null when none is configured.
`id`Required	`string`
`endpoint_url`Required	`string`
`topics`Required	WebhookTopic[]
`status`Required	`string`	`disabled` = quarantined after sustained delivery failures; re-PUT the subscription to resume. Values:`activedisabled`
`consecutive_failures`Required	`integer`
`activated_at`Required	`string`	Events that occurred before this instant are never delivered to this subscription.
`disabled_at`Requirednullable	`string`
`store`Required	`object`
`id`Required	`string`
`slug`Required	`string`
`name`Required	`string`
`currency`Required	`string`
`decimals`Required	`integer`	Minor-unit exponent of the store currency.
`locale`Required	`string`	Storefront locale (`ar` or `en`).
`timezone`Required	`string`	IANA zone derived from the store country; use it for day boundaries in reports.
`country`Requirednullable	`string`	ISO 3166-1 alpha-2 when the merchant set one.
`is_development`Required	`boolean`	True for sandbox stores. Test deliveries and dev sessions exist only here.

Example

{
  "install": {
    "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
    "app_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
    "status": "active",
    "granted_scopes": [
      "string"
    ],
    "effective_scopes": [
      "string"
    ],
    "distribution_channel": "development",
    "installed_at": "2026-08-18T16:00:00Z",
    "api_version": "string",
    "webhook": {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "endpoint_url": "string",
      "topics": [
        "order.created"
      ],
      "status": "active",
      "consecutive_failures": 1,
      "activated_at": "2026-08-18T16:00:00Z",
      "disabled_at": "2026-08-18T16:00:00Z"
    }
  },
  "store": {
    "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
    "slug": "string",
    "name": "Olive oil 1 L",
    "currency": "SYP",
    "decimals": 0,
    "locale": "string",
    "timezone": "string",
    "country": "string",
    "is_development": true
  }
}

`WebhookTestEvent`#

The accepted test event and its queued deliveries.

Name	Type	Description
`event_id`Required	`string`
`topic`Required	WebhookTopic	Webhook topic. Subscribing needs the read scope that governs the payload; `app.uninstalled` needs none and still delivers after revocation. Values:`order.createdorder.status_changedorder.paidproduct.createdproduct.updatedproduct.deletedinventory.movement_createdfulfillment.requestedfulfillment.createdfulfillment.updatedrefund.createdapp.uninstalled`
`sequence`Required	`integer`
`occurred_at`Required	`string`
`test`Required	`"true"`
`data`Required	`object`	The payload that was written, after overrides and validation.
`deliveries`Required	`object[]`	One row per subscription the event fanned out to; the worker sends within about a minute.
`id`Required	`string`	Delivery id; also sent as X-Dukkan-Delivery-Id.
`status`Required	`string`	Values:`pendingdeliveringretry_scheduledsucceededdead`
`endpoint_url`Required	`string`

Example

{
  "event_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "topic": "order.created",
  "sequence": 1661,
  "occurred_at": "2026-08-18T16:00:00Z",
  "test": true,
  "data": {},
  "deliveries": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "status": "pending",
      "endpoint_url": "string"
    }
  ]
}

`OrderPage`#

Cursor page of PII-free orders.

Name	Type	Description
`data`Required	Order[]
`next_cursor`Requirednullable	`string`	Pass back as `cursor` to fetch the next page; null on the last page.

Example

{
  "data": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "order_number": "1042",
      "status": "placed",
      "payment_status": "not_required",
      "source": "online",
      "line_pricing": "net",
      "subtotal": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "discount": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "shipping": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "tax": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "total": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "paid": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "refunded": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "exchange_rate": {
        "scaled": 1300000,
        "scale": 4
      },
      "tags": [
        "string"
      ],
      "created_at": "2026-08-18T16:00:00Z",
      "updated_at": "2026-08-18T16:00:00Z"
    }
  ],
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wOC0xOFQxNjowMDowMFoifQ"
}

`ProductPage`#

Cursor page of products with variants.

Name	Type	Description
`data`Required	Product[]
`next_cursor`Requirednullable	`string`	Pass back as `cursor` to fetch the next page; null on the last page.

Example

{
  "data": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "dsin": "D7Q2K9",
      "name": "Olive oil 1 L",
      "status": "placed",
      "updated_at": "2026-08-18T16:00:00Z",
      "image_url": "string",
      "image_color": "string",
      "brand": "string",
      "category": {
        "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
        "name": "Olive oil 1 L"
      },
      "description": "string",
      "images": [
        "string"
      ],
      "variants": [
        {
          "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
          "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
          "sku": "OIL-1L",
          "price": {
            "amount_minor": 275000,
            "currency": "SYP",
            "decimals": 0
          },
          "status": "placed",
          "name": "Olive oil 1 L",
          "attributes": {},
          "barcode": "string",
          "compare_at_price": {
            "amount_minor": 275000,
            "currency": "SYP",
            "decimals": 0
          },
          "image_url": "string",
          "weight_gram": 1,
          "available_quantity": 1
        }
      ]
    }
  ],
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wOC0xOFQxNjowMDowMFoifQ"
}

`DiscountPage`#

Cursor page of discounts.

Name	Type	Description
`data`Required	Discount[]
`next_cursor`Requirednullable	`string`	Pass back as `cursor` to fetch the next page; null on the last page.

Example

{
  "data": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "method": "code",
      "code": "invalid_request",
      "title": "Summer sale",
      "value_type": "percentage",
      "target": "order",
      "percent": 15,
      "amount": {
        "amount_minor": 275000,
        "currency": "SYP",
        "decimals": 0
      },
      "is_active": true,
      "usage_limit_total": 100,
      "used_count": 12,
      "applies_to_pos": true,
      "applies_to_online": true,
      "starts_at": "2026-08-18T16:00:00Z",
      "ends_at": "2026-08-18T16:00:00Z",
      "created_at": "2026-08-18T16:00:00Z",
      "updated_at": "2026-08-18T16:00:00Z"
    }
  ],
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wOC0xOFQxNjowMDowMFoifQ"
}

`MovementPage`#

Cursor page of append-only inventory movements.

Name	Type	Description
`data`Required	Movement[]
`next_cursor`Requirednullable	`string`	Pass back as `cursor` to fetch the next page; null on the last page.

Example

{
  "data": [
    {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "sequence": 1661,
      "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "location_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "delta": -2,
      "stock_after": 38,
      "reason": "correction",
      "occurred_at": "2026-08-18T16:00:00Z"
    }
  ],
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wOC0xOFQxNjowMDowMFoifQ"
}

`CreateOrderItem`#

One order line with the price the merchant agreed.

Name	Type	Description
`variant_id`Requirednullable	`string`	Catalog variant, or null for a custom line.
`name`	`string`	Line label. Required when variant_id is null; ignored otherwise (the catalog name is snapshotted).
`quantity`Required	`integer`
`unit_price_minor`Required	`integer`	Agreed unit price in minor units of the order currency. Zero is allowed.

Example

{
  "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "name": "Olive oil 1 L",
  "quantity": 2,
  "unit_price_minor": 1
}

`CreateOrderRequest`#

Create an order with app-set prices. Totals are recomputed server-side: subtotal = Σ quantity × unit_price_minor, total = subtotal − discount + shipping, tax 0.

Name	Type	Description
`currency`Required	`string`	One of the store's allowed storefront currencies; otherwise 422 `currency_not_allowed`.
`status`	`string`	`placed` (default) lets the merchant review; `approved` records an explicit customer acceptance the app collected. Values:`placedapproved` Default:`"placed"`
`items`Required	CreateOrderItem[]
`discount`nullable	`object`	Order-level discount; must not exceed the sum of the lines. Default:`null`
`amount_minor`Required	`integer`
`title`nullable	`string`	Default:`null`
`shipping`Required	`object`
`amount_minor`Required	`integer`
`method`Required	`string`	Values:`deliverypickup`
`customer`Required	`object`
`name`Required	`string`
`phone`Required	`string`	Full international number with country code; stored normalised.
`email`nullable	`string`	Optional. Never invented when absent. Default:`null`
`shipping_address`nullable	`object`	Required when shipping.method is `delivery`. Default:`null`
`address`Required	`string`
`province`Required	`string`	Syrian province value, e.g. `damascus` (see GET /store `provinces`).
`city`nullable	`string`	Default:`null`
`notes`nullable	`string`	Default:`null`
`payment_method`Required	`string`	Must be enabled in the store; otherwise 409 `payment_method_disabled`. Values:`codshamcash_manual`
`exchange_rate`nullable	`object`	Required when currency differs from the store's pricing currency, forbidden otherwise. rate = scaled / 10^scale, oriented 1 pricing-currency unit = rate order-currency units (same as GET /store `fx`). Default:`null`
`scaled`Required	`integer`
`scale`Required	`integer`
`note`nullable	`string`	Default:`null`
`tags`	`string[]`	At most 10 tags after case-insensitive dedupe.
`attributes`	OrderAttributes	Up to 20 keys (`[a-z0-9_.-]{1,64}`), scalar values up to 1000 UTF-8 bytes, 8192 bytes in total. Private to the calling app. Default:`{}`
`inventory`	`string`	Values:`decrementskip` Default:`"decrement"`

Example

{
  "currency": "SYP",
  "status": "placed",
  "items": [
    {
      "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "name": "Olive oil 1 L",
      "quantity": 2,
      "unit_price_minor": 1
    }
  ],
  "discount": {
    "amount_minor": 275000,
    "title": null
  },
  "shipping": {
    "amount_minor": 275000,
    "method": "delivery"
  },
  "customer": {
    "name": "Olive oil 1 L",
    "phone": "string",
    "email": null
  },
  "shipping_address": {
    "address": "string",
    "province": "string",
    "city": null,
    "notes": null
  },
  "payment_method": "cod",
  "exchange_rate": {
    "scaled": 1300000,
    "scale": 4
  },
  "note": null,
  "tags": [
    "string"
  ],
  "attributes": {},
  "inventory": "decrement"
}

`UpdateOrderRequest`#

Update the note, add/remove tags, or merge the app's own attributes. Money, lines, customer and address are immutable after creation.

Name	Type	Description
`note`nullable	`string`	Replace the order note; null clears it.
`tags`	`object`	Set operations, never a replace: the merchant's and other apps' tags survive.
`add`	`string[]`	At most 10 tags after case-insensitive dedupe.
`remove`	`string[]`	Removed case-insensitively.
`attributes`	OrderAttributesPatch	Merged into the app's namespace; a `null` value deletes that key.

Example

{
  "note": "Stock count 2026-08-18",
  "tags": {
    "add": [
      "string"
    ],
    "remove": [
      "string"
    ]
  },
  "attributes": {}
}

`UpdateOrderStatusRequest`#

Transition an order through the server matrix.

Name	Type	Description
`status`Required	SettableOrderStatus	Statuses an app may set through PATCH /orders/{id}/status. Money-bearing statuses are reachable only through refunds. Values:`placedapprovedprocessingshippeddelivereddelivered_failedreturnedcancelled`

Example

{
  "status": "placed"
}

`CreateFulfillmentRequest`#

Fulfill selected line quantities. Each order item may appear once.

Name	Type	Description
`provider`nullable	`string`
`tracking_number`nullable	`string`
`status`	`string`	"pending" reserves the quantities without auto-shipping the order (carrier booked, pickup not yet made); move to "shipped" via PATCH when the parcel leaves. Values:`pendingshipped` Default:`"shipped"`
`lines`Required	`object[]`
`order_item_id`Required	`string`
`quantity`Required	`integer`

Example

{
  "provider": "Aramex",
  "tracking_number": "RX123456789SY",
  "status": "shipped",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2
    }
  ]
}

`UpdateFulfillmentRequest`#

Update tracking, mark delivered, cancel, or propose a COD remittance. At least one field is required.

Name	Type	Description
`tracking_number`nullable	`string`
`status`	`string`	Values:`shippeddeliveredcancelled`
`cod_collected_minor`	`integer`	COD remittance PROPOSAL: the cash the courier reports collecting (minor units; may be less than the order total). Moves no money. The merchant confirms in admin, and that confirmation writes the cod_collection ledger row which updates payment status and fires order.paid. One open proposal per order; re-sending updates it.
`cod_collected_note`	`string`

Example

{
  "tracking_number": "RX123456789SY",
  "status": "shipped",
  "cod_collected_minor": 275000,
  "cod_collected_note": "string"
}

`CreateRefundRequest`#

Append a refund against captured funds.

Name	Type	Description
`amount_minor`Required	`integer`
`currency`	`string`	Optional confirmation guard; 409 when it differs from the order's currency.
`reason`nullable	`string`
`lines`	`object[]`	Optional line breakdown; amounts must sum to amount_minor.
`order_item_id`Required	`string`
`quantity`Required	`integer`
`amount_minor`Required	`integer`
`restock`	`object`	Return the refunded quantities to stock. Requires `lines` and the inventory:write scope. Untracked products are skipped.
`location_id`Required	`string`

Example

{
  "amount_minor": 275000,
  "currency": "SYP",
  "reason": "correction",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2,
      "amount_minor": 275000
    }
  ],
  "restock": {
    "location_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b"
  }
}

`CreateInventoryMovementRequest`#

Append an inventory movement.

Name	Type	Description
`variant_id`Required	`string`
`location_id`Required	`string`
`delta`Required	`integer`	Signed quantity change. Absolute stock writes are forbidden.
`reason`Required	`string`	Values:`correctioninitialreturndamage`
`note`nullable	`string`

Example

{
  "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "location_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "delta": -2,
  "reason": "correction",
  "note": "Stock count 2026-08-18"
}

`UpsertWebhookSubscriptionRequest`#

Create or replace the install's single subscription.

Name	Type	Description
`endpoint_url`Required	`string`	Public HTTPS URL. Private, loopback and IP-literal hosts are refused.
`topics`Required	WebhookTopic[]
`rotate_secret`	`boolean`	Mint a new signing secret and return it once in the response.

Example

{
  "endpoint_url": "https://app.example.com/webhooks/dukkan",
  "topics": [
    "order.created"
  ],
  "rotate_secret": false
}

`CreateWebhookTestEventRequest`#

Fire one signed test delivery (sandbox stores only).

Name	Type	Description
`topic`Required	WebhookTopic	Webhook topic. Subscribing needs the read scope that governs the payload; `app.uninstalled` needs none and still delivers after revocation. Values:`order.createdorder.status_changedorder.paidproduct.createdproduct.updatedproduct.deletedinventory.movement_createdfulfillment.requestedfulfillment.createdfulfillment.updatedrefund.createdapp.uninstalled`
`data`	`object`	Optional overrides merged over the platform-built sample payload for the topic (at most 16 KB).

Example

{
  "topic": "order.created",
  "data": {}
}

`OrderCreatedEventData`#

Name	Type	Description
`order_id`Required	`string`
`order_number`Required	`string`
`status`Required	`string`	Order status at creation (usually `placed`).
`total_minor`Required	`integer`	Integer minor units of `currency` (scale by the store's decimals).
`currency`Required	`string`
`source`nullable	`string`	Sales channel (`storefront`, `pos`, `admin`, `app`). Emitted since revision 2026-09-10.

Example

{
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_number": "1042",
  "status": "placed",
  "total_minor": 1,
  "currency": "SYP",
  "source": "online"
}

`OrderStatusChangedEventData`#

Name	Type	Description
`order_id`Required	`string`
`from_status`Required	`string`
`status`Required	`string`	The status the order moved to.

Example

{
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "from_status": "string",
  "status": "placed"
}

`OrderPaidEventData`#

Fires when captured funds reach the order total, from the payments ledger only. COD orders reach it when the merchant confirms the courier's remittance, never on delivery.

Name	Type	Description
`order_id`Required	`string`
`amount_minor`Required	`integer`	Captured funds at the moment they crossed the order total.
`currency`Required	`string`

Example

{
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "amount_minor": 275000,
  "currency": "SYP"
}

`ProductCreatedEventData`#

Name	Type	Description
`product_id`Required	`string`

Example

{
  "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b"
}

`ProductUpdatedEventData`#

Name	Type	Description
`product_id`Required	`string`
`variant_id`	`string`	Set when a variant row changed rather than the product itself.
`operation`	`string`	Present on variant changes: which write on the variant fired the event. Values:`insertupdatedelete`

Example

{
  "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "operation": "insert"
}

`ProductDeletedEventData`#

Name	Type	Description
`product_id`Required	`string`

Example

{
  "product_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b"
}

`InventoryMovementCreatedEventData`#

Name	Type	Description
`movement_id`Required	`string`
`variant_id`Requirednullable	`string`
`location_id`Required	`string`
`delta`Required	`integer`
`stock_after`Required	`integer`
`reason`Required	`string`

Example

{
  "movement_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "variant_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "location_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "delta": -2,
  "stock_after": 38,
  "reason": "correction"
}

`FulfillmentRequestedEventData`#

A fulfillment was created as pending: a pickup is waiting to be booked by a carrier app.

Name	Type	Description
`fulfillment_id`Required	`string`
`order_id`Required	`string`
`lines`Required	`object[]`
`order_item_id`Required	`string`
`quantity`Required	`integer`

Example

{
  "fulfillment_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2
    }
  ]
}

`FulfillmentCreatedEventData`#

Name	Type	Description
`fulfillment_id`Required	`string`
`order_id`Required	`string`
`status`Required	`string`	Values:`pendingshipped`
`tracking_number`Requirednullable	`string`
`lines`Required	`object[]`
`order_item_id`Required	`string`
`quantity`Required	`integer`
`order_fully_fulfilled`Required	`boolean`	True when every line of the order is now covered by a fulfillment.

Example

{
  "fulfillment_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "status": "pending",
  "tracking_number": "RX123456789SY",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2
    }
  ],
  "order_fully_fulfilled": true
}

`FulfillmentUpdatedEventData`#

Name	Type	Description
`fulfillment_id`Required	`string`
`order_id`Required	`string`
`status`Required	`string`	Values:`pendingshippeddeliveredcancelled`
`previous_status`Required	`string`
`tracking_number`Requirednullable	`string`

Example

{
  "fulfillment_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "status": "pending",
  "previous_status": "string",
  "tracking_number": "RX123456789SY"
}

`RefundCreatedEventData`#

Name	Type	Description
`refund_id`Required	`string`
`order_id`Required	`string`
`amount_minor`Required	`integer`	Integer minor units of `currency` (scale by the store's decimals).
`currency`Required	`string`
`lines`	`object[]`	Line breakdown when the refund carried one. Absent on POS refunds.
`order_item_id`Requirednullable	`string`
`quantity`Required	`integer`
`amount_minor`Required	`integer`	Integer minor units of `currency` (scale by the store's decimals).
`source`	`"pos"`	Present when the refund was written at the point of sale.

Example

{
  "refund_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "order_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "amount_minor": 275000,
  "currency": "SYP",
  "lines": [
    {
      "order_item_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "quantity": 2,
      "amount_minor": 275000
    }
  ],
  "source": "pos"
}

`AppUninstalledEventData`#

Farewell notice: the merchant removed the app. Tokens are already dead; delete what the DPA requires and stop calling the API for this install.

Name	Type	Description
`app_id`Required	`string`
`install_id`Required	`string`

Example

{
  "app_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
  "install_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b"
}

Error#

Money#

OrderStatus#

SettableOrderStatus#

PaymentStatus#

WebhookTopic#

WebhookEnvelope#

Order#

OrderItem#

OrderCustomer#

FulfillmentLine#

Fulfillment#

RefundLine#

Refund#

OrderReference#

OrderAttributes#

OrderAttributesPatch#

OrderDetail#

Variant#

VariantDetail#

VariantList#

ProductCategory#

Product#

Store#

Discount#

Movement#

WebhookSubscription#

Installation#

WebhookTestEvent#

OrderPage#

ProductPage#

DiscountPage#

MovementPage#

CreateOrderItem#

CreateOrderRequest#

UpdateOrderRequest#

UpdateOrderStatusRequest#

CreateFulfillmentRequest#

UpdateFulfillmentRequest#

CreateRefundRequest#

CreateInventoryMovementRequest#

UpsertWebhookSubscriptionRequest#

CreateWebhookTestEventRequest#

OrderCreatedEventData#

OrderStatusChangedEventData#

OrderPaidEventData#

ProductCreatedEventData#

ProductUpdatedEventData#

ProductDeletedEventData#

InventoryMovementCreatedEventData#

FulfillmentRequestedEventData#

FulfillmentCreatedEventData#

FulfillmentUpdatedEventData#

RefundCreatedEventData#

AppUninstalledEventData#

`Error`#

`Money`#

`OrderStatus`#

`SettableOrderStatus`#

`PaymentStatus`#

`WebhookTopic`#

`WebhookEnvelope`#

`Order`#

`OrderItem`#

`OrderCustomer`#

`FulfillmentLine`#

`Fulfillment`#

`RefundLine`#

`Refund`#

`OrderReference`#

`OrderAttributes`#

`OrderAttributesPatch`#

`OrderDetail`#

`Variant`#

`VariantDetail`#

`VariantList`#

`ProductCategory`#

`Product`#

`Store`#

`Discount`#

`Movement`#

`WebhookSubscription`#

`Installation`#

`WebhookTestEvent`#

`OrderPage`#

`ProductPage`#

`DiscountPage`#

`MovementPage`#

`CreateOrderItem`#

`CreateOrderRequest`#

`UpdateOrderRequest`#

`UpdateOrderStatusRequest`#

`CreateFulfillmentRequest`#

`UpdateFulfillmentRequest`#

`CreateRefundRequest`#

`CreateInventoryMovementRequest`#

`UpsertWebhookSubscriptionRequest`#

`CreateWebhookTestEventRequest`#

`OrderCreatedEventData`#

`OrderStatusChangedEventData`#

`OrderPaidEventData`#

`ProductCreatedEventData`#

`ProductUpdatedEventData`#

`ProductDeletedEventData`#

`InventoryMovementCreatedEventData`#

`FulfillmentRequestedEventData`#

`FulfillmentCreatedEventData`#

`FulfillmentUpdatedEventData`#

`RefundCreatedEventData`#

`AppUninstalledEventData`#