Jump to

• Request
• Response

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

Body ()

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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Barcodes for the Hierarchy

Body ()

Root Schema : BarCodeGetResponse

Type: object

Model for Barcode object

Show Source

• alternatePrepCost(required): number
  Prep cost used when ordering with barcode

  Example: 0.18
• alternatePrice(required): number
  Price used when ordering with barcode

  Example: 5.16
• barcode(required): integer
  Barcode value

  Example: 1
• defSequenceNum(required): integer
  Definition sequence number this barcode applies to. If null, all definitions apply

  Example: 5
• hierUnitId(required): integer
  Hierarchy location where the barcode is being added

  Example: 1012
• leadNumZeros(required): number
  Leading Zeroes

  Example: 2
• masterObjNum(required): integer
  Master object number

  Example: 501
• objectNum(required): integer
  Barcode record object number

  Example: 101
• priceSequenceNum(required): integer
  Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions.

  Example: 3

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "barcode",
        "masterObjNum",
        "defSequenceNum",
        "priceSequenceNum",
        "alternatePrice",
        "alternatePrepCost",
        "leadNumZeros"
    ],
    "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"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top