Order Management

Required for: API, CSV, SFTP, EDI catalog integration methods

Order object

When a shopper successfully completes checkout, Rokt delivers the full order to you via the order/create webhook. The payload contains everything you need to fulfill the purchase.

Webhooks

Register webhooks so your application receives real-time notifications when order events occur. Without webhooks, you would need to poll the API to discover new orders.

1. Subscribe to the order/create webhook to receive incoming orders from Partners. This is the primary webhook for Brands: it delivers the full order payload (line items, quantities, shipping address) so you can begin fulfillment.
2. Subscribe to the order/update webhook to receive changes to existing orders, such as shipping address corrections or status updates. This ensures your fulfillment system always has the latest order details.
3. Subscribe to the order/cancel webhook to be notified when a Partner cancels an order. Use this to halt fulfillment processing and update your inventory.

You can register webhooks through the Rokt Catalog app under Settings → Developer → Add Webhooks, or programmatically via the Webhook Create endpoint. For more details on webhook topics, verification, and payload format, see the Webhooks Guide.

Receiving orders: order/create webhook

Register an order/create webhook topic to receive new orders in real time.

The webhook body is the same Order object that the Retrieve Order endpoint returns.

// Webhook: order/create
// Headers: x-canal-app-id, x-canal-topic, x-canal-event-hash, x-canal-api-version, x-canal-webhook-id

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "remote_rid": "5718230417",
  "created_at": "2026-03-19T14:32:00Z",
  "shop": {
    "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
    "email": "orders@example.com",
    "phone": "+15125550100",
    "name": "Example Footwear Co.",
    "description": "Running shoes and apparel.",
    "myshopify_domain": "example-footwear.myshopify.com",
    "province": "Texas",
    "country": "United States",
    "domain": "www.example.com",
    "display_domain": "example.com",
    "privacy_policy_url": "https://www.example.com/privacy",
    "terms_of_service_url": "https://www.example.com/terms"
  },
  "customer": {
    "id": "2b7e1516-28ae-4d2a-9f6c-1a2b3c4d5e6f",
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "orders_count": 1
  },
  "email": "jane.doe@example.com",
  "total_price": "148.10",
  "currency": "USD",
  "name": "#1001",
  "line_items": [
    {
      "id": "9d4e7f1a-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
      "variant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 1,
      "fulfillable_quantity": 1,
      "price": 129.99,
      "requires_shipping": true,
      "title": "Classic Running Shoe - 8 / Black",
      "sku": "SHOE-8-BLK"
    }
  ],
  "fulfillments": [],
  "billing_address": {
    "name": "Jane Doe",
    "address1": "456 Shopper Ave",
    "address2": "",
    "city": "Austin",
    "province": "Texas",
    "province_code": "TX",
    "country": "United States",
    "country_code": "US",
    "zip": "78701",
    "phone": "+15125550199"
  },
  "shipping_address": {
    "name": "Jane Doe",
    "address1": "456 Shopper Ave",
    "address2": "",
    "city": "Austin",
    "province": "Texas",
    "province_code": "TX",
    "country": "United States",
    "country_code": "US",
    "zip": "78701",
    "phone": "+15125550199"
  },
  "shipping_lines": [
    {
      "code": "STANDARD",
      "title": "Standard Shipping",
      "price": 9.99,
      "currency": "USD"
    }
  ],
  "cancelled_at": null,
  "refunds": [],
  "connected_supplier_order_numbers": null,
  "cancel_reason": null,
  "note_attributes": [
    {
      "name": "Gift message",
      "value": "Happy birthday!"
    }
  ],
  "returns": []
}

備考

Monetary amounts are decimal values in the order's currency, not cents. total_price is a string (for example "148.10"), while line item price and shipping line price are numbers.

Order updates and cancellations

Subscribe to the order/cancel webhook to be notified when an order is canceled before fulfillment.

Topic	Direction	When it fires
order/create	Rokt → Brand	A new order has been placed and is ready for fulfillment.
order/update	Rokt → Brand	An existing order has been modified (e.g. address update, quantity change).
order/cancel	Rokt → Brand	An order has been canceled. Do not fulfill. If already shipped, initiate a return.

Fulfillment

Once you have shipped the order, you should send Rokt a fulfillment update so that the tracking information and the order status is updated. Providing shipping updates helps Rokt and Rokt Partners with potential customer service and any necessary troubleshooting.

A fulfillment update must include at minimum:

• The Rokt order ID
• Tracking number(s)
• Shipping carrier
• Tracking URL (if available)
• Shipped line items and quantities