Equipment Tracking

The Equipment Tracking webhook provides notifications when payment terminals are shipped to merchants. This webhook delivers detailed shipping information for each terminal device, including tracking numbers.

Payload Structure Example

The webhook delivers a JSON payload with the following structure:

{
  "event": "Shipped",
  "merchantId": "88880000000123456",
  "orderId": "999990000000987654",
  "payload": {
    "terminals": [
      {
        "name": "Survey Name",
        "trackingNumber": "1Z81T8T20299581550",
        "deviceType": "VP3300 (Bluetooth)",
        "terminalId": 1111,
        "storeNumber": 1111
      }
    ]
  }
}

Field Reference

Field
Description

event

Identifies the webhook event type ("Shipped")

merchantId

Unique identifier for the merchant receiving the equipment

orderId

Unique identifier for the equipment order

payload.terminals

Array of terminal devices included in the shipment

payload.terminals[].name

Display name or description of the terminal

payload.terminals[].trackingNumber

Shipping tracking number

payload.terminals[].deviceType

Model and connection type of the terminal

payload.terminals[].terminalId

Unique identifier for the terminal device

payload.terminals[].storeNumber

Store location identifier where the terminal will be deployed

Last updated

Was this helpful?