Get order
Use the Order Get API to retrieve order information
GET https://order.gelatoapis.com/v3/orders/{{orderId}}
Request example
$ curl -X POST \
https://order.gelatoapis.com/v3/orders/37365096-6628-4538-a9c2-fbf9892deb85 \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: {{apiKey}}'
Response example
{
"id": "37365096-6628-4538-a9c2-fbf9892deb85",
"orderType": "order",
"orderReferenceId": "{{myOrderId}}",
"customerReferenceId": "{{myCustomerId}}",
"fulfillmentStatus": "printed",
"financialStatus": "paid",
"currency": "USD",
"channel": "api",
"storeId": "90365096-6628-4538-a9c2-fbf9892deb46",
"createdAt": "2021-01-14T10:32:03+00:00",
"updatedAt": "2021-01-14T12:32:03+00:00",
"orderedAt": "2021-01-14T12:32:03+00:00",
"items": [
{
"id": "0549170c-bd7d-4d43-b7a1-34c855e6aefb",
"itemReferenceId": "{{myItemId1}}",
"productUid": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
"fileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_original",
"processedFileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_processed",
"quantity": 100,
"fulfillmentStatus": "printed",
"previews": [
{
"type": "preview_default",
"url": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/preview_default"
}
]
},
{
"id": "13c165fe-de51-4ea9-86e6-98503ae14486",
"itemReferenceId": "{{myItemId2}}",
"productUid": "cards_pf_5r_pt_100-lb-cover-coated-silk_cl_4-4_hor",
"fileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_original",
"processedFileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_processed",
"quantity": 100,
"fulfillmentStatus": "printed",
"previews": [
{
"type": "preview_default",
"url": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/preview_default"
}
],
"options": [
{
"id": "68a91f44-2acd-4315-a64a-74a1c2c6c90a",
"type": "envelope",
"productUid": "blank-envelopes_pf_a7-env_pt_120-g-env",
"quantity": 40
}
]
}
],
"shipment": {
"id": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
"shipmentMethodName": "UPS Surepost",
"shipmentMethodUid": "ups_surepost",
"minDeliveryDays": 6,
"maxDeliveryDays": 7,
"minDeliveryDate": "1567029600",
"maxDeliveryDate": "1567116000",
"totalWeight": 613,
"fulfillmentCountry": "US",
"fulfillmentFacilityId": "63c165fe-de51-4ea9-86e6-98503ae14486",
"packagesCount": 1,
"packages": [
{
"id": "4a771ca0-7de4-4f0b-a7d4-9c952093af6c",
"orderItemIds": [
"0549170c-bd7d-4d43-b7a1-34c855e6aefb",
"13c165fe-de51-4ea9-86e6-98503ae14486"
],
"trackingCode": "12345678990",
"trackingUrl": "http://test.tracking.url"
}
]
},
"billingEntity": {
"id": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
"companyName": "Example",
"companyNumber": "Example Number",
"companyVatNumber": "Example VAT1234567890",
"country": "US",
"recipientName": "Paul Smith",
"addressLine1": "451 Clarkson Ave",
"addressLine2": "Brooklyn",
"city": "New York",
"postCode": "11203",
"state": "NY",
"email": "[email protected]",
"phone": "123456789"
},
"shippingAddress": {
"id": "d6bcf17f-3a48-4ec8-888e-70766ae8b56a",
"orderId": "37365096-6628-4538-a9c2-fbf9892deb85",
"country": "US",
"firstName": "Paul",
"lastName": "Smith",
"companyName": "Example",
"addressLine1": "451 Clarkson Ave",
"addressLine2": "Brooklyn",
"city": "New York",
"postCode": "11203",
"state": "NY",
"email": "[email protected]",
"phone": "123456789"
},
"returnAddress": {
"id": "d6bcf17f-3a48-4ec8-888e-70766ae8b56b",
"orderId": "37365096-6628-4538-a9c2-fbf9892deb85",
"companyName": "My company",
"addressLine1": "3333 Saint Marys Avenue",
"addressLine2": "Brooklyn",
"state": "NY",
"city": "New York",
"postCode": "13202",
"country": "US",
"email": "[email protected]",
"phone": "123456789"
},
"receipts": [
{
"id": "c74447e5-c543-4baf-8239-3620422b8d81",
"orderId": "37365096-6628-4538-a9c2-fbf9892deb85",
"transactionType": "purchase",
"currency": "USD",
"items": [
{
"id": "b65bb8f3-c2a3-425e-a366-7e19c32c93e2",
"receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
"referenceId": "0549170c-bd7d-4d43-b7a1-34c855e6aefb",
"type": "product",
"title": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
"currency": "USD",
"priceBase": 12.47,
"amount": 1,
"priceInitial": 12.47,
"discount": 0,
"price": 12.47,
"vat": 0.75,
"priceInclVat": 13.22,
"createdAt": "2021-01-14T12:30:03+00:00",
"updatedAt": "2021-01-14T12:32:03+00:00"
},
{
"id": "3126e362-8369-4900-bcd3-6990d373b69c",
"receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
"referenceId": "13c165fe-de51-4ea9-86e6-98503ae14486",
"type": "product",
"title": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
"currency": "USD",
"priceBase": 12.47,
"amount": 1,
"priceInitial": 12.47,
"discount": 0,
"price": 12.47,
"vat": 0.75,
"priceInclVat": 13.22,
"createdAt": "2021-01-14T12:30:03+00:00",
"updatedAt": "2021-01-14T12:32:03+00:00"
},
{
"id": "762f3563-ff24-4d4e-b6c7-fee19bfc878b",
"receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
"referenceId": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
"type": "shipment",
"title": "Delivery using SmartPost",
"currency": "USD",
"priceBase": 4.91,
"amount": 1,
"priceInitial": 4.91,
"discount": 0,
"price": 4.91,
"vat": 0.3,
"priceInclVat": 5.21,
"createdAt": "2021-01-14T12:30:03+00:00",
"updatedAt": "2021-01-14T12:32:03+00:00"
},
{
"id": "bb4c9eee-91a0-44a1-8ee0-a3cef29820f1",
"receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
"referenceId": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
"type": "packaging",
"title": "Packaging",
"currency": "USD",
"priceBase": 1.7,
"amount": 1,
"priceInitial": 1.7,
"discount": 0,
"price": 1.7,
"vat": 0.1,
"priceInclVat": 1.8,
"createdAt": "2021-01-14T12:30:03+00:00",
"updatedAt": "2021-01-14T12:32:03+00:00"
}
],
"productsPriceInitial": 24.94,
"productsPriceDiscount": 0,
"productsPrice": 24.94,
"productsPriceVat": 1.5,
"productsPriceInclVat": 26.44,
"packagingPriceInitial": 1.7,
"packagingPriceDiscount": 0,
"packagingPrice": 1.7,
"packagingPriceVat": 0.1,
"packagingPriceInclVat": 1.8,
"shippingPriceInitial": 4.91,
"shippingPriceDiscount": 0,
"shippingPrice": 4.91,
"shippingPriceVat": 0.3,
"shippingPriceInclVat": 5.21,
"discount": 0,
"discountVat": 0,
"discountInclVat": 0,
"totalInitial": 31.55,
"total": 31.55,
"totalVat": 1.9,
"totalInclVat": 33.45
}
],
"connectedOrderIds": []
}
Request
| Parameter | Type | Description |
|---|---|---|
| orderId (required) | string | Gelato order id. |
Response
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Gelato order id. |
| orderType (required) | string | Type of the order. It can be order or draft. Draft orders can be edited from the dashboard and they don't go into production until you decide to convert draft into a regular order via UI or programmatically via Order Patch API. |
| orderReferenceId (required) | string | Reference to your internal order id. |
| customerReferenceId (required) | string | Reference to your internal customer id. |
| fulfillmentStatus (required) | string | The current order fulfillment status can be one of the statuses described under Order statuses. |
| financialStatus (required) | string | The order current financial status. Can be: draft, pending, invoiced, to_be_invoiced, paid, canceled, partially_refunded, refunded and refused. |
| currency (required) | string | The order currency in iso code standard ISO 4217. |
| channel (required) | string | The order channel. Can be: ui, api, shopify and etsy. |
| storeId | string | E-commerce store ID identifying which store the order was placed in. It will be null if the order was placed via UI or API. |
| createdAt (required) | string | Date and time in ISO 8601 format when order was created. |
| updatedAt (required) | string | Date and time in ISO 8601 format when order was updated. |
| orderedAt (required) | string | Date and time in ISO 8601 format when order was placed. |
| items (required) | ItemObject | List of order items |
| shipment (optional) | ShipmentObject | Information about shipment |
| billingEntity (optional) | BillingEntityObject | Billing recipient |
| shippingAddress (optional) | ShippingAddressObject | Shipping address |
| returnAddress (optional) | ReturnAddressObject | Return address |
| receipts (required) | ReceiptObject | List of order receipts |
| connectedOrderIds (optional) | string[] | List of connected order IDs. Used when an order needs to be produced in multiple locations for example. Read more here |
ItemObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Item Id. |
| itemReferenceId (required) | string | Reference to your internal order item id. |
| productUid (required) | string | Type of printing product in product uid format. |
| pageCount (optional) | integer | The page count for multipage products. This parameter is only needed for multi-page products. All pages in the product, including front and back cover are included in the count. For example for a Wire-o Notebook there are 112 inner pages (56 leaves), 2 front (outer and inside) and 2 back cover (outer and inside) pages, total 116 pages. The pageCount is 116. Read more |
| quantity (required) | integer | The product quantity. |
| fulfillmentStatus (required) | string | The current item fulfillment status can be one of the statuses described under Order statuses. |
| fileUrl (required) | string | The link to original file. |
| processedFileUrl (required) | string | The link to processed file which was sent to production. |
| previews (required) | ItemPreview[] | Array of previews |
| options (optional) | ItemOption[] | Array of additional item options |
ItemPreview
| Parameter | Type | Description |
|---|---|---|
| type (required) | string | Type of previews. Can be: preview_default and preview_thumbnail. |
| url (required) | string | Url to preview file. |
ItemOption
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Item option Id. |
| type (required) | string | A valid option category (currently only envelope). |
| productUid (required) | string | Specific option category product in product uid format. |
| quantity (required) | integer | The option quantity. For example how many envelopes should be added to your product. |
ShipmentObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Shipment Id. |
| shipmentMethodName (required) | string | The shipment method name. |
| shipmentMethodUid (required) | string | The shipment method uid. |
| packageCount (required) | integer | Count of shipping packages. Depending on the product type and quantity ordered, the product might be split into packages if a weight of the product exceeds the available weight or size for the shipping method. |
| minDeliveryDays (required) | integer | Minimum days estimate to produce and deliver the item. |
| maxDeliveryDays (required) | integer | Maximum days estimate to produce and deliver the item. |
| minDeliveryDate (required) | string | Minimum date estimate to produce and deliver the item. |
| maxDeliveryDate (required) | string | Maximum date estimate to produce and deliver the item |
| totalWeight (required) | integer | Total weight of the product in grams, including the weight of the packages. |
| fulfillmentCountry (required) | string | Shipment origin country. The two-character ISO 3166-1. |
| fulfillmentFacilityId (required) | string | Fulfillment facility identifier. |
| packages (required) | PackageObject[] | List of packages. |
PackageObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Package Id. |
| orderItemIds (required) | string[] | List of order item Ids. |
| trackingCode (required) | string | The tracking code of the package. |
| trackingUrl (required) | string | The tracking url. |
ShippingAddressObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Shipment address id |
| country (required) | string | The two-character ISO 3166-1 code that identifies the country or region. |
| firstName (required) | string | The first name of the recipient at this address. |
| lastName (required) | string | The last name of the recipient at this address. |
| companyName (optional) | string | The company name of the recipient at this address. |
| addressLine1 (required) | string | The first line of the address. For example, number, street, and so on. |
| addressLine2 (optional) | string | The second line of the address. For example, suite or apartment number. |
| city (required) | string | The city name. |
| postСode (required) | string | The postal code, which is the zip code or equivalent. |
| state (optional) | string | The code for a US state or the equivalent for other countries. |
| email (required) | string | The email address for the recipient. |
| phone (optional) | string | The phone number, in E.123 format. |
| isBusiness (optional) | bool | Boolean value, declares the recipient being a business. |
| federalTaxId (optional) | string | The Federal Tax identification number of recipient. |
| stateTaxId (optional) | string | The State Tax identification number of recipient. |
| registrationStateCode (optional) | string | The code number for a US state or the equivalent for other countries that defines state where recipient company is registered. |
BillingEntityObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Billing entity id |
| companyName (required) | string | The company name |
| companyNumber (optional) | string | The company number |
| companyVatNumber (optional) | string | The company VAT number |
| country (required) | string | The two-character ISO 3166-1 code that identifies the country or region. |
| recipientName (required) | string | The recipient name of the billing entity |
| addressLine1 (required) | string | The first line of the address. For example, number, street, and so on. |
| addressLine2 (optional) | string | The second line of the address. For example, suite or apartment number. |
| city (required) | string | The city name. |
| postСode (required) | string | The postal code, which is the zip code or equivalent. |
| state (optional) | string | The code for a US state or the equivalent for other countries. |
| email (required) | string | The email address for the billing entity |
| phone (optional) | string | The phone number, in E.123 format. |
ReceiptObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Receipt Id. |
| orderId (required) | string | Gelato order id. |
| transactionType (required) | string | The transaction type of receipt. Can be: purchase, refund. |
| currency (required) | string | The currency of receipt. |
| items (required) | ReceiptItemObject[] | List of receipt items. |
| productsPriceInitial (required) | double | The initial products price. |
| productsPriceDiscount (required) | double | The discount products price. |
| productsPrice (required) | double | The products price. |
| productsPriceVat (required) | double | The products VAT price. |
| productsPriceInclVat (required) | double | The products price included VAT. |
| packagingPriceInitial (required) | double | The initial packaging price. |
| packagingPriceDiscount (required) | double | The discount packaging price. |
| packagingPrice (required) | double | The packaging price. |
| packagingPriceVat (required) | double | The packaging VAT price. |
| packagingPriceInclVat (required) | double | The packaging price included VAT. |
| shippingPriceInitial (required) | double | The initial shipping price. |
| shippingPriceDiscount (required) | double | The discount shipping price. |
| shippingPrice (required) | double | The shipping price. |
| shippingPriceVat (required) | double | The shipping VAT price. |
| shippingPriceInclVat (required) | double | The shipping price included VAT. |
| discount (required) | double | The total discounts on the order. |
| discountVat (required) | double | The total discounts VAT on the order. |
| discountInclVat (required) | double | The total discounts on the order included VAT. |
| totalInitial (required) | double | The initial total price of the order. |
| total (required) | double | The total price of the order. |
| totalVat (required) | double | The total VATs of the order. |
| totalInclVat (required) | double | The total price of the order included VAT. |
ReceiptItemObject
| Parameter | Type | Description |
|---|---|---|
| id (required) | string | Receipt item Id. |
| receiptId (required) | string | Receipt Id. |
| referenceId (required) | string | Reference to order item id or to shipment id. |
| type (required) | string | The type of receipt item. Can be: product, shipment or packaging. |
| title (required) | string | The title of receipt item. |
| currency (required) | string | The currency of receipt item. |
| priceBase (required) | string | The base price of item. |
| amount (required) | string | The amount of item. |
| priceInitial (required) | double | The initial item price |
| discount (required) | double | The discount of the item |
| price (required) | double | The item price |
| vat (required) | double | The item VAT price |
| priceInclVat (required) | double | The item price included VAT |
| createdAt (required) | string | The receipt item created at date and time in format ISO 8601 |
| updatedAt (required) | string | The receipt item updated at date and time in format ISO 8601 |