Precoro Suppliers API

openapi: 3.2.0
info:
  title: Precoro Suppliers API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 15 operation(s) read from 6 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Precoro has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 15
    pages-with-code: 0
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://help.precoro.com/external-integrations-with-api
  - https://help.precoro.com/using-api-in-precoro
  - https://help.precoro.com/typical-api-usage-scenarios
  - https://help.precoro.com/how-to-set-up-and-use-webhooks
  - https://help.precoro.com/how-to-set-up-and-use-webhooks?hsLang=en
  - https://help.precoro.com/using-api-in-precoro?hsLang=en
servers:
- url: https://api.precoro.com
tags:
- name: Suppliers
paths:
  /suppliers:
    get:
      operationId: get_suppliers
      tags:
      - Suppliers
      summary: Retrieve suppliers, optionally filtered by external_id[]
      description: GET https://api.precoro.com/suppliers returns supplier records; can include external_id[] query parameter.
      x-source: https://help.precoro.com/external-integrations-with-api
      parameters:
      - name: external_id[]
        in: query
        required: false
        schema:
          type: array
        description: One or more external IDs to filter the suppliers returned (max 200).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /suppliers/{id}:
    patch:
      operationId: patch_suppliers_id
      tags:
      - Suppliers
      summary: Update the externalId field for an existing supplier record
      description: Send a PATCH request to https://api.precoro.com/suppliers/{id} with a JSON body containing the externalId field.
      x-source: https://help.precoro.com/external-integrations-with-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchSuppliersIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_suppliers_id
      tags:
      - Suppliers
      summary: Replace a supplier record with new data after comparing external IDs
      description: PUT https://api.precoro.com/suppliers/{id} updates the supplier when differences are detected.
      x-source: https://help.precoro.com/external-integrations-with-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutSuppliersIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PutSuppliersIdRequest:
      type: object
      properties:
        externalId:
          type: string
          description: External ID to associate with the supplier (optional).
        other supplier fields:
          type: object
          description: Any supplier attributes to be updated.
    PatchSuppliersIdRequest:
      type: object
      properties:
        externalId:
          type: string
          description: The new ExternalID value to set on the supplier
      required:
      - externalId