Login
      Contents x
      /v23.1/LabelDefinitions
      • 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/LabelDefinitions

      • Updated on 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/LabelDefinitions
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      ExternalCode
      string
      Description
      string
      LabelType
      string
      Valid values[ "NotSpecified", "Product", "Customer", "SerialNumber", "Reservations", "Location", "SaleOrders", "Carrier", "Parcel" ]
      TrackAndTraceOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsCompanyLabelDefinitionsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsCancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      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"
      isDerived
      boolean
      Default"False"
      labelClassDescription
      string
      thermalPrinterLanguageDescription
      string
      Array of object
      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"
      isDerived
      boolean
      Default"False"
      labelClassDescription
      string
      thermalPrinterLanguageDescription
      string
      Array of object
      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"
      isDerived
      boolean
      Default"False"
      labelClassDescription
      string
      thermalPrinterLanguageDescription
      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
      404

      Not Found

      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?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      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.
      Logout