# 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.


## List all consignments

 - [GET /_api/v1/company/{company_slug}/consignments](https://docs.scurri.com/connect/consignments-api/versions/1.0.0/openapi/consignments/listconsignments.md): 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.

## Import a new consignment

 - [POST /_api/v1/company/{company_slug}/consignments](https://docs.scurri.com/connect/consignments-api/versions/1.0.0/openapi/consignments/importconsignment.md): Creates a new consignment (shipment) for the company. The consignment can be allocated or unallocated, domestic or international.

## Get consignment details

 - [GET /_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}](https://docs.scurri.com/connect/consignments-api/versions/1.0.0/openapi/consignments/getconsignmentdetails.md): Retrieves details of a specific consignment (shipment).

## Update a consignment

 - [PUT /_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}](https://docs.scurri.com/connect/consignments-api/versions/1.0.0/openapi/consignments/updateconsignment.md): Updates a consignment. Can be used to allocate or unallocate the consignment.

## Cancel a consignment

 - [DELETE /_api/v1/company/{company_slug}/consignment/{shipmentIdentifier}](https://docs.scurri.com/connect/consignments-api/versions/1.0.0/openapi/consignments/cancelconsignment.md): Cancels a consignment, taking any necessary actions on the carrier side