Skip to content
Sections

API reference

Links

Tie your own variants to supplier variants, so availability can be asked for by your references.

The suppliers the account uses

get/v1/account/suppliers

With the trade account number at each. Matching searches these by default.

Called by
Account client
Scope
catalogue:read

Responses

200The list.Show
  • dataarray of AccountSupplierrequired
    Child attributes
    • apiobject | nullrequired

      The supplier's API, when it offers one through Presslane Suppliers (ADR-011). Null: stock from feeds only, no login needed.

      Child attributes
      • connectionobject | nullrequired

        The account's stored login at the supplier; null until one is sent.

        Child attributes
        • last_checked_atstring (date-time) | nullrequired

          e.g. 2026-11-09T08:00:00Z

        • statusstringrequired

          One of unverified, verified, failed

      • credential_fieldsarray of CredentialFieldrequired

        What to ask the business for: its API login at the supplier.

        Child attributes
        • helpstring | nullrequired
        • keystringrequired

          The key to send in api_credentials.

          e.g. username

        • labelstringrequired

          What to call it when asking the business.

          e.g. Uneek API username

        • requiredbooleanrequired
        • typestringrequired

          password: secret; mask it when asking, and it is never shown back.

          One of text, password

      • featuresarray of stringrequired

        One of place_orders, order_history, invoices, live_stock

      • needs_credentialsbooleanrequired

        True while no working login is stored (none yet, or the supplier refused it): ask the business for one and send it as api_credentials.

      • order_modestringrequired

        test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

        One of off, test, live

    • created_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

    • namestringrequired
    • needs_trade_accountbooleanrequired

      Stock is shown only once a trade account number is given.

    • slugstringrequired
    • supplier_archivedbooleanrequired
    • supplier_idstringrequired
    • trade_account_numberstring | nullrequired
    • updated_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/account/suppliers' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "api": {
        "connection": {
          "last_checked_at": "2026-11-09T08:00:00Z",
          "status": "unverified"
        },
        "credential_fields": [
          {
            "help": "string",
            "key": "username",
            "label": "Uneek API username",
            "required": false,
            "type": "text"
          }
        ],
        "features": [
          "place_orders"
        ],
        "needs_credentials": false,
        "order_mode": "off"
      },
      "created_at": "2026-11-09T08:00:00Z",
      "name": "string",
      "needs_trade_account": false,
      "slug": "string",
      "supplier_archived": false,
      "supplier_id": "string",
      "trade_account_number": "string",
      "updated_at": "2026-11-09T08:00:00Z"
    }
  ]
}
Try it in the sandbox

Replace the suppliers the account uses

put/v1/account/suppliers

Entries may carry the business’s API login at suppliers that offer one (api_credentials). All logins are checked with their suppliers first; if any is refused, nothing changes (409 supplier_auth_failed, with the entry in errors).

Called by
Account client
Scope
links:write

Headers

  • Idempotency-Keystring

    A repeat within 24 hours returns the first response.

    at most 255 characters

Request body · application/json

  • suppliersarray of objectrequired

    at most 200 items

    Child attributes
    • api_credentialsApiCredentials

      Only for suppliers with api_credential_fields. Left out: any stored login is kept. Needs orders:write.

    • supplier_idstringrequired
    • trade_account_numberstring | null

Responses

200The list after the change.Show
  • dataarray of AccountSupplierrequired
    Child attributes
    • apiobject | nullrequired

      The supplier's API, when it offers one through Presslane Suppliers (ADR-011). Null: stock from feeds only, no login needed.

      Child attributes
      • connectionobject | nullrequired

        The account's stored login at the supplier; null until one is sent.

        Child attributes
        • last_checked_atstring (date-time) | nullrequired

          e.g. 2026-11-09T08:00:00Z

        • statusstringrequired

          One of unverified, verified, failed

      • credential_fieldsarray of CredentialFieldrequired

        What to ask the business for: its API login at the supplier.

        Child attributes
        • helpstring | nullrequired
        • keystringrequired

          The key to send in api_credentials.

          e.g. username

        • labelstringrequired

          What to call it when asking the business.

          e.g. Uneek API username

        • requiredbooleanrequired
        • typestringrequired

          password: secret; mask it when asking, and it is never shown back.

          One of text, password

      • featuresarray of stringrequired

        One of place_orders, order_history, invoices, live_stock

      • needs_credentialsbooleanrequired

        True while no working login is stored (none yet, or the supplier refused it): ask the business for one and send it as api_credentials.

      • order_modestringrequired

        test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

        One of off, test, live

    • created_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

    • namestringrequired
    • needs_trade_accountbooleanrequired

      Stock is shown only once a trade account number is given.

    • slugstringrequired
    • supplier_archivedbooleanrequired
    • supplier_idstringrequired
    • trade_account_numberstring | nullrequired
    • updated_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X PUT 'https://suppliers.presslane.ai/v1/account/suppliers' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"suppliers":[{"api_credentials":{"password":"secret","username":"standardprint-api"},"supplier_id":"string"}]}'
Response · 200
{
  "data": [
    {
      "api": {
        "connection": {
          "last_checked_at": "2026-11-09T08:00:00Z",
          "status": "unverified"
        },
        "credential_fields": [
          {
            "help": "string",
            "key": "username",
            "label": "Uneek API username",
            "required": false,
            "type": "text"
          }
        ],
        "features": [
          "place_orders"
        ],
        "needs_credentials": false,
        "order_mode": "off"
      },
      "created_at": "2026-11-09T08:00:00Z",
      "name": "string",
      "needs_trade_account": false,
      "slug": "string",
      "supplier_archived": false,
      "supplier_id": "string",
      "trade_account_number": "string",
      "updated_at": "2026-11-09T08:00:00Z"
    }
  ]
}
Try it in the sandbox

One supplier the account uses

get/v1/account/suppliers/{supplier_id}
Called by
Account client
Scope
catalogue:read

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Responses

200The supplier, with the state of the account’s API login there.Show
  • apiobject | nullrequired

    The supplier's API, when it offers one through Presslane Suppliers (ADR-011). Null: stock from feeds only, no login needed.

    Child attributes
    • connectionobject | nullrequired

      The account's stored login at the supplier; null until one is sent.

      Child attributes
      • last_checked_atstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

      • statusstringrequired

        One of unverified, verified, failed

    • credential_fieldsarray of CredentialFieldrequired

      What to ask the business for: its API login at the supplier.

      Child attributes
      • helpstring | nullrequired
      • keystringrequired

        The key to send in api_credentials.

        e.g. username

      • labelstringrequired

        What to call it when asking the business.

        e.g. Uneek API username

      • requiredbooleanrequired
      • typestringrequired

        password: secret; mask it when asking, and it is never shown back.

        One of text, password

    • featuresarray of stringrequired

      One of place_orders, order_history, invoices, live_stock

    • needs_credentialsbooleanrequired

      True while no working login is stored (none yet, or the supplier refused it): ask the business for one and send it as api_credentials.

    • order_modestringrequired

      test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

      One of off, test, live

  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • namestringrequired
  • needs_trade_accountbooleanrequired

    Stock is shown only once a trade account number is given.

  • slugstringrequired
  • supplier_archivedbooleanrequired
  • supplier_idstringrequired
  • trade_account_numberstring | nullrequired
  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "api": {
    "connection": {
      "last_checked_at": "2026-11-09T08:00:00Z",
      "status": "unverified"
    },
    "credential_fields": [
      {
        "help": "string",
        "key": "username",
        "label": "Uneek API username",
        "required": false,
        "type": "text"
      }
    ],
    "features": [
      "place_orders"
    ],
    "needs_credentials": false,
    "order_mode": "off"
  },
  "created_at": "2026-11-09T08:00:00Z",
  "name": "string",
  "needs_trade_account": false,
  "slug": "string",
  "supplier_archived": false,
  "supplier_id": "string",
  "trade_account_number": "string",
  "updated_at": "2026-11-09T08:00:00Z"
}
Try it in the sandbox

Connect a supplier to the account

put/v1/account/suppliers/{supplier_id}

Adds the supplier to the account’s list, or updates it. Where the supplier offers API access (its api_credential_fields are not empty), send the business’s own API login there as api_credentials: it is checked with a harmless read at the supplier, then stored encrypted and used for every later call to that supplier for this account (orders, invoices, live stock). A login the supplier refuses changes nothing (409 supplier_auth_failed). Without a login the supplier is still connected for stock, and api.needs_credentials stays true.

Called by
Account client
Scope
links:write

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Headers

  • Idempotency-Keystring

    A repeat within 24 hours returns the first response.

    at most 255 characters

Request body · application/json

  • api_credentialsApiCredentials

    Where the supplier offers API access: the business’s login there. Left out: any stored login is kept. Needs orders:write.

  • trade_account_numberstring | null

    Left out: kept as it is. Null or empty: cleared.

Responses

200The supplier as connected.Show
  • apiobject | nullrequired

    The supplier's API, when it offers one through Presslane Suppliers (ADR-011). Null: stock from feeds only, no login needed.

    Child attributes
    • connectionobject | nullrequired

      The account's stored login at the supplier; null until one is sent.

      Child attributes
      • last_checked_atstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

      • statusstringrequired

        One of unverified, verified, failed

    • credential_fieldsarray of CredentialFieldrequired

      What to ask the business for: its API login at the supplier.

      Child attributes
      • helpstring | nullrequired
      • keystringrequired

        The key to send in api_credentials.

        e.g. username

      • labelstringrequired

        What to call it when asking the business.

        e.g. Uneek API username

      • requiredbooleanrequired
      • typestringrequired

        password: secret; mask it when asking, and it is never shown back.

        One of text, password

    • featuresarray of stringrequired

      One of place_orders, order_history, invoices, live_stock

    • needs_credentialsbooleanrequired

      True while no working login is stored (none yet, or the supplier refused it): ask the business for one and send it as api_credentials.

    • order_modestringrequired

      test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

      One of off, test, live

  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • namestringrequired
  • needs_trade_accountbooleanrequired

    Stock is shown only once a trade account number is given.

  • slugstringrequired
  • supplier_archivedbooleanrequired
  • supplier_idstringrequired
  • trade_account_numberstring | nullrequired
  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X PUT 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"api_credentials":{"password":"secret","username":"standardprint-api"}}'
Response · 200
{
  "api": {
    "connection": {
      "last_checked_at": "2026-11-09T08:00:00Z",
      "status": "unverified"
    },
    "credential_fields": [
      {
        "help": "string",
        "key": "username",
        "label": "Uneek API username",
        "required": false,
        "type": "text"
      }
    ],
    "features": [
      "place_orders"
    ],
    "needs_credentials": false,
    "order_mode": "off"
  },
  "created_at": "2026-11-09T08:00:00Z",
  "name": "string",
  "needs_trade_account": false,
  "slug": "string",
  "supplier_archived": false,
  "supplier_id": "string",
  "trade_account_number": "string",
  "updated_at": "2026-11-09T08:00:00Z"
}
Try it in the sandbox

Remove a supplier from the account’s list

DEL/v1/account/suppliers/{supplier_id}
Called by
Account client
Scope
links:write

Path parameters

  • supplier_idstringrequired

Responses

204Removed.
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X DELETE 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}' \
  -H "Authorization: Bearer $TOKEN"
Try it in the sandbox

Suggest supplier variants for tenant variants

post/v1/matches

Up to 500 tenant variants. Ranked suggestions: exact GTIN (gtin, 1.0); supplier SKU, or style code with colour and size (strong, 0.85–0.95); name words with colour and size (weak, at most 0.6). Nothing is saved: confirm with PUT /v1/links.

Called by
Account client
Scope
links:write

Request body · application/json

  • limitinteger

    Suggestions per variant (default 5).

    ≥ 1 · ≤ 10

  • suppliersarray of string

    Supplier IDs to search. Default: the account's suppliers, else all.

  • variantsarray of objectrequired

    1–500 items

    Child attributes
    • brandstring | null
    • colourstring | null
    • external_refstringrequired
    • gtinstring | null
    • product_codestring | null
    • product_namestring | null
    • sizestring | null
    • skustring | null
    • supplier_codestring | null

      The tenant's code for this product at the supplier.

Responses

200Suggestions per variant.Show
  • dataarray of objectrequired
    Child attributes
    • external_refstringrequired
    • suggestionsarray of MatchSuggestionrequired
      Child attributes
      • brandstring | nullrequired
      • colourstring | nullrequired
      • confidencenumberrequired

        gtin 1.0; strong 0.85–0.95; weak at most 0.6.

      • gtinstring | nullrequired
      • match_methodstringrequired

        One of gtin, strong, weak

      • product_codestringrequired
      • product_idstringrequired
      • product_namestringrequired
      • sizestring | nullrequired
      • supplier_idstringrequired
      • supplier_skustringrequired
      • supplier_variant_idstringrequired
  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X POST 'https://suppliers.presslane.ai/v1/matches' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"variants":[{"external_ref":"string"}]}'
Response · 200
{
  "data": [
    {
      "external_ref": "string",
      "suggestions": [
        {
          "brand": "string",
          "colour": "string",
          "confidence": 1,
          "gtin": "string",
          "match_method": "gtin",
          "product_code": "string",
          "product_id": "string",
          "product_name": "string",
          "size": "string",
          "supplier_id": "string",
          "supplier_sku": "string",
          "supplier_variant_id": "string"
        }
      ]
    }
  ]
}
Try it in the sandbox