Skip to content
/
Get documents for a speci...

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

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

Create a new manifest

Request

Initiates the manifest process for a given carrier and warehouse, specifying the consignments to include in the manifest.

Security
TokenAuth
Path
company_slugstringrequired
Bodyapplication/jsonrequired
warehouse_idstring

Unique identifier for the warehouse.

Example: "api-test-company|Test Warehouse"
carrier_idstring

Unique identifier for the carrier.

Example: "Generic Carrier"
consignmentsArray of strings

List of consignment identifiers to include in the manifest.

Example: ["8a12630db404424b943e131ce4ee3976","8a12630db404424b943e131ce4ee3978"]
curl -i -X POST \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/manifest' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "warehouse_id": "api-test-company|Test Warehouse",
    "carrier_id": "Generic Carrier",
    "consignments": [
      "8a12630db404424b943e131ce4ee3976",
      "8a12630db404424b943e131ce4ee3978"
    ]
  }'

Responses

Manifest created successfully.

Bodyapplication/json
identifierstring

Unique identifier for the created manifest.

Example: "2432"
Response
application/json
{
  "identifier": "2432"
}

Get documents for a specific manifest

Request

You can use this API call to get the manifest documentation (as an A4-size PDF file) that you need to hand-in to the carrier.

Scurri will return the correct documentation for the specified carrier.

Keep in mind that, because the document generation is kicked off asynchronously by the previous API call, the documents may not be ready, when you execute this API call. In that case, you should retry after a while.

Security
TokenAuth
Path
company_slugstringrequired
manifest_idstringrequired

Unique identifier for the manifest.

curl -i -X GET \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/manifest/{manifest_id}/documents' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Documents retrieved successfully.

Bodyapplication/json
documentsArray of strings
Response
application/json
{
  "documents": [
    "string"
  ]
}