@itentialopensource/adapter-scansource
Version:
This adapter integrates with system described as: apis.
1,812 lines (1,782 loc) • 214 kB
YAML
openapi: 3.0.0
info:
title: APIs
contact: {}
version: 'v1-2'
servers:
- url: https://webapitest.scansource.com
variables: {}
paths:
/address/{collectionKey}/{addressId}:
get:
tags:
- Address
summary: Address_GetAddress
description: Returns address for a given address Id
operationId: Address_GetAddress
parameters:
- name: collectionKey
in: path
description: Address Collection key
required: true
style: simple
schema:
type: string
- name: addressId
in: path
description: Optional Address id
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddressResponseModel'
- description: Extend Address model adding id, created/updated datetime stamp
deprecated: false
delete:
tags:
- Address
summary: Address_Delete
description: Delete Address
operationId: Address_Delete
parameters:
- name: collectionKey
in: path
description: collection Key
required: true
style: simple
schema:
type: string
- name: addressId
in: path
description: Id of address to delete
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/address/exists/{collectionKey}:
get:
tags:
- Address
summary: Address_Exists
description: Determines if collection exists and contains addresses
operationId: Address_Exists
parameters:
- name: collectionKey
in: path
description: Address collection key
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: boolean
description: OK
deprecated: false
/address/{collectionKey}:
put:
tags:
- Address
summary: Address_UpdateAddress
description: Update address in collection
operationId: Address_UpdateAddress
parameters:
- name: collectionKey
in: path
description: Address collection key
required: true
style: simple
schema:
type: string
requestBody:
description: Address model
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddressUpdateModel'
- description: Address model
required: true
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
post:
tags:
- Address
summary: Address_AddAddress
description: >-
Create new address in collection
Creates new collection if one does not exist
operationId: Address_AddAddress
parameters:
- name: collectionKey
in: path
description: Address collection key
required: true
style: simple
schema:
type: string
requestBody:
description: Address model
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddressModel'
- description: Address model
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: integer
description: OK
format: int32
deprecated: false
/address/copy/{collectionKey}/{AddressId}:
post:
tags:
- Address
summary: Address_CopyAddress
description: Copy existing address to new address
operationId: Address_CopyAddress
parameters:
- name: collectionKey
in: path
description: Address collection key
required: true
style: simple
schema:
type: string
- name: AddressId
in: path
description: Id of Address to copy
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: integer
description: OK
format: int32
deprecated: false
/address/clear/{collectionKey}:
delete:
tags:
- Address
summary: Address_Clear
description: Delete all addresses in collection
operationId: Address_Clear
parameters:
- name: collectionKey
in: path
description: Region
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/address/move/{sourceCollectionKey}/{destinationCollectionKey}/{addressId}:
post:
tags:
- Address
summary: Address_MoveAddress
description: Moves an address from one collection to another.
operationId: Address_MoveAddress
parameters:
- name: sourceCollectionKey
in: path
description: Source collection to move from
required: true
style: simple
schema:
type: string
- name: destinationCollectionKey
in: path
description: Destination collection
required: true
style: simple
schema:
type: string
- name: addressId
in: path
description: Address Id to move
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/address/search/{collectionKey}:
get:
tags:
- Address
summary: Address_Search
description: Search for addresses in collection
operationId: Address_Search
parameters:
- name: collectionKey
in: path
description: Address collection key
required: true
style: simple
schema:
type: string
- name: page
in: query
description: Page number
style: form
explode: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: Number of results per page
style: form
explode: true
schema:
type: integer
format: int32
- name: name
in: query
description: Optional search by address name
style: form
explode: true
schema:
type: string
- name: stateProvince
in: query
description: Optional search by state/province
style: form
explode: true
schema:
type: string
- name: postalCode
in: query
description: Optional search by postal code
style: form
explode: true
schema:
type: string
- name: countryCode
in: query
description: Optional search by country code
style: form
explode: true
schema:
type: string
- name: searchText
in: query
description: Full text search against all address fields - overrides other search parameters
style: form
explode: true
schema:
type: string
- name: useAndOperator
in: query
description: ''
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddressResponseModel'
description: OK
deprecated: false
/address/countries/{region}:
get:
tags:
- Address
summary: Address_GetAddressCountries
description: Get Countries codes and validation pattern for a given region
operationId: Address_GetAddressCountries
parameters:
- name: region
in: path
description: Specifies Region (North America - 0, Europe - 1, Latin America - 2)
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/region2'
- description: Specifies Region (North America - 0, Europe - 1, Latin America - 2)
example: 0
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddressCountry'
description: OK
deprecated: false
/address/provinces/{countryCode}:
get:
tags:
- Address
summary: Address_GetAddressProvinceStates
description: Get provinces / state codes for given countryCode
operationId: Address_GetAddressProvinceStates
parameters:
- name: countryCode
in: path
description: Standard ISO-3166 2-Character country code
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AddressProvinceState'
description: OK
deprecated: false
/address/validate:
post:
tags:
- Address
summary: Address_Validate
description: Validate address
operationId: Address_Validate
parameters: []
requestBody:
description: Address model
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddressValidationModel'
- description: Address model
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AddressValidationResponse'
deprecated: false
/cart/{cartCollectionKey}:
get:
tags:
- Cart
summary: Cart_GetCart
description: >-
Returns current cart for the given cartCollectionKey
optional id returns cart specified in cart collection
operationId: Cart_GetCart
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: cartId
in: query
description: Optional cart id
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CartResponse'
deprecated: false
put:
tags:
- Cart
summary: Cart_UpdateCart
description: Update cart in cart collection
operationId: Cart_UpdateCart
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: updateCartItems
in: query
description: ''
style: form
explode: true
schema:
type: boolean
requestBody:
description: Cart model
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CartUpdateModel'
- description: Cart model
required: true
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
post:
tags:
- Cart
summary: Cart_AddCart
description: >-
Create new cart in cart collection, optionally set as current cart
Creates new cart collection if one does not exist
operationId: Cart_AddCart
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: currentCart
in: query
description: Flag indicating if new cart should become current cart for collection
style: form
explode: true
schema:
type: boolean
requestBody:
description: Cart model
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CartModel'
- description: Cart model
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: integer
description: OK
format: int32
deprecated: false
delete:
tags:
- Cart
summary: Cart_Delete
description: Delete current cart or specific cart
operationId: Cart_Delete
parameters:
- name: cartCollectionKey
in: path
description: Collection Key
required: true
style: simple
schema:
type: string
- name: cartId
in: query
description: Optional Cart ID
style: form
explode: true
schema:
type: integer
format: int32
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/cart/exists/{cartCollectionKey}:
get:
tags:
- Cart
summary: Cart_Exists
description: Determines if cart collection exists and contains carts
operationId: Cart_Exists
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: boolean
description: OK
deprecated: false
/cart/copy/{cartCollectionKey}/{cartId}:
post:
tags:
- Cart
summary: Cart_CopyCart
description: "Copy existing cart to new cart \r\nOptionally set new cart as current cart"
operationId: Cart_CopyCart
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: cartId
in: path
description: Id of cart to copy
required: true
style: simple
schema:
type: integer
format: int32
- name: currentCart
in: query
description: Flag indicating if new cart should become current cart for collection
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: integer
description: OK
format: int32
deprecated: false
/cart/list/{cartCollectionKey}:
get:
tags:
- Cart
summary: Cart_GetCartList
description: >-
Returns an array of carts contained by the collection matching the received "cartCollectionKey".
This method can be used for client applications to display a list of carts for the user to select
as their current cart for systems which allow multiple carts per user.
operationId: Cart_GetCartList
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: name
in: query
description: Optional filter by name of cart
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CartListResponse'
deprecated: false
/cart/item/{cartCollectionKey}:
post:
tags:
- Cart
summary: Cart_AddItem
description: Add cart item to current cart or specified cartId
operationId: Cart_AddItem
parameters:
- name: cartCollectionKey
in: path
description: Collection Key
required: true
style: simple
schema:
type: string
- name: cartId
in: query
description: Optional cart id
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: cart item
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CartItemModel'
- description: cart item
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: integer
description: OK
format: int32
deprecated: false
/cart/item/{cartCollectionKey}/{cartId}:
put:
tags:
- Cart
summary: Cart_UpdateItem
description: Update cart item
operationId: Cart_UpdateItem
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: cartId
in: path
description: Cart ID
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: Cart item
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CartItemUpdateModel'
- description: Cart item
required: true
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/cart/item/{cartCollectionKey}/{itemId}:
delete:
tags:
- Cart
summary: Cart_DeleteItem
description: Delete current cart item or specific cart item
operationId: Cart_DeleteItem
parameters:
- name: cartCollectionKey
in: path
description: Cart Collection Key
required: true
style: simple
schema:
type: string
- name: itemId
in: path
description: Item Id
required: true
style: simple
schema:
type: integer
format: int32
- name: cartId
in: query
description: Optional cart id
style: form
explode: true
schema:
type: integer
format: int32
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/cart/clear/{cartCollectionKey}:
delete:
tags:
- Cart
summary: Cart_Clear
description: Delete all carts in cart collection
operationId: Cart_Clear
parameters:
- name: cartCollectionKey
in: path
description: Collection Key
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/cart/hascurrent/{cartCollectionKey}:
get:
tags:
- Cart
summary: Cart_HasCurrent
description: Indicates if cart collection has current cart
operationId: Cart_HasCurrent
parameters:
- name: cartCollectionKey
in: path
description: Collection Key
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: boolean
description: OK
deprecated: false
/cart/switch/{cartCollectionKey}/{cartId}:
put:
tags:
- Cart
summary: Cart_SwitchCurrentCart
description: >-
For client applications which allow multiple carts per user, provides a way to switch what is
considered the user's current cart to the cart matching the given cartID.
operationId: Cart_SwitchCurrentCart
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: cartId
in: path
description: Id of cart to make current cart
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/cart/move/{sourceCollectionKey}/{destinationCollectionKey}/{cartId}:
post:
tags:
- Cart
summary: Cart_MoveCart
description: >-
Moves a cart from one collection to another. This could be used by a caller for many
purposes such as providing a way to move a cart from one user to another, or to
provide the server-side implementation of an approval queue by creating a collectionKey
for the queue, and moving the cart to the queue collection upon submission.
operationId: Cart_MoveCart
parameters:
- name: sourceCollectionKey
in: path
description: Source collection to move from
required: true
style: simple
schema:
type: string
- name: destinationCollectionKey
in: path
description: Destination collection
required: true
style: simple
schema:
type: string
- name: cartId
in: path
description: Cart Id
required: true
style: simple
schema:
type: integer
format: int32
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/cart/checkoutinfo/{cartCollectionKey}:
get:
tags:
- Cart
summary: Cart_GetCheckoutInfo
description: Get checkout info from current cart or specified cart by cartId
operationId: Cart_GetCheckoutInfo
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: cartId
in: query
description: Optional cart id
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CartCheckoutInfoModel'
deprecated: false
post:
tags:
- Cart
summary: Cart_SaveCheckoutInfo
description: Add or update checkout info to current cart or cart specified by cartId
operationId: Cart_SaveCheckoutInfo
parameters:
- name: cartCollectionKey
in: path
description: Cart collection key
required: true
style: simple
schema:
type: string
- name: cartId
in: query
description: Optional cart id
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: Checkout state
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CartCheckoutInfoModel'
- description: Checkout state
required: true
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
/ciscodart/summary:
get:
tags:
- CiscoDart
summary: CiscoDart_GetSummary
description: Cisco Dart summary
operationId: CiscoDart_GetSummary
parameters:
- name: customerNumber
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CiscoDart'
description: OK
deprecated: false
/ciscodart/detail:
get:
tags:
- CiscoDart
summary: CiscoDart_GetDetail
description: Cisco Dart detail
operationId: CiscoDart_GetDetail
parameters:
- name: dealId
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CiscoDartDetail'
- description: Response returned from ciscodart/detail
deprecated: false
/customconfig/list:
get:
tags:
- CustomConfig
summary: CustomConfig_GetCustomConfigs
description: Get list of custom configurations
operationId: CustomConfig_GetCustomConfigs
parameters:
- name: customerNumber
in: query
description: Your customer number
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomConfig'
description: OK
deprecated: false
/customer/creditdata/{customerNumber}/{region}:
get:
tags:
- Customer
summary: Customer_GetCustCreditData
description: Returns customer status, revenue, credit limit, for a given customer
operationId: Customer_GetCustCreditData
parameters:
- name: customerNumber
in: path
description: Customer Number
required: true
style: simple
schema:
type: string
- name: region
in: path
description: Region
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustCreditDataResponse'
description: OK
deprecated: false
/customer/payers/{customerNumber}/{businessUnit}:
get:
tags:
- Customer
summary: Customer_GetPayers
description: Returns list of payers for a given customer
operationId: Customer_GetPayers
parameters:
- name: customerNumber
in: path
description: Your Customer Number
required: true
style: simple
schema:
type: string
- name: businessUnit
in: path
description: >-
Specify business unit that you will be purchasing from
<br />
1712 – ScanSource POS / Barcode
<br />
1713 – ScanSource Catalyst
<br />
1714 – ScanSource Communications
<br />
1715 – ScanSource Security
<br />
1718 – ScanSource Networking
<br />
2512 – ScanSource EU POS / Barcode
<br />
2514 – ScanSource EU Communications
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PayerResponse'
- description: Response returned from customer payers
deprecated: false
/invoice/summary/{customerNumber}:
get:
tags:
- Invoice
summary: Invoice_GetInvoiceSummary
description: >-
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
operationId: Invoice_GetInvoiceSummary
parameters:
- name: customerNumber
in: path
description: Your Customer Number
required: true
style: simple
schema:
type: string
- name: page
in: query
description: Page Number
style: form
explode: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: Number of results per page
style: form
explode: true
schema:
type: integer
format: int32
- name: salesOrderNumber
in: query
description: Sales Order Number
style: form
explode: true
schema:
type: string
- name: invoiceNumber
in: query
description: Invoice Number
style: form
explode: true
schema:
type: string
- name: poNumber
in: query
description: Purchase Order Number
style: form
explode: true
schema:
type: string
- name: fromDate
in: query
description: Start date range
style: form
explode: true
schema:
type: string
- name: toDate
in: query
description: End date range
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InvoiceSummary'
description: OK
deprecated: false
/invoice/list/{customerNumber}:
get:
tags:
- Invoice
summary: Invoice_GetInvoiceList
description: Get Invoice List allows customers to get a paged list of invoices with details.
operationId: Invoice_GetInvoiceList
parameters:
- name: customerNumber
in: path
description: Your Customer Number
required: true
style: simple
schema:
type: string
- name: page
in: query
description: Page Number
style: form
explode: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: Number of results per page
style: form
explode: true
schema:
type: integer
format: int32
- name: salesOrderNumber
in: query
description: Sales Order Number
style: form
explode: true
schema:
type: string
- name: invoiceNumber
in: query
description: Invoice Number
style: form
explode: true
schema:
type: string
- name: poNumber
in: query
description: Purchase Order Number
style: form
explode: true
schema:
type: string
- name: fromDate
in: query
description: Start date range
style: form
explode: true
schema:
type: string
- name: toDate
in: query
description: End date range
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InvoiceList'
description: OK
deprecated: false
/invoice/detail/{customerNumber}/{invoiceNumber}:
get:
tags:
- Invoice
summary: Invoice_GetInvoiceDetail
description: Invoice Detail - returns details about an invoice including serial and tracking numbers
operationId: Invoice_GetInvoiceDetail
parameters:
- name: customerNumber
in: path
description: Your Customer Number
required: true
style: simple
schema:
type: string
- name: invoiceNumber
in: path
description: Invoice Number
required: true
style: simple
schema:
type: string
- name: excludeSerialTracking
in: query
description: 'Optional flag to exclude serial/Tracking #s in detail response'
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Invoice'
- description: Response from invoice detail
deprecated: false
/invoice/pdf/{customerNumber}/{invoiceNumber}:
get:
tags:
- Invoice
summary: Invoice_GetPDF
description: Get PDF of invoice
operationId: Invoice_GetPDF
parameters:
- name: customerNumber
in: path
description: Customer Number
required: true
style: simple
schema:
type: string
- name: invoiceNumber
in: path
description: Invoice Number
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/InvoicePDFResponse'
deprecated: false
/partnerprofile:
get:
tags:
- PartnerProfile
summary: PartnerProfile_GetPartnerProfile
description: Get partners profile
operationId: PartnerProfile_GetPartnerProfile
parameters:
- name: APIKey
in: query
description: Partners API key
style: form
explode: true
schema:
type: string
- name: developerEmail
in: query
description: Developer email address registered in APIM
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerProfile'
deprecated: false
/partnerprofile/validate:
get:
tags:
- PartnerProfile
summary: PartnerProfile_GetValidate
description: Determines if partner profile is valid for specific api / resource
operationId: PartnerProfile_GetValidate
parameters:
- name: developerEmail
in: query
description: Developer email address registered in APIM
required: true
style: form
explode: true
schema:
type: string
- name: customerNumber
in: query
description: Customer Number
required: true
style: form
explode: true
schema:
type: string
- name: url
in: query
description: Original URL from APIM
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: boolean
description: OK
deprecated: false
/product/pricing:
post:
tags:
- Product
summary: Product_Pricing
description: >-
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.
operationId: Product_Pricing
parameters: []
requestBody:
description: Pricing request including list of items
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PricingRequest'
- description: Pricing request including list of items
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Product'
description: OK
deprecated: false
/product/availability:
post:
tags:
- Product
summary: Product_Availability
description: Product availability returns quantity available given a list of warehouse numbers and item numbers
operationId: Product_Availability
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProductAvailabilityRequest'
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProductAvailabilityResponse'
deprecated: false
/product/search:
get:
tags:
- Product
summary: Product_Search
description: Product search allows for search for products by item number, manufacturer, general search text against descriptions
operationId: Product_Search
parameters:
- name: customerNumber
in: query
description: 'Your customer #'
required: true
style: form
explode: true
schema:
type: string
- name: itemNumber
in: query
description: Optional item number
style: form
explode: true
schema:
type: string
- name: partNumberType
in: query
description: Part number type Unknown = 0, ScanSource = 1, Manufacturer = 2, Material = 3
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/partNumberType3'
- description: Part number type Unknown = 0, ScanSource = 1, Manufacturer = 2, Material = 3
example: 0
- name: manufacturer
in: query
description: Optional manufacturer name
style: form
explode: true
schema:
type: string
- name: catalogName
in: query
description: Optional catalog name
style: form
explode: true
schema:
type: string
- name: categoryPath
in: query
description: Optional category path
style: form
explode: true
schema:
type: string
- name: includeObsolete
in: query
description: Flag indicating if results should include obsolete items
style: form
explode: true
schema:
type: boolean
- name: searchText
in: query
description: 'General search against item #s, descriptions'
style: form
explode: true
schema:
type: string
- name: useAndOperator
in: query
description: Flag indicating if search should use OR / AND operator
style: form
explode: true
schema:
type: boolean
- name: region
in: query
description: 0-NA, 1-EU
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/region3'
- description: 0-NA, 1-EU
example: 0
- name: page
in: query
description: 'Page #'
style: form
explode: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: Results page size - max 100
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProductSearchResultModel'
description: OK
deprecated: false
/product/detail:
get:
tags:
- Product
summary: Product_GetDetail
description: Get detail about a product
operationId: Product_GetDetail
parameters:
- name: customerNumber
in: query
description: 'Your Customer #'
required: true
style: form
explode: true
schema:
type: string
- name: itemNumber
in: query
description: Item number
required: true
style: form
explode: true
schema:
type: string
- name: partNumberType
in: query
description: Part number type Unknown = 0, ScanSource = 1, Manufacturer = 2, Material = 3
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/partNumberType3'
- description: Part number type Unknown = 0, ScanSource = 1, Manufacturer = 2, Material = 3
example: 0
- name: region
in: query
description: 0-NA, 1-EU
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/region3'
- description: 0-NA, 1-EU
example: 0
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProductDetail'
- description: Response returned from product/detail
deprecated: false
/rma:
post:
tags:
- Rma
summary: Rma_CreateRMA
description: Create RMA
operationId: Rma_CreateRMA
parameters: []
requestBody:
description: CreateRMARequest
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CreateRMARequest'
- description: CreateRMARequest
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CreateRMAResponse'
- description: Create RMA Response
deprecated: false
/salesorder/create:
post:
tags:
- SalesOrder
summary: SalesOrder_CreateOrder
description: >-
Create a new sales order in ScanSource’s ERP system.
When the order is created clients receive a response with a sales order number.
operationId: SalesOrder_CreateOrder
parameters: []
requestBody:
description: Purchase Order Request
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PO'
- description: Purchase Order Request
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CreateOrderResponse'
- description: Create Order Response
deprecated: false
/salesorder/createAsync:
post:
tags:
- SalesOrder
summary: SalesOrder_CreateOrderAsync
description: >-
Create a new sales order in ScanSource’s ERP system.
When the order is created clients receive a response with sales order number.
operationId: SalesOrder_CreateOrderAsync
parameters: []
requestBody:
description: Purchase Order Request
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/POAsync'
- description: Purchase Order Request
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
description: OK
deprecated: false
/salesorder/vrd:
post:
tags:
- SalesOrder
summary: SalesOrder_GetVRD
description: >-
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
operationId: SalesOrder_GetVRD
parameters: []
requestBody:
description: VRD Request
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VRDRequest'
- description: VRD Request
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VRDResponse'
- description: Response from salesorder/vrd
deprecated: false
/salesorder/summary/{customerNumber}:
get:
tags:
- SalesOrder
summary: SalesOrder_GetOrderSummary
description: >-
Get Order Summary allows customers to get a paged list of sales orders.
Search parameters can be