GET api/v3/customers/locations/{locationId}

Retrieves details regarding a specific location for a customer

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	The id of the location for which to get details	integer	Required

Body Parameters

None.

Response Information

Resource Description

A structure containing the information for the location

CustomerLocation

Name	Description	Type	Additional information
Status	Indicates whether the location is open or closed.	OpenCloseStatus	None.
DefaultShopId	The LocationId of the ABC Shop to use by default	integer	None.
DefaultShopCode	The Code of the ABC Shop to use by default	string	None.
DefaultPricingId	The PricingId of the customer's pricing to use by default	integer	None.
TaxCode	The sales tax code used by default	string	None.
ShippingAttention	The attention line for the shipping address	string	None.
BillingAttention	The attention line for the billing address	string	None.
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:

{
  "Status": 0,
  "DefaultShopId": 1,
  "DefaultShopCode": "sample string 1",
  "DefaultPricingId": 1,
  "TaxCode": "sample string 2",
  "ShippingAttention": "sample string 3",
  "BillingAttention": "sample string 4",
  "LocationId": 5,
  "ShortName": "sample string 6",
  "Name": "sample string 7",
  "Code": "sample string 8",
  "BillingAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "Region": "sample string 4",
    "Postalcode": "sample string 5",
    "PostalZip4": "sample string 6",
    "CountryCode": "sample string 7"
  },
  "ShippingAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "Region": "sample string 4",
    "Postalcode": "sample string 5",
    "PostalZip4": "sample string 6",
    "CountryCode": "sample string 7"
  },
  "LocationType": 0,
  "Email": "sample string 9",
  "Phone": "sample string 10",
  "CodCustomerId": 1
}

application/xml, text/xml

Sample:

<CustomerLocation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LocationId>5</LocationId>
  <ShortName>sample string 6</ShortName>
  <Name>sample string 7</Name>
  <Code>sample string 8</Code>
  <BillingAddress>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
    <City>sample string 3</City>
    <Region>sample string 4</Region>
    <Postalcode>sample string 5</Postalcode>
    <PostalZip4>sample string 6</PostalZip4>
    <CountryCode>sample string 7</CountryCode>
  </BillingAddress>
  <ShippingAddress>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
    <City>sample string 3</City>
    <Region>sample string 4</Region>
    <Postalcode>sample string 5</Postalcode>
    <PostalZip4>sample string 6</PostalZip4>
    <CountryCode>sample string 7</CountryCode>
  </ShippingAddress>
  <LocationType>Customer</LocationType>
  <Email>sample string 9</Email>
  <Phone>sample string 10</Phone>
  <CodCustomerId>1</CodCustomerId>
  <Status>Open</Status>
  <DefaultShopId>1</DefaultShopId>
  <DefaultShopCode>sample string 1</DefaultShopCode>
  <DefaultPricingId>1</DefaultPricingId>
  <TaxCode>sample string 2</TaxCode>
  <ShippingAttention>sample string 3</ShippingAttention>
  <BillingAttention>sample string 4</BillingAttention>
</CustomerLocation>