{
    "swagger": "2.0",
    "info": {
        "description": "Returns Item data",
        "version": "1.0.0",
        "title": "Items"
    },
    "host": "qa-marko.aramark.net",
    "basePath": "/v1/product",
    "schemes": [
        "https"
    ],
    "securityDefinitions": {
        "apikey": {
            "type": "apiKey",
            "in": "header",
            "name": "apikey",
            "description": "This HTTP Header variable will verify security"
        }
    },
    "parameters": {
        "bypassCacheParam": {
            "in": "header",
            "name": "bypass-cache",
            "type": "string",
            "description": "This HTTP Header variable will bypass cache",
            "enum": [
                "true",
                "false"
            ],
            "default": "false"
        },
        "smokeParam": {
            "in": "header",
            "name": "smoke",
            "type": "string",
            "description": "When set to 'true' this HTTP Header variable will route to the Integration environment.  Only applicable in QA Server",
            "enum": [
                "true",
                "false"
            ],
            "default": "false"
        },
        "orgValueParam": {
            "in": "path",
            "name": "org_value",
            "type": "string",
            "description": "Aramark Location code",
            "required": true
        },
        "searchParam": {
            "name": "search",
            "in": "query",
            "type": "string",
            "description": "Text used to search for a specific product (Must use if NOT using Barcode)",
            "required": false
        },
        "barcodeParam": {
            "name": "barcode",
            "in": "query",
            "type": "string",
            "description": "Barcode value for a specific item (Must use if NOT using Search)",
            "required": false
        },
        "cpgParam": {
            "name": "cpg_only",
            "in": "query",
            "type": "number",
            "description": "Boolean value to determine whether to return only CPG items",
            "required": false,
            "enum": [
                0,
                1
            ]
        },
        "itemTypeParam": {
            "name": "item_type",
            "in": "query",
            "type": "string",
            "description": "Value used to determine whether output includes CPG item, non CPG items, or all items",
            "required": false,
            "enum": [
                "CPG",
                "NONCPG",
                "ALL"
            ],
            "default": "ALL"
        },
        "startDateTimeParam": {
            "name": "start_date_time",
            "in": "query",
            "type": "string",
            "description": "Used to specify the starting date. Goes against Last Updated Date Time. Format - \"MM/DD/YYYY HH:MI\"",
            "required": true
        },
        "endDateTimeParam": {
            "name": "end_date_time",
            "in": "query",
            "type": "string",
            "description": "Used to specify the ending date. Goes against Last Updated Date Time. Format - \"MM/DD/YYYY HH:MI\"",
            "required": true
        },
        "typeParam": {
            "name": "type",
            "in": "query",
            "type": "string",
            "description": "Used to specify the type of Receipt",
            "required": false,
            "enum": [
                "ALL",
                "PO",
                "NON-PO",
                "PO-INV"
            ]
        },
        "msaParam": {
            "name": "msa",
            "in": "query",
            "type": "string",
            "description": "List of MSAs by which to filter. Limited to 25 comma separated values"
        },
        "msaConditionalParam": {
            "name": "msa",
            "in": "query",
            "type": "string",
            "description": "MSA of item",
            "required": true
        },
        "orgValueConditionalParam": {
            "in": "path",
            "name": "org_value",
            "type": "string",
            "description": "Aramark Location code; Required if MSA not provided",
            "required": true
        },
        "bodyParam": {
            "in": "body",
            "name": "body",
            "description": "List of Items to have created with contact information.",
            "required": false,
            "schema": {
                "$ref": "#/definitions/request"
            }
        },
        "skuBodyParam": {
            "in": "body",
            "name": "body",
            "description": "Parameters used to identify SKU lookup",
            "required": true,
            "schema": {
                "$ref": "#/definitions/skuBodyParam"
            }
        }
    },
    "tags": [
        {
            "name": "Retail",
            "description": "Location level data for retail items sold"
        },
        {
            "name": "Supplier",
            "description": "Location level data for supplier items"
        }
    ],
    "paths": {
        "/retail/items/{org_value}": {
            "get": {
                "description": "Returns location level data for retail items",
                "operationId": "getRetailItems",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Retail"
                ],
                "parameters": [
                    {
                        "$ref": "#/parameters/orgValueParam"
                    },
                    {
                        "$ref": "#/parameters/searchParam"
                    },
                    {
                        "$ref": "#/parameters/barcodeParam"
                    },
                    {
                        "$ref": "#/parameters/itemTypeParam"
                    },
                    {
                        "$ref": "#/parameters/bypassCacheParam"
                    },
                    {
                        "$ref": "#/parameters/smokeParam"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Lists Item details by Location",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "status": {
                                    "type": "string",
                                    "description": "ENUM 'Success', 'Error' or 'Not Found'"
                                },
                                "count": {
                                    "type": "string",
                                    "description": "Number of records returned in request"
                                },
                                "retail_items": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/retail_items"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Requested resource does not exist."
                    },
                    "405": {
                        "description": "HTTP Verb / Operation not supported"
                    }
                }
            }
        },
        "/retail/items": {
            "post": {
                "tags": [
                    "Retail"
                ],
                "description": "Submit a request to have new retail item(s) created",
                "operationId": "postRetailItems",
                "produces": [
                    "application/json"
                ],
                "consumes": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "$ref": "#/parameters/bodyParam"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Items submitted successfully."
                    },
                    "404": {
                        "description": "Requested resource does not exist."
                    },
                    "405": {
                        "description": "HTTP Verb / Operation not supported"
                    }
                }
            }
        },
        "/supplier/items/{org_value}": {
            "get": {
                "description": "Returns location level data for supplier items",
                "operationId": "getSupplierItemsbyLocation",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Supplier"
                ],
                "parameters": [
                    {
                        "$ref": "#/parameters/orgValueConditionalParam"
                    },
                    {
                        "$ref": "#/parameters/msaConditionalParam"
                    },
                    {
                        "$ref": "#/parameters/bypassCacheParam"
                    },
                    {
                        "$ref": "#/parameters/smokeParam"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Lists Supplier Item details by Location",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "status": {
                                    "type": "string",
                                    "description": "ENUM 'Success', 'Error' or 'Not Found'"
                                },
                                "count": {
                                    "type": "string",
                                    "description": "Number of records returned in request"
                                },
                                "page": {
                                    "type": "number",
                                    "description": "Page Number of the result set"
                                },
                                "size": {
                                    "type": "number",
                                    "description": "Size of the result set"
                                },
                                "supplier_items": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/supplier_items"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Requested resource does not exist."
                    },
                    "405": {
                        "description": "HTTP Verb / Operation not supported"
                    }
                }
            }
        },
        "/supplier/items": {
            "get": {
                "description": "Returns location level data for supplier items",
                "operationId": "getSupplierItems",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Supplier"
                ],
                "parameters": [
                    {
                        "$ref": "#/parameters/msaConditionalParam"
                    },
                    {
                        "$ref": "#/parameters/bypassCacheParam"
                    },
                    {
                        "$ref": "#/parameters/smokeParam"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Lists Supplier Item details by Location",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "status": {
                                    "type": "string",
                                    "description": "ENUM 'Success', 'Error' or 'Not Found'"
                                },
                                "count": {
                                    "type": "string",
                                    "description": "Number of records returned in request"
                                },
                                "page": {
                                    "type": "number",
                                    "description": "Page Number of the result set"
                                },
                                "size": {
                                    "type": "number",
                                    "description": "Size of the result set"
                                },
                                "supplier_items": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/supplier_items"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Requested resource does not exist."
                    },
                    "405": {
                        "description": "HTTP Verb / Operation not supported"
                    }
                }
            }
        },
        "/supplier/receipts/{org_value}": {
            "get": {
                "description": "Returns location level data for supplier receipts",
                "operationId": "getSupplierReceipts",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Supplier"
                ],
                "parameters": [
                    {
                        "$ref": "#/parameters/orgValueParam"
                    },
                    {
                        "$ref": "#/parameters/startDateTimeParam"
                    },
                    {
                        "$ref": "#/parameters/endDateTimeParam"
                    },
                    {
                        "$ref": "#/parameters/msaParam"
                    },
                    {
                        "$ref": "#/parameters/typeParam"
                    },
                    {
                        "$ref": "#/parameters/bypassCacheParam"
                    },
                    {
                        "$ref": "#/parameters/smokeParam"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Lists Supplier Receipt details by Location",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "status": {
                                    "type": "string",
                                    "description": "ENUM 'Success', 'Error' or 'Not Found'"
                                },
                                "count": {
                                    "type": "string",
                                    "description": "Number of records returned in request"
                                },
                                "page": {
                                    "type": "number",
                                    "description": "Page Number of the result set"
                                },
                                "size": {
                                    "type": "number",
                                    "description": "Size of the result set"
                                },
                                "supplier_receipts": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/supplier_receipts"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Requested resource does not exist."
                    },
                    "405": {
                        "description": "HTTP Verb / Operation not supported"
                    }
                }
            }
        },
        "/sku/lookup": {
            "post": {
                "tags": [
                    "SKU"
                ],
                "description": "Submit a request to lookup SKUs",
                "operationId": "postSKULookup",
                "produces": [
                    "application/json"
                ],
                "consumes": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "$ref": "#/parameters/skuBodyParam"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "SKU lookup submitted successfully.",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "status": {
                                    "type": "string",
                                    "description": "ENUM 'Success', 'Error' or 'Not Found'"
                                },
                                "count": {
                                    "type": "number",
                                    "description": "Number of records returned in request"
                                },
                                "skus": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/skus"
                                    }
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Requested resource does not exist."
                    },
                    "405": {
                        "description": "HTTP Verb / Operation not supported"
                    }
                }
            }
        }
    },
    "definitions": {
        "skuBodyParam": {
            "type": "object",
            "properties": {
                "msa": {
                    "type": "string",
                    "description": "MSA of the Item to lookup"
                },
                "item_description": {
                    "type": "string",
                    "description": "Description of the Item"
                },
                "price": {
                    "type": "number",
                    "description": "Price of the Item"
                }
            }
        },
        "skus": {
            "type": "object",
            "properties": {
                "msa": {
                    "type": "string",
                    "description": "MSA of the Item to lookup"
                },
                "item_description": {
                    "type": "string",
                    "description": "Description of the Item"
                },
                "supplier_sku": {
                    "type": "string",
                    "description": "Supplier SKU for the item"
                },
                "order_uom": {
                    "type": "string",
                    "description": "Unit of Measure for the order"
                },
                "category_id": {
                    "type": "string",
                    "description": "Category ID for the item"
                },
                "similarity_match": {
                    "type": "string",
                    "description": null
                }
            }
        },
        "retail_items": {
            "type": "object",
            "properties": {
                "source_id": {
                    "type": "string",
                    "description": "Unique ID for the source"
                },
                "source_location_id": {
                    "type": "string",
                    "description": "Unique ID for the source location"
                },
                "revenue_center_id": {
                    "type": "string",
                    "description": "Unique ID for the revenue center"
                },
                "location_code": {
                    "type": "string",
                    "description": "Aramark Organization location code"
                },
                "location_name": {
                    "type": "string",
                    "description": "Name of the Location"
                },
                "item_name": {
                    "type": "string",
                    "description": "Name of the menu item"
                },
                "item_id": {
                    "type": "string",
                    "description": "Unique ID for the item"
                },
                "barcode": {
                    "type": "string",
                    "description": "Item barcode. This is a UPC (12-digit number with leading zeros.)"
                },
                "major_id": {
                    "type": "string",
                    "description": "Unique ID for the major group"
                },
                "major_name": {
                    "type": "string",
                    "description": "Name of the major group"
                },
                "minor_id": {
                    "type": "string",
                    "description": "Unique ID for the minor group"
                },
                "minor_name": {
                    "type": "string",
                    "description": "Name of the minor group"
                },
                "gl_account": {
                    "type": "string",
                    "description": "General Ledger account code"
                },
                "gl_account_description": {
                    "type": "string",
                    "description": "General Ledger account description"
                },
                "gl_category": {
                    "type": "string",
                    "description": "General Ledger category code"
                },
                "gl_category_description": {
                    "type": "string",
                    "description": "General Ledger category description"
                },
                "gl_concept": {
                    "type": "string",
                    "description": "General Ledger concept code"
                },
                "gl_concept_description": {
                    "type": "string",
                    "description": "General Ledger concept description"
                },
                "brand_id": {
                    "type": "string",
                    "description": "Unique ID for the brand"
                },
                "brand_name": {
                    "type": "string",
                    "description": "Name of the brand"
                },
                "catalog_id": {
                    "type": "string",
                    "description": "Unique ID for the catalog"
                },
                "catalog_name": {
                    "type": "string",
                    "description": "Name of the catalog"
                }
            }
        },
        "request": {
            "type": "object",
            "properties": {
                "source_id": {
                    "type": "number",
                    "description": "Unique ID for the source system of the item; Required"
                },
                "location_type_id": {
                    "type": "number",
                    "description": "Unique ID for the type of location; Required"
                },
                "location_code": {
                    "type": "string",
                    "description": "Aramark code for the location; Required when location_type_id=1"
                },
                "source_location_id": {
                    "type": "number",
                    "description": "POS Location ID; Required when location_type_id=3"
                },
                "revenue_center_id": {
                    "type": "number",
                    "description": "POS Revenue Center ID; Required when location_type_id=3"
                },
                "csp_location_id": {
                    "type": "number",
                    "description": "CSP Location ID; Required when location_type_id=2"
                },
                "contact_name": {
                    "type": "string",
                    "description": "Name of the requestor; Required"
                },
                "contact_phone": {
                    "type": "string",
                    "description": "Phone Number of the requestor; Required"
                },
                "email": {
                    "type": "string",
                    "description": "Email Address of the requestor; Required"
                },
                "effective_date": {
                    "type": "string",
                    "description": "Date the items will need to be available by; Optional"
                },
                "menuitem": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/menuitem"
                    }
                }
            }
        },
        "menuitem": {
            "type": "object",
            "properties": {
                "request_type": {
                    "type": "number",
                    "description": "Numeric value to indicate the type of request; 1-New, 2-Add, 3-Update, 4-Delete; Required"
                },
                "item_name": {
                    "type": "string",
                    "description": "Name of the item; Required for request_type=1 or New Menu Item"
                },
                "object_number": {
                    "type": "string",
                    "description": "Number for the object; Required for request_type=2,3,4"
                },
                "barcode": {
                    "type": "string",
                    "description": "Barcode for the item; Required for request_type=1 or New CPG Item"
                },
                "catalog": {
                    "type": "string",
                    "description": "Catalog to place the item in; Optional"
                },
                "slu": {
                    "type": "string",
                    "description": "Screen Look Up code for item; Optional"
                },
                "price": {
                    "type": "number",
                    "description": "Price of the item; Required for request_type=2,3"
                }
            }
        },
        "supplier_items": {
            "type": "object",
            "properties": {
                "msa": {
                    "type": "string",
                    "description": "MSA number of the Item"
                },
                "supplier_sku": {
                    "type": "string",
                    "description": "Supplier SKU of the Item"
                },
                "supplier_item_description": {
                    "type": "string",
                    "description": "Supplier Item Description of the Item"
                },
                "manufacturer_part_number": {
                    "type": "string",
                    "description": "Part Number of the Item"
                },
                "manufacturer_name": {
                    "type": "string",
                    "description": "Manufacturer Name of the Item"
                },
                "price": {
                    "type": "string",
                    "description": "Price of the Item"
                },
                "brand": {
                    "type": "string",
                    "description": "Brand of the Item"
                },
                "order_unit_of_measure": {
                    "type": "string",
                    "description": "Order Unit of Measure of the Item"
                },
                "item_base_unit_of_measure": {
                    "type": "string",
                    "description": "Item Unit of Measure of the Item"
                },
                "pack_size": {
                    "type": "number",
                    "description": "Pack Size of the Item"
                },
                "pack_quantity": {
                    "type": "number",
                    "description": "Pack Quantity of the Item"
                },
                "harmonized_category": {
                    "type": "string",
                    "description": "Harmonized Category of the Item"
                },
                "is_delete_marked": {
                    "type": "string",
                    "description": "Flag to deteremine delete status of the Item"
                },
                "product_master_id": {
                    "type": "string",
                    "description": "Product Master ID of the Item"
                },
                "product_master_description": {
                    "type": "string",
                    "description": "Product Master Description of the Item"
                },
                "product_master_source": {
                    "type": "string",
                    "description": "Product Master Source of the Item"
                },
                "gtin": {
                    "type": "string",
                    "description": "GTIN of the Item"
                },
                "category_short_description": {
                    "type": "string",
                    "description": "Category Short Description of the Item"
                },
                "category_long_description": {
                    "type": "string",
                    "description": "Category Long Description of the Item"
                },
                "item_city": {
                    "type": "string",
                    "description": "City of the Item"
                },
                "item_state": {
                    "type": "string",
                    "description": "State of the Item"
                },
                "item_postal_code": {
                    "type": "string",
                    "description": "Postal Code of the Item"
                },
                "stock_status": {
                    "type": "string",
                    "description": "Stock Status of the Item"
                },
                "additional_description": {
                    "type": "string",
                    "description": "Additional Description of the Item"
                },
                "storage_code": {
                    "type": "string",
                    "description": "Storage Code of the Item"
                },
                "price_by_pound": {
                    "type": "string",
                    "description": "Price By Pound of the Item"
                },
                "average_weight_in_pounds": {
                    "type": "string",
                    "description": "Average Weight in Pounds of the Item"
                },
                "upload_date": {
                    "type": "string",
                    "description": "Upload Date of the item"
                },
                "creation_date": {
                    "type": "string",
                    "description": "Create Date of the Item"
                },
                "last_updated_date": {
                    "type": "string",
                    "description": "Last Updated Date of the Item"
                }
            }
        },
        "supplier_receipts": {
            "type": "object",
            "properties": {
                "line_type": {
                    "type": "string",
                    "description": "Line Type of the Receipt"
                },
                "currency_code": {
                    "type": "string",
                    "description": "Currency Code of the Receipt"
                },
                "profit_center": {
                    "type": "string",
                    "description": "Aramark Profit Center Value"
                },
                "location": {
                    "type": "string",
                    "description": "Aramark Location Value"
                },
                "location_short_name": {
                    "type": "string",
                    "description": "Shortened name of the Location"
                },
                "msa": {
                    "type": "string",
                    "description": "MSA number of the Receipt"
                },
                "vendor_name": {
                    "type": "string",
                    "description": "Name of the Vendor of the Receipt"
                },
                "doc_id": {
                    "type": "string",
                    "description": "Doc ID of the Receipt"
                },
                "doc_number": {
                    "type": "string",
                    "description": "Doc Number of the Receipt"
                },
                "supplier_credit_memo": {
                    "type": "string",
                    "description": "Supplier Credit Memo of the Receipt"
                },
                "memo_number": {
                    "type": "string",
                    "description": "Memo Number of the Receipt"
                },
                "doc_type": {
                    "type": "string",
                    "description": "Doc Type of the Receipt"
                },
                "doc_date": {
                    "type": "string",
                    "description": "Doc Date of the Receipt"
                },
                "doc_amount": {
                    "type": "number",
                    "description": "Doc Amount of the Receipt"
                },
                "doc_creation_date": {
                    "type": "string",
                    "description": "Doc Creation Date of the Receipt"
                },
                "doc_description": {
                    "type": "string",
                    "description": "Doc Description of the Receipt"
                },
                "po_number": {
                    "type": "string",
                    "description": "PO Number of the Receipt"
                },
                "delivery_date": {
                    "type": "string",
                    "description": "Delivery Date of the Receipt"
                },
                "supplier_sku": {
                    "type": "string",
                    "description": "Supplier SKU of the Receipt"
                },
                "purchase_unit_of_measure": {
                    "type": "string",
                    "description": "Purchase Unit of Measure of the Receipt"
                },
                "item_description": {
                    "type": "string",
                    "description": "Item Description of the Receipt"
                },
                "item_quantity": {
                    "type": "number",
                    "description": "Item Quantity of the Receipt"
                },
                "unit_cost": {
                    "type": "number",
                    "description": "Unit Cost of the Receipt"
                },
                "unit_amount": {
                    "type": "number",
                    "description": "Unit Amount of the Receipt"
                },
                "tax_amount": {
                    "type": "number",
                    "description": "Tax Amount of the Receipt"
                },
                "freight_amount": {
                    "type": "number",
                    "description": "Freight Amount of the Receipt"
                },
                "discount_amount": {
                    "type": "number",
                    "description": "Discount Amount of the Receipt"
                },
                "country_legal_entity": {
                    "type": "string",
                    "description": "Country Legal Entity of the Receipt"
                },
                "service_type": {
                    "type": "string",
                    "description": "Service Type of the Receipt"
                },
                "summary_account": {
                    "type": "string",
                    "description": "Summary Account of the Receipt"
                },
                "account_category": {
                    "type": "string",
                    "description": "Account Category of the Receipt"
                },
                "user_email_address": {
                    "type": "string",
                    "description": "User Email Address of the Receipt"
                },
                "manufacturer_name": {
                    "type": "string",
                    "description": "Manufacturer Name of the Receipt"
                },
                "manufacturer_part_number": {
                    "type": "string",
                    "description": "Manufacturer Part Number of the Receipt"
                },
                "brand": {
                    "type": "string",
                    "description": "Brand of the Receipt"
                },
                "base_unit_of_measurement": {
                    "type": "string",
                    "description": "Base Unit of Measurement of the Receipt"
                },
                "pack_size": {
                    "type": "string",
                    "description": "Pack Size of the Receipt"
                },
                "pack_quantity": {
                    "type": "string",
                    "description": "Pack Quantity of the Receipt"
                },
                "mdg_item_category_id": {
                    "type": "string",
                    "description": "MDG Item Category ID of the Receipt"
                },
                "last_updated_datetime": {
                    "type": "string",
                    "description": "Last Updated Date of the Receipt"
                }
            }
        }
    }
}