Zalando Discovery API API

The Discovery API API from Zalando — 1 operation(s) for discovery api.

OpenAPI Specification

zalando-discovery-api-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: Article Requirements AnnouncedReturns Discovery API API
  version: 1.0.0
  x-audience: external-merchant
  x-api-id: e655a9cb-4cda-466d-a552-13a50c4b02ae
  description: 'This API provides endpoints to retrieve UAF article requirement outlines, attribute types, and attribute values for a given business partner. This API is in pilot phase and only available to a limited set of partners.

    '
tags:
- name: Discovery API
paths:
  /products/identifiers/{ean}:
    get:
      summary: 'Look up the existing product details in Zalando platform

        '
      tags:
      - Discovery API
      security:
      - OAuth2:
        - lemur.prototype.read
      parameters:
      - $ref: '#/components/parameters/ean'
      responses:
        '200':
          $ref: '#/components/responses/LookUpResponse'
        '409':
          $ref: '#/components/responses/ConflictError'
        default:
          $ref: '#/components/responses/GenericError'
components:
  schemas:
    LookUp:
      properties:
        items:
          type: array
          items:
            properties:
              ean:
                $ref: '#/components/schemas/EAN'
      example:
        items:
        - ean: '9780679762881'
    Problem:
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          default: about:blank
        title:
          type: string
          description: 'A short, summary of the problem type. Written in English and readable

            for engineers (usually not suited for non technical stakeholders and

            not localized);

            '
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          minimum: 100
          maximum: 600
          exclusiveMaximum: true
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.

            '
        instance:
          type: string
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
      example:
        type: https://zalando.github.io/problem/constraint-violation
        title: Service Unavailable
        status: 503
        detail: Connection to database timed out
    EAN:
      description: The International Article Number or also known as European Article Number.
      type: string
      format: gtin13
      example: '9780679762881'
  responses:
    LookUpResponse:
      description: 'Successfully looked up product detail information

        '
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/LookUp'
    GenericError:
      description: Error occurred - see status code and problem object for more information.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ConflictError:
      description: The request is semantically correct, but it cannot be processed due to business reasons. e.g. A product with same id was already submitted. Please refer to the response.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  parameters:
    ean:
      name: ean
      in: path
      description: The International Article Number or also known as European Article Number.
      required: true
      schema:
        $ref: '#/components/schemas/EAN'