Jump to

• Request
• Response

Add Barcodes

post

/config/sim/v1/menuItems/barcodes

Add a Barcode

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : BarCode

Type: object

Model for Barcode object

Show Source

• alteratePrepCost(optional): number
  Prep cost used when ordering with barcode

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

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

  Example: 1
• defSequenceNum(optional): 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
• masterObjNum(optional): integer
  Master object number

  Example: 501
• objectNum: integer
  Barcode record object number

  Example: 101
• priceSequenceNum(optional): 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"
    ],
    "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"
        },
        "alteratePrepCost":{
            "type":"number",
            "example":0.18,
            "description":"Prep cost used when ordering with barcode"
        }
    },
    "description":"Model for Barcode object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response body for the added Barcode

Body ()

Root Schema : BarCodeResponse

Type: object

Model for Barcode Response object

Show Source

• hierUnitId: integer
  Hierarchy location where the barcode is being added

  Example: 1012
• objectNum: integer
  Barcode record object number

  Example: 101

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "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"
        }
    },
    "description":"Model for Barcode Response object"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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",
    "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"
        }
    }
}

Back to Top