This developer-facing document outlines the integration instructions to be able push Entry and Receipt data to the GOcxm Receipt Verification/Retail Goverance Service and the returned responses.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2370093","collectionId":"19172bf9-d79c-4648-9861-ecc82b1a0311","publishedId":"2s9YC1Vtqg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"163a63","highlight":"163a63"},"publishDate":"2023-09-08T16:58:46.000Z"},"item":[{"name":"Receipt Verification","item":[{"name":"Create a new submission","id":"c05b3133-42b5-4b1d-bb3f-f724be337551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"app-token","value":"{{app_token}}","description":"required
\n"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"submission ref id\",\n \"user_ref_id\": \"submission user ref id\",\n \"contact_email\": \"submission contact email\",\n \"contact_phone\": \"submission contact phone\",\n \"files\": [\n {\n \"ref_id\": \"submission file ref id\",\n \"file_url\": \"full url for submission file\" \n }\n ],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ] \n}\n","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/apps/submissions","description":"API Call to send submission to Receipt Verification
\nExplanation For Request Variables
ref_id : Required | Max Length 36 | String | Unique Value to Refrence Submission
user_ref_id : Optional | Max Length 36 | String | User Refernce for Submission
contact_email**: Optional | Max Length 255 | String | Submission Emailcontact_phone: Optional | Max Length 50 | String | Submission Phonedocument_type: Required | Max Length 50 | String | Document type - receipt Or invoice
files: Submission File Array | Allow multiple files in single submission
{
ref_id: Required | Max Length 36 | String | Unique Value to Refrence Submission File ID
file_url: Required | Max Length 255 | String | Full URL of Submission File including http protocol and file extension
}
other_data: Optional | JSON | Submission related data which can be used to send back on callback data
\n","urlObject":{"path":["api","v1","apps","submissions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"652301a7-49c7-4a6a-bc6e-136a92550c23","name":"create a new submission","originalRequest":{"method":"POST","header":[{"key":"app-token","value":"AppTokenByGocxm","description":"required","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Contact Email\",\n \"contact_phone\": \"Submission Contact Phone\",\n \"document_type\": \"receipt\",\n \"files\": [\n {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\" \n }\n ],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ] \n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/apps/submissions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"1.0.0\",\n \"msg\": \"submission created\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"files\": 1\n}"}],"_postman_id":"c05b3133-42b5-4b1d-bb3f-f724be337551"},{"name":"Callback response when Submission Approved","id":"8e29a436-eefa-4dfd-909e-08cc9e0d92f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"approved\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"approved\",\n \"reason_codes\": [],\n \"location\": {\n \"name\": \"Retailer Name\",\n \"ref_id\": \"Retailer Ref Id\",\n \"image_url\": \"\",\n \"address_line_1\": \"Retailer Address Line 1\",\n \"address_line_2\": \"Retailer Address Line 2\",\n \"city\": \"Retailer City\",\n \"province\": \"Retailer Province/State\",\n \"postal_code\": \"Retailer Postal / Zip code\",\n \"country\": \"Retailer Counrty\",\n \"full_address\": \"Retailer Full Address\",\n \"phone_number\": \"Retailer Phone Number\"\n },\n \"summary\": {\n \"transaction_number\": \"Transaction Number\",\n \"sub_total\": \"Sub Total\",\n \"tax\": \"Tax Value\",\n \"total_amount\": \"Total Value\",\n \"payment_method\": \"Payment Method\",\n \"transaction_date\": \"Transaction Date\",\n \"normalized_transaction_date\": \"Transaction Date in yyyy-mm-dd format\",\n \"transaction_time\": \"Transaction Time\",\n \"receipt_type\": \"Printed\"\n },\n \"line_items\": [\n {\n \"line_item_name\": \"Item Name\",\n \"line_item_qty\": \"Item Qty\",\n \"line_item_price\": \"Item Price\",\n \"line_item_sku\": \"Item Sku No\",\n \"is_eligible\": false\n }\n ],\n \"eligible_line_item_count\": \"Eligible Item Count\",\n \"eligible_line_item_total\": \"Eligible Item Total\" \n }\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Receipt Verification will send post data to Callback url when Submission status changed to Approved.
\nyour-callback-url : Required | End point where Receipt Verification system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"03d947fe-e249-47d4-9186-c18f60df5f5b","name":"Calback success response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"approved\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ] ,\n \"files\": {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"approved\",\n \"reason_codes\": [],\n \"location\": {\n \"name\": \"Retailer Name\",\n \"ref_id\": \"Retailer Ref Id\",\n \"image_url\": \"\",\n \"address_line_1\": \"Retailer Address Line 1\",\n \"address_line_2\": \"Retailer Address Line 2\",\n \"city\": \"Retailer City\",\n \"province\": \"Retailer Province/State\",\n \"postal_code\": \"Retailer Postal / Zip code\",\n \"country\": \"Retailer Counrty\",\n \"full_address\": \"Retailer Full Address\",\n \"phone_number\": \"Retailer Phone Number\"\n },\n \"summary\": {\n \"transaction_number\": \"Transaction Number\",\n \"sub_total\": \"Sub Total\",\n \"tax\": \"Tax Value\",\n \"total_amount\": \"Total Value\",\n \"payment_method\": \"Payment Method\",\n \"transaction_date\": \"Transaction Date\",\n \"normalized_transaction_date\": \"Transaction Date in yyyy-mm-dd format\",\n \"transaction_time\": \"Transaction Time\",\n \"receipt_type\": \"Printed\"\n },\n \"line_items\": [\n {\n \"line_item_name\": \"Item Name\",\n \"line_item_qty\": \"Item Qty\",\n \"line_item_price\": \"Item Price\",\n \"line_item_sku\": \"Item Sku No\",\n \"is_eligible\": false\n }\n ],\n \"eligible_line_item_count\": \"Eligible Item Count\",\n \"eligible_line_item_total\": \"Eligible Item Total\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8e29a436-eefa-4dfd-909e-08cc9e0d92f7"},{"name":"Callback response when Submission Rejected","id":"9d872cd6-61b4-475e-989d-63a92c9fa856","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"rejected\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ],\n \"files\": {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"rejected\",\n \"revision_token\": \"Revision Token\",\n \"reason_codes\": [\n {\n \"field_key\": \"duplicate_submission\",\n \"field_label\": \"Duplicate submission\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Duplicate entry\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Soumission déjà envoyée\"\n }\n ]\n }\n ],\n \"location\": {\n \"name\": \"Retailer Name\",\n \"ref_id\": \"Retailer Ref Id\",\n \"image_url\": \"\",\n \"address_line_1\": \"Retailer Address Line 1\",\n \"address_line_2\": \"Retailer Address Line 2\",\n \"city\": \"Retailer City\",\n \"province\": \"Retailer Province/State\",\n \"postal_code\": \"Retailer Postal / Zip code\",\n \"country\": \"Retailer Counrty\",\n \"full_address\": \"Retailer Full Address\",\n \"phone_number\": \"Retailer Phone Number\"\n },\n \"summary\": {\n \"transaction_number\": \"Transaction Number\",\n \"sub_total\": \"Sub Total\",\n \"tax\": \"Tax Value\",\n \"total_amount\": \"Total Value\",\n \"payment_method\": \"Payment Method\",\n \"transaction_date\": \"Transaction Date\",\n \"normalized_transaction_date\": \"Transaction Date in yyyy-mm-dd format\",\n \"transaction_time\": \"Transaction Time\",\n \"receipt_type\": \"receipt\"\n },\n \"line_items\": [\n {\n \"line_item_name\": \"Item Name\",\n \"line_item_qty\": \"Item Qty\",\n \"line_item_price\": \"Item Price\",\n \"line_item_sku\": \"Item Sku No\",\n \"is_eligible\": false\n }\n ],\n \"eligible_line_item_count\": \"Eligible Item Count\",\n \"eligible_line_item_total\": \"Eligible Item Total\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Receipt Verification will send post data to Callback url when Submission status changed to Rejected.
\nyour-callback-url : Required | End point where Receipt Verification system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"8228ab2b-8b1a-4dde-bb87-81c9d78f805a","name":"Callback rejected response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"rejected\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ],\n \"files\": {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"rejected\",\n \"revision_token\": \"Revision Token\",\n \"reason_codes\": [\n {\n \"field_key\": \"duplicate_submission\",\n \"field_label\": \"Duplicate submission\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Duplicate entry\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Soumission déjà envoyée\"\n }\n ]\n }\n ],\n \"location\": {\n \"name\": \"Retailer Name\",\n \"ref_id\": \"Retailer Ref Id\",\n \"image_url\": \"\",\n \"address_line_1\": \"Retailer Address Line 1\",\n \"address_line_2\": \"Retailer Address Line 2\",\n \"city\": \"Retailer City\",\n \"province\": \"Retailer Province/State\",\n \"postal_code\": \"Retailer Postal / Zip code\",\n \"country\": \"Retailer Counrty\",\n \"full_address\": \"Retailer Full Address\",\n \"phone_number\": \"Retailer Phone Number\"\n },\n \"summary\": {\n \"transaction_number\": \"Transaction Number\",\n \"sub_total\": \"Sub Total\",\n \"tax\": \"Tax Value\",\n \"total_amount\": \"Total Value\",\n \"payment_method\": \"Payment Method\",\n \"transaction_date\": \"Transaction Date\",\n \"normalized_transaction_date\": \"Transaction Date in yyyy-mm-dd format\",\n \"transaction_time\": \"Transaction Time\",\n \"receipt_type\": \"receipt\"\n },\n \"line_items\": [\n {\n \"line_item_name\": \"Item Name\",\n \"line_item_qty\": \"Item Qty\",\n \"line_item_price\": \"Item Price\",\n \"line_item_sku\": \"Item Sku No\",\n \"is_eligible\": false\n }\n ],\n \"eligible_line_item_count\": \"Eligible Item Count\",\n \"eligible_line_item_total\": \"Eligible Item Total\" \n }\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9d872cd6-61b4-475e-989d-63a92c9fa856"},{"name":"Callback response when Submission on Hold","id":"77e7f8c3-561d-4329-85a8-ea3f8023c5d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"hold\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ],\n \"files\": {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"hold\",\n \"reason_codes\": [\n {\n \"field_key\": \"Fraud_detection_AI_generated\",\n \"field_label\": \"Fraud detection AI generated\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Fraud detection AI generated.\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Fraude générée par l'IA détectée.\"\n }\n ]\n }\n ],\n \"location\": {\n \"name\": \"Retailer Name\",\n \"ref_id\": \"Retailer Ref Id\",\n \"image_url\": \"\",\n \"address_line_1\": \"Retailer Address Line 1\",\n \"address_line_2\": \"Retailer Address Line 2\",\n \"city\": \"Retailer City\",\n \"province\": \"Retailer Province/State\",\n \"postal_code\": \"Retailer Postal / Zip code\",\n \"country\": \"Retailer Counrty\",\n \"full_address\": \"Retailer Full Address\",\n \"phone_number\": \"Retailer Phone Number\"\n },\n \"summary\": {\n \"transaction_number\": \"Transaction Number\",\n \"sub_total\": \"Sub Total\",\n \"tax\": \"Tax Value\",\n \"total_amount\": \"Total Value\",\n \"payment_method\": \"Payment Method\",\n \"transaction_date\": \"Transaction Date\",\n \"normalized_transaction_date\": \"Transaction Date in yyyy-mm-dd format\",\n \"transaction_time\": \"Transaction Time\",\n \"receipt_type\": \"receipt\"\n },\n \"line_items\": [\n {\n \"line_item_name\": \"Item Name\",\n \"line_item_qty\": \"Item Qty\",\n \"line_item_price\": \"Item Price\",\n \"line_item_sku\": \"Item Sku No\",\n \"is_eligible\": false\n }\n ],\n \"eligible_line_item_count\": \"Eligible Item Count\",\n \"eligible_line_item_total\": \"Eligible Item Total\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Receipt Verification will send post data to Callback url when Submission status changed to Rejected.
\nyour-callback-url : Required | End point where Receipt Verification system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"aad93c4b-50ba-4953-8318-87eaeeee92fd","name":"Callback rejected response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"hold\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ],\n \"files\": {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"hold\",\n \"reason_codes\": [\n {\n \"field_key\": \"Fraud_detection_AI_generated\",\n \"field_label\": \"Fraud detection AI generated\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Fraud detection AI generated.\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Fraude générée par l'IA détectée.\"\n }\n ]\n }\n ],\n \"location\": {\n \"name\": \"Retailer Name\",\n \"ref_id\": \"Retailer Ref Id\",\n \"image_url\": \"\",\n \"address_line_1\": \"Retailer Address Line 1\",\n \"address_line_2\": \"Retailer Address Line 2\",\n \"city\": \"Retailer City\",\n \"province\": \"Retailer Province/State\",\n \"postal_code\": \"Retailer Postal / Zip code\",\n \"country\": \"Retailer Counrty\",\n \"full_address\": \"Retailer Full Address\",\n \"phone_number\": \"Retailer Phone Number\"\n },\n \"summary\": {\n \"transaction_number\": \"Transaction Number\",\n \"sub_total\": \"Sub Total\",\n \"tax\": \"Tax Value\",\n \"total_amount\": \"Total Value\",\n \"payment_method\": \"Payment Method\",\n \"transaction_date\": \"Transaction Date\",\n \"normalized_transaction_date\": \"Transaction Date in yyyy-mm-dd format\",\n \"transaction_time\": \"Transaction Time\",\n \"receipt_type\": \"receipt\"\n },\n \"line_items\": [\n {\n \"line_item_name\": \"Item Name\",\n \"line_item_qty\": \"Item Qty\",\n \"line_item_price\": \"Item Price\",\n \"line_item_sku\": \"Item Sku No\",\n \"is_eligible\": false\n }\n ],\n \"eligible_line_item_count\": \"Eligible Item Count\",\n \"eligible_line_item_total\": \"Eligible Item Total\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"77e7f8c3-561d-4329-85a8-ea3f8023c5d8"},{"name":"Revision submission file - RV","id":"1e34d07f-9f8c-441b-b719-a6bce6dc01fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"app-token","value":"{{app_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref_id\": \"Submission Ref Id\",\r\n \"files\": [\r\n {\r\n \"ref_id\": \"Submission File Ref Id\",\r\n \"file_url\": \"Full URL for Revise Submission File\",\r\n \"revision_token\":\"Submission File Revise Token\" // Optinal in case you want to add new file in submission \r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/apps/submissions/files/revision","description":"API Call to send revise submission files to existing submission for Retail Verification program
\nExplanation For Request Variables
ref_id : Required | Max Length 36 | String | Unique Value to Refrence Submission
files: Submission File Array | Allow multiple files in single submission
{
ref_id: Required | Max Length 36 | String | Unique Value to Refrence Submission File ID
file_url: Required | Max Length 255 | String | Full URL of Submission File including http protocol and file extension
revision_token : Optional | Max Length 255 | String | if you want to revise existing submission file then you need to pass these value which you get from reject callback
}
This developer-facing document outlines the integration instructions to be able push Entry and Receipt data to the GOcxm Receipt Verification Service and the returned responses.
\n","_postman_id":"d70c4b00-0869-4856-8efa-7475763a648b"},{"name":"Retail Goverance","item":[{"name":"Create a new submission","id":"daea9f46-ae23-4dac-90e1-ec3349413515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"app-token","value":"{{app_token}}","description":"required
\n"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Contact Email\",\n \"contact_phone\": \"Submission Contact Phone\",\n \"files\": [\n {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\", \n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ] \n }\n ],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ] \n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/apps/submissions","description":"API Call to send submission to Retail Goverance
\nExplanation For Request Variables
ref_id : Required | Max Length 36 | String | Unique Value to Refrence Submission
user_ref_id : Optional | Max Length 36 | String | User Refernce for Submission
contact_email: Optional | Max Length 255 | String | Submission Email
contact_phone: Optional | Max Length 50 | String | Submission Phone
files: Submission File Array | Allow multiple files in single submission
{
ref_id: Required | Max Length 36 | String | Unique Value to Refrence Submission File ID
file_url: Required | Max Length 255 | String | Full URL of Submission File including http protocol and file extension
other_data: Optional | JSON | Submission file related data
}
\nother_data: Optional | JSON | Submission related data which can be used to send back on callback data
\n","urlObject":{"path":["api","v1","apps","submissions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5e9405a8-d2dc-463c-80a7-e01976d69358","name":"create a new submission","originalRequest":{"method":"POST","header":[{"key":"app-token","value":"AppTokenByGocxm","description":"required","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Contact Email\",\n \"contact_phone\": \"Submission Contact Phone\",\n \"files\": [\n {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ]\n }\n ],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/apps/submissions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"1.0.0\",\n \"msg\": \"submission created\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"files\": 1\n}"}],"_postman_id":"daea9f46-ae23-4dac-90e1-ec3349413515"},{"name":"Callback response when Submission In Review","id":"44e8302f-2403-47c0-a26d-d18bdd85993a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"in_review\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": [{\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"valid\",\n \"reason_codes\": [],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entity Name\",\n \"entity_fields\": [ \n { \n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ] \n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Retail Goverance will send post data to Callback url when Submission in Progress
\nyour-callback-url : Required | End point where Retail Goverance system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"c85c38d7-42c5-4c51-97b1-fa06cbf7908f","name":"Calback in_review response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"in_review\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": [{\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"Submission File Status\",\n \"reason_codes\": [],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entity Name\",\n \"entity_fields\": [ \n { \n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ] \n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"44e8302f-2403-47c0-a26d-d18bdd85993a"},{"name":"Callback response when Submission Approved","id":"7952ab74-fd08-40f3-8ab5-cdefa06e751f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"approved\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": [{\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"approved\",\n \"reason_codes\": [],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entity Name\",\n \"entity_fields\": [ \n { \n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ] \n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Retail Goverance will send post data to Callback url when Submission status changed to Approved.
\nyour-callback-url : Required | End point where Retail Goverance system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"06444d05-4bd9-44c6-a4ff-5ae4d4a36ff2","name":"Calback success response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"approved\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": [{\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"approved\",\n \"reason_codes\": [],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entity Name\",\n \"entity_fields\": [ \n { \n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ] \n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7952ab74-fd08-40f3-8ab5-cdefa06e751f"},{"name":"Callback response when Submission Rejected","id":"9af2131c-282c-4b24-a6b2-25ed27910f66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"rejected\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"Key1\": \"Value 1\",\n \"Key2\": \"Value 2\"\n }\n ],\n \"files\": [\n {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"rejected\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"reason_codes\": [\n {\n \"field_key\": \"duplicate_submission\",\n \"field_label\": \"Duplicate submission\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Duplicate entry\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Soumission déjà envoyée\"\n }\n ]\n }\n ],\n \"revision_token\": \"Submission File Revision Token\",\n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entiry Name\",\n \"entity_fields\": [\n {\n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Retail Goverance will send post data to Callback url when Submission status changed to Rejected.
\nyour-callback-url : Required | End point where Retail Goverance system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"431d7901-5e8e-459b-8fc3-426f23e582ee","name":"Callback rejected response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"rejected\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": [{\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"rejected\",\n \"reason_codes\": [\n {\n \"field_key\": \"duplicate_submission\",\n \"field_label\": \"Duplicate submission\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Duplicate entry\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Soumission déjà envoyée\"\n }\n ]\n }\n ],\n \"revision_token\": \"Submission File Revision Token\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entity Name\",\n \"entity_fields\": [ \n { \n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ] \n }\n ] \n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9af2131c-282c-4b24-a6b2-25ed27910f66"},{"name":"Callback response when Submission on Hold","id":"3792bec8-e6bf-468b-af34-6f23275fd101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"hold\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"Key1\": \"Value 1\",\n \"Key2\": \"Value 2\"\n }\n ],\n \"files\": [\n {\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"hold\",\n \"reason_codes\": [\n {\n \"field_key\": \"Fraud_detection_AI_generated\",\n \"field_label\": \"Fraud detection AI generated\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Fraud detection AI generated.\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Fraude générée par l'IA détectée.\"\n }\n ]\n }\n ],\n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entiry Name\",\n \"entity_fields\": [\n {\n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"your-callback-url","description":"Retail Goverance will send post data to Callback url when Submission status changed to Rejected.
\nyour-callback-url : Required | End point where Retail Goverance system send data.
\n","urlObject":{"host":["your-callback-url"],"query":[],"variable":[]}},"response":[{"id":"e0d7fd7d-fdac-4558-9332-d33a3da610b2","name":"Callback rejected response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"hold\",\n \"ref_id\": \"Submission Ref Id\",\n \"user_ref_id\": \"Submission User Ref Id\",\n \"contact_email\": \"Submission Email\",\n \"contact_phone\": \"Submission Phone\",\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"files\": [{\n \"ref_id\": \"Submission File Ref Id\",\n \"file_url\": \"Full URL for Submission File\",\n \"status\": \"hold\",\n \"reason_codes\": [\n {\n \"field_key\": \"Fraud_detection_AI_generated\",\n \"field_label\": \"Fraud detection AI generated\",\n \"localization\": [\n {\n \"language\": \"en\",\n \"description\": \"Fraud detection AI generated.\"\n },\n {\n \"language\": \"fr\",\n \"description\": \"Fraude générée par l'IA détectée.\"\n }\n ]\n }\n ],\n \"other_data\": [\n {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n }\n ], \n \"retail_governance_summary\": [\n {\n \"entity_name\": \"Entity Name\",\n \"entity_fields\": [ \n { \n \"field_key\": \"Field Key\",\n \"field_label\": \"Field Label\",\n \"field_type\": \"Field Type\",\n \"field_value\": \"Field Value\"\n }\n ] \n }\n ] \n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"your-callback-url"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3792bec8-e6bf-468b-af34-6f23275fd101"},{"name":"Revision submission file - RG","id":"f92bb2a7-a582-4088-aaee-bb0f89564177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"app-token","value":"{{app_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref_id\": \"Submission Ref Id\",\r\n \"files\": [\r\n {\r\n \"ref_id\": \"Submission File Ref Id\",\r\n \"file_url\": \"Full URL for Submission File\" ,\r\n \"revision_token\": \"Revision Token for Submission File\", // Optinal in case you want to add new file in submission \r\n \"other_data\": [ \r\n {\r\n \"key1\": \"value 1\",\r\n \"key2\": \"value 2\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"other_data\": [ //Optional, pass it im case you like to update other_data for submission\r\n {\r\n \"key1\": \"value 1\",\r\n \"key2\": \"value 2\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/apps/submissions/files/revision","description":"API Call to send revise submission files to existing submission for Retail Goverance program
\nExplanation For Request Variables
ref_id : Required | Max Length 36 | String | Unique Value to Refrence Submission
files: Submission File Array | Allow multiple files in single submission
{
ref_id: Required | Max Length 36 | String | Unique Value to Refrence Submission File ID
file_url: Required | Max Length 255 | String | Full URL of Submission File including http protocol and file extension
revision_token : Optional | Max Length 255 | String | if you want to revise existing submission file then you need to pass these value which you get from reject callback
}
This developer-facing document outlines the integration instructions to be able push Entry and document data to the GoCXM - Retail Governance API Service and the returned responses.
\n","_postman_id":"d6d6dc6c-8bd1-4985-8c50-30c479cab14c"}]}