Skip to content

location/type_changed

Overview

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

Description

Fired when the locationType of a location changes. This is a significant operational event because changing the type (e.g., from INTERNAL to WAREHOUSE) alters how the location handles stock, fulfillment services, and order dispatching.

Trigger Conditions

  • A user or integration changes the locationType field of a location via the API
  • The locationType transitions from one value to another (e.g., INTERNALWAREHOUSE)

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/type_changed",
    "date": "2024-06-01T10:00:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

Same structure as location/created.

FieldTypeNullableDescription
idstring (uuid)NoUnique location identifier
organizationIdstring (uuid)NoOrganization that owns this location
namestringNoInternal unique name
titlestringNoHuman-readable display name
descriptionstringYesDescription
locationTypeenumNoNew location type: INTERNAL or 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 location is active
registerAllVariantsbooleanNoAuto-register all variants flag
stockManagementbooleanNoStock management 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": "p7q8r9s0-t1u2-3456-vwxy-789012345678",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "location/type_changed",
    "date": "2024-06-01T10:00:00.000Z"
  },
  "body": {
    "id": "j1k2l3m4-n5o6-7890-pqrs-123456789012",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "warehouse-paris-nord",
    "title": "Entrepôt Paris Nord",
    "description": "Principal warehouse for Île-de-France region",
    "locationType": "WAREHOUSE",
    "socialReason": "HappyColis Logistics SAS",
    "form": "SAS",
    "address": "12 Rue de la Logistique",
    "addressComplement": "Zone Industrielle Nord",
    "zipCode": "93200",
    "city": "Saint-Denis",
    "state": "Île-de-France",
    "country": "FR",
    "email": "warehouse-paris@happycolis.com",
    "phone": "+33142000000",
    "active": true,
    "registerAllVariants": false,
    "stockManagement": true,
    "stockEvents": true,
    "acceptFulfillmentAt": null,
    "stockRefRuleSetId": null,
    "orderDispatchRuleSetId": "k2l3m4n5-o6p7-8901-qrst-234567890123",
    "allowedCountries": ["FR", "BE", "LU", "CH"],
    "excludedCountries": null
  }
}

Notes

  • The locationType in the payload reflects the new type after the change.
  • Possible values: INTERNAL (managed in-house) and WAREHOUSE (managed by an external fulfillment service or dedicated warehouse operator).
  • A type change from INTERNAL to WAREHOUSE typically requires subsequent configuration of a fulfillment service integration.
  • This event is fired in addition to location/updated.

HappyColis API Documentation