What is the SHIP API?

The SHIP API (or Application Programmer Interface) is a defined interface which allows programmers not familiar with SHIP internals to perform two main functions:

• pass updates into the SHIP network, and
• receive and process tickets that have been entered on SHIP scalehouse computers.

The SHIP API documentation (to be made available) fully describes the formats of transactions, both those received from and sent by the SHIP programs. There are two key points at which an Accounting system may be integrated in to the SHIP system.

• If the SHIP billing system, known as SHIP/ OFFICE is not being used, then typically the integration will occurr with the SHIPHUB program. Tickets will be received from the SHIPHUB program and products, customers and pricing will be passed to SHIPHUB.
• If the SHIP billing system is being used, tickets are still available from the SHIPHUB program and are also available after being priced and invoiced in SHIP/ OFFICE.
  The second option is useful to customers who are using SHIP for billing but wish to use a third party's Accounts Receivable, Job Costing or General Ledger.

Benefits of the SHIP API

• The entire network of SHIP locations can be updated through one point, the SHIPHUB. SHIPHUB will perform the function of relaying updates to each location running SHIP using the Internet, a modem, or even a USB key. As well SHIPHUB will collect tickets produced at each location.
• SHIP can be updated in real-time. For example, as updates are entered into the main Accounting system, the updates can be passed to the SHIP system almost simultaneously.
• SHIP can be updated seamlessly. If programmed properly, the updates are passed automatically to SHIP for updating; no further intervention in the form of import-export or a separate update step is required.
• The SHIP API requires no additional hardware to run,beyond running the SHIPHUB program. 1 to 2 days of training on the SHIP transactions and on SSI Pipex is suggested.