Configuration and Content API Guide

Get Barcodes

post

/config/sim/v1/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 : BarCodesGetRequestBody

Type: object

Show Source

hierUnitId(required): integer

Hierarchy location of the barcodes being fetched

Example: 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
languages: string

If specified, limits translated strings returned.

Example: en-US, de-DE, es-MX
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 supported

Example: 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 value

Example: where equals(active,1)

{
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy location of the barcodes being fetched"
        },
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Barcodes.

Root Schema : BarCodeGetResponse

Type: object

Show Source

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 size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Bracode objects of the organization.",
            "items":{
                "$ref":"#/definitions/BarCodeResourceObject"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Bracode objects of the organization.

Show Source

Array of: object BarCodeResourceObject

Model for Barcode object

{
    "type":"array",
    "description":"Array of Bracode objects of the organization.",
    "items":{
        "$ref":"#/definitions/BarCodeResourceObject"
    }
}

Nested Schema : BarCodeResourceObject

Type: object

Model for Barcode object

Show Source

alternatePrepCost: number

Prep cost used when ordering with barcode

Example: 0.18
alternatePrice: number

Price used when ordering with barcode

Example: 5.16
barcode: integer

Barcode value

Example: 1
defSequenceNum: integer

Definition sequence number this barcode applies to. If null, all definitions apply

Example: 5
hierUnitId: integer

Hierarchy location where the barcode is being added

Example: 1012
leadNumZeros: number

Leading Zeroes

Example: 2
masterObjNum: integer

Master object number

Example: 501
objectNum: integer

Barcode record object number

Example: 101
priceSequenceNum: integer

Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions.

Example: 3

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy location where the barcode is being added"
        },
        "objectNum":{
            "type":"integer",
            "example":101,
            "description":"Barcode record object number"
        },
        "barcode":{
            "type":"integer",
            "example":1,
            "description":"Barcode value"
        },
        "masterObjNum":{
            "type":"integer",
            "example":501,
            "description":"Master object number"
        },
        "defSequenceNum":{
            "type":"integer",
            "example":5,
            "description":"Definition sequence number this barcode applies to.  If null, all definitions apply"
        },
        "priceSequenceNum":{
            "type":"integer",
            "example":3,
            "description":"Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions."
        },
        "alternatePrice":{
            "type":"number",
            "example":5.16,
            "description":"Price used when ordering with barcode"
        },
        "alternatePrepCost":{
            "type":"number",
            "example":0.18,
            "description":"Prep cost used when ordering with barcode"
        },
        "leadNumZeros":{
            "type":"number",
            "example":2,
            "description":"Leading Zeroes"
        }
    },
    "description":"Model for Barcode object"
}