Skip to content
/
Update a consignment

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

List all consignments

Request

You can use this API call to retrieve the list of consignments in Scurri.

Pagination is provided via the offset and limit GET parameters.

For the offset, we don't use an integer value but instead use the last identifier of the current batch. The next value returned with the response body contains a URL you can use to retrieve the next batch.

Example offset URL: https://sandbox.scurri.co.uk/api/v1/company/test-company/consignments/?offset=000ed1bfb93c43319ec79247f50dfd3c

You can also use this API call to search for consignments using specific criteria, either for a specific identifier or for consignments of a specific status. Searching by identifier only returns a single consignment.

The Despatched, Delivered and Exception statuses are only available if Tracking has been enabled on your account.

Security
TokenAuth
Path
company_slugstringrequired
Query
offsetstring

The offset for any pagination. This is the string identifier of the last consignment entry in the current batch. Default: ''.

limitinteger

How many results to return for a request. Default: 10.

statusstring

Search for consignments with a specific status.

Example: status=Unallocated
identifierstring

Search for the consignment with the given identifier.

Example: identifier=myidentifier
curl -i -X GET \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/consignments?offset=string&limit=0&status=Unallocated&identifier=myidentifier' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved list of consignments

Bodyapplication/json
countinteger

Total number of consignments matching the search criteria. Count will decrease with each subsequent page.

nextstring

URL to the next page of results, if available. Returned as None if no further pages are available.

Example: "https://sandbox.scurri.co.uk/api/v1/company/test-company/consignments/?offset=000ed1bfb93c43319ec79247f50dfd3c"
resultsArray of objects(ConsignmentResponse)

A list of consignments matching the search criteria.

Response
application/json
{
  "count": 0,
  "next": "https://sandbox.scurri.co.uk/api/v1/company/test-company/consignments/?offset=000ed1bfb93c43319ec79247f50dfd3c",
  "results": [
    { … }
  ]
}

Import a new consignment

Request

Creates a new consignment (shipment) for the company. The consignment can be allocated or unallocated, domestic or international.

Security
TokenAuth
Path
company_slugstringrequired
Bodyapplication/jsonArray [
identifierstring[ 1 .. 255 ] characters

Unique identifier for the consignment (shipment).

Example: "8a12630db404424b943e131ce4ee3976"
order_numberstring[ 1 .. 255 ] charactersrequired

Order number associated with the consignment.

Example: "ORD123456"
create_datestring(date-time)required

Date and time when the consignment was created.

expected_delivery_datestring(date)

Expected delivery date for the consignment.

carrierstring<= 64 characters

Carrier name or code.

Example: "Generic Carrier"
service_idstring<= 128 characters

Service identifier (e.g., carrier and service name).

Example: "Generic Carrier|Generic Domestic Service GDOM"
warehouse_idstring<= 64 characters

Warehouse identifier.

Example: "api-company-slug|Warehouse Name"
shipping_methodstring<= 255 characters

Shipping method.

shipping_datestring

Shipping date.

Example: "2019-08-24"
order_valuenumber>= 0

Value of the order.

Example: 100
currencystring= 3 characters

Currency code

Example: "EUR"
delivery_instructionsstring<= 255 characters

Delivery instructions for the carrier.

Example: "Leave with neighbour if not home"
custom_field_1string<= 100 characters

Custom field 1 for additional data.

custom_field_2string<= 100 characters

Custom field 2 for additional data.

custom_field_3string<= 100 characters

Custom field 3 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_4string<= 100 characters

Custom field 4 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_5string<= 100 characters

Custom field 5 for additional data. This field is available upon request. The standard number of custom fields is 2.

origin_order_referencestring<= 255 characters

Reference to the original order in your system.

Example: "REF123456"
recipientobjectrequired

Recipient details. At least one of 'name', 'last_name', or 'company_name' must be provided.

recipient.​namestring[ 1 .. 255 ] charactersrequired

Full name of the recipient.

Example: "John Doe"
recipient.​first_namestring<= 255 characters

First name of the recipient.

Example: ""
recipient.​last_namestring<= 255 characters

Last name of the recipient.

Example: "John Doe"
recipient.​company_namestring<= 255 characters

Company name of the recipient.

Example: "Scurri"
recipient.​email_addressstring(email)<= 300 characters

Email address of the recipient.

Example: "john.doe@scurri.com"
recipient.​contact_numberstring<= 40 characters

Contact number of the recipient.

Example: "+353 1 234 5678"
recipient.​tax_identifierstring<= 50 characters

Tax identifier for the recipient.

Example: "IE1234567"
recipient.​eori_numberstring<= 17 characters

EORI number for customs.

Example: "GB123456789123"
recipient.​addressobjectrequired

Recipient address details.

recipient.​address.​address1string<= 255 charactersrequired

Address line 1.

Example: "Innovation House"
recipient.​address.​address2string<= 100 characters

Address line 2.

Example: "The Bullring"
recipient.​address.​address3string<= 100 characters

Address line 3.

Example: ""
recipient.​address.​citystring<= 100 charactersrequired

City.

Example: "Wexford"
recipient.​address.​statestring<= 40 characters

State or region.

Example: "County Wexford"
recipient.​address.​postcodestring<= 64 charactersrequired

Postal code.

Example: "Y35 DW6E"
recipient.​address.​countrystring= 2 charactersrequired

Country code (ISO 2-letter).

Example: "IE"
recipient.​address.​store_codestring<= 50 characters

Store code if applicable.

Example: ""
packagesArray of objects(Package)

List of packages within the consignment.

export_customsobject

Export customs information. Only include field if the value is populated, do not include if the value is null/empty.

optionsobject(Options)

Carrier-specific options for a consignment. If an option does not apply to the carrier for the consignment, it is ignored. Note that options are not set if a consignment cannot be allocated to a carrier service.

invoiceobject(Invoice)
custom_attributesobject(CustomAttributes)

Additional fields to customise the consignment.

]
curl -i -X POST \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/consignments' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "identifier": "8a12630db404424b943e131ce4ee3976",
      "order_number": "ORD123456",
      "create_date": "2019-08-24T14:15:22Z",
      "expected_delivery_date": "2019-08-24",
      "carrier": "Generic Carrier",
      "service_id": "Generic Carrier|Generic Domestic Service GDOM",
      "warehouse_id": "api-company-slug|Warehouse Name",
      "shipping_method": "string",
      "shipping_date": "2019-08-24",
      "order_value": 100,
      "currency": "EUR",
      "delivery_instructions": "Leave with neighbour if not home",
      "custom_field_1": "string",
      "custom_field_2": "string",
      "custom_field_3": "string",
      "custom_field_4": "string",
      "custom_field_5": "string",
      "origin_order_reference": "REF123456",
      "recipient": {
        "name": "John Doe",
        "first_name": "",
        "last_name": "John Doe",
        "company_name": "Scurri",
        "email_address": "john.doe@scurri.com",
        "contact_number": "+353 1 234 5678",
        "tax_identifier": "IE1234567",
        "eori_number": "GB123456789123",
        "address": {
          "address1": "Innovation House",
          "address2": "The Bullring",
          "address3": "",
          "city": "Wexford",
          "state": "County Wexford",
          "postcode": "Y35 DW6E",
          "country": "IE",
          "store_code": ""
        }
      },
      "packages": [
        {
          "description": "Clothing items",
          "weight": 1,
          "weight_unit": "kg",
          "length": 5,
          "width": 2,
          "height": 10,
          "dimensions_unit": "cm",
          "items": [
            {
              "name": "T-Shirt",
              "sku": "SKU12345",
              "quantity": 2,
              "value": 10.99,
              "harmonisation_code": "0902.10",
              "country_of_origin": "GB",
              "weight": 500,
              "vat_rate": "string",
              "fabric_content": "100% Cotton",
              "import_type": "B2B",
              "mid_code": "GBSCU18WEX",
              "reference": "A72B",
              "taric_condition": "string"
            }
          ],
          "reference": "SC1234"
        }
      ],
      "export_customs": {
        "reason_for_export": "merchandise",
        "shipping_cost": "10.00",
        "ioss_number": "IM0123456789"
      },
      "options": {
        "signature_required": "true",
        "age_check": "false"
      },
      "invoice": {
        "incoterm": "DAP"
      },
      "custom_attributes": {
        "override_sender_name": "Subsidiary Ltd",
        "override_sender_eori": "GB123456789000",
        "global_e_order_id": "1234567890",
        "override_sender_address1": "123 Business Rd",
        "override_send_address2": "Business Park",
        "override_sender_address3": "West Wing",
        "override_sender_city": "London",
        "override_sender_state": "London",
        "override_sender_postcode": "D02 ABC",
        "override_sender_country": "GB",
        "override_sender_email": "info@subsidiary.com",
        "override_sender_phone": "+4412345678"
      }
    }
  ]'

Responses

The batch request was successfully received and processed by the application. Check the success array for successfully imported consignment identifiers and the errors object, which maps the failed item's original request index to a specific error message.

Bodyapplication/json
successArray of strings

List of identifiers for created consignments.

Example: ["8a12630db404424b943e131ce4ee3976"]
errorsany

A map of validation errors keyed by the zero-indexed position of the failed request item. Each value is an array of failure messages.

Example: {"0":["recipient: name: Ensure this value has at most 255 characters (it has 256)."],"1":["service_type: This field is required."]}
Response
application/json
{
  "success": [
    "8a12630db404424b943e131ce4ee3976"
  ],
  "errors": {
    "0": [ … ],
    "1": [ … ]
  }
}

Get consignment details

Request

Retrieves details of a specific consignment (shipment).

Security
TokenAuth
Path
company_slugstringrequired
shipmentIdentifierstring

Unique identifier for the consignment (shipment).

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

Responses

Consignment details successfully retrieved.

Bodyapplication/json
identifierstring[ 1 .. 255 ] characters

Unique identifier for the consignment (shipment).

Example: "8a12630db404424b943e131ce4ee3976"
order_numberstring[ 1 .. 255 ] characters

Order number associated with the consignment.

Example: "ORD123456"
create_datestring(date-time)

Date and time when the consignment was created.

expected_delivery_datestring(date)

Expected delivery date for the consignment.

carrierstring<= 64 characters

Carrier name or code.

Example: "Generic Carrier"
service_idstring<= 128 characters

Service identifier (e.g., carrier and service name).

Example: "Generic Carrier|Generic Domestic Service GDOM"
warehouse_idstring<= 64 characters

Warehouse identifier.

Example: "api-company-slug|Warehouse Name"
shipping_methodstring<= 255 characters

Shipping method.

shipping_datestring

Shipping date.

Example: "2019-08-24"
order_valuenumber>= 0

Value of the order.

Example: 100
currencystring= 3 characters

Currency code

Example: "EUR"
delivery_instructionsstring<= 255 characters

Delivery instructions for the carrier.

Example: "Leave with neighbour if not home"
custom_field_1string<= 100 characters

Custom field 1 for additional data.

custom_field_2string<= 100 characters

Custom field 2 for additional data.

custom_field_3string<= 100 characters

Custom field 3 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_4string<= 100 characters

Custom field 4 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_5string<= 100 characters

Custom field 5 for additional data. This field is available upon request. The standard number of custom fields is 2.

origin_order_referencestring<= 255 characters

Reference to the original order in your system.

Example: "REF123456"
recipientobject

Recipient details. At least one of 'name', 'last_name', or 'company_name' must be provided.

packagesArray of objects(Package)

List of packages within the consignment.

export_customsobject

Export customs information. Only include field if the value is populated, do not include if the value is null/empty.

optionsobject(Options)

Carrier-specific options for a consignment. If an option does not apply to the carrier for the consignment, it is ignored. Note that options are not set if a consignment cannot be allocated to a carrier service.

invoiceobject(Invoice)
custom_attributesobject(CustomAttributes)

Additional fields to customise the consignment.

Response
application/json
{
  "identifier": "8a12630db404424b943e131ce4ee3976",
  "order_number": "ORD123456",
  "create_date": "2019-08-24T14:15:22Z",
  "expected_delivery_date": "2019-08-24",
  "carrier": "Generic Carrier",
  "service_id": "Generic Carrier|Generic Domestic Service GDOM",
  "warehouse_id": "api-company-slug|Warehouse Name",
  "shipping_method": "string",
  "shipping_date": "2019-08-24",
  "order_value": 100,
  "currency": "EUR",
  "delivery_instructions": "Leave with neighbour if not home",
  "custom_field_1": "string",
  "custom_field_2": "string",
  "custom_field_3": "string",
  "custom_field_4": "string",
  "custom_field_5": "string",
  "origin_order_reference": "REF123456",
  "recipient": {
    "name": "John Doe",
    "first_name": "",
    "last_name": "John Doe",
    "company_name": "Scurri",
    "email_address": "john.doe@scurri.com",
    "contact_number": "+353 1 234 5678",
    "tax_identifier": "IE1234567",
    "eori_number": "GB123456789123",
    "address": { … }
  },
  "packages": [
    { … }
  ],
  "export_customs": {
    "reason_for_export": "merchandise",
    "shipping_cost": "10.00",
    "ioss_number": "IM0123456789"
  },
  "options": {
    "signature_required": "true",
    "age_check": "false"
  },
  "invoice": {
    "incoterm": "DAP"
  },
  "custom_attributes": {
    "override_sender_name": "Subsidiary Ltd",
    "override_sender_eori": "GB123456789000",
    "global_e_order_id": "1234567890",
    "override_sender_address1": "123 Business Rd",
    "override_send_address2": "Business Park",
    "override_sender_address3": "West Wing",
    "override_sender_city": "London",
    "override_sender_state": "London",
    "override_sender_postcode": "D02 ABC",
    "override_sender_country": "GB",
    "override_sender_email": "info@subsidiary.com",
    "override_sender_phone": "+4412345678"
  }
}

Update a consignment

Request

Updates a consignment. Can be used to allocate or unallocate the consignment.

Security
TokenAuth
Path
company_slugstring
shipmentIdentifierstring

Unique identifier for the consignment (shipment).

Bodyapplication/json
identifierstring[ 1 .. 255 ] characters

Unique identifier for the consignment (shipment).

Example: "8a12630db404424b943e131ce4ee3976"
order_numberstring[ 1 .. 255 ] charactersrequired

Order number associated with the consignment.

Example: "ORD123456"
create_datestring(date-time)required

Date and time when the consignment was created.

expected_delivery_datestring(date)

Expected delivery date for the consignment.

carrierstring<= 64 characters

Carrier name or code.

Example: "Generic Carrier"
service_idstring<= 128 characters

Service identifier (e.g., carrier and service name).

Example: "Generic Carrier|Generic Domestic Service GDOM"
warehouse_idstring<= 64 characters

Warehouse identifier.

Example: "api-company-slug|Warehouse Name"
shipping_methodstring<= 255 characters

Shipping method.

shipping_datestring

Shipping date.

Example: "2019-08-24"
order_valuenumber>= 0

Value of the order.

Example: 100
currencystring= 3 characters

Currency code

Example: "EUR"
delivery_instructionsstring<= 255 characters

Delivery instructions for the carrier.

Example: "Leave with neighbour if not home"
custom_field_1string<= 100 characters

Custom field 1 for additional data.

custom_field_2string<= 100 characters

Custom field 2 for additional data.

custom_field_3string<= 100 characters

Custom field 3 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_4string<= 100 characters

Custom field 4 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_5string<= 100 characters

Custom field 5 for additional data. This field is available upon request. The standard number of custom fields is 2.

origin_order_referencestring<= 255 characters

Reference to the original order in your system.

Example: "REF123456"
recipientobjectrequired

Recipient details. At least one of 'name', 'last_name', or 'company_name' must be provided.

recipient.​namestring[ 1 .. 255 ] charactersrequired

Full name of the recipient.

Example: "John Doe"
recipient.​first_namestring<= 255 characters

First name of the recipient.

Example: ""
recipient.​last_namestring<= 255 characters

Last name of the recipient.

Example: "John Doe"
recipient.​company_namestring<= 255 characters

Company name of the recipient.

Example: "Scurri"
recipient.​email_addressstring(email)<= 300 characters

Email address of the recipient.

Example: "john.doe@scurri.com"
recipient.​contact_numberstring<= 40 characters

Contact number of the recipient.

Example: "+353 1 234 5678"
recipient.​tax_identifierstring<= 50 characters

Tax identifier for the recipient.

Example: "IE1234567"
recipient.​eori_numberstring<= 17 characters

EORI number for customs.

Example: "GB123456789123"
recipient.​addressobjectrequired

Recipient address details.

recipient.​address.​address1string<= 255 charactersrequired

Address line 1.

Example: "Innovation House"
recipient.​address.​address2string<= 100 characters

Address line 2.

Example: "The Bullring"
recipient.​address.​address3string<= 100 characters

Address line 3.

Example: ""
recipient.​address.​citystring<= 100 charactersrequired

City.

Example: "Wexford"
recipient.​address.​statestring<= 40 characters

State or region.

Example: "County Wexford"
recipient.​address.​postcodestring<= 64 charactersrequired

Postal code.

Example: "Y35 DW6E"
recipient.​address.​countrystring= 2 charactersrequired

Country code (ISO 2-letter).

Example: "IE"
recipient.​address.​store_codestring<= 50 characters

Store code if applicable.

Example: ""
packagesArray of objects(Package)

List of packages within the consignment.

export_customsobject

Export customs information. Only include field if the value is populated, do not include if the value is null/empty.

optionsobject(Options)

Carrier-specific options for a consignment. If an option does not apply to the carrier for the consignment, it is ignored. Note that options are not set if a consignment cannot be allocated to a carrier service.

invoiceobject(Invoice)
custom_attributesobject(CustomAttributes)

Additional fields to customise the consignment.

curl -i -X PUT \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identifier": "8a12630db404424b943e131ce4ee3976",
    "order_number": "ORD123456",
    "create_date": "2019-08-24T14:15:22Z",
    "expected_delivery_date": "2019-08-24",
    "carrier": "Generic Carrier",
    "service_id": "Generic Carrier|Generic Domestic Service GDOM",
    "warehouse_id": "api-company-slug|Warehouse Name",
    "shipping_method": "string",
    "shipping_date": "2019-08-24",
    "order_value": 100,
    "currency": "EUR",
    "delivery_instructions": "Leave with neighbour if not home",
    "custom_field_1": "string",
    "custom_field_2": "string",
    "custom_field_3": "string",
    "custom_field_4": "string",
    "custom_field_5": "string",
    "origin_order_reference": "REF123456",
    "recipient": {
      "name": "John Doe",
      "first_name": "",
      "last_name": "John Doe",
      "company_name": "Scurri",
      "email_address": "john.doe@scurri.com",
      "contact_number": "+353 1 234 5678",
      "tax_identifier": "IE1234567",
      "eori_number": "GB123456789123",
      "address": {
        "address1": "Innovation House",
        "address2": "The Bullring",
        "address3": "",
        "city": "Wexford",
        "state": "County Wexford",
        "postcode": "Y35 DW6E",
        "country": "IE",
        "store_code": ""
      }
    },
    "packages": [
      {
        "description": "Clothing items",
        "weight": 1,
        "weight_unit": "kg",
        "length": 5,
        "width": 2,
        "height": 10,
        "dimensions_unit": "cm",
        "items": [
          {
            "name": "T-Shirt",
            "sku": "SKU12345",
            "quantity": 2,
            "value": 10.99,
            "harmonisation_code": "0902.10",
            "country_of_origin": "GB",
            "weight": 500,
            "vat_rate": "string",
            "fabric_content": "100% Cotton",
            "import_type": "B2B",
            "mid_code": "GBSCU18WEX",
            "reference": "A72B",
            "taric_condition": "string"
          }
        ],
        "reference": "SC1234"
      }
    ],
    "export_customs": {
      "reason_for_export": "merchandise",
      "shipping_cost": "10.00",
      "ioss_number": "IM0123456789"
    },
    "options": {
      "signature_required": "true",
      "age_check": "false"
    },
    "invoice": {
      "incoterm": "DAP"
    },
    "custom_attributes": {
      "override_sender_name": "Subsidiary Ltd",
      "override_sender_eori": "GB123456789000",
      "global_e_order_id": "1234567890",
      "override_sender_address1": "123 Business Rd",
      "override_send_address2": "Business Park",
      "override_sender_address3": "West Wing",
      "override_sender_city": "London",
      "override_sender_state": "London",
      "override_sender_postcode": "D02 ABC",
      "override_sender_country": "GB",
      "override_sender_email": "info@subsidiary.com",
      "override_sender_phone": "+4412345678"
    }
  }'

Responses

Consignment updated successfully. Returns the updated consignment details.

Bodyapplication/json
identifierstring[ 1 .. 255 ] characters

Unique identifier for the consignment (shipment).

Example: "8a12630db404424b943e131ce4ee3976"
order_numberstring[ 1 .. 255 ] characters

Order number associated with the consignment.

Example: "ORD123456"
create_datestring(date-time)

Date and time when the consignment was created.

expected_delivery_datestring(date)

Expected delivery date for the consignment.

carrierstring<= 64 characters

Carrier name or code.

Example: "Generic Carrier"
service_idstring<= 128 characters

Service identifier (e.g., carrier and service name).

Example: "Generic Carrier|Generic Domestic Service GDOM"
warehouse_idstring<= 64 characters

Warehouse identifier.

Example: "api-company-slug|Warehouse Name"
shipping_methodstring<= 255 characters

Shipping method.

shipping_datestring

Shipping date.

Example: "2019-08-24"
order_valuenumber>= 0

Value of the order.

Example: 100
currencystring= 3 characters

Currency code

Example: "EUR"
delivery_instructionsstring<= 255 characters

Delivery instructions for the carrier.

Example: "Leave with neighbour if not home"
custom_field_1string<= 100 characters

Custom field 1 for additional data.

custom_field_2string<= 100 characters

Custom field 2 for additional data.

custom_field_3string<= 100 characters

Custom field 3 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_4string<= 100 characters

Custom field 4 for additional data. This field is available upon request. The standard number of custom fields is 2.

custom_field_5string<= 100 characters

Custom field 5 for additional data. This field is available upon request. The standard number of custom fields is 2.

origin_order_referencestring<= 255 characters

Reference to the original order in your system.

Example: "REF123456"
recipientobject

Recipient details. At least one of 'name', 'last_name', or 'company_name' must be provided.

packagesArray of objects(Package)

List of packages within the consignment.

export_customsobject

Export customs information. Only include field if the value is populated, do not include if the value is null/empty.

optionsobject(Options)

Carrier-specific options for a consignment. If an option does not apply to the carrier for the consignment, it is ignored. Note that options are not set if a consignment cannot be allocated to a carrier service.

invoiceobject(Invoice)
custom_attributesobject(CustomAttributes)

Additional fields to customise the consignment.

Response
application/json
{
  "identifier": "8a12630db404424b943e131ce4ee3976",
  "order_number": "ORD123456",
  "create_date": "2019-08-24T14:15:22Z",
  "expected_delivery_date": "2019-08-24",
  "carrier": "Generic Carrier",
  "service_id": "Generic Carrier|Generic Domestic Service GDOM",
  "warehouse_id": "api-company-slug|Warehouse Name",
  "shipping_method": "string",
  "shipping_date": "2019-08-24",
  "order_value": 100,
  "currency": "EUR",
  "delivery_instructions": "Leave with neighbour if not home",
  "custom_field_1": "string",
  "custom_field_2": "string",
  "custom_field_3": "string",
  "custom_field_4": "string",
  "custom_field_5": "string",
  "origin_order_reference": "REF123456",
  "recipient": {
    "name": "John Doe",
    "first_name": "",
    "last_name": "John Doe",
    "company_name": "Scurri",
    "email_address": "john.doe@scurri.com",
    "contact_number": "+353 1 234 5678",
    "tax_identifier": "IE1234567",
    "eori_number": "GB123456789123",
    "address": { … }
  },
  "packages": [
    { … }
  ],
  "export_customs": {
    "reason_for_export": "merchandise",
    "shipping_cost": "10.00",
    "ioss_number": "IM0123456789"
  },
  "options": {
    "signature_required": "true",
    "age_check": "false"
  },
  "invoice": {
    "incoterm": "DAP"
  },
  "custom_attributes": {
    "override_sender_name": "Subsidiary Ltd",
    "override_sender_eori": "GB123456789000",
    "global_e_order_id": "1234567890",
    "override_sender_address1": "123 Business Rd",
    "override_send_address2": "Business Park",
    "override_sender_address3": "West Wing",
    "override_sender_city": "London",
    "override_sender_state": "London",
    "override_sender_postcode": "D02 ABC",
    "override_sender_country": "GB",
    "override_sender_email": "info@subsidiary.com",
    "override_sender_phone": "+4412345678"
  }
}

Cancel a consignment

Request

Cancels a consignment, taking any necessary actions on the carrier side

Security
TokenAuth
Path
company_slugstringrequired
shipmentIdentifierstring

Unique identifier for the consignment (shipment).

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

Responses

Consignment cancelled successfully.

Response
No content

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