Connect HaiGuanJia with Open Flow

Check a vessel’s progress or find the correction behind a rejected manifest.

  • 76 actions
  • Custom credentials
  • Maps & location
  • Data & analytics
  • Cross-border commerce

20,000 free app calls per month (paid services billed separately)

What you can do

Access subscribed vessel tracks, authorized vehicle data, port information, and supported manifest submission and receipt workflows.

Vessels, Vehicles, and Carrier Tracking

Read vessel positions and tracks, query authorized trucks, and read a carrier tracking subscription.

Port Containers and Schedules

Query port container or schedule data and create the required subscriptions or schedule bindings.

Manifest Submission and Receipts

Submit complete Shanghai or Qingdao manifests, read Shanghai receipts, or request selected manifest changes.

All actions

76 actions

Subscribe Ship

Subscribe a vessel in HaiGuanJia so its track information can be queried.

hgj.subscribe_ship

Get Ship Position

Get the latest HaiGuanJia position and identity data for a vessel.

hgj.get_ship_position

List Ship Track Points

List HaiGuanJia track points for a previously subscribed vessel within a time range.

hgj.list_ship_track_points

Batch Get Truck Positions

Get current positions for multiple trucks. Only query vehicles that the caller is authorized to track. HaiGuanJia may charge for this request.

hgj.batch_get_truck_positions

List Truck Track Points

List a truck's historical track and parking events. Only query vehicles that the caller is authorized to track. HaiGuanJia documents this query as chargeable on every request.

hgj.list_truck_track_points

Subscribe Full Journey Tracking

Subscribe a bill, booking/SO number, or container for HaiGuanJia carrier full-journey tracking. Subscription submission is free, but delivered callback data is billed per returned container, so Connector never retries this request automatically.

hgj.subscribe_full_journey_tracking

Get Full Journey Tracking

Get carrier full-journey data for a subscription previously created by the connected HaiGuanJia account. Use this as a fallback when a callback was not received.

hgj.get_full_journey_tracking

Send Shanghai Manifest

Send a complete Shanghai port manifest through HaiGuanJia. HaiGuanJia charges once per customs declaration number, so Connector never retries this request automatically.

hgj.send_shanghai_manifest

Get Shanghai Manifest Status

Get send receipts for a customs declaration submitted through the connected HaiGuanJia account.

hgj.get_shanghai_manifest_status

Resend Shanghai Manifest

Resend an original Shanghai manifest that HaiGuanJia has rejected. This endpoint only accepts the rejected original manifest and Connector never retries it automatically.

hgj.resend_shanghai_manifest

Withdraw Shanghai Manifest

Withdraw a rejected Shanghai manifest submission. A successful withdrawal refunds the documented balance or usage count.

hgj.withdraw_shanghai_manifest

List Shanghai Shipping Agents

List candidate Shanghai shipping agent names for a bill, carrier, vessel, and voyage. HaiGuanJia documents the result as reference data only.

hgj.list_shanghai_shipping_agents

Validate Shanghai Voyage

Validate a Shanghai vessel and voyage and return its port calls and current planned timing.

hgj.validate_shanghai_voyage

Update Shanghai Manifest

Overwrite selected customs declarations in an existing Shanghai manifest. HaiGuanJia charges for each modified customs declaration, so Connector never retries this request automatically.

hgj.update_shanghai_manifest

Get Shanghai Manifest Update Status

Get the receipt status for a Shanghai manifest update submitted through the connected HaiGuanJia account.

hgj.get_shanghai_manifest_update_status

Delete Shanghai Manifest

Delete selected customs declarations from an existing Shanghai manifest. HaiGuanJia charges once per declaration, so Connector never retries this request automatically.

hgj.delete_shanghai_manifest

Get Shanghai Manifest Deletion Status

Get the receipt status for a Shanghai manifest deletion submitted through the connected HaiGuanJia account.

hgj.get_shanghai_manifest_deletion_status

Subscribe Port Container

Subscribe Ningbo, Shanghai, Shenzhen, or Qingdao container/cargo data. Submission is free but callbacks are billed per returned bill or booking number, so Connector never retries automatically.

hgj.subscribe_port_container

Get Port Container

Get current Ningbo, Shanghai, Shenzhen, or Qingdao container/cargo data. HaiGuanJia automatically subscribes missing data, so this operation may create a billed callback workflow and Connector never retries it automatically.

hgj.get_port_container

Get Ningbo Master House Bills

Resolve Ningbo master and house bill relationships without requiring the caller to identify whether the supplied bill is a master or house bill.

hgj.get_ningbo_master_house_bills

Bind Ningbo Schedule

Bind a Ningbo bill to an explicit vessel schedule.

hgj.bind_ningbo_schedule

Bind Shanghai Schedule

Bind a Shanghai bill to an explicit HaiGuanJia vessel schedule.

hgj.bind_shanghai_schedule

Subscribe Port Schedule

Subscribe Ningbo, Shanghai, Shenzhen, or Qingdao vessel schedule data. Submission is free but callbacks are billed per returned vessel and voyage, subscriptions expire after 45 days, and Connector never retries automatically.

hgj.subscribe_port_schedule

Get Port Schedule

Get current Ningbo, Shanghai, Shenzhen, or Qingdao vessel schedule data. HaiGuanJia automatically subscribes missing or expired schedules, so Connector never retries this request automatically.

hgj.get_port_schedule

Send Qingdao Manifest

Send a Qingdao manifest using HaiGuanJia coins. The request is chargeable and Connector never retries it automatically.

hgj.send_qingdao_manifest

Resend Qingdao Manifest

Resend the rejected original Qingdao manifest. Connector sends the operation once and never retries automatically.

hgj.resend_qingdao_manifest

Withdraw Qingdao Manifest

Withdraw a rejected Qingdao manifest and request the documented refund.

hgj.withdraw_qingdao_manifest

Validate Qingdao Voyage

Validate a Qingdao vessel and voyage using the product API ID rather than the conflicting example ID.

hgj.validate_qingdao_voyage

Get Qingdao Shipping Agent

Get the Qingdao shipping agent for a bill, carrier, vessel, and voyage.

hgj.get_qingdao_shipping_agent

Update Qingdao Manifest

Overwrite a Qingdao manifest. HaiGuanJia charges for affected master and house bills, so Connector never retries automatically.

hgj.update_qingdao_manifest

Reallocate Qingdao Manifest

Reallocate a Qingdao manifest to another vessel and voyage. The official page has conflicting billing labels, so Connector treats it as potentially chargeable and never retries automatically.

hgj.reallocate_qingdao_manifest

Delete Qingdao Manifest

Delete one or more Qingdao manifest declaration groups and return the declarations that HaiGuanJia could not delete.

hgj.delete_qingdao_manifest

Send Tianjin Manifest

Send a complete Tianjin manifest including VGM and attachments. The workflow is chargeable, so Connector never retries automatically.

hgj.send_tianjin_manifest

Send Tianjin Pickup Order

Send a Tianjin pickup order. HaiGuanJia documents this sub-interface as free, but the required attachment URLs and all business data remain redacted from execution logs.

hgj.send_tianjin_pickup_order

Send Shenzhen Manifest

Send a complete Shenzhen manifest. HaiGuanJia documents the request as chargeable, so Connector never retries automatically.

hgj.send_shenzhen_manifest

Send Nansha Manifest

Send a complete Nansha manifest. HaiGuanJia documents the request as chargeable, so Connector never retries automatically.

hgj.send_nansha_manifest

Get Shenzhen Nansha Schedule

Query Shenzhen or Nansha vessel schedules using the selected product API ID and the shared official endpoint.

hgj.get_shenzhen_nansha_schedule

Send Vgm

Send or resend multi-port VGM data. HaiGuanJia charges for every container on every call, including resends, so Connector never retries automatically.

hgj.send_vgm

Subscribe Us Customs Data

Subscribe US destination customs data for a bill and carrier. HaiGuanJia documents this request as chargeable, so Connector never retries automatically.

hgj.subscribe_us_customs_data

Subscribe Us Terminal Data

Subscribe US terminal data for a container and port. HaiGuanJia documents this request as chargeable, so Connector never retries automatically.

hgj.subscribe_us_terminal_data

Subscribe New Us Customs

Submit a new US customs-data subscription. HaiGuanJia bills this workflow on the business side, so Connector never retries automatically.

hgj.subscribe_new_us_customs

Get New Us Customs

Get the complete new US customs result for a prior HaiGuanJia query, including BOL, air, importer-bond, and in-bond data when present.

hgj.get_new_us_customs

Send Afr Manifest

Send an AFR manifest. HaiGuanJia charges once per house bill, so Connector never retries automatically.

hgj.send_afr_manifest

Update Afr Manifest

Overwrite an existing AFR house bill and its complete container data.

hgj.update_afr_manifest

Delete Afr Manifest

Delete an AFR house bill with the required cancellation reason.

hgj.delete_afr_manifest

Send Ams Manifest

Send an AMS manifest through HaiGuanJia agency service or the customer's own SCAC channel. Each house bill is chargeable and Connector never retries automatically.

hgj.send_ams_manifest

Update Ams Manifest

Overwrite an AMS manifest through the selected agency or customer SCAC channel.

hgj.update_ams_manifest

Delete Ams Manifest

Delete an AMS house bill through the selected agency or customer SCAC channel.

hgj.delete_ams_manifest

Send Isf5 Manifest

Send an ISF-5 manifest through HaiGuanJia agency filing or the customer's own FILER CODE channel. Each AMS bill is chargeable and Connector never retries automatically.

hgj.send_isf5_manifest

Update Isf5 Manifest

Overwrite an ISF-5 manifest through the selected agency or customer FILER CODE channel.

hgj.update_isf5_manifest

Delete Isf5 Manifest

Delete an ISF-5 AMS bill through the selected agency or customer FILER CODE channel.

hgj.delete_isf5_manifest

Send Isf10 Manifest

Send an ISF-10 manifest through HaiGuanJia agency filing or the customer's own FILER CODE channel. Each AMS bill is chargeable and Connector never retries automatically.

hgj.send_isf10_manifest

Update Isf10 Manifest

Overwrite an ISF-10 manifest through the selected agency or customer FILER CODE channel.

hgj.update_isf10_manifest

Delete Isf10 Manifest

Delete an ISF-10 AMS bill through the selected agency or customer FILER CODE channel.

hgj.delete_isf10_manifest

Send Em Manifest

Send an EM manifest through agency filing or the customer's own 8000-code channel. Each house bill is chargeable and Connector never retries automatically.

hgj.send_em_manifest

Update Em Manifest

Overwrite an EM manifest through the selected agency or customer channel.

hgj.update_em_manifest

Delete Em Manifest

Delete an EM house bill through the selected agency or customer channel.

hgj.delete_em_manifest

Check Em Bill Availability

Check whether an EM 8000-code and house-bill combination is available.

hgj.check_em_bill_availability

Close Em Manifest

Submit EM Close for a full 8000-code house bill. The official page has conflicting free/consumption wording, so Connector treats it as potentially chargeable and never retries automatically.

hgj.close_em_manifest

Cancel Em Manifest Close

Cancel EM Close for a full 8000-code house bill.

hgj.cancel_em_manifest_close

Send Aci Manifest

Send an ACI manifest through agency filing or the customer's own 8000-code channel. Each house bill is chargeable and Connector never retries automatically.

hgj.send_aci_manifest

Update Aci Manifest

Overwrite an ACI manifest through the selected agency or customer channel.

hgj.update_aci_manifest

Delete Aci Manifest

Delete an ACI house bill through the selected agency or customer channel.

hgj.delete_aci_manifest

Check Aci Bill Availability

Check whether an ACI 8000-code and house-bill combination is available.

hgj.check_aci_bill_availability

Send Ics2 Manifest

Send an ICS2 F14, F15, F16, or F17 manifest. HaiGuanJia bills the submission on the business side, so Connector never retries automatically.

hgj.send_ics2_manifest

Update Ics2 Manifest

Overwrite an ICS2 F14, F15, F16, or F17 manifest identified by billId.

hgj.update_ics2_manifest

Delete Ics2 Manifest

Delete an ICS2 manifest through the shared endpoint while preserving the selected F14, F15, F16, or F17 product API ID.

hgj.delete_ics2_manifest

Submit Export Customs Recognition

Submit a chargeable export customs-recognition task. HaiGuanJia fetches each fileUrl and Connector never retries automatically.

hgj.submit_export_customs_recognition

Get Export Customs Recognition Result

Get the current export customs-recognition task state and structured or customs-XML result.

hgj.get_export_customs_recognition_result

Submit Import Customs Recognition

Submit a chargeable import customs-recognition task. HaiGuanJia fetches each fileUrl and Connector never retries automatically.

hgj.submit_import_customs_recognition

Get Import Customs Recognition Result

Get the current import customs-recognition task state and structured or customs-XML result.

hgj.get_import_customs_recognition_result

Recognize Document

Recognize one or more documents with a fixed HaiGuanJia product template. This business-side billed request requires the connection's separate secondaryApiKey and is never retried automatically.

hgj.recognize_document

Recognize Custom Document

Recognize one or more documents with a promptCode maintained in HaiGuanJia's external Storybrooke console. This business-side billed request requires the connection's separate secondaryApiKey and is never retried automatically.

hgj.recognize_custom_document

Submit Ai Customs Intake

Submit a new AI customs-intake request. Connector fixes isModify to false and HaiGuanJia fetches each attachment URL.

hgj.submit_ai_customs_intake

Update Ai Customs Intake

Overwrite an existing AI customs-intake request. Connector fixes isModify to true and HaiGuanJia fetches each attachment URL.

hgj.update_ai_customs_intake

Get Ai Customs Intake Status

Get the raw HaiGuanJia AI customs-intake status. Automatic wait semantics are unavailable because the official status enum is not documented.

hgj.get_ai_customs_intake_status

Connect HaiGuanJia with Open Flow

Connect HaiGuanJia

20,000 free app calls per month (paid services billed separately)