Gearment API

Shipping Address Unverified

EVENT_SHIPPING_ADDRESS_UNVERIFIED is sent when a shipping address requires attention.

When it fires

Fires on draft creation or update when the shipping-verification status is newly set or changes to internal address_unverified. The delivery body sets only the Gearment ID and name and the verification value; it does not set order status or vendor order ID.

Example payload

V3

{
  "type": "shipping_address_unverified",
  "order": {
    "gearment_id": "260909P-DEMO01-9M4R2K6X",
    "gearment_name": "260909P-DEMO01-9M4R2K6X",
    "verified_address": "address_unverified",
    "ord_status": "",
    "vendor_id": ""
  }
}

V1

{
  "type": "shipping_address_unverified",
  "data": {
    "gearment_ord_id": "109876546",
    "gearment_ord_name": "260909P-DEMO01-9M4R2K6X",
    "ord_status": "pending",
    "verified_address": "unverified",
    "order_id": ""
  }
}

Fields

VersionFieldTypePresenceDescription
V1typestringALiteral "shipping_address_unverified"
V1dataobjectALegacy payload container
V1data.gearment_ord_idstringALegacy numeric draft/order ID as a string when mapped; otherwise internal ID
V1data.gearment_ord_namestringAInternal Gearment draft/order ID
V1data.ord_statusstringALiteral "pending"
V1data.verified_addressstringALiteral "unverified"
V1data.order_idstringA/emptyAlways "" on the current automatic producer path
V3typestringALiteral "shipping_address_unverified"
V3orderobjectAOrder/draft verification container
V3order.gearment_idstringAInternal Gearment draft/order ID
V3order.gearment_namestringASame internal ID copied into the name field
V3order.verified_addressstringAEvent status, currently "address_unverified"
V3order.ord_statusstringA/emptyAlways "" on the current automatic producer path
V3order.vendor_idstringA/emptyAlways "" on the current automatic producer path

Presence: A is always emitted; A/empty is always emitted but the value can be ""; Per item is emitted for every array element.

Verify the signature before parsing the body. See Verifying a payload.

Payload handling

Confirm the exact topic and payload version with the Webhook simulator. Preserve unknown fields, process the event idempotently, and do not depend on JSON property ordering.