# Get a carrier order by id

Endpoint: GET /orders/{orderId}
Version: 1.0.0
Security: M2X_auth_application

## Path parameters:

  - `orderId` (string, required)
    Internal M2X order id

## Response 200 fields (application/json):

  - `orderId` (string)

  - `deleted` (boolean)

  - `canceled` (boolean)

  - `cancellationNotes` (string,null)

  - `cancellationReason` (string,null)

  - `agent` (any)

  - `attachments` (array)

  - `bookingId` (string,null)

  - `customerBookingId` (string,null)

  - `bookingEntityId` (string)

  - `carrierId` (string)

  - `consignmentId` (string,null)

  - `customerId` (string)
    Internal ID of the customer associated with this order

  - `customerExternalId` (string,null)
    External ID of the customer associated with this order

  - `customerIntegrationId` (string,null)
    Integration ID of the customer associated with this order

  - `customerName` (string,null)
    Name of the customer associated with this order

  - `created` (string)

  - `createdBy` (string,null)
    The name of the user who created the order

  - `updated` (string)

  - `externalId` (string,null)

  - `externalNote` (string,null)

  - `largeContractId` (string,null)

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

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

  - `productComponents` (any)
    The sub components of the product if present

  - `quantity` (number)
    The product quantity

  - `legs` (array)

  - `legs.fromLocation` (object, required)

  - `legs.fromLocation.addressText` (string, required)

  - `legs.fromLocation.latitude` (number, required)

  - `legs.fromLocation.longitude` (number, required)

  - `legs.fromLocation.locationName` (string, required)

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

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

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

  - `legs.fromLocation.properties` (object,null)

  - `legs.fromDateAndTimeConstraint` (any)

  - `legs.fromVehicleMetadata` (object,null)

  - `legs.toLocation` (object, required)

  - `legs.toDateAndTimeConstraint` (any)

  - `legs.toVehicleMetadata` (object,null)

  - `legs.sequence` (number)

  - `legs.vehicleId` (string,null)

  - `defaultLegBranches` (array)
    The branches that will be applied to the legs of the order by default. When a leg is created, all of the defaultLegBranches will be applied to the branches field of the leg. Updating the defaultLegBranches will not update the branches field of existing legs.

  - `defaultLegBranches.id` (string)

  - `defaultLegBranches.name` (string,null)

  - `billingEntityId` (string)
    Legacy field for customerId

## Response 404 fields (application/json):

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