| Name | Description | Type | Additional information |
|---|---|---|---|
| OwnerCompanyNumber |
Identifies the company which owns the products. Used in product lookup, since same product can be owned by multiple companies. |
string |
None. |
| ProductIdentifier |
The string which identifies the product, such as GTIN |
string |
None. |
| Success |
If true, request was successful and all data needed for labeling should be in place. Production labels can be printed. If false, only sample labels can be printed if enough data is available. FailedRequestDescription should be presented to the user. |
boolean |
None. |
| FailedRequestDescription |
If request was not successful, describes the reason and states what the user is expected to do in order to overcome the problem. Examples: Product cannot be found; Insufficient data for labeling; Label must be |
string |
None. |
| Number |
Product number or similar, assigned by owner. Example: MC0117 |
string |
None. |
| Name |
Name of the product. Example: Markup Controller version 01/2017 |
string |
None. |
| IdentifiedUnit |
The unit the ProductIdentifier identifies. |
string |
None. |
| BasicUnit |
Basic unit of the product. |
string |
None. |
| BasicUnitsInDefaultBox |
Number of basic unis in a default box or other container. |
decimal number |
None. |
| IdentifiedUnitSizeInBasicUnits |
Identified unit can be converted to basic unit by multiplying quantity represented in IdentifiedUnit by this value. For example, if 1 carton (1 CT) contains 8 consumer packages (PCE) and product was identified using GTIN of the carton, then IdentifiedUnit is CT, BasicUnit is PCE and IdentifiedUnitSizeInBasicUnits is 8. |
decimal number |
None. |
| LabelWidthMillimeters |
Width of the label, in millimeters. 0 if not set. |
decimal number |
None. |
| LabelHeightMillimeters |
Height of the label, in millimeters. 0 if not set. |
decimal number |
None. |
| LabelLayoutIdentifier |
Specifies the layout to use if layout is stored on client side. |
string |
None. |
| LabelLayoutData |
Data for the layout fields. |
string |
None. |
| LabelLayoutDataFormat |
Specifies the format of the LabelLayoutData. |
string |
None. |
| ProcessingDirectionsText |
Directions for the user. Example: Put the label in back of the product. |
string |
None. |
| ProcessingDirectionsImage |
Base64-encoded image bytes. |
string |
None. |
| ProcessingDirectionsImageFormat |
Format of the image, such as image/png or image/jpeg |
string |
None. |