Please refer to the below for API version 1 (ie v1).
 Customers (GET)
Returns Customer data.
Collection
|
/v1/customers
|
Singleton
|
/v1/customers/XXXXXX
Where XXXXXX is the BBS customer code for a customer record
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
includeprospects
|
Include prospect accounts in response
|
Boolean (true / false)
|
false
|
includeclosed
|
Include closed accounts in response
|
Boolean (true / false)
|
false
|
search
|
Keywords to search for to filter results (case insensitive, separated by spaces)
|
String
|
No search filter is applied to results
|
Examples
Returns a list of customers, including prospective customers, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/customers?includeprospects=true
|
Returns a list of customers, including prospective customers, where both the words LIME and LEMON appear in the customer record, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/customers?includeprospects=true&search=Lime Lemon&format=detail
|
Returns the detail for customer LIM001, in the extended format.
https://abctra.users.bbserp.com.au:9001/api/v1/customers/LIM001?format=extended
|
|
Products (GET)
Returns Product data.
Collection
|
/v1/products
|
Singleton
|
/v1/products/XXXXXXXXXXXX
Where XXXXXXXXXXXX is the BBS product code, Manf Part No, SKU, APN/barcode, supplier item code, additional product code, selling unit of measure, barcode or any other product code from the product record.
NOTE: If multiple products have the same code, a HTTP error 404 Not Found will be returned.
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
includediscontinued
|
Include discontinued products in response
|
Boolean (true / false)
|
false
|
search
|
Keywords to search for to filter results (case insensitive, separated by spaces)
|
String
|
No search filter is applied to results
|
Examples
Returns a list of products, including discontinued products, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/products?includediscontinued=true
|
Returns a list of products, including discontinued products, where both the words STAINLESS and BOWL appear in the product record, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/products?includediscontinued=true&search=Stainless Bowl&format=detail
|
Returns the detail for product with a product code of FGES185, in the extended format.
https://abctra.users.bbserp.com.au:9001/api/v1/products/FGES185?format=extended
|
|
Stock Levels (GET)
Returns Stock Level data for products. Discontinued products are only returned in the data if there is stock available.
Collection
|
/v1/stocklevels
|
Singleton
|
/v1/stocklevels/XXXXXXXXXXXX
Where XXXXXXXXXXXX is the BBS product code, Manf Part No, SKU, APN/barcode, supplier item code, additional product code, selling unit of measure, barcode or any other product code on the product record.
NOTE: If multiple products have the same code, a HTTP error 404 Not Found will be returned.
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
search
|
Keywords to search for to filter results (case insensitive, separated by spaces)
|
String
|
No search filter is applied to results
|
Examples
Returns a list of stock levels for non-discontinued products, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/stocklevels
|
Returns a list of stock levels for non-discontinued products, where both the words STAINLESS and BOWL appear in the product record, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/stocklevels?Stainless Bowl&format=detail
|
Returns the stock levels for product with a product code of FGES185, in the extended format.
https://abctra.users.bbserp.com.au:9001/api/v1/stocklevels/FGES185?format=extended
|
|
|
