POST api/AddressBook/AddBusinessBulkUpload
Request Information
URI Parameters
None.
Body Parameters
AddBusinessBulkUpload| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessID | integer |
None. |
|
| CreatedBy | integer |
None. |
|
| Groupname | string |
None. |
|
| UploadFileName | string |
None. |
|
| bulkUploadsList | Collection of BulkUpload |
None. |
Request Formats
application/json, text/json
Sample:
{
"BusinessID": 1,
"CreatedBy": 2,
"Groupname": "sample string 3",
"UploadFileName": "sample string 4",
"bulkUploadsList": [
{
"Customer_code": "sample string 1",
"First_Name": "sample string 2",
"Last_Name": "sample string 3",
"Backed_Customer_Ref_no": "sample string 4",
"Use_Customer_code_at_barcode": "sample string 5",
"Customer_Barcode": "sample string 6",
"Open_Account_Date": "sample string 7",
"Registration_Number": "sample string 8",
"Type": "sample string 9",
"Communication": "sample string 10",
"RelationShip": "sample string 11",
"Price_Group": "sample string 12",
"Group_Discount": "sample string 13",
"exclusivity": "sample string 14",
"Geography": "sample string 15",
"Distributor_channel": "sample string 16",
"Outlet_Type": "sample string 17",
"key_Acount_Group": "sample string 18",
"key_Account_Relational_Group": "sample string 19",
"Sold_To_Address_1": "sample string 20",
"Sold_To_Address_2": "sample string 21",
"Sold_To_City": "sample string 22",
"Sold_To_State": "sample string 23",
"Sold_To_Address_5": "sample string 24",
"Sold_to_Postal_Code": "sample string 25",
"Bill_To_Code": "sample string 26",
"Bill_To_Name": "sample string 27",
"Bill_To_Address_1": "sample string 28",
"Bill_To_Address_2": "sample string 29",
"Bill_To_City": "sample string 30",
"Bill_To_State": "sample string 31",
"Bill_To_Address_5": "sample string 32",
"Bill_to_Postal_Code": "sample string 33",
"Contact_Person": "sample string 34",
"Telephone_Number": "sample string 35",
"Extension": "sample string 36",
"Additional_Telephone_Number": "sample string 37",
"Mobile_Number": "sample string 38",
"Fax_Number": "sample string 39",
"Email_Address": "sample string 40",
"Terms": "sample string 41",
"Credit_Limit": "sample string 42",
"Cust_Discount": "sample string 43",
"Tax_Exemption": "sample string 44",
"Exemption_Number": "sample string 45",
"Company_Tax_Registration_Number": "sample string 46",
"Special_Instrucation": "sample string 47",
"Bank": "sample string 48",
"Bank_Branch": "sample string 49",
"Bank_Account_Number": "sample string 50",
"Opening_Banlace": "sample string 51",
"Ac_of_Date": "sample string 52",
"DKA_Customer": "sample string 53",
"Seasonal_Customer": "sample string 54",
"Season_Start_Date": "sample string 55",
"Season_End_Date": "sample string 56",
"Longitude": "sample string 57",
"Latitude": "sample string 58",
"Image_Upload": "sample string 59",
"Distributor_User_Defined_1": "sample string 60",
"Distributor_User_Defined_2": "sample string 61",
"Distributor_User_Defined_3": "sample string 62",
"Distributor_User_Defined_4": "sample string 63",
"Distributor_User_Defined_5": "sample string 64"
},
{
"Customer_code": "sample string 1",
"First_Name": "sample string 2",
"Last_Name": "sample string 3",
"Backed_Customer_Ref_no": "sample string 4",
"Use_Customer_code_at_barcode": "sample string 5",
"Customer_Barcode": "sample string 6",
"Open_Account_Date": "sample string 7",
"Registration_Number": "sample string 8",
"Type": "sample string 9",
"Communication": "sample string 10",
"RelationShip": "sample string 11",
"Price_Group": "sample string 12",
"Group_Discount": "sample string 13",
"exclusivity": "sample string 14",
"Geography": "sample string 15",
"Distributor_channel": "sample string 16",
"Outlet_Type": "sample string 17",
"key_Acount_Group": "sample string 18",
"key_Account_Relational_Group": "sample string 19",
"Sold_To_Address_1": "sample string 20",
"Sold_To_Address_2": "sample string 21",
"Sold_To_City": "sample string 22",
"Sold_To_State": "sample string 23",
"Sold_To_Address_5": "sample string 24",
"Sold_to_Postal_Code": "sample string 25",
"Bill_To_Code": "sample string 26",
"Bill_To_Name": "sample string 27",
"Bill_To_Address_1": "sample string 28",
"Bill_To_Address_2": "sample string 29",
"Bill_To_City": "sample string 30",
"Bill_To_State": "sample string 31",
"Bill_To_Address_5": "sample string 32",
"Bill_to_Postal_Code": "sample string 33",
"Contact_Person": "sample string 34",
"Telephone_Number": "sample string 35",
"Extension": "sample string 36",
"Additional_Telephone_Number": "sample string 37",
"Mobile_Number": "sample string 38",
"Fax_Number": "sample string 39",
"Email_Address": "sample string 40",
"Terms": "sample string 41",
"Credit_Limit": "sample string 42",
"Cust_Discount": "sample string 43",
"Tax_Exemption": "sample string 44",
"Exemption_Number": "sample string 45",
"Company_Tax_Registration_Number": "sample string 46",
"Special_Instrucation": "sample string 47",
"Bank": "sample string 48",
"Bank_Branch": "sample string 49",
"Bank_Account_Number": "sample string 50",
"Opening_Banlace": "sample string 51",
"Ac_of_Date": "sample string 52",
"DKA_Customer": "sample string 53",
"Seasonal_Customer": "sample string 54",
"Season_Start_Date": "sample string 55",
"Season_End_Date": "sample string 56",
"Longitude": "sample string 57",
"Latitude": "sample string 58",
"Image_Upload": "sample string 59",
"Distributor_User_Defined_1": "sample string 60",
"Distributor_User_Defined_2": "sample string 61",
"Distributor_User_Defined_3": "sample string 62",
"Distributor_User_Defined_4": "sample string 63",
"Distributor_User_Defined_5": "sample string 64"
}
]
}
application/xml, text/xml
Sample:
<AddBusinessBulkUpload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
<BusinessID>1</BusinessID>
<CreatedBy>2</CreatedBy>
<Groupname>sample string 3</Groupname>
<UploadFileName>sample string 4</UploadFileName>
<bulkUploadsList>
<BulkUpload>
<Ac_of_Date>sample string 52</Ac_of_Date>
<Additional_Telephone_Number>sample string 37</Additional_Telephone_Number>
<Backed_Customer_Ref_no>sample string 4</Backed_Customer_Ref_no>
<Bank>sample string 48</Bank>
<Bank_Account_Number>sample string 50</Bank_Account_Number>
<Bank_Branch>sample string 49</Bank_Branch>
<Bill_To_Address_1>sample string 28</Bill_To_Address_1>
<Bill_To_Address_2>sample string 29</Bill_To_Address_2>
<Bill_To_Address_5>sample string 32</Bill_To_Address_5>
<Bill_To_City>sample string 30</Bill_To_City>
<Bill_To_Code>sample string 26</Bill_To_Code>
<Bill_To_Name>sample string 27</Bill_To_Name>
<Bill_To_State>sample string 31</Bill_To_State>
<Bill_to_Postal_Code>sample string 33</Bill_to_Postal_Code>
<Communication>sample string 10</Communication>
<Company_Tax_Registration_Number>sample string 46</Company_Tax_Registration_Number>
<Contact_Person>sample string 34</Contact_Person>
<Credit_Limit>sample string 42</Credit_Limit>
<Cust_Discount>sample string 43</Cust_Discount>
<Customer_Barcode>sample string 6</Customer_Barcode>
<Customer_code>sample string 1</Customer_code>
<DKA_Customer>sample string 53</DKA_Customer>
<Distributor_User_Defined_1>sample string 60</Distributor_User_Defined_1>
<Distributor_User_Defined_2>sample string 61</Distributor_User_Defined_2>
<Distributor_User_Defined_3>sample string 62</Distributor_User_Defined_3>
<Distributor_User_Defined_4>sample string 63</Distributor_User_Defined_4>
<Distributor_User_Defined_5>sample string 64</Distributor_User_Defined_5>
<Distributor_channel>sample string 16</Distributor_channel>
<Email_Address>sample string 40</Email_Address>
<Exemption_Number>sample string 45</Exemption_Number>
<Extension>sample string 36</Extension>
<Fax_Number>sample string 39</Fax_Number>
<First_Name>sample string 2</First_Name>
<Geography>sample string 15</Geography>
<Group_Discount>sample string 13</Group_Discount>
<Image_Upload>sample string 59</Image_Upload>
<Last_Name>sample string 3</Last_Name>
<Latitude>sample string 58</Latitude>
<Longitude>sample string 57</Longitude>
<Mobile_Number>sample string 38</Mobile_Number>
<Open_Account_Date>sample string 7</Open_Account_Date>
<Opening_Banlace>sample string 51</Opening_Banlace>
<Outlet_Type>sample string 17</Outlet_Type>
<Price_Group>sample string 12</Price_Group>
<Registration_Number>sample string 8</Registration_Number>
<RelationShip>sample string 11</RelationShip>
<Season_End_Date>sample string 56</Season_End_Date>
<Season_Start_Date>sample string 55</Season_Start_Date>
<Seasonal_Customer>sample string 54</Seasonal_Customer>
<Sold_To_Address_1>sample string 20</Sold_To_Address_1>
<Sold_To_Address_2>sample string 21</Sold_To_Address_2>
<Sold_To_Address_5>sample string 24</Sold_To_Address_5>
<Sold_To_City>sample string 22</Sold_To_City>
<Sold_To_State>sample string 23</Sold_To_State>
<Sold_to_Postal_Code>sample string 25</Sold_to_Postal_Code>
<Special_Instrucation>sample string 47</Special_Instrucation>
<Tax_Exemption>sample string 44</Tax_Exemption>
<Telephone_Number>sample string 35</Telephone_Number>
<Terms>sample string 41</Terms>
<Type>sample string 9</Type>
<Use_Customer_code_at_barcode>sample string 5</Use_Customer_code_at_barcode>
<exclusivity>sample string 14</exclusivity>
<key_Account_Relational_Group>sample string 19</key_Account_Relational_Group>
<key_Acount_Group>sample string 18</key_Acount_Group>
</BulkUpload>
<BulkUpload>
<Ac_of_Date>sample string 52</Ac_of_Date>
<Additional_Telephone_Number>sample string 37</Additional_Telephone_Number>
<Backed_Customer_Ref_no>sample string 4</Backed_Customer_Ref_no>
<Bank>sample string 48</Bank>
<Bank_Account_Number>sample string 50</Bank_Account_Number>
<Bank_Branch>sample string 49</Bank_Branch>
<Bill_To_Address_1>sample string 28</Bill_To_Address_1>
<Bill_To_Address_2>sample string 29</Bill_To_Address_2>
<Bill_To_Address_5>sample string 32</Bill_To_Address_5>
<Bill_To_City>sample string 30</Bill_To_City>
<Bill_To_Code>sample string 26</Bill_To_Code>
<Bill_To_Name>sample string 27</Bill_To_Name>
<Bill_To_State>sample string 31</Bill_To_State>
<Bill_to_Postal_Code>sample string 33</Bill_to_Postal_Code>
<Communication>sample string 10</Communication>
<Company_Tax_Registration_Number>sample string 46</Company_Tax_Registration_Number>
<Contact_Person>sample string 34</Contact_Person>
<Credit_Limit>sample string 42</Credit_Limit>
<Cust_Discount>sample string 43</Cust_Discount>
<Customer_Barcode>sample string 6</Customer_Barcode>
<Customer_code>sample string 1</Customer_code>
<DKA_Customer>sample string 53</DKA_Customer>
<Distributor_User_Defined_1>sample string 60</Distributor_User_Defined_1>
<Distributor_User_Defined_2>sample string 61</Distributor_User_Defined_2>
<Distributor_User_Defined_3>sample string 62</Distributor_User_Defined_3>
<Distributor_User_Defined_4>sample string 63</Distributor_User_Defined_4>
<Distributor_User_Defined_5>sample string 64</Distributor_User_Defined_5>
<Distributor_channel>sample string 16</Distributor_channel>
<Email_Address>sample string 40</Email_Address>
<Exemption_Number>sample string 45</Exemption_Number>
<Extension>sample string 36</Extension>
<Fax_Number>sample string 39</Fax_Number>
<First_Name>sample string 2</First_Name>
<Geography>sample string 15</Geography>
<Group_Discount>sample string 13</Group_Discount>
<Image_Upload>sample string 59</Image_Upload>
<Last_Name>sample string 3</Last_Name>
<Latitude>sample string 58</Latitude>
<Longitude>sample string 57</Longitude>
<Mobile_Number>sample string 38</Mobile_Number>
<Open_Account_Date>sample string 7</Open_Account_Date>
<Opening_Banlace>sample string 51</Opening_Banlace>
<Outlet_Type>sample string 17</Outlet_Type>
<Price_Group>sample string 12</Price_Group>
<Registration_Number>sample string 8</Registration_Number>
<RelationShip>sample string 11</RelationShip>
<Season_End_Date>sample string 56</Season_End_Date>
<Season_Start_Date>sample string 55</Season_Start_Date>
<Seasonal_Customer>sample string 54</Seasonal_Customer>
<Sold_To_Address_1>sample string 20</Sold_To_Address_1>
<Sold_To_Address_2>sample string 21</Sold_To_Address_2>
<Sold_To_Address_5>sample string 24</Sold_To_Address_5>
<Sold_To_City>sample string 22</Sold_To_City>
<Sold_To_State>sample string 23</Sold_To_State>
<Sold_to_Postal_Code>sample string 25</Sold_to_Postal_Code>
<Special_Instrucation>sample string 47</Special_Instrucation>
<Tax_Exemption>sample string 44</Tax_Exemption>
<Telephone_Number>sample string 35</Telephone_Number>
<Terms>sample string 41</Terms>
<Type>sample string 9</Type>
<Use_Customer_code_at_barcode>sample string 5</Use_Customer_code_at_barcode>
<exclusivity>sample string 14</exclusivity>
<key_Account_Relational_Group>sample string 19</key_Account_Relational_Group>
<key_Acount_Group>sample string 18</key_Acount_Group>
</BulkUpload>
</bulkUploadsList>
</AddBusinessBulkUpload>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VCAPIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | string |
None. |
|
| dateTime | string |
None. |
|
| StatusCode | integer |
None. |
|
| ErrorMessage | string |
None. |
|
| Result | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"Version": "1.0.0",
"dateTime": "2025/11/03 15:58:49",
"StatusCode": 1,
"ErrorMessage": "sample string 2",
"Result": {}
}
application/xml, text/xml
Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model"> <ErrorMessage>sample string 2</ErrorMessage> <Result /> <StatusCode>1</StatusCode> </VCAPIResponse>