MarginEdge · Schema

GetVendorsResponseModel

GetVendorsResponseModel schema from MarginEdge Public API

RestaurantBack OfficeInvoicesInventoryAccountingReporting

Properties

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

JSON Schema

public-api-get-vendors-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-vendors-response-model-schema.json",
  "title": "GetVendorsResponseModel",
  "description": "GetVendorsResponseModel schema from MarginEdge Public API",
  "type": "object",
  "properties": {
    "nextPage": {
      "type": "string",
      "description": "Unique key for the next page of results",
      "example": "eyJsYXN0SWQiOiAiMTIzNDUifQ=="
    },
    "vendors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vendorId": {
            "type": "string",
            "description": "Unique identifier of the vendor within this restaurant unit",
            "example": "me-vendor-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"
          },
          "vendorAccounts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "vendorAccountNumber": {
                  "type": "string",
                  "description": "The vendor\u2019s account number for this restaurant",
                  "example": "INV-100245"
                }
              }
            }
          }
        }
      }
    }
  }
}