Welcome to Spreetail Channel Integration API

The Spreetail Channel Integration API enables you to seamlessly integrate with our fulfillment system to create orders, manage inventory, and track shipments. This guide will help you get up and running quickly.

What is the Spreetail Channel Integration API?

The Spreetail Channel Integration API is a RESTful API that allows you to:

• Create Orders: Submit outbound orders for fulfillment
• Manage Inventory: Check real-time inventory levels and stock availability
• Create Inbound Deliveries: Register inbound shipments and purchase orders
• Calculate Shipping: Get shipping cost estimates for outbound orders
• Track Orders: Retrieve order status and tracking information

Quick Start

Step 1: Get Your Credentials

Contact [email protected] to receive your:

• Client ID: Your unique client identifier
• Client Secret: Your secret key for authentication

🔒

Security Note: Keep your Client Secret secure and never expose it in client-side code or public repositories.

Step 2: Authenticate

Use your credentials to obtain a JWT access token:

curl -X POST 'https://api.spreetaileu.com/api/api/v1/auth/login' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "your-client-id",
    "client_secret": "your-client-secret"
  }'

Response:

{
  "success": true,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_in": 86400,
    "client_id": "your-client-id"
  }
}

The token is valid for 24 hours and should be reused for all API requests during this period.

Step 3: Make Your First API Call

Use the access token to create an order:

curl -X POST 'https://api.spreetaileu.com/api/api/v1/outbound' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
    "ReferenceNumber": "ORD-2025-001",
    "ReceivedDate": "2025-01-15T10:00:00Z",
    "DispatchBy": "2025-01-16T17:00:00Z",
    "Status": "Pending",
    "Currency": "EUR",
    "PaymentStatus": "PAID",
    "ChannelBuyerName": "John Doe",
    "OrderItems": [{
      "SKU": "PROD-12345",
      "ItemTitle": "Premium Headphones",
      "Qty": 2,
      "PricePerUnit": 29.99
    }],
    "DeliveryAddress": {
      "FullName": "John Doe",
      "Address1": "123 Main Street",
      "Town": "Berlin",
      "PostCode": "10115",
      "Country": "Germany",
      "CountryCode": "DE"
    },
    "BillingAddress": {
      "FullName": "John Doe",
      "Address1": "123 Main Street",
      "Town": "Berlin",
      "PostCode": "10115",
      "Country": "Germany",
      "CountryCode": "DE"
    }
  }'

API Base URL

All API requests should be made to:

https://api.spreetaileu.com/api/api/v1

Integration Types

Before you begin, it's helpful to understand the different integration options available:

ℹ️

Not sure which integration type fits your needs? Check out our Integration Types Guide to learn about Direct Integration, Custom Integration, and more.

Common Use Cases

Code Examples

We provide code examples in multiple languages:

• Python: See our Python examples
• JavaScript/Node.js: See our JavaScript examples
• cURL: All endpoints include cURL examples in the reference docs

Next Steps

1. Understand Integration Types: Review the Integration Types Guide to determine which integration approach fits your needs
2. Read the Authentication Guide: Learn about token management and security best practices
3. Explore the API Reference: Browse all available endpoints and their schemas
4. Check Error Handling: Understand how to handle errors and edge cases
5. Review Best Practices: Learn about rate limits, retry strategies, and optimization

Need Help?

• Email Support: [email protected]
• API Reference: Browse the complete API Reference
• Troubleshooting: Check our Common Issues guide

API Version: 1.0.0
Last Updated: January 2025