Get Barcodes
post
/config/sim/v2/menuItems/getBarcodes
Gets a list of all the Barcodes for the specified hierarchy
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : BarCodesGetRequestBodyv2
Type:
Show Source
object-
hierUnitId(required):
integer
Hierarchy location of the barcodes being fetchedExample:
1012 -
include:
string
Example:
locations -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Barcodes for the Hierarchy
Root Schema : BarCodeGetResponse
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Bracode objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Bracode objects of the organization.
Show Source
-
Array of:
object BarCodeResourceObject
Model for Barcode object
Nested Schema : BarCodeResourceObject
Type:
objectModel for Barcode object
Show Source
-
alternatePrepCost:
number
Prep cost used when ordering with barcodeExample:
0.18 -
alternatePrice:
number
Price used when ordering with barcodeExample:
5.16 -
barcode:
integer
Barcode valueExample:
1 -
defSequenceNum:
integer
Definition sequence number this barcode applies to. If null, all definitions applyExample:
5 -
hierUnitId:
integer
Hierarchy location where the barcode is being addedExample:
1012 -
leadNumZeros:
number
Leading ZeroesExample:
2 -
masterObjNum:
integer
Master object numberExample:
501 -
objectNum:
integer
Barcode record object numberExample:
101 -
priceSequenceNum:
integer
Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions.Example:
3
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found