Create Outbound Order

Endpoint: POST /outbound

Full URL: https://api.spreetaileu.com/api/api/v1/outbound

Create an outbound order for fulfillment.

Requirements

  • Authentication: Bearer token required (Get token from /auth/login)
  • Client mapping: Your token contains client identification

Order Processing

Orders are:

  1. Validated against the schema
  2. Stored securely with your client identifier
  3. Processed by our fulfillment system
  4. Shipped according to the dispatch timeline

Important Fields

  • ReferenceNumber: Must be unique per client
  • Currency: Must be a valid ISO 4217 code (EUR, GBP, USD)
  • OrderItems: At least one item required
  • PricePerUnit: Must be greater than 0 (minimum: 0.01). Orders with zero price will be rejected by Linnworks.
  • OrderLineNumber: Required (e.g., '1', '2') and cannot be empty. Required for order processing compatibility with Linnworks.
  • DeliveryAddress & BillingAddress: Both required with complete information
  • warehouse_name: Optional warehouse name string (e.g. RHEINE01); stored as-is on the order record
  • Status: Automatically set to "Pending" - do not include in request (any value provided will be ignored)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique order reference number (must be unique per client)

date-time
required

Order received date (ISO 8601 format)

date-time
required

Required dispatch date (ISO 8601 format)

string
enum
required

Currency code (ISO 4217)

Allowed:
string

Payment status

string

Customer name

float
Defaults to 0

Shipping cost

float
Defaults to 0

Shipping tax rate (percentage)

string

Optional warehouse name (e.g. ramy data testing). Stored on the order record in DynamoDB (linnworks-channel-orders.warehouse_name). When omitted, defaults to an empty string.

OrderItems
array of objects
required
length ≥ 1

Array of order items (minimum 1 item required)

OrderItems*
DeliveryAddress
object
required
BillingAddress
object
required
ExtendedProperties
array of objects
Defaults to []

Additional custom properties

ExtendedProperties
Notes
array of objects
Defaults to []

Order notes

Notes
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json