location/deactivated

Overview

Property	Value
Webhook type	location/deactivated
Kafka topic	location.deactivated
Direction	Platform → Your endpoint

Description

Fired when a location is deactivated. A deactivated location will no longer accept new fulfillment requests or stock movements. In-progress operations are not automatically interrupted.

Trigger Conditions

• A user or integration deactivates a location via the API
• active transitions from true to false

Message Envelope

{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "location/deactivated",
    "date": "2024-05-01T18:00:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

Same structure as location/created.

Field	Type	Nullable	Description
id	string (uuid)	No	Unique location identifier
organizationId	string (uuid)	No	Organization that owns this location
name	string	No	Internal unique name
title	string	No	Human-readable display name
description	string	Yes	Description
locationType	enum	No	INTERNAL or WAREHOUSE
socialReason	string	Yes	Legal entity name
form	string	Yes	Legal form
address	string	Yes	Street address
addressComplement	string	Yes	Address complement
zipCode	string	Yes	Postal/ZIP code
city	string	Yes	City
state	string	Yes	State or region
country	string	Yes	ISO 3166-1 alpha-2 country code
email	string	Yes	Contact email
phone	string	Yes	Contact phone
active	boolean	No	Always false for this event
registerAllVariants	boolean	No	Auto-register all variants flag
stockManagement	boolean	No	Stock management flag
stockEvents	boolean	No	Stock event emission flag
acceptFulfillmentAt	string (ISO 8601)	Yes	Fulfillment acceptance start date
stockRefRuleSetId	string (uuid)	Yes	Stock reference rule set ID
orderDispatchRuleSetId	string (uuid)	Yes	Order dispatch rule set ID
allowedCountries	string[]	Yes	Allowed shipping country codes
excludedCountries	string[]	Yes	Excluded shipping country codes

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "o6p7q8r9-s0t1-2345-uvwx-678901234567",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "location/deactivated",
    "date": "2024-05-01T18: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": false,
    "registerAllVariants": false,
    "stockManagement": true,
    "stockEvents": true,
    "acceptFulfillmentAt": null,
    "stockRefRuleSetId": null,
    "orderDispatchRuleSetId": "k2l3m4n5-o6p7-8901-qrst-234567890123",
    "allowedCountries": ["FR", "BE", "LU", "CH"],
    "excludedCountries": null
  }
}

Related Events

• location/activated — the counterpart event
• location/updated — fired on any field update

Notes

• The active field is always false in this event payload.
• Deactivating a location does not cancel in-flight delivery orders or shipments — those must be handled separately.
• The location can be re-activated at any time, which will fire a location/activated event.