# Get consignment details

Retrieves details of a specific consignment (shipment).

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

## Path parameters:

  - `company_slug` (string, required)

  - `shipmentIdentifier` (string)
    Unique identifier for the consignment (shipment).

## Response 200 fields (application/json):

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

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

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

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

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

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

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

  - `shipping_method` (string)
    Shipping method.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `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"

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

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

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

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

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

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

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

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

  - `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"

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

  - `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"

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

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

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

  - `invoice` (object)

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

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

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

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

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

  - `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"

  - `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"

  - `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"

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

  - `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"

  - `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"

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

  - `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"

  - `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)
    Permission denied error message.

## Response 404 fields (application/json):

  - `detail` (string)
    Not found error message.