BlueCart · Schema

ClientCreate

Payload for creating a client association.

RestaurantProcurementWholesaleOrderingFood DistributionHospitalityeCommerce

Properties

Name Type Description
clientEmail string
clientId integer
name string
catalogId integer
orderFrequency string
accountNumber string
netTerms string
addresses object
salesReps array
View JSON Schema on GitHub

JSON Schema

bluecart-client-create-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientCreate",
  "description": "Payload for creating a client association.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bluecart/refs/heads/main/json-schema/bluecart-client-create-schema.json",
  "type": "object",
  "properties": {
    "clientEmail": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "clientId": {
      "type": "integer",
      "format": "int64",
      "example": 5012
    },
    "name": {
      "type": "string",
      "example": "Downtown Bistro"
    },
    "catalogId": {
      "type": "integer",
      "format": "int64",
      "example": 700
    },
    "orderFrequency": {
      "type": "string",
      "example": "Weekly"
    },
    "accountNumber": {
      "type": "string",
      "example": "ACCT-5012"
    },
    "netTerms": {
      "type": "string",
      "example": "Net 30"
    },
    "addresses": {
      "type": "object",
      "additionalProperties": true
    },
    "salesReps": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "example": [
        3001
      ]
    }
  },
  "required": [
    "clientEmail",
    "name"
  ]
}