Introduction
This guide explains the essential terminology and concepts you'll encounter when working with GelatoConnect's order intake systems. Understanding these terms will help you navigate the platform more effectively and communicate more clearly about order management processes.
Core Order Concepts
Order
A request for one or more products to be produced and shipped to a specified address. An order is the fundamental unit of work in GelatoConnect.
Order Reference ID
Your unique identifier for an order. This should correspond to an order ID in your system and allows you to track the relationship between GelatoConnect orders and your internal systems.
Customer Reference ID
Your unique identifier for the customer placing the order. This helps link orders to specific customers in your system.
Order Type
Defines how an order should be processed. The two main types are:
Order: A standard order that will be processed immediately
Draft: An order saved for future editing and submission
Order Status
Indicates the current stage of an order in the fulfillment process. Key statuses include:
Draft: Order created but not submitted for processing
Received: Order submitted and under initial validation
Passed: Order has passed validation checks
Failed: Order has failed validation checks
Created: Order validated and ready for production
In Production: Order is being processed
Printed: Production is complete
Packaged: Order is packaged and ready for shipping
Shipped: Order has been handed to the carrier
Delivered: Order has been delivered to the recipient
Canceled: Order has been canceled by request or system
Order Item
An individual product within an order. Each item has its own specifications, quantities, and files. Multiple items can be included in a single order.
Item Reference ID
Your unique identifier for a specific item within an order. This helps track individual products within a larger order.
Product Identification Methods
Product UID
A unique identifier for a specific product configuration in the GelatoConnect system. Product UIDs follow a structured format that encodes product attributes.
Example: flat_product_pf_a4_pt_200-gsm-uncoated_cl_4-0_ct_none_prt_none_sft_none_set_none_hor
This identifier contains encoded information about:
Product type (
flat_product)Paper format (
pf_a4)Paper type (
pt_200-gsm-uncoated)Color configuration (
cl_4-0meaning 4-color front, 0-color back)Other specifications (cutting, printing, etc.)
Orientation (
horfor horizontal)
Customer Product
A simplified way to identify products using a product name and variant structure. This approach is more human-readable and easier to manage for complex product catalogs.
Example:
{
"productName": "Business Card",
"productVariant": {
"Size": "Standard",
"Paper": "Premium Matte",
"Color": "Full Color Both Sides"
}
}
File Management
Print File
The source file containing the artwork to be printed. Typically a PDF, PNG, or JPEG file, depending on the product requirements.
File URL
The location where the print file can be accessed. Must be a publicly accessible URL that GelatoConnect can download from.
File Type
Defines the role of the file in the product. Common types include:
default: The main print file for the product
front: The file for the front of a product
back: The file for the back of a product
cover: The file for a book cover
inside: The file for a book inner pages
Processed File
The production-ready version of the print file after GelatoConnect has applied any necessary transformations.
Preview
A visual representation of how the final product will look based on the provided print files.
Shipping Information
Shipping Address
The destination address where the order should be delivered, including recipient details.
Shipment Method UID
An identifier for the shipping method to be used for the order. Can be specific (fed_ex_2_day) or general (express).
Return Address
The address that will be used as the sender address on the package and for any returns.
Tracking Code
A unique identifier provided by the shipping carrier to track the package's delivery progress.
Tracking URL
A web address where the customer can check the current status of their shipment.
Integration Concepts
API
Application Programming Interface - the method to programmatically interact with GelatoConnect. Uses standard HTTP methods (GET, POST, PUT, etc.) to manipulate orders.
API Key and Secret
Security credentials used to authenticate requests to the GelatoConnect API. Consists of a key and secret pair that must be provided in the X-API-KEY header in the format "key:secret".
Webhook
An HTTP callback that delivers notifications about events in GelatoConnect to your system in real-time.
Postback
A notification sent from GelatoConnect to your system (or your customers) when an order's status changes.
Template Mapper
A tool for transforming data between your format and GelatoConnect's format, using the Jinja2 templating language.
Lookup
A mapping table that converts values from your system (like product SKUs) into GelatoConnect values (like Product UIDs).
Storefront
An e-commerce platform (like Shopify, Etsy, or WooCommerce) that can be connected to GelatoConnect for automatic order import.
FTP
File Transfer Protocol - a method for uploading order files to GelatoConnect for batch processing.
Financial and Billing Terms
Currency
The monetary unit orders will be charged in. Must be specified for each order using ISO currency codes (e.g., USD, EUR, GBP).
Retail Price
The price charged to the end customer for a product, typically used for customs declarations on international shipments.
Advanced Concepts
Order Request
The initial submission of an order before it has been fully processed and validated.
Metadata
Additional information attached to an order as key-value pairs, used for tracking, analysis, or integration purposes. Metadata can be applied to individual order items or the whole order.
Preflight Check
Automated validation of print files to ensure they meet production requirements.
Workflow Builder
A tool for defining the production steps for each product type.
Glossary of Abbreviations
Abbreviation | Definition |
PSP | Print Service Provider |
API | Application Programming Interface |
FTP | File Transfer Protocol |
UID | Unique Identifier |
UI | User Interface |
SLA | Service Level Agreement |
EDI | Electronic Data Interchange |
B2B | Business to Business |
B2C | Business to Consumer |
CSV | Comma-Separated Values |
JSON | JavaScript Object Notation |
XML | Extensible Markup Language |
Next Steps
Now that you're familiar with the common terms and concepts used in GelatoConnect's order intake systems, you're better equipped to:
Understand documentation and error messages
Navigate the platform with greater confidence
For more detailed information on specific aspects of order intake, please refer to the relevant sections in our help center.
If you have questions about terminology or concepts not covered here, please contact our support team at [email protected].