Skip to content

Status Postback

The status postbacks are json messages back to Gelato Connect API to keep us and our customers updated on the production status of the order. Following statuses can be posted back to Gelato:

  • received - postback expected immediately after order received, to confirm successful processing in your system. This status is mandatory
  • error - postback expected in case of any error, either submission error (when status "received" can not be provided)
  • printed - postback expected when an order item or the entire order has been finished printed. This status is optional
  • shipped – postback expected when an order item or the entire order has been shipped. This status is mandatory
  • cancelled - postback expected when an order item or the entire order has been cancelled in your system. This status is mandatory

Post backs can be submitted either for an entire order or for each individual order item. If you are sending for each individual order item, we expect you to send back post backs for each order item in the order, for our system to mark it as completed

POST /v2/order/status

Request example

{
  "timestamp": "2008-09-15T15:53:00Z",
  "orderId": "d290f1ee",
  "status": "received",
  "message": "The order has been shipped",
  "trackingCode": "RT1235D",
  "trackingLink": "https://test.com"
}

Success response example

{
  "message": "order status update has been sent"
}

Error response example

{
  "error": "invalid request"
}

Request

Parameter Type Description
timestamp (required) string Date the status is sent by the partner system to Gelato Connect API, in ISO*8601.
_Sample: 2008-09-15T15:53:00Z._
orderId (required) string Gelato submitted ID.
Sample: d290f1ee.
status (required) string One of the supported values (see below):
• received - postback expected immediately after order received
• error - postback expected in case of any error
• printed - postback expected when print job printed
• shipped - postback expected when order shipped
• cancelled - postback expected when order cancelled on the partner side.
Sample: received.
message string Mandatory for status error, but can be provided with any other status. Sample: The order has been shipped.
trackingCode string Optional information to be provided with status shipped when not using Gelato dispatchOrder.
Sample: RT1235D.
trackingLink string Optional information to be provided with status shipped when not using Gelato dispatchOrder.
Sample: https://test.com.

Success response

Parameter Type Description
message (required) string The message with the success.
Sample: subscribed webhook.

Error response

Parameter Type Description
error (required) string The message with the error.
Sample: invalid request.