Fulfillment.yaml

description: Describes how a an order will be rendered/fulfilled to the end-customer
type: object
properties:
  id:
    description: Unique reference ID to the fulfillment of an order
    type: string
  type:
    description: A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.
    type: string
  rateable:
    description: Whether the fulfillment can be rated or not
    type: boolean
  rating:
    description: The rating value of the fulfullment service.
    allOf:
      - $ref: "./Rating.yaml#/properties/value"
  state:
    description: The current state of fulfillment. The BPP must set this value whenever the state of the order fulfillment changes and fire an unsolicited `on_status` call.
    allOf: 
      - $ref: "./FulfillmentState.yaml"
  tracking:
    type: boolean
    description: Indicates whether the fulfillment allows tracking
    default: false
  customer:
    description: The person that will ultimately receive the order
    allOf:
      - $ref: "./Customer.yaml"
  agent:
    description: The agent that is currently handling the fulfillment of the order
    allOf:
      - $ref: "./Agent.yaml"
  contact:
    $ref: "./Contact.yaml"
  vehicle:
    $ref: "./Vehicle.yaml"
  stops:
    description: The list of logical stops encountered during the fulfillment of an order. 
    type: array
    items:
      $ref: "./Stop.yaml"
  path:
    description: The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.
    type: string
  tags:
    type: array
    items:
      $ref: "./TagGroup.yaml"