ScanSource Restful APIs Help Pages

Introduction

APIs (application program interface) give you instant access to information on inventory, order status, delivery details, and now product information. We know your customers don’t want you waiting on information, so we give you real-time access around the clock.

Product

Product API includes operations to get pricing and inventory in real time

API	Description
POST product/pricing?customerNumber={customerNumber}	Product pricing returns SPA adjusted customer pricing, MSRP, dealer authorized flag, available and on order quantities. SPA information includes flag indicating pricing is SPA adjusted, SPA description, flag indicating there is a SPA restriction, SPA restriction description. SPA restrictions can include expiration date, min/max quantities.
POST product/availability?customerNumber={customerNumber}	Product availability returns quantity available given a list of warehouse numbers and item numbers
GET product/search?customerNumber={customerNumber}&itemNumber={itemNumber}&partNumberType={partNumberType}&manufacturer={manufacturer}&catalogName={catalogName}&categoryPath={categoryPath}&includeObsolete={includeObsolete}&searchText={searchText}&useAndOperator={useAndOperator}&region={region}&page={page}&pageSize={pageSize}	Product search allows for search for products by item number, manufacturer, general search text against descriptions
GET product/detail?customerNumber={customerNumber}&itemNumber={itemNumber}&partNumberType={partNumberType}&region={region}	Get detail about a product

Invoice

Invoice API allows your application to interface with ScanSource backend ERP system in real time Includes operations to get invoice summary and detail

API	Description
GET invoice/summary/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&invoiceNumber={invoiceNumber}&poNumber={poNumber}&fromDate={fromDate}&toDate={toDate}	Get Invoice Summary allows customers to get a paged list of invoices. Search parameters can be specified to search by serial numbers and mac addresses within a given date range
GET invoice/list/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&invoiceNumber={invoiceNumber}&poNumber={poNumber}&fromDate={fromDate}&toDate={toDate}	Get Invoice List allows customers to get a paged list of invoices with details.
GET invoice/detail/{customerNumber}/{invoiceNumber}?excludeSerialTracking={excludeSerialTracking}	Invoice Detail - returns details about an invoice including serial and tracking numbers
GET invoice/pdf/{customerNumber}/{invoiceNumber}	Get PDF of invoice

SalesOrder

Sales Order API allows your application to interface with ScanSource backend ERP system in real time Includes operations to create orders, get available shipping options with freight amounts, get tracking info, get order detail and cancel orders

API	Description
POST salesorder/create?customerNumber={customerNumber}&requestor={requestor}	Create a new sales order in ScanSource’s ERP system. When the order is created clients receive a response with a sales order number.
POST salesorder/createAsync?customerNumber={customerNumber}&requestor={requestor}	Create a new sales order in ScanSource’s ERP system. When the order is created clients receive a response with sales order number.
POST salesorder/vrd?customerNumber={customerNumber}	Allows consumer to know which vendor required fields are necessary to collect before order creation fields returned should be included on the salesorder/create VRDAnswers array
GET salesorder/summary/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&poNumber={poNumber}&referenceNumber={referenceNumber}&status={status}&docType={docType}&fromDate={fromDate}&toDate={toDate}&fromLastChangeDate={fromLastChangeDate}&toLastChangeDate={toLastChangeDate}&serialNumbers={serialNumbers}&macAddresses={macAddresses}	Get Order Summary allows customers to get a paged list of sales orders. Search parameters can be specified to search by serial numbers and mac addresses within a given date range
GET salesorder/list/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&poNumber={poNumber}&endUserPO={endUserPO}&shippingCity={shippingCity}&referenceNumber={referenceNumber}&status={status}&docType={docType}&includeScheduleLines={includeScheduleLines}&fromDate={fromDate}&toDate={toDate}&fromLastChangeDate={fromLastChangeDate}&toLastChangeDate={toLastChangeDate}	Get Order List allows customers to get a paged list of sales orders with details.
POST salesorder/shipquote?customerNumber={customerNumber}&requestor={requestor}	ShipQuote allows customers to get a list of available shipping options with freight amounts given a shipping address and list of items
GET salesorder/detail/{customerNumber}/{salesOrderNumber}?excludeSerialTracking={excludeSerialTracking}	Sales Order Detail - returns details about an order including serial and tracking numbers
GET salesorder/tracking/{customerNumber}?orderNumber={orderNumber}&poNumber={poNumber}&deliveryNumber={deliveryNumber}	Sales Order tracking allows customers to get tracking numbers for a given sales order, po or delivery
DELETE salesorder/cancel?customerNumber={customerNumber}&salesOrderNumber={salesOrderNumber}&purchaseOrderNumber={purchaseOrderNumber}	Submit request to process order cancellation
GET salesorder/serials?customerNumber={customerNumber}&page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&poNumber={poNumber}&invoiceNumber={invoiceNumber}&serialNumbers={serialNumbers}&fromDate={fromDate}&toDate={toDate}	Get serial numbers in date range / search serial numbers