openapi: 3.1.1
info:
  title: HyperlocalDelivery
  version: 2.0.0
  description: 'A Beckn domain schema for hyperlocal (same-city, typically sub-2-hour)
    physical delivery

    of goods or prepared food from an origin to a destination within a short radius.


    HyperlocalDelivery is a concrete, domain-specific fulfillmentAttributes value
    for a

    beckn:Fulfillment entry. It is fully aligned with schema:ParcelDelivery.


    schema.org alignment: schema:ParcelDelivery (subtype of schema:Intangible)

    Use in: beckn:Fulfillment.fulfillmentAttributes

    '
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    HyperlocalDelivery:
      x-iri: https://schema.nfh.global/HyperlocalDelivery/v2.0
      description: 'A Beckn domain schema for hyperlocal (same-city, typically sub-2-hour)
        physical delivery

        of goods or prepared food from an origin to a destination within a short radius.


        HyperlocalDelivery is a concrete, domain-specific fulfillmentAttributes value
        for a

        beckn:Fulfillment entry. It is fully aligned with schema:ParcelDelivery.


        schema.org alignment: schema:ParcelDelivery (subtype of schema:Intangible)

        Use in: beckn:Fulfillment.fulfillmentAttributes

        '
      title: HyperlocalDelivery
      x-tags:
      - retail
      - logistics
      - fulfillment
      type: object
      properties:
        pickupLocation:
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
          description: 'The pickup/origin location (restaurant, warehouse, dark store).
            Corresponds to schema:originAddress on schema:ParcelDelivery.

            '
          x-jsonld:
            '@id': schema:originAddress
        deliveryLocation:
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
          description: 'The delivery destination (consumer''s address). Corresponds
            to schema:deliveryAddress on schema:ParcelDelivery.

            '
          x-jsonld:
            '@id': schema:deliveryAddress
        itemsShipped:
          type: array
          description: 'The items shipped in this delivery. Corresponds to schema:itemShipped
            on schema:ParcelDelivery.

            '
          items:
            $ref: https://schema.nfh.global/Attributes/v2.0/attributes.yaml#/components/schemas/Attributes
          x-jsonld:
            '@id': schema:itemShipped
        agent:
          $ref: https://schema.nfh.global/Attributes/v2.0/attributes.yaml#/components/schemas/Attributes
          description: 'The delivery agent (rider) carrying out this delivery. Corresponds
            to schema:carrier on schema:ParcelDelivery.

            '
          x-jsonld:
            '@id': schema:carrier
        trackingUrl:
          type: string
          format: uri
          description: 'Live real-time tracking URL for the rider''s location during
            delivery. Corresponds to schema:trackingUrl on schema:ParcelDelivery.

            '
          x-jsonld:
            '@id': schema:trackingUrl
        expectedArrivalFrom:
          type: string
          format: date-time
          description: Earliest expected delivery time (ISO 8601). Maps to schema:expectedArrivalFrom.
          x-jsonld:
            '@id': schema:expectedArrivalFrom
        expectedArrivalUntil:
          type: string
          format: date-time
          description: Latest expected delivery time (ISO 8601). Maps to schema:expectedArrivalUntil.
          x-jsonld:
            '@id': schema:expectedArrivalUntil
      required: []
      additionalProperties: false