# Get a carrier large contract by contract id

Endpoint: GET /largeContracts/{contractId}
Version: 1.0.0
Security: M2X_auth_application

## Path parameters:

  - `contractId` (string, required)
    M2X large contract id

## Response 200 fields (application/json):

  - `contractId` (string)

  - `externalId` (string,null)

  - `bookingId` (string,null)

  - `customerBookingId` (string,null)

  - `branches` (array)

  - `branches.id` (string)

  - `branches.name` (string,null)

  - `created` (string,null)

  - `updated` (string,null)

  - `customerId` (string)
    Carrier customer id for this contract

  - `customerName` (string)
    Carrier customer name for this contract

  - `productCode` (string,null)
    M2X internal tracking id for the product code used

  - `productCodeName` (string,null)
    M2X name for the product code used

  - `productCodeExternalId` (string,null)
    External Id for product tracking

  - `productComponents` (any)

  - `properties` (object,null)
    A key value store containing custom properties

  - `quantity` (number)
    The product quantity

  - `fromLocation` (object)

  - `fromLocation.addressText` (string, required)

  - `fromLocation.latitude` (number, required)

  - `fromLocation.longitude` (number, required)

  - `fromLocation.locationName` (string, required)

  - `fromLocation.locationId` (string,null)
    The M2X internal location id. When a location is manually created in M2X, this is a randomly generated unique identifier. If creating locations via API, the caller can set the Location ID.

  - `fromLocation.externalId` (string,null)
    An optional external identifier assigned to the location. This ID can be provided when creating the location and is typically used for cross-system referencing or integration with external data sources.

  - `fromLocation.timezone` (string)
    IANA (aka TZ database) timezone name
    Example: "Pacific/Auckland"

  - `fromLocation.properties` (object,null)

  - `fromTimeConstraint` (any)

  - `toLocation` (object)

  - `toTimeConstraint` (any)

  - `noteLong` (string,null)
    Long note

  - `noteShort` (string,null)
    Short note

  - `priceTotal` (number,null)
    Total transport price. Use priceTotal OR pricePerUnit + priceUnitOfMeasure

  - `pricePerUnit` (number,null)
    Transport price per unit

  - `priceUnitOfMeasure` (string,null)
    Unit of measure used for transport pricing e.g. metric values ea, t, kg, m3, km and imperial values ea, tn, cwt, lb, ft3, mi

  - `adjustmentPriceTotal` (number,null)
    Total adjustment price when specifying a fixed price. Use adjustmentPriceTotal OR adjustmentPricePerUnit + adjustmentPriceUnitOfMeasure

  - `adjustmentPricePerUnit` (number,null)
    Price per unit

  - `adjustmentPriceUnitOfMeasure` (string,null)
    Unit of measure used for adjustment pricing e.g. no value allows adjustmentPricePerUnit to be specified as a decimal percentage of transport total price, metric values t, kg, km and imperial values tn, cwt, lb, mi

  - `transportPricePerUnit` (number,null)
    Transport price per unit

  - `validFromDate` (string,null)
    The date this contract is valid from

  - `requiredByDate` (string,null)
    The date this contract needs to be completed by

  - `completed` (boolean)
    True if the contract has been completed

  - `draft` (boolean)
    True if the contract is a draft

## Response 404 fields (application/json):

  - `message` (string)
    Example: "not found"