Information for: DEVELOPERS   PARTNERS   SUPPORT

Organization Feed

Feed structure

Field Name Required ? Data type Referential integrity Description
SourceOrganizationNumber (key) Required String Transaction:SourceOrganizationNumber, TransactionItem:SourceOrganizationNumber The unique identifier of the organization in your data.
Name Required String   The organization’s name.
Status Required String   Status of the organization (accepted values are : “open”, “closed”).
Type Required String   Describes the type of organization. The only accepted values are : Digital, Physical, Warehouse, Other. If not provided, we will default to “Other”. Note that this field is used to determine which organization is a store (type = “Physical”) and thus, it is a requirement for any “distance-to-store” reporting or audience selection.
SubType Recommended String   The subtype of your organization (e.g. outlet store, warehouse store…)
ParentSourceOrganizationNumber Required (if available) String Organization: SourceOrganizationNumber Identifier of the parent organization in your data. If populated, it should reference another row in the feed. If it does not (i.e. this organization has no parent), leave it empty.
Country Required String   The standard ISO Alpha-2 code for the country where the organization is located (e.g. United States should be “US”, Canada should be “CA”, France should be “FR”, etc…). Two character ISO Alpha-2 codes are required for distance-to-store and closest-store calculations. See the list of supported countries for more details
State Required String   The state where the organization is located. Required for distance-to-store calculations.
City Required String   The city where the organization is located. Required for distance-to-store calculations
Address1 Required String   The address where the organization is located. Required for distance-to-store calculations.
Address2 Required String   The address where the organization is located. Required for distance-to-store calculations.
Zip Required String   The zip or postal code of the organization’s location. This should contain the Zipcode only, not the +4. Required for distance-to-store calculations.
ExcludeAsClosestStore Optional Integer   Marks store that should be excluded from distance-to-store calculations. Only authorized values are 0 (ie “don’t exclude that store”, this is the default) and 1 (ie “exclude that store”).
DateCreated Optional String   Date at which the record was created in the client’s system.
Custom attributes Optional Any (float, datetime, string, boolean)   Custom attributes that you want to use inside the Customer Data Platform (CDP) application. Note that this customization is not self-service, requires you to engage with your CDP CSM, and involves some deployment effort.