Pipe17 API References

Key API Resources

Core API Documentation

The API documentation at apidoc.pipe17.com includes:

• Entity Models: Detailed schemas for all Pipe17 entities (orders, products, inventory, etc.)

• Endpoints: Complete list of available API endpoints with request/response formats

• Authentication: Information on how to authenticate API requests

• Error Handling: Standard error codes and troubleshooting guidance

Data Models

General data model information is available here. The API documentation provides detailed models for all core entities:

• Orders: Pipe17 API

• Shipping Requests: Pipe17 API

• Fulfillments: Pipe17 API

• Products: Pipe17 API

• Inventory: Pipe17 API

Integration Approaches

Pipe17 offers two main approaches for integrating with their app:

Custom Integration Framework (Recommended)

This is the preferred method for building integrations with Pipe17. It provides a more structured approach with better security and visibility.

Key Features:

• Integration appears in the Pipe17 UI

• Access is restricted to data owned by the integration

• Events are registered under the integration

• Integration can expose settings and mappings for organization admins

API-based Connection (Legacy)

This is the older method of integrating with Pipe17, which is simpler but has limitations.

Key Features:

• Uses a user-created API key

• Simpler to implement for limited use cases

• API key has access to all data for granted resource types

Documentation:

• API Based Connection (Legacy)

Webhooks

Pipe17 supports webhooks for real-time notifications about entity changes:

Key Features:

• Register webhooks for specific entity types (orders, fulfillments, products, inventory, etc.) - Please see the Webhook API Doc for full list of entities supported.

• Receive notifications when entities are created, updated, or deleted

• Use API keys for authentication

Documentation:

• Getting started with Pipe17 Webhooks

Reference Implementation

Pipe17 provides reference implementations to help developers understand how to build integrations:

1. Pipe17 API Client Node Module: A Node.js client for the Pipe17 API

2. Pipe17 3PL Reference Implementation: An example implementation of a 3PL integration

Best Practices for API Integration

1. Use the Custom Integration Framework when possible for better security and visibility

2. Store and use checkpoint timestamps when polling for updates to avoid processing the same data multiple times

3. Handle rate limits by implementing appropriate backoff strategies

4. Implement proper error handling to manage API failures gracefully

5. Use webhooks for real-time notifications rather than frequent polling when possible

6. Secure API keys and never expose them in client-side code

Need Help?

If you need additional assistance:

• Use Ask Pippen, our AI agent, located at the top of the app page.

• Submit a support request with as much relevant detail as possible. Learn how to submit a request.

• For urgent issues, email us directly at support@pipe17.com.

We're here to help you succeed with your operations.