Skip to content

Receipt

Version 1

Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Barrett Distribution Centers, Inc. Receipt Schema",
    "description": "Version 1",
    "additionalProperties": false,
    "properties": {
        "orderId": {
            "type": "string"
        },
        "receiptId": {
            "type": "string"
        },
        "orderType": {
            "type": "string"
        },
        "receiptDate": {
            "type": "string",
            "format": "date"
        },
        "toFacility": {
            "type": "string"
        },
        "purchaseOrder": {
            "type": "string"
        },
        "billOfLading": {
            "type": "string"
        },
        "proNumber": {
            "type": "string"
        },
        "returnTrackingNo": {
            "type": "string"
        },
        "totalQuantity": {
            "type": "number"
        },
        "undamagedQuantity": {
            "type": "number"
        },
        "damagedQuantity": {
            "type":"number"
        },
        "quantityUom": {
            "type":"string"
        },
        "custom": {
            "$ref": "#/definitions/custom"
        },
        "items": {
            "type": "array",
            "minItems": 1,
            "items": {
                "$ref": "#/definitions/item"
            }
        }
    },
    "required": [
        "receiptId",
        "orderId",
        "receiptDate",
        "toFacility",
        "totalQuantity",
        "undamagedQuantity",
        "damagedQuantity",
        "quantityUom",
        "items"
    ],
    "definitions": {
        "custom": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "customStrings": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "$ref": "#/definitions/customString"
                    }
                },
                "customNumbers": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "$ref": "#/definitions/customNumber"
                    }
                },
                "customDates": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "$ref": "#/definitions/customDate"
                    }
                }
            },
            "anyOf": [
                {
                    "required": [
                        "customStrings"
                    ]
                },
                {
                    "required": [
                        "customNumbers"
                    ]
                },
                {
                    "required": [
                        "customDates"
                    ]
                }
            ]
        },
        "customString": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "name": {
                    "type": "string"
                },
                "value": {
                    "type": "string"
                }
            },
            "required": [
                "name",
                "value"
            ]
        },
        "customNumber": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "name": {
                    "type": "string"
                },
                "value": {
                    "type": "number"
                }
            },
            "required": [
                "name",
                "value"
            ]
        },
        "customDate": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "name": {
                    "type": "string"
                },
                "value": {
                    "type": "string",
                    "format": "date"
                }
            },
            "required": [
                "name",
                "value"
            ]
        },
        "item": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "itemId": {
                    "type": "string"
                },
                "totalQuantity": {
                    "type": "integer"
                },
                "quantityUom": {
                    "type": "string"
                },
                "undamagedQuantity": {
                    "type": "number"
                },
                "damagedQuantity": {
                    "type": "number"
                },
                "lotNumber": {
                    "type": "string"
                },
                "serialNumber": {
                    "type": "string"
                },
                "manufactureDate": {
                    "type": "string",
                    "format": "date"
                },
                "expirationDate": {
                    "type": "string",
                    "format": "date"
                },
                "custom": {
                    "$ref": "#/definitions/custom"
                }
            },
            "required": [
                "itemId",
                "totalQuantity",
                "quantityUom",
                "undamagedQuantity",
                "damagedQuantity"
            ]
        },
        "note": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "note": {
                    "type": "string"
                },
                "sequence": {
                    "type": "number"
                }
            },
            "required": [
                "note",
                "sequence"
            ]
        }
    }
}

Sample

{
    "orderId": "2832890",
    "receiptId": "15239923-1",
    "purchaseOrder": "PO1339832038",
    "toFacility": "TN2",
    "orderType": "incoming",
    "proNumber": "2021042103",
    "totalQuantity": 2376,
    "undamagedQuantity": 1584,
    "damagedQuantity": 792,
    "quantityUom": "EA",
    "receiptDate": "2021-04-21",
    "items": [
        {
            "itemId": "WX5786",
            "totalQuantity": 792,
            "undamagedQuantity": 792,
            "damagedQuantity": 0,
            "quantityUom": "EA",
            "serialNumber": "286",
            "lotNumber": "ABC123",
            "manufactureDate": "2021-03-21",
            "expirationDate": "2022-04-21",
            "custom": {
                "customNumbers": [
                    {
                        "name": "DTLPASSTHRUNUM10",
                        "value": 1
                    }
                ]
            }
        },
        {
            "itemId": "WX5786",
            "totalQuantity": 792,
            "undamagedQuantity": 0,
            "damagedQuantity": 792,
            "quantityUom": "EA",
            "serialNumber": "286",
            "custom": {
                "customNumbers": [
                    {
                        "name": "DTLPASSTHRUNUM10",
                        "value": 3
                    }
                ]
            }
        },
        {
            "itemId": "WX5746",
            "totalQuantity": 792,
            "undamagedQuantity": 792,
            "damagedQuantity": 0,
            "quantityUom": "EA",
            "serialNumber": "287",
            "custom": {
                "customNumbers": [
                    {
                        "name": "DTLPASSTHRUNUM10",
                        "value": 2
                    }
                ]
            }
        }
    ]
}

Railroad Diagrams

Note

Items in green represent the properties that are always present. Items in blue represent additional properties that may or may not be present.

Receipt

Item

Custom

Custom String

Custom Number

Custom Date