Get Order
Retrieve information about an existing order.
GET /{getOrderURL}/{order_id}
You can use either the Gelato Order ID or your Order Reference ID.
Response Format
The response will include detailed information about the order, including:
- Order details (ID, reference, status, etc.)
- Shipping address
- Items ordered with product details
- Shipment information (method, tracking, etc.)
- Financial information
Response example
{
"id": "9f9ff09f-5891-4d3d-be35-9b302db835a1",
"clientId": "ddb4371a-ad83-4f68-b99d-6b48c7eff366",
"orderReferenceId": "healthcheck_middleware_order_create_2024-12-02-11:05:06_1991",
"customerReferenceId": "sandbox-customer",
"fulfillmentStatus": "failed",
"financialStatus": "canceled",
"currency": "USD",
"shippingAddress": {
"id": "29de7336-95a9-48d2-aa85-d7d40e6ea65c",
"orderId": "9f9ff09f-5891-4d3d-be35-9b302db835a1",
"country": "GB",
"firstName": "TEST",
"lastName": "PRINT",
"companyName": "",
"addressLine1": "19 June Lewis Way",
"addressLine2": "",
"city": "Fairford",
"postCode": "GL7 4GH",
"state": "",
"email": "[email protected]",
"phone": "1111111119",
"isBusiness": false,
"federalTaxId": null,
"stateTaxId": null,
"registrationState": null
},
"items": [
{
"id": "e9f6de69-670b-47c5-a953-3710cac053a1",
"itemReferenceId": "1111111111",
"productUid": "large-posters_pf_500x700-mm_pt_170-gsm-coated-silk_cl_4-0_ver",
"storeProductVariantId": null,
"storeProductId": null,
"files": [
{
"id": null,
"type": "default",
"url": "https://URLexample.com/order",
"threadColors": [],
"isVisible": false,
"fitMethod": null,
"fillMethod": null,
"mimeType": "application/pdf",
"metadata": []
}
],
"processedFileUrl": null,
"quantity": 1,
"options": [],
"category": "Posters",
"productCategoryUid": "wall-art",
"productTypeUid": "poster",
"productNameUid": "classic-semi-glossy-poster",
"productName": "Classic Semi-Glossy Poster",
"fulfillmentStatus": "failed",
"pageCount": null,
"printJobs": [],
"eventLog": [],
"previews": [
{
"type": "preview_default",
"url": "https://URLexample.com/order"
},
{
"type": "preview_thumbnail",
"url": "https://URLexample.com/order"
},
{
"type": "preview_flat",
"url": "https://URLexample.com/order"
}
],
"designId": null,
"productFileMimeType": "application/pdf",
"finalProductUid": "large-posters_pf_500x700-mm_pt_170-gsm-coated-silk_cl_4-0_ver",
"metadata": [
{
"key": "unitWeight",
"value": "800"
},
{
"key": "unitPrice",
"value": ""
},
{
"key": "supplierPartAuxiliaryId",
"value": ""
}
],
"retailPriceInclVat": null,
"attributes": [
{
"name": "size",
"title": "Size",
"value": "500x700-mm",
"formattedValue": "50 x 70 cm"
},
{
"name": "orientation",
"title": "Orientation",
"value": "ver",
"formattedValue": "Vertical (portrait) orientation"
}
],
"itemReferenceName": null,
"isIgnored": false,
"price": 0,
"customTrim": null,
"fileUrl": "https://URLexample.com/order",
"dpi": 0,
"appServices": [],
"filesSize": 3.8,
"productVariant": []
}
],
"shipment": {
"id": "33163694-1437-407f-99ef-57a0d579114f",
"orderProductId": null,
"shippingAddressId": "29de7336-95a9-48d2-aa85-d7d40e6ea65c",
"promiseUid": "d_dfae1a1c58d230dbe73690a2",
"packageCount": 1,
"shipmentMethodUid": "dhl_global_parcel",
"shipmentMethodName": "DHL Global Parcel",
"isCheapest": true,
"minDeliveryDays": 1,
"maxDeliveryDays": 1,
"minDeliveryDate": "2024-12-03",
"maxDeliveryDate": "2024-12-03",
"totalWeight": 139,
"price": 0,
"status": null,
"packages": [],
"fulfillmentCountry": "DE",
"fulfillmentFacilityId": "db0622e7-d7af-4453-b39f-cdf1b67f3daa",
"retailShippingPriceInclVat": null,
"initialMinDeliveryDate": "2024-12-03",
"initialMaxDeliveryDate": "2024-12-03",
"serviceType": "normal",
"speedType": ""
},
"receipts": [
{
"id": "f9f6e29a-de14-4755-bafe-7cf0cdf6e3fc",
"orderId": "9f9ff09f-5891-4d3d-be35-9b302db835a1",
"type": "contract",
"currency": "USD",
"items": [
{
"id": "a99224b0-6e96-430e-84dd-82995f274840",
"receiptId": "f9f6e29a-de14-4755-bafe-7cf0cdf6e3fc",
"orderId": "9f9ff09f-5891-4d3d-be35-9b302db835a1",
"clientId": "ddb4371a-ad83-4f68-b99d-6b48c7eff366",
"type": "product",
"referenceId": "e9f6de69-670b-47c5-a953-3710cac053a1",
"title": "1x large-posters_pf_500x700-mm_pt_170-gsm-coated-silk_cl_4-0_ver",
"currency": "USD",
"priceBase": 0,
"amount": 1,
"priceInitial": 0,
"discount": 0,
"price": 0,
"vat": 0,
"priceInclVat": 0,
"pricePlanId": null,
"createdAt": "2024-12-02T11:05:09+00:00",
"updatedAt": "2024-12-02T11:05:09+00:00"
}
],
"createdAt": "2024-12-02T11:05:09+00:00",
"updatedAt": "2024-12-02T11:05:10+00:00",
"receiptNumber": "005-0014597660",
"billingEntity": {
"id": 218720,
"companyName": "Gelato",
"companyNumber": "",
"companyVatNumber": "",
"companyVatNumbers": [],
"countryIsoCode": "DE",
"country": "DE",
"recipientName": "Alex Shiltcev",
"addressLine1": "Something 1",
"addressLine2": "",
"city": "Berlin",
"postCode": "10113",
"stateCode": "",
"state": "",
"email": "[email protected]",
"phone": "",
"currencyIsoCode": "EUR",
"currency": "EUR",
"status": 1,
"iossNumber": null,
"invoiceType": null
},
"billingTag": "gelato-norway-de",
"transactionType": "purchase",
"productsPriceInitial": 0,
"productsPriceDiscount": 0,
"productsPrice": 0,
"productsPriceVat": 0,
"productsPriceInclVat": 0,
"shippingPriceInitial": 0,
"shippingPriceDiscount": 0,
"shippingPrice": 0,
"shippingPriceVat": 0,
"shippingPriceInclVat": 0,
"discount": 0,
"discountVat": 0,
"discountInclVat": 0,
"totalInitial": 0,
"total": 0,
"totalVat": 0,
"totalInclVat": 0,
"isCalculated": true
}
],
"createdAt": "2024-12-02T11:05:09+00:00",
"refusalReason": "Order is failing as it's going to be cross border and product retail prices are missing.",
"channel": "api",
"storeId": null,
"orderedByUserId": null,
"orderType": "order",
"metadata": [
{
"key": "tenant-customer-id",
"value": "02be1010-5f59-4504-a669-5cf88e84f627"
},
{
"key": "tenant-customer-uid",
"value": "sandbox-customer"
}
],
"billingEntity": {
"id": 218720,
"companyName": "Gelato",
"companyNumber": "",
"companyVatNumber": "",
"companyVatNumbers": [],
"countryIsoCode": "DE",
"country": "DE",
"recipientName": "Alex Shiltcev",
"addressLine1": "Something 1",
"addressLine2": "",
"city": "Berlin",
"postCode": "10113",
"stateCode": "",
"state": "",
"email": "[email protected]",
"phone": "",
"currencyIsoCode": "EUR",
"currency": "EUR",
"status": 1,
"iossNumber": null,
"invoiceType": null
},
"retailCurrency": null,
"paymentMethodType": null,
"paymentMethodId": null,
"prepaymentTransactionId": null,
"orderedAt": "2024-12-02T11:05:07+00:00",
"updatedAt": "2024-12-02T11:05:10+00:00",
"connectedOrderIds": [],
"discounts": [],
"returnAddress": {
"id": "6eeb262a-92ce-45a4-9cd6-128473a0acb0",
"country": null,
"addressLine1": null,
"addressLine2": null,
"city": null,
"postCode": null,
"state": null,
"email": null,
"phone": null,
"companyName": "Gelato Connect Sandbox"
},
"iossNumber": null,
"refusalReasonCode": "missing_retail_prices",
"refusalReasonDetails": null,
"comment": "Order is failing as it's going to be cross border and product retail prices are missing.",
"digitizationId": null,
"appServices": [],
"shipmentMethodUid": "normal"
}