POST api/abcshops/v2/lookup

Looks up ABC Shops by specified parameters.

Request Information

URI Parameters

None.

Body Parameters

The parameters defining the requested items.

Name	Description	Type	Additional information
FilterText	The text to match to either location name or code.	string	None.
MatchPartial	Allow partial match	boolean	Default value is false
StartingRowNumber	Starting row number	integer	Default value is 0
RowCount	Maximum number of rows to return.	integer	Default value is 50
BusinessUnitId	Business Unit id to filter results by.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FilterText": "sample string 1",
  "MatchPartial": true,
  "StartingRowNumber": 3,
  "RowCount": 4,
  "BusinessUnitId": 1
}

application/xml, text/xml

Sample:

<AbcShopLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FilterText>sample string 1</FilterText>
  <MatchPartial>true</MatchPartial>
  <StartingRowNumber>3</StartingRowNumber>
  <RowCount>4</RowCount>
  <BusinessUnitId>1</BusinessUnitId>
</AbcShopLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the look up.

Collection of Location

Name	Description	Type	Additional information
LocationId	A number to identify this specific location.	integer	None.
ShortName	A shortened name for this location	string	None.
Name	The full name of the location	string	None.
Code	A code that can be used to identify this location.	string	None.
BillingAddress	The address to which correspondence is sent.	Address	None.
ShippingAddress	The address at which shipments are accepted.	Address	None.
LocationType	The type of location	LocationType	None.
Email	The email for the location	string	None.
Phone	The phone for the location	string	None.
CodCustomerId	For a shop, the Id of the Cod customer, if set.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LocationId": 1,
    "ShortName": "sample string 2",
    "Name": "sample string 3",
    "Code": "sample string 4",
    "BillingAddress": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "Street3": "sample string 3",
      "City": "sample string 4",
      "Region": "sample string 5",
      "Postalcode": "sample string 6",
      "PostalZip4": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "ShippingAddress": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "Street3": "sample string 3",
      "City": "sample string 4",
      "Region": "sample string 5",
      "Postalcode": "sample string 6",
      "PostalZip4": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "LocationType": 0,
    "Email": "sample string 5",
    "Phone": "sample string 6",
    "CodCustomerId": 1
  },
  {
    "LocationId": 1,
    "ShortName": "sample string 2",
    "Name": "sample string 3",
    "Code": "sample string 4",
    "BillingAddress": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "Street3": "sample string 3",
      "City": "sample string 4",
      "Region": "sample string 5",
      "Postalcode": "sample string 6",
      "PostalZip4": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "ShippingAddress": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "Street3": "sample string 3",
      "City": "sample string 4",
      "Region": "sample string 5",
      "Postalcode": "sample string 6",
      "PostalZip4": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "LocationType": 0,
    "Email": "sample string 5",
    "Phone": "sample string 6",
    "CodCustomerId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfLocation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Location>
    <LocationId>1</LocationId>
    <ShortName>sample string 2</ShortName>
    <Name>sample string 3</Name>
    <Code>sample string 4</Code>
    <BillingAddress>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <Street3>sample string 3</Street3>
      <City>sample string 4</City>
      <Region>sample string 5</Region>
      <Postalcode>sample string 6</Postalcode>
      <PostalZip4>sample string 7</PostalZip4>
      <CountryCode>sample string 8</CountryCode>
    </BillingAddress>
    <ShippingAddress>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <Street3>sample string 3</Street3>
      <City>sample string 4</City>
      <Region>sample string 5</Region>
      <Postalcode>sample string 6</Postalcode>
      <PostalZip4>sample string 7</PostalZip4>
      <CountryCode>sample string 8</CountryCode>
    </ShippingAddress>
    <LocationType>Customer</LocationType>
    <Email>sample string 5</Email>
    <Phone>sample string 6</Phone>
    <CodCustomerId>1</CodCustomerId>
  </Location>
  <Location>
    <LocationId>1</LocationId>
    <ShortName>sample string 2</ShortName>
    <Name>sample string 3</Name>
    <Code>sample string 4</Code>
    <BillingAddress>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <Street3>sample string 3</Street3>
      <City>sample string 4</City>
      <Region>sample string 5</Region>
      <Postalcode>sample string 6</Postalcode>
      <PostalZip4>sample string 7</PostalZip4>
      <CountryCode>sample string 8</CountryCode>
    </BillingAddress>
    <ShippingAddress>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <Street3>sample string 3</Street3>
      <City>sample string 4</City>
      <Region>sample string 5</Region>
      <Postalcode>sample string 6</Postalcode>
      <PostalZip4>sample string 7</PostalZip4>
      <CountryCode>sample string 8</CountryCode>
    </ShippingAddress>
    <LocationType>Customer</LocationType>
    <Email>sample string 5</Email>
    <Phone>sample string 6</Phone>
    <CodCustomerId>1</CodCustomerId>
  </Location>
</ArrayOfLocation>