generated: '2026-10-09'
method: derived
generator: derive-data-model.py
source:
- openapi/shipcloud-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 33
  entities_in_spec: 33
  relationships: 31
entities:
- name: address
  fields: 10
- name: address_with_id
  fields: 0
- name: address_with_id_clean
  fields: 11
- name: current_user
  fields: 7
  description: Getting information about the user that is making the request
- name: customs_declaration
  fields: 11
  description: declaration of customs related information
- name: customs_declaration_items
  fields: 7
- name: customs_declaration_response
  fields: 0
- name: label
  fields: 2
  description: label specific definitions
- name: localized_attributes
  fields: 3
- name: manifest
  fields: 4
- name: manifest_response
  fields: 0
- name: order
  fields: 12
  description: An order
- name: order_line_item
  fields: 13
- name: order_line_item_with_id
  fields: 0
- name: order_with_id
  fields: 0
- name: package
  fields: 0
- name: package_minimal
  fields: 4
  description: defines package attributes
- name: package_response_object
  fields: 0
- name: package_with_id
  fields: 0
- name: pickup
  fields: 2
  description: for some carriers a pickup has to be requested when creating a shipment
- name: pickup_dropoff_location
  fields: 16
  description: A single location of a carrier. Includes opening hours, additional properties and (optional) maximum
    package measurements.
- name: pickup_request_object
  fields: 6
- name: pickup_time_object
  fields: 2
  description: defines a time window in which the carrier should pickup shipments
- name: shipment
  fields: 18
- name: shipment_document
  fields: 3
- name: shipment_document_response_object
  fields: 4
- name: shipment_put
  fields: 13
- name: shipment_response_object
  fields: 0
- name: tracker_object
  fields: 11
- name: tracker_object_with_id
  fields: 0
- name: webhook_create_with_basic_auth
  fields: 0
- name: webhook_object
  fields: 3
  description: Webhooks inform your system of events that have happened within the shipcloud platform
- name: webhook_object_with_id
  fields: 0
relationships:
- from: customs_declaration_response
  to: customs_declaration_items
  type: has_many
  via: items
- from: manifest
  to: address
  type: has_one
  via: posting_hub_address
- from: order
  to: address
  type: has_one
  via: delivery_address
- from: order
  to: order_line_item
  type: has_many
  via: order_line_items
- from: order_line_item
  to: localized_attributes
  type: has_one
  via: title
- from: order_with_id
  to: address_with_id_clean
  type: has_one
  via: delivery_address
- from: order_with_id
  to: order_line_item_with_id
  type: has_many
  via: order_line_items
- from: package
  to: customs_declaration_items
  type: has_many
  via: customs_declaration_items
- from: pickup
  to: pickup_time_object
  type: has_one
  via: pickup_time
- from: pickup
  to: address_with_id
  type: has_one
  via: pickup_address
- from: pickup_request_object
  to: pickup_time_object
  type: has_one
  via: pickup_time
- from: pickup_request_object
  to: address_with_id
  type: has_one
  via: pickup_address
- from: shipment
  to: address
  type: has_one
  via: to
- from: shipment
  to: address
  type: has_one
  via: from
- from: shipment
  to: address
  type: has_one
  via: cover_address
- from: shipment
  to: label
  type: has_one
  via: label
- from: shipment
  to: pickup
  type: has_one
  via: pickup
- from: shipment
  to: customs_declaration
  type: has_one
  via: customs_declaration
- from: shipment
  to: order
  type: belongs_to
  via: order_id
- from: shipment_put
  to: address
  type: has_one
  via: to
- from: shipment_put
  to: address
  type: has_one
  via: from
- from: shipment_put
  to: address
  type: has_one
  via: cover_address
- from: shipment_put
  to: label
  type: has_one
  via: label
- from: shipment_put
  to: pickup
  type: has_one
  via: pickup
- from: shipment_response_object
  to: address_with_id
  type: has_one
  via: to
- from: shipment_response_object
  to: address_with_id
  type: has_one
  via: from
- from: shipment_response_object
  to: package_with_id
  type: has_many
  via: packages
- from: shipment_response_object
  to: customs_declaration_response
  type: has_one
  via: customs_declaration
- from: tracker_object
  to: address_with_id
  type: has_one
  via: from
- from: tracker_object
  to: shipment
  type: belongs_to
  via: shipment_id
- from: tracker_object
  to: address_with_id
  type: has_one
  via: to