Table of Events

Name	Description
order.voided	Order has been voided (cancelled).
order.freight.changed	Freight costs or charges have been changed.
order.discount.changed	Discount amount has been changed.
dispatch.shipped	Order has been shipped.
dispatch.collect.received	Order marked as received at a Click & Collect location.
dispatch.collect.collected	Order marked as collected from a Click & Collect location.
order.split	Order has been split.
order.item.deleted	An order item has been deleted.
order.item.backordered	An order item has been backordered.
order.item.quantity.changed	An order item quantity has been changed.
order.confirmed	Customer has placed an order.
dispatch.assigned	Order assigned to a dispatch point.
dispatch.shipped.attempteddelivery	Consignment service has notified that delivery was attempted for a shipment.
dispatch.shipped.awaitingcollection	Consignment service has notified that the shipment is awaiting collection.
dispatch.shipped.intransit	Consignment service has notified that the shipment is in transit.
dispatch.shipped.outfordelivery	Consignment service has notified that the shipment is out for delivery.
dispatch.shipped.delivered	Consignment service has notified that the shipment has been delivered.
order.replacement.confirmed	Replacement of an order has been confirmed.
dispatch.3pl.queued	The order has been queued for processing with a 3PL service.
dispatch.3pl.processing	The order is being processed by a 3PL service.
dispatch.3pl.error	There was an error processing the order with a 3PL service.
dispatch.unassigned	Order has been unassigned from a dispatch point.

Payloads

Events carry a JSON payload with data relevant to the specific event. Whilst many events share a common payload format, some events have additional elements, or specific payloads.

Examples of these payloads, and the events they're relevant to, are provided below.

Common Fulfilment Events

order.confirmed, dispatch.shipped.attempteddelivery, dispatch.shipped.awaitingcollection, dispatch.shipped.intransit, dispatch.shipped.outfordelivery, dispatch.shipped.delivered, dispatch.3pl.queued, dispatch.3pl.processing, dispatch.3pl.error, dispatch.unassigned

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.confirmed ...",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ]
  }
}

order.split

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.split",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "childOrderID": "[child Viare order ID]",
    "item": [
      {
        "id": "[child order item ID]",
        "barcode": "[product item barcode]",
        "quantity": "[new quantity of product item]",
        "iteminfo": {
          "info": {
            "@key": "[key]",
            "@value": "[value]"
          }
        }
      }
    ],
    "vouchers": [
      {
        "id": "[child voucher ID]",
        "quantity": "1"
      }
    ]
  }
}

order.discount.changed

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.discount.changed",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "discount": "[discount]"
  }
}

dispatch.collect.received, dispatch.assigned

{
  "subscriber": 1,
  "sequence": 1,
  "type": "dispatch.collect.received, dispatch.assigned",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "dispatchPoint": "[dispatch point name]"
  }
}

dispatch.collect.collected

{
  "subscriber": 1,
  "sequence": 1,
  "type": "dispatch.collect.collected",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "dispatchPoint": "[dispatch point name]",
    "collectedBy": "[customer or nominated person]",
    "staffNumber": "[staff number]"
  }
}

dispatch.shipped

{
  "subscriber": 1,
  "sequence": 1,
  "type": "dispatch.shipped",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "dispatchPoint": "[dispatch point name]",
    "freightProvider": "[freight provider name]",
    "shipping": [
      {
        "reference": "[shipping reference]",
        "carrier": "[carrier name]",
        "trackingUrl": "[tracking URL]"
      }
    ]
  }
}

order.freight.changed

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.freight.changed",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "freight": "[new freight charge]"
  }
}

order.item.quantity.changed

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.item.quantity.changed",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "item": {
      "id": "[order item ID]",
      "barcode": "[product item barcode]",
      "quantity": "[new order item quantity]",
      "iteminfo": {
        "info": {
          "@key": "[key]",
          "@value": "[value]"
        }
      }
    }
  }
}

order.item.deleted, order.item.backordered

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.item.deleted, order.item.backordered",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]"
      }
    ],
    "item": {
      "id": "[order item ID]",
      "barcode": "[product item barcode]",
      "quantity": "[order item quantity]",
      "iteminfo": {
        "info": {
          "@key": "[key]",
          "@value": "[value]"
        }
      }
    }
  }
}

order.voided

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.voided",
  "message": {
    "orderID": "[Viare order ID]",
    "externalReferences": [
      {
        "id": "[external order ID]",
        "source": "[external order source]",
        "voidReasonCode": "[external void reason code]"
      }
    ]
  }
}

order.replacement.confirmed

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.replacement.confirmed",
  "message": {
    "orderID": "[Viare order ID]",
    "originalOrderID": "[Viare original order ID]"
  }
}

order.profiler.approved, order.profiler.cancelled

{
  "subscriber": 1,
  "sequence": 1,
  "type": "order.profiler.approved, order.profiler.cancelled",
  "message": {
    "orderID": "[Viare order ID]",
    "user": "System",
    "externalReferences": [
      {
        "externalID": "[external order ID]",
        "externalSource": "[external order source]"
      }
    ]
  }
}