POST salesorder/create?customerNumber={customerNumber}

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

Your Customer Number

string

None.

Body Parameters

Purchase Order Request

PO
NameDescriptionTypeAdditional information
CustomerNumber

Your ScanSource customer number

string

Max length: 10

BusinessUnit

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

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

date

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

ShipComplete

Flag indicating all items need to be in the same shipment

boolean

None.

ShipMethodServiceLevelCode

Specifies shipping method for order
NOTE: List of shipping options with freight amounts can be obtained using the GetShipQuote method

string

Required

ShippingAccountNumber

If third party shipping option is specified, include your carrier account number to be charged freight

string

None.

ShippingAddress

Ship address for order

Address

Required

ShippingInfo

Shipping details

POShippingInfo

None.

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.

SalesOffice

Sales Office

string

None.

SalesGroup

Sales Group

string

None.

SalesDist

Sales Dist

string

None.

Deal1

For deal specific SPAs, specify up to 3 deal IDs

string

None.

ConfigType

Indicates if this order is for custom config and the type of configuration basic / enhanced 0 - None 1 - Basic 2 - Enhanced

ConfigType

None.

ConfigID

If a configuration has already been created specify the ID

string

None.

ConfigDeviceType

Custom Config Device Type

string

None.

ConfigURL

Custom Configuration URL

string

None.

ConfigURLType

Custom Config URL type
0 - FTP
1 - FTPS
2 - HTTP
3 - HTTPS
4 - TFTP

ConfigURLType

None.

ConfigUserName

Custom Config - If authentication is needed specify the user name

string

None.

ConfigPassword

Custom Config - If authentication is needed specify the password

string

None.

Lines

Specifies the line item details for the request

Collection of POLine

Required

Answers

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

Collection of VRDAnswer

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerNumber": "sample string 1",
  "BusinessUnit": 2,
  "ReferenceNumber": "sample string 3",
  "PONumber": "sample string 4",
  "EndUserPO": "sample string 5",
  "ManufacturerDropShip": true,
  "RequestedDeliveryDate": "2021-05-13T17:17:23.8738288-04:00",
  "EnteredByEmailAddress": "sample string 7",
  "Memo": "sample string 8",
  "ShipComplete": true,
  "ShipMethodServiceLevelCode": "sample string 10",
  "ShippingAccountNumber": "sample string 11",
  "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"
  },
  "ShippingInfo": {
    "ServiceLevelDescription": "sample string 1",
    "DeliveryPhoneNumber": "sample string 2",
    "PackingListNotes": "sample string 3",
    "CarrierInfo": {
      "Name": "sample string 1",
      "Phone": "sample string 2"
    }
  },
  "PayerId": "sample string 12",
  "SalesOffice": "sample string 14",
  "SalesGroup": "sample string 15",
  "SalesDist": "sample string 16",
  "Deal1": "sample string 17",
  "ConfigType": 0,
  "ConfigID": "sample string 18",
  "ConfigDeviceType": "sample string 19",
  "ConfigURL": "sample string 20",
  "ConfigURLType": 0,
  "ConfigUserName": "sample string 21",
  "ConfigPassword": "sample string 22",
  "Lines": [
    {
      "POLineNumber": 1,
      "ReferenceLineNumber": 1,
      "ItemNumber": "sample string 1",
      "PartNumberType": 0,
      "Quantity": 2,
      "Price": 1.0,
      "CustomerPartReference": "sample string 3",
      "Memo": "sample string 4",
      "PackingListNotes": "sample string 5",
      "NumberLicenses": 1,
      "DealIDs": [
        "sample string 1",
        "sample string 2"
      ],
      "ContractStartDate": "2021-05-13T17:17:23.8738288-04:00",
      "ContractEndDate": "2021-05-13T17:17:23.8738288-04:00",
      "ConfigID": "sample string 6",
      "ConfigDeviceType": "sample string 7",
      "ConfigURL": "sample string 8",
      "ConfigURLType": 0,
      "ConfigUserName": "sample string 9",
      "ConfigPassword": "sample string 10",
      "ItemData": [
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2"
        },
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2"
        }
      ],
      "ConfigLabelData": [
        {
          "Sequence": 1,
          "Key": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Sequence": 1,
          "Key": "sample string 2",
          "Value": "sample string 3"
        }
      ]
    },
    {
      "POLineNumber": 1,
      "ReferenceLineNumber": 1,
      "ItemNumber": "sample string 1",
      "PartNumberType": 0,
      "Quantity": 2,
      "Price": 1.0,
      "CustomerPartReference": "sample string 3",
      "Memo": "sample string 4",
      "PackingListNotes": "sample string 5",
      "NumberLicenses": 1,
      "DealIDs": [
        "sample string 1",
        "sample string 2"
      ],
      "ContractStartDate": "2021-05-13T17:17:23.8738288-04:00",
      "ContractEndDate": "2021-05-13T17:17:23.8738288-04:00",
      "ConfigID": "sample string 6",
      "ConfigDeviceType": "sample string 7",
      "ConfigURL": "sample string 8",
      "ConfigURLType": 0,
      "ConfigUserName": "sample string 9",
      "ConfigPassword": "sample string 10",
      "ItemData": [
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2"
        },
        {
          "HardwareModelSKU": "sample string 1",
          "SerialNumber": "sample string 2"
        }
      ],
      "ConfigLabelData": [
        {
          "Sequence": 1,
          "Key": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Sequence": 1,
          "Key": "sample string 2",
          "Value": "sample string 3"
        }
      ]
    }
  ],
  "Answers": [
    {
      "ID": "sample string 1",
      "Answer": "sample string 2"
    },
    {
      "ID": "sample string 1",
      "Answer": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<PO xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerNumber>sample string 1</CustomerNumber>
  <BusinessUnit>2</BusinessUnit>
  <ReferenceNumber>sample string 3</ReferenceNumber>
  <PONumber>sample string 4</PONumber>
  <EndUserPO>sample string 5</EndUserPO>
  <ManufacturerDropShip>true</ManufacturerDropShip>
  <RequestedDeliveryDate>2021-05-13T17:17:23.8738288-04:00</RequestedDeliveryDate>
  <EnteredByEmailAddress>sample string 7</EnteredByEmailAddress>
  <Memo>sample string 8</Memo>
  <ShipComplete>true</ShipComplete>
  <ShipMethodServiceLevelCode>sample string 10</ShipMethodServiceLevelCode>
  <ShippingAccountNumber>sample string 11</ShippingAccountNumber>
  <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>
  <ShippingInfo>
    <ServiceLevelDescription>sample string 1</ServiceLevelDescription>
    <DeliveryPhoneNumber>sample string 2</DeliveryPhoneNumber>
    <PackingListNotes>sample string 3</PackingListNotes>
    <CarrierInfo>
      <Name>sample string 1</Name>
      <Phone>sample string 2</Phone>
    </CarrierInfo>
  </ShippingInfo>
  <PayerId>sample string 12</PayerId>
  <SalesOffice>sample string 14</SalesOffice>
  <SalesGroup>sample string 15</SalesGroup>
  <SalesDist>sample string 16</SalesDist>
  <Deal1>sample string 17</Deal1>
  <ConfigType>None</ConfigType>
  <ConfigID>sample string 18</ConfigID>
  <ConfigDeviceType>sample string 19</ConfigDeviceType>
  <ConfigURL>sample string 20</ConfigURL>
  <ConfigURLType>FTP</ConfigURLType>
  <ConfigUserName>sample string 21</ConfigUserName>
  <ConfigPassword>sample string 22</ConfigPassword>
  <Lines>
    <POLine>
      <POLineNumber>1</POLineNumber>
      <ReferenceLineNumber>1</ReferenceLineNumber>
      <ItemNumber>sample string 1</ItemNumber>
      <PartNumberType>Unknown</PartNumberType>
      <Quantity>2</Quantity>
      <Price>1</Price>
      <CustomerPartReference>sample string 3</CustomerPartReference>
      <Memo>sample string 4</Memo>
      <PackingListNotes>sample string 5</PackingListNotes>
      <NumberLicenses>1</NumberLicenses>
      <DealIDs>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </DealIDs>
      <ContractStartDate>2021-05-13T17:17:23.8738288-04:00</ContractStartDate>
      <ContractEndDate>2021-05-13T17:17:23.8738288-04:00</ContractEndDate>
      <ConfigID>sample string 6</ConfigID>
      <ConfigDeviceType>sample string 7</ConfigDeviceType>
      <ConfigURL>sample string 8</ConfigURL>
      <ConfigURLType>FTP</ConfigURLType>
      <ConfigUserName>sample string 9</ConfigUserName>
      <ConfigPassword>sample string 10</ConfigPassword>
      <ItemData>
        <ItemData>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
        </ItemData>
        <ItemData>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
        </ItemData>
      </ItemData>
      <ConfigLabelData>
        <ConfigLabelData>
          <Sequence>1</Sequence>
          <Key>sample string 2</Key>
          <Value>sample string 3</Value>
        </ConfigLabelData>
        <ConfigLabelData>
          <Sequence>1</Sequence>
          <Key>sample string 2</Key>
          <Value>sample string 3</Value>
        </ConfigLabelData>
      </ConfigLabelData>
    </POLine>
    <POLine>
      <POLineNumber>1</POLineNumber>
      <ReferenceLineNumber>1</ReferenceLineNumber>
      <ItemNumber>sample string 1</ItemNumber>
      <PartNumberType>Unknown</PartNumberType>
      <Quantity>2</Quantity>
      <Price>1</Price>
      <CustomerPartReference>sample string 3</CustomerPartReference>
      <Memo>sample string 4</Memo>
      <PackingListNotes>sample string 5</PackingListNotes>
      <NumberLicenses>1</NumberLicenses>
      <DealIDs>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </DealIDs>
      <ContractStartDate>2021-05-13T17:17:23.8738288-04:00</ContractStartDate>
      <ContractEndDate>2021-05-13T17:17:23.8738288-04:00</ContractEndDate>
      <ConfigID>sample string 6</ConfigID>
      <ConfigDeviceType>sample string 7</ConfigDeviceType>
      <ConfigURL>sample string 8</ConfigURL>
      <ConfigURLType>FTP</ConfigURLType>
      <ConfigUserName>sample string 9</ConfigUserName>
      <ConfigPassword>sample string 10</ConfigPassword>
      <ItemData>
        <ItemData>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
        </ItemData>
        <ItemData>
          <HardwareModelSKU>sample string 1</HardwareModelSKU>
          <SerialNumber>sample string 2</SerialNumber>
        </ItemData>
      </ItemData>
      <ConfigLabelData>
        <ConfigLabelData>
          <Sequence>1</Sequence>
          <Key>sample string 2</Key>
          <Value>sample string 3</Value>
        </ConfigLabelData>
        <ConfigLabelData>
          <Sequence>1</Sequence>
          <Key>sample string 2</Key>
          <Value>sample string 3</Value>
        </ConfigLabelData>
      </ConfigLabelData>
    </POLine>
  </Lines>
  <Answers>
    <Answer>
      <ID>sample string 1</ID>
      <Answer>sample string 2</Answer>
    </Answer>
    <Answer>
      <ID>sample string 1</ID>
      <Answer>sample string 2</Answer>
    </Answer>
  </Answers>
</PO>

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 'PO'.

Response Information

Resource Description

CreateOrderResponse

CreateOrderResponse
NameDescriptionTypeAdditional information
OrderNumber

ScanSource sales order number

string

None.

OrderCreated

Flag indicating if order was created, if false see Error Description

boolean

None.

ErrorMessage

If there was an error during the order creation process this field will contain a verbal description

string

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderNumber": "sample string 1",
  "OrderCreated": true,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:
<CreateOrderResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderNumber>sample string 1</OrderNumber>
  <OrderCreated>true</OrderCreated>
  <ErrorMessage>sample string 3</ErrorMessage>
</CreateOrderResponse>