Thoroughly test your product configurations, packaging, and order flows using the GelatoConnect API.
1. Preparing to Place a Test Order
Before placing a test order, ensure that you have:
Customer Product Setup: Create the Customer Product with the required attributes and variants. Follow these steps:
Navigate to the Customer Products section in GelatoConnect.
Select the relevant product model (e.g., Poster Product).
Define the base attributes and variants, ensuring they align with the customer’s preferred data format. Map customer-provided values (e.g., color or size) to internal Gelato attributes.
Save the configuration.
API Access: Confirm you have valid API credentials and access permissions for placing orders.
Test Files: Ensure you have sample files ready to upload (e.g., print-ready PDFs).
2. Placing a Test Order Using the GelatoConnect API
Use the following steps to place a test order via the API:
API Endpoint
POST https://order.ie.live.gelato.tech/api/v4/orders
Example API Request Structure
{
"clientId": "your-client-id",
"orderReferenceId": "test-order-ref",
"customerReferenceId": "test-customer-ref",
"orderType": "order",
"currency": "USD",
"retailCurrency": "USD",
"retailShippingPriceInclVat": 5.99,
"shippingAddress": {
"country": "US",
"firstName": "John",
"lastName": "Doe",
"addressLine1": "123 Test St",
"city": "Testville",
"postCode": "12345",
"state": "CA",
"email": "[email protected]",
"phone": "1234567890"
},
"items": [
{
"itemReferenceId": "test-item-ref",
"productName": "Sample Product",
"productVariant": {
"paper": "a1",
"color": "front"
},
"files": [
{
"type": "default",
"url": "https://example.com/test-file.pdf"
}
],
"quantity": 1,
"retailPriceInclVat": 19.99
}
]
}Key Fields
productName: Must match the exact name of your Customer Product in GelatoConnect.
productVariant: Specify options such as paper type, size, or color based on your setup.
files: Provide the URL for the file to be used in production.
3. Validating the Test Order
Once the test order is placed, verify the following:
Order Confirmation: Check the API response to ensure the order was successfully created. Note the order ID and fulfillment status.
Order Display in GNX: Log into GelatoConnect (GNX) to view the test order details.
Confirm that all attributes and variants are correctly applied.
Verify that the files have been uploaded successfully and meet the production requirements.
Packaging Check:
Review the packaging details in the GNX display.
Ensure the selected options (e.g., gift wrapping) match your expectations.
Create customized packaging checks (see section 9 for reference)
Create customized shelves (see section 9 for reference)
Input the barcode manually with the print job number to test the packaging station flow
4. Troubleshooting Issues
If the test order does not meet expectations:
Check Product Configuration:
Verify that the productName and productVariant fields in the API request match your Customer Product setup.
Ensure all required options are included and correctly mapped.
Inspect Files: Confirm that the uploaded files meet the size and format requirements of the Customer Product.
Review API Credentials: Verify that the credentials used have the correct permissions for placing test orders.
Contact Support: For persistent issues, contact GelatoConnect support with the order ID and details of the issue.
📝 Not what you needed?
Help us improve this article, send us an email to [email protected] — please include the article title.