Getting Started
Ship API provides an end-to-end management solution for large-scale printing jobs. This enables users to configure shipments to work with couriers that are not already integrated into Site Flow or for users who would like to have full control by building the integration themselves. The entity referred to as the Partner in this guide refers to the shipping backend, which may or may not be the PSP. PSP refers to the print service provider or partner who dispatches through Site Flow.
The diagram below displays the full process. With this integration model, once a shipment is triggered in the Site Flow UI, Site Flow will generate a request via the Ship API that will contact the customer endpoint. The customer endpoint is integrated with the carrier and handles the communication with it. The customer endpoint will send back a JSON response containing all the needed data to handle the shipment in Site Flow
This guide covers the customer endpoint, sending the JSON request by the Ship API, and the Ship API’s response. All examples are written in JavaScript.
