Skip to content

Dispatch Order

Dispatch Order allows the print partner to notify Gelato when order is ready to be dispatched. This will generate labels and invoices.

POST /v2/order/dispatch

Request example

{
  "orderId": "d290f1ee"
}

Success response example

{
  "documents": [
    {
      "type": "label",
      "contentType": "application/pdf",
      "format": "pdf",
      "url": "https://s3-eu-west-1.amazonaws.com/printcloud.storage-test/dev/edi/c7a7638810cc70ab38e4e74690dc9553aac751d8_DHLExpress.pdf"
    }
  ],
  "trackingCode": "RT1235D",
  "trackingLink": "https://tracking_service.com/RT1235D"
}

Error response example

{
  "error": "invalid request"
}

Request

Parameter Type Description
orderId (required) string Gelato Order.id as provided in the Order Submit request

Success response

ShippingDocResponse

Parameter Type Description
documents (required) Document[] An array of documents.
trackingCode (optional) string Tracking code.
Sample: RT1235D.
trackingLink (optional) string Tracking link.
Sample: https://tracking_service.com/RT1235D.

Document

Parameter Type Description
type (required) string Type of the shipping document. Supported types: label, invoice.
Sample: label.
contentType (required) string Content type of the document. Possible values: application/pdf.
Sample: application/pdf.
format (required) string Format of the document. Possible values: pdf.
Sample: pdf.
url (required) string HTTPS link to the document valid for 7 days.
Sample: https://s3-eu-west-1.amazonaws.com/printcloud.storage-test/dev/edi/c7a7638810cc70ab38e4e74690dc9553aac751d8_DHLExpress.pdf.

Error response

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