> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.onechain-tms.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get one location
> This endpoint returns the location corresponding to the given ID.
## OpenAPI
````yaml openapi.json get /v1/locations/{id}
openapi: 3.1.0
info:
title: OneChain API
version: 1.3.2
x-logo:
href: https://www.onechain-tms.com
url: static/logo.png
servers:
- url: localhost:8080
security: []
tags:
- description: |-
This API lets you fetch your data from ONECHAIN's servers.
URL: https://api.onechain-tms.com
name: Introduction
x-displayName: Introduction
- description: >-
To safely access the resources exposed by our API, you will need to
provide an authenticated token in your requests headers. Please reach out
to your ONECHAIN’s Account Manager to get your token.
| Name of the header | Type of authentication |
|--------------------|------------------------|
| Authorization | API AUTHORIZATION KEY |
Please note that the API authorization key must be prefixed with "Bearer "
For example:
`Authorization: Bearer 1234567890`
name: Authentication
x-displayName: Authentication
- description: |-
All endpoints fetching multiple items are paginated.
Use `skip` to skip to the items you want to retrieve.
Use `take` to define how many items you want to retrieve.
`skip` and `take` are optional parameters.
If you do not input them, `skip` equals to 0 and `take` equals to 10.
Example:
`/v1/shipments?skip=20&take=10`
name: Pagination
x-displayName: Pagination
- name: Shipments
- name: Purchase Orders
- name: Documents
- name: Locations
- name: Invoices
- name: Users
- name: Reporting
- description:
name: ShipmentObject
x-displayName: ShipmentObject
- description:
name: TrackingObject
x-displayName: TrackingObject
- description:
name: OrderPreparationObject
x-displayName: OrderPreparationObject
- description:
name: PurchaseOrderObject
x-displayName: PurchaseOrderObject
- description:
name: TrackingEventObject
x-displayName: TrackingEventObject
- description:
name: TrackingDateObject
x-displayName: TrackingDateObject
- description:
name: TrackingStepObject
x-displayName: TrackingStepObject
- description:
name: ProductObject
x-displayName: ProductObject
- description:
name: PortObject
x-displayName: PortObject
- description:
name: CoordinatesObject
x-displayName: CoordinatesObject
- description:
name: ContainerObject
x-displayName: ContainerObject
- description:
name: UserObject
x-displayName: UserObject
- description:
name: LoadObject
x-displayName: LoadObject
- description:
name: DocumentObject
x-displayName: DocumentObject
- description:
name: InvoiceObject
x-displayName: InvoiceObject
- description:
name: LocationObject
x-displayName: LocationObject
- description:
name: PriceObject
x-displayName: PriceObject
- description:
name: QuantityObject
x-displayName: QuantityObject
- description:
name: SizeObject
x-displayName: SizeObject
- description:
name: VolumeObject
x-displayName: VolumeObject
- description:
name: WeightObject
x-displayName: WeightObject
- description:
name: SimpleDateObject
x-displayName: SimpleDateObject
- description:
name: DateWithTimeObject
x-displayName: DateWithTimeObject
paths:
/v1/locations/{id}:
get:
tags:
- Locations
summary: Get one location
description: This endpoint returns the location corresponding to the given ID.
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: This endpoint returns the location corresponding to the given ID.
content:
application/json:
schema:
$ref: '#/components/schemas/Location'
description: >-
This endpoint returns the location corresponding to the given
ID.
'404':
description: Location not found
content:
application/json:
schema:
description: Location not found
type: object
components:
schemas:
Location:
type: object
modelName: Location
properties:
id:
type: string
example: 12345
company_name:
type: string
example: Logistics WorldWide Co
name:
type: string
example: Saint Quentin warehouse
address:
type: string
example: 357 allée des Tilleuls
city:
type: string
example: Saint Quentin Fallavier
zip_code:
type: string
example: 69300
country:
type: string
example: FR
contacts:
type: array
items:
type: object
properties:
name:
type: string
example: Thierry Henriet
email:
type: string
example: log@patagonia.com
phone:
type: string
example: 33134567891
opening_hours:
type: string
example: Monday to Friday 8am to 5pm
requires_appointment:
type: boolean
description: >-
Specifies if appointments are required for loading and unloading at
this location.
requires_tailgate_truck:
type: boolean
description: Specifies if liftgate trucks are required for this location.
example: false
additional_information:
type: string
example: Please avoid Friday after 4pm
````