Skip to content
Sections

API reference

Catalogue

The supplier directory and its products and variants: every colour and size, with the supplier’s codes, barcodes and list prices.

Search products

get/v1/products

By supplier, brand, manufacturer style code, text and updated-since.

Called by
Account client
Scope
catalogue:read

Query parameters

  • limitinteger

    Page size, 1–200 (default 50).

    ≥ 1 · ≤ 200

  • starting_afterstring

    The next_cursor from the previous page.

    at most 80 characters

  • supplierstring

    Supplier ID or slug.

    at most 100 characters

  • brandstring

    at most 100 characters

  • manufacturer_codestring

    at most 100 characters

  • qstring

    Words to find in name, brand, product code or style code.

    at most 200 characters

  • updated_sincestring (date-time)

    matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Responses

200A page of products.Show
  • dataarray of ProductSummaryrequired
    Child attributes
    • brandstring | nullrequired
    • categorystring | nullrequired
    • idstringrequired
    • image_urlstring | nullrequired
    • manufacturer_codestring | nullrequired

      The manufacturer's style code.

    • namestringrequired
    • product_codestringrequired
    • statusstringrequired

      One of active, discontinued

    • supplierSupplierRefrequired
      Child attributes
      • idstringrequired

        e.g. sup_01jd7p…

      • slugstringrequired

        e.g. example-wholesale

    • updated_atstring (date-time)required

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

    • variant_countintegerrequired
  • has_morebooleanrequired
  • next_cursorstring | nullrequired

    Pass as starting_after for the next page.

  • 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/products' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "brand": "string",
      "category": "string",
      "id": "string",
      "image_url": "string",
      "manufacturer_code": "string",
      "name": "string",
      "product_code": "string",
      "status": "active",
      "supplier": {
        "id": "sup_01jd7p…",
        "slug": "example-wholesale"
      },
      "updated_at": "2026-11-09T08:00:00Z",
      "variant_count": 1
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}
Try it in the sandbox

Get a product with its variants

get/v1/products/{id}
Called by
Account client
Scope
catalogue:read

Path parameters

  • idstringrequired

    at most 100 characters

Responses

200The product and every variant.Show
  • brandstring | nullrequired
  • categorystring | nullrequired
  • idstringrequired
  • image_urlstring | nullrequired
  • manufacturer_codestring | nullrequired

    The manufacturer's style code.

  • namestringrequired
  • product_codestringrequired
  • statusstringrequired

    One of active, discontinued

  • supplierSupplierRefrequired
    Child attributes
    • idstringrequired

      e.g. sup_01jd7p…

    • slugstringrequired

      e.g. example-wholesale

  • updated_atstring (date-time)required

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

  • variant_countintegerrequired
  • variantsarray of Variantrequired
    Child attributes
    • colourstring | nullrequired
    • colour_codestring | nullrequired
    • gtinstring | nullrequired
    • idstringrequired
    • in_feedbooleanrequired

      False when the last full catalogue load did not include it.

    • lead_time_daysinteger | nullrequired
    • list_priceMoney | nullrequired
      Child attributes
      • amount_minorintegerrequired
      • currencystringrequired
    • manufacturer_skustring | nullrequired
    • optionsmap of stringrequired
    • pack_sizeintegerrequired
    • product_codestringrequired
    • product_idstringrequired
    • sizestring | nullrequired
    • size_codestring | nullrequired
    • statusstringrequired

      One of active, discontinued

    • supplierSupplierRefrequired
      Child attributes
      • idstringrequired

        e.g. sup_01jd7p…

      • slugstringrequired

        e.g. example-wholesale

    • supplier_skustringrequired
    • 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).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/products/{id}' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "brand": "string",
  "category": "string",
  "id": "string",
  "image_url": "string",
  "manufacturer_code": "string",
  "name": "string",
  "product_code": "string",
  "status": "active",
  "supplier": {
    "id": "sup_01jd7p…",
    "slug": "example-wholesale"
  },
  "updated_at": "2026-11-09T08:00:00Z",
  "variant_count": 1,
  "variants": [
    {
      "colour": "string",
      "colour_code": "string",
      "gtin": "string",
      "id": "string",
      "in_feed": false,
      "lead_time_days": 1,
      "list_price": {
        "amount_minor": 1,
        "currency": "string"
      },
      "manufacturer_sku": "string",
      "options": {},
      "pack_size": 1,
      "product_code": "string",
      "product_id": "string",
      "size": "string",
      "size_code": "string",
      "status": "active",
      "supplier": {
        "id": "sup_01jd7p…",
        "slug": "example-wholesale"
      },
      "supplier_sku": "string",
      "updated_at": "2026-11-09T08:00:00Z"
    }
  ]
}
Try it in the sandbox

List suppliers

get/v1/suppliers

Active and paused suppliers that have completed a first import, with last sync and stale flag.

Called by
Account client
Scope
catalogue:read

Query parameters

  • limitinteger

    Page size, 1–200 (default 50).

    ≥ 1 · ≤ 200

  • starting_afterstring

    The next_cursor from the previous page.

    at most 80 characters

Responses

200A page of suppliers.Show
  • dataarray of Supplierrequired
    Child attributes
    • account_opening_urlstring | nullrequired

      Where a business applies for a trade account.

    • api_credential_fieldsarray of CredentialFieldrequired

      The API login to ask the business for when it connects this supplier (sent as api_credentials). Empty: no login needed.

      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

    • api_featuresarray of stringrequired

      What the supplier's API offers with the account's own login (ADR-011). Empty: stock from feeds only.

      One of place_orders, order_history, invoices, live_stock

    • countrystringrequired
    • currencystringrequired
    • default_lead_time_daysinteger | nullrequired
    • idstringrequired
    • last_sync_atstring (date-time) | nullrequired

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

    • locationsarray of Locationrequired
      Child attributes
      • codestringrequired

        e.g. MAIN

      • countrystringrequired
      • is_defaultbooleanrequired
      • namestringrequired
    • logo_urlstring | nullrequired
    • low_stock_thresholdintegerrequired
    • namestringrequired
    • needs_trade_accountbooleanrequired

      Stock is shown only to accounts that recorded a trade account number with this supplier.

    • slugstringrequired
    • stalebooleanrequired

      No successful import within the stale-after age.

    • stale_after_hoursintegerrequired
    • statusstringrequired

      Paused suppliers keep their data but stop syncing.

      One of active, paused

    • websitestring | nullrequired
  • has_morebooleanrequired
  • next_cursorstring | nullrequired

    Pass as starting_after for the next page.

  • 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/suppliers' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "account_opening_url": "string",
      "api_credential_fields": [
        {
          "help": "string",
          "key": "username",
          "label": "Uneek API username",
          "required": false,
          "type": "text"
        }
      ],
      "api_features": [
        "place_orders"
      ],
      "country": "string",
      "currency": "string",
      "default_lead_time_days": 1,
      "id": "string",
      "last_sync_at": "2026-11-09T08:00:00Z",
      "locations": [
        {
          "code": "MAIN",
          "country": "string",
          "is_default": false,
          "name": "string"
        }
      ],
      "logo_url": "string",
      "low_stock_threshold": 1,
      "name": "string",
      "needs_trade_account": false,
      "slug": "string",
      "stale": false,
      "stale_after_hours": 1,
      "status": "active",
      "website": "string"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}
Try it in the sandbox

Get a supplier

get/v1/suppliers/{id}

One supplier by ID or slug, with its locations.

Called by
Account client
Scope
catalogue:read

Path parameters

  • idstringrequired

    Supplier ID or slug.

    at most 100 characters

Responses

200The supplier.Show
  • account_opening_urlstring | nullrequired

    Where a business applies for a trade account.

  • api_credential_fieldsarray of CredentialFieldrequired

    The API login to ask the business for when it connects this supplier (sent as api_credentials). Empty: no login needed.

    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

  • api_featuresarray of stringrequired

    What the supplier's API offers with the account's own login (ADR-011). Empty: stock from feeds only.

    One of place_orders, order_history, invoices, live_stock

  • countrystringrequired
  • currencystringrequired
  • default_lead_time_daysinteger | nullrequired
  • idstringrequired
  • last_sync_atstring (date-time) | nullrequired

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

  • locationsarray of Locationrequired
    Child attributes
    • codestringrequired

      e.g. MAIN

    • countrystringrequired
    • is_defaultbooleanrequired
    • namestringrequired
  • logo_urlstring | nullrequired
  • low_stock_thresholdintegerrequired
  • namestringrequired
  • needs_trade_accountbooleanrequired

    Stock is shown only to accounts that recorded a trade account number with this supplier.

  • slugstringrequired
  • stalebooleanrequired

    No successful import within the stale-after age.

  • stale_after_hoursintegerrequired
  • statusstringrequired

    Paused suppliers keep their data but stop syncing.

    One of active, paused

  • websitestring | nullrequired
  • 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).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/suppliers/{id}' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "account_opening_url": "string",
  "api_credential_fields": [
    {
      "help": "string",
      "key": "username",
      "label": "Uneek API username",
      "required": false,
      "type": "text"
    }
  ],
  "api_features": [
    "place_orders"
  ],
  "country": "string",
  "currency": "string",
  "default_lead_time_days": 1,
  "id": "string",
  "last_sync_at": "2026-11-09T08:00:00Z",
  "locations": [
    {
      "code": "MAIN",
      "country": "string",
      "is_default": false,
      "name": "string"
    }
  ],
  "logo_url": "string",
  "low_stock_threshold": 1,
  "name": "string",
  "needs_trade_account": false,
  "slug": "string",
  "stale": false,
  "stale_after_hours": 1,
  "status": "active",
  "website": "string"
}
Try it in the sandbox

Look up variants

get/v1/variants

By supplier and supplier SKU, by GTIN, or by manufacturer SKU.

Called by
Account client
Scope
catalogue:read

Query parameters

  • limitinteger

    Page size, 1–200 (default 50).

    ≥ 1 · ≤ 200

  • starting_afterstring

    The next_cursor from the previous page.

    at most 80 characters

  • supplierstring

    Supplier ID or slug; needed with supplier_sku.

    at most 100 characters

  • supplier_skustring

    at most 100 characters

  • gtinstring

    matches ^\d{8,14}$

  • manufacturer_skustring

    at most 100 characters

Responses

200Matching variants.Show
  • dataarray of Variantrequired
    Child attributes
    • colourstring | nullrequired
    • colour_codestring | nullrequired
    • gtinstring | nullrequired
    • idstringrequired
    • in_feedbooleanrequired

      False when the last full catalogue load did not include it.

    • lead_time_daysinteger | nullrequired
    • list_priceMoney | nullrequired
      Child attributes
      • amount_minorintegerrequired
      • currencystringrequired
    • manufacturer_skustring | nullrequired
    • optionsmap of stringrequired
    • pack_sizeintegerrequired
    • product_codestringrequired
    • product_idstringrequired
    • sizestring | nullrequired
    • size_codestring | nullrequired
    • statusstringrequired

      One of active, discontinued

    • supplierSupplierRefrequired
      Child attributes
      • idstringrequired

        e.g. sup_01jd7p…

      • slugstringrequired

        e.g. example-wholesale

    • supplier_skustringrequired
    • updated_atstring (date-time)required

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

  • has_morebooleanrequired
  • next_cursorstring | nullrequired

    Pass as starting_after for the next page.

  • 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/variants' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "colour": "string",
      "colour_code": "string",
      "gtin": "string",
      "id": "string",
      "in_feed": false,
      "lead_time_days": 1,
      "list_price": {
        "amount_minor": 1,
        "currency": "string"
      },
      "manufacturer_sku": "string",
      "options": {},
      "pack_size": 1,
      "product_code": "string",
      "product_id": "string",
      "size": "string",
      "size_code": "string",
      "status": "active",
      "supplier": {
        "id": "sup_01jd7p…",
        "slug": "example-wholesale"
      },
      "supplier_sku": "string",
      "updated_at": "2026-11-09T08:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}
Try it in the sandbox