APIs invoked during Parcel Carrier Adapter integration
APIs are invoked during the Sterling Order Management System Software integration with the Carrier Adapter.
APIs invoked during the Carrier Adapter integration with UPSN
- openManifest API
- shipCarton API
- deleteCarton API
- closeManifest API
APIs invoked during the Carrier Adapter integration with FedEx
- openManifest API
- shipCarton API
- deleteCarton API
- closeManifest API
APIs used for Carrier Adapter integration
The Sterling Order Management System Software integrates with the Carrier Adapter using the following APIs:
- openManifest API: The openManifest API is used to open a manifest for a carrier server. This API calls the openManifest API in the Carrier Adapter. For field level mapping details between these APIs, see "Field-Level Mapping Between the openManifest API on the Sterling Order Management System Software and the openManifest API on the Carrier Adapter".
- addContainerToManifest API: The addContainerToManifest API is used to add a container to a manifest. This API calls the shipCarton API in the Carrier Adapter. For field level mapping details between these APIs, see "Mappings Between the addContainerToManifest API on the Sterling Order Management System Software and the shipCarton API on the Carrier Adapter".
- removeContainerFromManifest API: The removeContainerFromManifest API is used to delete a carton from a manifest. This API calls the deleteCarton API on the Carrier Adapter. For field level mapping details between these APIs, see "Mapping Between the removeContainerFromManifest API on the Sterling Order Management System Software and the deleteCarton API on the Carrier Adapter".
- closeManifest API: The closeManifest API
is used to close a manifest. This API calls the closeManifest API
on the Carrier Adapter. For field level mapping details between these
APIs, see "Mapping Between the closeManifest API on the Sterling Order Management System Software and
the closeManifest API on the Carrier Adapter". Note: For the FedEx carrier, the Carrier Adapter supports label prints when a container is added to a manifest if the FedEx Printer is configured on the FedEx Carrier Server. For the UPSN carrier, the Carrier Adapter supports label prints when a container is added to a manifest or a manifest is closed.