Add the Parts Catalog

You can search for the parts used or returned from the catalog and then add these parts to an invoice. To view the parts from the catalog, you must create the catalog using the create_catalog method of the SOAP API or the REST API.

1. Use this code sample to understand how to create a catalog for Debrief:

   {
               "name": "my_catalog",
               "fieldSchemas": [
                   {
                       "label": "part_disposition_code",
                       "name": "Part Disposition Code",
                       "searchable": true,
                       "preview": false
                   },
                   {
                       "label": "part_item_number",
                       "name": "Item Number",
                       "searchable": true,
                       "preview": true
                   },
                   {
                       "label": "part_item_revision",
                       "name": "Item Revision",
                       "searchable": true
                   },
                   {
                       "label": "part_item_desc",
                       "name": "Item Description",
                       "preview": true
                   },
                   {
                       "label": "part_uom_code",
                       "name": "UOM",
                       "preview": true,
                       "searchable": true
                   }
             ],
              "typeSchemas": [
                   {
                       "itemType": "part",
                       "inventoryType": "part_general"
                   },
                   {
                       "itemType": "cartridge",
                       "inventoryType": "part_cartridge"
                   }
               ]              
   }

2. Use this code sample to understand how to create or update parts catalog items for Debrief scenarios:

   "type": "part",
               "fields": [
                   {
                       "label": "part_disposition_code",
                       "value": "ECM100001A"
                   },
                   {
                       "label": "part_item_number",
                       "value": "ECM100000"
                   },
                   {
                       "label": "part_item_revision",
                       "value": "ECM100000A"
                   },
                   {
                       "label": "part_item_desc",
                       "value": "2" x 5" Robotically Welded Steel Frame"
                   },
                 {
                       "label": "part_uom_code",
                       "value": "ea"
                   }
    
               ],
               "tags": [
                   "Printer",
                   "Cartridge"
               ],
               "linkedItems": [
                   {
                       "itemLabel": "RG5-7691-250CN",
                       "data": "1"
                   },
                   {
                       "itemLabel": "RG5-7691-250CF",
                       "data": "2"
                   },
                   {
                       "itemLabel": "RG5-7691-250CZ",
                       "data": "3"
                   }
               ],
               "images": [
                   {
                       "imageURL": "https://www.storage-service.com/rg5_7691_250cz.png"
                   },
                   {
                       "imageURL": "https://www.storage-service.com/rg5_7691_250cf.png"
                   }
               ]
   }

3. Doublecheck the value for the type field as follows:
   • The 'type' field within the 'create' or 'update' parts catalog calls must be set as "part" for serialized inventory.
   • The 'type' field within the 'create' or 'update' parts catalog calls must be set as "part_sn" for non-serialized inventory.
   • Each item's 'Fields' schemas must contain these elements:

     Label	Property Label	Searchable
     part_uom_code	part_uom_code	0
     part_item_revision	part_item_revision	0
     part_item_number	part_item_number	0
     part_item_desc	part_item_desc	1
     part_disposition_code	part_disposition_code	0