Stack Custom Shipping Carrier Integration Guide

Enhance your e-commerce capabilities with Stack by integrating your preferred shipping carriers. This guide will walk you through connecting a custom shipping carrier to Stack, allowing you to display real-time shipping rates, automate order fulfillment, and provide accurate tracking information to your customers.

Benefits of Custom Shipping Carrier Integration

Flexibility: Connect with any shipping carrier that offers an API.
Accurate Rates: Display real-time shipping costs from your carrier accounts during checkout.
Automated Fulfillment: Automatically create shipping labels and trigger shipments.
Seamless Tracking: Sync tracking information from the carrier back into Stack orders.
Integrated Experience: Manage shipping directly within the Stack ecosystem.

Integration Overview

Building this integration involves backend development for API calls and webhooks, frontend development for user configuration, and secure management of credentials and data flow between Stack, your service, and the carrier’s API.

Requirements

Technical Knowledge

Basic backend development (e.g., Node.js, Python).
Understanding REST APIs, webhooks, and OAuth 2.0.

Backend Service

Handle OAuth redirection from Stack.
Process webhooks from Stack and the shipping carrier.
Make API calls to Stack and the carrier’s API.

Database

Securely store Stack OAuth tokens and carrier credentials.
Map information between Stack entities (like orders) and carrier entities.

Frontend

A simple application (possibly a Custom Page in Stack) for users to manage their shipping carrier API credentials.

APIs

Implement several API endpoints for OAuth, webhook listeners, and carrier credential management.

Initial Setup

Create Marketplace App

Create a new Marketplace application in Stack.
Set up OAuth and webhook URLs to handle callbacks and events.

Frontend UI

Develop an interface for users to enter and manage their shipping carrier credentials.

Handling User Context

Identify the Stack location the user is interacting with using context provided by Stack.

Carrier Credential Handling

Receive and validate carrier credentials from the user, and store them securely.

Live Shipping Rates Implementation

Register Shipping Carrier in Stack

Make a POST request to Stack’s API to create a shipping carrier.
Provide details such as name and callback URL for live rates.

Implement Live Rates Callback

Implement an endpoint to handle requests from Stack for live shipping rates during checkout.

Configure Shipping Rates in Stack Zones

Add shipping rates based on your carrier to the relevant Shipping Zones within Stack.

Order Syncing and Fulfillment

Enable Order Webhooks

Ensure webhooks for order creation and status updates are enabled.

Handling Order Creation Webhook

Process webhooks from Stack when an order is created or its status changes.
Transform order data and create shipments with your carrier.

Handling Carrier Shipping Updates

Receive notifications from the carrier about shipment status changes.
Update Stack with tracking information and fulfill orders.

Disconnection and Uninstallation

Deleting the Shipping Carrier

Listen for app uninstallation events and clean up integration settings within Stack.

Conclusion

By following this guide, you can build a robust integration that streamlines shipping operations for Stack users. Prioritize secure authentication, reliable API integration, and efficient data management to ensure a seamless experience.