Skip to content
/
Get consignment documents

Scurri Platform API (1.0.0)

This API allows you to manage consignments, including creating, updating, and retrieving details about shipments including labels and customs invoices.

Authentication

All requests must be authenticated using either Basic Auth or API token-based authentication. If you have been provided with an API token, you should use token-based authentication.

API Token

With API token-based authentication, you must include the token in the Authorization header as an API token, e.g. Authorization: token YOUR_API_TOKEN. Failed requests will return a 401 HTTP code with WWW-Authenticate: Basic response header.

Basic Auth

With Basic Auth, you have to send the username and password base64-encoded in the standard Basic manner, e.g. Authorization: Basic YXBpdGVzdDphcGkgcGFzc3dvcmQgdGVzdA==.

Here is some sample code in Python to generate the value of the header: ```python`

import base64 username = 'apitest' password = 'api-test-password' print(base64.b64encode((username + ':' + password).encode()).decode()) YXBpdGVzdDphcGktdGVzdC1wYXNzd29yZA==

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/
Scurri Sandbox Environment
https://sandbox.scurri.co.uk/

Carriers

The Carriers API allows you to query Scurri for the carriers that are enabled in your account.

The result contains the identifier for each carrier, which you can use in the rest of the API calls, whenever a Carrier needs to be specified. The identifier will never change, so this can be called once to get the values.

Operations

Carrier Services

The Carrier Services API allows you to query Scurri for the services that are available for each carrier.

The result contains the identifier for each service, which you can use in the rest of the API calls, whenever a Carrier Service needs to be specified.

Operations

Warehouses

The Warehouses API allows you to retrieve a list of warehouses that you have access to (within a company).

The result contains the identifier for each warehouse, which you can use in the rest of the API calls, whenever a Warehouse needs to be specified.

Operations

Consignments

This group of API calls allow you to interact with your consignments in Scurri. You can list and search through them, create new ones, update existing ones, and retrieve their details. To see consignment documents, go to the Consignment Documents section.

Operations

Consignment Documents

You can use this API call to get the label and any customs invoice documents required for a specific consignment, if required.

Keep in mind that a label will be created for each package of the consignment.

Operations

Available label formats

The resulting documents are returned as strings within the JSON response. These are plaintext in the case of ZPL labels, all other formats are base64-encoded binary files. Labels can be provided in the following formats:

  • PDF: One PDF returned with multiple labels concatenated in a single document (one label per page)
  • ZPL: Can be configured as 230 or 300 DPI resolution. It's also possible to specify the required label resolution or compress the label in the request.
  • PNG: A ZIP file is returned containing all files
  • PNG list: Single file PNGs (non-zipped)

Alternative label formats are also available, for example 8"x4". To enable this feature on your account, contact Scurri support. Once enabled the label customisation parameter can be used.

The label format can be specified in the documenttype query parameter, which can take the following values:

  • PDF: application/pdf
  • ZPL: application/x-zebra-zpl
  • PNG: image/png
  • PNG list: image/x-png-list

Customs Invoice Documents

Scurri will return the documents the carrier requires, only if the carrier does require them for the specific consignment.Another thing to note about customs invoice documents is that they can be either in a 6"x4" size (for thermal printer) or in an A4 size (for a document printer). Your account can be configured, so that 6"x4" thermal invoices can be concatenated with the respective label. This makes it easier to send each file to the correct printer. Note that setting documenttype to application/x-zebra-zpl only impacts labels, not invoices - they remain PDF as they are A4.

Natively Supported ZPL Carriers

  • An Post
  • Colissimo
  • Deutsche Post
  • DPD
  • DPD Germany
  • DPD Ireland
  • DX
  • Fastway
  • Generic Carrier
  • Hermes
  • Interlink
  • ITD Carrier
  • P2P Trakpak
  • ParcelForce
  • PostNL
  • Royal Mail
  • Spring Global
  • TNT
  • Tuffnells
  • UKMail
  • Yodel

Get consignment documents

Request

Retrieves documents (e.g., labels) for a consignment. Supports filtering by document type and invoice quantity.

Security
TokenAuth
Path
shipmentIdentifierstring

Unique identifier for the consignment (shipment).

company_slugstring
Query
documenttypestring

Document MIME type (e.g., application/x-zebra-zpl)

Default "application/pdf"
Enum"application/pdf""image/png""application/x-zebra-zpl""image/x-png-list"
invoice_quantityinteger

Number of invoices to include

curl -i -X GET \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}/documents?documenttype=application%2Fpdf&invoice_quantity=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved consignment label and invoice documents.

Bodyapplication/json
labelsstring(byte)

Plaintext or base64-encoded string containing label data for the consignment. Format depends on the requested document type (PDF, PNG, ZPL, etc.).

invoicesstring(byte)

Base64-encoded invoice data for the consignment, if required by the carrier/destination. May be null if not applicable.

Response
application/json
{
  "labels": "string",
  "invoices": "string"
}

Manifests

The manifest process marks a list of consignments as ready to be picked up by the carrier. A manifest always refers to a specific warehouse and carrier. Scurri abstracts away the necessary actions and documentation a carrier needs and presents a common interface for the manifest process.

The endpoints in this section allow you to create a manifest for given consignments, and retrieve any relevant documents

Operations