Skip to content

location/activated

Overview

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

Description

Fired when a previously deactivated location is re-activated. An active location can receive stock, accept fulfillment requests, and dispatch orders.

Trigger Conditions

  • A user or integration re-activates a deactivated location via the API
  • active transitions from false to true

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/activated",
    "date": "2024-04-10T08: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
locationTypeenumNoINTERNAL 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
activebooleanNoAlways true for this event
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": "n5o6p7q8-r9s0-1234-tuvw-567890123456",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "location/activated",
    "date": "2024-04-10T08: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 active field is always true in this event payload.
  • This event is fired in addition to location/updated when a location is re-activated.
  • A newly created location is active by default; location/activated only fires on re-activation after a deactivation.

HappyColis API Documentation