Orisha Commerce Platform

Appearance

Items ​

In an ERP (Enterprise Resource Planning) system, "items" refer to the products or services that a business sells and/or purchases. Items are typically defined with specific properties and details to facilitate these processes, such as unit of measures and pricing information.

In the Orisha Commerce Platform, items are also used for display in webshops and/or mobile apps. Therefore, it is possible to enrich items with marketing-related data, including descriptions, images, and attachments.

Images ​

Images can be attached to items which can be used for displaying the item visually to the customer. The image should meet the following requirements:

  • Maximum file size is 5MB.
  • Image should be of type JPG or PNG.

When a image is uploaded, a hash (MD5) is generated and returned in the response. You can use that hash to compare if the image it outdated.

Attachments ​

Attachments provide additional resources related to an item, such as manuals, datasheets, certificates, or other relevant documents. These files can be uploaded and associated with an item to enhance product information. Attachments must meet the following requirements:

  • Maximum file size is 5MB.
  • Attachment should be of type JPG, PNG, PDF, XLS, XLSX, DOC or DOCX.

When a attachment is uploaded, a hash (MD5) is generated and returned in the response. You can use that hash to compare if the attachment it outdated.

Attributes ​

Item has support for attributes usage.

Stock ​

An item can have multiple stock entries, which can be distributed across different warehouses. When stock is created or updated, it must be recorded in the item's base unit of measure.

Filtering ​

To learn more about filtering, see the guide on filtering entities.

Partial updates (PATCH) ​

Items support JSON Patch (RFC 6902) for partial updates using the HTTP PATCH method (application/json-patch+json). Send an ordered array of operations to modify only the needed fields.

Example JSON Patch body:

json
[
  {
    "op": "replace",
    "path": "/FamilyCode",
    "value": "New Family Code"
  }
]