POST salesorder/createAsync?customerNumber={customerNumber}

Create a new sales order in ScanSource’s ERP system. When the order is created clients receive a response with sales order number.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

Your Customer Number

string

None.

Body Parameters

Purchase Order Request

POAsync
NameDescriptionTypeAdditional information
PayerId

Payer for this order. Used to bill against other accounts. Typically the same as customer #.
NOTE: List of Payers can be obtained using the GetPayers method

string

None.

BusinessUnit

Specifies the ScanSource business unit to place order
1700 – ScanSource NA
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

integer

Required

ReferenceNumber

Optional reference number to identifier in client system

string

None.

PONumber

Your Purchase Order Number

string

None.

EndUserPO

Your customer’s PO Number

string

None.

ManufacturerDropShip

Flag indicating this order is a manufacturer drop ship

boolean

None.

RequestedDeliveryDate

Future shipping date

string

None.

EnteredByEmailAddress

Email address for order confirmations

string

None.

Memo

Additional notes about this order.
NOTE: The memo is just an internal reference and will not be printed on external documents (e.g. packing slip)

string

Max length: 500

ShippingInfo

Shipping details

POShippingInfoAsync

None.

DealIds

For deal specific SPAs, specify up to 3 deal IDs

Collection of string

None.

ContractStartDate

string

None.

ContractEndDate

string

None.

ExtendedData

POExtendedDataAsync

None.

Lines

Specifies the line item details for the request

Collection of POLineAsync

Required

VRD

Vendor required data
NOTE: List of required vendor data at: VRD

Collection of POVRDAsync

None.

Request Formats

application/json, text/json

Sample:
{
  "PayerId": "sample string 1",
  "BusinessUnit": 2,
  "ReferenceNumber": "sample string 3",
  "PONumber": "sample string 4",
  "EndUserPO": "sample string 5",
  "ManufacturerDropShip": true,
  "RequestedDeliveryDate": "sample string 7",
  "EnteredByEmailAddress": "sample string 8",
  "Memo": "sample string 9",
  "ShippingInfo": {
    "ShipMethodServiceLevelCode": "sample string 1",
    "ShippingAccountNumber": "sample string 2",
    "ShipComplete": true,
    "DeliveryPhoneNumber": "sample string 4",
    "PackingListNotes": "sample string 5",
    "FreightForwarderNumber": "sample string 6",
    "ShippingAddress": {
      "Name": "sample string 1",
      "Attn": "sample string 2",
      "Street1": "sample string 3",
      "Street2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "PostalCode": "sample string 7",
      "Country": "sample string 8"
    },
    "CarrierInfo": {
      "CarrierAddress": {
        "Name": "sample string 1",
        "Attn": "sample string 2",
        "Street1": "sample string 3",
        "Street2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8"
      },
      "Phone": "sample string 1"
    }
  },
  "DealIds": [
    "sample string 1",
    "sample string 2"
  ],
  "ContractStartDate": "sample string 11",
  "ContractEndDate": "sample string 12",
  "ExtendedData": {
    "SalesOffice": "sample string 1",
    "SalesGroup": "sample string 2",
    "SalesDist": "sample string 3"
  },
  "Lines": [
    {
      "PartNumber": "sample string 1",
      "PartType": 0,
      "CustomerItemReference": "sample string 2",
      "MagicKey": "sample string 3",
      "POLineNumber": 1,
      "ReferenceLineNumber": 1,
      "Quantity": 4,
      "NumberLicenses": 5,
      "Price": 1.0,
      "Memo": "sample string 6",
      "PackingListNotes": "sample string 7",
      "DealIDs": [
        "sample string 1",
        "sample string 2"
      ],
      "ContractStartDate": "sample string 8",
      "ContractEndDate": "sample string 9",
      "VRD": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "ItemData": [
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2",
          "MACAddress": "sample string 3"
        },
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2",
          "MACAddress": "sample string 3"
        }
      ]
    },
    {
      "PartNumber": "sample string 1",
      "PartType": 0,
      "CustomerItemReference": "sample string 2",
      "MagicKey": "sample string 3",
      "POLineNumber": 1,
      "ReferenceLineNumber": 1,
      "Quantity": 4,
      "NumberLicenses": 5,
      "Price": 1.0,
      "Memo": "sample string 6",
      "PackingListNotes": "sample string 7",
      "DealIDs": [
        "sample string 1",
        "sample string 2"
      ],
      "ContractStartDate": "sample string 8",
      "ContractEndDate": "sample string 9",
      "VRD": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "ItemData": [
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2",
          "MACAddress": "sample string 3"
        },
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2",
          "MACAddress": "sample string 3"
        }
      ]
    }
  ],
  "VRD": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<POAsync xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PayerId>sample string 1</PayerId>
  <BusinessUnit>2</BusinessUnit>
  <ReferenceNumber>sample string 3</ReferenceNumber>
  <PONumber>sample string 4</PONumber>
  <EndUserPO>sample string 5</EndUserPO>
  <ManufacturerDropShip>true</ManufacturerDropShip>
  <RequestedDeliveryDate>sample string 7</RequestedDeliveryDate>
  <EnteredByEmailAddress>sample string 8</EnteredByEmailAddress>
  <Memo>sample string 9</Memo>
  <ShippingInfo>
    <ShipMethodServiceLevelCode>sample string 1</ShipMethodServiceLevelCode>
    <ShippingAccountNumber>sample string 2</ShippingAccountNumber>
    <ShipComplete>true</ShipComplete>
    <DeliveryPhoneNumber>sample string 4</DeliveryPhoneNumber>
    <PackingListNotes>sample string 5</PackingListNotes>
    <FreightForwarderNumber>sample string 6</FreightForwarderNumber>
    <ShippingAddress>
      <Name>sample string 1</Name>
      <Attn>sample string 2</Attn>
      <Street1>sample string 3</Street1>
      <Street2>sample string 4</Street2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <PostalCode>sample string 7</PostalCode>
      <Country>sample string 8</Country>
    </ShippingAddress>
    <CarrierInfo>
      <CarrierAddress>
        <Name>sample string 1</Name>
        <Attn>sample string 2</Attn>
        <Street1>sample string 3</Street1>
        <Street2>sample string 4</Street2>
        <City>sample string 5</City>
        <State>sample string 6</State>
        <PostalCode>sample string 7</PostalCode>
        <Country>sample string 8</Country>
      </CarrierAddress>
      <Phone>sample string 1</Phone>
    </CarrierInfo>
  </ShippingInfo>
  <DealIds>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </DealIds>
  <ContractStartDate>sample string 11</ContractStartDate>
  <ContractEndDate>sample string 12</ContractEndDate>
  <ExtendedData>
    <SalesOffice>sample string 1</SalesOffice>
    <SalesGroup>sample string 2</SalesGroup>
    <SalesDist>sample string 3</SalesDist>
  </ExtendedData>
  <Lines>
    <POLineAsync>
      <PartNumber>sample string 1</PartNumber>
      <PartType>Unknown</PartType>
      <CustomerItemReference>sample string 2</CustomerItemReference>
      <MagicKey>sample string 3</MagicKey>
      <POLineNumber>1</POLineNumber>
      <ReferenceLineNumber>1</ReferenceLineNumber>
      <Quantity>4</Quantity>
      <NumberLicenses>5</NumberLicenses>
      <Price>1</Price>
      <Memo>sample string 6</Memo>
      <PackingListNotes>sample string 7</PackingListNotes>
      <DealIDs>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </DealIDs>
      <ContractStartDate>sample string 8</ContractStartDate>
      <ContractEndDate>sample string 9</ContractEndDate>
      <VRD>
        <POVRDAsync>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </POVRDAsync>
        <POVRDAsync>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </POVRDAsync>
      </VRD>
      <ItemData>
        <ItemDataAsync>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
          <MACAddress>sample string 3</MACAddress>
        </ItemDataAsync>
        <ItemDataAsync>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
          <MACAddress>sample string 3</MACAddress>
        </ItemDataAsync>
      </ItemData>
    </POLineAsync>
    <POLineAsync>
      <PartNumber>sample string 1</PartNumber>
      <PartType>Unknown</PartType>
      <CustomerItemReference>sample string 2</CustomerItemReference>
      <MagicKey>sample string 3</MagicKey>
      <POLineNumber>1</POLineNumber>
      <ReferenceLineNumber>1</ReferenceLineNumber>
      <Quantity>4</Quantity>
      <NumberLicenses>5</NumberLicenses>
      <Price>1</Price>
      <Memo>sample string 6</Memo>
      <PackingListNotes>sample string 7</PackingListNotes>
      <DealIDs>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </DealIDs>
      <ContractStartDate>sample string 8</ContractStartDate>
      <ContractEndDate>sample string 9</ContractEndDate>
      <VRD>
        <POVRDAsync>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </POVRDAsync>
        <POVRDAsync>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </POVRDAsync>
      </VRD>
      <ItemData>
        <ItemDataAsync>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
          <MACAddress>sample string 3</MACAddress>
        </ItemDataAsync>
        <ItemDataAsync>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
          <MACAddress>sample string 3</MACAddress>
        </ItemDataAsync>
      </ItemData>
    </POLineAsync>
  </Lines>
  <VRD>
    <POVRDAsync>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </POVRDAsync>
    <POVRDAsync>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </POVRDAsync>
  </VRD>
</POAsync>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateOrderResponse

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string>sample string 1</string>