# Reads Delivery

Endpoint: GET /fuel/deliveries/{deliveryId}
Version: 1.0.0
Security: M2X_auth_application

## Path parameters:

  - `deliveryId` (string, required)
    The unique delivery Id

## Response 200 fields (application/json):

  - `id` (string)
    Example: "D001"

  - `constraintId` (string,null)
    Example: "D001"

  - `externalId` (string,null)

  - `dispatchGroupId` (string,null)
    Example: "ABC1123-asdasdasd-123213"

  - `deleted` (boolean)

  - `vehicleId` (string)
    Example: "D001"

  - `vehicleExternalId` (any)

  - `driver` (any)

  - `location` (object)

  - `location.locationKind` (string,null)
    Enum: "Farm", "Carrier", "Port", "Warehouse", "Sale Yard", "Holding Yard", "Works", "Weighbridge", "Accommodation", "Quarry", "Mine", "Store", "Plant", "Forest", "Ranch", "Growyard", "Elevator", "Feedyard", "Depot", "Pack Site", "Container Depot"

  - `location.shortName` (string, required)
    Example: "Dreamy Farm"

  - `location.areaName` (string,null)
    Example: "Mystery Creek"

  - `location.facilityName` (string,null)
    Example: "Main Yards"

  - `location.addressText` (string,null)
    Example: "Main Yards"

  - `location.latitude` (number,null)
    If null or not provided, the latitude from the current location will be retained.  If there is no current latitude, it will be resolved by geocoding.

  - `location.longitude` (number,null)
    If null or not provided, the longitude from the current location will be retained.  If there is no current longitude, it will be resolved by geocoding.

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

  - `location.inboundIntegrationIds` (array,null)

  - `location.disabled` (boolean, required)

  - `location.onHold` (boolean)

  - `location.customer` (object,null)
    At least one field needs to be provided to resolve the customer

  - `location.customer.customerId` (string)
    M2X customer ID

  - `location.customer.customerName` (string)
    Customer name

  - `location.customer.integrationId` (string)
    Customer integration ID

  - `location.customer.externalId` (string)
    External customer ID

  - `location.mobile` (string,null)
    Location mobile number
    Example: "+33 123"

  - `location.phone` (string,null)
    Location phone number
    Example: "+33 123"

  - `location.email` (string,null)
    Location email
    Example: "asd@asd.asd"

  - `location.hazards` (string,null)
    Hazards descriptions

  - `location.notes` (string,null)
    Notes

  - `location.properties` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `location.requirements` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `location.restrictions` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `location.metadata` (object,null)
    Opaque passenger data

  - `location.readonlyFields` (object,null)
    Specifies which field should not be touched by the user

  - `location.readonlyFields.latitude` (boolean)

  - `location.readonlyFields.longitude` (boolean)

  - `location.readonlyFields.notes` (boolean)

  - `location.readonlyFields.hazards` (boolean)

  - `location.readonlyFields.customer` (boolean)

  - `location.readonlyFields.mobile` (boolean)

  - `location.readonlyFields.phone` (boolean)

  - `location.readonlyFields.email` (boolean)

  - `location.readonlyFields.gtnCaptureRequiredPickup` (boolean)

  - `location.readonlyFields.gtnCaptureRequiredDelivery` (boolean)

  - `location.readonlyFields.openingHours` (boolean)

  - `location.accessLatitude` (number,null)

  - `location.accessLongitude` (number,null)

  - `location.maxIncomingWeight` (number,null)

  - `location.maxOutgoingWeight` (number,null)

  - `location.minIncomingWeight` (number,null)

  - `location.minOutgoingWeight` (number,null)

  - `location.offRoadDistance` (number,null)

  - `location.offRoadDuration` (number,null)

  - `location.waitTime` (number,null)

  - `location.contactName` (string,null)

  - `location.contactNotes` (string,null)

  - `location.dairySupplyGeneration` (object,null)

  - `location.geofenceType` (string,null)
    Enum: "Circular", "Polygon", null

  - `location.polygonGeofence` (string,null)
    If geofenceType is "Polygon" uses this WKT closed polygon (last and first lat/long pair must match)
    Example: "POLYGON ((-105.0105 39.7617,-105.0108 39.7614,-105.0111 39.7616,-105.0105 39.7617))"

  - `location.radius` (integer,null)
    If geofenceType is "Circular" uses this integer radius in meters around the determined or provided lat/long
    Example: 300

  - `location.geofenceAlerting` (object,null)

  - `location.geofenceAlerting.enabled` (boolean, required)

  - `location.geofenceAlerting.emails` (array,null)
    A list of email addresses
    Example: ["abc@example.com"]

  - `location.geofenceAlerting.mobileNumbers` (array,null)
    A list of mobile numbers
    Example: [64211234567]

  - `location.gtnCaptureRequiredPickup` (string,null)
    Policy for weighbridge input on pickup
    Enum: "MANDATORY", "OPTIONAL", "NONE", null

  - `location.gtnCaptureRequiredDelivery` (string,null)
    Policy for weighbridge input on delivery
    Enum: "MANDATORY", "OPTIONAL", "NONE", null

  - `location.weeklySupplyGeneration` (object,null)

  - `location.weeklySupplyGeneration.interactionsInstructions` (array,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.storageId` (string, required)

  - `location.weeklySupplyGeneration.interactionsInstructions.storageName` (string,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.capacity` (object)

  - `location.weeklySupplyGeneration.interactionsInstructions.capacity.capacityFuelMinPumpableLitres` (number,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.capacity.capacityFuelSafeFillLitres` (number,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.capacity.capacityFuelSafetyStockLitres` (number,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.capacity.capacityLitres` (number,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.product` (object)

  - `location.weeklySupplyGeneration.interactionsInstructions.product.productCodeId` (string, required)

  - `location.weeklySupplyGeneration.interactionsInstructions.product.productCodeName` (string, required)

  - `location.weeklySupplyGeneration.interactionsInstructions.product.productId` (string, required)

  - `location.weeklySupplyGeneration.interactionsInstructions.product.productLinearRate` (number,null)

  - `location.weeklySupplyGeneration.interactionsInstructions.productLinearRateCalculated` (boolean)

  - `location.weeklySupplyGeneration.defaultProductEnabled` (boolean)

  - `location.weeklySupplyGeneration.dayCollectionWindow` (object,null)

  - `location.weeklySupplyGeneration.dayCollectionWindow.startTime` (string,null)
    The start of the collection/delivery time window.  May extend past 24:00 for overnight time windows.
    Example: "07:00"

  - `location.weeklySupplyGeneration.dayCollectionWindow.endTime` (string,null)
    The end of the collection/delivery time window.  May extend past 24:00 for overnight time windows.
    Example: "28:00"

  - `location.weeklySupplyGeneration.generationBasis` (string,null)
    Enum: "PATTERN", "SAFETY_STOCK"

  - `location.weeklySupplyGeneration.patternType` (string,null)
    Enum: "TWICE_WEEKLY", "WEEKLY", "FORTNIGHTLY", "THIRD_WEEK", "FOURTH_WEEK", "FIVE_DAYS", "CUSTOM"

  - `location.weeklySupplyGeneration.pattern` (array,null)

  - `location.weeklySupplyGeneration.pattern.monday` (object, required)

  - `location.weeklySupplyGeneration.pattern.monday.day` (boolean)

  - `location.weeklySupplyGeneration.pattern.monday.night` (boolean)

  - `location.weeklySupplyGeneration.pattern.tuesday` (object, required)

  - `location.weeklySupplyGeneration.pattern.wednesday` (object, required)

  - `location.weeklySupplyGeneration.pattern.thursday` (object, required)

  - `location.weeklySupplyGeneration.pattern.friday` (object, required)

  - `location.weeklySupplyGeneration.pattern.saturday` (object, required)

  - `location.weeklySupplyGeneration.pattern.sunday` (object, required)

  - `location.weeklySupplyGeneration.patternStartDay` (string,null)
    YYYY-MM-DD
    Example: "2024-01-01"

  - `location.weeklySupplyGeneration.customPriority` (string,null)
    Enum: "HIGH", "MEDIUM", "LOW"

  - `location.weeklySupplyGeneration.isTopupSite` (boolean)

  - `location.weeklySupplyGeneration.productQuantity` (number,null)

  - `location.updated` (string,null)

  - `products` (array)

  - `products.transportRequirementsId` (string)
    M2X internal tracking id for the product type

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

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

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

  - `products.quantity` (integer)
    The entered quantity

  - `shiftMetadata` (object)

  - `shiftMetadata.serviceDay` (string)

  - `shiftMetadata.shiftId` (string)

  - `shiftMetadata.totalShifts` (integer)

  - `shiftMetadata.shiftIndex` (integer)

  - `actual` (object,null)

  - `actual.inboundInventory` (object,null)

  - `actual.inboundInventory.compartments` (array)

  - `actual.inboundInventory.compartments.compartmentId` (string)

  - `actual.outboundInventory` (object,null)

  - `actual.truckReference` (string)
    Example: "D001"

  - `actual.timestamp` (string,null)

  - `actual.interactionsTransactions` (array)

  - `actual.interactionsTransactions.reasonCode` (object,null)

  - `actual.interactionsTransactions.reasonCode.label` (string)

  - `actual.interactionsTransactions.reasonCode.code` (string)

  - `actual.interactionsTransactions.storageId` (string)
    The storage being interacted with

  - `actual.interactionsTransactions.storageIntegrationId` (string,null)
    The external identifier of the storage

  - `actual.interactionsTransactions.sources` (array)

  - `actual.interactionsTransactions.sources.empty` (boolean)

  - `actual.interactionsTransactions.sources.quantity` (number)

  - `actual.storagesMeasurements` (array)

  - `actual.storagesMeasurements.preDipLitre` (number,null)
    The pre delivery dip measurement

  - `actual.storagesMeasurements.postDipLitre` (number,null)
    The post delivery dip measurement

  - `actual.storagesMeasurements.isBespokeTank` (boolean)
    whether the tank was added on the fly by the driver

  - `actual.odometerDistanceKm` (number,null)
    The odometer distance reading in kilometers

## Response 404 fields (application/json):

  - `message` (string)
    Example: "no delivery exists with that id {deliveryId}"