Creates new data records within the schema example_schema.
If your request contains a unique key that matches a record already received by Monetate, the record is updated with the latest data.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "Representation of the fields for this Schema.
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.
Representation of the fields for this Schema.
Validation error.
\nOne or more values being sent was not in the correct format, or a required value was missing.
", "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": "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": "ij_X2VikDvPp0BguYNyrx", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.monetate.net/api/data/v1/{retailerShortname}/production/data/example_schema/ \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"schema_rows\": [\n {\n \"example_field1\": \"\"\n }\n ]\n }'" }, { "id": "DJKR4KesxGfSQRE1yOpCn", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"schema_rows\": [\n {\n \"example_field1\": \"\"\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.monetate.net/api/data/v1/{retailerShortname}/production/data/example_schema/\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "EjXntk6EeyXlFRhbV7nkB", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.monetate.net/api/data/v1/{retailerShortname}/production/data/example_schema/\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"schema_rows\": [\n {\n \"example_field1\": \"\"\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "dhmp5KmNfAN4_5R3uINSJ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.monetate.net/api/data/v1/{retailerShortname}/production/data/example_schema/\"\n\npayload = json.dumps({\n \"schema_rows\": [\n {\n \"example_field1\": \"\"\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ij_X2VikDvPp0BguYNyrx" }, "results": { "languages": [ { "id": "ZYQ0GYL2coa5-i71qbwJE", "language": "201", "code": "// Data was posted for the schema and will be made available for targetting.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {\n \"schema_rows\": [\n {\n \"example_field1\": \"\",\n \"example_field2\": \"\",\n \"example_field3\": false,\n \"example_field4\": 0,\n \"example_field5\": \"\"\n }\n ]\n }\n}" }, { "id": "wfXnAD08jHmFix723NvVG", "language": "400", "code": "// Validation error.\nOne or more values being sent was not in the correct format, or a required value was missing.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}" }, { "id": "unCquOat_2J6lVhW_UkSQ", "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": "KoNmXzrABODDLTRM9BZ1v", "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": "ESES12W1d81ZCc1sXdgg2", "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": "MYz7g3ZRRlrdXccAepzaO", "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": "ZYQ0GYL2coa5-i71qbwJE" } }, "children": [ { "text": "" } ] }