Skip to content

Requests

Creating a basic order with a the set of default workflow (including valid statuses)

sh
POST /request/orders
{
  # organization-owned
  owner: { organization: <org.id> },
  # who the request is for
  requestedForType: 'medical-patient',
  requestedFor: <px.id>,
  # items requested
  items: [{
    name: 'Request Item 1',
    # optional. defaults to 1
    quantity: 1,
  }],
}
POST /request/orders
{
  # organization-owned
  owner: { organization: <org.id> },
  # who the request is for
  requestedForType: 'medical-patient',
  requestedFor: <px.id>,
  # items requested
  items: [{
    name: 'Request Item 1',
    # optional. defaults to 1
    quantity: 1,
  }],
}

Creating an order w/ items referenced from other services

sh
POST /request/orders
{
  owner: { organization: <org.id> },
  requestedForType: 'medical-patient',
  requestedFor: <px.id>,
  # items w/ reference (name will be populated from the referenced doc)
  items: [{
    refType: 'inventory-variant',
    ref: <variant.sku>,
  }],
}
POST /request/orders
{
  owner: { organization: <org.id> },
  requestedForType: 'medical-patient',
  requestedFor: <px.id>,
  # items w/ reference (name will be populated from the referenced doc)
  items: [{
    refType: 'inventory-variant',
    ref: <variant.sku>,
  }],
}

Changing the status

sh
PATCH /request/orders/:id
{
  changeStatus: 'preparing'
}
PATCH /request/orders/:id
{
  changeStatus: 'preparing'
}

Marking an item as confirmed

sh
PATCH /request/orders/:id
{
  confirmItem: <OrderItem.id>
}
PATCH /request/orders/:id
{
  confirmItem: <OrderItem.id>
}

Released under the MIT License.