WISEPIM Open Data API GTIN API

openapi: 3.2.0
info:
  title: WISEPIM Open Data GTIN API
  version: 1.0.0
  summary: Free GTIN/EAN validation, HS code lookup and European marketplace fee data.
  description: 'A free, keyless reference API for product data: validate GTIN, EAN, UPC and ISBN barcodes and find the GS1 prefix origin, browse the EU Combined Nomenclature and US HTS customs tariffs, and read a sourced dataset of European marketplace seller fees (Amazon, eBay, bol, OTTO, Kaufland, Allegro and more).


    **Terms:** free for commercial and non-commercial use. Show a visible link with the text "Data by WISEPIM" wherever the data appears; every response carries the exact link in `attribution`. Limit: 120 requests a minute per IP; responses may be cached for an hour. Full terms: https://wisepim.com/developers/open-data#terms'
  termsOfService: https://wisepim.com/developers/open-data#terms
  contact:
    name: WISEPIM
    url: https://wisepim.com/developers/open-data
    email: support@wisepim.com
  x-logo:
    url: https://wisepim.com/wisepim-logo.png
servers:
- url: https://wisepim.com/api/open/v1
tags:
- name: GTIN
  description: Barcode validation and GS1 prefix lookup.
paths:
  /gtin/{code}:
    get:
      tags:
      - GTIN
      operationId: validateGtin
      summary: Validate one GTIN, EAN, UPC or ISBN-13
      description: 'Checks the length and GS1 check digit, detects the format and returns the GS1 prefix origin. An invalid code is still a 200 with `valid: false`.'
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          maxLength: 32
        example: '4006381333931'
      responses:
        '200':
          description: The validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GtinResult'
        '400':
          description: Code too long
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /gtin/check-digit/{digits}:
    get:
      tags:
      - GTIN
      operationId: gtinCheckDigit
      summary: Calculate the check digit and return the complete code
      parameters:
      - name: digits
        in: path
        required: true
        description: 7, 11, 12 or 13 digits without the check digit.
        schema:
          type: string
        example: '400638133393'
      responses:
        '200':
          description: The completed code, validated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GtinResult'
        '400':
          description: Wrong number of digits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /gtin:
    get:
      tags:
      - GTIN
      operationId: validateGtinBatch
      summary: Validate up to 100 codes
      parameters:
      - name: codes
        in: query
        required: true
        description: Comma-separated codes, at most 100.
        schema:
          type: string
        example: 4006381333931,036000291452
      responses:
        '200':
          description: One result per code, in order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GtinBatch'
        '400':
          description: Missing or too many codes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GtinBatch:
      type: object
      properties:
        count:
          type: integer
        valid:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/GtinResult'
        attribution:
          $ref: '#/components/schemas/Attribution'
    Attribution:
      type: object
      description: 'Credit to show wherever the data appears: a visible link with the text "Data by WISEPIM" to `url`.'
      required:
      - required
      - text
      - url
      - html
      - markdown
      - terms
      properties:
        required:
          type: boolean
          const: true
        text:
          type: string
          example: Data by WISEPIM
        url:
          type: string
          format: uri
          example: https://wisepim.com/hs-codes/8471
        html:
          type: string
          example: <a href="https://wisepim.com/hs-codes/8471">Data by WISEPIM</a>
        markdown:
          type: string
          example: '[Data by WISEPIM](https://wisepim.com/hs-codes/8471)'
        terms:
          type: string
          format: uri
    GtinResult:
      type: object
      required:
      - input
      - valid
      - format
      - checkDigit
      - expectedCheckDigit
      - gtin14
      - gs1Prefix
      - error
      properties:
        input:
          type: string
        valid:
          type: boolean
        format:
          type:
          - string
          - 'null'
          enum:
          - EAN-13
          - EAN-8
          - UPC-A
          - ISBN-13
          - GTIN-14
          - null
        checkDigit:
          type:
          - integer
          - 'null'
        expectedCheckDigit:
          type:
          - integer
          - 'null'
        gtin14:
          type:
          - string
          - 'null'
          description: The code zero-padded to 14 digits, when valid.
        gs1Prefix:
          type:
          - object
          - 'null'
          properties:
            prefix:
              type: string
              example: '400'
            name:
              type: string
              example: Germany
            kind:
              type: string
              enum:
              - country
              - organization
              - unassigned
            regions:
              type: array
              items:
                type: string
              description: ISO 3166-1 alpha-2 codes.
        error:
          type:
          - object
          - 'null'
          properties:
            code:
              type: string
              enum:
              - empty
              - nonDigit
              - length
              - checkDigit
            message:
              type: string
        attribution:
          $ref: '#/components/schemas/Attribution'
    Error:
      type: object
      required:
      - error
      - docs
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              enum:
              - invalid_request
              - not_found
              - method_not_allowed
              - rate_limited
              - unavailable
            message:
              type: string
        docs:
          type: string
          format: uri
externalDocs:
  description: Documentation and examples
  url: https://wisepim.com/developers/open-data