{"openapi":"3.0.0","info":{"description":"This API will return a collection of Service Inventory Data Location.\n\nThe base endpoint URL for this API in production is: `https://marko.aramark.net/v1/inventory`.\n\nFor testing the API with the \"Try\" tool on this page or in your app, use either our testing server \"qa-marko\" or our development server \"dev-marko\".\n","version":"1.0.0-oas3","title":"Inventory"},"tags":[{"name":"Storage","description":"A collection of Storage Areas for a Location"},{"name":"Items","description":"Get or Update Inventory Items"},{"name":"Purchase Orders","description":"A collection of Purchase Order data"},{"name":"Configuration","description":"A collection of Configuration data endpoints"}],"paths":{"/storage_areas":{"get":{"summary":"Inventory Storage Areas","description":"Returns a Hierarchal collection of Inventory Storage Areas for a specific location\n","operationId":"getInventoryStorage","tags":["Storage"],"parameters":[{"$ref":"#/components/parameters/locationIdParam"},{"$ref":"#/components/parameters/sourceSystemParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"All Inventory Storage Areas for a specific Location","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'"},"count":{"type":"string","description":"Number of records"},"storage_areas":{"type":"array","items":{"$ref":"#/components/schemas/storage_areas"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/purchase_orders":{"get":{"summary":"Inventory Purchase Orders","description":"Returns a Hierarchal collection of Purchase Order header and details for a specific location\n","operationId":"getPurchaseOrders","tags":["Purchase Orders"],"parameters":[{"$ref":"#/components/parameters/locationIdParam"},{"$ref":"#/components/parameters/sourceSystemParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"All Purcahase Orders for a specific Location","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'"},"count":{"type":"string","description":"Number of records"},"purchase_orders":{"type":"array","items":{"$ref":"#/components/schemas/purchase_orders"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}},"put":{"summary":"Update an Purchase Orders","description":"Allows updates to Purchase Orders\n","operationId":"putPurchaseOrders","tags":["Purchase Orders"],"parameters":[{"$ref":"#/components/parameters/sourceSystemParam"}],"requestBody":{"description":"Details for the Purchase Order that is being updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putPurchaseOrderBody"}}}},"responses":{"200":{"description":"Status of the Update Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'"},"message":{"type":"string","description":"Status Message for the Update Request"}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/items":{"get":{"summary":"Inventory Items for a specific Location","description":"Returns a collection of Inventory Item data for a specific location\n","operationId":"getInventoryItems","tags":["Items"],"parameters":[{"$ref":"#/components/parameters/locationIdParam"},{"$ref":"#/components/parameters/includeDisabledParam"},{"$ref":"#/components/parameters/sourceSystemParam"},{"$ref":"#/components/parameters/bypassCacheParam"}],"responses":{"200":{"description":"List all Inventory Items information for a location","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'"},"count":{"type":"string","description":"Number of records"},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/inventory"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}},"put":{"summary":"Update an Inventory Items","description":"Allows updates to Inventory Items\n","operationId":"putInventoryItems","tags":["Items"],"parameters":[{"$ref":"#/components/parameters/sourceSystemParam"}],"requestBody":{"description":"Details for the Item that is being updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putItemBody"}}}},"responses":{"200":{"description":"Status of the Update Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'"},"message":{"type":"string","description":"Status Message for the Update Request"}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/configuration":{"put":{"summary":"Update Inventory Configuration","description":"Allows updates to Inventory Configuration\n","operationId":"putConfiguration","tags":["Configuration"],"parameters":[{"$ref":"#/components/parameters/sourceSystemParam"}],"requestBody":{"description":"Details for the configuration that is being updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putConfigurationBody"}}}},"responses":{"201":{"description":"Status of the Update Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'"},"message":{"type":"string","description":"Status Message for the Update Request"}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}}},"servers":[{"url":"https://qa-marko.aramark.net/v1/inventory","description":"Testing server"},{"url":"https://dev-marko.aramark.net/v1/inventory","description":"Development server"}],"components":{"parameters":{"locationIdParam":{"name":"location_id","in":"query","description":"ID of the Location","required":true,"schema":{"type":"number"}},"sourceSystemParam":{"name":"source_system","in":"query","description":"Inventory source system","required":true,"schema":{"type":"string","enum":["PRMA","CLIENT"]}},"includeDisabledParam":{"name":"include_disabled","in":"query","description":"Flag to determine if disabled Items should be included in results","required":false,"schema":{"type":"boolean","default":false}},"inventoryItemIdParam":{"name":"inventory_item_id","in":"path","description":"ID of the Inventory Item to be udpated","required":true,"schema":{"type":"number"}},"bypassCacheParam":{"in":"header","name":"bypass-cache","description":"This HTTP Header variable will bypass cache","schema":{"type":"string","enum":["true","false"]}},"smokeParam":{"in":"header","name":"smoke","description":"When set to 'true' this HTTP Header variable will route to the Integration environment.  Only applicable in QA Server.\n","schema":{"type":"string","enum":["true","false"]}}},"securitySchemes":{"apikey":{"type":"apiKey","in":"header","name":"apikey","description":"This HTTP Header variable will verify security"}},"schemas":{"putItemBody":{"type":"object","properties":{"inventory_item_id":{"type":"number","description":"Inventory Item ID"},"actual_unit1_value":{"type":"number","description":"Actual Unit1 Value for the Item"},"actual_unit2_value":{"type":"number","description":"Actual Unit2 Value for the Item"},"actual_unit3_value":{"type":"number","description":"Actual Unit3 Value for the Item"},"fiscal_time_period_id":{"type":"number","description":"Fiscal Period ID in which the Item is being updated"}}},"putPurchaseOrderBody":{"type":"object","properties":{"po_header_id":{"type":"number"},"po_detail_id":{"type":"number"},"received_qty":{"type":"number"},"is_catchweight":{"type":"boolean"}}},"putConfigurationBody":{"type":"object","properties":{"inventory_item_id":{"type":"number"},"to_storage_area_id":{"type":"number"},"sort_order":{"type":"number"},"enabled":{"type":"boolean"}}},"storage_areas":{"type":"object","properties":{"storage_area_id":{"type":"number","description":"ID of the Storage Area"},"site_id":{"type":"number","description":"Site ID for the Storage Area"},"description":{"type":"string","description":"Name of the Storage Area"},"location_id":{"type":"number","description":"Location ID for the Storage Area"},"storage_area_order":{"type":"number","description":"Sort Order of the Storage Area"},"storage_area_level":{"type":"number","description":"Level of the Storage Area"},"level1":{"type":"number","description":"Level 1 Storage Area ID"},"level2":{"type":"number","description":"Level 2 Storage Area ID"},"level3":{"type":"number","description":"Level 3 Storage Area ID"}}},"purchase_orders":{"type":"object","properties":{"po_header_id":{"type":"number","description":"Purchase Order Header ID"},"po_number":{"type":"string","description":"Number of the Purchase Order"},"po_date":{"type":"string","description":"Date of the Purchase Order"},"location_id":{"type":"number","description":"Location ID for the Purchase Order"},"vendor_id":{"type":"number","description":"Vendor ID for the Purchase Order"},"vendor_name":{"type":"string","description":"Name of the Vendor for the Purchase Order"},"total_amount":{"type":"number","description":"Total amount of the Purchase Order"},"purchase_order_status_seq":{"type":"number","description":"Purchase Order status sequence"},"status":{"type":"string","description":"Purchase Order status"},"comments":{"type":"string","description":"Comments on the Purchase Order"},"details":{"type":"array","items":{"$ref":"#/components/schemas/purchase_order_details"}}}},"purchase_order_details":{"type":"object","properties":{"po_detail_id":{"type":"number","description":"Purchase Order Detail ID"},"line_number":{"type":"number","description":"Line Number of the Purchase Order Detail"},"quantity":{"type":"number","description":"Quantity of the Purchase Order Detail"},"unit_price":{"type":"number","description":"Unit Price of the Purchase Order Detail"},"ext_amount":{"type":"number","description":"Ext Amount of the Purchase Order Detail"},"uom":{"type":"string","description":"Unit of the Measure of the Purhcase Order Detail"},"is_catch_weight":{"type":"number","description":"Is Catch Weight of the Purchase Order Detail"},"vendor_item_number":{"type":"string","description":"Vendor Item Number for the Purchase Order Detail"}}},"inventory":{"type":"object","properties":{"location_id":{"type":"number","description":"ID of the Location"},"inventory_item_storage_area_name":{"type":"string","description":"Name of the Storage Area for the Item"},"inventory_item_storage_area_id":{"type":"number","description":"ID of the Storage Area for the Item"},"inventory_item_name":{"type":"string","description":"Name of the Item"},"inventory_item_id":{"description":"ID of the Item"},"sort_order":{"type":"number"},"enabled":{"type":"boolean"},"pack_unit_size":{"$ref":"#/components/schemas/pack_unit_size"},"details":{"$ref":"#/components/schemas/details"}}},"pack_unit_size":{"type":"object","properties":{"purchase_size_description":{"type":"string","description":"Description of the Purchase Size of the Item Pack"},"purchase_size":{"type":"number","description":"Purchase Size of the Item Pack"},"pack_size_description":{"type":"string","description":"Description of the Pack Size of the Item"},"pack_size":{"type":"number","description":"Pack Size of the Item"},"inner_pack_size_description":{"type":"string","description":"Description of the Inner Pack Size of the Item"},"inner_pack_size":{"type":"number","description":"Inner Pack Size of the Item"}}},"details":{"type":"object","properties":{"unit_purchase_description":{"type":"string","description":"Description of the Purchase Unit of the Item"},"beginning_units":{"type":"number","description":"Number of Beginning Units of the Item"},"received_units":{"type":"number","description":"Number of Received Units of the Item"},"catch_weight_flag":{"type":"string","description":"Flag to indicate whether or not catch weight is applicable for this Item"},"transfer_in_quantity":{"type":"number","description":"Number of Units Transferred In for the Item"},"transfer_out_quantity":{"type":"number","description":"Number of Units Transferred Out for the Item"},"fiscal_time_period_id":{"type":"number","description":"ID of the Fiscal Period for the Item"},"last_purchase_date":{"type":"string"},"vendor_item_description":{"type":"string"},"vendor_item_number":{"type":"string"},"vendor_name":{"type":"string"}}}}}}