# List all consignments

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.

Endpoint: GET /_api/v1/company/{company_slug}/consignments
Version: 1.0.0
Security: TokenAuth

## Path parameters:

  - `company_slug` (string, required)

## Query parameters:

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

  - `limit` (integer)
    How many results to return for a request. Default: 10.

  - `status` (string)
    Search for consignments with a specific status.
    Example: "Unallocated"

  - `identifier` (string)
    Search for the consignment with the given identifier.
    Example: "myidentifier"

## Response 200 fields (application/json):

  - `count` (integer)
    Total number of consignments matching the search criteria. Count will decrease with each subsequent page.

  - `next` (string)
    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"

  - `results` (array)
    A list of consignments matching the search criteria.

  - `results.identifier` (string)
    Unique identifier for the consignment (shipment).
    Example: "8a12630db404424b943e131ce4ee3976"

  - `results.order_number` (string)
    Order number associated with the consignment.
    Example: "ORD123456"

  - `results.create_date` (string)
    Date and time when the consignment was created.

  - `results.expected_delivery_date` (string)
    Expected delivery date for the consignment.

  - `results.carrier` (string)
    Carrier name or code.
    Example: "Generic Carrier"

  - `results.service_id` (string)
    Service identifier (e.g., carrier and service name).
    Example: "Generic Carrier|Generic Domestic Service GDOM"

  - `results.warehouse_id` (string)
    Warehouse identifier.
    Example: "api-company-slug|Warehouse Name"

  - `results.shipping_method` (string)
    Shipping method.

  - `results.shipping_date` (string)
    Shipping date.
    Example: "2019-08-24"

  - `results.order_value` (number)
    Value of the order.
    Example: 100

  - `results.currency` (string)
    Currency code
    Example: "EUR"

  - `results.delivery_instructions` (string)
    Delivery instructions for the carrier.
    Example: "Leave with neighbour if not home"

  - `results.custom_field_1` (string)
    Custom field 1 for additional data.

  - `results.custom_field_2` (string)
    Custom field 2 for additional data.

  - `results.custom_field_3` (string)
    Custom field 3 for additional data. This field is available upon request. The standard number of custom fields is 2.

  - `results.custom_field_4` (string)
    Custom field 4 for additional data. This field is available upon request. The standard number of custom fields is 2.

  - `results.custom_field_5` (string)
    Custom field 5 for additional data. This field is available upon request. The standard number of custom fields is 2.

  - `results.origin_order_reference` (string)
    Reference to the original order in your system.
    Example: "REF123456"

  - `results.recipient` (object)
    Recipient details. At least one of 'name', 'last_name', or 'company_name' must be provided.

  - `results.recipient.name` (string, required)
    Full name of the recipient.
    Example: "John Doe"

  - `results.recipient.first_name` (string)
    First name of the recipient.

  - `results.recipient.last_name` (string)
    Last name of the recipient.
    Example: "John Doe"

  - `results.recipient.company_name` (string)
    Company name of the recipient.
    Example: "Scurri"

  - `results.recipient.email_address` (string)
    Email address of the recipient.
    Example: "john.doe@scurri.com"

  - `results.recipient.contact_number` (string)
    Contact number of the recipient.
    Example: "+353 1 234 5678"

  - `results.recipient.tax_identifier` (string)
    Tax identifier for the recipient.
    Example: "IE1234567"

  - `results.recipient.eori_number` (string)
    EORI number for customs.
    Example: "GB123456789123"

  - `results.recipient.address` (object, required)
    Recipient address details.

  - `results.recipient.address.address1` (string, required)
    Address line 1.
    Example: "Innovation House"

  - `results.recipient.address.address2` (string)
    Address line 2.
    Example: "The Bullring"

  - `results.recipient.address.address3` (string)
    Address line 3.

  - `results.recipient.address.city` (string, required)
    City.
    Example: "Wexford"

  - `results.recipient.address.state` (string)
    State or region.
    Example: "County Wexford"

  - `results.recipient.address.postcode` (string, required)
    Postal code.
    Example: "Y35 DW6E"

  - `results.recipient.address.country` (string, required)
    Country code (ISO 2-letter).
    Example: "IE"

  - `results.recipient.address.store_code` (string)
    Store code if applicable.

  - `results.packages` (array)
    List of packages within the consignment.

  - `results.packages.description` (string)
    General description of the contents of the package.
    Example: "Clothing items"

  - `results.packages.weight` (number)
    Numeric weight of the package
    Example: 1

  - `results.packages.weight_unit` (string)
    Unit of weight
    Enum: "g", "kg"

  - `results.packages.length` (number)
    Numeric length of the package
    Example: 5

  - `results.packages.width` (number)
    Numeric width of the package
    Example: 2

  - `results.packages.height` (number)
    Numeric height of the package
    Example: 10

  - `results.packages.dimensions_unit` (string)
    Unit of dimensions
    Enum: "mm", "cm", "m", "in", "ft"

  - `results.packages.tracking_number` (string)
    Unique identifier assigned by the carrier for tracking the package, if per-package tracking is supported. Read-only.
    Example: "1Z12345E0205271688"

  - `results.packages.items` (array)
    List of items in the package.

  - `results.packages.items.name` (string, required)
    The item name.
    Example: "T-Shirt"

  - `results.packages.items.sku` (string)
    SKU (Stock Keeping Unit) of the item.
    Example: "SKU12345"

  - `results.packages.items.quantity` (integer, required)
    Quantity of the item in the package.
    Example: 2

  - `results.packages.items.value` (number)
    unit value of the item
    Example: 10.99

  - `results.packages.items.harmonisation_code` (string)
    'Standard harmonisation code of the item for tariff '
'purposes. Only required if sending to an international '
'destination.'
    Example: "0902.10"

  - `results.packages.items.country_of_origin` (string)
    Country of origin for the item (ISO 2-letter code).
    Example: "GB"

  - `results.packages.items.weight` (number)
    Weight of the item
    Example: 500

  - `results.packages.items.vat_rate` (string)
    VAT rate applicable to the item.

  - `results.packages.items.fabric_content` (string)
    Fabric content of the item
    Example: "100% Cotton"

  - `results.packages.items.import_type` (string)
    Import type for the item
    Example: "B2B"

  - `results.packages.items.mid_code` (string)
    MID (Manufacturer Identification) code for the item.
    Example: "GBSCU18WEX"

  - `results.packages.items.reference` (string)
    A field for your own internal reference
    Example: "A72B"

  - `results.packages.items.taric_condition` (string)
    TARIC (EU Tariff) code for the item.

  - `results.packages.reference` (string)
    The package reference. This field is for associating your internal packages with Scurri packages.
The reference doesn't need to be unique per company or per item.
    Example: "SC1234"

  - `results.export_customs` (object)
    Export customs information. Only include field if the value is populated, do not include if the value is null/empty.

  - `results.export_customs.reason_for_export` (string)
    The reason for export or purpose of shipment for customs clearance.
    Enum: "merchandise", "sample", "documents", "gift", "other", "returns", "personal"

  - `results.export_customs.shipping_cost` (string)
    Shipping cost for customs declaration.
    Example: "10.00"

  - `results.export_customs.ioss_number` (string)
    IOSS number for international shipments.
    Example: "IM0123456789"

  - `results.options` (object)
    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.

  - `results.invoice` (object)

  - `results.invoice.incoterm` (string)
    Incoterm for the invoice.
    Example: "DAP"

  - `results.custom_attributes` (object)
    Additional fields to customise the consignment.

  - `results.custom_attributes.override_sender_name` (string)
    Replaces your company's name on labels and customs documentation for this consignment.
    Example: "Subsidiary Ltd"

  - `results.custom_attributes.override_sender_eori` (string)
    Replaces your company's EORI number on customs documentation for this consignment.
    Example: "GB123456789000"

  - `results.custom_attributes.global_e_order_id` (string)
    Global-e order ID for consignments fulfilled through Global-e.
    Example: "1234567890"

  - `results.custom_attributes.override_sender_address1` (string)
    Replaces address line 1 of your company's address on labels and customs documentation for this consignment.
    Example: "123 Business Rd"

  - `results.custom_attributes.override_send_address2` (string)
    Replaces address line 2 of your company's address on labels and customs documentation for this consignment.
    Example: "Business Park"

  - `results.custom_attributes.override_sender_address3` (string)
    Replaces address line 3 of your company's address on labels and customs documentation for this consignment.
    Example: "West Wing"

  - `results.custom_attributes.override_sender_city` (string)
    Replaces the city of your company's address on labels and customs documentation for this consignment.
    Example: "London"

  - `results.custom_attributes.override_sender_state` (string)
    Replaces the state/region of your company's address on labels and customs documentation for this consignment.
    Example: "London"

  - `results.custom_attributes.override_sender_postcode` (string)
    Replaces the postcode of your company's address on labels and customs documentation for this consignment.
    Example: "D02 ABC"

  - `results.custom_attributes.override_sender_country` (string)
    Replaces the country of your company's address on labels and customs documentation for this consignment.
    Example: "GB"

  - `results.custom_attributes.override_sender_email` (string)
    Replaces the email address of your company on labels and customs documentation for this consignment.
    Example: "info@subsidiary.com"

  - `results.custom_attributes.override_sender_phone` (string)
    Replaces the phone number of your company on labels and customs documentation for this consignment.
    Example: "+4412345678"

## Response 401 fields (application/json):

  - `detail` (string)
    Unauthorized error message."