Skip to main content

Introduction

Welcome to the Warehouse API documentation! This API is designed for seamless integration with warehouse management systems, organized around RESTful principles, and generated using Protocol Buffers (protobufs).

Getting Started​

Protocol Buffers (protobufs)​

Our API structure is defined by protobuf files, providing a clear definition of data formats and message types. Explore the official documentation for detailed protobuf information.

RESTful Architecture​

The API follows RESTful principles, offering simplicity, flexibility, and ease of use. Endpoints are logically organized for CRUD operations on warehouse entities.

Base Endpoint​

The base url endpoint is your courier's domain followed by rpc

https://<COURIER_DOMAINA.COM>/rpc

https://shipcourier.com/rpc