/v23.1/LabelDefinitions
  • 05 Jun 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/LabelDefinitions

  • Dark
    Light
  • PDF

Article summary

Post
/v23.1/LabelDefinitions
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
externalCode
string
description
string
labelType
string
Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
trackAndTrace
boolean
Default"False"
thermalPrinterLanguageId
integer (int32)
labelClassId
integer (int32)
startPrinting
string
startLabel
string
label
string
stopLabel
string
stopPrinting
string
horizontalLabels
integer (int32)
isPrintDescriptions
boolean
Default"False"
property1
boolean
Default"False"
property2
boolean
Default"False"
property3
boolean
Default"False"
property4
boolean
Default"False"
property5
boolean
Default"False"
property6
boolean
Default"False"
property7
boolean
Default"False"
property8
boolean
Default"False"
property9
boolean
Default"False"
property10
boolean
Default"False"
codePage
integer (int32)
encoding
string
isCancelled
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
externalCode
string
description
string
labelType
string
Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
trackAndTrace
boolean
Default"False"
thermalPrinterLanguageId
integer (int32)
labelClassId
integer (int32)
startPrinting
string
startLabel
string
label
string
stopLabel
string
stopPrinting
string
horizontalLabels
integer (int32)
isPrintDescriptions
boolean
Default"False"
property1
boolean
Default"False"
property2
boolean
Default"False"
property3
boolean
Default"False"
property4
boolean
Default"False"
property5
boolean
Default"False"
property6
boolean
Default"False"
property7
boolean
Default"False"
property8
boolean
Default"False"
property9
boolean
Default"False"
property10
boolean
Default"False"
codePage
integer (int32)
encoding
string
isCancelled
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
externalCode
string
description
string
labelType
string
Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
trackAndTrace
boolean
Default"False"
thermalPrinterLanguageId
integer (int32)
labelClassId
integer (int32)
startPrinting
string
startLabel
string
label
string
stopLabel
string
stopPrinting
string
horizontalLabels
integer (int32)
isPrintDescriptions
boolean
Default"False"
property1
boolean
Default"False"
property2
boolean
Default"False"
property3
boolean
Default"False"
property4
boolean
Default"False"
property5
boolean
Default"False"
property6
boolean
Default"False"
property7
boolean
Default"False"
property8
boolean
Default"False"
property9
boolean
Default"False"
property10
boolean
Default"False"
codePage
integer (int32)
encoding
string
isCancelled
boolean
Default"False"
Responses
200

Success

object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
externalCode
string
description
string
labelType
string
Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
trackAndTrace
boolean
Default"False"
thermalPrinterLanguageId
integer (int32)
labelClassId
integer (int32)
startPrinting
string
startLabel
string
label
string
stopLabel
string
stopPrinting
string
horizontalLabels
integer (int32)
isPrintDescriptions
boolean
Default"False"
property1
boolean
Default"False"
property2
boolean
Default"False"
property3
boolean
Default"False"
property4
boolean
Default"False"
property5
boolean
Default"False"
property6
boolean
Default"False"
property7
boolean
Default"False"
property8
boolean
Default"False"
property9
boolean
Default"False"
property10
boolean
Default"False"
codePage
integer (int32)
encoding
string
isCancelled
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
externalCode
string
description
string
labelType
string
Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
trackAndTrace
boolean
Default"False"
thermalPrinterLanguageId
integer (int32)
labelClassId
integer (int32)
startPrinting
string
startLabel
string
label
string
stopLabel
string
stopPrinting
string
horizontalLabels
integer (int32)
isPrintDescriptions
boolean
Default"False"
property1
boolean
Default"False"
property2
boolean
Default"False"
property3
boolean
Default"False"
property4
boolean
Default"False"
property5
boolean
Default"False"
property6
boolean
Default"False"
property7
boolean
Default"False"
property8
boolean
Default"False"
property9
boolean
Default"False"
property10
boolean
Default"False"
codePage
integer (int32)
encoding
string
isCancelled
boolean
Default"False"
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
externalCode
string
description
string
labelType
string
Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
trackAndTrace
boolean
Default"False"
thermalPrinterLanguageId
integer (int32)
labelClassId
integer (int32)
startPrinting
string
startLabel
string
label
string
stopLabel
string
stopPrinting
string
horizontalLabels
integer (int32)
isPrintDescriptions
boolean
Default"False"
property1
boolean
Default"False"
property2
boolean
Default"False"
property3
boolean
Default"False"
property4
boolean
Default"False"
property5
boolean
Default"False"
property6
boolean
Default"False"
property7
boolean
Default"False"
property8
boolean
Default"False"
property9
boolean
Default"False"
property10
boolean
Default"False"
codePage
integer (int32)
encoding
string
isCancelled
boolean
Default"False"
400

Bad Request

Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.