JSON Schema for Inventory Records

The current JSON Schema for Inventory records. You can use this schema to validate your data.


{
  "title": "inventory",
  "description": "Merchstack Inventory Schema",
  "$id": "https://docs.merchstack.io/schemas/inventorySchema.json",
  "type": "object",
  "properties": {
    "importMetaData": {
      "type": "object",
      "properties": {
        "importId": {
          "type": "string"
        },
        "recordNum": {
          "type": "integer"
        },
        "recordOf": {
          "type": "integer"
        },
        "recordType": {
          "type": "string",
          "const": "inventory"
        },
        "operationType": {
          "type": "string",
          "enum": [
            "create",
            "update"
          ]
        },
        "formatVersion": {
          "type": "string",
          "enum": [
            "1.0"
          ]
        }
      },
      "required": [
        "importId",
        "recordNum",
        "recordOf",
        "recordType",
        "operationType",
        "formatVersion"
      ]
    },
    "stockOnHand": {
      "type": "integer"
    },
    "externalVariantId": {
      "type": "string"
    }
  },
  "required": [
    "importMetaData",
    "externalVariantId",
    "stockOnHand"
  ]
}