# Get locations Get list of locations Endpoint: GET /locations/{offset}/{amount} Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Path parameters: - `offset` (integer, required) - `amount` (integer, required) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `totalResults` (integer) - `locations` (array) - `locations.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.uuid` (string, required) - `locations.primaryPlatformId` (string, required) - `locations.createdAt` (string) The date and time this Entity has been created - `locations.updatedAt` (string) The date and time this Entity has been updated - `locations.language` (object) circular reference - `locations.type` (string) Enum: "warehouse", "store", "environmentalZone", "restrictedArea", "customer", "parkingSpot", "loadingUnloadingArea", "operationalBase", "fuelStation" - `locations.name` (string) - `locations.unCode` (string) - `locations.geoReference` (object) - `locations.geoReference.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.geoReference.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.geoReference.uuid` (string, required) - `locations.geoReference.primaryPlatformId` (string, required) - `locations.geoReference.createdAt` (string) The date and time this Entity has been created - `locations.geoReference.updatedAt` (string) The date and time this Entity has been updated - `locations.geoReference.language` (object) circular reference - `locations.geoReference.type` (string) Enum: "addressGeoReference", "zoneGeoReference", "tmcArrayGeoReference", "tmcLocationGeoReference", "openLRGeoReference", "GeoReference", "Feature", "latLonArrayGeoReference", "latLonPointGeoReference" - `locations.administrativeReference` (object) - `locations.administrativeReference.name` (string) - `locations.administrativeReference.street` (string) - `locations.administrativeReference.houseNumber` (string) - `locations.administrativeReference.houseNumberAddition` (string) - `locations.administrativeReference.postalCode` (string) - `locations.administrativeReference.city` (string) - `locations.administrativeReference.country` (string) - `locations.contactDetails` (array) - `locations.contactDetails.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.contactDetails.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.contactDetails.uuid` (string, required) - `locations.contactDetails.primaryPlatformId` (string, required) - `locations.contactDetails.createdAt` (string) The date and time this Entity has been created - `locations.contactDetails.updatedAt` (string) The date and time this Entity has been updated - `locations.contactDetails.language` (object) circular reference - `locations.contactDetails.type` (string) Enum: "iban", "gln", "vatCode", "name", "lastName", "middleName", "firstName", "phone", "mobilePhone", "email", "language", "other" - `locations.contactDetails.value` (string) - `locations.contactDetails.remarks` (string) - `locations.openingTimes` (object) - `locations.openingTimes.monday` (object) - `locations.openingTimes.monday.start` (string) - `locations.openingTimes.monday.end` (string) - `locations.openingTimes.monday.open` (boolean) - `locations.openingTimes.monday.day` (string) - `locations.openingTimes.monday.name` (string) - `locations.openingTimes.monday.description` (string) - `locations.openingTimes.tuesday` (object) - `locations.openingTimes.wednesday` (object) - `locations.openingTimes.thursday` (object) - `locations.openingTimes.friday` (object) - `locations.openingTimes.saturday` (object) - `locations.openingTimes.sunday` (object) - `locations.terminal` (object) - `locations.terminal.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.terminal.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.terminal.uuid` (string, required) - `locations.terminal.primaryPlatformId` (string, required) - `locations.terminal.createdAt` (string) The date and time this Entity has been created - `locations.terminal.updatedAt` (string) The date and time this Entity has been updated - `locations.terminal.language` (object) circular reference - `locations.terminal.name` (string, required) - `locations.terminal.integrationType` (string) Enum: "portbase", "psa", "dpworld" - `locations.terminal.ean` (string) - `locations.terminal.bicsCode` (string) - `locations.terminal.quayName` (string) - `locations.terminal.smdgCode` (string) - `locations.terminal.locations` (array) - `locations.terminal.allowedModalities` (array) - `locations.terminal.terminalSettings` (array) - `locations.terminal.terminalSettings.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.terminal.terminalSettings.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.terminal.terminalSettings.uuid` (string, required) - `locations.terminal.terminalSettings.primaryPlatformId` (string, required) - `locations.terminal.terminalSettings.createdAt` (string) The date and time this Entity has been created - `locations.terminal.terminalSettings.updatedAt` (string) The date and time this Entity has been updated - `locations.terminal.terminalSettings.language` (object) circular reference - `locations.terminal.terminalSettings.loading` (boolean) - `locations.terminal.terminalSettings.full` (boolean) - `locations.terminal.terminalSettings.modality` (string) - `locations.terminal.terminalSettings.sealNumberAllowed` (boolean) - `locations.terminal.terminalSettings.reeferAllowed` (boolean) - `locations.terminal.terminalSettings.grossWeightAllowed` (boolean) - `locations.terminal.terminalSettings.outOfGaugeAllowed` (boolean) - `locations.terminal.terminalSettings.dangerousGoodsAllowed` (boolean) - `locations.terminal.terminalSettings.cargoCutOffInMinutes` (integer) - `locations.terminal.tarRequired` (boolean) - `locations.terminal.roadLicenseIdRequired` (boolean) - `locations.actions` (array) - `locations.actions.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.actions.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.actions.uuid` (string, required) - `locations.actions.primaryPlatformId` (string, required) - `locations.actions.createdAt` (string) The date and time this Entity has been created - `locations.actions.updatedAt` (string) The date and time this Entity has been updated - `locations.actions.language` (object) circular reference - `locations.actions.type` (string) Enum: "load", "unload", "handOver", "stop", "move", "attachTransportEquipment", "detachTransportEquipment", "attachChauffeur", "detachChauffeur", "genericAction", "wait", "break", "refuel", "customs", "weighing", "typeTakeAndReturn", "booking" - `locations.actions.groupId` (string) - `locations.actions.name` (string, required) The name of the action - `locations.actions.externalAttributes` (object) - `locations.actions.identifiers` (array) - `locations.actions.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.actions.identifiers.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.actions.identifiers.uuid` (string, required) - `locations.actions.identifiers.primaryPlatformId` (string, required) - `locations.actions.identifiers.createdAt` (string) The date and time this Entity has been created - `locations.actions.identifiers.updatedAt` (string) The date and time this Entity has been updated - `locations.actions.identifiers.language` (object) circular reference - `locations.actions.identifiers.name` (string) - `locations.actions.identifiers.system` (string) - `locations.actions.identifiers.value` (string) - `locations.actions.identifiers.expiredAt` (string) - `locations.actions.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `locations.actions.result` (object) - `locations.actions.result.status` (string) Enum: "succeeded", "failed", "partiallySucceeded", "cancelled" - `locations.actions.result.remark` (string) - `locations.actions.result.reason` (string) - `locations.actions.result.results` (array) - `locations.actions.result.answers` (object) - `locations.actions.result.attachments` (array) - `locations.actions.result.attachments.questionId` (string) - `locations.actions.result.attachments.type` (string) Enum: "photo", "signature", "document" - `locations.actions.result.attachments.documentId` (string) - `locations.actions.result.attachments.dataUrl` (string) - `locations.actions.remark` (string) - `locations.actions.sequenceNr` (integer) The number in which order the Action occurs - `locations.actions.tripSequenceNr` (integer) The number in which order the Action occurs within the trip - `locations.actions.location` (object) - `locations.actions.location.associationType` (string) Enum: "inline", "reference" - `locations.actions.startTime` (string) - `locations.actions.endTime` (string) - `locations.actions.eta` (string) - `locations.actions.etd` (string) - `locations.actions.timeFormat` (string) - `locations.actions.recurrence` (string) - `locations.actions.duration` (integer) The actual duration of the action in minutes - `locations.actions.estimatedDuration` (integer) The estimated duration of the action in minutes - `locations.actions.inTripOnly` (boolean) - `locations.actions.actions` (array) - `locations.actions.actions.associationType` (string) Enum: "inline", "reference" - `locations.actions.communicationRequests` (array) - `locations.actions.communicationRequests.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.actions.communicationRequests.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.actions.communicationRequests.uuid` (string, required) - `locations.actions.communicationRequests.primaryPlatformId` (string, required) - `locations.actions.communicationRequests.createdAt` (string) The date and time this Entity has been created - `locations.actions.communicationRequests.updatedAt` (string) The date and time this Entity has been updated - `locations.actions.communicationRequests.language` (object) circular reference - `locations.actions.communicationRequests.name` (string) - `locations.actions.communicationRequests.description` (string) - `locations.actions.communicationRequests.status` (string) Enum: "pending", "processing", "success", "failure" - `locations.actions.communicationRequests.responseMessage` (string) - `locations.actions.communicationRequests.responseValue` (string) - `locations.actions.documents` (array) - `locations.actions.documents.associationType` (string) Enum: "inline", "reference" - `locations.actions.contextEvents` (array) - `locations.actions.contextEvents.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.actions.contextEvents.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.actions.contextEvents.uuid` (string, required) - `locations.actions.contextEvents.primaryPlatformId` (string, required) - `locations.actions.contextEvents.createdAt` (string) The date and time this Entity has been created - `locations.actions.contextEvents.updatedAt` (string) The date and time this Entity has been updated - `locations.actions.contextEvents.language` (object) circular reference - `locations.actions.contextEvents.type` (string) Enum: "generalEvent", "sensorUpdateEvent", "gateInEvent", "gateOutEvent", "arrivalEvent", "departureEvent", "stopEngineEvent", "startEngineEvent", "startWaitingEvent", "stopWaitingEvent", "stopMovingEvent", "startMovingEvent", "locationUpdateEvent", "updateEvent", "associationRemovedEvent", "associationCreatedEvent", "capacityChangeEvent" - `locations.actions.contextEvents.lifeCycle` (string) Enum: "requested", "planned", "projected", "actual", "realized" - `locations.actions.contextEvents.externalAttributes` (object) - `locations.actions.contextEvents.identifiers` (array) - `locations.actions.contextEvents.dateTime` (string) - `locations.actions.attributes` (array) - `locations.actions.attributes.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.actions.attributes.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.actions.attributes.uuid` (string, required) - `locations.actions.attributes.primaryPlatformId` (string, required) - `locations.actions.attributes.createdAt` (string) The date and time this Entity has been created - `locations.actions.attributes.updatedAt` (string) The date and time this Entity has been updated - `locations.actions.attributes.language` (object) circular reference - `locations.actions.attributes.name` (string) - `locations.actions.attributes.color` (string) - `locations.actions.versionNumber` (integer) - `locations.actions.constraints` (array) - `locations.actions.constraints.associationType` (string, required) - `locations.constraints` (array) - `locations.constraints.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.constraints.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.constraints.uuid` (string, required) - `locations.constraints.primaryPlatformId` (string, required) - `locations.constraints.createdAt` (string) The date and time this Entity has been created - `locations.constraints.updatedAt` (string) The date and time this Entity has been updated - `locations.constraints.language` (object) circular reference - `locations.constraints.type` (string) Enum: "accessConstraint", "timeConstraint", "timeWindowsConstraint", "startDateTimeConstraint", "endDateTimeConstraint", "sizeConstraint", "weightConstraint", "speedConstraint", "sensorValueConstraint", "fuelTypeConstraint", "vehicleTypeConstraint", "emissionStandardConstraint", "attributeConstraint", "transportEquipmentTypeConstraint", "routeConstraint", "andConstraint", "orConstraint", "notConstraint", "genericConstraint" - `locations.constraints.name` (string) - `locations.constraints.enforceability` (string) Enum: "enforced", "preference" - `locations.pricingElements` (array) - `locations.pricingElements.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.pricingElements.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.pricingElements.uuid` (string, required) - `locations.pricingElements.primaryPlatformId` (string, required) - `locations.pricingElements.createdAt` (string) The date and time this Entity has been created - `locations.pricingElements.updatedAt` (string) The date and time this Entity has been updated - `locations.pricingElements.language` (object) circular reference - `locations.pricingElements.sequenceNr` (integer) - `locations.pricingElements.quantity` (integer) - `locations.pricingElements.name` (string) - `locations.pricingElements.description` (string) - `locations.pricingElements.category` (object) - `locations.pricingElements.category.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.pricingElements.category.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.pricingElements.category.uuid` (string, required) - `locations.pricingElements.category.primaryPlatformId` (string, required) - `locations.pricingElements.category.createdAt` (string) The date and time this Entity has been created - `locations.pricingElements.category.updatedAt` (string) The date and time this Entity has been updated - `locations.pricingElements.category.language` (object) circular reference - `locations.pricingElements.category.name` (string) - `locations.pricingElements.category.creditCode` (string) - `locations.pricingElements.category.debitCode` (string) - `locations.pricingElements.category.defaultValue` (number) - `locations.pricingElements.category.enabled` (boolean) - `locations.pricingElements.category.tripRevenue` (boolean) - `locations.pricingElements.business` (object) circular reference - `locations.pricingElements.amount` (object) - `locations.pricingElements.amount.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.pricingElements.amount.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.pricingElements.amount.uuid` (string, required) - `locations.pricingElements.amount.primaryPlatformId` (string, required) - `locations.pricingElements.amount.createdAt` (string) The date and time this Entity has been created - `locations.pricingElements.amount.updatedAt` (string) The date and time this Entity has been updated - `locations.pricingElements.amount.language` (object) circular reference - `locations.pricingElements.amount.amount` (number) - `locations.pricingElements.amount.currency` (object) - `locations.pricingElements.amount.currency.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.pricingElements.amount.currency.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.pricingElements.amount.currency.uuid` (string, required) - `locations.pricingElements.amount.currency.primaryPlatformId` (string, required) - `locations.pricingElements.amount.currency.createdAt` (string) The date and time this Entity has been created - `locations.pricingElements.amount.currency.updatedAt` (string) The date and time this Entity has been updated - `locations.pricingElements.amount.currency.language` (object) circular reference - `locations.pricingElements.amount.currency.name` (string) - `locations.pricingElements.amount.currency.short` (string) - `locations.pricingElements.amount.currency.sign` (string) - `locations.pricingElements.amount.currency.decimalDelimiter` (string) - `locations.pricingElements.amount.currency.thousandDelimiter` (string) - `locations.pricingElements.amount.currency.enabled` (boolean) - `locations.pricingElements.amount.taxRate` (object) - `locations.pricingElements.amount.taxRate.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.pricingElements.amount.taxRate.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.pricingElements.amount.taxRate.createdAt` (string) The date and time this Entity has been created - `locations.pricingElements.amount.taxRate.updatedAt` (string) The date and time this Entity has been updated - `locations.pricingElements.amount.taxRate.creditCode` (string) - `locations.pricingElements.amount.taxRate.debitCode` (string) - `locations.pricingElements.amount.taxRate.identifiers` (array) - `locations.pricingElements.amount.taxRate.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `locations.pricingElements.amount.taxRate.identifiers.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `locations.pricingElements.amount.taxRate.identifiers.createdAt` (string) The date and time this Entity has been created - `locations.pricingElements.amount.taxRate.identifiers.updatedAt` (string) The date and time this Entity has been updated - `locations.pricingElements.amount.taxRate.identifiers.name` (string) - `locations.pricingElements.amount.taxRate.identifiers.system` (string) - `locations.pricingElements.amount.taxRate.identifiers.value` (string) - `locations.pricingElements.amount.taxRate.identifiers.expiredAt` (string) - `locations.pricingElements.amount.taxRate.name` (string) - `locations.pricingElements.amount.taxRate.description` (string) - `locations.pricingElements.amount.taxRate.jurisdiction` (string) - `locations.pricingElements.amount.taxRate.percentage` (number) - `locations.pricingElements.amount.taxRate.inclusive` (boolean) - `locations.pricingElements.amount.taxRate.active` (boolean) - `locations.pricingElements.amount.inclusiveOfTax` (boolean) - `locations.pricingElements.subTotal` (object) - `locations.pricingElements.tax` (object) - `locations.pricingElements.total` (object) - `locations.remark` (string) - `locations.hash` (string) - `locations.identifiers` (array) - `locations.externalAttributes` (object) - `locations.dataIsComplete` (boolean) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)