Bill of Lading

A document to provide evidence of contract of carriage; confirmation of receipt for the goods; and/or a document of title.

KTDDE Requirements

This schema is based on the data elements defined here.

Data Model

Example

{
  "issuer": {
    "id": "https://jargon.sh",
    "address": {
      "street": "The quick brown fox jumps over the lazy dog.",
      "city": "The quick brown fox jumps over the lazy dog.",
      "state": "The quick brown fox jumps over the lazy dog.",
      "zip": 12345
    }
  },
  "issuanceDate": "1970-01-01T00:00:00Z",
  "credentialSubject": {
    "id": "https://jargon.sh",
    "billOfLadingNumber": "The quick brown fox jumps over the lazy dog.",
    "bookingNumber[]": "The quick brown fox jumps over the lazy dog.",
    "shipper": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "consignee": {
      "id": "https://jargon.sh",
      "address": {
        "street": "The quick brown fox jumps over the lazy dog.",
        "city": "The quick brown fox jumps over the lazy dog.",
        "state": "The quick brown fox jumps over the lazy dog.",
        "zip": 12345
      }
    },
    "shippingDate": "1970-01-01"
  }
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "issuer": {
      "$ref": "#/$defs/Party",
      "description": ""
    },
    "issuanceDate": {
      "type": "string",
      "format": "date-time",
      "description": ""
    },
    "credentialSubject": {
      "$ref": "#/$defs/Consignment",
      "description": ""
    }
  },
  "description": "A request to purchase one or more goods",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "Party": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Address": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "street": {
          "type": "string",
          "description": "The street component of the address"
        },
        "city": {
          "type": "string",
          "description": "The city compomnent of the address"
        },
        "state": {
          "type": "string",
          "description": "The state component of the address"
        },
        "zip": {
          "type": "number",
          "description": "Zip or postal code for the address"
        }
      },
      "description": ""
    },
    "Consignment": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number for the user"
        },
        "billOfLadingNumber": {
          "type": "string",
          "description": ""
        },
        "bookingNumber[]": {
          "type": "string",
          "description": ""
        },
        "shipper": {
          "$ref": "#/$defs/Shipper",
          "description": ""
        },
        "consignee": {
          "$ref": "#/$defs/Consignee",
          "description": ""
        },
        "shippingDate": {
          "type": "string",
          "format": "date",
          "description": ""
        }
      },
      "description": ""
    },
    "Shipper": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    },
    "Consignee": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "A unique number that identifies a customer"
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The shipping address for the customer where they would like their orders delivered"
        }
      },
      "description": ""
    }
  }
}