SAP Sales and Distribution (SD) SAP Customer Returns Delivery API — Returns Delivery Header

naftiko: 1.0.0-alpha2
info:
  label: SAP Sales and Distribution (SD) SAP Customer Returns Delivery API — Returns Delivery Header
  description: 'SAP Sales and Distribution (SD) SAP Customer Returns Delivery API — Returns Delivery Header. 4 operations.
    Lead operation: Retrieve a list of customer returns deliveries. Self-contained Naftiko capability covering one Sap Sales
    And Distribution Sd business surface.'
  tags:
  - Sap Sales And Distribution Sd
  - Returns Delivery Header
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_SALES_AND_DISTRIBUTION_SD_API_KEY: SAP_SALES_AND_DISTRIBUTION_SD_API_KEY
capability:
  consumes:
  - type: http
    namespace: sap-sd-customer-returns-delivery-returns-delivery-header
    baseUri: https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_CUSTOMER_RETURN_DELIVERY_SRV_0002
    description: SAP Sales and Distribution (SD) SAP Customer Returns Delivery API — Returns Delivery Header business capability.
      Self-contained, no shared references.
    resources:
    - name: A_ReturnsDeliveryHeader
      path: /A_ReturnsDeliveryHeader
      operations:
      - name: listreturnsdeliveries
        method: GET
        description: Retrieve a list of customer returns deliveries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: A_ReturnsDeliveryHeader('{DeliveryDocument}')
      path: /A_ReturnsDeliveryHeader('{DeliveryDocument}')
      operations:
      - name: getreturnsdelivery
        method: GET
        description: Retrieve a single returns delivery
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: DeliveryDocument
          in: path
          type: string
          description: Delivery document number (10 characters)
          required: true
      - name: updatereturnsdelivery
        method: PATCH
        description: Update a returns delivery
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: DeliveryDocument
          in: path
          type: string
          description: Delivery document number
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: PostGoodsReceipt
      path: /PostGoodsReceipt
      operations:
      - name: postgoodsreceipt
        method: POST
        description: Post goods receipt for a returns delivery
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: DeliveryDocument
          in: query
          type: string
          description: Delivery document number
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_SALES_AND_DISTRIBUTION_SD_API_KEY}}'
  exposes:
  - type: rest
    namespace: sap-sd-customer-returns-delivery-returns-delivery-header-rest
    port: 8080
    description: REST adapter for SAP Sales and Distribution (SD) SAP Customer Returns Delivery API — Returns Delivery Header.
      One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/a-returnsdeliveryheader
      name: a-returnsdeliveryheader
      description: REST surface for A_ReturnsDeliveryHeader.
      operations:
      - method: GET
        name: listreturnsdeliveries
        description: Retrieve a list of customer returns deliveries
        call: sap-sd-customer-returns-delivery-returns-delivery-header.listreturnsdeliveries
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/a-returnsdeliveryheader-deliverydocument
      name: a-returnsdeliveryheader-deliverydocument
      description: REST surface for A_ReturnsDeliveryHeader('{DeliveryDocument}').
      operations:
      - method: GET
        name: getreturnsdelivery
        description: Retrieve a single returns delivery
        call: sap-sd-customer-returns-delivery-returns-delivery-header.getreturnsdelivery
        with:
          DeliveryDocument: rest.DeliveryDocument
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatereturnsdelivery
        description: Update a returns delivery
        call: sap-sd-customer-returns-delivery-returns-delivery-header.updatereturnsdelivery
        with:
          DeliveryDocument: rest.DeliveryDocument
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/postgoodsreceipt
      name: postgoodsreceipt
      description: REST surface for PostGoodsReceipt.
      operations:
      - method: POST
        name: postgoodsreceipt
        description: Post goods receipt for a returns delivery
        call: sap-sd-customer-returns-delivery-returns-delivery-header.postgoodsreceipt
        with:
          DeliveryDocument: rest.DeliveryDocument
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sap-sd-customer-returns-delivery-returns-delivery-header-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Sales and Distribution (SD) SAP Customer Returns Delivery API — Returns Delivery Header.
      One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: retrieve-list-customer-returns-deliveries
      description: Retrieve a list of customer returns deliveries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-sd-customer-returns-delivery-returns-delivery-header.listreturnsdeliveries
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-returns-delivery
      description: Retrieve a single returns delivery
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-sd-customer-returns-delivery-returns-delivery-header.getreturnsdelivery
      with:
        DeliveryDocument: tools.DeliveryDocument
      outputParameters:
      - type: object
        mapping: $.
    - name: update-returns-delivery
      description: Update a returns delivery
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sap-sd-customer-returns-delivery-returns-delivery-header.updatereturnsdelivery
      with:
        DeliveryDocument: tools.DeliveryDocument
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: post-goods-receipt-returns-delivery
      description: Post goods receipt for a returns delivery
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-sd-customer-returns-delivery-returns-delivery-header.postgoodsreceipt
      with:
        DeliveryDocument: tools.DeliveryDocument
      outputParameters:
      - type: object
        mapping: $.