Skip to content

location/updated

Overview

PropertyValue
Webhook typelocation/updated
Kafka topiclocation.updated
DirectionPlatform → Your endpoint

Description

Fired when any field on an existing location is updated. This covers changes to address, contact details, shipping rules, stock management flags, and configuration settings.

Trigger Conditions

  • A user or integration updates location fields via the API
  • Configuration changes are applied to the location (rule sets, allowed countries, etc.)

Message Envelope

json
{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "location/updated",
    "date": "2024-04-01T09:30:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

Location Object

FieldTypeNullableDescription
idstring (uuid)NoUnique location identifier
organizationIdstring (uuid)NoOrganization that owns this location
namestringNoInternal unique name (immutable)
titlestringNoHuman-readable display name
descriptionstringYesDescription of the location
locationTypeenumNoLocation type: INTERNAL, WAREHOUSE
socialReasonstringYesLegal entity name
formstringYesLegal form
addressstringYesStreet address
addressComplementstringYesAddress complement
zipCodestringYesPostal/ZIP code
citystringYesCity
statestringYesState or region
countrystringYesISO 3166-1 alpha-2 country code
emailstringYesContact email
phonestringYesContact phone
activebooleanNoWhether the location is currently active
registerAllVariantsbooleanNoAuto-register all variants flag
stockManagementbooleanNoStock management enabled flag
stockEventsbooleanNoStock event emission flag
acceptFulfillmentAtstring (ISO 8601)YesFulfillment acceptance start date
stockRefRuleSetIdstring (uuid)YesStock reference rule set ID
orderDispatchRuleSetIdstring (uuid)YesOrder dispatch rule set ID
allowedCountriesstring[]YesAllowed shipping country codes
excludedCountriesstring[]YesExcluded shipping country codes

Full JSON Payload Sample

json
{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "l3m4n5o6-p7q8-9012-rstu-345678901234",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "location/updated",
    "date": "2024-04-01T09:30:00.000Z"
  },
  "body": {
    "id": "j1k2l3m4-n5o6-7890-pqrs-123456789012",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "warehouse-paris-nord",
    "title": "Entrepôt Paris Nord — Site A",
    "description": "Principal warehouse for Île-de-France and neighbouring regions",
    "locationType": "WAREHOUSE",
    "socialReason": "HappyColis Logistics SAS",
    "form": "SAS",
    "address": "12 Rue de la Logistique",
    "addressComplement": "Zone Industrielle Nord, Bâtiment B",
    "zipCode": "93200",
    "city": "Saint-Denis",
    "state": "Île-de-France",
    "country": "FR",
    "email": "warehouse-paris@happycolis.com",
    "phone": "+33142000001",
    "active": true,
    "registerAllVariants": false,
    "stockManagement": true,
    "stockEvents": true,
    "acceptFulfillmentAt": "2024-04-01T00:00:00.000Z",
    "stockRefRuleSetId": "m4n5o6p7-q8r9-0123-stuv-456789012345",
    "orderDispatchRuleSetId": "k2l3m4n5-o6p7-8901-qrst-234567890123",
    "allowedCountries": ["FR", "BE", "LU", "CH", "DE"],
    "excludedCountries": null
  }
}

Notes

  • The full current state of the location is always included in the payload (not just changed fields).
  • name is immutable and will never change after creation.
  • Changes to active flag also trigger dedicated location/activated or location/deactivated events in addition to this event.

HappyColis API Documentation