GET api/customers/{customerCode}

Retrieves detailed information about a customer.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerCode

The CustomerCode for the requested customer.

string

Required

Body Parameters

None.

Response Information

Resource Description

Detailed information about a customer.

CustomerDetailedInformation
NameDescriptionTypeAdditional information
BusinessUnitId

A number identifying the business unit this specific customer belongs to

integer

None.

BusinessUnitName

The short name of the business unit this specific customer belongs to

string

None.

CustomerId

A number to identify this specific customer

integer

None.

CustomerCode

A short code used to identify the customer

string

None.

CustomerName

The customer's name

string

None.

CorporateAddress

The corporate address

Address

None.

DefaultPricingId

The PricingId of the customer level default pricing sheet.

integer

None.

DefaultLocationId

The LocationId of the customer's default location for placing orders.

integer

None.

LocationList

A list of the customer's locations.

Collection of CustomerLocation

None.

PricingList

A list of the customer's pricing sheets.

Collection of CustomerPricing

None.

ShippingProfile

The customer's default shipping profile.

ShippingProfile

None.

DefaultShippingProfileId

The id of the shipping profile that would be used by default.

integer

None.

ShipItShippingProfileId

The id of the "Ship-It" shipping profile, or the default profile id if not explicitly set in system.

integer

None.

ShippingProfileDetails

Detailed information on shipping profiles.

Collection of ShippingProfile

None.

RequiresPoNo

Is a po number required?

boolean

None.

RequiresProject

Is a project required?

boolean

None.

UseProjectList

Does the customer requires projects selected from project list

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "BusinessUnitId": 1,
  "BusinessUnitName": "sample string 2",
  "CustomerId": 3,
  "CustomerCode": "sample string 4",
  "CustomerName": "sample string 5",
  "CorporateAddress": {
    "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"
  },
  "DefaultPricingId": 1,
  "DefaultLocationId": 1,
  "LocationList": [
    {
      "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
    },
    {
      "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
    }
  ],
  "PricingList": [
    {
      "PricingId": 1,
      "Number": "sample string 2",
      "Name": "sample string 3",
      "EffectivedDate": "2024-12-25T09:11:50.7577622-05:00",
      "PricingCurrencyDescription": "sample string 5"
    },
    {
      "PricingId": 1,
      "Number": "sample string 2",
      "Name": "sample string 3",
      "EffectivedDate": "2024-12-25T09:11:50.7577622-05:00",
      "PricingCurrencyDescription": "sample string 5"
    }
  ],
  "ShippingProfile": {
    "ProfileId": 1,
    "ProfileName": "sample string 2",
    "PackagingCharges": [
      {
        "ItemCode": "sample string 1",
        "AdjustmentType": 0,
        "AdjustmentAmount": 2.0,
        "Code": "sample string 3",
        "Description": "sample string 4"
      },
      {
        "ItemCode": "sample string 1",
        "AdjustmentType": 0,
        "AdjustmentAmount": 2.0,
        "Code": "sample string 3",
        "Description": "sample string 4"
      }
    ],
    "HandlingCharges": [
      {
        "ItemCode": "sample string 1",
        "AdjustmentType": 0,
        "AdjustmentAmount": 2.0,
        "Code": "sample string 3",
        "Description": "sample string 4"
      },
      {
        "ItemCode": "sample string 1",
        "AdjustmentType": 0,
        "AdjustmentAmount": 2.0,
        "Code": "sample string 3",
        "Description": "sample string 4"
      }
    ],
    "ShippingAccounts": [
      {
        "ShippingMethod": 1,
        "Code": "sample string 1",
        "Description": "sample string 2"
      },
      {
        "ShippingMethod": 1,
        "Code": "sample string 1",
        "Description": "sample string 2"
      }
    ],
    "ShippingMethods": [
      1,
      1
    ]
  },
  "DefaultShippingProfileId": 1,
  "ShipItShippingProfileId": 1,
  "ShippingProfileDetails": [
    {
      "ProfileId": 1,
      "ProfileName": "sample string 2",
      "PackagingCharges": [
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        },
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        }
      ],
      "HandlingCharges": [
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        },
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        }
      ],
      "ShippingAccounts": [
        {
          "ShippingMethod": 1,
          "Code": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "ShippingMethod": 1,
          "Code": "sample string 1",
          "Description": "sample string 2"
        }
      ],
      "ShippingMethods": [
        1,
        1
      ]
    },
    {
      "ProfileId": 1,
      "ProfileName": "sample string 2",
      "PackagingCharges": [
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        },
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        }
      ],
      "HandlingCharges": [
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        },
        {
          "ItemCode": "sample string 1",
          "AdjustmentType": 0,
          "AdjustmentAmount": 2.0,
          "Code": "sample string 3",
          "Description": "sample string 4"
        }
      ],
      "ShippingAccounts": [
        {
          "ShippingMethod": 1,
          "Code": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "ShippingMethod": 1,
          "Code": "sample string 1",
          "Description": "sample string 2"
        }
      ],
      "ShippingMethods": [
        1,
        1
      ]
    }
  ],
  "RequiresPoNo": true,
  "RequiresProject": true,
  "UseProjectList": true
}

application/xml, text/xml

Sample:
<CustomerDetailedInformation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BusinessUnitId>1</BusinessUnitId>
  <BusinessUnitName>sample string 2</BusinessUnitName>
  <CustomerId>3</CustomerId>
  <CustomerCode>sample string 4</CustomerCode>
  <CustomerName>sample string 5</CustomerName>
  <CorporateAddress>
    <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>
  </CorporateAddress>
  <DefaultPricingId>1</DefaultPricingId>
  <DefaultLocationId>1</DefaultLocationId>
  <LocationList>
    <CustomerLocation>
      <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>
    <CustomerLocation>
      <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>
  </LocationList>
  <PricingList>
    <CustomerPricing>
      <PricingId>1</PricingId>
      <Number>sample string 2</Number>
      <Name>sample string 3</Name>
      <EffectivedDate>2024-12-25T09:11:50.7577622-05:00</EffectivedDate>
      <PricingCurrencyDescription>sample string 5</PricingCurrencyDescription>
    </CustomerPricing>
    <CustomerPricing>
      <PricingId>1</PricingId>
      <Number>sample string 2</Number>
      <Name>sample string 3</Name>
      <EffectivedDate>2024-12-25T09:11:50.7577622-05:00</EffectivedDate>
      <PricingCurrencyDescription>sample string 5</PricingCurrencyDescription>
    </CustomerPricing>
  </PricingList>
  <ShippingProfile>
    <ProfileId>1</ProfileId>
    <ProfileName>sample string 2</ProfileName>
    <PackagingCharges>
      <ShippingChargeDetail>
        <ItemCode>sample string 1</ItemCode>
        <AdjustmentType>None</AdjustmentType>
        <AdjustmentAmount>2</AdjustmentAmount>
        <Code>sample string 3</Code>
        <Description>sample string 4</Description>
      </ShippingChargeDetail>
      <ShippingChargeDetail>
        <ItemCode>sample string 1</ItemCode>
        <AdjustmentType>None</AdjustmentType>
        <AdjustmentAmount>2</AdjustmentAmount>
        <Code>sample string 3</Code>
        <Description>sample string 4</Description>
      </ShippingChargeDetail>
    </PackagingCharges>
    <HandlingCharges>
      <ShippingChargeDetail>
        <ItemCode>sample string 1</ItemCode>
        <AdjustmentType>None</AdjustmentType>
        <AdjustmentAmount>2</AdjustmentAmount>
        <Code>sample string 3</Code>
        <Description>sample string 4</Description>
      </ShippingChargeDetail>
      <ShippingChargeDetail>
        <ItemCode>sample string 1</ItemCode>
        <AdjustmentType>None</AdjustmentType>
        <AdjustmentAmount>2</AdjustmentAmount>
        <Code>sample string 3</Code>
        <Description>sample string 4</Description>
      </ShippingChargeDetail>
    </HandlingCharges>
    <ShippingAccounts>
      <ThirdPartyShippingAccount>
        <ShippingMethod>Ups</ShippingMethod>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
      </ThirdPartyShippingAccount>
      <ThirdPartyShippingAccount>
        <ShippingMethod>Ups</ShippingMethod>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
      </ThirdPartyShippingAccount>
    </ShippingAccounts>
    <ShippingMethods>
      <ShippingMethod>Ups</ShippingMethod>
      <ShippingMethod>Ups</ShippingMethod>
    </ShippingMethods>
  </ShippingProfile>
  <DefaultShippingProfileId>1</DefaultShippingProfileId>
  <ShipItShippingProfileId>1</ShipItShippingProfileId>
  <ShippingProfileDetails>
    <ShippingProfile>
      <ProfileId>1</ProfileId>
      <ProfileName>sample string 2</ProfileName>
      <PackagingCharges>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
      </PackagingCharges>
      <HandlingCharges>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
      </HandlingCharges>
      <ShippingAccounts>
        <ThirdPartyShippingAccount>
          <ShippingMethod>Ups</ShippingMethod>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
        </ThirdPartyShippingAccount>
        <ThirdPartyShippingAccount>
          <ShippingMethod>Ups</ShippingMethod>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
        </ThirdPartyShippingAccount>
      </ShippingAccounts>
      <ShippingMethods>
        <ShippingMethod>Ups</ShippingMethod>
        <ShippingMethod>Ups</ShippingMethod>
      </ShippingMethods>
    </ShippingProfile>
    <ShippingProfile>
      <ProfileId>1</ProfileId>
      <ProfileName>sample string 2</ProfileName>
      <PackagingCharges>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
      </PackagingCharges>
      <HandlingCharges>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
        <ShippingChargeDetail>
          <ItemCode>sample string 1</ItemCode>
          <AdjustmentType>None</AdjustmentType>
          <AdjustmentAmount>2</AdjustmentAmount>
          <Code>sample string 3</Code>
          <Description>sample string 4</Description>
        </ShippingChargeDetail>
      </HandlingCharges>
      <ShippingAccounts>
        <ThirdPartyShippingAccount>
          <ShippingMethod>Ups</ShippingMethod>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
        </ThirdPartyShippingAccount>
        <ThirdPartyShippingAccount>
          <ShippingMethod>Ups</ShippingMethod>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
        </ThirdPartyShippingAccount>
      </ShippingAccounts>
      <ShippingMethods>
        <ShippingMethod>Ups</ShippingMethod>
        <ShippingMethod>Ups</ShippingMethod>
      </ShippingMethods>
    </ShippingProfile>
  </ShippingProfileDetails>
  <RequiresPoNo>true</RequiresPoNo>
  <RequiresProject>true</RequiresProject>
  <UseProjectList>true</UseProjectList>
</CustomerDetailedInformation>