Returns the most recent uploads for the Schema provided. Can be used for upload history or the view the status of a currently processed upload.
\nUploads will appear once file is completely upload to Monetate. SFTP uploads appear when they are scanned and disappear from the SFTP drop location.
\nUploads are sorted by upload_time in descending order, so the most recent upload will always be first in the list.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "schema-name", "type": "string", "description": "The name of the Schema." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Token Authentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "The Monetate Data API uses Token Authentication, so requests to the Data API must include a valid, active authentication token. Include an Authorization header with the value Token [token_string] with every request. See Auth API for information on obtaining the token_string.
A URL to the next group of items, if any.
" }, { "name": "previous", "kind": "optional", "type": "string", "description": "A URL to the previous group of items, if any.
" } ] } ] }, { "name": "data", "kind": "required", "type": "array", "description": "Data payload of this response.", "modelRef": "#/components/schemas/FileUpload", "customType": "FileUpload[]", "schema": [ { "name": "status", "kind": "optional", "type": "stringThe time Monetate began importing (validating) the file.
", "format": "date-time" }, { "name": "import_end_time", "kind": "optional", "type": "stringThe time Monetate completed importing (validating) the file.
", "format": "date-time" }, { "name": "validation_errors", "kind": "optional", "type": "array", "readOnly": true, "description": "The validation error, if any that occurred. Populated when status is VALIDATION_ERROR.
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "validation_warnings", "kind": "optional", "type": "array", "readOnly": true, "description": "The validation warnings, if any occurred. Status may still be COMPLETE.
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/FileUploadListResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized.
\nThe request did not include a token, or the token provided was invalid. Please ensure that your token is correct and that the Authorization header is properly formatted.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden.\n\nThe request included a token that has been revoked. Please contact your account administrator to generate a new token.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found.
\nThe resource you are trying to fetch does not exist, or has been deleted.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] }, { "statusCode": "500", "description": "Unknown error.\n\nPlease try again or contact your account manager for more information.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response", "schema": [ { "name": "meta", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseMeta", "customType": "ResponseMeta", "schema": [ { "name": "code", "kind": "required", "type": "integer", "description": "The http response code for this response.", "example": 200 }, { "name": "warnings", "kind": "optional", "type": "array", "description": "A list of warnings associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of errors associated with this response.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/ResponseAnyData", "customType": "ResponseAnyData", "schema": [] } ], "modelRef": "#/components/schemas/Response", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "dhAWJmb-4HZwjBmrrgN_a", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.monetate.net/api/data/v1/{retailerShortname}/production/upload/{schema-name}/ \\\n --header 'accept: application/json'" }, { "id": "HI35ox6spe_PYxOvpmt3m", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.monetate.net/api/data/v1/{retailerShortname}/production/upload/{schema-name}/\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "1CmdeoJDi28WNFcpdKxEA", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.monetate.net/api/data/v1/{retailerShortname}/production/upload/{schema-name}/\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "LTj4iftD8Yal4RSm-uUMX", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.monetate.net/api/data/v1/{retailerShortname}/production/upload/{schema-name}/\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "dhAWJmb-4HZwjBmrrgN_a" }, "results": { "languages": [ { "id": "hLcPA_D8A2WcANOHwPeSp", "language": "200", "code": "// A list of file uploads.\n{\n \"meta\": {},\n \"data\": [\n {\n \"status\": \"\",\n \"upload_time\": \"\",\n \"import_start_time\": \"\",\n \"import_end_time\": \"\",\n \"validation_errors\": [\n \"\"\n ],\n \"validation_warnings\": [\n \"\"\n ]\n }\n ]\n}" }, { "id": "T-TTheHONId3Vyw-f7S3z", "language": "401", "code": "// Unauthorized.\nThe request did not include a token, or the token provided was invalid. Please ensure that your token is correct and that the Authorization header is properly formatted.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "3JFk13nrK7BTTH4MXZk3p", "language": "403", "code": "// Forbidden.\n\nThe request included a token that has been revoked. Please contact your account administrator to generate a new token.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "NI9pNJSE4c_d8ToMAAdwi", "language": "404", "code": "// Not found.\nThe resource you are trying to fetch does not exist, or has been deleted.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "NtIL8LtoyqLE6kxY4n1aQ", "language": "500", "code": "// Unknown error.\n\nPlease try again or contact your account manager for more information.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" } ], "selectedLanguageId": "hLcPA_D8A2WcANOHwPeSp" } }, "children": [ { "text": "" } ] }