Batch Number

The Batch Number API allows you to create a batch by making a POST HTTP request.

URL

.../wms/lgfapi/entity/batch_number/
  • If the matching record already exists, that will be returned and no record is created in the database. An HTTP status of 200 - OK is returned.
  • If a match is not found, a new record is created and an HTTP status 201 - Created is returned.
  • Both scenarios will return a representation in the response body.
  • We will attempt to match on facility, company, batch_nbr, and item.
  • If a match is found, but the expiry date or lock do not match the existing record, an error is returned. This will not update the existing record.
  • The batch_nbr is validated against the barcode type configuration for "Batch Nbr".

Request Body Example

{
    "fields": {
        "facility_id": 269,
	"company_id": 48,
	"batch_nbr": "BATCH123",
        "item_id": 1,
        "lock_id": 123,
        "expiry_date": "2018-01-01"
    }
}