Print Plate Search
Print plate search API is a RESTful API that allows you to find an order and get the useful information about it.
POST /v1/print-plate/search
Request example
{
"printPlateId": [503372049],
"createdFrom": "2024-06-14T12:30:03+00:00",
"createdTo": "2024-08-14T12:30:03+00:00",
"statusUid": ["failed"],
"pagination": {
"pageNumber": 1,
"perPage": 100
}
}
Success response example
{
"pagination": {
"pageNumber": 1,
"perPage": 50,
"totalResult": 1
},
"printPlate": [
{
"createdAt": "2024-06-30T03:01:47+00:00",
"platePart": [
{
"attribute": [
{
"key": "bindingTypeUid",
"value": "stitched-left"
},
{
"key": "coatingTypeUid",
"value": "none"
},
{
"key": "colorTypeUid",
"value": "4-4"
},
{
"key": "foldingTypeUid",
"value": "none"
},
{
"key": "substrateFormatUid",
"value": "sra3"
},
{
"key": "substrateTypeUid",
"value": "250-gsm-coated-silk"
},
{
"key": "substrateWidthMm",
"value": "320"
},
{
"key": "substrateHeightMm",
"value": "450"
}
],
"sheetQuantity": 4,
"type": "inner_page"
},
{
"attribute": [
{
"key": "coatingTypeUid",
"value": "none"
},
{
"key": "colorTypeUid",
"value": "4-4"
},
{
"key": "substrateFormatUid",
"value": "b2"
},
{
"key": "substrateTypeUid",
"value": "250-gsm-coated-silk"
},
{
"key": "substrateWidthMm",
"value": "530"
},
{
"key": "substrateHeightMm",
"value": "750"
}
],
"sheetQuantity": 4,
"type": "cover_page"
},
{
"attribute": [
{
"key": "colorTypeUid",
"value": "4-4"
},
{
"key": "substrateFormatUid",
"value": "sra3"
},
{
"key": "substrateTypeUid",
"value": "250-gsm-coated-silk"
},
{
"key": "substrateWidthMm",
"value": "320"
},
{
"key": "substrateHeightMm",
"value": "450"
}
],
"sheetQuantity": 1,
"type": "info_inner_page"
},
{
"attribute": [
{
"key": "coatingTypeUid",
"value": "none"
},
{
"key": "colorTypeUid",
"value": "4-4"
},
{
"key": "substrateFormatUid",
"value": "b2"
},
{
"key": "substrateTypeUid",
"value": "250-gsm-coated-silk"
},
{
"key": "substrateWidthMm",
"value": "530"
},
{
"key": "substrateHeightMm",
"value": "750"
}
],
"sheetQuantity": 1,
"type": "info_cover_page"
}
],
"printHouseUid": "US_TEST",
"file": [
{
"key": "info_pdf",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.example/staging/print_plates/print_house_US_TEST/20250101/123456789/W01_sheet500x700mm_123456789_jobticket.pdf?X-Amz-Signature=signature1"
},
{
"key": "plate_cover_info_pdf",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.example/staging/print_plates/print_house_US_TEST/20250101/123456789/W01_sheet500x700mm_123456789_cover_info.pdf?X-Amz-Signature=signature2",
"relatedPlateParts": ["info_cover_page"]
},
{
"key": "plate_cover_pdf",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.example/staging/print_plates/print_house_US_TEST/20250101/123456789/W01_sheet500x700mm_123456789_cover_plate.pdf?X-Amz-Signature=signature3",
"relatedPlateParts": ["cover_page"]
},
{
"key": "plate_info_pdf",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.example/staging/print_plates/print_house_US_TEST/20250101/123456789/W01_sheet500x700mm_123456789_inner_info.pdf?X-Amz-Signature=signature4",
"relatedPlateParts": ["info_inner_page"]
},
{
"key": "plate_pdf",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.example/staging/print_plates/print_house_US_TEST/20250101/123456789/W01_sheet500x700mm_123456789_inner_plate.pdf?X-Amz-Signature=signature5",
"relatedPlateParts": ["inner_page"]
},
{
"key": "production_order",
"url": "https://s3.eu-west-1.amazonaws.com/printcloud.example/staging/print_plates/print_house_US_TEST/20250101/123456789/production_order_123456789.xml?X-Amz-Signature=signature6"
}
],
"printPlateId": 503372049,
"statusUid": "uploading",
"updatedAt": "2024-06-30T03:01:56+00:00",
"workflowUid": "W07"
}
]
}
Error response example
{
"error": "'pageNumber' should be greater than 0,'perPage' should be less than or equal to 100,'from date' should be not less than seven days from now"
}
Request
| Parameter |
Type |
Description |
| printPlateId (required) |
array of numbers |
List of print plates id, can be empty list. |
| statusUid (required) |
array of strings |
List of statuses, can be empty list. Supported statuses. |
| createdFrom (required) |
date format, ISO 8601 |
Date and time of created print plate. Can not be less then 7 day from today. |
| createdTo (required) |
date format, ISO 8601 |
Date and time of created print plate. |
| pagination (optional) |
Pagination |
Pagination. |
Statuses
[
"new",
"failed",
"cancelled",
"building",
"built",
"uploading",
"uploaded",
"production_error",
"partial_scanned",
"scanned",
"reverted",
"printed",
"upload_retry",
"rip_processing",
"rip_complete",
"print_running",
"print_complete",
"laminated",
"foil",
"cut"
]
| Parameter |
Type |
Description |
| pageNumber (required) |
number |
Must be positive and bigger then zero. |
| perPage (required) |
number |
Must be positive and bigger then zero but less or equal 100. |
Successful response
The API returns a JSON object with the following structure:
| Field |
Type |
Description |
| pagination |
object |
Pagination information |
| pagination.pageNumber |
number |
Current page number |
| pagination.perPage |
number |
Number of items per page |
| pagination.totalResult |
number |
Total number of items |
| printPlate |
array of objects |
List of print plates |
Each print plate object has the following structure:
| Field |
Type |
Description |
| printPlateId |
number |
Unique identifier of the print plate |
| statusUid |
string |
Current status of the print plate |
| printHouseUid |
string |
Identifier of the print house |
| createdAt |
string |
Creation date and time (ISO 8601 format) |
| updatedAt |
string |
Last update date and time (ISO 8601 format) |
| workflowUid |
string |
Identifier of the workflow |
| file |
array of objects |
List of files associated with the print plate |
| platePart |
array of objects |
List of plate parts |
| printJob |
array of objects |
List of print jobs |
File object
| Field |
Type |
Description |
| key |
string |
Identifier of the file type |
| url |
string |
URL to download the file |
| relatedPlateParts |
array of strings |
List of plate part types that this file is related to. A file can be related to multiple plate parts (e.g., a file may be related to "inner_page", "info_inner_page", and "bottom_card" simultaneously). Some files (like XML metadata files) might not be related to any plate parts, in which case this field will be omitted. |
Plate Part object
| Field |
Type |
Description |
| type |
string |
Type of the plate part (e.g., "inner_page", "cover_page") |
| sheetQuantity |
number |
Number of sheets for this plate part |
| attribute |
array of objects |
List of attributes for this plate part |
Attribute object
| Field |
Type |
Description |
| key |
string |
Attribute name |
| value |
string |
Attribute value |
Print Job object
| Field |
Type |
Description |
| printJobId |
number |
Unique identifier of the print job |
| orderItemId |
string |
Identifier of the order item |
| orderId |
string |
Identifier of the order |
| packageId |
number |
Identifier of the package |
| productUid |
string |
Identifier of the product |
| originalQuantity |
number |
Original quantity ordered |
| extraQuantity |
number |
Extra quantity added |
| printedQuantity |
number |
Total quantity printed |
| pagesQuantity |
number |
Number of pages in the print job |
| tenantCustomerUid |
string |
Identifier of the tenant customer |
| tenantCustomerName |
string |
Name of the tenant customer |