Get All Customers

This method returns list of Customers. The client makes a PUT request providing input parameters CompanyID and LangID in the request url. The output will be either in json or xml format depending on the request type.

Please note that “CustomerUnitID” value in the Customer Node will always be 0 when retrieving Customer Information. These fields are only used during customer creation.
Name Value
REST-API METHOD GET ALL CUSTOMERS
HTTP METHOD POST
RESPONSE TYPE XML
URL https://api.csm.next4biz.net/services/CustomerService/{CompanyID}/Customers.json/{LangID}https://api.csm.next4biz.net/services/CustomerService/{CompanyID}/Customers.xml/{LangID}
REQUEST HEAD Authorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+json,application/json;q=0.9,*/*;q=0.8 Content-Type: application/jsonAuthorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Content-Type: application/xml
  • XML
  • JSON
ENDPOINT DEFINITION
POST
REQUEST BODY
                                    
                                        <Customer>
	<CustomerBusinessChannelID>{CustomerBusinessChannelID}</CustomerBusinessChannelID>
	<CustomerCode></CustomerCode>
	<CustomerEmail></CustomerEmail>
	<CustomerFields>
		<CustomerField>
			<CustomerFieldID>{CustomerFieldID}</CustomerFieldID>
			<CustomerFieldValue>{CustomerFieldValue}</CustomerFieldValue>
		</CustomerField>
	</CustomerFields>
	<CustomerHomePhoneNumber></CustomerHomePhoneNumber>
	<CustomerMobilePhoneNumber></CustomerMobilePhoneNumber>
	<CustomerName>{CustomerName}</CustomerName>
	<CustomerSurname></CustomerSurname>
	<CustomerPassword></CustomerPassword>
	<CustomerWorkPhoneNumber></CustomerWorkPhoneNumber>
	<InventoryFilter>
		<SearchItems>
			<InventoryFilterItem>
				<InventoryTypeId>{InventoryTypeId}</InventoryTypeId>
				<Keyword>{Keyword}</Keyword>
			</InventoryFilterItem>
		</SearchItems>
	</InventoryFilter>
</Customer>
                                    
                                
                                                                        
                                        {
    "CustomerBusinessChannelID": "{CustomerBusinessChannelID}",
    "CustomerCode": {},
    "CustomerEmail": {},
    "CustomerFields": {
        "CustomerField": {
            "CustomerFieldID": "{CustomerFieldID}",
            "CustomerFieldValue": "{CustomerFieldValue}"
        }
    },
    "CustomerHomePhoneNumber": {},
    "CustomerMobilePhoneNumber": {},
    "CustomerName": "{CustomerName}",
    "CustomerSurname": {},
    "CustomerPassword": {},
    "CustomerWorkPhoneNumber": {},
    "InventoryFilter": {
        "SearchItems": {
            "InventoryFilterItem": {
                "InventoryTypeId": "{InventoryTypeId}",
                "Keyword": "{Keyword}"
            }
        }
    }
}                                    
                                                                    
RESPONSE BODY
                                    
                                        <?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomer
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Customer>
		<CustomerEmail>{CustomerEmail}</CustomerEmail>
		<CustomerHomePhoneNumber>{CustomerHomePhoneNumber}</CustomerHomePhoneNumber>
		<CustomerID>{CustomerHomePhoneNumber}</CustomerID>
		<CustomerMobilePhoneNumber>{CustomerMobilePhoneNumber}</CustomerMobilePhoneNumber>
		<CustomerName>{CustomerName}</CustomerName>
		<CustomerSurname>{CustomerSurname}</CustomerSurname>
		<CustomerWorkPhoneNumber>{CustomerWorkPhoneNumber}</CustomerWorkPhoneNumber>
		<CustomerBusinessChannelID>{CustomerBusinessChannelID}</CustomerBusinessChannelID>
		<CustomerUnitID>0</CustomerUnitID>
		<CustomerFields>
			<CustomerField>
				<CustomerFieldID>{CustomerFieldID}</CustomerFieldID>
				<CustomerFieldValues>
					<CustomerFieldReferenceValue CustomerFieldReferenceValueID="{ID}">
						<CustomerFieldReferenceValueText>{Text}</CustomerFieldReferenceValueText>
					</CustomerFieldReferenceValue>
				</CustomerFieldValues>
			</CustomerField>
			<CustomerField>
				<CustomerFieldID>{CustomerFieldID}</CustomerFieldID>
				<CustomerFieldValue>{CustomerFieldValue}</CustomerFieldValue>
			</CustomerField>
		</CustomerFields>
	</Customer>
</ArrayOfCustomer>                                    
                                
                                                                        
                                        {
    "Customer": {
        "CustomerEmail": "{CustomerEmail}",
        "CustomerHomePhoneNumber": "{CustomerHomePhoneNumber}",
        "CustomerID": "{CustomerHomePhoneNumber}",
        "CustomerMobilePhoneNumber": "{CustomerMobilePhoneNumber}",
        "CustomerName": "{CustomerName}",
        "CustomerSurname": "{CustomerSurname}",
        "CustomerWorkPhoneNumber": "{CustomerWorkPhoneNumber}",
        "CustomerBusinessChannelID": "{CustomerBusinessChannelID}",
        "CustomerUnitID": "0",
        "CustomerFields": {
            "CustomerField": [
                {
                    "CustomerFieldID": "{CustomerFieldID}",
                    "CustomerFieldValues": {
                        "CustomerFieldReferenceValue": {
                            "CustomerFieldReferenceValueID": "{ID}",
                            "CustomerFieldReferenceValueText": "{Text}"
                        }
                    }
                },
                {
                    "CustomerFieldID": "{CustomerFieldID}",
                    "CustomerFieldValue": "{CustomerFieldValue}"
                }
            ]
        }
    }
}