POST salesorder/shipquote?customerNumber={customerNumber}

ShipQuote allows customers to get a list of available shipping options with freight amounts given a shipping address and list of items

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

Your Customer Number

string

None.

Body Parameters

ShipQuoteRequest

ShipQuoteRequest
NameDescriptionTypeAdditional information
CustomerNumber

Your customer number

string

None.

BusinessUnit

Specifies the ScanSource business unit you will be purchasing from
1712 – ScanSource POS / Barcode
1713 – ScanSource Catalyst
1714 – ScanSource Communications
1715 – ScanSource Security
1718 – ScanSource Networking
2512 – ScanSource EU POS / Barcode
2514 – ScanSource EU Communications
1154 - ScanSource Imago UK
1224 - ScanSource Imago FR
1234 - ScanSource Video Corp FR
1782 - ScanSource LA POS / Barcode
1784 - ScanSource LA Communications
5512 - ScanSource MX POS / Barcode
5514 - ScanSource MX Communications

string

Required

ShipToPostalCode

Shipping Address Postal Code

string

None.

ShipToStateProvinceCode

State / Province code Valid 2 character State or Province code. See ISO-3166

string

None.

ShipToCountryCode

Country Code Standard ISO-3166 2-Character country code

string

Required

Lines

List of lines that specify the item and quantity to be purchased

Collection of ShipQuoteRequestLine

Required

Request Formats

application/json, text/json

Sample:
{
  "CustomerNumber": "sample string 1",
  "BusinessUnit": "sample string 2",
  "ShipToPostalCode": "sample string 3",
  "ShipToStateProvinceCode": "sample string 4",
  "ShipToCountryCode": "sample string 5",
  "Lines": [
    {
      "ItemNumber": "sample string 1",
      "Quantity": 2
    },
    {
      "ItemNumber": "sample string 1",
      "Quantity": 2
    }
  ]
}

application/xml, text/xml

Sample:
<ShipQuoteRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerNumber>sample string 1</CustomerNumber>
  <BusinessUnit>sample string 2</BusinessUnit>
  <ShipToPostalCode>sample string 3</ShipToPostalCode>
  <ShipToStateProvinceCode>sample string 4</ShipToStateProvinceCode>
  <ShipToCountryCode>sample string 5</ShipToCountryCode>
  <Lines>
    <ShipQuoteRequestLine>
      <ItemNumber>sample string 1</ItemNumber>
      <Quantity>2</Quantity>
    </ShipQuoteRequestLine>
    <ShipQuoteRequestLine>
      <ItemNumber>sample string 1</ItemNumber>
      <Quantity>2</Quantity>
    </ShipQuoteRequestLine>
  </Lines>
</ShipQuoteRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ShipQuoteRequest'.

Response Information

Resource Description

Ship Quote Response

ShipQuoteResponse
NameDescriptionTypeAdditional information
Items

List of available shipping options with freight amounts

Collection of ShipQuoteResponseItem

None.

ThirdPartyItems

List of available third party shipping options

Collection of ShipQuoteResponseItem

None.

Insurance

Insurance amount

decimal number

None.

CurrencyCode

Currency code for Insurance and Freight amounts. USD – US Dollars, CAD- Canadian Dollars, EUR- Euro, GBP- British Pound

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "ServiceLevelCode": "sample string 1",
      "ServiceLevelDescription": "sample string 2",
      "FreightAmount": 3.0
    },
    {
      "ServiceLevelCode": "sample string 1",
      "ServiceLevelDescription": "sample string 2",
      "FreightAmount": 3.0
    }
  ],
  "ThirdPartyItems": [
    {
      "ServiceLevelCode": "sample string 1",
      "ServiceLevelDescription": "sample string 2",
      "FreightAmount": 3.0
    },
    {
      "ServiceLevelCode": "sample string 1",
      "ServiceLevelDescription": "sample string 2",
      "FreightAmount": 3.0
    }
  ],
  "Insurance": 1.0,
  "CurrencyCode": "sample string 2"
}

application/xml, text/xml

Sample:
<ShipQuoteResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <ShipQuoteResponseItem>
      <ServiceLevelCode>sample string 1</ServiceLevelCode>
      <ServiceLevelDescription>sample string 2</ServiceLevelDescription>
      <FreightAmount>3</FreightAmount>
    </ShipQuoteResponseItem>
    <ShipQuoteResponseItem>
      <ServiceLevelCode>sample string 1</ServiceLevelCode>
      <ServiceLevelDescription>sample string 2</ServiceLevelDescription>
      <FreightAmount>3</FreightAmount>
    </ShipQuoteResponseItem>
  </Items>
  <ThirdPartyItems>
    <ShipQuoteResponseItem>
      <ServiceLevelCode>sample string 1</ServiceLevelCode>
      <ServiceLevelDescription>sample string 2</ServiceLevelDescription>
      <FreightAmount>3</FreightAmount>
    </ShipQuoteResponseItem>
    <ShipQuoteResponseItem>
      <ServiceLevelCode>sample string 1</ServiceLevelCode>
      <ServiceLevelDescription>sample string 2</ServiceLevelDescription>
      <FreightAmount>3</FreightAmount>
    </ShipQuoteResponseItem>
  </ThirdPartyItems>
  <Insurance>1</Insurance>
  <CurrencyCode>sample string 2</CurrencyCode>
</ShipQuoteResponse>