MarginEdge · Schema

GetVendorItemsResponseModel

GetVendorItemsResponseModel schema from MarginEdge Public API

RestaurantBack OfficeInvoicesInventoryAccountingReporting

Properties

Name Type Description
vendorItems array
nextPage string Unique key for the next page of results
View JSON Schema on GitHub

JSON Schema

public-api-get-vendor-items-response-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/marginedge/refs/heads/main/json-schema/public-api-get-vendor-items-response-model-schema.json",
  "title": "GetVendorItemsResponseModel",
  "description": "GetVendorItemsResponseModel schema from MarginEdge Public API",
  "type": "object",
  "properties": {
    "vendorItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vendorItemCode": {
            "type": "string",
            "description": "Vendor\u2019s item code or SKU identifying the item",
            "example": "example"
          },
          "centralVendorItemId": {
            "type": "string",
            "description": "Unique identifier of this vendor item in MarginEdge (across all restaurant units/vendors)",
            "example": "me-centralvendoritem-9f3a2b"
          },
          "vendorId": {
            "type": "string",
            "description": "Unique identifier of the vendor within this restaurant unit",
            "example": "me-vendor-9f3a2b"
          },
          "companyConceptProductId": {
            "type": "string",
            "description": "Identifier of the product (unique within the company concept this restaurant belongs to) this item is assigned to in MarginEdge",
            "example": "me-companyconceptproduct-9f3a2b"
          },
          "vendorName": {
            "type": "string",
            "description": "Name of the vendor in MarginEdge",
            "example": "Sample Vendor"
          },
          "centralVendorId": {
            "type": "string",
            "description": "Unique identifier of the vendor centrally (across all restaurant units in MarginEdge)",
            "example": "me-centralvendor-9f3a2b"
          },
          "productName": {
            "type": "string",
            "description": "Name of the product",
            "example": "Sample Product"
          }
        }
      }
    },
    "nextPage": {
      "type": "string",
      "description": "Unique key for the next page of results",
      "example": "eyJsYXN0SWQiOiAiMTIzNDUifQ=="
    }
  }
}