Skip to main content
API docs by Redocly

Inventory Management (3.0.0)

Supplier

Access and Manage Suppliers

Retrieve Suppliers

Retrieve a list of Suppliers

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (Supplier)
Array
supplier-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "supplier-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Centaur"
      }
    ]
}

Retrieve Supplier

Retrieve a single supplier

path Parameters
supplier-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
supplier-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "supplier-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "name": "Centaur"
}

Import and update supplier price data

Import and update supplier price data

path Parameters
supplier-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
Array of objects (SupplierProduct)
Array
supplier-sku
string <= 50 characters
description
string <= 255 characters
cost
number

Cost of product

group-item
string <= 50 characters
size
string <= 50 characters

Responses

Response Schema: application/json
job-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "supplier-products": [
    • {
      • "supplier-sku": "1234567890",
      • "description": "200mg of medicine",
      • "cost": 37.55,
      • "group-item": "Group-item of product",
      • "size": "Size of medicine"
      }
    ]
}

Response samples

Content type
application/json
{
  • "job-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
}

Retrieve the import price data job status

Retrieve the import price data job status

path Parameters
job-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
status
string
start-date
string <date-time>
end-date
string <date-time>

Response samples

Content type
application/json
{
  • "status": "Requested",
  • "start-date": "2020-09-07T15:50:00.00Z",
  • "end-date": "2020-09-07T15:50:00.00Z"
}

Product Batch

Access and Manage batch data on inventory

Retrieve Batches

Retrieve a list of Batches

query Parameters
required
object (Pageable)

Pageable parameters

batch-number
string
Example: batch-number=A067B01
formulary-uuid
string <uuid>
Example: formulary-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
location-space-uuid
string <uuid>
Example: location-space-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
in-stock
boolean
Default: "true"
Example: in-stock=true

Restricts to items that have stock

include-expired
boolean
Default: "false"

Includes batch numbers with expired batch dates

modified-start
string <date-time>
Example: modified-start=2021-06-01T00:00:00.00Z
modified-end
string <date-time>
Example: modified-end=2021-07-01T00:00:00.00Z
location-uuid
string <uuid>
Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
Array of objects (Batch)
Array
batch-uuid
string <uuid>
location-space-uuid
string <uuid>
formulary-uuid
string <uuid>
batch-number
string
expiry-date
string <date>

No time element

in-stock
boolean
stock-level
number
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "batch-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "location-space-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "batch-number": "A067B01",
      • "expiry-date": "2021-11-05T15:50:00.00Z",
      • "in-stock": true,
      • "stock-level": 10.555,
      • "modified": "2020-09-07T15:50:00.00Z"
      }
    ]
}

Retrieve Batch

Retrieve a single Batch

path Parameters
batch-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
batch-uuid
string <uuid>
location-space-uuid
string <uuid>
formulary-uuid
string <uuid>
batch-number
string
expiry-date
string <date>

No time element

in-stock
boolean
stock-level
number
modified
string <date-time>

Response samples

Content type
application/json
{
  • "batch-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "location-space-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "batch-number": "A067B01",
  • "expiry-date": "2021-11-05T15:50:00.00Z",
  • "in-stock": true,
  • "stock-level": 10.555,
  • "modified": "2020-09-07T15:50:00.00Z"
}

Manufacturer

Access and Manage Manufacturers

Retrieve manufacturers

Retrieve a list of manufacturer objects

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (Manufacturer)
Array
manufacturer-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "manufacturer-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
      • "name": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF"
      }
    ]
}

Retrieve a manufacturer

Retrieve a manufacturer object by uuid

path Parameters
manufacturer-uuid
required
string <uuid>
Example: C668A5B0-0471-4AD5-B222-71B38A94F4C2

Responses

Response Schema: application/json
manufacturer-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "manufacturer-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
  • "name": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF"
}

Level

Access and Manage Levels

Retrieve Levels

Retrieve a list of Levels

query Parameters
required
object (Pageable)

Pageable parameters

formulary-uuid
string <uuid>
Example: formulary-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
location-uuid
string <uuid>
Example: location-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
location-space-uuid
string <uuid>
Example: location-space-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
in-stock
boolean
Example: in-stock=true

Responses

Response Schema: application/json
Array of objects (Level)
Array
formulary-uuid
string <uuid>
location-uuid
string <uuid>
location-space-uuid
string <uuid>
in-stock
boolean
quantity
number

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "location-space-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "in-stock": true,
      • "quantity": 9115.75
      }
    ]
}