{{ message.head }}

{{ message.text }}

LynkaHub API · B2B integration

LynkaHub API: connect your system directly to Lynka

Submit decorated-apparel orders, track their status and shipment, and check live stock availability straight from your ERP, e-commerce platform or order management system. No manual uploads, no re-typing — one REST API for your orders with Lynka.

  • REST · JSON
  • Version 1.07
  • Test environment available

What the API covers

Four things your system can do with Lynka

The LynkaHub API is built for distributors, resellers and brands that order branded apparel from Lynka regularly and want those orders to flow automatically.

Submit orders

Send orders with shipping details, Lynka SKUs and decoration data — embroidery, screen print, digital print or transfer — for Standard, print-on-demand and stock lines.

POST /orders

Track order status

Follow every order from queue to shipment. Statuses tell you whether it was accepted, needs a correction or has shipped — with carrier tracking numbers.

GET /orders/{id}

Check stock availability

Download availability for the SKUs in your catalogue — stock in the Lynka warehouse and at the vendor — in full or incrementally, refreshed every 3 hours.

GET /availability

Correct decorations

If a single decoration line is rejected, fix and resend just that line. The rest of the order keeps moving — no need to resubmit everything.

PUT …/decorations/{code}

How it works

From first call to shipped order

Orders are processed asynchronously: your system hands the order over in one call and checks the outcome in another.

  1. Get access

    Send us the public IP addresses you will call from. We allowlist them and issue your client code and API key.

  2. Submit the order

    A 202 response confirms the order is queued and returns a correlationId — store it.

  3. Check the status

    Validation and delivery to production happen in the background. Poll the status — once every 15 minutes is enough.

  4. Receive tracking

    When the order ships, its status changes to SHIPPED and the carrier tracking number is returned.

Order statuses PENDING ACCEPTED SHIPPED REJECTED DUPLICATE FAILED

Endpoints

API at a glance

Six endpoints under /api/v1. Full field rules, response examples and error codes are in the documentation.

MethodEndpointPurpose
GET/api/v1/healthCheck that the API is reachable (no API key required)
POST/api/v1/ordersSubmit a new order with order lines and decoration data
GET/api/v1/orders/{correlationId}Status of a single submission, incl. errors and tracking numbers
GET/api/v1/orders?orderNo=…Full history of submissions under one order number
PUT/api/v1/orders/{correlationId}/lines/{lineNo}/decorations/{externalDesignCode}Replace a rejected decoration line with corrected data
GET/api/v1/availabilityStock availability per Lynka SKU, paginated and filterable

Example

What a call looks like

Standard HTTPS requests with JSON bodies — any language or integration platform that can send HTTP requests can connect.

POST /api/v1/orders
X-Client-Code: YOUR_CLIENT_CODE
X-Api-Key: YOUR_API_KEY
Content-Type: application/json

{
  "orderNo": "ORD-2026-00123",
  "shipToName": "John Smith",
  "shipToCountryCode": "PL",
  // … remaining shipping fields
  "orderLines": [
    {
      "lineNo": 10000,
      "itemNo": "TBC/TU01T/001/3",
      "quantity": 5,
      "orderType": "Standard",
      "designCode": "NZ02033-26-P00062",
      "decorationLines": [
        { "externalDesignCode": "NZ02033-26-P00062", "decorationType": "Embroidery" }
      ]
    }
  ]
}

// 202 Accepted
{ "correlationId": "f9d72f25-7e0d-4ddd-9256-4c7a3ad5dde0", "status": "NEW" }

Examples are shortened. The documentation lists every field, validation rule and error response.

Before you integrate

Good to know

  • Secured accessEvery request is checked against your IP allowlist plus a client code and API key sent in headers.
  • Asynchronous by designA 202 means “received”, not “valid”. Field errors are reported by the status endpoint.
  • Stock data every 3 hoursDownload the full list or only changed records with modifiedAfter.
  • Test environment firstBuild and test against our test environment. The production URL is shared before go-live.

FAQ

Questions about the LynkaHub API

Who can use the LynkaHub API?

The API is available to Lynka business customers — distributors, resellers, promotional agencies and brands — who want to send orders and read stock data from their own systems. Access is granted per client after a short onboarding.

How do I get API credentials?

Contact us and send the public IP addresses your system will call from. We add them to the allowlist and issue your X-Client-Code and X-Api-Key. The key is shown only once, so store it securely — if it is lost, we issue a new one.

Which decoration methods can I order through the API?

Order lines can carry decoration data for embroidery, screen print, digital print, transfer and sewing, together with placement, size in centimetres, number of colours or stitches, Pantone references and links to artwork files. Order lines can be Standard, print-on-demand (POD) or stock.

How do I know an order was processed correctly?

Submitting an order returns a correlationId. Use it to check the order status: ACCEPTED means it reached production, SHIPPED means it is on its way with a tracking number, and REJECTED lists the fields to correct. There are no callbacks yet — polling once every 15 minutes per order is recommended.

How current is the stock availability data?

Availability is refreshed every 3 hours and shows quantities in the Lynka warehouse and at the vendor for the SKUs in your catalogue. One full download every few hours, or an incremental call for changed records, keeps your shop up to date.

Is there a test environment?

Yes. Every integration starts on the test environment with test credentials. The production URL is provided before go-live.

Ready to connect your system?

Request access and we will send you the full LynkaHub API documentation (v1.07), test credentials and onboarding details.

Sign In