Item Setup
Version 1
Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Barrett Distribution Centers, Inc. Item Setup",
"description": "Version 1",
"additionalProperties": false,
"properties": {
"itemId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 40
},
"abbreviation": {
"type": "string"
},
"upc": {
"type": "string"
},
"gtin14": {
"type": "string"
},
"gtin14Innr": {
"type": "string"
},
"gtin14Cs": {
"type": "string"
},
"velocity": {
"$ref": "#/definitions/velocity"
},
"isHazardous": {
"type": "boolean"
},
"kittingType": {
"$ref": "#/definitions/kittingType"
},
"statusId": {
"$ref": "#/definitions/statusId"
},
"countryOfOrigin": {
"$ref": "#/definitions/country"
},
"shippingInformation": {
"$ref": "#/definitions/shippingInformation"
},
"uoms": {
"type": "array",
"minItems": 1,
"$ref": "#/definitions/uoms"
},
"uomConversions": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/uomConversion"
}
},
"options": {
"$ref": "#/definitions/options"
},
"additionalAliases": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/alias"
}
},
"kitComponents": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/kitComponent"
}
},
"custom": {
"$ref": "#/definitions/custom"
}
},
"required": [
"itemId",
"customerId",
"description",
"upc",
"velocity",
"isHazardous",
"countryOfOrigin",
"shippingInformation",
"uoms",
"uomConversions"
],
"definitions": {
"options": {
"type": "object",
"additionalProperties": false,
"properties": {
"lotNumberRequired": {
"type": "boolean"
},
"serialNumberRequired": {
"type": "boolean"
},
"manufactureDateRequired": {
"type": "boolean"
},
"expirationDateRequired": {
"type": "boolean"
}
}
},
"shippingInformation": {
"type": "object",
"additionalProperties": false,
"properties": {
"htsCode": {
"type": "string"
},
"htsCodeDescription": {
"type": "string"
},
"nmfcCode": {
"type": "string"
},
"ltlClass": {
"type": "string"
}
},
"required": [
"htsCode",
"htsCodeDescription",
"nmfcCode",
"ltlClass"
]
},
"uomConversion": {
"type": "object",
"properties": {
"fromUom": {
"$ref": "#/definitions/itemUom"
},
"toUom": {
"$ref": "#/definitions/itemUom"
},
"quantity": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"quantity",
"fromUom",
"toUom"
]
},
"dimensions": {
"type": "object",
"additionalProperties": false,
"properties": {
"length": {
"type": "integer"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"weight": {
"type": "integer"
}
},
"required": [
"length",
"width",
"height",
"weight"
]
},
"alias": {
"type": "object",
"properties": {
"name": {
"type":"string"
},
"value": {
"type": "string"
},
"uom": {
"$ref": "#/definitions/itemUom"
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"kitComponent": {
"type": "object",
"properties": {
"itemId": {
"type":"string"
},
"quantity": {
"type": "number"
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"uoms": {
"type": "object",
"properties": {
"uom": {
"$ref": "#/definitions/itemUom"
},
"isBase": {
"type": "boolean"
},
"dimensions": {
"$ref": "#/definitions/dimensionsValue"
}
},
"required": [
"uom",
"dimensions"
]
},
"itemUom": {
"type": "string",
"enum": [
"EA",
"CS",
"CTN",
"INNR",
"PLT"
]
},
"dimensionsValue": {
"length": "number",
"width": "number",
"height": "number",
"weight": "number"
},
"statusId": {
"type": "string",
"enum": [
"active",
"inactive",
"pending"
]
},
"kittingType": {
"type": "string",
"enum": [
"none",
"kitByItem",
"simplifiedKit",
"componentTemplate"
]
},
"velocity": {
"type": "string",
"enum": [
"A",
"B",
"C"
]
},
"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"
]
},
"country": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"VG",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"HK",
"MO",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"AN",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW",
"AFG",
"ALB",
"DZA",
"ASM",
"AND",
"AIA",
"ATA",
"ATG",
"ARG",
"ARM",
"ABW",
"AUS",
"AUT",
"AZE",
"BHS",
"BHR",
"BGD",
"BRB",
"BLR",
"BEL",
"BLZ",
"BEN",
"BMU",
"BTN",
"BOL",
"BIH",
"BWA",
"BVT",
"BRA",
"IOT",
"VGB",
"BRN",
"BGR",
"BFA",
"BDI",
"KHM",
"CMR",
"CAN",
"CPV",
"CYM",
"CAF",
"TCD",
"CHL",
"CHN",
"CXR",
"CCK",
"COL",
"COM",
"COG",
"COK",
"CRI",
"CIV",
"HRV",
"CUB",
"CYP",
"CZE",
"DNK",
"DJI",
"DMA",
"DOM",
"TMP",
"ECU",
"EGY",
"SLV",
"GNQ",
"ERI",
"EST",
"ETH",
"FLK",
"FRO",
"FJI",
"FIN",
"FRA",
"FXX",
"GUF",
"PYF",
"ATF",
"GAB",
"GMB",
"GEO",
"DEU",
"GHA",
"GIB",
"GRC",
"GRL",
"GRD",
"GLP",
"GUM",
"GTM",
"GIN",
"GNB",
"GUY",
"HTI",
"HMD",
"HND",
"HKG",
"HUN",
"ISL",
"IND",
"IDN",
"IRN",
"IRQ",
"IRL",
"ISR",
"ITA",
"JAM",
"JPN",
"JOR",
"KAZ",
"KEN",
"KIR",
"KOR",
"PKR",
"KWT",
"KGZ",
"LAO",
"LVA",
"LBN",
"LSO",
"LBR",
"LBY",
"LIE",
"LTU",
"LUX",
"MAC",
"MKD",
"MDG",
"MWI",
"MYS",
"MDV",
"MLI",
"MLT",
"MHL",
"MTQ",
"MRT",
"MUS",
"MYT",
"MEX",
"FSM",
"MDA",
"MCO",
"MNG",
"MSR",
"MAR",
"MOZ",
"MMR",
"NAM",
"NRU",
"NPL",
"NLD",
"ANT",
"NCL",
"NZL",
"NIC",
"NER",
"NGA",
"NIU",
"NFK",
"MNP",
"NOR",
"OMN",
"PAK",
"PLW",
"PAN",
"PNG",
"PRY",
"PER",
"PHL",
"PCN",
"POL",
"PRT",
"PRI",
"QAT",
"REU",
"ROM",
"RUS",
"RWA",
"KNA",
"LCA",
"VCT",
"WSM",
"SMR",
"STP",
"SAU",
"SEN",
"SYC",
"SLE",
"SGP",
"SX",
"SVK",
"SVN",
"SLB",
"SOM",
"ZAF",
"SGS",
"ESP",
"LKA",
"SHN",
"SPM",
"SDN",
"SUR",
"SJM",
"SWZ",
"SWE",
"CHE",
"SWI",
"SYR",
"TWN",
"TJK",
"TZA",
"THA",
"TGO",
"TKL",
"TON",
"TTO",
"TUN",
"TUR",
"TKM",
"TCA",
"TUV",
"UGA",
"UKR",
"ARE",
"GBR",
"UK",
"UMI",
"USA",
"URY",
"VIR",
"UZB",
"VUT",
"VAT",
"VEN",
"VNM",
"WLF",
"ESH",
"YEM",
"YUG",
"ZAR",
"ZMB",
"ZWE"
]
}
}
}
Sample
[{
"itemId": "XD659549393848",
"customerId": "46334",
"description": "SHOE AXL BLCK",
"abbreviation": "ADT",
"upc": "123456789012",
"gtin14": "12345678901234",
"velocity": "C",
"isHazardous": false,
"statusId": "inactive",
"countryOfOrigin": "US",
"shippingInformation": {
"htsCode": "0901.21.0011",
"htsCodeDescription": "Shoes and Footwear",
"nmfcCode": "32100.4",
"ltlClass": "50"
},
"uoms": [
{
"uom": "EA",
"isBase": true,
"dimensions": {
"length": 15,
"width": 11,
"height": 1,
"weight": 1
}
},
{
"uom": "INNR",
"isBase": false,
"dimensions": {
"length": 15,
"width": 11,
"height": 1,
"weight": 1
}
},
{
"uom": "CS",
"isBase": false,
"dimensions": {
"length": 15,
"width": 11,
"height": 1,
"weight": 1
}
}
],
"uomConversions": [
{
"fromUom": "EA",
"quantity": 6,
"toUom": "INNR"
},
{
"fromUom": "INNR",
"quantity": 12,
"toUom": "CS"
}
],
"options": {
"lotNumberRequired": false,
"serialNumberRequired": false,
"manufactureDateRequired": false,
"expirationDateRequired": false
},
"additionalAliases": [
{
"name": "NS-INTERNALID",
"value": "NS-849043890r"
}
],
"custom": {
"customDates": [
{
"name": "A Date",
"value": "1948-07-11"
},
{
"name": "Another Date",
"value": "1990-01-19"
}
]
}
}]
UOM Codes
The following captures the allowed values for the various UOM properties found in Barrett's REST APIs.
Item UOMs
| UOM | Description |
|---|---|
| EA | Each |
| CS | Case |
| CTN | Carton |
| INNR | Inner |
| PLT | Pallet |
Dimension UOMs
| UOM | Description |
|---|---|
| IN | Inch |
Weight UOMs
| UOM | Description |
|---|---|
| LB | Pounds |
Kitting Types
The following captures the allowed values for the various UOM properties found in Barrett's REST APIs.
Kitting Types
| KittingType | Description |
|---|---|
| none | No kitting required |
| kitByItem | Kit By Item |
| simplifiedKit | Simplified Kit |
| componentTemplate | Template |
Railroad Diagrams
Note
Items in green represent the properties that Barrett requires. Items in blue represent optional properties that may be additionally sent by the customer.