CaseIDs

caseids_import

Imports a CaseID into a dispensary’s inventory, creating or updating the associated POS Package UID, Catalog Product, and Inventory Package records.

Endpoint

POST /api/v1.2/caseids/import/

Example Payload

{
  "case_uuid": "<case_uuid>",
  "packaged_product_uuid": "<packaged_product_uuid>",
  "pos_product_id": "<pos_product_id>",
  "pos_inventory_id": "<pos_inventory_id>",
  "package_uid": "<package_uid>"
}

Request Fields

Field

Type

Required

Description

case_uuid

string (ShortUUID)

yes

UUID of the case to import

packaged_product_uuid

string (ShortUUID)

yes

UUID of the packaged product within the case

pos_product_id

string

yes

POS catalog/product ID

pos_inventory_id

string

yes

POS inventory record/package ID

package_uid

string

yes

Package UID

sku

string

no

Product SKU

Responses

200

Success response

{
  "case_uuid": "<case_uuid>",
  "packaged_product_uuid": "<packaged_product_uuid>",
  "package_uid": "<package_uid>"
}

Bad Request

400

will be returned for business rule violations

{
  "detail": "This case has already been scanned for another dispensary."
}

will be returned for field-level validation errors

{
  "case_uuid": ["This field is required."],
  "pos_product_id": ["This field is required."]
}

caseids_import_remove

Removes a previously imported CaseID from a dispensary’s inventory. Deletes the associated import records and removes the LucidIDs from the inventory collection.

Endpoint

POST /api/v1.2/caseids/import/remove/

Example Payload

{
  "case_uuid": "<case_uuid>",
  "package_uid": "<package_uid>",
  "packaged_product_uuid": "<packaged_product_uuid>"
}

Request Fields

Field

Type

Required

Description

case_uuid

string (ShortUUID)

yes

UUID of the case to remove

package_uid

string

yes

Package UID

packaged_product_uuid

string (ShortUUID)

no

UUID of the packaged product to remove (for multi-batch cases)

Responses

200

Bad Request

400

will be returned for business rule violations

{
  "detail": "POS Package UID not found for package_uid=PKG-001."
}