Getting Started

Welcome to the Spreetail Channel Integration API! This guide will help you make your first API call in minutes.

What is the Spreetail Channel Integration API?

The Spreetail Channel Integration API is a RESTful API that enables 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

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

Next Steps

Common Use Cases

Creating Orders

Learn how to create and manage outbound orders:

• Creating Orders Guide

Checking Inventory

Query real-time inventory levels:

• Checking Inventory Guide

Managing Inbound Deliveries

Register inbound shipments and purchase orders:

• Inbound Deliveries Guide

Support

For API access, questions, or support:

Email: [email protected]

Related Documentation

• API Overview - High-level API architecture
• Integration Flow - Integration options and flows
• Customer Portal - Portal access and features

Ready to get started? Contact [email protected] to receive your API credentials and begin integrating with Spreetail's fulfillment platform.