openapi: 3.0.1
info:
title: ONE Record API Documentation
description: "This OpenAPI specification describes the API endpoint structure of\
\ an ONE Record API implementation.
Note:
The included schemas\
\ can only be used to generate JSON-LD in the extended document form.
However,\
\ to be fully ONE Record compliant, any ONE Record API (and any compliant ONE\
\ Record client)
MUST support at least the expanded, compacted, and\
\ flattened document forms.
More information about the ONE Record specification\
\ are available on [IATA Github repository](https://github.com/IATA-Cargo/ONE-Record)\
\ and on the [ONE Record Developer Portal](https://onerecord.iata.org)."
contact:
name: IATA
url: https://onerecord.iata.org/
email: onerecord@iata.org
license:
name: MIT License
url: https://opensource.org/licenses/MIT
version: 2.3.0
servers:
- url: https://1r.example.com
tags:
- name: Server Information
- name: Logistics Objects
- name: Logistics Events
- name: Subscriptions
- name: Notifications
- name: Access Delegations
- name: Action Requests
paths:
/:
get:
summary: Get Server Information
description: Return the information about the server
tags:
- Server Information
operationId: getServerInformation
responses:
"200":
description: The request to retrieve the ServerInformation has been successful
headers:
Last-Modified:
description: The date and time of the most recent change to the server information
required: true
style: simple
schema:
type: string
format: HTTP-date
example: "Tue, 21 Feb 2023 07:28:00 GMT"
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ServerInformation'
"301":
description: The server has permanently moved to a new location
headers:
Location:
description: New location of the server
required: true
style: simple
schema:
type: string
format: uri
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Resource Not Found
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
"405":
description: Method not Allowd
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/logistics-objects:
post:
tags:
- Logistics Objects
summary: "INTERNAL: Create a LogisticsObject"
description: Create a LogisticsObject in the ONE Record server
operationId: createLogisticsObject
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/LogisticsObject'
required: true
responses:
"201":
description: Logistics Object has been created
headers:
Type:
description: Type of the created LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
Location:
description: Location of the created LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"400":
description: Invalid Logistics Object
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"409":
description: LogisticsObject with provided ID already exists
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/logistics-objects/{logisticsObjectId}:
get:
tags:
- Logistics Objects
summary: Request a logistics object
description: Get all information contained into a LogisticsObject in the ONE Record server
operationId: getLogisticsObject
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
- name: at
in: query
required: false
schema:
type: string
format: date-time
- name: embedded
in: query
required: false
schema:
type: boolean
responses:
"200":
description: The request to retrieve the Logistics Object has been successful
headers:
Type:
description: Type of the requested LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
Revision:
description: The revision of the requested Logistics Object
required: true
style: simple
schema:
type: integer
format: int64
Last-Modified:
description: The date and time of the most recent change to the Logistics Object
required: true
style: simple
schema:
type: string
format: HTTP-date
example: "Tue, 21 Feb 2023 07:28:00 GMT"
Latest-Revision:
description: Latest revision number of the requested Logistics Object
required: true
style: simple
schema:
type: integer
format: int64
Location:
description: Location of the created LogisticsObject
required: false
style: simple
schema:
type: string
format: uri
content:
application/ld+json:
schema:
$ref: '#/components/schemas/LogisticsObject'
"301":
description: The URI of the Logistics Object has permanently changed.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"302":
description: The URI of the Logistics Object has temporarily moved.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
patch:
tags:
- Logistics Objects
summary: Request a change for a given logistics object
description: Allow a third party to propose a change on a logistics object
operationId: updateLogisticsObject
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Change'
required: true
responses:
"201":
description: The change was successfully requested
headers:
Type:
description: The type of the newly created resource as a URI
required: true
style: simple
schema:
type: string
format: uri
Location:
description: The URI of the submitted ChangeRequest
required: true
style: simple
schema:
type: string
format: uri
"400":
description: The update request body is invalid
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized to update the Logistics Object
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"422":
description: Unprocessable Request
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Logistics Objects
summary: Request a verification for a given logistics object
description: Allow a third party to propose a verification on a logistics object
operationId: verifyLogisticsObject
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Verification'
required: true
responses:
"201":
description: The verification request was successfully requested
headers:
Type:
description: The type of the newly created resource as a URI
required: true
style: simple
schema:
type: string
format: uri
Location:
description: The URI of the submitted ChangeRequest
required: true
style: simple
schema:
type: string
format: uri
"400":
description: The verification request body is invalid
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"422":
description: Unprocessable Request
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/logistics-objects/{logisticsObjectId}/audit-trail:
get:
tags:
- Logistics Objects
summary: Retrieves the audit trail (history) of a given logistics object
description: Retrieve the list of change request applied to the logistics object
operationId: getAuditTrail
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
- name: updatedFrom
in: query
required: false
schema:
type: string
format: date-time
- name: updatedTo
in: query
required: false
schema:
type: string
format: date-time
- name: status
in: query
required: false
schema:
type: string
enum: [PENDING, ACCEPTED, REJECTED]
responses:
"200":
description: The request to retrieve the AuditTrail has been successful
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail'
"301":
description: The URI of the Logistics Object has permanently changed.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"302":
description: The URI of the Logistics Object has temporarily moved.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/logistics-objects/{logisticsObjectId}/logistics-events:
get:
tags:
- Logistics Events
summary: Retrieves the LogisticsEvents of a given LogisticsObject
description: Retrieve the list of LogisticsEvents of a given LogisticsObject
operationId: getLogisticsEvents
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
- name: event-code
in: query
required: false
schema:
type: array
items:
type: string
example: [FOF,DEP]
- name: created-after
in: query
required: false
schema:
type: string
format: date-time
- name: created-before
in: query
required: false
schema:
type: string
format: date-time
- name: occurred-after
in: query
required: false
schema:
type: string
format: date-time
- name: occurred-before
in: query
required: false
schema:
type: string
format: date-time
- name: sort
in: query
required: false
schema:
type: array
items:
type: string
example: [ASC-creationDate,DESC-creationDate,ASC-eventDate,DESC-eventDate]
- name: limit
in: query
required: false
schema:
type: integer
- name: skip
in: query
required: false
schema:
type: integer
responses:
"200":
description: The request to retrieve the Logistics Events has been successful
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Collection'
"301":
description: The URI of the Logistics Object has permanently changed.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"302":
description: The URI of the Logistics Object has temporarily moved.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Logistics Events
summary: Append a LogisticsEvent to the event log of a given LogisticsObject
description: Add a LogisticsEvent to a given LogisticsObject
operationId: appendLogisticsEvent
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/LogisticsEvent'
required: true
responses:
"201":
description: Logistics Event has been created
headers:
Type:
description: Type of the created LogisticsEvent
required: true
style: simple
schema:
type: string
format: uri
Location:
description: Location of the created LogisticsEvent
required: true
style: simple
schema:
type: string
format: uri
"400":
description: Invalid Logistics Object
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: LogisticsObject not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal server error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/logistics-objects/{logisticsObjectId}/logistics-events/{logisticsEventsId}:
get:
tags:
- Logistics Events
summary: Retrieves a LogisticsEvents
description: Get a specific LogisticsEvents from a give LogisticsObject
operationId: getLogisticsEvent
parameters:
- name: logisticsObjectId
in: path
required: true
schema:
type: string
- name: logisticsEventsId
in: path
required: true
schema:
type: string
responses:
"200":
description: The request to retrieve the Logistics Event has been successful
headers:
Last-Modified:
description: The date and time of the most recent change to the Logistics Object
required: true
style: simple
schema:
type: string
format: HTTP-date
example: "Tue, 21 Feb 2023 07:28:00 GMT"
content:
application/ld+json:
schema:
$ref: '#/components/schemas/LogisticsEvent'
"301":
description: The URI of the Logistics Object has permanently changed.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"302":
description: The URI of the Logistics Object has temporarily moved.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object or Logistics Event not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/subscriptions:
get:
tags:
- Subscriptions
summary: Get subscription information
description: Get a specific subscription object
operationId: getSubscription
parameters:
- name: topicType
in: query
required: true
schema:
type: string
- name: topic
in: query
required: true
schema:
type: string
responses:
"200":
description: The request to retrieve the Subscription Information has been successful
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Subscription'
"400":
description: The request is invalid
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Subscriptions
summary: Request subscription
description: Send a subscription request for a Logistics Object
operationId: createSubscriptionRequest
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Subscription'
required: true
responses:
"201":
description: The Subscription Request has been created successfully
headers:
Type:
description: Type of the SubscriptionRequest
required: true
style: simple
schema:
type: string
format: uri
Location:
description: Location of the created SubscriptionRequest
required: true
style: simple
schema:
type: string
format: uri
"400":
description: The request is invalid
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/notifications:
post:
tags:
- Notifications
summary: Used as callback URL for receiving Notifications
description: Post a notification object to a specific host
operationId: receiveNotification
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Notification'
required: true
responses:
"204":
description: No Content
"400":
description: The request is invalid
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Not Found
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
"405":
description: Method not allowed
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/access-delegations:
post:
tags:
- Access Delegations
summary: Request delegated access on LogisticsObjects
description: Request an access delegation on a given LogisticsObjects
operationId: createAccessDelegationRequest
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AccessDelegation'
required: true
responses:
"201":
description: Access Delegation Request has been created
headers:
Type:
description: Type of the created Access Delegation Request
required: true
style: simple
schema:
type: string
format: uri
Location:
description: Location of the created Access Delegation Request
required: true
style: simple
schema:
type: string
format: uri
"400":
description: Invalid Access Delegation Object
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
/action-requests/{actionRequestId}:
get:
tags:
- Action Requests
summary: Retrieve an ActionRequest
description: Get any type of ActionRequest by the id
operationId: getActionRequest
parameters:
- name: actionRequestId
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
headers:
Type:
description: Type of the retrieved Action Request
required: true
style: simple
schema:
type: string
format: uri
Last-Modified:
description: The date and time of the most recent change to the Action Request
required: true
style: simple
schema:
type: string
format: HTTP-date
example: "Tue, 21 Feb 2023 07:28:00 GMT"
content:
application/ld+json:
schema:
oneOf:
- $ref: '#/components/schemas/ActionRequest'
- $ref: '#/components/schemas/AccessDelegationRequest'
- $ref: '#/components/schemas/ChangeRequest'
- $ref: '#/components/schemas/SubscriptionRequest'
"301":
description: The URI of the Action Request has permanently changed.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"302":
description: The URI of the Action Request has temporarily moved.
headers:
Location:
description: New location of the LogisticsObject
required: true
style: simple
schema:
type: string
format: uri
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Logistics Object not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
patch:
tags:
- Action Requests
summary: "INTERNAL: Update an ActionRequest"
description: Update the status of an ActionRequest
operationId: updateActionRequest
parameters:
- name: actionRequestId
in: path
required: true
schema:
type: string
- name: status
in: query
required: true
schema:
type: string
enum: [https://onerecord.iata.org/ns/api#REQUEST_ACCEPTED, https://onerecord.iata.org/ns/api#REQUEST_REJECTED, https://onerecord.iata.org/ns/api#REQUEST_REVOKED]
responses:
"204":
description: The Action Request was successfully updated
headers:
Type:
description: Type of retrieved Action Request
required: true
style: simple
schema:
type: string
format: uri
"400":
description: The update request body is invalid
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Action Request not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"415":
description: Unsupported Content Type
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"422":
description: Unprocessable request
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
delete:
tags:
- Action Requests
summary: Revoke an Action Request
description: Revoke an Action Request
operationId: revokeActionRequest
parameters:
- name: actionRequestId
in: path
required: true
schema:
type: string
responses:
"204":
description: The Action Request was successfully deleted
"401":
description: Not authenticated
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"403":
description: Not authorized
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Action Request not found
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
AccessDelegation:
description: Access to a Logistics Object delegated to an Organization
properties:
https://onerecord.iata.org/ns/api#hasDescription:
description: Reason for the request (optional)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasPermission:
description: Description not available
items:
$ref: '#/components/schemas/Permission'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#AccessDelegation
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasLogisticsObject:
description: A reference to a cargo:LogisticsObject.
items:
$ref: '#/components/schemas/LogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedFor:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#notifyRequestStatusChange:
description: Flag specifying if the requestor wants to receive Notification
from the publisher when the status of an action request changed, default=FALSE
items:
type: boolean
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
OperationObject:
description: Object to modify in the PATCH request
properties:
https://onerecord.iata.org/ns/api#hasValue:
description: Updated value for the field
items:
maxItems: 1
minItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#OperationObject
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasDatatype:
description: Data type of the field to update, must be a valid URI, e.g.
http://www.w3.org/2001/XMLSchema#int
items:
maxItems: 1
minItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Error:
description: Error model
properties:
https://onerecord.iata.org/ns/api#hasTitle:
description: Short summary of the error
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasErrorDetail:
description: Error details
items:
$ref: '#/components/schemas/ErrorDetail'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Error
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
AccessPermissions:
description: Access permissions granted to a logistics agent for a logistics
object
properties:
https://onerecord.iata.org/ns/api#hasPermission:
description: Description not available
items:
$ref: '#/components/schemas/Permission'
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#AccessPermissions
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasLogisticsObject:
description: A reference to a cargo:LogisticsObject.
items:
$ref: '#/components/schemas/LogisticsObject'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/api#hasLogisticsAgent:
description: Description not available
items:
$ref: '#/components/schemas/LogisticsAgent'
maxItems: 1
minItems: 1
nullable: true
type: array
type: object
Verification:
description: Description not available
properties:
https://onerecord.iata.org/ns/api#hasError:
description: Error object(s) if the processing was not successful
items:
$ref: '#/components/schemas/Error'
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRevision:
description: Revision number of the Logistics Object, starting with 0 for
changing the initial revision of a Logistics Object
items:
format: int32
maxItems: 1
minItems: 1
type: integer
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Verification
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasLogisticsObject:
description: A reference to a cargo:LogisticsObject.
items:
$ref: '#/components/schemas/LogisticsObject'
maxItems: 1
minItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Change:
description: Description not available
properties:
https://onerecord.iata.org/ns/api#hasRevision:
description: Revision number of the Logistics Object, starting with 0 for
changing the initial revision of a Logistics Object
items:
format: int32
maxItems: 1
minItems: 1
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasDescription:
description: Reason for the request (optional)
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Change
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasLogisticsObject:
description: A reference to a cargo:LogisticsObject.
items:
$ref: '#/components/schemas/LogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasVerificationRequest:
description: Link to the Verification Request
items:
$ref: '#/components/schemas/VerificationRequest'
nullable: true
type: array
https://onerecord.iata.org/ns/api#notifyRequestStatusChange:
description: Flag specifying if the requestor wants to receive Notification
from the publisher when the status of an action request changed, default=FALSE
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasOperation:
description: Operation(s) to apply as PATCH on a Logistics Object
items:
$ref: '#/components/schemas/Operation'
minItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Operation:
description: Operation Request contained in the PATCH body
properties:
https://onerecord.iata.org/ns/api#s:
description: Operation objects MUST have exactly one "s", subject, member.
The value of this member MUST be one of IRI or blank node.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#p:
description: Operations objects must have exactly one p, predicate, member.
The value of this member must be an URI, e.g. https://onerecord.iata.org/ns/cargo#hasGoodsDescription
items:
maxItems: 1
minItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#o:
description: Description not available
items:
$ref: '#/components/schemas/OperationObject'
maxItems: 1
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Operation
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#op:
description: Description not available
items:
$ref: '#/components/schemas/PatchOperation'
maxItems: 1
minItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
ChangeRequest:
description: Change Request containing updates on a Logistics Object
properties:
https://onerecord.iata.org/ns/api#hasError:
description: Error object(s) if the processing was not successful
items:
$ref: '#/components/schemas/Error'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedAt:
description: Datetime when the request was created
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedAt:
description: The datetime when the action request was revoked.
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRequestStatus:
description: Description not available
items:
$ref: '#/components/schemas/RequestStatus'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRevision:
description: Revision number of the Logistics Object, starting with 0 for
changing the initial revision of a Logistics Object
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasChange:
description: Contains submitted Change object
items:
$ref: '#/components/schemas/Change'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedBy:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedBy:
description: Organization Identifier that represents the Organization that
has requested the action
items:
$ref: '#/components/schemas/Organization'
maxItems: 1
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#ChangeRequest
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasVerificationRequest:
description: Link to the Verification Request
items:
$ref: '#/components/schemas/VerificationRequest'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
VerificationRequest:
description: Description not available
properties:
https://onerecord.iata.org/ns/api#hasError:
description: Error object(s) if the processing was not successful
items:
$ref: '#/components/schemas/Error'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedAt:
description: Datetime when the request was created
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedAt:
description: The datetime when the action request was revoked.
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRequestStatus:
description: Description not available
items:
$ref: '#/components/schemas/RequestStatus'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedBy:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedBy:
description: Organization Identifier that represents the Organization that
has requested the action
items:
$ref: '#/components/schemas/Organization'
maxItems: 1
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#VerificationRequest
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasVerification:
description: Links to the Verification class
items:
$ref: '#/components/schemas/Verification'
maxItems: 1
minItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Notification:
description: Notification sent by the publisher to the subscriber
properties:
https://onerecord.iata.org/ns/api#isTriggeredBy:
description: Optional URI to the ChangeRequest that triggered a Notification
if the eventType is one of CHANGE_REQUEST_ACCEPTED, CHANGE_REQUEST_REJECT,
or CHANGE_REQUEST_FAILED
items:
$ref: '#/components/schemas/ActionRequest'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasEventType:
description: Description not available
items:
$ref: '#/components/schemas/NotificationEventType'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasLogisticsObjectType:
description: The type of cargo:LogisticsObject in the notification e.g.
https://onerecord.iata.org/ns/cargo#Piece
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Notification
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasLogisticsObject:
description: A reference to a cargo:LogisticsObject.
items:
$ref: '#/components/schemas/LogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasChangedProperty:
description: List of all changed properties as IRIs after a ChangeRequest
was successfully applied, e.g. [https://onerecord.iata.org/ns/cargo#hasVolumetricWeight,
https://onerecord.iata.org/ns/cargo/#hasGoodsDescription]
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/api#hasTopic:
description: The Logistics Object type or specific Logistics Object to which
the subscription belongs to e.g. https://onerecord.iata.org/Piece or https://1r.example.com/7f01363f-0c6a-4414-be48-d3692e219b91
items:
type: string
nullable: true
type: array
type: object
ErrorDetail:
description: Error details that belong to an error
properties:
https://onerecord.iata.org/ns/api#hasProperty:
description: Property of the object for which the error applies in IRI format,
i.e. https://onerecord.iata.org/ns/cargo#hasVolumetricWeight
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#ErrorDetail
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasCode:
description: Error code is a numeric or alphanumeric code that can be used
to determine the source of the error and why it occured.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasResource:
description: URI of the object where the error occurred
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/api#hasMessage:
description: Message that describes the error
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
TopicType:
description: Description not available
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#TopicType
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
SubscriptionRequest:
description: SubscriptionRequest initiated by subscribers to publisher (data
holder) for themselves or for a third party subscriber.
properties:
https://onerecord.iata.org/ns/api#hasError:
description: Error object(s) if the processing was not successful
items:
$ref: '#/components/schemas/Error'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedAt:
description: Datetime when the request was created
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedAt:
description: The datetime when the action request was revoked.
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRequestStatus:
description: Description not available
items:
$ref: '#/components/schemas/RequestStatus'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedBy:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedBy:
description: Organization Identifier that represents the Organization that
has requested the action
items:
$ref: '#/components/schemas/Organization'
maxItems: 1
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#SubscriptionRequest
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasSubscription:
description: Link to the requestors Subscription object with all subscription
information
items:
$ref: '#/components/schemas/Subscription'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
ServerInformation:
description: Information about the ONE Record server
properties:
https://onerecord.iata.org/ns/api#hasSupportedEncoding:
description: Optional list of supported encodings of the ONE Record server,
e.g. gzip
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasSupportedLanguage:
description: Supported languages of the ONE Record API, minimum is en-US
(American English)
items:
minItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasSupportedOntologyVersion:
description: Supported ontology versions on the server, MUST be versioned
IRIs
items:
minItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasServerEndpoint:
description: ONE Record API endpoint
items:
maxItems: 1
minItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#ServerInformation
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasSupportedOntology:
description: Supported ontologies on the server, MUST be non-versioned IRIs
items:
minItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasDataHolder:
description: The data holder of the servers data.
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/api#hasSupportedApiVersion:
description: Supported ONE Record API versions by the server, MUST include
at least one supported version.
items:
minItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasSupportedContentType:
description: Supported content types of the server, MUST contain at least
application/ld+json
items:
minItems: 1
type: string
nullable: true
type: array
type: object
ActionRequest:
description: Superclass for all kinds of requests (i.e someone requsted something
(e.g. subscription, access, etc.) at a publisher/holder of a logistics object)
properties:
https://onerecord.iata.org/ns/api#hasError:
description: Error object(s) if the processing was not successful
items:
$ref: '#/components/schemas/Error'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedAt:
description: Datetime when the request was created
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedAt:
description: The datetime when the action request was revoked.
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRequestStatus:
description: Description not available
items:
$ref: '#/components/schemas/RequestStatus'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedBy:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedBy:
description: Organization Identifier that represents the Organization that
has requested the action
items:
$ref: '#/components/schemas/Organization'
maxItems: 1
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#ActionRequest
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
NotificationEventType:
description: Description not available
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#NotificationEventType
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
SubscriptionEventType:
description: Description not available
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#SubscriptionEventType
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
AccessDelegationRequest:
description: Delegation Request to 3rd parties
properties:
https://onerecord.iata.org/ns/api#hasError:
description: Error object(s) if the processing was not successful
items:
$ref: '#/components/schemas/Error'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedAt:
description: Datetime when the request was created
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedAt:
description: The datetime when the action request was revoked.
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasAccessDelegation:
description: Description not available
items:
$ref: '#/components/schemas/AccessDelegation'
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasRequestStatus:
description: Description not available
items:
$ref: '#/components/schemas/RequestStatus'
maxItems: 1
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRevokedBy:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#isRequestedBy:
description: Organization Identifier that represents the Organization that
has requested the action
items:
$ref: '#/components/schemas/Organization'
maxItems: 1
minItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#AccessDelegationRequest
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
PatchOperation:
description: Description not available
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#PatchOperation
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Permission:
description: Description not available
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Permission
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Collection:
description: Used as response of endpoints returning a collection of more than
one graph, i.e. more than one not linked subjects.
properties:
https://onerecord.iata.org/ns/api#hasTotalItems:
description: The number of total items contained in a collection
items:
format: int32
type: integer
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Collection
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
AuditTrail:
description: Audit trail of a Logistics Object
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#AuditTrail
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#hasActionRequest:
description: Link any type of Action Request
items:
$ref: '#/components/schemas/ActionRequest'
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasChangeRequest:
description: Recorded change requests in the Audit Trail of a Logistics
Object
items:
$ref: '#/components/schemas/ChangeRequest'
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasLatestRevision:
description: Latest revision of the Logistics Object. Starting with revision
0
items:
format: int32
type: integer
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Subscription:
description: Subscription information sent to the publisher
properties:
https://onerecord.iata.org/ns/api#hasTopicType:
description: Description not available
items:
$ref: '#/components/schemas/TopicType'
nullable: true
type: array
https://onerecord.iata.org/ns/api#includeSubscriptionEventType:
description: An array used to indicate the specific types of notifications
that the subscriber desires to receive from the publisher. The subscriber
is required to specify their preferences on a per-type basis
items:
$ref: '#/components/schemas/SubscriptionEventType'
minItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasSubscriber:
description: Description not available
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasContentType:
description: Content types that the subscriber wants to receive in the notifications,
e.g. application/ld+json
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#expiresAt:
description: 'Expiry date as date time of the subscription information that
supports caching but does not require the ONE Record client to store the
datetime when the Subscription object was received; if not given: the
information does not expire'
items:
format: date-time
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/api#hasDescription:
description: Reason for the request (optional)
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#Subscription
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/api#notifyRequestStatusChange:
description: Flag specifying if the requestor wants to receive Notification
from the publisher when the status of an action request changed, default=FALSE
items:
maxItems: 1
minItems: 1
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/api#sendLogisticsObjectBody:
description: Flag specifying if the publisher should send the whole logistics
object or not in the notification object
items:
maxItems: 1
type: boolean
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/api#hasTopic:
description: The Logistics Object type or specific Logistics Object to which
the subscription belongs to e.g. https://onerecord.iata.org/Piece or https://1r.example.com/7f01363f-0c6a-4414-be48-d3692e219b91
items:
maxItems: 1
minItems: 1
type: string
nullable: true
type: array
type: object
RequestStatus:
description: Description not available
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/api#RequestStatus
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
OtherIdentifier:
description: Other identifiers
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#OtherIdentifier
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#otherIdentifierType:
description: Identifier type or description
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#textualValue:
description: Textual value filled on use context (eg. characteristic colour,
contactDetail mail address, etc.)
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Address:
description: Address details
properties:
https://onerecord.iata.org/ns/cargo#textualPostCode:
description: Postal / ZIP code
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#country:
description: Country details. Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#streetAddressLines:
description: Street address including street name, street number, building
number, apartment etc
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#addressCode:
description: Address identifier using special coding systems e.g. US CBP
FIRMS code
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#cityCode:
description: UN/LOCODE city code (5 letter) or IATA city code (3 letter)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Address
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#postalCode:
description: Postal / ZIP code
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#postOfficeBox:
description: Post Office box number / code
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#regionCode:
description: Region/ State / Department. Refer ISO 3166-2
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
type: object
BookingPreferences:
description: BookingPreferences details
properties:
https://onerecord.iata.org/ns/cargo#includedViaPoints:
description: Locations or stations to included in the routing
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#excludedViaPoints:
description: Locations of excluded Via Points
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingPreferences
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#preferredTransportId:
description: When part of the Request it refers to the preferred Transport
ID from the customer. When part of the BookingOption (offer or actual
booking) it refers to the expected Transport ID or flight
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#priceReferenceId:
description: Reference to a price reference if existing (e.g. Allotment
number, contract reference, etc.)
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#aircraftPossibilityCode:
description: Type of aircraft to be used if any specific requirements (e.g.
Pure freighter, etc.)
items:
$ref: '#/components/schemas/AircraftPossibilityCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#maxSegments:
description: Maximum number of segments for the transportation of the goods.
1 means direct flight
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
LogisticsAction:
description: 'Superclass: LogisticsAction is a specific task with a specific
result performed on one or more physical LOs by one party in the context of
an Activity'
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LogisticsAction
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionTimeType:
description: Enum stating the type of the Action
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionStartTime:
description: DateTime holding the start time of the Action; Type is indicated
through ActionType property
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#performedAt:
description: Reference to the Location the Action was performed at
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedActivity:
description: Reference to the Activity the Action was performed for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionEndTime:
description: DateTime holding the end time of the Action; Type is indicated
through ActionType property
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
Check:
description: Action to describe a check
properties:
https://onerecord.iata.org/ns/cargo#checkedObject:
description: Reference to the checked Object
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checker:
description: Reference to the Actor performing the Check
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checkTotalResult:
description: Reference to the result of the Check
items:
$ref: '#/components/schemas/CheckTotalResult'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Check
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionTimeType:
description: Enum stating the type of the Action
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionStartTime:
description: DateTime holding the start time of the Action; Type is indicated
through ActionType property
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#performedAt:
description: Reference to the Location the Action was performed at
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedActivity:
description: Reference to the Activity the Action was performed for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#usedTemplate:
description: Reference to the Template used in the Check
items:
$ref: '#/components/schemas/CheckTemplate'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionEndTime:
description: DateTime holding the end time of the Action; Type is indicated
through ActionType property
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
Adjustments:
description: Adjustments in the context of CASS records
properties:
https://onerecord.iata.org/ns/cargo#correctionSerialNumber:
description: Serial Number of the correction
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Adjustments
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#correctionNumber:
description: Number of the adjustment
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#reasonsForAdjustments:
description: A free text for user to include a reason for correction
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Product:
description: Product details
properties:
https://onerecord.iata.org/ns/cargo#manufacturer:
description: Manufacturing company details and contacts
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherCharacteristics:
description: Characteristics of the product
items:
$ref: '#/components/schemas/Characteristic'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uniqueIdentifier:
description: Manufacturer's unique product identifier
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Product
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#describedObjects:
description: Reference to the Items or Pieces in which the product can be
found.
items:
$ref: '#/components/schemas/PhysicalLogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#description:
description: Natural language description if required
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsCommodityDescription:
description: Commodity description
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsCommodityName:
description: If no Code provided, name of commodity
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsCode:
description: Harmonized Commodity code, refer to hsType used. 6 minimum
digits are expected.
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsType:
description: Reference identifying the type of standard code to be used
for the Commodity Classification (Brussels Tariff Nomenclature, EU Harmonized
System Code, UN Standard International Trade Classification). Mandatory
if the commodity code is more than 6 digits
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#commodityItemNumber:
description: Indicates the specific commodity on which the rate class code
is applied
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
PieceGroup:
description: PieceGroup details
properties:
https://onerecord.iata.org/ns/cargo#pieceGroupGrossWeight:
description: Total gross weight of the piece group
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dryIceWeight:
description: Weight of dry ice
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupId:
description: Identifier of the piece group, increasing integers
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#PieceGroup
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#pieceGroupCount:
description: Number of pieces in the piece group
items:
format: int32
type: integer
nullable: true
type: array
type: object
Item:
description: Item details
properties:
https://onerecord.iata.org/ns/cargo#weight:
description: Weight of the item
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Item
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#dimensions:
description: Dimensions details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#targetCountry:
description: Item target country. Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ofProduct:
description: Reference to the Product describing the Item
items:
$ref: '#/components/schemas/Product'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#productionCountry:
description: Production country details. Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#inPiece:
description: Reference to the Piece this Item or Piece is contained in
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#itemQuantity:
description: Quantity of the item when applicable, with associated units
of measure
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#quantityForUnitPrice:
description: Product quantity for unit price - e.g. 12 (eggs for one USD
1)
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#unitPrice:
description: Product price per unit in the base
items:
$ref: '#/components/schemas/CurrencyValue'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#lotNumber:
description: Production lot number / reference
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#batchNumber:
description: Production batch number / reference
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#expiryDate:
description: Product expiry date - e.g. for perishables goods or goods with
programmed obsolescence
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#productionDate:
description: Production date
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ExternalReference:
description: Reference documents details
properties:
https://onerecord.iata.org/ns/cargo#originator:
description: Document originator details and contacts
items:
$ref: '#/components/schemas/Company'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#validUntil:
description: Validity end date (date of expiry) based on usage context
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ExternalReference
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#createdAtLocation:
description: Location of the document, e.g. location where the document
was emitted
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#documentName:
description: 'If no DocumentType provided, name of the referenced document '
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#documentIdentifier:
description: Unique document identifier
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#documentVersion:
description: Document version number
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#referenceForObjects:
description: References to the LogisticsObjects referring to this external
reference
items:
$ref: '#/components/schemas/LogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#documentLink:
description: Link to the document, e.g. URL of the file where it is hosted
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#checksum:
description: Checksum of the document to validate its integrity
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#validFrom:
description: Validity start date based on usage context
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#documentType:
description: Type of the referenced document . Can refer UNEDIFACT 11 e.g.
740 - Air Waybill, but not limited to
items:
type: string
nullable: true
type: array
type: object
ExecutionStatus:
description: Restricted code list for the execution status of activities
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ExecutionStatus
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
Actor:
description: 'Superclass: Actors are Persons or entities acting like a single
person'
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Actor
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#associatedOrganization:
description: Reference to the Organization the Actor is associated with
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
PublicAuthority:
description: PublicAuthorities are Organizations of the state on public interests,
such as customs
properties:
https://onerecord.iata.org/ns/cargo#parentOrganization:
description: Reference to the parent Organization
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#basedAtLocation:
description: Reference to the Location where the Organization is based at
or headquartered
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#PublicAuthority
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shortName:
description: Short name of the Organization if any
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#subOrganization:
description: References to all sub-Organizations
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
EpermitConsignment:
description: Details of the pieces (Live animals) of the permit and specific
information such as quantity measured and used to date quota
properties:
https://onerecord.iata.org/ns/cargo#usedToDateQuotaQuantity:
description: total number of specimens exported in the current calendar
year and the current annual quota for the species concerned (box 11a)
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#EpermitConsignment
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#consignmentItems:
description: Reference to te pieces (Live Animals) of the permit
items:
$ref: '#/components/schemas/PieceLiveAnimals'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#epermit:
description: Reference to the Epermit of the consignment
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#examiningQuantity:
description: Quantity measured by the examining authority (box 14)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
DgDeclaration:
description: Dangerous goods declaration
properties:
https://onerecord.iata.org/ns/cargo#issuedForPiece:
description: Reference to the Piece the document was issued for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#handlingInformation:
description: 'Free text. This may include items such as Control temperature
for substances stabilized by temperature control, name and telephone number
of a responsible person for infectious substances. '
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#DgDeclaration
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#shipperDeclarationText:
description: Contains the shipper's declaration to comply with the regulations
text note. Free text . This field is mandatory for air (Air)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#aircraftLimitationInformation:
description: 'Contains the Special Handling Code related to the prescribed
limitation. Hardcoded to PASSENGER AND CARGO AIRCRAFT or CARGO AIRCRAFT
ONLY. This field is mandatory for air (Air) '
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#exclusiveUseIndicator:
description: Indicates an exclusive use shipment
items:
type: boolean
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#complianceDeclarationText:
description: 'Contains the warning message complying with the regulations
text note. This field is mandatory for air (Air) '
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
DgProductRadioactive:
description: 'Details of the radioactive products '
properties:
https://onerecord.iata.org/ns/cargo#forProductDg:
description: Reference to the ProductDg this DgProductRadioactive details
items:
$ref: '#/components/schemas/ProductDg'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#fissileExceptionReference:
description: Fissile exception reference, mandatory if Fissile Exception
Indicator is true.
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#DgProductRadioactive
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#isotopes:
description: DgRadioactiveIsotope.
items:
$ref: '#/components/schemas/DgRadioactiveIsotope'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportIndexNumeric:
description: Radioactive Transport-Index value of the package or all packed
in one. Conditionally mandatory and applies to categories II-Yellow and
III-Yellow only; field only contains the value, if printed, TI must be
added as a prefix to the value to be printed in the Packing Instructions
column
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dgRaTypeCode:
description: 'The category of the package or all packed in one. Complete
text to be transmitted: I-White, II-Yellow, III-Yellow instead of I, II,
III'
items:
$ref: '#/components/schemas/RaTypeCode'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#fissileExceptionIndicator:
description: Indicates if Fissile is excepted
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
CarrierProduct:
description: Carrier product details
properties:
https://onerecord.iata.org/ns/cargo#productCode:
description: Carrier's product code
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#productDescription:
description: Carrier's product description
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CarrierProduct
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#serviceLevelCode:
description: Service level code
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
type: object
Booking:
description: Booking object refers to a confirmed booking
properties:
https://onerecord.iata.org/ns/cargo#bookingRequest:
description: Reference to the Booking Request
items:
$ref: '#/components/schemas/BookingRequest'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Booking
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#issuedForWaybill:
description: Reference to the Waybill object
items:
$ref: '#/components/schemas/Waybill'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillPrefix:
description: Prefix used for the Waybill Number. Refer to IATA Airlines
Codes
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#updateBookingOptionRequests:
description: References to BookingOptionRequests that request to update
the Booking
items:
$ref: '#/components/schemas/BookingOptionRequest'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#activitySequences:
description: Information about the Activities that are part of the Service
and their sequence
items:
$ref: '#/components/schemas/ActivitySequence'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillNumber:
description: House or Master Waybill unique identifier
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#bookingStatus:
description: Status of the Booking
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
type: object
RegulatedEntity:
description: Regulated Entity
properties:
https://onerecord.iata.org/ns/cargo#regulatedEntityExpiryDate:
description: Expiry date 4 digits month/year
items:
format: date-time
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#RegulatedEntity
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#regulatedEntityIdentifier:
description: Regulated entity identifier as per IATA e-CSD/CSD Resolution
65
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#owningOrganization:
description: Reference to the Organization for which the RegulatedEntity
information is valid
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#regulatedEntityCategory:
description: Category code of the Regulated Entity
items:
$ref: '#/components/schemas/RegulatedEntityCategoryCode'
nullable: true
type: array
type: object
PieceDg:
description: Dangerous Goods subtype of Piece
properties:
https://onerecord.iata.org/ns/cargo#overpackTypeCode:
description: 'Identifies the Logistic Unit package type. UN Recommendation
on Transport of Dangerous Goods, Model Regulations '
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#overpackT1:
description: 'A single number assigned to a package, overpack or freight
container to provide control over radiation exposure. '
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#goodsDescription:
description: Description of goods, for the BookingShipment the commodity
list defined by Modernizing Cargo Distribution MCD working group can be
used as a referential.
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#PieceDg
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contentProducts:
description: Reference to the Products describing the content of the Piece,
mandatory if no data on Item level is used
items:
$ref: '#/components/schemas/Product'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dimensions:
description: Dimensions details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ofShipment:
description: Reference to the Shipment the Piece is assigned to
items:
$ref: '#/components/schemas/Shipment'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#containedPieces:
description: Details of contained piece(s)
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packageMarkCoded:
description: Reference identifying how the package is marked. Field is hardcode
to "SSCC-18", "UPC" or "Other"
items:
$ref: '#/components/schemas/PackageMarkCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#inPiece:
description: Reference to the Piece this Item or Piece is contained in
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagingType:
description: 'Packaging details '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#overpackIndicator:
description: 'Overpack indicator '
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nvdForCustoms:
description: When no value is declared for Customs, this field may be completed
with the value TRUE otherwise FALSE
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shippingMarks:
description: Shipping marks
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dgDeclaration:
description: Reference to the Dangerous Goods declaration
items:
$ref: '#/components/schemas/DgDeclaration'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#fulfillsUldTypeCode:
description: Text holding an ULD Type Code if the Piece fulfills it before
UnitComposition
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#textualHandlingInstructions:
description: Strings to provide free text handling instructions such as
SSR and OSI
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nvdForCarriage:
description: When no value is declared for Carriage, this field may be completed
with the value TRUE otherwise FALSE
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#securityDeclarations:
description: Security details of the piece
items:
$ref: '#/components/schemas/SecurityDeclaration'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#allPackedInOneIndicator:
description: 'A statement identifying that the dangerous goods listed above
are all contained in the same outer packaging. Takes the form All packed
in one aaaa (description of packaging type) x nn (number of packages).
Applies to air transport only. (Air) '
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#temperatureInstructions:
description: Temperature instructions if a specific range
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadType:
description: Load type of the shipment or piece (Bulk, ULD, Pallet, Loose)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#qValueNumeric:
description: 'Most instances of all packed in one will require the addition
of the Q value which 1. Applies to air transport only. (Air) '
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#stackable:
description: Stackable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagedeIdentifier:
description: SSCC-18 code for the value of the package mark, company or
bar code, free text, pallet code, etc.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#grossWeight:
description: Weight details
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#coload:
description: Coload indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#containedItems:
description: Reference to the item(s) contained in the piece
items:
$ref: '#/components/schemas/Item'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contentProductionCountry:
description: Goods production country, mandatory when there are no Items.
Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#slac:
description: Shipper's Load And Count ( total contained piece count as
provided by shipper)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialHandlingCodes:
description: Three-letter special handling code (SPH)
items:
$ref: '#/components/schemas/SpecialHandlingCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#customsInformation:
description: Customs details
items:
$ref: '#/components/schemas/CustomsInformation'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#overpackCriticalitySafetyIndexNumeric:
description: 'Applies to fissile material only, other than fissile excepted.
A numeric value expressed to one decimal place preceded by the letters
CSI. '
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#upid:
description: Unique Piece Identifier (UPID) of the piece. Refer IATA Recommended
Practice 1689
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#turnable:
description: Turnable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
type: object
DirectionType:
description: Restricted code list for the direction of a MovementTime
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#DirectionType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
StationRemarks:
description: StationRemarks details
properties:
https://onerecord.iata.org/ns/cargo#station:
description: 'Reference to the station (Airport), mandatory '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#StationRemarks
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#remarksText:
description: Details of the remarks, mandatory
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
ItemDg:
description: Dangerous Goods subtype of Item
properties:
https://onerecord.iata.org/ns/cargo#reportableQuantity:
description: Reportable quantities, To and from the USA only
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#weight:
description: Weight of the item
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#supplementaryInfoPrefix:
description: Additional information that may be added in addition to the
proper shipping name to more fully describe the goods or to identify a
particular condition
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ItemDg
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#dimensions:
description: Dimensions details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#netWeightMeasure:
description: The total net weight of dangerous goods transported of this
line item. For air transport the value must be the volume or mass in each
package.
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ofProduct:
description: Reference to the Product describing the Item
items:
$ref: '#/components/schemas/Product'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#inPiece:
description: Reference to the Piece this Item or Piece is contained in
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#itemQuantity:
description: Quantity of the item when applicable, with associated units
of measure
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#unitPrice:
description: Product price per unit in the base
items:
$ref: '#/components/schemas/CurrencyValue'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#batchNumber:
description: Production batch number / reference
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#supplementaryInfoSuffix:
description: Additional information that may be added in addition to the
proper shipping to more fully describe the goods or to identify a particular
condition
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#productionDate:
description: Production date
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#targetCountry:
description: Item target country. Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#emergencyContact:
description: Contains the Emergency contact name (e.g. the name of the agency)
and phone number (min required)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#productionCountry:
description: Production country details. Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#quantityForUnitPrice:
description: Product quantity for unit price - e.g. 12 (eggs for one USD
1)
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#lotNumber:
description: Production lot number / reference
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#expiryDate:
description: Product expiry date - e.g. for perishables goods or goods with
programmed obsolescence
items:
format: date-time
type: string
nullable: true
type: array
type: object
ULDBasicPiece:
description: ULDBasicPiece details
properties:
https://onerecord.iata.org/ns/cargo#pieceGroupGrossWeight:
description: Total gross weight of the piece group
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldLoadingIndicator:
description: Indicator related to ULD loading (e.g. Main deck only)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dryIceWeight:
description: Weight of dry ice
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupId:
description: Identifier of the piece group, increasing integers
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ULDBasicPiece
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#slac:
description: Shipper's Load And Count ( total contained piece count as
provided by shipper)
items:
format: int32
type: integer
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#pieceGroupCount:
description: Number of pieces in the piece group
items:
format: int32
type: integer
nullable: true
type: array
type: object
BookingShipment:
description: Simplified shipment object that is to be used only for the distribution
scope where only a subset of data is known priori to operational phase.
properties:
https://onerecord.iata.org/ns/cargo#forBookingOptionRequest:
description: Reference to the BookingOptionRequest the information of the
LogisticsObject is detailing
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#temperatureInstructions:
description: Temperature instructions if a specific range
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#densityGroupCode:
description: Density Group Code as defined in cXML code list 2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingShipment
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#pieceGroups:
description: Reference to the Piece groups of the shipment
items:
$ref: '#/components/schemas/PieceGroup'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#consolidationIndicator:
description: Indication if the shipment is a consolidation
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialServiceRequests:
description: Special service requests
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#expectedCommodity:
description: Expected commodity of the shipment as per Commodity Code list.
Either this or expected HS code required
items:
$ref: '#/components/schemas/CommodityCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#expectedHScode:
description: Expected commodity of the shipment as per HS code (at least
6 digits). Either this or expectedCommodityCode required
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialHandlingCodes:
description: Three-letter special handling code (SPH)
items:
$ref: '#/components/schemas/SpecialHandlingCode'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#textualHandlingInstructions:
description: Strings to provide free text handling instructions such as
SSR and OSI
items:
type: string
nullable: true
type: array
type: object
Person:
description: Person details
properties:
https://onerecord.iata.org/ns/cargo#employeeId:
description: Employee ID
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#middleName:
description: Middle name/ other name
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#firstName:
description: First name / given name
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#department:
description: Department / Division / Unit
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#jobTitle:
description: Job title / position
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Person
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#associatedOrganization:
description: Reference to the Organization the Actor is associated with
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#salutation:
description: 'Salutation '
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#documents:
description: Linked documents to the person, e.g. driver's license, ID,
etc.
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactRole:
description: Contact type - e.g. Emergency contact, Customs contact, Customer
contact
items:
$ref: '#/components/schemas/ContactRole'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#lastName:
description: Last name / family name / surname
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
BookingOption:
description: Booking details
properties:
https://onerecord.iata.org/ns/cargo#additionalInformation:
description: Additional information related to the Booking Option, e.g.
sales details
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#bookingTimes:
description: Information about the Booking Times of a provided Booking Option
items:
$ref: '#/components/schemas/BookingTimes'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#forBookingOptionRequest:
description: Reference to the BookingOptionRequest the information of the
LogisticsObject is detailing
items:
$ref: '#/components/schemas/BookingOptionRequest'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#stationRemarks:
description: Remarks related to specific stations in the routing (e.g. Embargo
in XXX)
items:
$ref: '#/components/schemas/StationRemarks'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#requestMatch:
description: Indicates if the Booking Option is a match to the Booking Option
Request preferences
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingOption
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#price:
description: Price of the Booking (if different from the offer)
items:
$ref: '#/components/schemas/Price'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#unitsPreference:
description: Reference to unit preferences of the request (e.g. kg or cm)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportLegs:
description: Reference to the Transport Legs of the proposed routing
items:
$ref: '#/components/schemas/TransportLegs'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrierProduct:
description: Reference to the Carrier product if known
items:
$ref: '#/components/schemas/CarrierProduct'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#forBookingRequest:
description: Reference to the Booking Request the of the Booking Option
items:
$ref: '#/components/schemas/BookingRequest'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#statusBookingOption:
description: Status of the Booking Option
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrier:
description: Reference to the operating carrier
items:
$ref: '#/components/schemas/Carrier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#offerValidTo:
description: Date and time of end of offer validity
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#offerValidFrom:
description: Date and time of beginning of offer validity
items:
format: date-time
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#alternatives:
description: Description of the alternatives proposed that do not match
the Booking Option Request
items:
type: string
nullable: true
type: array
type: object
Organization:
description: 'Superclass: Organizations represent a kind of Agent corresponding
to social institutions such as companies, societies, etc'
properties:
https://onerecord.iata.org/ns/cargo#parentOrganization:
description: Reference to the parent Organization
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#basedAtLocation:
description: Reference to the Location where the Organization is based at
or headquartered
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Organization
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shortName:
description: Short name of the Organization if any
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#subOrganization:
description: References to all sub-Organizations
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
CheckTemplate:
description: Body of a Check referencing various Questions
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#templatePurpose:
description: Purpose of the template
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CheckTemplate
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#date:
description: DateTime on which the CheckTemplate was released
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#usedInCheck:
description: Reference to the Check the template was used in
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#version:
description: Version of the template
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#questions:
description: References to all Questions that are part of this template
items:
$ref: '#/components/schemas/Question'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#legacyTemplate:
description: Reference to an ExternalReference holding a legacy template
outside of ONE Record, such as a photo or pdf of a checksheet
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
type: object
EventTimeType:
description: Restricted code list for acceptable event times
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#EventTimeType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ContactRole:
description: Open code list for roles of a contact
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ContactRole
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
LogisticsService:
description: 'Superclass: LogisticsService is a sequence of Activities provided
by one Party to another'
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LogisticsService
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#activitySequences:
description: Information about the Activities that are part of the Service
and their sequence
items:
$ref: '#/components/schemas/ActivitySequence'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
TemperatureInstructions:
description: TemperatureInstructions details
properties:
https://onerecord.iata.org/ns/cargo#minTemperature:
description: Minimum temperature of the range
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#maxTemperature:
description: Maximum temperature of the range
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#TemperatureInstructions
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
SecurityDeclaration:
description: Security declaration details
properties:
https://onerecord.iata.org/ns/cargo#issuedBy:
description: Name of person (or employee ID) who issued the security status
items:
$ref: '#/components/schemas/Person'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#receivedFrom:
description: Regulated entity that tendered the consignment
items:
$ref: '#/components/schemas/RegulatedEntity'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#SecurityDeclaration
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#regulatedEntityAcceptor:
description: Information about the accepting regulated entity of the Security
Declaration
items:
$ref: '#/components/schemas/RegulatedEntity'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#issuedOn:
description: Date and time when the security status was issued
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#screeningMethods:
description: 'Screening methods which have been used to secure the cargo
PHS – Physical Inspection and/or hand search VCK - Visual check XRY- X-ray
equipment EDS - Explosive detection system EDD - Explosive detection dogsETD
- Explosive trace detection equipment - particles or vapor CMD - Cargo
metal detection AOM - Subjected to any other means: this entry should
be followed by free text specifying what other mean was used to secure
the cargo'
items:
$ref: '#/components/schemas/ScreeningMethod'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#securityStatus:
description: 'Security status indicator (CXML 1.13) - e.g. SPX- Cargo Secure
for Passenger and All-Cargo Aircraft '
items:
$ref: '#/components/schemas/SecurityStatus'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#issuedForPiece:
description: Reference to the Piece the document was issued for
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#additionalSecurityInformation:
description: Any additional information that may be required by an ICAO
Member State
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#groundsForExemption:
description: Exemption code - e.g. BIOM- Bio-Medical Samples SMUS - small
undersized shipments MAIL - mail BIOM - bio-medical samples DIPL - diplomatic
bags or diplomatic mail LFSM - life-saving materials NUCL - nuclear materials
TRNS - transfer or transshipment
items:
$ref: '#/components/schemas/ScreeningExemption'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#regulatedEntityIssuer:
description: Regulated entity issuing the Security Declaration
items:
$ref: '#/components/schemas/RegulatedEntity'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherRegulatedEntities:
description: Any other regulated entity that accepts custody of the cargo
and accepts the security status originally issued
items:
$ref: '#/components/schemas/RegulatedEntity'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherScreeningMethods:
description: Other methods used to secure the cargo
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Party:
description: Refers to a Company and its role in a specific context, e.g Company
A as shipper. Cargo-XML Code List 1.15 can be used as a reference with the
addition of "Notify Party"
properties:
https://onerecord.iata.org/ns/cargo#partyDetails:
description: Reference to the Agent described by the role of the Party
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#partyRole:
description: Role fo the Company in the context. Can refer to Code List
1.36 in the CXML Toolkit
items:
$ref: '#/components/schemas/ParticipantIdentifier'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Party
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
BookingRequest:
description: A party, usually the freight forwarder, creates the BookingRequest
in order to confirm the booking to the Carrier
properties:
https://onerecord.iata.org/ns/cargo#forBookingOption:
description: Reference to the BookingOption the LogisticsObject is detailing
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#booking:
description: Reference to the Booking
items:
$ref: '#/components/schemas/Booking'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingRequest
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#waybillPrefix:
description: Prefix used for the Waybill Number. Refer to IATA Airlines
Codes
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillNumber:
description: House or Master Waybill unique identifier
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
Loading:
description: Action to describe onloading or offloading TransportMeans
properties:
https://onerecord.iata.org/ns/cargo#onTransportMeans:
description: Reference to the TransportMeans that is being onloaded or offloaded
items:
$ref: '#/components/schemas/TransportMeans'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Loading
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionTimeType:
description: Enum stating the type of the Action
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionStartTime:
description: DateTime holding the start time of the Action; Type is indicated
through ActionType property
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadedUnits:
description: References to LoadingUnits onloaded or offloaded
items:
$ref: '#/components/schemas/LoadingUnit'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadedPieces:
description: References to Pieces onloaded or offloaded
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#performedAt:
description: Reference to the Location the Action was performed at
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadedMaterials:
description: References to Materials onloaded or offloaded
items:
$ref: '#/components/schemas/LoadingMaterial'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedActivity:
description: Reference to the Activity the Action was performed for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionEndTime:
description: DateTime holding the end time of the Action; Type is indicated
through ActionType property
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadingType:
description: Enum stating whether the LoadingAction describes onloading
or offloading
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadingPositionIdentifier:
description: Short text stating the loading position in the TransportMeans
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
Piece:
description: Individual piece or virtual grouping of pieces
properties:
https://onerecord.iata.org/ns/cargo#goodsDescription:
description: Description of goods, for the BookingShipment the commodity
list defined by Modernizing Cargo Distribution MCD working group can be
used as a referential.
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Piece
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contentProducts:
description: Reference to the Products describing the content of the Piece,
mandatory if no data on Item level is used
items:
$ref: '#/components/schemas/Product'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dimensions:
description: Dimensions details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ofShipment:
description: Reference to the Shipment the Piece is assigned to
items:
$ref: '#/components/schemas/Shipment'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#containedPieces:
description: Details of contained piece(s)
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packageMarkCoded:
description: Reference identifying how the package is marked. Field is hardcode
to "SSCC-18", "UPC" or "Other"
items:
$ref: '#/components/schemas/PackageMarkCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#inPiece:
description: Reference to the Piece this Item or Piece is contained in
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagingType:
description: 'Packaging details '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nvdForCustoms:
description: When no value is declared for Customs, this field may be completed
with the value TRUE otherwise FALSE
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shippingMarks:
description: Shipping marks
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#fulfillsUldTypeCode:
description: Text holding an ULD Type Code if the Piece fulfills it before
UnitComposition
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#textualHandlingInstructions:
description: Strings to provide free text handling instructions such as
SSR and OSI
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nvdForCarriage:
description: When no value is declared for Carriage, this field may be completed
with the value TRUE otherwise FALSE
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#securityDeclarations:
description: Security details of the piece
items:
$ref: '#/components/schemas/SecurityDeclaration'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#temperatureInstructions:
description: Temperature instructions if a specific range
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadType:
description: Load type of the shipment or piece (Bulk, ULD, Pallet, Loose)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#stackable:
description: Stackable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagedeIdentifier:
description: SSCC-18 code for the value of the package mark, company or
bar code, free text, pallet code, etc.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#grossWeight:
description: Weight details
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#coload:
description: Coload indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#containedItems:
description: Reference to the item(s) contained in the piece
items:
$ref: '#/components/schemas/Item'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contentProductionCountry:
description: Goods production country, mandatory when there are no Items.
Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#slac:
description: Shipper's Load And Count ( total contained piece count as
provided by shipper)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialHandlingCodes:
description: Three-letter special handling code (SPH)
items:
$ref: '#/components/schemas/SpecialHandlingCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#customsInformation:
description: Customs details
items:
$ref: '#/components/schemas/CustomsInformation'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#upid:
description: Unique Piece Identifier (UPID) of the piece. Refer IATA Recommended
Practice 1689
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#turnable:
description: Turnable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
type: object
LoadingUnit:
description: Common loading unit/container details
properties:
https://onerecord.iata.org/ns/cargo#inUnitComposition:
description: Description not available
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#tareWeight:
description: Tare weight of the empty ULD
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#remarks:
description: Remarks or Supplement Information
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LoadingUnit
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
Question:
description: Question as part of a CheckTemplate
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Question
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#answerOptionsText:
description: Text restrictions to the Answer
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shortText:
description: Short text of the Question
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#answer:
description: Reference to the Answer to the Question
items:
$ref: '#/components/schemas/Answer'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#questionNumber:
description: Number of the Question within the template (alphanumeric)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checkTemplate:
description: Reference to the CheckTemplate the Question is from
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#answerOptionsValue:
description: Value restrictions to the answer
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#longText:
description: Long text of the question
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#questionSection:
description: Section of the CheckTemplate this Question is part of
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
MovementTime:
description: Times referring to Transport Movements, used to describe specfic
times such as Actual Departure time, etc.
properties:
https://onerecord.iata.org/ns/cargo#movementTimeType:
description: The type of time can be Actual, Estimated ot Scheduled
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#direction:
description: Direction to indicate if it's Inbound or Outbound
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#movementTimestamp:
description: Timestamp (date and time) of the movement time. If the movement
time is recorded asynchronously, the timestamp should reflect the actual
time, not when the data was created.
items:
format: date-time
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#MovementTime
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#movementMilestone:
description: The milestone list still needs to be defined, it includes elements
from CXML Code List 1.92 but is not limited to those values, e.g. block-on
and block-off times might be added as a comparison to wheels off and touchdown.
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
type: object
WaybillType:
description: Restricted code list for Waybill types
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#WaybillType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ULDSpecificPiece:
description: ULDSpecificPiece details
properties:
https://onerecord.iata.org/ns/cargo#pieceGroupGrossWeight:
description: Total gross weight of the piece group
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldContourCode:
description: Contour code as per IATA ULD Regulation
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldType:
description: Type of ULD as per IATA ULD Regulation
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dryIceWeight:
description: Weight of dry ice
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupId:
description: Identifier of the piece group, increasing integers
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ULDSpecificPiece
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#slac:
description: Shipper's Load And Count ( total contained piece count as
provided by shipper)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldSerialNumber:
description: Serial number that allows to uniquely identify the ULD
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#pieceGroupCount:
description: Number of pieces in the piece group
items:
format: int32
type: integer
nullable: true
type: array
type: object
UnitsPreference:
description: UnitsPreference details
properties:
https://onerecord.iata.org/ns/cargo#weightUnit:
description: Preferred unit for weight
items:
$ref: '#/components/schemas/WeightUnitCode'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#UnitsPreference
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#temperatureUnit:
description: Preferred unit for temperature
items:
$ref: '#/components/schemas/TemperatureUnitCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dimensionsUnit:
description: Preferred unit for measurement and dimensions
items:
$ref: '#/components/schemas/DimensionsUnitCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#volumeUnit:
description: Preferred unit for volume
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#currency:
description: Preferred unit for currency
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
type: object
Dimensions:
description: Dimension details
properties:
https://onerecord.iata.org/ns/cargo#width:
description: Width
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Dimensions
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#height:
description: Height
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#length:
description: Length
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#volume:
description: Volume
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
type: object
LoosePiece:
description: LoosePiece details
properties:
https://onerecord.iata.org/ns/cargo#pieceGroupGrossWeight:
description: Total gross weight of the piece group
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceWeight:
description: Weight of a single piece
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceWidth:
description: Width of a single piece
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceLength:
description: Length of a single piece
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dryIceWeight:
description: Weight of dry ice
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupId:
description: Identifier of the piece group, increasing integers
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LoosePiece
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#stackable:
description: Stackable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupCount:
description: Number of pieces in the piece group
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceHeight:
description: Height of a single piece
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#turnable:
description: Turnable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
type: object
BookingOptionStatus:
description: Restricted code list containing the statuses of a booking option
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingOptionStatus
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ContactDetail:
description: Contact details
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ContactDetail
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#textualValue:
description: Textual value filled on use context (eg. characteristic colour,
contactDetail mail address, etc.)
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#contactDetailType:
description: Type of the contact details, e.g. Phone number, Mail address
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
type: object
ProductDg:
description: Dangerous Goods subtype of Product
properties:
https://onerecord.iata.org/ns/cargo#manufacturer:
description: Manufacturing company details and contacts
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherCharacteristics:
description: Characteristics of the product
items:
$ref: '#/components/schemas/Characteristic'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hazardClassificationId:
description: Identifies the hazard class / division identification containing
a numeric field separated by a decimal
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagingDangerLevelCode:
description: Packing group, If used must reference I, II or III
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ProductDg
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#describedObjects:
description: Reference to the Items or Pieces in which the product can be
found.
items:
$ref: '#/components/schemas/PhysicalLogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#description:
description: Natural language description if required
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#additionalHazardClassificationId:
description: 'Identifies the subsidiary hazard class / division identification
containing a numeric field separated by a decimal. There may be , 1 or
2 subsidiary risk classes or divisions. If there is more than one, each
should be separated by a comma. The subsidiary risk must be shown in parentheses. '
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#explosiveCompatibilityGroupCode:
description: Specifies the reference to the group which identifies the kind
of substances and articles that are deemed to be compatible. Mandatory
field in case of transport of explosive articles or substances
items:
$ref: '#/components/schemas/ExplosiveCompatibilityGroupCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsCode:
description: Harmonized Commodity code, refer to hsType used. 6 minimum
digits are expected.
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#commodityItemNumber:
description: Indicates the specific commodity on which the rate class code
is applied
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uniqueIdentifier:
description: Manufacturer's unique product identifier
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#authorizationInformation:
description: 'Contains additional information relating to an approval, permission
or other specific detail applicable to the commodity (e.g. Dangerous Goods
in excepted quantities) '
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#properShippingName:
description: The name used to describe the particular article or substance
as shown in the UN Model Regulations Dangerous Goods List
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsCommodityDescription:
description: Commodity description
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dgRadioactiveMaterial:
description: Dg Radioactive Material
items:
$ref: '#/components/schemas/DgProductRadioactive'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsCommodityName:
description: If no Code provided, name of commodity
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#technicalName:
description: 'This is additional chemical name(s) required for some proper
shipping names. When added the technical must be shown in parentheses
immediately following the proper shipping name. '
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialProvisionId:
description: 'For Air Mode: Special Provision may show a single, double
or triple digit number preceded by the letter A, against appropriate entries
in the List of Dangerous Goods'
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#unNumber:
description: Reference identifying the United Nations Dangerous Goods serial
number assigned within the UN to substances and articles contained in
a list of the dangerous goods most commonly carried. e.g. 1189 - Ethylene
glycol monomethyl ether acetate
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#hsType:
description: Reference identifying the type of standard code to be used
for the Commodity Classification (Brussels Tariff Nomenclature, EU Harmonized
System Code, UN Standard International Trade Classification). Mandatory
if the commodity code is more than 6 digits
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packingInstructionNumber:
description: 'The packing instruction number applicable to the UN number
/ proper shipping name entry. A three-numeric value which may be preceded
by the letter Y. Mandatory field for air transport (Air) '
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
Insurance:
description: Insurance details
properties:
https://onerecord.iata.org/ns/cargo#coveringOrganization:
description: 'Party covering the insurance '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#insuredShipments:
description: Reference to the shipments insured
items:
$ref: '#/components/schemas/Shipment'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Insurance
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#insuredAmount:
description: Insured amount - amount covered by the insurance policy
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
LogisticsActivity:
description: 'Superclass: LogisticsActivity is a scheduled set of tasks that
is executed as part of one or more Services'
properties:
https://onerecord.iata.org/ns/cargo#checkActions:
description: References to CheckActions performed for the Activity
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LogisticsActivity
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedServices:
description: Reference to Services this Activity is executed for
items:
$ref: '#/components/schemas/LogisticsService'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#executionStatus:
description: Enum stating the status of the Activity
items:
$ref: '#/components/schemas/ExecutionStatus'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
WaybillLineItem:
description: Information from AWB Rate Description section as per bullet point
18 - data elements 22A - 22Z from AWB. Data describing Piece and Package parameters
to be transmitted per Piece object using pieceReferences; Data describing
ULD parameters to be transmitted per ULD object using uldReference.
properties:
https://onerecord.iata.org/ns/cargo#rateClassCodeBasic:
description: Rate Surcharge/Reduction - Basic Rate Class Code
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#chargeableWeight:
description: Chargeable weight
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#WaybillLineItem
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#rcp:
description: IATA 3-letter city code of the rate combination point as defined
in TACT
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#conversionFactor:
description: Volume to weight conversion factor
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#rateCharge:
description: TACT Rate for rate description details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#rateClassCode:
description: Rate class code e.g. Q. Refer to CXML Code List 1.4 Rate Class
Codes
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceReferences:
description: References to Pieces for which a rate applies
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldRateClassType:
description: ULD Rate information - ULD Rate Class Type
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#lineItemNumber:
description: Number of the line item
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ratePercentage:
description: Rate Surcharge/Reduction - Percentage of red. / surcharge
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldReferences:
description: References to ULDs for which the rate applies
items:
$ref: '#/components/schemas/ULD'
nullable: true
type: array
type: object
Ranges:
description: Ranges details
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Ranges
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#maximumQuantity:
description: Maximum quantity
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#minimumQuantity:
description: Minimum quantity
items:
type: number
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#rateClassCode:
description: Rate class code e.g. Q. Refer to CXML Code List 1.4 Rate Class
Codes
items:
$ref: '#/components/schemas/RateClassCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldRateClassType:
description: ULD Rate information - ULD Rate Class Type
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#unitBasis:
description: Specific commodity code linked to commodity
items:
type: string
nullable: true
type: array
type: object
Company:
description: Company details
properties:
https://onerecord.iata.org/ns/cargo#parentOrganization:
description: Reference to the parent Organization
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#basedAtLocation:
description: Reference to the Location where the Organization is based at
or headquartered
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Company
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#iataCargoAgentLocationIdentifier:
description: IATA CASS cargo agent 4 digit branch number / location identifier
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shortName:
description: Short name of the Organization if any
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#iataCargoAgentCode:
description: IATA accredited cargo agent 7 digit number
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#subOrganization:
description: References to all sub-Organizations
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
Geolocation:
description: Geolocation details - e.g. for drones, automated vehicles
properties:
https://onerecord.iata.org/ns/cargo#longitude:
description: Location longitude decimal
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#latitude:
description: Location latitude decimal
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#elevation:
description: Elevation from sea level - Change of data type to Value as
of ontology v1.1
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Geolocation
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
OtherCharge:
description: Other Charge details from AWB as per bullet point 19 - data element
23 from AWB
properties:
https://onerecord.iata.org/ns/cargo#otherChargeAmount:
description: Other Charge amount
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#reasonDescription:
description: String describing the reason for a charge
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#chargePaymentType:
description: Indicates if charge is prepaid or collect (P, C)
items:
$ref: '#/components/schemas/PrepaidCollectIndicator'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#OtherCharge
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#chargeQuantity:
description: Double describing the time or item basis quantity of a charge
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherChargeCode:
description: Refer to CargoXML Code List 1.2 for Other Charges
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#entitlement:
description: Entitlement code to define if charges are Due carrier (C) or
Due agent (A). Refer to CXML Code List 1.3
items:
$ref: '#/components/schemas/EntitlementCode'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#locationIndicator:
description: String indicating if the Other Charge Location is Origin (O)
or Transit (T) or Destination(D)
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
LogisticsAgent:
description: 'Superclass: LogisticsAgents describe acting entities in the logistics
supply chain such as persons and organizations'
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LogisticsAgent
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
LoadingMaterial:
description: LoadingMaterial describes transportable, complementary non-Piece
objects such as dry ice or nets
properties:
https://onerecord.iata.org/ns/cargo#manufacturer:
description: Manufacturing company details and contacts
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LoadingMaterial
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#description:
description: Natural language description if required
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#serialNumber:
description: Serial number that allows to uniquely identify the object
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#materialModel:
description: Model of the LoadingMaterial if any
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#materialType:
description: Type of the LoadingMaterial
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
AccountingNote:
description: Embedded object used for AWB mapping (box 10)
properties:
https://onerecord.iata.org/ns/cargo#accountingNoteIdentifier:
description: String holding accounting information (AWB box 10)
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#AccountingNote
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#accountingNoteText:
description: String holding the identifier in an accounting note (AWB box
10)
items:
type: string
nullable: true
type: array
type: object
CompositionType:
description: Restricted code list for Composing subtypes
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CompositionType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ULD:
description: Unit Load Device details
properties:
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ULD
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#ownerCode:
description: Owner code of the ULD in aa, an or na format - owner can be
an airline or leasing company
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#serviceabilityCode:
description: 'Designator of serviceability condition e.g. SER or DAM '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldSerialNumber:
description: Serial number that allows to uniquely identify the ULD
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#odlnCode:
description: Contains two designator codes of ODLN or Operational Damage
Limit Notices. ODLN code is used to define type of damage after visually
check the serviceability of ULDs section 7, Standard Specifications 4/3
or 4/4 in ULD Regulations
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#numberOfFittings:
description: Number of fittings
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#tareWeight:
description: Tare weight of the empty ULD
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#remarks:
description: Remarks or Supplement Information
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ataDesignator:
description: US / ATA Unit Load Device type code e.g. M2
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#damageFlag:
description: Indicates if the ULD is Damaged
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#demurrageCode:
description: Contains three designator of demurrage code, refer to RP 1654
(BCC, HHH, XXX, ZZZ)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#uldTypeCode:
description: Standard Unit Load Device type code e.g. AKE - Certified Container
- Contoured. Refer to IATA ULD Technical Manual
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#numberOfNets:
description: Number of nets
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#numberOfDoors:
description: Number of doors
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#inUnitComposition:
description: Description not available
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#numberOfStraps:
description: Number of straps
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadingIndicator:
description: ULD height or loading limitation code. Refer CXML Code List
1.47, e.g. R - ULD Height above 244 centimetres
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#sealNumber:
description: ULD seal number if applicable
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ActionTimeType:
description: Restricted code list for acceptable action times
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ActionTimeType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
CustomsInformation:
description: Customs information details
properties:
https://onerecord.iata.org/ns/cargo#otherCustomsInformation:
description: Supplementary Customs, Security and Regulatory Control Information
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#country:
description: Country details. Refer ISO 3166-2
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contentCode:
description: 'Customs, Security and Regulatory Control Information Identifier.
Coded indicator qualifying Customs related information: Item Number "I",
Exemption Legend "L", System Downtime Reference "S", Unique Consignment
Reference Number "U", Movement Reference Number "M" . Refers to Code List
1.1. Condition: At least one of the three elements (Country Code, Information
Identifier or Customs, Security and Regulatory Control Information Identifier)
must be completed'
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CustomsInformation
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#subjectCode:
description: 'Information Identifier. Code identifying a piece of information/entity
e.g. "IMP" for import, "EXP" for export, "AGT" for Agent, "ISS" for The
Regulated Agent Issuing the Security Status for a Consignment etc. Condition:
At least one of the three elements (Country Code, Information Identifier
or Customs, Security and Regulatory Control Information Identifier) must
be completed'
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#issuedForPiece:
description: Reference to the Piece the document was issued for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#note:
description: Free text for customs remarks, not used in OCI Composition
Rules Table
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#issuedForShipment:
description: Reference to the shipment the document was issued for
items:
$ref: '#/components/schemas/Shipment'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Ratings:
description: Ratings details
properties:
https://onerecord.iata.org/ns/cargo#chargePaymentType:
description: Indicates if charge is prepaid or collect (P, C)
items:
$ref: '#/components/schemas/PrepaidCollectIndicator'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ranges:
description: Reference to the ranges
items:
$ref: '#/components/schemas/Ranges'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Ratings
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#forPrices:
description: Reference to the Prices based on this Ratings
items:
$ref: '#/components/schemas/Price'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#quantity:
description: Quantity for the charge if applicable
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#subTotal:
description: Subtotal of the charge
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#priceReferenceId:
description: Reference to a price reference if existing (e.g. Allotment
number, contract reference, etc.)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#entitlement:
description: Entitlement code to define if charges are Due carrier (C) or
Due agent (A). Refer to CXML Code List 1.3
items:
$ref: '#/components/schemas/EntitlementCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#rcp:
description: IATA 3-letter city code of the rate combination point as defined
in TACT
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#chargeDescription:
description: Description of the charge e.g. Airfreight, fuel, etc.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherChargeCode:
description: Refer to CargoXML Code List 1.2 for Other Charges
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#priceSpecification:
description: Specification of the price e.g. Street, Group, Spot, etc.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#billingChargeIdentifier:
description: Billing charge identifiers to be used for CASS. Refer to CargoXML
Code List 1.33
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#chargeType:
description: Charge type related to amount total as per bullet points 2/21
- data elements 24A - 3B from AWB
items:
$ref: '#/components/schemas/ChargeIdentifier'
nullable: true
type: array
type: object
LiveAnimalsEpermit:
description: Epermit for Live Animals details
properties:
https://onerecord.iata.org/ns/cargo#signatures:
description: List of all the signatures of the Epermit (applicant box 4,
issuing authority box 6, issuer box 13 and examining authority box 14)
items:
$ref: '#/components/schemas/EpermitSignature'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#permitTypeOtherDescription:
description: Description if TypeCode is Other (box 1)
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transactionPurposeCode:
description: Code indicating the purpose of the transaction (box 5a)
items:
$ref: '#/components/schemas/TransactionPurposeCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#validUntil:
description: Validity end date (date of expiry) based on usage context
items:
format: date-time
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LiveAnimalsEpermit
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#transportContractTypeCode:
description: Code specifying the transport document name (box 15)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#copyIndicator:
description: Indicates if the permit is a copy (true) or an original (false)
(box 1)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#epermitNumber:
description: The original number is a unique number allocated to each document
by the relevant Management Authority. (box 1)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportContractId:
description: Reference to the Air Waybill or other transport contract document
(box 15)
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#consignee:
description: Reference to the Organization that fulfills the role of the
consignee, for a LiveAnimalsEpermit it has to include complete name and
address (box 3)
items:
$ref: '#/components/schemas/Company'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialConditions:
description: Special conditions (box 5)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#consignments:
description: Reference to the pieces and properties linked to the Permit
(box 7 to 12)
items:
$ref: '#/components/schemas/EpermitConsignment'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transactionPurpose:
description: Purpose of the transaction in free text (box 5a)
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#permitTypeCode:
description: Code specifying the document name. (box 1)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#validFrom:
description: Validity start date based on usage context
items:
format: date-time
type: string
nullable: true
type: array
type: object
TransportMovement:
description: Activity to describe transports, replaces the TransportSegment
in v1.1 and above
properties:
https://onerecord.iata.org/ns/cargo#checkActions:
description: References to CheckActions performed for the Activity
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#co2Emissions:
description: References to CO2Emissions
items:
$ref: '#/components/schemas/CO2Emissions'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#seal:
description: Seal identifier
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#TransportMovement
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#executionStatus:
description: Enum stating the status of the Activity
items:
$ref: '#/components/schemas/ExecutionStatus'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#fuelType:
description: e.g. Kerosene, Diesel, SAF, Electricity [renewable], Electricity
[non-renewable]
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#operatingParties:
description: Information about the parties operating this TransportMovement,
for example pilot and co-pilot; can also refer to organizations through
Party
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#distanceMeasured:
description: Information about the measured distance
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#modeCode:
description: Mode of transport code, refer to UNECE Rec. 19 https://unece.org/fileadmin/DAM/cefact/recommendations/rec19/rec19_1cf19e.pdf
items:
$ref: '#/components/schemas/ModeCode'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#fuelAmountMeasured:
description: Information about the measured fuel amount
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedServices:
description: Reference to Services this Activity is executed for
items:
$ref: '#/components/schemas/LogisticsService'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#movementTimes:
description: Information about times related to the movement (milestone
list to be defined)
items:
$ref: '#/components/schemas/MovementTime'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#fuelAmountCalculated:
description: Information about the calculated fuel amount
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#modeQualifier:
description: Pre-Carriage, Main-Carriage or On-Carriage
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#distanceCalculated:
description: Information about the calculated distance
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#departureLocation:
description: Reference to the departure Location
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#arrivalLocation:
description: Reference to the arrival Location
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadingActions:
description: References to all actions of type Loading performed for the
TransportMovement
items:
$ref: '#/components/schemas/Loading'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportIdentifier:
description: Airline flight number, or rail/truck/maritime line id
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#operatingTransportMeans:
description: Reference to the TransportMeans operating the TransportMovement
items:
$ref: '#/components/schemas/TransportMeans'
nullable: true
type: array
type: object
Carrier:
description: Company details of carriers
properties:
https://onerecord.iata.org/ns/cargo#parentOrganization:
description: Reference to the parent Organization
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#airlineCode:
description: IATA two-character airline code
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#basedAtLocation:
description: Reference to the Location where the Organization is based at
or headquartered
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Carrier
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#prefix:
description: IATA three-numeric airline prefix number
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#iataCargoAgentLocationIdentifier:
description: IATA CASS cargo agent 4 digit branch number / location identifier
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shortName:
description: Short name of the Organization if any
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#iataCargoAgentCode:
description: IATA accredited cargo agent 7 digit number
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#subOrganization:
description: References to all sub-Organizations
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
VolumetricWeight:
description: Volumetric weight details
properties:
https://onerecord.iata.org/ns/cargo#conversionFactor:
description: Volume to weight conversion factor
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#chargeableWeight:
description: Chargeable weight
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#VolumetricWeight
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Characteristic:
description: Product additional details
properties:
https://onerecord.iata.org/ns/cargo#characteristicType:
description: Product characteristics code - e.g. CLR - Color. Not restricted
to a list.
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Characteristic
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#textualValue:
description: Textual value filled on use context (eg. characteristic colour,
contactDetail mail address, etc.)
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
EpermitSignature:
description: Signature details of the Epermit for Live Animals
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#EpermitSignature
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#signatoryRole:
description: 'Role of the signatory with regards to the ePermit: Applicant,
Permit issuer, Issuing Authority or Examining authority'
items:
$ref: '#/components/schemas/SignatoryRole'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#signatureStatement:
description: Signatory signature authentication text
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#securityStampId:
description: Security Stamp ID
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#signatoryCompany:
description: Signatory company name
items:
$ref: '#/components/schemas/Company'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#forEpermit:
description: Reference to the LiveAnimalsEpermit this Signature applies
to
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#signatureDate:
description: Date and time of the signature
items:
format: date-time
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#signatureTypeCode:
description: Code specifying a type of government action such as inspection,
detention, fumigation, security.
items:
$ref: '#/components/schemas/SignatureTypeCode'
nullable: true
type: array
type: object
Shipment:
description: Shipment details
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#goodsDescription:
description: Description of goods, for the BookingShipment the commodity
list defined by Modernizing Cargo Distribution MCD working group can be
used as a referential.
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Shipment
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#waybill:
description: Reference to the Waybill of the shipment
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#totalDimensions:
description: Dimensions of the whole shipment
items:
$ref: '#/components/schemas/Dimensions'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#incoterms:
description: Standard codes as defined by UNCEFACT and ICC that correspond
to international rules for the interpretation of the most commonly used
trade terms in different countries. UNECE recommendation n. 5 Incoterms
2.
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieces:
description: References to the Pieces that are part of this Shipment
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#totalGrossWeight:
description: Total gross weight of the whole shipment
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#customsInformation:
description: Customs details
items:
$ref: '#/components/schemas/CustomsInformation'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#insurance:
description: Insurance details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#textualHandlingInstructions:
description: Strings to provide free text handling instructions such as
SSR and OSI
items:
type: string
nullable: true
type: array
type: object
ActivitySequence:
description: Embedded object to create a sequence of Activities in the context
of a Service
properties:
https://onerecord.iata.org/ns/cargo#sequenceNumber:
description: Short text to detail sequence number (alphanumeric)
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ActivitySequence
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#activity:
description: Reference to the Activity that is performed as part of a Service
items:
$ref: '#/components/schemas/LogisticsActivity'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
UnitComposition:
description: Activity to describe composition and decomposition of LoadingUnits
properties:
https://onerecord.iata.org/ns/cargo#checkActions:
description: References to CheckActions performed for the Activity
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#UnitComposition
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedServices:
description: Reference to Services this Activity is executed for
items:
$ref: '#/components/schemas/LogisticsService'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#compositionIdentifier:
description: Short text holding the process number if necessary
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#executionStatus:
description: Enum stating the status of the Activity
items:
$ref: '#/components/schemas/ExecutionStatus'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#compositionActions:
description: References to all CompositionActions performed for the UnitComposition
items:
$ref: '#/components/schemas/Composing'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadingUnit:
description: Reference to the LoadingUnit composed in the Unit Composition
or referenced in Composing actions
items:
$ref: '#/components/schemas/LoadingUnit'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#slac:
description: Shipper's Load And Count ( total contained piece count as
provided by shipper)
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Composing:
description: Action to describe build-up or break-down of LoadingUnits
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#composedPieces:
description: References to the Pieces being built-up or broken-down
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Composing
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionTimeType:
description: Enum stating the type of the Action
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionStartTime:
description: DateTime holding the start time of the Action; Type is indicated
through ActionType property
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#performedAt:
description: Reference to the Location the Action was performed at
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#compositionType:
description: Enum stating whether the CompositionAction describes build-up
or break-down
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedActivity:
description: Reference to the Activity the Action was performed for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadingUnit:
description: Reference to the LoadingUnit composed in the Unit Composition
or referenced in Composing actions
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#composedMaterials:
description: References to the Materials being built-up or broken-down
items:
$ref: '#/components/schemas/LoadingMaterial'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionEndTime:
description: DateTime holding the end time of the Action; Type is indicated
through ActionType property
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
IotDevice:
description: IoT Device details
properties:
https://onerecord.iata.org/ns/cargo#manufacturer:
description: Manufacturing company details and contacts
items:
$ref: '#/components/schemas/Company'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#IotDevice
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#description:
description: Natural language description if required
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#connectedSensors:
description: Reference to the sensors linked to the device
items:
$ref: '#/components/schemas/Sensor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#deviceModel:
description: Commercial denomination of the device
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#serialNumber:
description: Serial number that allows to uniquely identify the object
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedToObject:
description: Reference to the PhysicalLogisticsObject the IotDevice is attached
to
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
BookingOptionRequest:
description: 'Request object, refers to the Quote request or Booking request '
properties:
https://onerecord.iata.org/ns/cargo#bookingShipmentDetails:
description: Reference to the BookingShipment if required
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingOptionRequest
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#timePreferences:
description: Schedule preferences of the request
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#bookingToUpdate:
description: Reference to the Booking to update
items:
$ref: '#/components/schemas/Booking'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#unitsPreference:
description: Reference to unit preferences of the request (e.g. kg or cm)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportLegs:
description: Reference to the Transport Legs of the proposed routing
items:
$ref: '#/components/schemas/TransportLegs'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrierProduct:
description: Reference to the Carrier product if known
items:
$ref: '#/components/schemas/CarrierProduct'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#bookingPreference:
description: Reference to the Booking preferences
items:
$ref: '#/components/schemas/BookingPreferences'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#bookingOptions:
description: Reference to all Booking Options
items:
$ref: '#/components/schemas/BookingOption'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#knownShipper:
description: Indication if shipper is a Known Shipper as per TSA grant
items:
type: boolean
nullable: true
type: array
type: object
Storage:
description: Activity to describe storing processes
properties:
https://onerecord.iata.org/ns/cargo#checkActions:
description: References to CheckActions performed for the Activity
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Storage
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedServices:
description: Reference to Services this Activity is executed for
items:
$ref: '#/components/schemas/LogisticsService'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#storingIdentifier:
description: Short text holding the process number if necessary
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#executionStatus:
description: Enum stating the status of the Activity
items:
$ref: '#/components/schemas/ExecutionStatus'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#storingActions:
description: References to all StoringActions performed for the Storing
Activity
items:
$ref: '#/components/schemas/Storing'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Price:
description: Price associated to the offer/booking
properties:
https://onerecord.iata.org/ns/cargo#forBookingOption:
description: Reference to the BookingOption the LogisticsObject is detailing
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#chargeCode:
description: Charge code, refer to CargoXML Code List 1.1
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Price
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#ratings:
description: Rating used for pricing
items:
$ref: '#/components/schemas/Ratings'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#grandTotal:
description: Total price
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
Value:
description: Unit of measurement details
properties:
https://onerecord.iata.org/ns/cargo#unit:
description: Unit of measurement as per MeasurementUnitCode codelist. If
the code is not present, create an instance of MeasurementUnitCode based
on UNECE Rec. 20 Rev. 17e-2021
items:
$ref: '#/components/schemas/MeasurementUnitCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#numericalValue:
description: Numerical value
items:
type: number
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Value
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
TransportLegs:
description: TransportLegs details
properties:
https://onerecord.iata.org/ns/cargo#departureDate:
description: Departure date and time of the leg
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#co2Emissions:
description: References to CO2Emissions
items:
$ref: '#/components/schemas/CO2Emissions'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#TransportLegs
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#arrivalDate:
description: Arrival date and time of the leg
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportMeansServiceType:
description: Type of transport means service, e.g. Aircraftor Truck
items:
$ref: '#/components/schemas/TransportMeansServiceType'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#legNumber:
description: Leg number
items:
format: int32
type: integer
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#transportMeansType:
description: Type of transport means, e.g. 744, RFS
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#departureLocation:
description: Reference to the departure Location
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#arrivalLocation:
description: Reference to the arrival Location
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#transportIdentifier:
description: Airline flight number, or rail/truck/maritime line id
items:
type: string
nullable: true
type: array
type: object
LoadType:
description: Restricted code list for the Load Type of a piece or shipment
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LoadType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
CheckTotalResult:
description: Result of a Check
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#resultOfCheck:
description: Description not available
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checkRemark:
description: Free text remarks to the check result
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#certifiedByActor:
description: Reference to the Actor certifying the result of the Check if
required
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CheckTotalResult
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#passed:
description: Boolean indicating whether the Check was passed
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#resultValue:
description: Information about a result Value of any kind of the Check
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
Sensor:
description: Sensor details and measurements, linked to Connected Devices
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#measurements:
description: Reference to the Measurements recorded by the Sensor
items:
$ref: '#/components/schemas/Measurement'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Sensor
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#description:
description: Natural language description if required
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#name:
description: Human-understandable name of object depending on the context
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#partOfIotDevice:
description: Reference to the IoT Device to which the sensor is linked
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#serialNumber:
description: Serial number that allows to uniquely identify the object
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#sensorType:
description: Type of sensor as described in Interactive Cargo Recommended
Practice
items:
$ref: '#/components/schemas/SensorType'
nullable: true
type: array
type: object
Measurement:
description: Measurements details for Sensors, either generic or geolocation
measurements are recorded
properties:
https://onerecord.iata.org/ns/cargo#measurementTimestamp:
description: Timestamp for the measurement
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#measurementValue:
description: Information about all non-Geolocation values of the measurement
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Measurement
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#recordedGeolocation:
description: Reference to the Geolocation recorded of the measurement
items:
$ref: '#/components/schemas/Geolocation'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
DgRadioactiveIsotope:
description: Details of the radioactive isotope contained in the product
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contentOfDgProductRadioactive:
description: Reference to the DgProductRadioactive this Isotope is contained
in
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#DgRadioactiveIsotope
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#specialFormIndicator:
description: A notation that the material is special form
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#isotopeId:
description: Id of each radionuclide or for mixtures of radionuclides.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#physicalChemicalForm:
description: A description of the physical and chemical form of the material.
items:
$ref: '#/components/schemas/RadioactiveMaterialClassification'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#activityLevelMeasure:
description: Numeric expression of the activity of a radioactive Item
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#criticalitySafetyIndexNumeric:
description: Applies to fissile material only, other than fissile excepted.
A numeric value expressed to one decimal place preceded by the letters
CSI.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#lowDispersibleIndicator:
description: A notation that the material is low dispersible radioactive
material.
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#isotopeName:
description: 'The name or symbol of each radionuclide or for mixtures of
radionuclides, an appropriate general description, or a list of the most
restrictive radionuclides. '
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
BookingTimes:
description: Previously called Schedule. This object refers to times used for
the Booking Option Request (preferences part of the request) or the Booking
Option (times sur as LAT where there is a commitment from the carrier)
properties:
https://onerecord.iata.org/ns/cargo#totalTransitTime:
description: Total transit time as per CargoIQ definition, expressed as
a duration
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#latestAcceptanceTime:
description: Latest Acceptance time as per CargoIQ definition (requested,
proposed or actual)
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#latestArrivalTime:
description: Latest arrival time at destination
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#timeOfAvailability:
description: Time of availability of the shipment as per CargoIQ definition
items:
format: date-time
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingTimes
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#earliestAcceptanceTime:
description: Earliest acceptance date time (requested or proposed)
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ContactDetailType:
description: Open code list for types of contact details
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ContactDetailType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
CO2Emissions:
description: CO2 Calculation
properties:
https://onerecord.iata.org/ns/cargo#methodName:
description: Name of the CO2 calculation method
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CO2Emissions
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#calculationFor:
description: Reference to the TransportMovement or TransportLegs the CO2Emissions
have been calculated for
items:
$ref: '#/components/schemas/LogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#calculatedEmissions:
description: CO2 emissions calculated
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#methodVersion:
description: Version used for the calculation
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
LogisticsObject:
description: Logistics Object parent class, containing all common properties
for logistics objects.
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LogisticsObject
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
Waybill:
description: Waybill details
properties:
https://onerecord.iata.org/ns/cargo#declaredValueForCarriage:
description: The value of a shipment declared for carriage purposes
items:
$ref: '#/components/schemas/CurrencyValue'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shipment:
description: Reference to the Shipment
items:
$ref: '#/components/schemas/Shipment'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Waybill
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#destinationCurrencyRate:
description: Conversion rate applied
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#billingDetails:
description: Reference to the BillingDetails of the Waybill
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shippingRefNo:
description: Optional shipping reference number if any
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shippingInfo:
description: The shipper or its Agent may enter the appropriate optional
shipping
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#customsOriginCode:
description: Code indicating the origin of goods for Customs purposes (e.g.
For goods in free circulation in the EU) List to be provided by local
authorities
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrierDeclarationPlace:
description: Location of individual or company involved in the movement
of a consignment or Coded representation of a specific airport/city code
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherCharges:
description: Information about Other Charges applying to this Waybill
items:
$ref: '#/components/schemas/OtherCharge'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#accountingInformation:
description: Indicates the details of accounting information. Free text
e.g. PAYMENT BY CERTIFIED CHEQUE etc.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#declaredValueForCustoms:
description: The value of a shipment declared for customs purposes
items:
$ref: '#/components/schemas/CurrencyValue'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrierDeclarationDate:
description: Date upon which the certification is made by the carrier
items:
format: date-time
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#destinationCharges:
description: Charges levied at destination accruing to the last carrier,
in destination currency
items:
$ref: '#/components/schemas/CurrencyValue'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrierChargeCode:
description: One letter charge code as per bullet point 12 - data element
13 from AWB
items:
$ref: '#/components/schemas/ChargeCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#houseWaybills:
description: Refers to the Waybill(s) contained
items:
$ref: '#/components/schemas/Waybill'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#consignorDeclarationSignature:
description: Name of consignor signatory
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#weightValuationIndicator:
description: Indicator whether the payment for the Weight/Valuation is to
be made at origin (prepaid) or at destination (collect) as per bullet
point 13 - data element 14a/14b from AWB
items:
$ref: '#/components/schemas/PrepaidCollectIndicator'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherChargesIndicator:
description: Indicator whether the payment of Other Charges is to be made
at origin (prepaid) or at destination (collect) as per bullet point 13
- data element 15a/15b from AWB
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#modularCheckNumber:
description: The check is a Modular 7 validation on the AWB number, recorded
as a boolean.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#taxAmount:
description: Information about taxes
items:
$ref: '#/components/schemas/CurrencyValue'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillType:
description: 'Type of the Waybill: House, Direct or Master'
items:
$ref: '#/components/schemas/WaybillType'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#accountingNotes:
description: Information about accounting notes (AWB box 10)
items:
$ref: '#/components/schemas/AccountingNote'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#masterWaybill:
description: Reference to the master Waybill if it is contained in one
items:
$ref: '#/components/schemas/Waybill'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#departureLocation:
description: Reference to the departure Location
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#arrivalLocation:
description: Reference to the arrival Location
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillPrefix:
description: Prefix used for the Waybill Number. Refer to IATA Airlines
Codes
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#referredBookingOption:
description: Refers to the Booking
items:
$ref: '#/components/schemas/Booking'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#carrierDeclarationSignature:
description: Contains the authentication of the Carrier
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#serviceCode:
description: One letter service code as per bullet point 18.4 - data element
22Z from AWB
items:
$ref: '#/components/schemas/ServiceCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillNumber:
description: House or Master Waybill unique identifier
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#waybillLineItems:
description: Information about rates applying to this Waybill handled as
line item
items:
$ref: '#/components/schemas/WaybillLineItem'
nullable: true
type: array
type: object
StoringType:
description: Restricted code list for Storing subtypes
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#StoringType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
Storing:
description: Action to describe store-in or store-out
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Storing
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contactPersons:
description: References to Actors (Person, NonHumanActor) acting as contacts
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionTimeType:
description: Enum stating the type of the Action
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionStartTime:
description: DateTime holding the start time of the Action; Type is indicated
through ActionType property
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contactDetails:
description: Information about contactDetails
items:
$ref: '#/components/schemas/ContactDetail'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#performedAt:
description: Reference to the Location the Action was performed at
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#storedObjects:
description: Reference to the Objects being stored in or stored out
items:
$ref: '#/components/schemas/PhysicalLogisticsObject'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#storingType:
description: Enum stating whether the StoringAction describes the store-in
or the store-out
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#servedActivity:
description: Reference to the Activity the Action was performed for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#actionEndTime:
description: DateTime holding the end time of the Action; Type is indicated
through ActionType property
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#storagePlaceIdentifier:
description: Short text stating the exact place of storage
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
type: object
BookingStatus:
description: Restricted code list containing the possible statuses of a booking
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BookingStatus
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
VolumePieceGroup:
description: VolumePieceGroup details
properties:
https://onerecord.iata.org/ns/cargo#pieceGroupGrossWeight:
description: Total gross weight of the piece group
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#totalVolume:
description: Total volume fo the volume piece group
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dryIceWeight:
description: Weight of dry ice
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupId:
description: Identifier of the piece group, increasing integers
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#VolumePieceGroup
type: string
nullable: false
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#stackable:
description: Stackable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#pieceGroupCount:
description: Number of pieces in the piece group
items:
format: int32
type: integer
nullable: true
type: array
type: object
PieceLiveAnimals:
description: LiveAnimals subclass of Piece
properties:
https://onerecord.iata.org/ns/cargo#exportTradeCountry:
description: Country of last re-export (box 12a). Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#goodsDescription:
description: Description of goods, for the BookingShipment the commodity
list defined by Modernizing Cargo Distribution MCD working group can be
used as a referential.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#speciesScientificName:
description: Species scientific name (box 7)
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#ofShipment:
description: Reference to the Shipment the Piece is assigned to
items:
$ref: '#/components/schemas/Shipment'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#associatedEpermit:
description: Reference to the permits associated with the Live Animals
items:
$ref: '#/components/schemas/EpermitConsignment'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagingType:
description: 'Packaging details '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#fulfillsUldTypeCode:
description: Text holding an ULD Type Code if the Piece fulfills it before
UnitComposition
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#textualHandlingInstructions:
description: Strings to provide free text handling instructions such as
SSR and OSI
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#temperatureInstructions:
description: Temperature instructions if a specific range
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#goodsTypeCode:
description: Appendix number of the convention (I, II or III) (box 1)
items:
$ref: '#/components/schemas/GoodsTypeCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specimenDescription:
description: Description of specimens, including age and sex if LA (box
9)
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#originReferencePermitTypeCode:
description: Document type code of origin reference permit or re-export
reference Certificate (box 12/12a)
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#goodsTypeExtensionCode:
description: Appendix number of the convention (I, II or III) (box 1)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#originTradeCountry:
description: country of origin (box 12). Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#originReferencePermitDateTime:
description: Issuing date for Origin reference permit or re-export reference
Certificate (box 12)
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#upid:
description: Unique Piece Identifier (UPID) of the piece. Refer IATA Recommended
Practice 1689
items:
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#PieceLiveAnimals
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#contentProducts:
description: Reference to the Products describing the content of the Piece,
mandatory if no data on Item level is used
items:
$ref: '#/components/schemas/Product'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#originReferencePermitId:
description: identifier of Origin reference permit or re-export reference
Certificate (box 12/12a)
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#dimensions:
description: Dimensions details
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#quantityAnimals:
description: Quantity including units (box 11)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#containedPieces:
description: Details of contained piece(s)
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packageMarkCoded:
description: Reference identifying how the package is marked. Field is hardcode
to "SSCC-18", "UPC" or "Other"
items:
$ref: '#/components/schemas/PackageMarkCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#inPiece:
description: Reference to the Piece this Item or Piece is contained in
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nvdForCustoms:
description: When no value is declared for Customs, this field may be completed
with the value TRUE otherwise FALSE
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#speciesCommonName:
description: Species common name (box 8)
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#shippingMarks:
description: Shipping marks
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#categoryCode:
description: Operations code ID. Refers to the number of the registered
captive-breeding or artificial propagation operation (box 12b)
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#acquisitionDateTime:
description: Defined in Resolution Conf. 13.6 and is required for pre-Convention
specimens (box 12b)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nvdForCarriage:
description: When no value is declared for Carriage, this field may be completed
with the value TRUE otherwise FALSE
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#securityDeclarations:
description: Security details of the piece
items:
$ref: '#/components/schemas/SecurityDeclaration'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#loadType:
description: Load type of the shipment or piece (Bulk, ULD, Pallet, Loose)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#stackable:
description: Stackable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#packagedeIdentifier:
description: SSCC-18 code for the value of the package mark, company or
bar code, free text, pallet code, etc.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#grossWeight:
description: Weight details
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#coload:
description: Coload indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#containedItems:
description: Reference to the item(s) contained in the piece
items:
$ref: '#/components/schemas/Item'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#contentProductionCountry:
description: Goods production country, mandatory when there are no Items.
Refer ISO 3166-2
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#slac:
description: Shipper's Load And Count ( total contained piece count as
provided by shipper)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specialHandlingCodes:
description: Three-letter special handling code (SPH)
items:
$ref: '#/components/schemas/SpecialHandlingCode'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#specimenTypeCode:
description: Description of specimens, CITES type code (box 9)
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#customsInformation:
description: Customs details
items:
$ref: '#/components/schemas/CustomsInformation'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#annualQuotaQuantity:
description: total number of specimens exported in the current calendar
year and the current annual quota for the species concerned (box 11a)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#otherIdentifiers:
description: Details about any other identifier, depending on the context
of use
items:
$ref: '#/components/schemas/OtherIdentifier'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#turnable:
description: Turnable indicator for the pieces (boolean)
items:
type: boolean
nullable: true
type: array
type: object
PackagingType:
description: 'Packaging details '
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#PackagingType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#description:
description: Natural language description if required
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#typeCode:
description: 'Packaging type identifier as per UNECE Rec 21 Annex V and
VI e.g. 1A - Drum, steel - Packaging material code. Identifies the Logistic
Unit package type. UN Recommendation on Transport of Dangerous Goods,
Model Regulations '
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#appliedOnPieces:
description: Piece on which the Packaging type is applicable
items:
$ref: '#/components/schemas/Piece'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
PhysicalLogisticsObject:
description: 'Superclass: PhysicalLogisticObjects represent the digital twin
of an object in the logistics supply chain that physically exist'
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#PhysicalLogisticsObject
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
LoadingType:
description: Restricted code list for Loading subtypes
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LoadingType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
SensorType:
description: Open code list for sensor types
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#SensorType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
ModeQualifier:
description: Open code list for transport modes
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#ModeQualifier
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
TransportMeans:
description: Transport means details
properties:
https://onerecord.iata.org/ns/cargo#typicalFuelConsumption:
description: Typical fuel consumption (e.g. 2 L / 1 nm)
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#TransportMeans
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#transportOrganization:
description: Company operating the transport means
items:
$ref: '#/components/schemas/Organization'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#typicalCo2Coefficient:
description: Required for some CO2 calculations
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#vehicleType:
description: Vehicle or container type. Refer UNECE28, e.g. 4.. - Aircraft,
type unknown.For Air refer to IATA Standard Schedules Information Manual
in section ATA/IATA Aircraft Types
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#operatedTransportMovement:
description: Transport Movement on which the Transport Means is used
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#vehicleRegistration:
description: Vehicle identification - e.g. aircraft registration number
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#vehicleModel:
description: Model or make of the vehicle (e.g. A33-3)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#vehicleSize:
description: Size of the vehicle - free text
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
BillingDetails:
description: In the context of CASS2. process, BillingDetails object is used
to integrate specific Billing and Settlement data requirements
properties:
https://onerecord.iata.org/ns/cargo#vatIndicator:
description: Indicate if subject to VAT (boolean)
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#nbCorrections:
description: Number of corrections to CASS records
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#awbUseIndicator:
description: It must either contain the values of R for Revenue AWB, V for
Void AWB or S for Service AWB.
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#awbDeliveryDate:
description: The Date AWB Delivery is also used as the AWB Execution date
which will determine which billing period it will be processed and billed
in.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#adjustments:
description: Information about Adjustments performed on the BillingDetails
items:
$ref: '#/components/schemas/Adjustments'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#discount:
description: This is used as a discount to the “official” transportation
charge on AWB to arrive at actual selling price
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#commissionIndicator:
description: Indicates if commission is applied. Boolean
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#BillingDetails
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#exchangeRate:
description: The Rate at which the Air Waybill Amount has been multiplied
to arrive at the amount of settlement.
items:
type: number
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#taxDueAirline:
description: Tax due Airline (as per AWB, or VAT/GST as per invoice). Total
VAT/TAX amount payable by agent to airline
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#awbAcceptanceDate:
description: The Date AWB Acceptance should be the same as the Date AWB
Delivery. (beginning of the process)
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#taxDueAgent:
description: Tax due Agent (VAT/GST on Commission). Total VAT/TAX amount
payable by airline to agent
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#awbExecutionDate:
description: The AWB execution date determines which billing period the
document will be processed and billed in.
items:
format: date-time
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#commission:
description: The commission amount in favour of the Cargo Agent/Associate,
applicable for the shipment concerned
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#detailedWaybill:
description: Reference to the Waybill
items:
$ref: '#/components/schemas/Waybill'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#commissionPercentage:
description: The commission percentage in favour of the Cargo Agent/Associate,
applicable for the shipment concerned
items:
type: number
nullable: true
type: array
type: object
NonHumanActor:
description: Non-human actors are actors which are not a person, such as robots
properties:
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#NonHumanActor
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#associatedOrganization:
description: Reference to the Organization the Actor is associated with
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
type: object
MovementTimeType:
description: Restricted code list for MovementTime subtypes
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#MovementTimeType
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
Answer:
description: Answer holds the answer to one Question
properties:
https://onerecord.iata.org/ns/cargo#answerValue:
description: Information about an answer Value of any kind of the Answer
items:
$ref: '#/components/schemas/Value'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Answer
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#text:
description: Text for the Answer
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#involvedParties:
description: Information about other Parties involved depending on the context
of use
items:
$ref: '#/components/schemas/Party'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#question:
description: Reference to the Question the Answer is for
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#answerActor:
description: Reference to the Actor giving the Answer
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#givenAtLocation:
description: Reference to the Location from which the Question was answered,
relevant for split checks with documentary and physical elements
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
type: object
CodeListElement:
description: Embedded object to transmit codes from non-RDF code lists in 1R
in a semi-structured way. Code lists may be externally maintained codes (such
as HS codes) or carrier-specific codes. If a code is present in RDF-form as
Named Individual (like in the 1R core code lists ontology), it suffices to
put in its IRI
properties:
https://onerecord.iata.org/ns/cargo#codeLevel:
description: Integer indicating the level of a code if a codelists is hierarchical,
for example HS-Codes
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeListName:
description: Official name of the code list without version number when
direct reference is not possible, for example "UN/LOCODE" when referring
to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CodeListElement
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#codeListVersion:
description: Version of the code list, for example "223-1" for UN/LOCODE.
Used if the property codeListName is used or the version is not apparent
from the resource referred to in property codeListReference.
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#codeDescription:
description: Description or long version of the code, for example "Switzerland"
for Switzerland when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#codeListReference:
description: URL to access the code list the code is taken from, for example
"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory"
for UN/LOCODE.
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#code:
description: Code or short version of a code, for example "CH" for Switzerland
when referring to the UN/LOCODE code list
items:
maxItems: 1
type: string
nullable: true
type: array
type: object
LogisticsEvent:
description: Event details
properties:
https://onerecord.iata.org/ns/cargo#eventFor:
description: Refers to the URI of the linked object(s)
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#eventLocation:
description: Location of event
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#eventDate:
description: Date and time of the event
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#eventCode:
description: Movement or milestone code. Can hold a named individual of
the StatusCode core code list (corresponding to cXML code list 1.18),
but can also be referring to different code lists.
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#LogisticsEvent
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#creationDate:
description: DateTime at which the LogisticsEvent was posted
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#recordingOrganization:
description: Organization recording the LogisticsEvent
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#eventName:
description: If no EventCode provided, event name - e.g. Security clearance
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#eventTimeType:
description: Indicates type of event e.g. Scheduled, Estimated, Actual
items:
$ref: '#/components/schemas/Thing'
maxItems: 1
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#partialEventIndicator:
description: Boolean indicating that the LogisticsEvent is only applicable
for parts of the LogisticObject it was recorded for, for example for some
Pieces of a Shipment
items:
maxItems: 1
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#recordingActor:
description: Reference to the Actor recording the LogisticsEvent
items:
$ref: '#/components/schemas/Actor'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
CurrencyValue:
description: Embedded object to transmit currencies
properties:
https://onerecord.iata.org/ns/cargo#numericalValue:
description: Numerical value
items:
maxItems: 1
type: string
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#CurrencyValue
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#currencyUnit:
description: Information about the currency used in a CurrencyValue. Create
an instance of CurrencyCode based on ISO 4217
items:
$ref: '#/components/schemas/CurrencyCode'
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
type: object
Location:
description: Location describes a physical location, e.g. an airport, a warehouse
or a truck deck
properties:
https://onerecord.iata.org/ns/cargo#address:
description: Address details
items:
$ref: '#/components/schemas/Address'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#onsiteActions:
description: References to the Actions happening at the Location
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#skeletonIndicator:
description: Indicator whether a logistics object is a skeleton object
items:
type: boolean
nullable: true
type: array
'@type':
description: Type of the resource
items:
enum:
- https://onerecord.iata.org/ns/cargo#Location
type: string
nullable: false
type: array
https://onerecord.iata.org/ns/cargo#involvedInActions:
description: References to the Actions the object is involved in
items:
$ref: '#/components/schemas/LogisticsAction'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#events:
description: Events object
items:
$ref: '#/components/schemas/LogisticsEvent'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#locationCodes:
description: Location code of airport, freight terminal, seaport, rail station.
UN/LOCODE city code (5 letter) or IATA airport code (3 letter)
items:
$ref: '#/components/schemas/CodeListElement'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#checks:
description: References to the CheckActions performed on the object
items:
$ref: '#/components/schemas/Check'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#locationType:
description: Location type - e.g. Airport, Freight terminal, Rail station,
Seaport, etc
items:
type: string
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#geolocation:
description: Geolocation details
items:
$ref: '#/components/schemas/Geolocation'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#externalReferences:
description: References to all associated ExternalReferences
items:
$ref: '#/components/schemas/ExternalReference'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#attachedIotDevices:
description: References to all connected IotDevices
items:
$ref: '#/components/schemas/IotDevice'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#locationName:
description: Full name of the location
items:
type: string
nullable: true
type: array
'@id':
description: Resource Identifier
nullable: true
type: string
https://onerecord.iata.org/ns/cargo#subLocations:
description: References to Sublocations that describe the Location in more
detail
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
https://onerecord.iata.org/ns/cargo#subLocationOf:
description: Reference to the Location this is a Sublocation of
items:
$ref: '#/components/schemas/Location'
nullable: true
type: array
type: object