Get order status

Use the Order status API to get the order details about status, production log or tracking information. Please note: Order creation is internally queued and therefore there can be a small delay (typically 1-3 seconds) between the order placement call and the Order status API being able to return a meaningful status.

GET https://api.gelato.com/v2/order/status/{{orderReferenceId}}

Request example

$ curl -X GET \
   https://api.gelato.com/v2/order/status/{{MyOrderId}} \
   -H 'Content-Type: application/json' \
   -H 'X-API-KEY: {{apiKey}}'

Response example

{
  "orderReferenceId": "{{MyOrderId}}",
  "productionStatus": "passed",
  "productionFacilityId": "940fec84-54bc-44fc-a8a3-7d6f02cf8f14",
  "orderItems": [
      {
        "itemReferenceId": "{{MyItemId1}}",
        "status": "passed",
        "trackingCode": [
          {
            "parcelNumber": 1,
            "trackingCode": "",
            "trackingUrl": ""
          }
        ],
        "productionLog": [
          {
            "date": "2018-06-14T11:30:33+00:00",
            "printJobId": 1000077008,
            "message": "PdfToolbox - Uploaded original pdf to s3"
          },
          {
            "date": "2018-06-14T11:30:32+00:00",
            "printJobId": 1000077008,
            "message": "PrintJob created"
          }
        ]
      },
      {
        "itemReferenceId": "{{MyItemId2}}",
        "status": "shipped",
        "trackingCode": [
          {
            "parcelNumber": 1,
            "trackingCode": "1234567890",
            "trackingUrl": "https://example.com/search?piececode=1234567890"
          }
        ],
        "productionLog": [
          {
            "date": "2018-06-14T11:30:33+00:00",
            "printJobId": 1000078008,
            "message": "PdfToolbox - Uploaded original pdf to s3"
          },
          {
            "date": "2018-06-14T11:30:32+00:00",
            "printJobId": 1000078008,
            "message": "PrintJob created"
          },
         {
           "date": "2018-06-15T11:30:32+00:00",
           "printJobId": 1000078008,
           "message": "The package is shipped"
         }
        ]
      }
  ]
}

Query Parameters

Parameter	Type	Description
orderReferenceId (required)	string	Reference to your internal order id.

Response Parameters

Parameter	Type	Description
orderReferenceId (required)	string	Reference to your internal order id.
productionStatus (required)	string	Current aggregated status of your order can be one of the statuses described under Order statuses. Note: You can also access the status of each order item individually.
productionFacilityId (required)	string	Id of production facility where the order was assigned to.
orderItems	OrderItemObject[]	List of order items details.

OrderItemObject

Parameter	Type	Description
itemReferenceId (required)	string	Reference to your internal item id.
status (required)	string	The current item fulfillment status can be one of the statuses described under Order statuses.
trackingCode (required)	TrackingCodeObject[]	The list of tracking codes for each parcel.
productionLog (required)	ProductionLogObject[]	The log of the production process, including printing and shipping information

TrackingCodeObject

Parameter	Type	Description
parcelNumber (required)	integer	The serial number of the parcel. Always started at 1.
trackingCode (required)	string	The tracking code of the parcel.
trackingUrl (required)	string	The tracking url.

ProductionLogObject

Parameter	Type	Description
date (required)	string	The production log creation date and time in ISO-8601 format.
printJobId (required)	integer	Gelato's internal reference id to the print job. Please note: one itemReferenceId might be split into parcels and print jobs if the weight of the product exceeds the available weight or size for the shipping method.
message (required)	string	The production log message.

---