POST v1/customer-locations/search

search for available customer locations using the search filters.

Request Information

URI Parameters

None.

Body Parameters

Customer Locations search parameters

Name	Description	Type	Additional information
Name		string	None.
Active	If not provided, gets all the active/inactive locations	boolean	None.
Customer	If provided, customer locations will be filtered based on the customer Id or Number or Name. If all of them are provided, Id takes the first precedence, then the number and then the name. All matching customer locations will be returned.	CustomerRef	None.
DateCreatedRange	The date and time (in company time zone) when the location was created.	DateRange	None.
LastUpdatedDateRange	The date and time (in company time zone) when the location was last updated.	DateRange	None.
Phone	customer locations will be filtered by matching all the phone numbers added to the locations.	string	None.
SortExpression	Available Sort Expresstions: [LocationName Default ASC, DateCreated, LastUpdateDate]	string	None.
PageIndex	zero-based page number	integer	None.
PageSize	Default value is 100	integer	Range: inclusive between 1 and 1000
SortOrder	Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending)	integer	Range: inclusive between 1 and 2

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "active": true,
  "customer": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "dateCreatedRange": null,
  "lastUpdatedDateRange": null,
  "phone": "sample string 2",
  "sortExpression": "sample string 3",
  "pageIndex": 4,
  "pageSize": 5,
  "sortOrder": 6
}

application/xml, text/xml

Sample:

<CustomerLocationSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.CRM">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">4</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">5</PageSize>
  <SortExpression i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models" />
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">6</SortOrder>
  <Active>true</Active>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </Customer>
  <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <LastUpdatedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <Name>sample string 1</Name>
  <Phone>sample string 2</Phone>
  <SortExpression>sample string 3</SortExpression>
</CustomerLocationSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfCustomerLocationSearchResult

Name	Description	Type	Additional information
TotalCount		integer	None.
Data		Collection of CustomerLocationSearchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "totalCount": 1,
  "data": [
    {
      "phones": [
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        },
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        }
      ],
      "id": 1,
      "name": "sample string 2",
      "customer": {
        "id": 1,
        "number": "sample string 2",
        "name": "sample string 3"
      },
      "isPrimary": true,
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postalCode": "sample string 6",
        "country": "sample string 7",
        "latitude": 8.0,
        "longitude": 9.0,
        "fullAddress": "sample string 10"
      }
    },
    {
      "phones": [
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        },
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        }
      ],
      "id": 1,
      "name": "sample string 2",
      "customer": {
        "id": 1,
        "number": "sample string 2",
        "name": "sample string 3"
      },
      "isPrimary": true,
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postalCode": "sample string 6",
        "country": "sample string 7",
        "latitude": 8.0,
        "longitude": 9.0,
        "fullAddress": "sample string 10"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<SearchResultOfCustomerLocationsUEq14mzK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.CRM.SearchResults">
    <d2p1:CustomerLocations>
      <d2p1:Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:Address3>sample string 3</d4p1:Address3>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:Country>sample string 7</d4p1:Country>
        <d4p1:FullAddress>sample string 10</d4p1:FullAddress>
        <d4p1:Latitude>8</d4p1:Latitude>
        <d4p1:Longitude>9</d4p1:Longitude>
        <d4p1:PostalCode>sample string 6</d4p1:PostalCode>
        <d4p1:State>sample string 5</d4p1:State>
      </d2p1:Address>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:Id>1</d4p1:Id>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Number>sample string 2</d4p1:Number>
      </d2p1:Customer>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Phones xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Phone>
          <d4p1:Active>true</d4p1:Active>
          <d4p1:CountryDialCode>2</d4p1:CountryDialCode>
          <d4p1:Extension>sample string 4</d4p1:Extension>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsPreferred>true</d4p1:IsPreferred>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:PhoneType>
        </d4p1:Phone>
        <d4p1:Phone>
          <d4p1:Active>true</d4p1:Active>
          <d4p1:CountryDialCode>2</d4p1:CountryDialCode>
          <d4p1:Extension>sample string 4</d4p1:Extension>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsPreferred>true</d4p1:IsPreferred>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:PhoneType>
        </d4p1:Phone>
      </d2p1:Phones>
    </d2p1:CustomerLocations>
    <d2p1:CustomerLocations>
      <d2p1:Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:Address3>sample string 3</d4p1:Address3>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:Country>sample string 7</d4p1:Country>
        <d4p1:FullAddress>sample string 10</d4p1:FullAddress>
        <d4p1:Latitude>8</d4p1:Latitude>
        <d4p1:Longitude>9</d4p1:Longitude>
        <d4p1:PostalCode>sample string 6</d4p1:PostalCode>
        <d4p1:State>sample string 5</d4p1:State>
      </d2p1:Address>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:Id>1</d4p1:Id>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Number>sample string 2</d4p1:Number>
      </d2p1:Customer>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Phones xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Phone>
          <d4p1:Active>true</d4p1:Active>
          <d4p1:CountryDialCode>2</d4p1:CountryDialCode>
          <d4p1:Extension>sample string 4</d4p1:Extension>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsPreferred>true</d4p1:IsPreferred>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:PhoneType>
        </d4p1:Phone>
        <d4p1:Phone>
          <d4p1:Active>true</d4p1:Active>
          <d4p1:CountryDialCode>2</d4p1:CountryDialCode>
          <d4p1:Extension>sample string 4</d4p1:Extension>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:IsPreferred>true</d4p1:IsPreferred>
          <d4p1:Number>sample string 3</d4p1:Number>
          <d4p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d4p1:PhoneType>
        </d4p1:Phone>
      </d2p1:Phones>
    </d2p1:CustomerLocations>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfCustomerLocationsUEq14mzK>