2024 is the year of the connector - vote here

Explore the Flexport API data model

See how the various Flexport endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, read the docs below

Pulling data from the Flexport API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Flexport API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Booking

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Booking

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
ShipmentRemoteID string Shipment → ID -
ShipperEntityRemoteID string CompanyEntity → ID -
ConsigneeRemoteID string CompanyEntity → ID -
Status string - -
QuoteStatus string - -
NotifyParty string - -
TransportationMode string - -
SpecialInstructions string - -
CargoReadyDate datetime - -
DeliveryDate datetime - -
OriginAddressRef string - -
OriginAddressStreetAddress string - -
OriginAddressStreetAddress2 string - -
OriginAddressCity string - -
OriginAddressState string - -
OriginAddressCountry string - -
OriginAddressCountryCode string - -
OriginAddressZip string - -
OriginAddressTimezone string - -
OriginAddressUnlocode string - -
DeliveryAddressRef string - -
DeliveryAddressStreetAddress string - -
DeliveryAddressStreetAddress2 string - -
DeliveryAddressCity string - -
DeliveryAddressState string - -
DeliveryAddressCountry string - -
DeliveryAddressCountryCode string - -
DeliveryAddressZip string - -
DeliveryAddressTimezone string - -
DeliveryAddressUnlocode string - -
WantsExportCustomsService boolean - -
WantsImportCustomsService boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -
Object string - -

Company

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Company

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Ref string - -
Editable boolean - -
Object string - -

Contact

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Contact

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Email string - -
PhoneNumber string - -
ClientVerified boolean - -
CompanyID string Company → ID -
Object string - -

Invoice

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Invoices

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
IssuedAt datetime - -
DueDate datetime - -
QuoteCurrencyCode string - -
ExchangeRate decimal - -
TotalAmount decimal - -
TotalCurrencyCode string - -
BalanceAmount decimal - -
BalanceCurrencyCode string - -
Status string - -
Type string - -
VoidedAt datetime - -
LastUpdatedAt datetime - -
RecipientID string CompanyEntity → ID -
IssuerID string CompanyEntity → ID -
Object string - -

Location

Documentation: https://apidocs.flexport.com/v3/tag/Location

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Editable boolean - -
AddressRef string - -
CompanyRemoteID string Company → RemoteID -
Ref string - -
Object string - -

Product

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Product

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
Sku string - -
ProductCategory string - -
ArchivedAt datetime - -
ClientVerified boolean - -
Object string - -

Shipment

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Shipment

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
BookingRemoteID string Booking → ID -
TransportationMode string - -
FreightType string - -
Incoterm string - -
WeightUnits string - -
WeightValue decimal - -
VolumeUnits string - -
VolumeValue decimal - -
Pieces int - -
Status string - -
Priority string - -
EstimatedDepartureDate datetime - -
ActualDepartureDate datetime - -
EstimatedArrivalDate datetime - -
ActualArrivalDate datetime - -
CargoReadyDate datetime - -
WantsFreightManagementBco boolean - -
WantsFlexportFreight boolean - -
WantsCommercialInvoiceTranscription boolean - -
WantsFlexportInsurance boolean - -
WantsPickupService boolean - -
WantsTradeDeclarationService boolean - -
VisibilityOnly boolean - -
WantsDeliveryService boolean - -
Wants214Filing boolean - -
BelongsToABuyersConsol boolean - -
ParentShipmentRemoteID string Shipment → RemoteID -
EstimatedPickedUpInFullDate datetime - -
ActualPickedUpInFullDate datetime - -
TargetDeliveryDate datetime - -
EstimatedDeliveredInFullDate datetime - -
ActualDeliveredInFullDate datetime - -
WantsExportCustomsService boolean - -
WantsImportCustomsService boolean - -
QuotedTransitTimeDaysMin decimal - -
QuotedTransitTimeDaysMax decimal - -
QuotedDeliveryDateFrom datetime - -
QuotedDeliveryDateTo datetime - -
DangerousGoodsReviewStatus string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Object string - -

ShipmentContainer

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Container

Column Type Relates to Notes
RemoteID string - -
ShipmentRemoteID string Shipment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
ContainerType string - -
ContainerNumber string - -
ContainerSize string - -
SealNumber string - -
PickupNumber string - -
EstimatedDepartureDate datetime - -
ActualDepartureDate datetime - -
EstimatedArrivalDate datetime - -
ActualArrivalDate datetime - -
EstimatedPickupDate datetime - -
ActualPickupDate datetime - -
EstimatedDeliveryDate datetime - -
ActualDeliveryDate datetime - -
LastFreeDayDate datetime - -
EmptyReadyDate datetime - -
EmptyReturnedDate datetime - -
CargoReadyDate datetime - -
AvailableForPickupDate datetime - -
EstimatedAvailableForPickupDate datetime - -
Object string - -

BookingLineItem

Documentation: https://apidocs.flexport.com/2023-07-01/tag/BookingLineItem

Column Type Relates to Notes
RemoteID string - -
BookingRemoteID string Booking → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
PurchaseOrderLineItemRemoteID string PurchaseOrderLineItem → RemoteID -
Units int - -

OceanBookingDetail

Column Type Relates to Notes
RemoteID string - -
BookingRemoteID string Booking → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContainerCountTwentyFt int - -
ContainerCountFortyFt int - -
ContainerCountFortyFtHc int - -
ContainerCountFortyFiveFtHc int - -
IsLcl boolean - -
Incoterm string - -
WantsPickupService boolean - -
WantsDeliveryService boolean - -
OriginPortName string - -
DestinationPortName string - -

AirBookingDetail

Column Type Relates to Notes
RemoteID string - -
BookingRemoteID string Booking → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Incoterm string - -
WantsPickupService boolean - -
WantsDeliveryService boolean - -
OriginPortName string - -
DestinationPortName string - -

TruckingBookingDetail

Column Type Relates to Notes
RemoteID string - -
BookingRemoteID string Booking → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
IsFtl boolean - -
PaymentTerms string - -
DescriptionOfProducts string - -

CompanyEntity

Documentation: https://apidocs.flexport.com/2023-07-01/tag/CompanyEntity

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Ref string - -
MailingAddressRef string - -
VatNumbers string -
  • 27 Feb 2024 It seemed unreasonable to create a full sync entity for Vat Numbers as they have no endpoint, are very simple in structure and are used by multiple other endpoint, so I simply combine them into a single string for preservation in the data
Object string - -

InvoiceCreditMemo

Column Type Relates to Notes
RemoteID string - -
InvoiceRemoteID string Invoice → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CreditedAt datetime - -
Amount decimal - -
AmountCurrencyCode string - -

InvoiceItem

Column Type Relates to Notes
RemoteID string - -
InvoiceRemoteID string Invoice → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
LineNumber int - -
Slug string - -
Category string - -
Amount decimal - -
AmountCurrencyCode string - -
RateValue decimal - -
RateQualifier string - -
QuantityValue decimal - -
QuantityQualifier string - -

ProductClassification

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Region string - -

ProductSupplier

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CountryOfOrigin string - -
Ref string - -

ShipmentDangerousGoodClassification

Column Type Relates to Notes
RemoteID string - -
ShipmentRemoteID string Shipment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Classification string - -

ShipmentItem

Documentation: https://apidocs.flexport.com/2023-07-01/tag/Shipment#operation/shipment_index

Column Type Relates to Notes
RemoteID string - -
ShipmentRemoteID string Shipment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
TotalUnits decimal - -
Unit string - -
WeightUnits string - -
WeightValue decimal - -
VolumeUnits string - -
VolumeValue decimal - -
PurchaseOrderNumber string PurchaseOrder → RemoteID -
ProductRemoteID string Product → RemoteID -
TotalUnitsUnitOfMeasure string - -
AdditionalQuantityUnits string - -
AdditionalQuantityValue decimal - -
PackageQuantityUnits string - -
PackageQuantityValue decimal - -
Reference string - -
ShipmentContainerRemoteID string ShipmentContainer → RemoteID -
Object string - -

ShipmentMetaDataValue

Column Type Relates to Notes
RemoteID string - -
ShipmentRemoteID string Shipment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ShipmentID string Shipment → ID -
Key string - -
ValueNumber int - -
Value string - -

ProductClassificationCode

Column Type Relates to Notes
RemoteID string - -
ProductClassificationRemoteID string ProductClassification → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Code string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Flexport data Interactive ERD Querying Flexport using regular SQL