Zalando Reports API

openapi: 3.2.0
info:
  version: 4.2.0
  x-api-id: cc2c30ca-2969-403e-87b1-e27df78ed655
  x-audience: external-partner
  title: zDirect Platform ZFS Stock Movements Reports API
  description: The Stock Movements API is a service offered by Zalando Fulfillment Solutions (ZFS).
servers:
- url: api.merchants.zalando.com/zfs/stock-movements
  description: Production instance
- url: api-sandbox.merchants.zalando.com/zfs/stock-movements
  description: Sandbox instance for merchant center
tags:
- name: Reports
paths:
  /reports/received-items/{merchant-id}:
    get:
      summary: Retrieve inbounded items
      description: Returns all items inbounded at Zalando warehouses for specific `merchant-id` and `zalando_advice_ids`. Endpoint has no 100 days time limitation, but to not overload the client, it provides cursor based pagination. The cursor is a string that is returned in the response and can be used to fetch the next page of results. Please note that if `from` and `to` parameters are not provided the API will return the data for the last 100 days.
      security:
      - BearerAuth:
        - partner-inbound-tracker.received.read
      parameters:
      - in: path
        name: merchant-id
        schema:
          type: string
          format: uuid
        example: 29809185-6a98-4691-a15b-e8d16839b6e8
        description: Merchant ID
        required: true
      - in: query
        name: zalando_advice_ids
        schema:
          type: array
          items:
            $ref: '#/components/schemas/AdviceId'
        description: Zalando advice ids to filter inbounded items by. Returns items for all advice ids if not provided.
        required: false
      - in: query
        name: from
        schema:
          $ref: '#/components/schemas/DateTime'
        description: Start timestamp. Default is now minus 100 days.
        required: false
      - in: query
        name: to
        schema:
          $ref: '#/components/schemas/DateTime'
        description: End timestamp. Default is now.
        required: false
      - in: query
        name: cursor
        schema:
          type: string
        description: Cursor to paginate through results
        example: MjAxNy0wNy0yMVQxNzozMjoyOFoK
        required: false
      - in: query
        name: limit
        schema:
          type: string
          default: 100000
        description: Number of inbounded items to fetch per page. Maximum is 200000.
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundedItemsResponse'
        default:
          description: A specific error occurred - see status code for more information.
          content:
            application/problem+json:
              schema:
                $ref: https://opensource.zalando.com/restful-api-guidelines/problem-1.0.1.yaml#/Problem
      tags:
      - Reports
      operationId: getReportsReceivedItemsByMerchantId
      x-operation-id-source: derived
components:
  schemas:
    AdviceId:
      type: string
      pattern: ^[0-9]{8}$
      example: 99200001
    Ean13:
      type: string
      format: ean
      pattern: ^[0-9]{13}$
      maxLength: 13
      description: A 13-digit EAN
      example: 0191476239145
    InboundedItem:
      type: object
      description: Inbounded Item
      properties:
        zalando_advice_id:
          allOf:
          - $ref: '#/components/schemas/AdviceId'
          description: The ID of the advice the item belongs to.
        ean:
          $ref: '#/components/schemas/Ean13'
        quality_label:
          type: string
          description: A unique identifier per EAN per item.
          example: 00014D02W8V
        merchant_article_id:
          type: string
          description: A merchant specified article id if provided. E.g. UPOS-8
        merchant_item_id:
          type: string
          description: A merchant specified item id if provided. E.g. UPOS-15
        merchant_b2b_reference:
          type: string
          description: A merchant specific optional reference id or information for the advice (for example a merchant's order name or number)
          example: reference
        location_id:
          type: string
          format: uuid
          description: Location ID of the warehouse that inbounded the item.
          example: 29809185-6a98-4691-a15b-e8d16839b6e8
        received_timestamp:
          allOf:
          - $ref: '#/components/schemas/DateTime'
          description: Timestamp when actual inbound has happened.
      required:
      - zalando_advice_id
      - ean
      - quality_label
      - location_id
      - received_timestamp
    InboundedItemsResponse:
      type: object
      properties:
        received_items:
          type: array
          items:
            $ref: '#/components/schemas/InboundedItem'
        next:
          type: string
          description: Cursor reference. Used to fetch the next page of results.
          example: MjAxNy0wNy0yMVQxNzozMjoyOFoK
    DateTime:
      type: string
      format: date-time
      description: Date time
      example: '2017-07-21T17:32:28Z'
  securitySchemes:
    merchant_platform:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api-sandbox.merchants.zalando.com/auth/token
          scopes:
            zfs/received-item/read: Access to ZFS received items of a merchant.
            zfs/returned-item/read: Access to ZFS returned items of a merchant.