Partner API Overview#

The Partner API provides a set of integrations that enable partners to connect their systems directly with our platform, automate key operational processes, and manage their business in real time. Depending on your business needs and technical capabilities, you can use our APIs to manage orders, product catalogs, promotions, and outlet operations.

Explore the Partner API offerings below to find the integrations that best fit your needs.

Manage Incoming Orders - Partner API/Orders#

Partner API/Orders allows you to receive, process, and track customer orders in real time. You can integrate the API with your own fulfilment system or use our Pelican Picking Device solution to manage orders throughout the fulfilment process.

With Partner API/Orders, you can:

• Receive real-time notifications when new orders are placed

• Process and manage orders through your fulfilment workflow

• Track order status from picking and packing through dispatch and delivery

• Integrate with your own fulfilment application or use the Pelican fulfilment solution

There are two integration options depending on how you manage fulfilment:

1. Partner Picking Device - Use your own fulfilment device and application, integrating directly with the API to receive and process orders.

2. Pelican Picking Device - Use our Pelican fulfilment application and picking device, with the API providing real-time order updates.

Manage Your Product Catalog - Partner API/Catalog#

Partner API/Catalog enables you to manage and synchronise product information between your systems and our platform. It is designed for partners who want to efficiently maintain their product availability, pricing, and catalog information through a direct API integration.

With Partner API/Catalog, you can:

• Manage real-time product availability and stock information

• Update and synchronise product prices

• Keep product information up to date on our platform

• Automate catalog management through a direct API connection

This integration is ideal for partners with the technical capabilities to build and maintain an API connection. If you do not have API capabilities, you can use our file-based SFTP Catalog solution instead.

Grow Your Business - Partner API/Promotions#

Partner API/Promotions enables you to create and manage promotions directly through an API, helping you automate promotion setup and efficiently manage discounts at scale.

With Partner API/Promotions, you can:

• Create and manage strikethrough discounts, including percentage-off, absolute-value-off, and final-price promotions

• Create and manage same-item bundle discounts, including percentage-off, absolute-value-off, and free-item promotions

• Automate promotion creation and management

• Reduce manual effort and gain greater control over your promotional strategy This integration is ideal for partners with the technical capabilities to build and maintain an API connection who want to automate their promotion management. If you do not have API capabilities, you can use our file-based SFTP Promotion solution instead.

Manage Your Outlets - Partner API/Outlet Management#

Partner API/Outlet Management allows you to control your stores' operational status and schedules directly through an API. It provides real-time visibility and flexible control over outlet availability, opening hours, closures, and check-ins.

With Partner API/Outlet Management, you can:

• Update and retrieve your outlet's open or closed status in real time

• Manage opening hours and schedule changes

• Apply temporary closures or busy mode when needed

• Manage required check-ins before opening an outlet to customers

• Keep your outlet availability information accurate and up to date

Choose the Right Partner API Integration#

Whether you want to manage incoming orders, synchronise your product catalog, automate promotions, or control your outlet operations, the Partner API enables you to connect your systems with our platform and streamline your day-to-day operations.

For detailed information on each integration, including requirements, endpoints, use cases, testing guidance, troubleshooting, and FAQs, refer to the dedicated documentation pages for each Partner API offering.