CRM360° CustomerApi Documentation

Customer - Store

Manage the stores attached to contacts for the current user's allowed zones.

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
StoreId Int32
StoreIdentifier String
Name String
Address1 String
Address2 String
Address3 String
Address4 String
Address5 String
Address6 String
Address7 String
PostCode String
City String
State String
CountryId String
PhoneNumber String
FaxNumber String
EmailAddress String
StoreTypeId Int16
StoreStateId Int16
DeletionFlag Boolean
BrandId Int32
ZoneId Int32
FreeField1 String
FreeField2 String
FreeField3 String
FreeField4 String
FreeField5 String
FreeFieldDateTime1 DateTime
FreeFieldDateTime2 DateTime
FreeFieldDateTime3 DateTime
FreeFieldDateTime4 DateTime
FreeFieldDateTime5 DateTime
FreeFieldNumber1 Decimal
FreeFieldNumber2 Decimal
FreeFieldNumber3 Decimal
FreeFieldNumber4 Decimal
FreeFieldNumber5 Decimal
FreeFieldBoolean1 Boolean
FreeFieldBoolean2 Boolean
FreeFieldBoolean3 Boolean
FreeFieldBoolean4 Boolean
FreeFieldBoolean5 Boolean
SourceId Int16
PurchaseHeaders Collection of PurchaseHeader
Brand Brand
Zone Zone
Country Country
StoreType StoreType
StoreState StoreState
AttachedStores Collection of AttachedStore
LoyaltyCards Collection of LoyaltyCard
Source Source

Examples

Select all Stores

https://customerapi.fts-crm360.com/data/Stores()
HttpMethod : GET
Json Result :
[ { "StoreId" : "13", "StoreIdentifier" : "vj9iY hSbUrmeF", "Name" : "veSnxhD 3w0 wz", "Address1" : "2cIAuf 4J dMmF", "Address2" : "qiLtEJ", "Address3" : "fWEqjExhkxeycOcc", "Address4" : "FwkHNSVc4y", "Address5" : "SnBteD", "Address6" : "y6C64Gn stzn1ME nUj", "Address7" : "SCvNpSsO8uwSYS", "PostCode" : "gTJ1dfYlmoQ72Mz", "City" : "Z5 ovL0Rm Z", "State" : "88gPihjfcdFJ5cIjZ", "CountryId" : "AJTXX8o6V", "PhoneNumber" : "3OCFgnoHAZUo", "FaxNumber" : "85 QuSBQ2", "EmailAddress" : "lXsplIR4m", "StoreTypeId" : "3", "StoreStateId" : "1", "DeletionFlag" : "False", "BrandId" : "24", "ZoneId" : "5", "FreeField1" : "Y ebY", "FreeField2" : "eY2Wbis5oSM 8ct 9C9", "FreeField3" : "et PZqxMVch eUF", "FreeField4" : "TIkj 960iQkVj0bco", "FreeField5" : "x9m7wxfjKwX", "FreeFieldDateTime1" : "2010-02-02T00:00:00", "FreeFieldDateTime2" : "2013-12-05T00:00:00", "FreeFieldDateTime3" : "2005-09-24T00:00:00", "FreeFieldDateTime4" : "2016-03-18T00:00:00", "FreeFieldDateTime5" : "2024-01-21T00:00:00", "FreeFieldNumber1" : "7942575.484", "FreeFieldNumber2" : "2886148.831", "FreeFieldNumber3" : "2448148.251", "FreeFieldNumber4" : "6266251.591", "FreeFieldNumber5" : "5214668.561", "FreeFieldBoolean1" : "True", "FreeFieldBoolean2" : "True", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "False", "FreeFieldBoolean5" : "False", "SourceId" : "3" }, { "StoreId" : "52", "StoreIdentifier" : "FE5T6yy QNbiR", "Name" : "5Qh PAOanQ", "Address1" : "bX0J5y1 dZ2H", "Address2" : "RTjkXjF", "Address3" : "uT2xJx", "Address4" : "eWpbpy", "Address5" : "a7 Valiz8BIV", "Address6" : "6coDDJ tD9Yv wf", "Address7" : "u cZy2", "PostCode" : "wAIfi6V nzDIBt", "City" : "YfXwW9al BrN", "State" : "q75C12B5o1ytJv", "CountryId" : "7ndZIB8AAfoUauqgOGM", "PhoneNumber" : "1IEL0jc1g9o rpcLiSE", "FaxNumber" : "t63hNilL8Vim7", "EmailAddress" : "DzhSikjFfC2zowQd", "StoreTypeId" : "9", "StoreStateId" : "9", "DeletionFlag" : "False", "BrandId" : "61", "ZoneId" : "23", "FreeField1" : "Ph9S8R3K A23kppQvf", "FreeField2" : "na0pZ", "FreeField3" : "06dXmjVjIi UPnSMUn", "FreeField4" : "7vLl sLhklf 2jYGV", "FreeField5" : "zzcgTbGp6f2", "FreeFieldDateTime1" : "2016-03-22T00:00:00", "FreeFieldDateTime2" : "2007-06-02T00:00:00", "FreeFieldDateTime3" : "1997-12-17T00:00:00", "FreeFieldDateTime4" : "2000-11-27T00:00:00", "FreeFieldDateTime5" : "2018-12-26T00:00:00", "FreeFieldNumber1" : "5263664.179", "FreeFieldNumber2" : "6227859.858", "FreeFieldNumber3" : "4447527.768", "FreeFieldNumber4" : "2421235.172", "FreeFieldNumber5" : "4474895.264", "FreeFieldBoolean1" : "False", "FreeFieldBoolean2" : "False", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "True", "FreeFieldBoolean5" : "True", "SourceId" : "1" }, ... ]

Select Store by Id

https://customerapi.fts-crm360.com/data/Stores(13)
HttpMethod : GET
Json Result :
{ "StoreId" : "72", "StoreIdentifier" : "0d4uY4zO6DnnB6CXc9", "Name" : "F7hokCREi 0nEf", "Address1" : "KRPoA2hjAdi V", "Address2" : "jM5bYm8T TrGzP Fa", "Address3" : "HdwxH 8yjYfKA", "Address4" : "7P9m6", "Address5" : "s3l2b67", "Address6" : "CRI6B 21EyDFekCkyp", "Address7" : "oJiRyKP1P", "PostCode" : "3UM2BuROkHAKEKKh r", "City" : "ADxoS", "State" : "e WwyIn Ld2Nb1wW", "CountryId" : "gPdEYFPV", "PhoneNumber" : "v 1 hikSOR3zU", "FaxNumber" : "iF9sqmPPDp0QYzqG4F", "EmailAddress" : "PZMHX6ToJnd", "StoreTypeId" : "5", "StoreStateId" : "4", "DeletionFlag" : "False", "BrandId" : "37", "ZoneId" : "93", "FreeField1" : "ZZktSeWL9RKwmHYxYEd", "FreeField2" : "8mwW8FnkLa", "FreeField3" : "3sse", "FreeField4" : "s7416YpI3ieF", "FreeField5" : "AG3lAxnNwM1w hN", "FreeFieldDateTime1" : "1999-07-08T00:00:00", "FreeFieldDateTime2" : "2020-09-06T00:00:00", "FreeFieldDateTime3" : "2021-09-08T00:00:00", "FreeFieldDateTime4" : "2007-04-05T00:00:00", "FreeFieldDateTime5" : "2021-02-14T00:00:00", "FreeFieldNumber1" : "3726513.221", "FreeFieldNumber2" : "5255492.379", "FreeFieldNumber3" : "8397119.849", "FreeFieldNumber4" : "1612439.319", "FreeFieldNumber5" : "6517673.523", "FreeFieldBoolean1" : "True", "FreeFieldBoolean2" : "True", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "False", "FreeFieldBoolean5" : "False", "SourceId" : "9" }

Create a Store

https://customerapi.fts-crm360.com/data/Stores()
HttpMethod : POST
Json Post :
{
"StoreIdentifier" : "XhZEXrNE5CSDF7zK",
"Name" : "WVRQFTzavI8 ZkK",
"Address1" : "jmxs4L0yluq9",
"Address2" : "VNZiHrqeRN",
"Address3" : "pnhPpfdHlhUBc",
"Address4" : "KeepWo 9uzv 1bdy",
"Address5" : "ViHPjT",
"Address6" : "7OM11d K6w8ML",
"Address7" : "5kwr3tfooApyc dVh",
"PostCode" : "L7tHb8HPyjDFeR",
"City" : "O 9WjqkBSkKMC",
"State" : "slOW",
"CountryId" : "GyIyio56",
"PhoneNumber" : "ihYMOje 96m4",
"FaxNumber" : "QwDPx2d1HQWGm",
"EmailAddress" : "i BpGtAn 1xbMlP Y",
"StoreTypeId" : "4",
"StoreStateId" : "7",
"DeletionFlag" : "False",
"BrandId" : "86",
"ZoneId" : "4",
"FreeField1" : "YIDFr G0G7oa",
"FreeField2" : "48yrgo6NcUp3mt3A W9",
"FreeField3" : "gofCnUNt qej",
"FreeField4" : "Rfah uO",
"FreeField5" : "P6zZNE",
"FreeFieldDateTime1" : "2015-05-05T00:00:00",
"FreeFieldDateTime2" : "2001-09-09T00:00:00",
"FreeFieldDateTime3" : "2019-01-29T00:00:00",
"FreeFieldDateTime4" : "2015-07-25T00:00:00",
"FreeFieldDateTime5" : "2012-03-26T00:00:00",
"FreeFieldNumber1" : "7953571.242",
"FreeFieldNumber2" : "2881732.554",
"FreeFieldNumber3" : "6743776.435",
"FreeFieldNumber4" : "5299938.398",
"FreeFieldNumber5" : "9589129.357",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"SourceId" : "9"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Store

https://customerapi.fts-crm360.com/data/Stores(13)
HttpMethod : DELETE