","description":"**(Required)** Authenticated Person Role Code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 18 Jan 2021 19:30:41 GMT"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"codeMenu\": 6272,\n \"menuDescription\": \"makeFVOrder\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6273,\n \"menuDescription\": \"consultaFVStock\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6274,\n \"menuDescription\": \"FV indicators\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6275,\n \"menuDescription\": \"sacFV\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6276,\n \"menuDescription\": \"FV news\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6277,\n \"menuDescription\": \"consultaFVTeam\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6278,\n \"menuDescription\": \"FVRequestslist\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6279,\n \"menuDescription\": \"indicateFVConsultor\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6280,\n \"menuDescription\": \"relatoriosDinamicosFV\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6281, \n \"menuDescription\": \"myFVRegistrationData\",\n \"codeApplication\": 42\n },\n {\n \"codeMenu\": 6282,\n \"menuDescription\": \"downloadsFV\",\n \"codeApplication\": 42\n }\n ]"}],"_postman_id":"bd5d3902-621a-411b-a4a9-69b774e6fc83"}],"id":"4f95a27f-d1c7-4032-93dc-d884fc38e197","description":"To register an application in Let, it is necessary to use the Application Manager.
\n The application manager is an API of Let responsible for managing third party applications that are added to the system.
\n To add an application, a schedule must be made, which can be for immediate execution of the deploy or for a desired date. It is also necessary a .zip file, containing a folder with the files referring to the application and also the manifesto.xml file, because this compressed file will be selected at the time of scheduling to deploy the application in **Let **.
\n The following types of files are allowed for using the application:
\n\n- Style:
css; \n- Script:
js; \n- Pages: html;
\n- Images:
gif, png, jpg, svg; \n- Fonts:
fnt, fon, ttc, ttf. \n
\n In the Application Manager it is possible to view a historical screen of the deploys that were made referring to a particular application. In it, information is available such as:
\n\n- Deployment execution date;
\n- Version;
\n- Deployment status;
\n- User who requested the deploy;
\n- File size.
\n
\n It is also possible to view the manifesto.xml file, download the application's .zip file, view errors - if any occur during deployment - and restore application versions.
\n There is also a scheduling screen, where similar information - referring to an application's deployment schedules - can be consulted and file downloads (manifesto.xml) can be made. In addition, in the appointments screen it is also possible to edit or cancel an appointment.
\n Finally, it is possible to exclude a specific application if it is no longer used.
\nManifest File:
\n It is mandatory that the package contains at its root a file called manifesto.xml. This file must contain basic information about the application, which will allow its configuration, and must be in accordance with the following layout:
\n<sgiapp manifestVersion=\"1.0\">\n<appIdentity name=\"appName\" version=\"1.0.0\" vendor=\"VendorName\" />\n<appDetails type=\"appType\" basepath=\"path/basefile.fil\">\n<secret>appsecret</secret>\n<apiUsage>\n<controller name=\"apiControllerName\" method=\"method\" />\n</apiUsage>\n<appParameters>\n<parameter name=\"appParameterName\" value=\"value\" />\n</appParameters>\n<refreshTokenLifeTime>refreshTokenLifeTime</refreshTokenLifeTime>\n<accessConfiguration>\n<functions>\n<function code=\"functionCode\" />\n</functions>\n</accessConfiguration>\n</appDetails>\n</sgiapp>\n
\n The highlighted items must be filled in according to the desired configuration for the application:
\n\nappName: application name;
\nVendorName: name of the person responsible for the application;
\nappType: indicates how the application should be loaded, and can assume the following values (The type of application (internal/external) must be consistent with the type of application indicated below: internalapplications can be of typefragment, fullorframeandexternalapplications can only beexternalApp.):
\nfragment: fragment of page loaded in space destined to pages in Let;
\nfull: page with full layout (using the entire window);
\ninternalFrame: page with layout loaded and referenced to an internal link in Let. Allows references to be relative to the application's base path;
\nexternalFrame: page with full layout loaded in a frame in the space reserved for Letpages;
\nexternalApp: external application to Let.
\npath/basefile.fil: path to the file or application home page, starting from the package root (.zip);
\nappSecret: character string to be used by Let to control access to the application. The secret is created automatically in the application creation operation; its filling in the manifest is optional: if it is informed, there will be a validation if the informed secret is valid;
\napiControllerNameandmethod: there must be a \"controller\" tag for each LetAPI control that the application uses together with the control name, the method that the application will use must also be informed ( GET/POST/PATCH);
\nappParameterNameandvalue: there must be a \"parameter\" tag for each parameter that must be passed from the application to Let. Must not contain the character “&�? in the name and not in the value of the parameter. It can only be used in fragmentandfullapplication types;
\nrefreshTokenLifeTime: application token refresh time information;
\nfunctionCode: there must be a \"function\" tag for each function that will be used to access the Let API.
\n
\nRegister Application
\n Access the Application Manager screen through the Processes menu -> Application Manager -> Application Registration
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_path.png\")
\n On the search screen, click on \"Search\"
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_pesquisar.png\")
\n On the results screen, click on \"+ Application\"
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_resultadoDaBusca.png\")
\n On the application registration screen, fill in the fields:
\n\nName: Application name;
\nNickname: Friendly name for the application. It will be used in the contract registration, to display the list of systems that can have a linked contract;
\nType: choose between options:
\nInternal – Version published within Let's menu;
\nExternal – Application to be called from outside Let, which will have access to Let's apis.
\nSituation: choose between the options:
\nInactive;
\nActivates;
\nSecret: auto-filled when saving functionality;
\nAuthentication method: Authentication method to be used by the application (In the case of internal applications and external applications already registered, this option is locked in the \"Authentication API\" type). If the chosen authentication method is \"GeraAD\", two new fields will appear:
\nAuthentication flow: determines the authentication flow to be used by GeraAD;
\nUse Facebook: Indicates if Facebook is used to login.
\nUse contract: Indicates if the application is enabled to use the contracts module. The Default option is No;
\n
\n *Temporary login lock: After a number of password errors, system locks;
\n\n- Force expired password: when the password expires, it will be necessary to change the password;
\n
\n *Permission name: name of the permission that will need to be assigned to users so that they can access the application;
\n In case of internal application:
\n\n- Menu option – Level 1: choose which level 1 menu where the application menu will be available;
\n
\n *Menu option – Level 2: choose which level 2 menu where the application menu will be available;
\n\nMenu option name – Portuguese: text that will be displayed in the application menu when Letlanguage is Portuguese;
\nMenu option name – Spanish: text that will be displayed in the application menu when Let language is Spanish;
\n
\n Menu option name – English: text that will be displayed in the application menu when*Let language is English;
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_cadastro_autenticacao_API.png\")
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_cadastro_autenticacao_geraAD.png\")
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_cadastro_aplicacao.png\")
\n After filling in the fields and clicking on the “Save” button, the “Secret” field will be automatically filled. When you return to the search page and perform a new search, the new application will appear in the list.
\nEdit Application
\n When clicking on “Edit application”, the registration screen will open, but with the “Type” and “Secret” fields blocked for alteration.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_editarAplicacao.png\")
\nSchedule Deploy
\n In the context menu referring to the desired functionality, click on the option “Schedule Deploy”.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_agendarDeploy.png\")
\n On the scheduling screen, select whether the deployment will be on a scheduled or immediate date.
\n\nScheduled Date: select the desired date and time in the “Deploy date” and “Time” fields, respectively;
\nImmediate: system fills the fields Deploy date and Time, with the current date and time.
\n
\n Click on the “Choose file” button, so you can select the .zip file that contains the application files and the manifesto.xml file.
\n![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_agendarDeploy_agendamento.png\")
\nExample manifesto.xml File
\n<sgiapp manifestVersion=\"1.0\">\n<appIdentity name=\"TesteInterna\" version=\"1.0.0\" vendor=\"RodrigoRosales\" />\n<appDetails type=\"fragment\" basepath=\"TesteInterna/teste.xml\">\n<secret>HX4UONOSISLSVRRXPWK3AEWBTBOIAX4I7MXWMNTW</secret>\n<apiUsage>\n<controller name=\"Orders\" method=\"GET\" />\n</apiUsage>\n<appParameters>\n<parameter name=\"ParametroTeste\" value=\"teste\" />\n</appParameters>\n<refreshTokenLifeTime>24:00:00</refreshTokenLifeTime>\n<accessConfiguration>\n<functions>\n<function code=\"1\" />\n</functions>\n</accessConfiguration>\n</appDetails>\n</sgiapp>\n
\n In the appIdentity tag, the name attribute must be the same name as the registered functionality and must not contain special characters.
\n The vendor attribute must not contain special characters.
\n The secret tag must include the data generated in the Secret field, on the functionality registration screen.
\n Observation
\n Every 15 minutes, batches are automatically run to validate the schedules made and to deploy the applications that have the schedule status as “Validated”, which has already arrived on the scheduled date.
\nView Schedules
\n In the context menu referring to the desired functionality, click on the option “View Schedules”.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_visualizarAgendamentos.png\")
\n On the scheduled deploys screen, the following information can be viewed:
\n\nDate: date for which the deployment was scheduled;
\nDeploy situation: 3 situations can be presented:
\nCreated;
\nValidated;
\nMistake.
\nRequester: user who made the appointment;
\nFile Size: file size selected at the time of scheduling;
\n
\n The following actions can be performed:
\n\nView Manifest: view the application's manifesto.xml file;
\nDownload: download the .zip file that was selected at the time of booking;
\nView Errors: View errors that occurred during the validation of the schedule.
\n
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_visualizarAgendamentos_deploysAgendados.png\")
\n Screen that shows processing errors, if any occur in the validation of the deployment schedule.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_visualizarAgendamentos_erros.png\")
\n In the context menu of the appointments, 2 options are displayed:
\n\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_visualizarAgendamentos_editarOuCancelar.png\")
\nView Update History
\n In the context menu referring to the desired functionality, click on the option “See update history”.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_historicoAtualizacoes.png\")
\n The history screen will only show information regarding the application's deployment execution; while the application is not deployed, no information will be shown. In the history screen, the information can be viewed:
\n\nDate: date on which the deployment process was executed;
\nVersion: application version number that was indicated in the manifest.xml file;
\nDeploy situation: 2 situations can be presented:
\nProcessed;
\nMistake.
\nChange: user who requested the deploy;
\nFile Size: size of the file selected at the time of scheduling;
\n
\n The following actions can be performed:
\n\nView Manifest: view the application's manifesto.xml file;
\nDownload: download the .zip file that was selected at the time of booking;
\nView Errors: view the errors that occurred during the validation of the schedule and the execution of the deploy.
\n
\n When more than one deployment has already been made for the same application, the context menu is enabled with the option \"Restore\" (in the lines of versions that are not marked as current in the column \"Version\"), which allows restoring the application to a version previous.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_restaurar.png\")
\nView Application
\n When the deploy is successfully executed, the application's menu is created in Let, in the path selected in the application's registration.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_visualizarAplicacao_path.png\")
\n By clicking on the menu, the application is opened as configured (fragment, full, frame or external).
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_visualizarAplicacao_aplicacao.png\")
\nDelete Application
\n In the context menu, click on \"Delete application\"
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_excluirAplicacao.png\")
\n A message will appear asking you to confirm the deletion.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_confirmacaoExclusao.png\")
\n When confirming the deletion, a message will appear stating that the functionality was successfully deleted. The application will no longer be displayed.
\n ![\"Application](\"https://geradev.blob.core.windows.net/images/en-Us/LetManagerApps_registroExcluido.png\")
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"eac5a9d8-05e0-4371-ba4c-540ada16df52"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3b9d14dd-3275-4a3d-9771-df471a3f19c8"}}],"_postman_id":"4f95a27f-d1c7-4032-93dc-d884fc38e197","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8b8899de-8115-43f0-aabf-c86985da7867","id":"8b8899de-8115-43f0-aabf-c86985da7867","name":"Authentication","type":"folder"}}}],"id":"8b8899de-8115-43f0-aabf-c86985da7867","description":"For all access to APIs and other integrations available through the Let platform, an authentication is required.
\n For such access, it is necessary to register your application and approve the requested access. The concept and standard authentication functionality of the Let APIs are described below.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"94f8583c-28f0-482b-87db-280cf76a4d23"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a78a712d-9f3b-479b-8a7d-c7c5dd0d3789"}}],"_postman_id":"8b8899de-8115-43f0-aabf-c86985da7867"},{"name":"Integrations","item":[{"name":"Standard Integration","item":[{"name":"import data","id":"03f70ecb-a696-45f9-8057-e2dfb5275647","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \nIN interface load content\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","urlObject":{"path":["servicos","integracao","padrao","IntegracaoPadraoWS.asmx"],"host":["{{host_webService}}"],"query":[],"variable":[]}},"response":[{"id":"5b2c684a-5084-4f77-9276-f81a08f006e7","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \nIN interface load content\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \n\r \nProcessing date (YYYY-MM-DDThh:mm:ss)\r \n\r \nDescription of the error found, if any\r \n\r \n\r \n\r \n\r \n"},{"id":"c2277339-5ca0-4d48-800a-8dadb8d1ee43","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \nIN interface load content\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\n\n\n\n\n20019-09-18T20:10:35\n\n\n\n\n\n\n"}],"_postman_id":"03f70ecb-a696-45f9-8057-e2dfb5275647"},{"name":"export data","id":"58cf0ed2-77ec-4751-bb5b-f94ed0ed8660","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ExportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \nOUT interface name\r \nInterface version\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","urlObject":{"path":["servicos","integracao","padrao","IntegracaoPadraoWS.asmx"],"host":["{{host_webService}}"],"query":[],"variable":[]}},"response":[{"id":"70999f65-2390-4442-958a-4708c0bc1d65","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ExportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \nOUT interface name\r \nInterface version\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \n\r \nProcessing date (YYYY-MM-DDThh:mm:ss)\r \nUnique caller ID\r \nOUT interface load content\r \nEncrypted ticket content\r \n\r \nDescription of the error found, if any\r \n\r \n\r \n\r \n\r \n"},{"id":"1149339c-08f2-4037-aedd-ae6c6fdc9067","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ExportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \nOUT interface name\r \nInterface version\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \n\r \n20019-09-18T20:10:35\r \n1234\r \nOUT interface load content\r \n\r \n\r \n\r \n\r \n\r \n\r \n\r \n"}],"_postman_id":"58cf0ed2-77ec-4751-bb5b-f94ed0ed8660"},{"name":"Add confirmation ticket","id":"a3e7c542-24df-48d3-a42a-4d343dfb54ad","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/AdicionaConfirmacao\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique call identification (same ticket code as previously sent)\r \n\r \n\r \nDocument identifier code\r \nDocument Status Code\r \nerror code\r \nError message\r \n\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","description":"This service is used to confirm the processing of data sent by LettoERP.
\n It is essential that it is executed after each data record sent by Let. Otherwise, Let will send exactly the same information.
\n This confirmation must always contain:
\n\n","urlObject":{"path":["servicos","integracao","padrao","IntegracaoPadraoWS.asmx"],"host":["{{host_webService}}"],"query":[],"variable":[]}},"response":[{"id":"50602031-1e9d-4e7a-b408-e57aa81dd019","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/AdicionaConfirmacao\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique call identification (same ticket code as previously sent)\r \n\r \n\r \nDocument identifier code\r \nDocument Status Code\r \nerror code\r \nError message\r \n\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \nIndicates whether information processing was successful\r \nProcessing date (YYYY-MM-DDThh:mm:ss)\r \n\r \nDescription of the error found, if any\r \n\r \n\r \n\r \n"},{"id":"8a9f1753-9a92-43aa-9cd8-1c294b4b4ca9","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/AdicionaConfirmacao\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique call identification (same ticket code as previously sent)\r \n\r \n\r \nDocument identifier code\r \nDocument Status Code\r \nerror code\r \nError message\r \n\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \ntrue\r \n20019-09-18T20:10:35\r \n\r \n\r \n\r \n\r \n\r \n"}],"_postman_id":"a3e7c542-24df-48d3-a42a-4d343dfb54ad"}],"id":"8706368b-8e25-4dde-887f-3c58b79b2c8e","_postman_id":"8706368b-8e25-4dde-887f-3c58b79b2c8e","description":""},{"name":"Input Interfaces","item":[{"name":"Material Product","item":[{"name":"material product v1.0","id":"acebb4a7-636c-4144-9c67-f1f3b2760320","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \n\r\n \r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n 123\r\n < ProductPurchaseType>1\r\n 123\r\n 123\r\n \r i>\n 1\r\n 1\r\n 1\r\n 1\r\n str1234\r\n str1234\r\n str1234 \r\n str1234\r\n 123\r\n 123\r\n 123\r\n str1234\r\n 1\r\n str1234\n 123\r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n str1234 \r\n 1\r\n 1\r\n 123.00\r\n 123.00\r\n 1\r\n 1\r\n 1234\n 1\r\n 1\r\n 1\r\n 1 \r\n 1234\r\n 1234\r\n 1\r\n 1\r\n 123123\r\n 123123123\r\n 123\r\n str1234< >123.00\r\n 1\r\n 123\r\n 123\n 123.00\r\n 1\r\n 1\r\n 123\r\n str1234\r\n \r
123.00\r\n 123.00\r\n 123.00\r\n \r \n str1234\r\n 123\r\n \r\n \r
\r\n \r\n 123\r\n \r\n \r \n \r\n 1\r\n 123\r\n \r\n \r\n \r\n \r\n 1\r\n 1\r \n 123\r\n 123\r\n 1\r\n < i>\n \r\n \r\n \r\n 123\r\n 123\r\n \r\n \r\n \r\n \r\n 123\r< \r\n \r\n \r\n \r\n 1\n str1234\r\n str1234\r\n \r\n \r< br> \r\n \r\n 123\r\n 1\r\n \r\n \r\n \r\n \n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","description":"This interface is used to import the records of a product material into Let.
\n\nProduct
\n A maximum of 25 Products are allowed
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductCod | \nInteger | \n9 | \nYes | \nProduct Code | \n
\n\nEANProduct | \nInteger | \n14 | \nNo | \nEAN Product Code | \n
\n\nName | \nString | \n100 | \nYes | \nProduct Name | \n
\n\nPurchase Multiple | \nInteger | \n9 | \nYes | \nPurchase Multiple | \n
\n\nProductPurchaseType | \nByte | \n2 | \nNo | \nDefault - 0 | \n
\n\nQtyClosedBoxUnits | \nInteger | \n9 | \nNo | \nIndicates the quantity of the product that completes an entire box | \n
\n\nQtyUnitsSuggestClosedBox | \nInteger | \n9 | \nNo | \nIf filled in, it indicates the missing amount needed for a suggestion to complete the box to be triggered. This parameter can only be used when the quantity per box is provided | \n
\n\nClosedBoxProductCode | \nInteger | \n9 | \nNo | \nField to optionally indicate a different product code that represents the closed-box product. If completed and the unopened box is completed, the item will be inserted into the order with this product code | \n
\n\nKit | \nByte | \n2 | \nYes | \nIndicates if the product is a KIT | \n
\n\nNotConsumeCredit | \nByte | \n2 | \nNo | \nIndicates whether the product will consume credits | \n
\n\nDisregardReorder | \nByte | \n2 | \nNo | \nDoes not allow the product to use Reorder | \n
\n\nDisregardProdProntMinima | \nByte | \n2 | \nNo | \nIndicates that the product will be considered in the capture for the calculation of the minimum score | \n
\n\nSummary Description | \nString | \n2000 | \nNo | \nSummary Product Description | \n
\n\nDescription | \nString | \n8000 | \nNo | \nProduct description | \n
\n\nTechnical Data | \nString | \n8000 | \nNo | \nProduct Datasheet | \n
\n\nTarget Publish | \nString | \n100 | \nNo | \nPublish product target | \n
\n\nLaunch Cycle | \nInteger | \n9 | \nYes | \nCycle in which the product will be launched(202013) . It must be a cycle previously registered in the system | \n
\n\nDiscontinuation Cycle | \nInteger | \n9 | \nNo | \nLast cycle in which the product will be available for capture(202014) . It must be a cycle previously registered in the system | \n
\n\nReorderLimit Campaign | \nInteger | \n9 | \nNo | \nCampaign limit for incorporating the product into the order | \n
\n\nKeyword | \nString | \n2000 | \nNo | \nList of keywords, separated by comma (,) | \n
\n\nAllowsUsePlanOrder | \nByte | \n2 | \nNo | \n | \n
\n\nProduct DisclosureMessage | \nString | \n2000 | \nNo | \nProduct disclosure message. When the parameter DivulgacaoDoProdutoCodAbrangencia is sent, it becomes mandatory | \n
\n\nProduct Disclosure Code Coverage | \nInteger | \n9 | \nNo | \nProduct disclosure coverage code. It must be of the Product Disclosure type and be previously registered in Let. When the parameter DivulgacaoDoProdutoMensagem is sent, it becomes mandatory | \n
\n\nMaterials | \nList of Objects of type Material | \n | \nYes | \nEach product can have n associated materials | \n
\n\nStructures | \nList of Objects of type Structure | \n | \nNo | \nProduct Structures | \n
\n\nTypes | \nList of Objects of type Type | \n | \nNo | \nProduct Type | \n
\n\nRelated | \nList of Objects of type Related | \n | \nNo | \nRelated Products (Substitutes or Complementary) | \n
\n\nValueRatings | \nList of Objects of type ValueRating | \n | \nNo | \nRating Groups | \n
\n\nSaleScopeRestrictions | \nList of objects of the type SaleScopeRestriction | \n | \nNo | \nSale restriction scopes | \n
\n\nLocking Reasons | \nList of Objects of type Locking Reason | \n | \nNo | \nClocking Reasons | \n
\n\nPayment Plans | \nList of Objects of type Standard Payment Plan | \n | \nNo | \nPayment Plans | \n
\n\n
\n
Material
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nCodMaterial | \nInteger | \n9 | \nYes | \nMaterial code (SKU) | \n
\n\nSKU Code | \nString | \n30 | \nYes | \nMaterial SKU Code (Material Key) | \n
\n\nEAN Code | \nString | \n14 | \nNo | \nMaterial EAN Code | \n
\n\nName | \nString | \n100 | \nYes | \nMaterial name | \n
\n\nType | \nByte | \n2 | \nYes | \nCode indicating the type of material Default - 1| 1 | Finished product | | 2 | Semi-finished product | | 3 | Feedstock | | 4 | Packaging |
| \n
\n\nCategory | \nByte | \n2 | \nNo | \nCode that indicates the category of the material. | \n
\n\nVolume | \nDecimal | \n(10, 2) | \nYes | \nVolume in milliliters | \n
\n\nWeight | \nDecimal | \n(10, 2) | \nYes | \nWeight in grams | \n
\n\nWeight PrecisionControl | \nByte | \n2 | \nYes | \nCode that indicates whether the material has weight precision control. Default - 0 | \n
\n\nUnit of Measure | \nByte | \n2 | \nYes | \nCode that indicates the unit of measure of the material.| 1 | Unit | | 2 | Box | | 3 | Grams | | 4 | milligrams | | 5 | milliliters | | 6 | Tray | | 7 | Set | | 8 | card | | 9 | Display | | 10 | Dozen | | 11 | Burden | | 12 | thousand | | 13 | Package | | 14 | Bowl |
| \n
\n\nBox Unit | \nInteger | \n9 | \nN/A | \nInformation that indicates how many units of material are included in each box. This parameter becomes mandatory when the value of the parameter Unit of Measure is 2 | \n
\n\nSuspended Sale | \nByte | \n2 | \nYes | \nCode that indicates if the sale of this material is suspended. Default - 0 | \n
\n\nSituation | \nByte | \n2 | \nYes | \nCode that indicates the status of the material. Default - 1 | \n
\n\nQuality Control | \nByte | \n2 | \nYes | \nCode that indicates whether the material has quality control. Default - 0 | \n
\n\nOrigin | \nByte | \n2 | \nYes | \nCode that indicates the origin of the material. Default - 0.| 0 | National | | 1 | Foreign - Direct import, except as indicated in code 7 | | 2 | Foreign - Purchased in the domestic market, except as indicated in code 7 | | 3 | National, merchandise or good with Import Content greater than 40% and less than or equal to 70% | | 4 | National, whose production has been made in accordance with the basic production processes dealt with in the legislation mentioned in the Adjustments | | 5 | National, merchandise or good with Import Content less than or equal to 40% | | 6 | Foreign - Direct import, without national similar, listed on CAMEX | | 7 | Foreign - Acquired in the domestic market, with no national similar on the CAMEX list | | 8 | National, merchandise or good with Import Content greater than 70% (Adjustment Sinief 15/2013 vig.01/08/2013) |
| \n
\n\nCountryOrigin | \nByte | \n2 | \nNo | \nCode that indicates the country of origin of the material.| 1 | Brazil | | 2 | Chile | | 3 | Argentina | | 4 | Peru | | 5 | Mexico | | 6 | Venezuela |
| \n
\n\nFiscal Classification | \nInteger | \n9 - (XXXX.XX.XX) | \nYes | \nTax classification of the material | \n
\n\nAccount Classification | \nByte | \n2 | \nNo | \nIndicates which account classification the material fits into.| 1 | Regular Products | | 2 | Samples | | 3 | Accessories | | 4 | Support Materials |
| \n
\n\nABC Rating | \nString | \n2 | \nNo | \nABC rating indicator of the material. Possible values: A, B, C | \n
\n\nLoteDeFabricacaoControleLote | \nByte | \n2 | \nNo | \nCode that indicates whether there will be control of the material's manufacturing lot. If so, what will be the method of batch consumption. Default - 0.| 0 | There will be no batch control | | 1 | FEFO | | 2 | FIFO | | 3 | LEFO | | 4 | LIFO |
| \n
\n\nFabricacaoBatchDaysExpiration Alert | \nInteger | \n9 | \nN/A | \nDays for batch expiration alert. It is mandatory if the Batch Control information is different from 0 | \n
\n\nLoteDeFabricacaoDiasUsoLote | \nInteger | \n9 | \nN/A | \nDays for batch expiration alert. It is mandatory if the Batch Control information is different from 0 | \n
\n\nLoteDeFabricacaoDiasRecusaLote | \nInteger | \n9 | \nN/A | \nExpiration days for batch rejection. It is mandatory if the Batch Control information is different from 0 | \n
\n\nFCINumber | \nString | \n36 | \nNo | \nThis information requires a specific format that must be validated. Used in operations in Brazil where imported materials are sold | \n
\n\nFCI Percent | \nDecimal | \n(8, 5) | \nNo | \nFCI import content percentage. Used in operations in Brazil where imported materials are sold | \n
\n\nPriority | \nByte | \n2 | \nYes | \nMaterial priority | \n
\n\nCodScope | \nInteger | \n9 | \nYes | \nScope code (It must be of the Sales x Material Relation type and be registered in Let | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of material | \n
\n\nPartDoItem | \nInteger | \n8.5 | \nYes | \nParticipation percentage of the item in the total value of the Kit. E.g.: 100 for 100% | \n
\n\nCropOption | \nByte | \n2 | \nNo | \nMandatory clipping option for Priority other than 1.| 1 | Incorporate item as donation | | 2 | Incorporate item as a purchase option | | 3 | Do not embed item |
| \n
\n\nUnavailabilityOption | \nByte | \n2 | \nYes | \nOption in case of material unavailability.| 1 | Cut Kit | | 2 | Ignore and discount value | | 3 | Incorporate sale and discount value | | 4 | Incorporate donation and collect value |
| \n
\n\nSubstitute Code | \nInteger | \n9 | \nYes | \nSubstitute material code | \n
\n\nStandardCost | \nDecimal | \n(18, 2) | \nYes | \nStandard cost of material | \n
\n\nAverage Cost | \nDecimal | \n(18, 2) | \nYes | \nAverage material cost | \n
\n\nLast Replacement Cost | \nDecimal | \n(18, 2) | \nYes | \nLast Replacement Cost of Material | \n
\n\nInitial StockStockCode | \nString | \n30 | \nNo | \nStock code, registered in Let as External Code of the Stock Center. This parameter is the key of the Stock Center | \n
\n\nInitial StockQuantity | \nInteger | \n9 | \nNo | \nAmount of material in stock. Only used for new materials; in case of updates, this value will be ignored | \n
\n\n
\n
Structure
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nStructureCode | \nInteger | \n9 | \nNo | \nProduct structure code [leaf level]. It must be from a product structure, previously registered in the system | \n
\n\n
\n
Product Type
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductType | \nByte | \n2 | \nYes | \nProduct type code.| 1 | Regular - Cosmetics | | 2 | Support material | | 3 | Special discount | | 4 | Gift | | 5 | Bazaar | | 6 | Pre launch | | 7 | no defined type | | 8 | Packaging | | 9 | Regular - Non-Cosmetic |
| \n
\n\nStart Cycle | \nInteger | \n9 | \nYes | \nProduct Classification Group start cycle. It must be a cycle previously registered in the system | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nRelationshipType | \nByte | \n2 | \nYes | \nType of relationship.| 1 | Complementary | | 2 | Substitute |
| \n
\n\nRelatedProductCod | \nInteger | \n9 | \nYes | \nRelated product code. It must be a product code previously registered in Let | \n
\n\nScope | \nInteger | \n9 | \nYes | \nScope of the relationship. It must be a scope of the Related Product type, previously registered in the system | \n
\n\nSelf-Relationship | \nByte | \n2 | \nNo | \nSelf-relationship product. | \n
\n\n
\n
Rating Group
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nClassificationGroupCod | \nInteger | \n9 | \nYes | \nClassification group code | \n
\n\nClassification Code | \nInteger | \n9 | \nYes | \nClassification code | \n
\n\n
\n
Sales Restriction
\n\nSale Scope Restriction
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nScopeCod | \nInteger | \n9 | \nYes | \nSell restriction scope code. It must be a scope of the Product Purchase Restriction type previously registered in the system | \n
\n\n
\n
Reason for Blocking
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nLanguage | \nByte | \n2 | \nYes | \nLanguage of the text.| 1 | Portuguese | | 2 | Spanish | | 3 | English |
| \n
\n\nSummary Blocking Reason | \nString | \n30 | \nYes | \nShort description of the reason for blocking the sale of the material. E.g.: In person, recipe | \n
\n\nFull Blocking Reason | \nString | \n30 | \nYes | \nDescription of the reason for blocking the sale of the material. E.g.: Only in person, for presentation of medical prescription | \n
\n\n
\n
Product Payment Plan
\n\nStandard Payment Plan
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPaymentPlanCod | \nInteger | \n9 | \nYes | \nProduct Payment Plan Code. It must be a payment plan previously registered in Let | \n
\n\nAllowsJoinPlots | \nByte | \n2 | \nYes | \nIndicates if the product can join the installments | \n
\n\n
\n
123.00\r\n 123.00\r\n 123.00\r\n \r \n str1234\r\n 123\r\n \r\n \r
\r\n \r\n 123\r\n \r\n \r \n \r\n 1\r\n 123\r\n \r\n \r\n \r\n \r\n 1\r\n 1\r \n 123\r\n 123\r\n 1\r\n < i>\n \r\n \r\n \r\n 123\r\n 123\r\n \r\n \r\n \r\n \r\n 123\r< \r\n \r\n \r\n \r\n 1\n str1234\r\n str1234\r\n \r\n \r< br> \r\n \r\n 123\r\n 1\r\n \r\n \r\n \r\n \n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \n\r \nProcessing date (YYYY-MM-DDThh:mm:ss)\r \n\r \nDescription of the error found, if any\r \n\r \n\r \n\r \n\r \n"},{"id":"d2c54796-f1a4-4434-aa6b-78f8c4c6414d","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \n\r\n \r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n 123\r\n < ProductPurchaseType>1\r\n 123\r\n 123\r\n \r i>\n 1\r\n 1\r\n 1\r\n 1\r\n str1234\r\n str1234\r\n str1234 \r\n str1234\r\n 123\r\n 123\r\n 123\r\n str1234\r\n 1\r\n str1234\n 123\r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n str1234 \r\n 1\r\n 1\r\n 123.00\r\n 123.00\r\n 1\r\n 1\r\n 1234\n 1\r\n 1\r\n 1\r\n 1 \r\n 1234\r\n 1234\r\n 1\r\n 1\r\n 123123\r\n 123123123\r\n 123\r\n str1234< >123.00\r\n 1\r\n 123\r\n 123\n 123.00\r\n 1\r\n 1\r\n 123\r\n str1234\r\n \r
123.00\r\n 123.00\r\n 123.00\r\n \r \n str1234\r\n 123\r\n \r\n \r
\r\n \r\n 123\r\n \r\n \r \n \r\n 1\r\n 123\r\n \r\n \r\n \r\n \r\n 1\r\n 1\r \n 123\r\n 123\r\n 1\r\n < i>\n \r\n \r\n \r\n 123\r\n 123\r\n \r\n \r\n \r\n \r\n 123\r< \r\n \r\n \r\n \r\n 1\n str1234\r\n str1234\r\n \r\n \r< br> \r\n \r\n 123\r\n 1\r\n \r\n \r\n \r\n \n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\n\n\n\n\n2021-07-29T13:07:48.8600801\n\n\n\n\n"}],"_postman_id":"acebb4a7-636c-4144-9c67-f1f3b2760320"},{"name":"material product v2.0","id":"c1ac8407-9e61-42cf-825d-22a6ef33bfe5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \n\r \n\r\n \r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n 123\r\n < ProductPurchaseType>1\r\n 123\r\n 123\r\n \r i>\n 1\r\n 1\r\n 1\r\n 1\r\n str1234\r\n str1234\r\n str1234 \r\n str1234\r\n 123\r\n 123\r\n 123\r\n str1234\r\n 1\r\n str1234\n 123\r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n str1234 \r\n 1\r\n 1\r\n 123.00\r\n 123.00\r\n 1\r\n 1\r\n 1234\n 1\r\n 1\r\n 1\r\n 1 \r\n 1234\r\n 1234\r\n 1\r\n 1\r\n 123123\r\n 123123123\r\n 123\r\n str1234< >123.00\r\n 1\r\n 123\r\n 123\n 123.00\r\n 1\r\n 1\r\n 123\r\n str1234\r\n \r
\r\n 123\r\n 123.00\r\n 123.00\r\n br> 123.00\r\n \r\n \r\n str1234\r\n 123\r\n \r\n \r\n \r\n \r< br> 123\r\n \r\n \r\n \r\n \r< br> 1\r\n 123\r\n \r\n \r\n \r\n \r\n 1\r\n 1\r\n 123 \r\n 1\r\n \r\n \r\n \r \n \r\n 123\r\n 123\r\n \r\n \r\n \r\n \r< br> 123\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 123\r\n 1\r\n \r\n \r\n \r\n \r\n 123\r\n \r\n \r\n \r\n \r\n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","description":"This interface is used to import the records of a product material into Let.
\n\nProduct
\n A maximum of 25 Products are allowed
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductCod | \nInteger | \n9 | \nYes | \nProduct Code | \n
\n\nEANProduct | \nInteger | \n14 | \nNo | \nEAN Product Code | \n
\n\nName | \nString | \n100 | \nYes | \nProduct Name | \n
\n\nPurchase Multiple | \nInteger | \n9 | \nYes | \nPurchase Multiple | \n
\n\nProductPurchaseType | \nByte | \n2 | \nNo | \nDefault - 0 | \n
\n\nQtyClosedBoxUnits | \nInteger | \n9 | \nNo | \nIndicates the quantity of the product that completes an entire box | \n
\n\nQtyUnitsSuggestClosedBox | \nInteger | \n9 | \nNo | \nIf filled in, it indicates the missing amount needed for a suggestion to complete the box to be triggered. This parameter can only be used when the quantity per box is provided | \n
\n\nClosedBoxProductCode | \nInteger | \n9 | \nNo | \nField to optionally indicate a different product code that represents the closed-box product. If completed and the unopened box is completed, the item will be inserted into the order with this product code | \n
\n\nKit | \nByte | \n2 | \nYes | \nIndicates if the product is a KIT | \n
\n\nNotConsumeCredit | \nByte | \n2 | \nNo | \nIndicates whether the product will consume credits | \n
\n\nDisregardReorder | \nByte | \n2 | \nNo | \nDoes not allow the product to use Reorder | \n
\n\nDisregardProdProntMinima | \nByte | \n2 | \nNo | \nIndicates that the product will be considered in the capture for the calculation of the minimum score | \n
\n\nSummary Description | \nString | \n2000 | \nNo | \nSummary Product Description | \n
\n\nDescription | \nString | \n8000 | \nNo | \nProduct description | \n
\n\nTechnical Data | \nString | \n8000 | \nNo | \nProduct Datasheet | \n
\n\nTarget Publish | \nString | \n100 | \nNo | \nPublish product target | \n
\n\nLaunch Cycle | \nInteger | \n9 | \nYes | \nCycle in which the product will be launched(202013) . It must be a cycle previously registered in the system | \n
\n\nDiscontinuation Cycle | \nInteger | \n9 | \nNo | \nLast cycle in which the product will be available for capture(202014) . It must be a cycle previously registered in the system | \n
\n\nReorderLimit Campaign | \nInteger | \n9 | \nNo | \nCampaign limit for incorporating the product into the order | \n
\n\nKeyword | \nString | \n2000 | \nNo | \nList of keywords, separated by comma (,) | \n
\n\nAllowsUsePlanOrder | \nByte | \n2 | \nNo | \n | \n
\n\nProduct DisclosureMessage | \nString | \n2000 | \nNo | \nProduct disclosure message. When the parameter DivulgacaoDoProdutoCodAbrangencia is sent, it becomes mandatory | \n
\n\nProduct Disclosure Code Coverage | \nInteger | \n9 | \nNo | \nProduct disclosure coverage code. It must be of the Product Disclosure type and be previously registered in Let. When the parameter DivulgacaoDoProdutoMensagem is sent, it becomes mandatory | \n
\n\nMaterials | \nList of Objects of type Material | \n | \nYes | \nEach product can have n associated materials | \n
\n\nStructures | \nList of Objects of type Structure | \n | \nNo | \nProduct Structures | \n
\n\nTypes | \nList of Objects of type Type | \n | \nNo | \nProduct Type | \n
\n\nRelated | \nList of Objects of type Related | \n | \nNo | \nRelated Products (Substitutes or Complementary) | \n
\n\nValueRatings | \nList of Objects of type ValueRating | \n | \nNo | \nRating Groups | \n
\n\nSaleScopeRestrictions | \nList of objects of the type SaleScopeRestriction | \n | \nNo | \nSale restriction scopes | \n
\n\nLocking Reasons | \nList of Objects of type Locking Reason | \n | \nNo | \nClocking Reasons | \n
\n\nPayment Plans | \nList of Objects of type Standard Payment Plan | \n | \nNo | \nPayment Plans | \n
\n\nDistributors | \nList of Objects of type Distributor | \n | \nNo | \nDistributors | \n
\n\n
\n
Material
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nCodMaterial | \nInteger | \n9 | \nYes | \nMaterial code (SKU) | \n
\n\nSKU Code | \nString | \n30 | \nYes | \nMaterial SKU Code (Material Key) | \n
\n\nEAN Code | \nString | \n14 | \nNo | \nMaterial EAN Code | \n
\n\nName | \nString | \n100 | \nYes | \nMaterial name | \n
\n\nType | \nByte | \n2 | \nYes | \nCode indicating the type of material Default - 1| 1 | Finished product | | 2 | Semi-finished product | | 3 | Feedstock | | 4 | Packaging |
| \n
\n\nCategory | \nByte | \n2 | \nNo | \nCode that indicates the category of the material. | \n
\n\nVolume | \nDecimal | \n(10, 2) | \nYes | \nVolume in milliliters | \n
\n\nWeight | \nDecimal | \n(10, 2) | \nYes | \nWeight in grams | \n
\n\nWeight PrecisionControl | \nByte | \n2 | \nYes | \nCode that indicates whether the material has weight precision control. Default - 0 | \n
\n\nUnit of Measure | \nByte | \n2 | \nYes | \nCode that indicates the unit of measure of the material.| 1 | Unit | | 2 | Box | | 3 | Grams | | 4 | milligrams | | 5 | milliliters | | 6 | Tray | | 7 | Set | | 8 | card | | 9 | Display | | 10 | Dozen | | 11 | Burden | | 12 | thousand | | 13 | Package | | 14 | Bowl |
| \n
\n\nBox Unit | \nInteger | \n9 | \nN/A | \nInformation that indicates how many units of material are included in each box. This parameter becomes mandatory when the value of the parameter Unit of Measure is 2 | \n
\n\nSuspended Sale | \nByte | \n2 | \nYes | \nCode that indicates if the sale of this material is suspended. Default - 0 | \n
\n\nSituation | \nByte | \n2 | \nYes | \nCode that indicates the status of the material. Default - 1 | \n
\n\nQuality Control | \nByte | \n2 | \nYes | \nCode that indicates whether the material has quality control. Default - 0 | \n
\n\nOrigin | \nByte | \n2 | \nYes | \nCode that indicates the origin of the material. Default - 0.| 0 | National | | 1 | Foreign - Direct import, except as indicated in code 7 | | 2 | Foreign - Purchased in the domestic market, except as indicated in code 7 | | 3 | National, merchandise or good with Import Content greater than 40% and less than or equal to 70% | | 4 | National, whose production has been made in accordance with the basic production processes dealt with in the legislation mentioned in the Adjustments | | 5 | National, merchandise or good with Import Content less than or equal to 40% | | 6 | Foreign - Direct import, without national similar, listed on CAMEX | | 7 | Foreign - Acquired in the domestic market, with no national similar on the CAMEX list | | 8 | National, merchandise or good with Import Content greater than 70% (Adjustment Sinief 15/2013 vig.01/08/2013) |
| \n
\n\nCountryOrigin | \nByte | \n2 | \nNo | \nCode that indicates the country of origin of the material.| 1 | Brazil | | 2 | Chile | | 3 | Argentina | | 4 | Peru | | 5 | Mexico | | 6 | Venezuela |
| \n
\n\nFiscal Classification | \nInteger | \n9 - (XXXX.XX.XX) | \nYes | \nTax classification of the material | \n
\n\nAccount Classification | \nByte | \n2 | \nNo | \nIndicates which account classification the material fits into.| 1 | Regular Products | | 2 | Samples | | 3 | Accessories | | 4 | Support Materials |
| \n
\n\nABC Rating | \nString | \n2 | \nNo | \nABC rating indicator of the material. Possible values: A, B, C | \n
\n\nLoteDeFabricacaoControleLote | \nByte | \n2 | \nNo | \nCode that indicates whether there will be control of the material's manufacturing lot. If so, what will be the method of batch consumption. Default - 0.| 0 | There will be no batch control | | 1 | FEFO | | 2 | FIFO | | 3 | LEFO | | 4 | LIFO |
| \n
\n\nFabricacaoBatchDaysExpiration Alert | \nInteger | \n9 | \nN/A | \nDays for batch expiration alert. It is mandatory if the Batch Control information is different from 0 | \n
\n\nLoteDeFabricacaoDiasUsoLote | \nInteger | \n9 | \nN/A | \nDays for batch expiration alert. It is mandatory if the Batch Control information is different from 0 | \n
\n\nLoteDeFabricacaoDiasRecusaLote | \nInteger | \n9 | \nN/A | \nExpiration days for batch rejection. It is mandatory if the Batch Control information is different from 0 | \n
\n\nFCINumber | \nString | \n36 | \nNo | \nThis information requires a specific format that must be validated. Used in operations in Brazil where imported materials are sold | \n
\n\nFCI Percent | \nDecimal | \n(8, 5) | \nNo | \nFCI import content percentage. Used in operations in Brazil where imported materials are sold | \n
\n\nPriority | \nByte | \n2 | \nYes | \nMaterial priority | \n
\n\nCodScope | \nInteger | \n9 | \nYes | \nScope code (It must be of the Sales x Material Relation type and be registered in Let | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of material | \n
\n\nPartDoItem | \nInteger | \n8.5 | \nYes | \nParticipation percentage of the item in the total value of the Kit. E.g.: 100 for 100% | \n
\n\nCropOption | \nByte | \n2 | \nNo | \nMandatory clipping option for Priority other than 1.| 1 | Incorporate item as donation | | 2 | Incorporate item as a purchase option | | 3 | Do not embed item |
| \n
\n\nUnavailabilityOption | \nByte | \n2 | \nYes | \nOption in case of material unavailability.| 1 | Cut Kit | | 2 | Ignore and discount value | | 3 | Incorporate sale and discount value | | 4 | Incorporate donation and collect value |
| \n
\n\nSubstitute Code | \nInteger | \n9 | \nYes | \nSubstitute material code | \n
\n\nDistribution Channel | \nInteger | \n9 | \nYes | \nDistribution channel code | \n
\n\nStandardCost | \nDecimal | \n(18, 2) | \nYes | \nStandard cost of material | \n
\n\nAverage Cost | \nDecimal | \n(18, 2) | \nYes | \nAverage material cost | \n
\n\nLast Replacement Cost | \nDecimal | \n(18, 2) | \nYes | \nLast Replacement Cost of Material | \n
\n\nInitial StockStockCode | \nString | \n30 | \nNo | \nStock code, registered in Let as External Code of the Stock Center. This parameter is the key of the Stock Center | \n
\n\nInitial StockQuantity | \nInteger | \n9 | \nNo | \nAmount of material in stock. Only used for new materials; in case of updates, this value will be ignored | \n
\n\n
\n
Structure
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nStructureCode | \nInteger | \n9 | \nNo | \nProduct structure code [leaf level]. It must be from a product structure, previously registered in the system | \n
\n\n
\n
Product Type
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductType | \nByte | \n2 | \nYes | \nProduct type code.| 1 | Regular - Cosmetics | | 2 | Support material | | 3 | Special discount | | 4 | Gift | | 5 | Bazaar | | 6 | Pre launch | | 7 | no defined type | | 8 | Packaging | | 9 | Regular - Non-Cosmetic |
| \n
\n\nStart Cycle | \nInteger | \n9 | \nYes | \nProduct Classification Group start cycle. It must be a cycle previously registered in the system | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nRelationshipType | \nByte | \n2 | \nYes | \nType of relationship.| 1 | Complementary | | 2 | Substitute |
| \n
\n\nRelatedProductCod | \nInteger | \n9 | \nYes | \nRelated product code. It must be a product code previously registered in Let | \n
\n\nScope | \nInteger | \n9 | \nYes | \nScope of the relationship. It must be a scope of the Related Product type, previously registered in the system | \n
\n\nSelf-Relationship | \nByte | \n2 | \nNo | \nSelf-relationship product. | \n
\n\n
\n
Rating Group
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nClassificationGroupCod | \nInteger | \n9 | \nYes | \nClassification group code | \n
\n\nClassification Code | \nInteger | \n9 | \nYes | \nClassification code | \n
\n\n
\n
Sales Restriction
\n\nSale Scope Restriction
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nScopeCod | \nInteger | \n9 | \nYes | \nSell restriction scope code. It must be a scope of the Product Purchase Restriction type previously registered in the system | \n
\n\n
\n
Reason for Blocking
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nLanguage | \nByte | \n2 | \nYes | \nLanguage of the text.| 1 | Portuguese | | 2 | Spanish | | 3 | English |
| \n
\n\nSummary Blocking Reason | \nString | \n30 | \nYes | \nShort description of the reason for blocking the sale of the material. E.g.: In person, recipe | \n
\n\nFull Blocking Reason | \nString | \n30 | \nYes | \nDescription of the reason for blocking the sale of the material. E.g.: Only in person, for presentation of medical prescription | \n
\n\n
\n
Product Payment Plan
\n\nStandard Payment Plan
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPaymentPlanCod | \nInteger | \n9 | \nYes | \nProduct Payment Plan Code. It must be a payment plan previously registered in Let | \n
\n\nAllowsJoinPlots | \nByte | \n2 | \nYes | \nIndicates if the product can join the installments | \n
\n\n
\n
Distributor
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDistributor Code | \nInteger | \n9 | \nYes | \nCode of the legal entity registered in Let | \n
\n\n
\n
\r\n 123\r\n 123.00\r\n 123.00\r\n br> 123.00\r\n \r\n \r\n str1234\r\n 123\r\n \r\n \r\n \r\n \r< br> 123\r\n \r\n \r\n \r\n \r< br> 1\r\n 123\r\n \r\n \r\n \r\n \r\n 1\r\n 1\r\n 123 \r\n 1\r\n \r\n \r\n \r \n \r\n 123\r\n 123\r\n \r\n \r\n \r\n \r< br> 123\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 123\r\n 1\r\n \r\n \r\n \r\n \r\n 123\r\n \r\n \r\n \r\n \r\n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\n\n\n\n\nProcessing date (YYYY-MM-DDThh:mm:ss)\n\nDescription of the error found, if any\n\n\n\n\n"},{"id":"95d72815-aa15-4821-84d5-60dd6b2e685e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \n\r \n\r\n \r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n 123\r\n < ProductPurchaseType>1\r\n 123\r\n 123\r\n \r i>\n 1\r\n 1\r\n 1\r\n 1\r\n str1234\r\n str1234\r\n str1234 \r\n str1234\r\n 123\r\n 123\r\n 123\r\n str1234\r\n 1\r\n str1234\n 123\r\n \r\n \r\n 123\r\n str1234\r\n str1234\r\n str1234 \r\n 1\r\n 1\r\n 123.00\r\n 123.00\r\n 1\r\n 1\r\n 1234\n 1\r\n 1\r\n 1\r\n 1 \r\n 1234\r\n 1234\r\n 1\r\n 1\r\n 123123\r\n 123123123\r\n 123\r\n str1234< >123.00\r\n 1\r\n 123\r\n 123\n 123.00\r\n 1\r\n 1\r\n 123\r\n str1234\r\n \r
\r\n 123\r\n 123.00\r\n 123.00\r\n br> 123.00\r\n \r\n \r\n str1234\r\n 123\r\n \r\n \r\n \r\n \r< br> 123\r\n \r\n \r\n \r\n \r< br> 1\r\n 123\r\n \r\n \r\n \r\n \r\n 1\r\n 1\r\n 123 \r\n 1\r\n \r\n \r\n \r \n \r\n 123\r\n 123\r\n \r\n \r\n \r\n \r< br> 123\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 123\r\n 1\r\n \r\n \r\n \r\n \r\n 123\r\n \r\n \r\n \r\n \r\n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\n\n\n\n\n2021-07-29T13:07:48.8600801\n\n\n\n\n"}],"_postman_id":"c1ac8407-9e61-42cf-825d-22a6ef33bfe5"}],"id":"1793b289-e991-47bf-9a6e-4dcbe68e9158","_postman_id":"1793b289-e991-47bf-9a6e-4dcbe68e9158","description":""},{"name":"Product Structure","item":[{"name":"v1.0 product structure","id":"9869a8e3-d928-48c4-80e8-19e710173980","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \n\r \n\r\n \r\n \r\n \r\n 123\n str1234\r\n 1\r\n 1\r\n str1234 \r\n 1\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r< br> \r\n \r\n \r\n \r
\r\n \r\n \r\n \r\n 123\r \n str1234\r\n 1\r\n 1\r\n str1234< /Concept>\r\n 1\r\n 123\r\n 123\r\n \r
str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n < DescriptionLevel8>str1234\r\n str1234\r\n \r\n \r\n \r\n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","description":"This interface is used to import the records of a product structure into Let.
\n\nProduct Structure
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nView | \nList of Objects of type Structure | \n | \nYes | \nIt is used to register or upload a structure of the highest level | \n
\n\nStructure | \nList of Objects of type Structure | \n | \nYes | \nIt is used to register a structure below a view | \n
\n\n
\n
Structure
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nStructureCode | \nInteger | \n9 | \nYes | \nStructure Code | \n
\n\nName | \nString | \n100 | \nYes | \nStructure name | \n
\n\nAvailable Virtual Store | \nByte | \n2 | \nYes | \nCode that indicates whether the structure is available in the Virtual Store. | \n
\n\nSituation | \nByte | \n2 | \nYes | \nStructure status code. | \n
\n\nConcept | \nString | \n200 | \nYes | \nStructure description | \n
\n\nTypeAssociacaoProdutosVisao | \nByte | \n2 | \nYes | \n| 1 | single structure | | 2 | Multiple Structures |
| \n
\n\nParent Structure | \nInteger | \n9 | \nYes | \nParent structure code. Must not be filled when the structure in question is a View | \n
\n\nNumberLevels | \nInteger | \n9 | \nYes | \nNumber of hierarchy levels related to the structure in question. Must not be filled when the structure in question is a View | \n
\n\nDescriptionLevels | \nObject of type DescriptionLevels | \nN/A | \nYes | \nDescription of each hierarchy level. Must not be filled when the structure in question is a View | \n
\n\n
\n
Description of Levels
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDescriptionLevel1 | \nString | \n100 | \nYes | \nDescription of the first level of the structure | \n
\n\nDescriptionLevel2 | \nString | \n100 | \nYes | \nDescription of the second level of the structure | \n
\n\nDescriptionLevel3 | \nString | \n100 | \nYes | \nDescription of the third level of the structure | \n
\n\nDescriptionLevel4 | \nString | \n100 | \nYes | \nDescription of the fourth level of the structure | \n
\n\nDescriptionLevel5 | \nString | \n100 | \nYes | \nDescription of the fifth level of the structure | \n
\n\nDescriptionLevel6 | \nString | \n100 | \nYes | \nDescription of the sixth level of structure | \n
\n\nDescriptionLevel7 | \nString | \n100 | \nYes | \nDescription of the seventh level of the structure | \n
\n\nDescriptionLevel8 | \nString | \n100 | \nYes | \nDescription of the eighth level of the structure | \n
\n\nDescriptionLevel9 | \nString | \n100 | \nYes | \nDescription of the ninth level of the structure | \n
\n\n
\n
\r\n \r\n \r\n \r\n 123\r \n str1234\r\n 1\r\n 1\r\n str1234< /Concept>\r\n 1\r\n 123\r\n 123\r\n \r
str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n < DescriptionLevel8>str1234\r\n str1234\r\n \r\n \r\n \r\n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\r \n\r \n\r \n\r \n\r \nProcessing date (YYYY-MM-DDThh:mm:ss)\r \n\r \nDescription of the error found, if any\r \n\r \n\r \n\r \n\r \n"},{"id":"e59d7a0f-fd7d-494b-825c-9aac516b2987","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"},{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ImportarDados\"","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \ninterface name\r \nInterface version\r \nUnique caller ID\r \n\r \n\r\n \r\n \r\n \r\n 123\n str1234\r\n 1\r\n 1\r\n str1234 \r\n 1\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r< br> \r\n \r\n \r\n \r
\r\n \r\n \r\n \r\n 123\r \n str1234\r\n 1\r\n 1\r\n str1234< /Concept>\r\n 1\r\n 123\r\n 123\r\n \r
str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n str1234\r\n < DescriptionLevel8>str1234\r\n str1234\r\n \r\n \r\n \r\n ]]>\r \n\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"\n\n\n\n\n2021-07-29T13:07:48.8600801\n\n\n\n\n"}],"_postman_id":"9869a8e3-d928-48c4-80e8-19e710173980"}],"id":"cb30e52e-47fb-4449-84e3-fbb428c87fd0","_postman_id":"cb30e52e-47fb-4449-84e3-fbb428c87fd0","description":""}],"id":"c32698bb-5c9c-46ef-b97b-af526cd0d90d","_postman_id":"c32698bb-5c9c-46ef-b97b-af526cd0d90d","description":""},{"name":"Output Interfaces","item":[{"name":"Request","item":[{"name":"Order v2.1","id":"4de133e2-eaea-41e9-b238-f455549b9097","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"SOAP Action","value":"\"http://www.geravd.com.br/ExportarDados\"","type":"text"},{"key":"Content-Type","value":"text/xml; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"\r \n\r \n\r \n\r \nAuthentication token configured\r \nOUT interface name\r \nInterface version\r \n\r \n\r \n","options":{"raw":{"language":"xml"}}},"url":"{{host_webService}}/servicos/integracao/padrao/IntegracaoPadraoWS.asmx","description":"This interface is used to export the records of a Let order.
\n\nRequest
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \nYes | \nEntity export control document code - in this case, the order | \n
\n\nOrderCode | \nInteger | \n9 | \nYes | \nOrder code. This field is the key of the order | \n
\n\nCommercialSituation | \nByte | \n2 | \nYes | \nCode that indicates the commercial status of the order.| 1 | fundraising | | 2 | Called off | | 3 | In separation | | 4 | Pending | | 5 | On carriage | | 6 | Delivered | | 7 | Reserved | | 8 | Approved |
| \n
\n\nFiscal Status | \nByte | \n2 | \nYes | \nCode that indicates the tax status of the order.| 1 | Not Billed | | 2 | Invoice Issued | | 3 | Canceled Invoice | | 4 | Returned Invoice | | 5 | Available for Billing | | 6 | Donation Document Issued | | 7 | Transference request |
| \n
\n\nCampaign | \nInteger | \nAAAACC | \nYes | \nOrder creation campaign. E.g.: 201403 | \n
\n\nMarketing Campaign | \nInteger | \nAAAACC | \nYes | \nOrder marketing campaign. E.g.: 201402 | \n
\n\nIndicator Campaign | \nInteger | \nAAAACC | \nNo | \nOrder \"indicator\" campaign - campaign in which it is considered for indicators (Billing). E.g.: 201404 | \n
\n\nFunction | \nString | \n50 | \nYes | \nName of the Function considered to capture the order | \n
\n\nPaper | \nString | \n50 | \nYes | \nName of the Paper considered for capturing the order | \n
\n\nDistribution Center | \nString | \n100 | \nYes | \nExternal code defined in the registration of the Distribution Center. If not filled in, the Distribution Center Name will be used | \n
\n\nDistributionCenterType | \nByte | \n2 | \nYes | \nCode that indicates the type of Distribution Center.| 1 | CD/PA | | 2 | Physical Store/Service Center |
| \n
\n\nInvoicing Distribution Center | \nString | \n100 | \nYes | \nExternal code defined in the registration of the Distribution Center and considered in the billing. If not filled in, the Distribution Center Name will be used | \n
\n\nOrder DateTime | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \nYes | \nOrder date | \n
\n\nApproval DateTime | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \nYes | \nOrder approval date | \n
\n\nAccount Account | \nObject of type AccountAccount | \n | \nYes | \nSection that contains the data of the ledger account used in the order capture | \n
\n\nMedium Capture | \nByte | \n2 | \nYes | \nCode that indicates the means of capturing the order.| 1 | Let Self Service | | 2 | Let Call Center | | 3 | Customer Service Request | | 4 | OrderReorder | | 5 | Virtual store | | 6 | Request EDI | | 7 | Refilling | | 8 | FV | | 9 | SV | | 11 | TransferDistributor | | 12 | Scheduled Purchase | | 13 | Service Center | | 14 | Physical store | | 15 | Consolidated Order | | 16 | LetLightAutoService | | 17 | LetLightCallCenter | | 18 | LetLightSV | | 19 | LetLightFV | | 20 | LetLight Physical Store | | 21 | LetLightCenterService | | 22 | LetLightMobileAutoService | | 23 | LetLightMobileCallCenter | | 24 | LetLightMobileSV | | 25 | LetLightMobileFV | | 26 | LetLightMobileLojaPhysica | | 27 | LetLightMobileCenterService | | 28 | SiteReseller | | 29 | External System | | 30 | LetAPI | | 31 | PDVAPI |
| \n
\n\nOrigin System | \nByte | \n2 | \nYes | \nCode that indicates the system of origin of the order.| 1 | let | | 2 | LetLight | | 3 | Virtual store | | 4 | External System | | 5 | LetSAC | | 6 | Consolidated Order | | 7 | API | | 8 | PDVAPI |
| \n
\n\nBusinessModelCode | \nInteger | \n9 | \nYes | \nBusinessModel Code. This field is the keyof the business model | \n
\n\nCommercialModel | \nString | \n100 | \nYes | \nBusiness model used and which defines the order capture rules | \n
\n\nVolume | \nDecimal | \n(10, 2) | \nYes | \nVolume in** milliliters** | \n
\n\nWeight | \nDecimal | \n(10, 2) | \nYes | \nWeight ingrams | \n
\n\nResidual Current Account Value | \nDecimal | \n(18, 2) | \nYes | \nResidual current account value applied to the order. It is the resulting balance between credits and debits, which can be positive or negative. If no checking account is linked to the order, this value will be zero | \n
\n\nExternal CodeDelivery Policy | \nInteger | \n | \nYes | \n | \n
\n\nDeliveryOption | \nString | \n | \nYes | \n | \n
\n\nOrder Delivery | \nObject of type Order Delivery | \n | \nYes | \nSection containing the order delivery data | \n
\n\nPersonaOrder | \nObject of type PersonaOrder | \n | \nYes | \nSection that contains some basic data to identify the person who placed the order | \n
\n\nOrder Items | \nList of objects of type Order Item | \n | \nYes | \nOrder Item List | \n
\n\nGoodies | \nList of objects of type Toast | \n | \nYes | \nList of freebies from the order | \n
\n\nCrop Items | \nList of objects of type Crop Item | \n | \nYes | \nList of cut items from order | \n
\n\nDistributionAmountsPayment | \nList of objects of type DistributionAmountsPayment | \n | \nYes | \nList of amounts to be paid for this order. Contains information even for orders paid with a single payment method, or with payment plans by product | \n
\n\n
\n
Account
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nAccount Code Code | \nInteger | \n9 | \nNo | \nG/L Account Code | \n
\n\nG/L Account | \nString | \n100 | \nNo | \nG/L Account Description | \n
\n\n
\n
Delivery
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDelivery Policy | \nString | \n100 | \nYes | \nExternal code defined in the registration of the Delivery Policy. If not filled in, the name of the Delivery Policy will be used | \n
\n\nDelivery Amount | \nDecimal | \n(18, 2) | \nNo | \nOrder delivery amount | \n
\n\nDeliveryCodeArea | \nString | \n15 | \nNo | \nDelivery address area code | \n
\n\nGeographic StructureLevel0 | \nString | \n100 | \nNo | \nBase Level of the Geographical Structure of the Delivery Address | \n
\n\nGeographic StructureLevel1 | \nString | \n100 | \nNo | \nFirst Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel2 | \nString | \n100 | \nNo | \nSecond Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel3 | \nString | \n100 | \nNo | \nThird Level Geographic Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel4 | \nString | \n100 | \nNo | \nFourth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel5 | \nString | \n100 | \nNo | \nFifth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel6 | \nString | \n100 | \nNo | \nSixth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel7 | \nString | \n100 | \nNo | \nSeventh Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel8 | \nString | \n100 | \nNo | \nEighth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel9 | \nString | \n100 | \nNo | \nNinth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nDelivery Number | \nString | \n10 | \nNo | \nDelivery address number | \n
\n\nDelivery Addendum | \nString | \n100 | \nNo | \nDelivery Address Addendum | \n
\n\nDeliveryReference | \nString | \n100 | \nNo | \nDelivery address reference | \n
\n\nScheduled Delivery Date | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \nNo | \nExpected delivery date at the time the order is merged. This date is updated throughout the life of the order; at the time of integration, it may be outdated. It should only serve as a basis, not being considered exact information | \n
\n\nDeliveryNeighbor | \nByte | \n2 | \nNo | \nCode that indicates whether the order can be delivered to a neighbor's address.| 1 | Does not authorize delivery | | 2 | Right Neighbor Delivery | | 3 | Left Neighbor Delivery |
| \n
\n\nDeliveryNumberNeighbor | \nString | \n10 | \nNo | \nNumber of the neighbor to which delivery was authorized | \n
\n\n
\n
People
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPerson Code | \nInteger | \n9 | \nYes | \nCode of the person registered in Let. This field is the person's key | \n
\n\nPersonName | \nString | \n100 | \nYes | \nInformation identifying the person.| Physical person | Name | | Legal person | Corporate Name |
| \n
\n\nPersonType | \nByte | \n2 | \nYes | \nCode indicating the person's type.| 1 | Physical person | | 2 | Legal person |
| \n
\n\nIdentification | \nString | \n20 | \nYes | \nDocument that identifies the person. Defined as the \"Main Document\" according to the type of person (CPF, CNPJ etc.) | \n
\n\nIdentificationType | \nByte | \n2 | \nYes | \nCode that identifies the document's type.| 1 | ID |
|---|
| 2 | CPF | | 3 | Voter Title | | 4 | CNH | | 5 | CNPJ | | 6 | State registration | | 7 | RUT - Chile | | 8 | CedulaCidadania - Colombia | | 9 | NIT - (Colombia | | 10 | PIS | | 11 | DNI - Argentina | | 12 | CUIT - Argentina (Unique Tax Identification Key) | | 13 | CUIT_PF - (CUIT used in PF registration) | | 14 | LC - Argentina (Libreta Civicas) | | 15 | CI - Argentina (ID Card) | | 16 | LE - Argentina (Libreta de Enrolamiento) | | 17 | DNI_PE - Peru (National Identity Document) | | 18 | Foreign Portfolio - Peru | | 19 | RUC - Peru (Unique Taxpayer Register) | | 20 | RUC_PF - Peru (RUC used in the PF registration) | | 21 | IFE - Mexico (IFE - Federal Electoral Institute) - Voter's Document | | 22 | PasaporteFM - Mexico (Passport or FM1/FM2 - Migration Document) | | 23 | RFC_PF - Mexico (Federal Taxpayers Registry) - PF | | 24 | RFC - Mexico (Federal Taxpayers Registry) - PJ | | 25 | OtherDoc1 - Mexico | | 26 | OtherDoc2 - Mexico | | 27 | CURP - Mexico | | 28 | CI_CIE - Bolivia |
| \n
\n\n
\n
Items
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nItemNumber | \nInteger | \n9 | \nYes | \nNumber that indicates the \"index\" of that item within the order. This number will not necessarily be sequential, nor will it be guaranteed that there will be no gaps without some number occurring. It is used to identify the item within the order and should not necessarily be used as a way of sequencing the items | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of units of this item in the order | \n
\n\nTablePrice | \nDecimal | \n(18, 2) | \nYes | \nUnitaryTable Price of this item | \n
\n\nPrice Practiced | \nDecimal | \n(18, 2) | \nYes | \nPrice Practicedunitof this item | \n
\n\nNetPrice | \nDecimal | \n(18, 2) | \nYes | \nNet Priceunit of this item | \n
\n\nCostPrice | \nDecimal | \n(18, 2) | \nYes | \nUnitaryCost Price of this item | \n
\n\nCommission Amount | \nDecimal | \n(18, 2) | \nYes | \nUnitary commission amount for this item | \n
\n\nAmount of Points | \nInteger | \n9 | \nYes | \nUnitary amount of points for this item. This field can be disregarded in case of configuration to use currency score (R$) | \n
\n\nKit | \nByte | \n2 | \nYes | \n| s | The item is a Kit |
|---|
| N | Item is not a Kit |
| \n
\n\nProductType | \nByte | \n2 | \nYes | \nCode that indicates the type of product in the order.| 1 | Regular Cosmetics |
|---|
| 2 | Support material | | 3 | Special discount | | 4 | Gift | | 5 | Bazaar | | 6 | Pre launch | | 7 | no type | | 8 | Packaging | | 9 | RegularNo Cosmetics |
| \n
\n\nProduct | \nObject of type Product - Item | \n | \nYes | \nSection containing the information of the product indicated by this order item | \n
\n\nAccountAccount | \nObject of type AccountAccount | \n | \nYes | \nSection that contains the data of the G/L account used specifically for the item, if there is such an association | \n
\n\n
\n
Gifts
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nGiftItemNumber | \nInteger | \n9 | \nYes | \nNumber that indicates the \"index\" of this gift within the order. This number will not necessarily be sequential, nor will it be guaranteed that there will be no gaps without some number occurring. It is used to identify the freebie within the order and should not necessarily be used as a form of sequencing the freebies | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of units of this gift in the order | \n
\n\nTable Price | \nDecimal | \n(18, 2) | \nYes | \nUnitaryTable Price of this gift | \n
\n\nCost Price | \nDecimal | \n(18, 2) | \nYes | \nunit price of this gift | \n
\n\nKit | \nByte | \n2 | \nYes | \n| s | The freebie is a kit |
|---|
| N | The freebie is not a kit |
| \n
\n\nProductType | \nByte | \n2 | \nYes | \nCode that indicates the type of product on the gift.| 1 | Regular Cosmetics |
|---|
| 2 | Support material | | 3 | Special discount | | 4 | Gift | | 5 | Bazaar | | 6 | Pre launch | | 7 | no type | | 8 | Packaging | | 9 | RegularNo Cosmetics |
| \n
\n\nProduct | \nObject of the type Product - Gift | \n | \nYes | \nSection containing the information of the product indicated by this order gift | \n
\n\nPromotion | \nObject of type Promotion | \n | \nYes | \nSection containing the promotion information related to the gift | \n
\n\nAccount Account | \nObject of type AccountAccount | \n | \nYes | \nSection containing the data of the ledger account used specifically for the gift, if such association exists | \n
\n\n
\n
Clipped Items
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nTablePrice | \nDecimal | \n(18, 2) | \nYes | \nUnitaryTable Price of this item | \n
\n\nPrice Practiced | \nDecimal | \n(18, 2) | \nYes | \nPrice Practicedunit of this item | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of units cut from this item | \n
\n\nReasonCutOrderItem | \nByte | \n2 | \nYes | \nCode that indicates the reason for cutting this item.| 1 | Product Vision |
|---|
| 2 | Unregistered price | | 3 | Material not registered | | 4 | Quota Exhausted | | 5 | Insufficient stock | | 6 | Suspense Sale | | 7 | Credit Limit Exceeded | | 8 | Discontinued product | | 9 | Stock Separation | | 10 | Quota per Out of Person | | 11 | Incomplete Product Registration | | 12 | Insufficient Physical Stock | | 13 | Donation not allowed | | 14 | Stock Separation Adjustment | | 15 | Stock Separation Adjustment Incorporated | | 16 | Substitute Separation Stock | | 18 | Conditional Sale Limit | | 19 | Non-existent External System Registration | | 20 | Product in Quotas | | 21 | Non-Belonging Product Seller Portfolio |
| \n
\n\nProduct | \nObject of type Product - Cut Item | \n | \nYes | \nSection containing the information of the product indicated by this order item | \n
\n\n
\n
Distribution of Payment Amounts
\n\nDistribution Amounts Payment
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPaymentPlanCode | \nString | \n30 | \nYes | \nExternal payment plan code | \n
\n\nAmount | \nDecimal | \n(18, 2) | \nYes | \nBase amount to be paid through this payment plan. Does not include charge fee | \n
\n\nChargingRate | \nDecimal | \n(18, 2) | \nYes | \nCollection fee amount generated by choosing this payment plan | \n
\n\nFlagCode | \nString | \n20 | \nNo | \nRelevant only for card payments. External code of the card's flag. In the absence of an external code, send card description | \n
\n\nFlagType | \nByte | \n2 | \nNo | \nRelevant for card payments only. Flag type. | \n
\n\nAmount of Installments | \nInteger | \n2 | \nYes | \nAmount of installments selected for payment - either configured in the payment plan or chosen by the user, when paying via credit card | \n
\n\nOperatorAuthorizationCode | \nString | \n6 | \nNo | \nRelevant only for card payments. Card payment authorization code | \n
\n\n
\n
Products
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductCode | \nInteger | \n9 | \nYes | \nProduct code. This field is the key of the product | \n
\n\nProductName | \nString | \n100 | \nYes | \nProduct Name | \n
\n\nMaterials | \nList of objects of type Material - Item | \n | \nYes | \nList of materials that make up the product. It will be greater than 1 in case of kits or different priorities of materials in the same product | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductCode | \nInteger | \n9 | \nYes | \nProduct code. This field is the key of the product | \n
\n\nProductName | \nString | \n100 | \nYes | \nProduct Name | \n
\n\nMaterials | \nList of objects of type Material - Gift | \n | \nYes | \nList of materials that make up the product. It will be greater than 1 in case of kits or different priorities of materials in the same product | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductCode | \nInteger | \n9 | \nYes | \nProduct code. This field is the key of the product | \n
\n\nProductName | \nString | \n100 | \nYes | \nProduct Name | \n
\n\nMaterials | \nList of objects of type Material - Cut Item | \n | \nYes | \nList of materials that make up the product. It will be greater than 1 in case of kits or different priorities of materials in the same product | \n
\n\n
\n
Materials
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nMaterialSKU Code | \nString | \n30 | \nYes | \nSKU code of the material. This field is the key of the material | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of occurrences of this material in the product. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nTable Price | \nDecimal | \n(18, 2) | \nYes | \nUnitary Table Price of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nPrice Practiced | \nDecimal | \n(18, 2) | \nYes | \nPrice Practiced unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nNetPrice | \nDecimal | \n(18, 2) | \nNo | \nNet Price unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nCost Price | \nDecimal | \n(18, 2) | \nNo | \nUnit Cost Price of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nCommission Value | \nDecimal | \n(18, 2) | \nNo | \nunit commission value of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nMaterialSKU Code | \nString | \n30 | \nYes | \nSKU code of the material. This field is the key of the material | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of occurrences of this material in the product. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nTable Price | \nDecimal | \n(18, 2) | \nYes | \nUnitary Table Price of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nCost Price | \nDecimal | \n(18, 2) | \nNo | \nUnit Cost Price of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nMaterialSKU Code | \nString | \n30 | \nYes | \nSKU code of the material. This field is the key of the material | \n
\n\nQuantity | \nInteger | \n9 | \nYes | \nAmount of occurrences of this material in the product. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nTable Price | \nDecimal | \n(18, 2) | \nYes | \nUnitary Table Price of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nPrice Practiced | \nDecimal | \n(18, 2) | \nYes | \nPrice Practiced unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPromotionCode | \nInteger | \n9 | \nYes | \nPromotion Code | \n
\n\nPromotionName | \nString | \n100 | \nYes | \nPromotion Description | \n
\n\n
\n
This interface is used to export the records of a Let order.
\n\nRequest
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \n | \n | \n
\n\nOrderCode | \nInteger | \n | \n | \nOrder code. This field is the key of the order | \n
\n\nCommercial Situation | \nByte | \n | \n | \nCode that indicates the commercial status of the order. | \n
\n\nFiscal Status | \nByte | \n | \n | \nCode that indicates the tax status of the order. | \n
\n\nCampaign | \nInteger | \n | \n | \nOrder creation campaign. E.g.: 201403 | \n
\n\nMarketing Campaign | \nInteger | \n | \n | \nOrder marketing campaign. E.g.: 201402 | \n
\n\nIndicator Campaign | \nInteger | \n | \n | \nOrder \"indicator\" campaign - campaign in which it is considered for indicators (Billing). E.g.: 201404 | \n
\n\nFunction | \nString | \n | \n | \nName of the Function considered to capture the order | \n
\n\nPaper | \nString | \n | \n | \nName of the Paper considered for capturing the order | \n
\n\nDistribution Center | \nString | \n | \n | \nExternal code defined in the registration of the Distribution Center. If not filled in, the Distribution Center Name will be used | \n
\n\nDistribution CenterType | \nByte | \n | \n | \nCode that indicates the type of the Distribution Center. | \n
\n\nInvoicing Distribution Center | \nString | \n | \n | \nExternal code defined in the registration of the Distribution Center and considered in the billing. If not filled in, the Distribution Center Name will be used | \n
\n\nOrder DateTime | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \n | \nOrder Date | \n
\n\nApproval DateTime | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \n | \nOrder approval date | \n
\n\nAccountAccount | \nObject of type AccountAccount | \n | \n | \nSection that contains the data of the G/L account used in the capture of the order | \n
\n\nMedium Capture | \nByte | \n | \n | \nCode that indicates the means of capturing the order. | \n
\n\nOrigin System | \nByte | \n | \n | \nCode that indicates the system of origin of the order. | \n
\n\nBusinessModelCode | \nInteger | \n | \n | \nBusiness model code. This field is the keyof the business model | \n
\n\nCommercialModel | \nString | \n | \n | \nBusiness model used and that defines the order capture rules | \n
\n\nVolume | \nDecimal | \n | \n | \nVolume inmilliliters | \n
\n\nWeight | \nDecimal | \n | \n | \nWeight in grams | \n
\n\nResidual Current Account Value | \nDecimal | \n | \n | \nResidual current account value applied to the order. It is the resulting balance between credits and debits, which can be positive or negative. If no checking account is linked to the order, this value will be zero | \n
\n\nExternalCodePoliticaDelivery | \nInteger | \n | \n | \n | \n
\n\nDeliveryOption | \nString | \n | \n | \n | \n
\n\nOrder Delivery | \nObject of type Order Delivery | \n | \n | \nSection containing the order delivery data | \n
\n\nPersonaOrder | \nObject of type PersonaOrder | \n | \n | \nSection that contains some basic data to identify the person who placed the order | \n
\n\nOrder Items | \nList of objects of type Order Item | \n | \n | \nOrder Item List | \n
\n\nGoodies | \nList of objects of type Toast | \n | \n | \nList of freebies from the order | \n
\n\nCutItems | \nList of objects of type CutItem | \n | \n | \nList of cut items from order | \n
\n\nDistributionAmountsPayment | \nList of objects of type DistributionAmountsPayment | \n | \n | \n | \n
\n\n
\n
Account
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nAccount Code | \n | \n | \n | \nG/L Account Code | \n
\n\nAccount Account | \n | \n | \n | \nDescription of the G/L account | \n
\n\n
\n
Delivery
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDelivery Policy | \nString | \n | \n | \nExternal code defined in the registration of the Delivery Policy. If not filled in, the name of the Delivery Policy will be used | \n
\n\nDelivery Amount | \nDecimal | \n | \n | \nOrder Delivery Amount | \n
\n\nDeliveryCodeArea | \nString | \n | \n | \nDelivery address area code | \n
\n\nGeographic StructureLevel0 | \nString | \n | \n | \nBase Level of the Geographical Structure of the Delivery Address | \n
\n\nGeographic StructureLevel1 | \nString | \n | \n | \nFirst Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel2 | \nString | \n | \n | \nSecond Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel3 | \nString | \n | \n | \nThird Level Geographic Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel4 | \nString | \n | \n | \nFourth Level Geographic Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel5 | \nString | \n | \n | \nFifth Level of Structure Shipping Address Geographic (if any) | \n
\n\nGeographic StructureLevel6 | \nString | \n | \n | \nSixth Level Geographic Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel7 | \nString | \n | \n | \nSeventh Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel8 | \nString | \n | \n | \nEighth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nGeographic StructureLevel9 | \nString | \n | \n | \nNinth Level of the Geographical Structure of the Delivery Address (if any) | \n
\n\nDeliveryNumber | \nString | \n | \n | \nDelivery address number | \n
\n\nDeliveryAdd-on | \nString | \n | \n | \nDelivery address add-on | \n
\n\nDeliveryReference | \nString | \n | \n | \nDelivery address reference | \n
\n\nDatePrevisaoDelivery | \ndateTime | \n | \n | \nExpected delivery date at the time the order is integrated. This date is updated throughout the life of the order; at the time of integration, it may be outdated. It should only serve as a basis, not being considered exact information | \n
\n\nDeliveryNeighbor | \nByte | \n | \n | \nCode that indicates whether the order can be delivered to a neighbor's address | \n
\n\nDeliveryNumberNeighbor | \nString | \n | \n | \nNumber of the neighbor for which delivery was authorized | \n
\n\n
\n
People
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPerson Code | \nInteger | \n | \n | \nCode of the person registered in Let. This field is the person's key | \n
\n\nPersonName | \nString | \n | \n | \nInformation that identifies the person. | \n
\n\nPersonType | \nByte | \n | \n | \nCode that indicates the type of the person. | \n
\n\nIdentification | \nString | \n | \n | \nDocument that identifies the person. Defined as the \"Main Document\" according to the type of person (CPF, CNPJ etc.) | \n
\n\nIdentificationType | \nByte | \n | \n | \nCode that identifies the document's type. | \n
\n\n
\n
Items
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nItemNumber | \nInteger | \n | \n | \nNumber that indicates the \"index\" of that item within the order. This number will not necessarily be sequential, nor will it be guaranteed that there will be no gaps without some number occurring. It is used to identify the item within the order and should not necessarily be used as a way of sequencing the items | \n
\n\nQuantity | \nInteger | \n | \n | \nAmount of units of this item in the order | \n
\n\nTablePrice | \nDecimal | \n | \n | \nTable Price unitof this item | \n
\n\nPrice Practiced | \nDecimal | \n | \n | \nPrice Practicedunitof this item | \n
\n\nNetPrice | \nDecimal | \n | \n | \nNet Priceunit of this item | \n
\n\nCostPrice | \nDecimal | \n | \n | \nUnitCost Price of this item | \n
\n\nCommissionAmount | \nDecimal | \n | \n | \nCommission valueunit of this item | \n
\n\nAmount of Points | \nInteger | \n | \n | \nUnitary amount of points for this item. This field can be disregarded in case of configuration to use currency score (R$) | \n
\n\nKit | \nByte | \n | \n | \n[[TABLE]] | \n
\n\nProductType | \nByte | \n | \n | \nCode that indicates the type of product in the order. | \n
\n\nProduct | \nObject of type Product | \n | \n | \nSection containing the information of the product indicated by this order item | \n
\n\nAccountAccount | \nObject of type AccountAccount | \n | \n | \nSection containing the data of the G/L account used specifically for the item, if such an association exists | \n
\n\n
\n
Gifts
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nGiftItemNumber | \nInteger | \n | \n | \nNumber that indicates the \"index\" of this gift within the order. This number will not necessarily be sequential, nor will it be guaranteed that there will be no gaps without some number occurring. It is used to identify the freebie within the order and should not necessarily be used as a form of sequencing the freebies | \n
\n\nQuantity | \nInteger | \n | \n | \nNumber of units of this gift in the order | \n
\n\nTable Price | \nDecimal | \n | \n | \nTable Price unitof this gift | \n
\n\nCost Price | \nDecimal | \n | \n | \nPrice Practicedunit of this gift | \n
\n\nKit | \nByte | \n | \n | \n[[TABLE]] | \n
\n\nProductType | \nByte | \n | \n | \nCode that indicates the type of product on the gift. | \n
\n\nProduct | \nObject of type Product | \n | \n | \nSection containing the information of the product indicated by this order gift | \n
\n\nPromotion | \nObject of type Promotion | \n | \n | \nSection containing the promotion information related to the gift | \n
\n\nAccount Account | \nObject of type AccountAccount | \n | \n | \nSection containing the data of the ledger account used specifically for the gift, if such association exists | \n
\n\n
\n
Clipped Items
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nTablePrice | \nDecimal | \n | \n | \nTable Price unitof this item | \n
\n\nPrice Practiced | \nDecimal | \n | \n | \nPrice Practicedunit of this item | \n
\n\nQuantity | \nInteger | \n | \n | \nAmount of units cut from this item | \n
\n\nReason CutItemOrder | \nByte | \n | \n | \nCode that indicates reason for cutting this item | \n
\n\nProduct | \nObject of type Product | \n | \n | \nSection containing the information of the product indicated by this order item | \n
\n\n
\n
Distribution of Payment Amounts
\n\nDistribution Amounts Payment
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPaymentPlanCode | \nString | \n | \n | \nPayment plan external code | \n
\n\nAmount | \nDecimal | \n | \n | \nBase amount to be paid through this payment plan. Does not include charge fee | \n
\n\nChargeRate | \nDecimal | \n | \n | \nAmount of the charge rate generated by choosing this payment plan | \n
\n\nFlagCode | \nString | \n | \n | \nRelevant only for card payments. External code of the card's flag. In the absence of an external code, send card description | \n
\n\nBannerType | \nByte | \n | \n | \nRelevant only for card payments. Flag type. | \n
\n\nAmount Installments | \nInteger | \n | \n | \nAmount of installments selected for payment - either configured in the payment plan or chosen by the user, when paying via credit card | \n
\n\nOperatorAuthorizationCode | \nString | \n | \n | \nRelevant only for card payments. Card payment authorization code | \n
\n\n
\n
Products
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nProductCode | \nInteger | \n | \n | \nProduct code. This field is the key of the product | \n
\n\nProductName | \nString | \n | \n | \nProduct Name | \n
\n\nMaterials | \nList of objects of type Material | \n | \n | \nList of materials that make up the product. It will be greater than 1 in case of kits or different priorities of materials in the same product | \n
\n\n
\n
Materials
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nMaterialCodeSKU | \nString | \n | \n | \nCode SKU of the material. This field is the key of the material | \n
\n\nQuantity | \nInteger | \n | \n | \nNumber of occurrences of this material in the product. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nTablePrice | \nDecimal | \n | \n | \nTable Price unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nPrice Practiced | \nDecimal | \n | \n | \nPrice Practiced unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nNetPrice | \nDecimal | \n | \n | \nNet Price unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nCostPrice | \nDecimal | \n | \n | \nCost Price unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\nCommission Value | \nDecimal | \n | \n | \nCommission value unit of this material. For \"non-kit\" products, this value will be exactly the same as the field of the same name in the superior entity | \n
\n\n
\n
\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nPromotion Code | \n | \n | \n | \nPromotion Code | \n
\n\nPromotion Name | \n | \n | \n | \nDescription of the promotion | \n
\n\n
\n
This interface is used to export a person's records from Let.
\n\nPeople
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \nYes | \nEntity export control document code - in this case, the person | \n
\n\nCode | \nInteger | \n9 | \nYes | \nCode of the person registered in Let. This field is the person's key | \n
\n\nName | \nString | \n100 | \nYes | \nInformation identifying the person.| Physical person | Name | | Legal person | Corporate Name |
| \n
\n\nSurname | \nString | \n50 | \nNo | \nInformation identifying the person's last name.| Physical person | Surname | | Legal person | Fantasy name |
| \n
\n\nType | \nByte | \n2 | \nYes | \nCode that identifies the person's type.| 1 | Physical person | | 2 | Legal person |
| \n
\n\nDocument | \nObject of type Document | \n | \nNo | \nList that contains all documents registered for the person | \n
\n\nAddress | \nObject of type Address | \n | \nNo | \nList that contains all registered addresses for the person | \n
\n\nPhone | \nObject of type Phone | \n | \nNo | \nList that contains all registered phones for the person | \n
\n\nEmail | \nObject of type Email | \n | \nNo | \nList that contains all emails registered for the person | \n
\n\nIndividual | \nObject of type Individual | \n | \nNo | \nSection that contains specific data on when the person is of the type Individual | \n
\n\nLegalPerson | \nObject of the LegalPerson type | \n | \nNo | \nSection that contains specific data on when the person is of the Legal Entity type | \n
\n\nFunction | \nObject of type Function | \n | \nNo | \nList containing all functions of the person | \n
\n\nPersonVariableFields | \nObject of type FieldsVariablePerson | \n | \nNo | \n | \n
\n\n
\n
Document
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \nYes | \nCode that identifies the document's type.| 1 | ID |
|---|
| 2 | CPF | | 3 | Voter Title | | 4 | CNH | | 5 | CNPJ | | 6 | State registration | | 7 | RUT - Chile | | 8 | CedulaCidadania - Colombia | | 9 | NIT - (Colombia | | 10 | PIS | | 11 | DNI - Argentina | | 12 | CUIT - Argentina (Unique Tax Identification Key) | | 13 | CUIT_PF - (CUIT used in PF registration) | | 14 | LC - Argentina (Libreta Civicas) | | 15 | CI - Argentina (ID Card) | | 16 | LE - Argentina (Libreta de Enrolamiento) | | 17 | DNI_PE - Peru (National Identity Document) | | 18 | Foreign Portfolio - Peru | | 19 | RUC - Peru (Unique Taxpayer Register) | | 20 | RUC_PF - Peru (RUC used in the PF registration) | | 21 | IFE - Mexico (IFE - Federal Electoral Institute) - Voter's Document | | 22 | PasaporteFM - Mexico (Passport or FM1/FM2 - Migration Document) | | 23 | RFC_PF - Mexico (Federal Taxpayers Registry) - PF | | 24 | RFC - Mexico (Federal Taxpayers Registry) - PJ | | 25 | OtherDoc1 - Mexico | | 26 | OtherDoc2 - Mexico | | 27 | CURP - Mexico | | 28 | CI_CIE - Bolivia |
| \n
\n\nDocument | \nString | \n20 | \nYes | \nDocument number | \n
\n\nExtraInformation | \nString | \n10 | \nNo | \nAdditional information that may exist for this document | \n
\n\n
\n
Address
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \nYes | \nCode that identifies the type of address.| 1 | Residential | | 2 | Commercial | | 3 | Delivery | | 4 | Alternative Delivery | | 5 | Revenues | | 6 | Charge | | 7 | Alternative Delivery 2 |
| \n
\n\nAreaCode | \nString | \n15 | \nNo | \nAddress Area Code | \n
\n\nGeoStructure | \nString | \n100 | \nYes | \nBase Level of the Geographical Structure of the Address | \n
\n\nGeoStructure1 | \nString | \n100 | \nNo | \nFirst Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo2Structure | \nString | \n100 | \nNo | \nSecond Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo3Structure | \nString | \n100 | \nNo | \nThird Level Geographic Structure of the Address (if any) | \n
\n\nGeo4Structure | \nString | \n100 | \nNo | \nFourth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo5Structure | \nString | \n100 | \nNo | \nFifth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo6Structure | \nString | \n100 | \nNo | \nSixth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo7Structure | \nString | \n100 | \nNo | \nSeventh Level of the Geographical Structure of the Address (if exist) | \n
\n\nGeo8Structure | \nString | \n100 | \nNo | \nEighth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo9Structure | \nString | \n100 | \nNo | \nNinth Level of the Geographical Structure of the Address (if any) | \n
\n\nNumber | \nString | \n10 | \nNo | \nAddress number | \n
\n\nComplement | \nString | \n100 | \nNo | \nAddress complement | \n
\n\nReference | \nString | \n100 | \nNo | \nAddress reference | \n
\n\nAuxiliary AreaCode | \nString | \n100 | \nNo | \nAuxiliary area code of address | \n
\n\n
\n
Telephone
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \nYes | \nCode that identifies the type of phone.| 1 | Residential | | 2 | Commercial | | 3 | Delivery | | 4 | Alternative Delivery | | 5 | Revenues | | 6 | Charge | | 7 | Alternative Delivery 2 |
| \n
\n\nPhone | \nString | \n20 | \nYes | \nPhone number, as registered in Let (including spaces, special characters, etc.) | \n
\n\nExtension | \nString | \n5 | \nNo | \nPhone extension | \n
\n\n
\n
Email
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \nYes | \nCode that identifies the type of email.| 1 | Folks | | 2 | Alternative | | 3 | Commercial |
| \n
\n\nEmail | \nString | \n50 | \nYes | \nEmail address | \n
\n\n
\n
Physical person
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDate of Birth | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \nNo | \nDate of birth | \n
\n\nGender | \nByte | \n2 | \nNo | \nCode that indicates the person's gender. | \n
\n\nCivil Status | \nByte | \n2 | \nNo | \nCode that indicates the person's marital status.| 1 | Single | | 2 | Married | | 3 | Widower | | 4 | Separate | | 5 | Divorced |
| \n
\n\nChildren | \nByte | \n2 | \nNo | \nCode that indicates the number of children of the person.| 0 to 5 | The code is the number of children | | 6 | 5 or more children |
| \n
\n\n
\n
Legal person
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \nYes | \nCode indicating the type of legal entity.| 1 | Distribution channel | | 2 | Distributor | | 3 | Shipping company | | 4 | Warehouse/Industrial | | 5 | Retailer | | 6 | Representative | | 7 | Bank | | 8 | Manufacturer |
| \n
\n\nContribuinteICMS | \nByte | \n2 | \nNo | \nCode that indicates whether the legal entity is a taxpayer of ICMS. | \n
\n\nExternal Code | \nString | \n30 | \nNo | \nExternal code defined in the legal entity's registration | \n
\n\n
\n
Occupation
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nFunctionCode | \nInteger | \n9 | \nYes | \nCode that identifies the function inside the Let. Only Register functions will be sent. This field is the key of the function | \n
\n\nFunctionName | \nString | \n50 | \nYes | \nFunction name | \n
\n\nCommercialSituation | \nByte | \n2 | \nNo | \nIf the function allows the capture of orders and this person is allocated in the network for this function, then the code that indicates the commercial situation of the person in this function will be returned.| 1 | Registered | | 2 | Available | | 3 | Unavailable | | 4 | ceased | | 5 | Resale Intent |
| \n
\n\nCampaign | \nInteger | \nAAAACC | \nNo | \nCampaign the person is in, considering this function | \n
\n\nCredit Balance | \nInteger | \n9 | \nNo | \nThis person's credit balance for this role | \n
\n\nCredit Limit | \nInteger | \n9 | \nNo | \nThis person's credit limit for this role | \n
\n\nCommercial Structure0 | \nString | \n100 | \nYes | \nBase Level of the Commercial Structure | \n
\n\nBusiness Structure1 | \nString | \n100 | \nNo | \nFirst Level of Business Structure where the person is allocated in this role (if any) | \n
\n\nCommercial Structure2 | \nString | \n100 | \nNo | \nSecond Level of the Commercial Structure in which the person is allocated in this role (if any) | \n
\n\nBusiness Structure3 | \nString | \n100 | \nNo | \nThird Level of Business Structure where the person is allocated in this role (if any) | \n
\n\nCommercial Structure4 | \nString | \n100 | \nNo | \nFourth Level of the Commercial Structure where the person is allocated in this role (if any) | \n
\n\nCommercial Structure5 | \nString | \n100 | \nNo | \nFifth Level of the Commercial Structure in which the person is allocated in this role (if any) | \n
\n\nBusiness Structure6 | \nString | \n100 | \nNo | \nSixth Level of the Business Structure in which the person is allocated in this role (if any) | \n
\n\nBusiness Structure7 | \nString | \n100 | \nNo | \nSeventh Level of the Business Structure in which the person is allocated in this role (if any) | \n
\n\nBusiness Structure8 | \nString | \n100 | \nNo | \nEighth Level of Business Structure where the person is allocated in this role (if any) | \n
\n\nBusiness Structure9 | \nString | \n100 | \nNo | \nNinth Level of Business Structure where the person is allocated in this role (if any) | \n
\n\n
\n
Variable Field
\n\nFieldsVariablesPerson
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \nYes | \nEntity export control document code - in this case, the variable field | \n
\n\nParentDocumentCode | \nLong | \n | \nYes | \nExport control document code of the parent entity - in this case, the person | \n
\n\nVariableFieldCode | \nInteger | \n | \nYes | \nVariable Field Code | \n
\n\nVariableField Description | \nString | \n | \nNo | \nVariable field description | \n
\n\nDataInicioSituacao | \ndateTime | \n | \nNo | \nStart date of the current situation of the variable field | \n
\n\nValue | \nObject of type Value | \n | \nNo | \nList of variable field values | \n
\n\n
\n
Variable Field Value
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nValueCode | \nInteger | \n | \nNo | \nCode of variable field value | \n
\n\nDescriptionValue | \nString | \n100 | \nNo | \nDescription of the variable field value | \n
\n\n
\n
This interface is used to export a person's records from Let.
\n\nPeople
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \n | \n | \n
\n\nCode | \nInteger | \n9 | \n | \nCode of the person registered in Let. This field is the person's key | \n
\n\nName | \nString | \n100 | \n | \nInformation identifying the person. | \n
\n\nSurname | \nString | \n50 | \n | \nInformation identifying the person's last name | \n
\n\nType | \nByte | \n2 | \n | \nCode identifying the person's type | \n
\n\nDocument | \nObject of type Document | \n | \n | \nList containing all documents registered for the person | \n
\n\nAddress | \nObject of type Address | \n | \n | \nList containing all registered addresses for the person | \n
\n\nPhone | \nObject of type Phone | \n | \n | \nList containing all registered phones for the person | \n
\n\nEmail | \nObject of type Email | \n | \n | \nList containing all emails registered for the person | \n
\n\nIndividual | \nObject of type Individual | \n | \n | \nSection that contains specific data on when the person is of the type Individual | \n
\n\nLegalPerson | \nObject of the LegalPerson type | \n | \n | \nSection that contains specific data on when the person is of the Legal Entity type | \n
\n\nFunction | \nObject of type Function | \n | \n | \nList containing all functions of the person | \n
\n\nPersonVariableFields | \nObject of the type PersonVariableFields | \n | \n | \n | \n
\n\n
\n
Document
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \n | \nCode identifying the document type | \n
\n\nDocument | \nString | \n20 | \n | \nDocument number | \n
\n\nExtraInformation | \nString | \n10 | \n | \nAdditional information that may exist for this document | \n
\n\n
\n
Address
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \n | \nCode that identifies the type of address. | \n
\n\nAreaCode | \nString | \n15 | \n | \nAddress Area Code | \n
\n\nGeo0Structure | \nString | \n100 | \n | \nBase Level of the Geographical Structure of the Address | \n
\n\nGeoStructure1 | \nString | \n100 | \n | \nFirst Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo2Structure | \nString | \n100 | \n | \nSecond Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo3Structure | \nString | \n100 | \n | \nThird Level Geographic Structure of the Address (if any) | \n
\n\nGeo4Structure | \nString | \n100 | \n | \nFourth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo5Structure | \nString | \n100 | \n | \nFifth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo6Structure | \nString | \n100 | \n | \nSixth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo7Structure | \nString | \n100 | \n | \nSeventh Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo8Structure | \nString | \n100 | \n | \nEighth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo9Structure | \nString | \n100 | \n | \nNinth Level of the Geographical Structure of the Address (if any) | \n
\n\nNumber | \nString | \n10 | \n | \nAddress number | \n
\n\nComplement | \nString | \n100 | \n | \nAddress complement | \n
\n\nReference | \nString | \n100 | \n | \nAddress reference | \n
\n\nAuxiliary AreaCode | \nString | \n100 | \n | \nAuxiliary area code of the address | \n
\n\n
\n
Telephone
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \n | \nCode identifying the phone type | \n
\n\nTelephone | \nString | \n20 | \n | \nPhone number, as registered in Let (including spaces, special characters, etc.) | \n
\n\nExtension | \nString | \n5 | \n | \nPhone extension | \n
\n\n
\n
Email
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \n | \nCode identifying the type of email | \n
\n\nEmail | \nString | \n50 | \n | \nEmail address | \n
\n\n
\n
Physical person
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDate of Birth | \ndateTime | \nYYYY-mm-DDTHH:MM:ss | \n | \nDate of birth | \n
\n\nGender | \nByte | \n2 | \n | \nCode that indicates the person's gender. | \n
\n\nCivil Status | \nByte | \n2 | \n | \nCode that indicates the person's marital status. | \n
\n\nChildren | \nByte | \n2 | \n | \nCode that indicates the number of children of the person. | \n
\n\n
\n
Legal person
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nType | \nByte | \n2 | \n | \nCode indicating the type of legal entity | \n
\n\nContribuinteICMS | \nByte | \n2 | \n | \nCode indicating whether the legal entity is a taxpayer of ICMS. | \n
\n\nExternal Code | \nString | \n30 | \n | \nExternal code defined in the legal entity's registration | \n
\n\n
\n
Occupation
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nFunctionCode | \nInteger | \n9 | \n | \nCode that identifies the function inside the Let. Only Register functions will be sent. This field is the key of the function | \n
\n\nFunctionName | \nString | \n50 | \n | \nFunction name | \n
\n\nSituacaoComercial | \nByte | \n2 | \n | \nIf the function allows the capture of orders and this person is allocated in the network for this function, then the code that indicates the commercial situation of the person in this function will be returned. | \n
\n\nCampaign | \nInteger | \nAAAACC | \n | \nCampaign the person is in, considering this function | \n
\n\nCredit Balance | \nInteger | \n9 | \n | \nThis person's credit balance for this role | \n
\n\nCredit Limit | \nInteger | \n9 | \n | \nThis person's credit limit for this role | \n
\n\nCommercial Structure0 | \nString | \n100 | \n | \nBase Level of the Commercial Structure | \n
\n\nBusiness Structure1 | \nString | \n100 | \n | \nFirst Level of Business Structure where the person is allocated in this role (if any) | \n
\n\nCommercial Structure2 | \nString | \n100 | \n | \nSecond Level of the Commercial Structure in which the person is allocated in this role (if any) | \n
\n\nCommercial Structure3 | \nString | \n100 | \n | \n | \n
\n\nCommercial Structure4 | \nString | \n100 | \n | \nFourth Level of the Commercial Structure in which the person is allocated in this role (if any) | \n
\n\nCommercial Structure5 | \nString | \n100 | \n | \nFifth Level of the Commercial Structure where the person is allocated in this role (if any) | \n
\n\nCommercial Structure6 | \nString | \n100 | \n | \nSixth Level of the Commercial Structure where the person is allocated in this role (if any) | \n
\n\nCommercial Structure7 | \nString | \n100 | \n | \nSeventh Level of the Commercial Structure in which the person is allocated in this role (if any) | \n
\n\nCommercial Structure8 | \nString | \n100 | \n | \nEighth Level of the Commercial Structure where the person is allocated in this role (if any) | \n
\n\nBusiness Structure9 | \nString | \n100 | \n | \nNinth Level of Business Structure where the person is allocated in this role (if any) | \n
\n\n
\n
Variable Field
\n\nFieldsVariablesPerson
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \n | \n | \n
\n\nFatherDocumentCode | \nLong | \n | \n | \n | \n
\n\nVariableFieldCode | \nInteger | \n | \n | \n | \n
\n\nVariableField Description | \nString | \n | \n | \n | \n
\n\nStartDateSituacao | \ndateTime | \n | \n | \n | \n
\n\nValue | \nObject of type Value | \n | \n | \n | \n
\n\n
\n
Variable Field Value
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nValueCode | \nInteger | \n | \n | \n | \n
\n\nDescriptionValue | \nString | \n | \n | \n | \n
\n\n
\n
This interface is used to export the records of a Let invoice.
\n\nPeople
\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nDocumentCode | \nLong | \n | \n | \n | \n
\n\nCode | \nInteger | \n | \n | \nInvoice Code, internal to Let. This field is the key of the Invoice. There is also a logical key for the Nora Fiscal, formed by: Number. Series. Date and Issuer. | \n
\n\nOrderCode | \nInteger | \n | \n | \nOrder code. This field is the key of the order | \n
\n\nNumber | \nInteger | \n | \n | \nInvoice number within the specified Series | \n
\n\nSeries | \nInteger | \n | \n | \nInvoice Series | \n
\n\nData | \ndateTime | \n | \n | \nInvoice Operation Date. It may be the Date of Issue, Cancellation, Denial etc. | \n
\n\nNetWeight | \nDecimal | \n | \n | \nWeight netof the order of this Invoice, ingrams | \n
\n\nGross Weight | \nDecimal | \n | \n | \nGrossweight of the order of this Invoice, ingrams | \n
\n\nQuantityVolumes | \nDecimal | \n | \n | \nAmount of volumes that make up this Invoice | \n
\n\nType | \nByte | \n | \n | \nCode that indicates the type of the Invoice. | \n
\n\nStatus | \nByte | \n | \n | \nCode that indicates the status of the Invoice. | \n
\n\nShipping Type | \nByte | \n | \n | \nCode that indicates the type of shipping of this Invoice. | \n
\n\nInvoicing Center | \nString | \n | \n | \nExternal Code defined in the registration of the Distribution Channel used and considered in the Invoicing. If not filled in, the Distribution Center Name will be used | \n
\n\nAdditional Data | \nString | \n | \n | \nAdditional data of this Invoice | \n
\n\nInvoiceReference | \nObject of the type InvoiceReference | \n | \n | \nSection that contains, when it exists, the information of the Invoice referenced by this one. Basically used when it is an incoming Invoice that references an outgoing Invoice of that order | \n
\n\nPerson Issuer | \nObject of the type Person Issuer | \n | \n | \nSection that contains some basic data to identify the person responsible for Issuing the Invoice | \n
\n\nRecipient | \nObject of the type Recipient | \n | \n | \nSection containing the Recipient of the Invoice | \n
\n\nConveyor | \nObject of the type Conveyor | \n | \n | \nSection that contains some basic data to identify the Legal Entity of the Carrier related to this Invoice | \n
\n\nValues | \nObject of type Values | \n | \n | \n | \n
\n\nInvoiceItems | \nObject of type InvoiceItems | \n | \n | \n | \n
\n\n
\n
Invoice Reference
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nInvoiceCode | \nInteger | \n | \n | \n | \n
\n\nNumber | \nInteger | \n | \n | \n | \n
\n\nSeries | \nInteger | \n | \n | \n | \n
\n\nIssuingDate | \ndateTime | \n | \n | \n | \n
\n\nIssuerPerson Code | \nInteger | \n | \n | \n | \n
\n\n
\n
Issuer Person
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nCode | \nInteger | \n | \n | \n | \n
\n\nName | \nString | \n | \n | \n | \n
\n\nType | \nByte | \n | \n | \n | \n
\n\nIdentification | \nString | \n | \n | \n | \n
\n\nIdentificationType | \nByte | \n | \n | \n | \n
\n\n
\n
Recipient
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nCode | \nInteger | \n | \n | \n | \n
\n\nName | \nString | \n | \n | \n | \n
\n\nType | \nByte | \n | \n | \n | \n
\n\nIdentification | \nString | \n | \n | \n | \n
\n\nIdentificationType | \nByte | \n | \n | \n | \n
\n\nPhone | \nString | \n | \n | \n | \n
\n\nEmail | \nString | \n | \n | \n | \n
\n\nAreaCode | \nString | \n | \n | \n | \n
\n\nGeoStructure | \nString | \n100 | \nYes | \nBase Level of the Geographical Structure of the Address | \n
\n\nGeoStructure1 | \nString | \n100 | \nNo | \nFirst Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo2Structure | \nString | \n100 | \nNo | \nSecond Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo3Structure | \nString | \n100 | \nNo | \nThird Level Geographic Structure of the Address (if any) | \n
\n\nGeo4Structure | \nString | \n100 | \nNo | \nFourth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo5Structure | \nString | \n100 | \nNo | \nFifth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo6Structure | \nString | \n100 | \nNo | \nSixth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo7Structure | \nString | \n100 | \nNo | \nSeventh Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo8Structure | \nString | \n100 | \nNo | \nEighth Level of the Geographical Structure of the Address (if any) | \n
\n\nGeo9Structure | \nString | \n100 | \nNo | \nNinth Level of the Geographical Structure of the Address (if any) | \n
\n\nNumber | \nString | \n10 | \nNo | \nAddress number | \n
\n\nComplement | \nString | \n100 | \nNo | \nAddress complement | \n
\n\nReference | \nString | \n100 | \nNo | \nAddress reference | \n
\n\nDeliveryNeighbor | \nByte | \n | \n | \n | \n
\n\nNumberNeighbor | \nString | \n | \n | \n | \n
\n\n
\n
Shipping company
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nCode | \nInteger | \n | \n | \n | \n
\n\nName | \nString | \n | \n | \n | \n
\n\nType | \nByte | \n | \n | \n | \n
\n\nIdentification | \nString | \n | \n | \n | \n
\n\nIdentificationType | \nByte | \n | \n | \n | \n
\n\n
\n
Values
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nTotalAmountNote | \nDecimal | \n | \n | \n | \n
\n\nProduct Value | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase1 | \nDecimal | \n | \n | \n | \n
\n\nBaseTax Calculation2 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase3 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase4 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase5 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount1 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount2 | \nDecimal | \n | \n | \n | \n
\n\nTax Value3 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount4 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount5 | \nDecimal | \n | \n | \n | \n
\n\nShipping | \nDecimal | \n | \n | \n | \n
\n\nInsurance | \nDecimal | \n | \n | \n | \n
\n\nOther Expenses | \nDecimal | \n | \n | \n | \n
\n\nTotalDifferentialAliquots | \nDecimal | \n | \n | \n | \n
\n\n
\n
Invoice Items
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nItemNumber | \nLong | \n | \n | \n | \n
\n\nSKU Code | \nDecimal | \n | \n | \n | \n
\n\nMaterial | \nDecimal | \n | \n | \n | \n
\n\nQuantity | \nDecimal | \n | \n | \n | \n
\n\nCFOP | \nDecimal | \n | \n | \n | \n
\n\nFiscal Classification | \nDecimal | \n | \n | \n | \n
\n\nMVA Percentage | \nDecimal | \n | \n | \n | \n
\n\nUnit of Measure | \nDecimal | \n | \n | \n | \n
\n\nFiscal Operation | \nDecimal | \n | \n | \n | \n
\n\nValues | \nObject of type Item Values | \n | \n | \n | \n
\n\n
\n
Item Values
\n\n\n\n\n| Interface | \nType | \nSize/Format | \nMandatory | \nNote | \n
\n\n\n\nTable Price | \nDecimal | \n | \n | \n | \n
\n\nPrice Practiced | \nDecimal | \n | \n | \n | \n
\n\nLiquid Price | \nDecimal | \n | \n | \n | \n
\n\nBilling Price | \nDecimal | \n | \n | \n | \n
\n\nAliquotaTax1 | \nDecimal | \n | \n | \n | \n
\n\nAliquotaTax2 | \nDecimal | \n | \n | \n | \n
\n\nAliquotaTax3 | \nDecimal | \n | \n | \n | \n
\n\nAliquotaTax4 | \nDecimal | \n | \n | \n | \n
\n\nAliquotaTax5 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase1 | \nDecimal | \n | \n | \n | \n
\n\nBaseTax Calculation2 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase3 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase4 | \nDecimal | \n | \n | \n | \n
\n\nTax CalculationBase5 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount1 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount2 | \nDecimal | \n | \n | \n | \n
\n\nTax Value3 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount4 | \nDecimal | \n | \n | \n | \n
\n\nTax Amount5 | \nDecimal | \n | \n | \n | \n
\n\nShipping | \nDecimal | \n | \n | \n | \n
\n\nInsurance | \nDecimal | \n | \n | \n | \n
\n\nOther Expenses | \nDecimal | \n | \n | \n | \n
\n\nTotalDifferentialAliquots | \nDecimal | \n | \n | \n | \n
\n\n
\n
MODULE UNDER CONSTRUCTION
\n","_postman_id":"b516598a-352a-475c-86a4-1cd2e61956ec"}],"id":"69e040da-a3f2-4027-b7f0-5dc0eb24796e","_postman_id":"69e040da-a3f2-4027-b7f0-5dc0eb24796e","description":""},{"name":"Service","item":[{"name":"Sales Orders","item":[{"name":"Order Capture","item":[{"name":"Order Capture Flow - Online","item":[{"name":"Step 1 - Get System Parameters","item":[],"id":"2708ea6f-5a36-4621-b389-1ee7c7585040","description":"Right after authentication, the application must get the system parameters relevant to the order capture that will be performed.
\n The important parameters in an order taking are:
\n\nAllowCaptureOnNextCampaignInExtendedPeriodWithoutCloseBuyerCampaign: If enabled, the user can capture in the future cycle without closing the current cycle.
\nTipoSelecaoPessoaInicioCaptacao: Indicates, when consulting a person to capture orders, which information can be provided for search, main document, secondary document or code. Possible combinations are in the glossary.
\nRestrict People QueriesABuyersOnPickup: If enabled, people queries for order capture will only return users who are active for order capture.
\n
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ee6628bd-8e1d-4fe2-bbe1-ebc8d1990972"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"483f31cf-17ca-4bd8-9a26-e1a715fd9ae8"}}],"_postman_id":"2708ea6f-5a36-4621-b389-1ee7c7585040"},{"name":"Step 2 - Define Order Owner","item":[{"name":"Consult permissions","id":"ecdc0b38-0644-400a-b46c-0fec6eb363a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/people/:id/permissions","description":"This call is used to obtain a series of permissions from the authenticated person.
\n","urlObject":{"path":["api","people",":id","permissions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"a5d0aa30-438d-4951-857a-a18cb31e5fd9","description":{"content":"(Required) Identifier code of the logged in user.
\n","type":"text/plain"},"type":"any","value":"{{usuarioLogado}}","key":"id"}]}},"response":[{"id":"a9c9b85e-9cd4-45af-8ab0-4374ea63abf3","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/people/:id/permissions?","host":["{{baseUrl}}"],"path":["api","people",":id","permissions"],"query":[{"key":"","value":null}],"variable":[{"key":"id","value":"{{usuarioLogado}}","description":"**(Required)** Authenticated User Code."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"allowSearchCFMaster\": \"Allows you to consult and register final consumer (PermissaoMasterConsultarConsumidor)\",\n \"allowSearchCF\": \"Allows to query end consumer (PermissaoConsultarConsumidor)\",\n \"allowCreatedCF\": \"Allows the registration of the final consumer in the capture (PermiteCriacaoCaptacaoConsumidorFinal)\",\n \"allowPersonification\": \"Deprecated\",\n \"allowCartApplicationAccess\": \"Allows access to Cart application\",\n \"allowConsultSacOccurrences\": \"Allows consulting SAC occurrences\",\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\"\n }"},{"id":"33acf8b9-f4fd-4ef9-8ccf-c820a456c8fb","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/people/:id/permissions?","host":["{{baseUrl}}"],"path":["api","people",":id","permissions"],"query":[{"key":"","value":null}],"variable":[{"key":"id","value":"{{usuarioLogado}}","description":"**(Required)** Authenticated User Code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 13 Nov 2020 19:45:41 GMT"},{"key":"Content-Length","value":"136"}],"cookie":[],"responseTime":null,"body":"{\n \"allowSearchCFMaster\": true,\n \"allowSearchCF\": true,\n \"allowCreatedCF\": true,\n \"allowPersonification\": true,\n \"allowCartApplicationAccess\": true,\n \"allowConsultSacOccurrences\": true,\n \"allowChangeIncorporatedItemQuantity\": true\n }"}],"_postman_id":"ecdc0b38-0644-400a-b46c-0fec6eb363a8"},{"name":"Consult service information","id":"433a00d7-f200-45b2-ba14-365ff19ff6ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/sellers/:id/serviceInfo","description":"This call is used to query the authenticated user's service information.
\n","urlObject":{"path":["api","sellers",":id","serviceInfo"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"dbbab94e-0af3-4a2f-8b97-bb8862821f05","description":{"content":"(Required) Identifier code of the logged in user.
\n","type":"text/plain"},"type":"any","value":"{{usuarioLogado}}","key":"id"}]}},"response":[{"id":"85d7beb7-3357-4f8a-979d-90a7485235f0","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/serviceInfo","host":["{{baseUrl}}"],"path":["api","sellers",":id","serviceInfo"],"variable":[{"key":"id","value":"","description":"**(Required)** Authenticated User Code."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"canOrderingOtherSeller\": \"Defines if the user can capture to another user\",\n \"searchSellerOnlyCode\": \"Defines whether it is possible to search for a user only with his code\",\n \"typeSearchSeller\": \"Indicates the type of search by the user\",\n \"canOrderingCDPA\": \"Defines if the user can capture by CDPA\",\n \"canOrderingCSLoja\": \"Defines if the user can capture to CSLoja\",\n \"checkoutForBuyerInPreviousCampaign\": \"Defines whether the user can checkout to the buyer in the past campaign\",\n \"checkoutInTheNewCampaign\": \"Defines whether the user can checkout the new campaign\",\n \"checkoutInTheNewCampaignWithoutConfirmation\": \"Defines whether the user can checkout the new campaign without confirmation\",\n \"selectMarketingMixCycle\": \"Defines if the user can select a marketing cycle mixed\"\n }"},{"id":"5d3b1034-3ca2-42d9-9636-731f005be3a0","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/serviceInfo","host":["{{baseUrl}}"],"path":["api","sellers",":id","serviceInfo"],"variable":[{"key":"id","value":"{{usuarioLogado}}","description":"**(Required)** Authenticated User Code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 13 Nov 2020 20:03:18 GMT"},{"key":"Content-Length","value":"177"}],"cookie":[],"responseTime":null,"body":"{\n \"canOrderingOtherSeller\": true,\n \"searchSellerOnlyCode\": false,\n \"typeSearchSeller\": 3,\n \"canOrderingCDPA\": true,\n \"canOrderingCSStore\": true,\n \"checkoutForBuyerInPreviousCampaign\": true,\n \"checkoutInTheNewCampaign\": true,\n \"checkoutInTheNewCampaignWithoutConfirmation\": true,\n \"selectMarketingMixCycle\": true\n }"}],"_postman_id":"433a00d7-f200-45b2-ba14-365ff19ff6ec"},{"name":"Validate permission to take order","id":"e4550135-b6a8-4d3c-8d46-72b08a388d1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/sellers/:id/allowedOrderingSeller?identification={{donoPedido}}&includeOptions=by the way","description":"This call is made to verify that the authenticated person can pick up a request for the user in question.
\n If the call returns an object, the authenticated person can pick up a request for this user. If the call returns a 404 Not Found error, the authenticated person does not have permission to take requests for that user.
\n The identification input parameter can accept different values, depending on the TypePessoaInicioCaptacao system parameter, which has 3 values, available in the glossary.
\n Heads up
\n If the system parameter RestrictQueryOfPeopleABuyersOnPurchase is activated (value == true), the application will return only the users who can capture an order.
\n","urlObject":{"path":["api","sellers",":id","allowedOrderingSeller"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required) Accepts main document, main email or person code.
\n","type":"text/plain"},"key":"identification","value":"{{donoPedido}}"},{"description":{"content":"Returns the person's alias.
\n","type":"text/plain"},"key":"includeOptions","value":"by the way"}],"variable":[{"id":"728d6844-c8c6-4e75-9046-533ea1edb1ef","description":{"content":"(Required) Identifier code of the logged in user.
\n","type":"text/plain"},"type":"any","value":"{{usuarioLogado}}","key":"id"}]}},"response":[{"id":"2d612ac6-6afd-48aa-9ec7-7a4277beb035","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/allowedOrderingSeller?identification={{donoPedido}}&includeOptions=by the way","host":["{{baseUrl}}"],"path":["api","sellers",":id","allowedOrderingSeller"],"query":[{"key":"identification","value":"{{donoPedido}}","description":"**(Required)** main document, main emial, code"},{"key":"includeOptions","value":"by the way","description":"Returns the person's alias."}],"variable":[{"key":"id","value":"{{usuarioLogado}}","description":"**(Required)** Authenticated User."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 13 Nov 2020 20:00:56 GMT"},{"key":"Content-Length","value":"283"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 216,\n \"name\": \"ADRIANO TEST\",\n \"sellerPictures\": [\n {\n \"type\": {\n \"id\": 1,\n \"description\": \"Avatar\"\n },\n \"urlPicture\": \"https://inovadevsgi.geravd.com.br/Paginas/Imagens/Fotos/4f8fd46225c12195616c57d324878330.png\"\n }\n ],\n \"by the way\": [\n {\n \"typeId\": 1,\n \"alias\": \"3799245225ALIASWEBSTORE\"\n },\n {\n \"typeId\": 2,\n \"alias\": \"ALIAS FANTASY NAME TEST\"\n }\n ],\n \"quantityCyclesWithoutOrdering\": 0,\n \"situation\": 0 \n }"},{"id":"54767f52-7270-49fd-b119-d4bbe8b36e46","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/allowedOrderingSeller?identification={{donoPedido}}&includeOptions=by the way","host":["{{baseUrl}}"],"path":["api","sellers",":id","allowedOrderingSeller"],"query":[{"key":"identification","value":"{{donoPedido}}","description":"**(Required)** main document, main emial, code"},{"key":"includeOptions","value":"by the way","description":"Returns the person's alias."}],"variable":[{"key":"id","value":"{{usuarioLogado}}","description":"**(Required)** Authenticated User."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 13 Nov 2020 20:00:56 GMT"},{"key":"Content-Length","value":"283"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"Code of the consulted user\",\n \"name\": \"Name of the consulted user\",\n \"sellerPictures\": [ // List of reseller images\n {\n \"type\": { // Image Type - Possible Glossary Values (Image Types)\n \"id\": \"Image type code\",\n \"description\": \"Image type description\"\n },\n \"urlPicture\": \"Picture URL\"\n }\n ],\n \"alias\": [ // Alias List - Possible Glossary Values (Alias Types)\n {\n \"typeId\": \"Alias type code\",\n \"alias\": \"Person alias\"\n }\n ],\n \"quantityCyclesWithoutOrdering\": \"Amount of cycles since that the user does not place an order\"\n }"}],"_postman_id":"e4550135-b6a8-4d3c-8d46-72b08a388d1a"}],"id":"6351b422-be6f-4716-b8e0-483f65240124","description":"In this step, the owner or owner of the order will be defined. To do this, you must first define whether the order is your own or for someone else.
\nOwn Order
\n If the order is your own -the authenticated person is taking an order for you- the application should obtain information from the reseller. If the referenced endpoint does not return the desired person, the application must get information about the authenticated person.
\nOrder for Another Person
\n If the request is for someone else - the authenticated person performs the capture of the request for another user -, the application must validate a series of permissions.
\nPermissions
\n To confirm whether the logged in user can search for another user, the application should see permissions of the person. In the return object, the allowSearchCF property must be true.
\n To validate whether the logged in user can take a request for another person, the application must see service information for the logged in person. In the return object, the canOrderingOtherSeller property must be true.
\n If the above condition is true, the application must validate permission to take order for the person in question. If the endpoint returns the wanted person object, the user can pick up for that person.
\nRegister New Person
\n If the logged in user wants to capture to a person not registered on the platform, it will be necessary to register it in Let. For this, it is necessary to consult the part of Registration, where it will be possible to register a Reseller or Final Consumer to capture the order.
\n Observation
\n When the user needs to register a new person in Let, it is necessary to check the allowCreatedCF permission, in the callback to see permissions, without this permission, no It is possible for the logged-in user to register a Final Consumer. In this case, registration can be done anonymously, with a public user.
\n\n If all conditions are true, the application should see dealer information.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"47bd22e7-954e-4210-96e6-c8e2574f7094"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"92829f5d-e6cd-4df0-a3c3-2de90012b850"}}],"_postman_id":"6351b422-be6f-4716-b8e0-483f65240124"},{"name":"Step 3 - Start Order","item":[{"name":"3.1 Reset Order (*)","item":[{"name":"Check open order","event":[{"listen":"test","script":{"exec":["var retrieved = tests[\"Status code is 201\"] = responseCode.code === 201;\r","postman.setEnvironmentVariable(\"codigoPedido\", null);\r","\r","if(retrieved)\r","{\r"," // Set the order code to the Local let environment\r"," var data = JSON.parse(responseBody);\r"," var codigoPedido = data.number;\r"," postman.setEnvironmentVariable(\"codigoPedido\", codigoPedido);\r","}"],"type":"text/javascript","id":"9f22f932-0fb8-44a0-9570-8a95e7e932c7"}}],"id":"4ee7cf2a-9ce4-4200-b710-9b014f2c091c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"representativeCode","value":"{{donoPedido}}","description":"Order owner user code.
\n"},{"key":"collectionSystem","value":"{{collectionSystem}}","description":"Capture system code.
\n"},{"key":"collectionMode","value":"{{collectionMode}}","description":"Capture mode code.
\n"},{"key":"originSystem","value":"{{originSystem}}","description":"Source system code.
\n"},{"key":"distributionCenterCode","value":"","description":"Fixed distribution center code for which the person can be responsible.
\n"},{"key":"choosePaymentPlan","value":"","description":"Payment plan definition moment.
\n If the order to be captured is a type VI, the payment plan must be defined before initiating the order. For this, code 1 must be passed.
\n In the case of EC and POS orders, the payment plan must be defined at the end of the qualification process. For this, code 2 must be passed.
\n"}]},"url":"{{baseUrl}}/api/orders/retrieved","description":"This call is used to check if the user who owns the order has an open order.
\n Heads up
\n In case a token refresh is performed, this API must always be called again.
\n","urlObject":{"path":["api","orders","retrieved"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"4116c4d9-2f09-434c-a820-f940ace07ef4","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"representativeCode","value":"{{donoPedido}}","description":"Order owner user code."},{"key":"collectionSystem","value":"{{collectionSystem}}","description":"ID_SYSTEM_CAPTATION"},{"key":"collectionMode","value":"{{collectionMode}}","description":"CAPTATION_ID_MEID"},{"key":"originSystem","value":"{{originSystem}}","description":"SOURCE_SYSTEM ID"},{"key":"distributionCenterCode","value":"","description":"Fixed distribution center code for which the person can be responsible.","disabled":true},{"key":"choosePaymentPlan","value":"{{choosePaymentPlan}}","description":"Payment plan definition moment. \n\n If the order to be captured is a type VI, the payment plan must be defined before initiating the order. For this, code 1 must be passed. \n\n In the case of EC and POS orders, the payment plan must be defined at the end of the qualification process. For this, code 2 must be passed."}]},"url":"{{baseUrl}}/api/orders/retrieved"},"status":"created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"location","value":"http://inovadevapisgi.geravd.com.br/api/orders/16276089"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 13 Nov 2020 19:24:31 GMT"},{"key":"Content-Length","value":"1069"}],"cookie":[],"responseTime":null,"body":"{\n \"number\": 16276089,\n \"businessInformation\": {\n \"paid\": false,\n \"orderingCycle\": 202011,\n \"marketingCycle\": 202011,\n \"itemsQuantity\": 1,\n \"productsQuantity\": 1,\n \"pointsQuantity\": 1800,\n \"minimumPointsQuantity\": 11100,\n \"tableValue\": 18,\n \"marketValue\": 18,\n \"netValue\": 18,\n \"businessModelCode\": 5,\n \"businessModelName\": \"Business Model - Final Consumer\",\n \"functionCode\": 9,\n \"simulatedValue\": 18,\n \"simulatedPoints\": 12423,\n \"simulatedOrderPoints\": 1800,\n \"simulatedValueProfitabilityGifts\": 0,\n \"distributionCenterCode\": 1,\n \"isWithdrawalCenter\": false,\n \"minimumPointsQuantityConsideredOrder\": 1800,\n \"minimumOrderType\": {\n \"id\": 1,\n \"description\": \"Monetary\"\n },\n \"allowChangeIncorporatedItemQuantity\": true,\n \"flexBalanceAvailable\": 0,\n \"flexBalanceAmountConsumed\": 0,\n \"flexBalanceUpdatedAvailable\": 0,\n \"proposedNetValue\": 0,\n \"allowFlexNegotiation\": false\n },\n \"businessStructure\": {\n \"businessStructureCode\": 30\n },\n \"items\": [\n {\n \"number\": 1,\n \"productCode\": 23, \n \"productName\": \"Product 01\",\n \"quantity\": 1,\n \"unitTableValue\": 18,\n \"unitMarketValue\": 18,\n \"unitNetValue\": 18,\n \"unitPointsQuantity\": 1800,\n \"unitKitPointsQuantity\": 0,\n \"unitMultilevelPointsQuantity\": 0,\n \"associatedItem\": true,\n \"associatedItemRequired\": false,\n \"associatedItemOrigin\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"simulatedValueProfitability\": 18,\n \"simulatedValueProfitabilityUnit\": 18,\n \"profitabilityValue\": 0,\n \"origin\": {\n \"id\": 1,\n \"description\": \"Sale\" \n },\n \"isBloquedRemoveItem\": false,\n \"isBlockedEditQuantity\": true,\n \"confirmAssociatedItemDeletion\": false,\n \"associatedItemOriginDetails\": {\n \"origin\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"promotionCode\": 12351,\n \"promotionDescription\": \"Promotion 01\",\n \"order\": 12345,\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\n \"orderCycle\": 202001,\n \"programPointsCode\": 2,\n \"programPointsDescription\": \"Points Program 01\",\n \"notificationCode\": 2,\n \"productCode\": 32\n },\n \"isMaterialKit\": false, \n \"productDescription\": \"Product 01\",\n \"hasDiscountValue\": false,\n \"hasAppliedProfitabilityValueAddItem\": false,\n \"multipleSaleRestriction\": 1,\n \"displayItemWithDiscountPromotion\": false,\n \"unitMeasurementType\": {\n \"id\": 1,\n \"description\": \"un\"\n },\n \"quantityUnitMeasurement\": 1,\n \"pricePerUnitMeasurement\": 18,\n \"flexNegotiation\": {\n \"minValue\": 17.99,\n \"maxValue\": 19.99,\n \"initialUnitNetValue\": 18,\n \"proposedUnitNetValue\": 0,\n \"proposedNetValue\": 0,\n \"status\": {\n \"id\": 1,\n \"description\": \"No negotiated\"\n },\n \"allowFlexNegotiation\": true\n },\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n }\n ],\n \"cutItems\": [\n {\n \"type\": {\n \"id\": 3,\n \"description\": \"Embedded\"\n },\n \"productCode\": 17,\n \"productName\": \"Product 02\",\n \"quantity\": 1,\n \"cutReason\": {\n \"id\": 2,\n \"description\": \"Price not registered\"\n },\n \"unitTableValue\": 0,\n \"unitMarketValue\": 0,\n \"isMaterialKit\": false,\n \"productDescription\": \"Product 02\",\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n },\n {\n \"type\": {\n \"id\": 3,\n \"description\": \"Embedded\"\n },\n \"productCode\": 22,\n \"productName\": \"Product 03\",\n \"quantity\": 1,\n \"cutReason\": {\n \"id\": 8,\n \"description\": \"Discontinued product\"\n },\n \"unitTableValue\": 0,\n \"unitMarketValue\": 0,\n \"isMaterialKit\": false,\n \"productDescription\": \"Product 03\",\n \"isClosedBoxProduct\": false, \n \"isPromotionRequirementProduct\": false\n }\n ],\n \"externalPreAuthorization\": false,\n \"orderBusinessStatus\": {\n \"code\": 1,\n \"description\": \"Capture\",\n \"dateCreated\": \"2020-11-13T16:24:05.197Z\"\n },\n \"allRewardsPromotion\": false,\n \"paymentPlans\": {\n \"administrateTax\": 0,\n \"code\": 17,\n \"contingentPaymentPlans\": [],\n \"creditTreatment\": {\n \"description\": \"Ignore credit - does not consume credit\",\n \"id\": 3\n },\n \"externalPaymentMethod\": {\n \"description\": \"No\",\n \"id\": 0\n },\n \"isBlocked\": false,\n \"marketingMessages\": [],\n \"minimumInstallmentAmount\": 0,\n \"name\": \"Currency(BRL)\",\n \"paymentInfo\": [\n {\n \"installments\":[1] ,\n \"installmentsQuantity\": 1\n }\n ],\n \"paymentMode\": {\n \"description\": \"In Kind\",\n \"id\": 11\n },\n \"showCreditConsumptionData\": {\n \"description\": \"No\",\n \"id\": 0\n },\n \"type\": {\n \"description\": \"Prepaid\",\n \"id\": 1\n } \n }\n }"},{"id":"2efcd62d-6db3-413b-97c6-268a178b4730","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"representativeCode","value":"{{donoPedido}}","description":"Order owner user code."},{"key":"collectionSystem","value":"{{collectionSystem}}","description":"ID_SYSTEM_CAPTATION"},{"key":"collectionMode","value":"{{collectionMode}}","description":"CAPTATION_ID_MEID"},{"key":"originSystem","value":"{{originSystem}}","description":"SOURCE_SYSTEM ID"},{"key":"distributionCenterCode","value":"","description":"Fixed distribution center code for which the person can be responsible.","disabled":true},{"key":"choosePaymentPlan","value":"{{choosePaymentPlan}}","description":"Payment plan definition moment. \n\n If the order to be captured is a type VI, the payment plan must be defined before initiating the order. For this, code 1 must be passed. \n\n In the case of EC and POS orders, the payment plan must be defined at the end of the qualification process. For this, code 2 must be passed."}]},"url":"{{baseUrl}}/api/orders/retrieved"},"status":"created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"location","value":"http://inovadevapisgi.geravd.com.br/api/orders/16276089"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 13 Nov 2020 19:24:31 GMT"},{"key":"Content-Length","value":"1069"}],"cookie":[],"responseTime":null,"body":"{\n \"number\": \"Order number\",\n \"businessInformation\": { // Business Information\n \"paid\": \"Indicates if the order has already been paid\",\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\n \"itemsQuantity\": \"Quantity of items included in the order\",\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\n \"pointsQuantity\": \"Amount of points earned on order\",\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\n \"tableValue\": \"Product table value\",\n \"marketValue\": \"Product value practiced\",\n \"netValue\": \"Net product value\",\n \"businessModelCode\": \"Business rule code\",\n \"businessModelName\": \"Business Rule Name\",\n \"functionCode\": \"Person's Function Code\",\n \"simulatedValue\": \"Simulated order value\",\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\n \"simulatedOrderPoints\": \"Simulated order point value\",\n \"simulatedValueProfitabilityGifts\": \"Total profit forecast from order gifts\",\n \"distributionCenterCode\": \"Distribution center code\",\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\n \"id\": \"Value type code\",\n \"description\": \"Description of value type\"\n },\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\n \"flexBalanceAvailable\": \"Available flex budget amount\",\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\n \"proposedNetValue\": \"Proposed trading value\",\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \n },\n \"businessStructure\": { // Business Structure\n \"businessStructureCode\": \"Business Structure Code\"\n },\n \"items\": [ // List of items included in the order\n {\n \"number\": \"Item number\",\n \"productCode\": \"Product code\",\n \"productName\": \"Product Name\",\n \"quantity\": \"Quantity of item on order\",\n \"unitTableValue\": \"Unit table value\",\n \"unitMarketValue\": \"Unit value practiced\",\n \"unitNetValue\": \"Net unit value\",\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\n \"associatedItem\": \"Indicates if the product is associated with another\",\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\n \"id\": \"Source code of associated item\",\n \"description\": \"Description of the associated item's origin\"\n },\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\n \"profitabilityValue\": \"Profitability Value\",\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\n \"id\": \"Item source code\",\n \"description\": \"Description of the item's origin\"\n },\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\n \"id\": \"Embedded item source code\",\n \"description\": \"Description of the embedded item's origin\"\n },\n \"promotionCode\": \"Promotion code\",\n \"promotionDescription\": \"Description of the promotion\",\n \"order\": \"Order\",\n \"collectionDate\": \"Date of collection\",\n \"orderCycle\": \"Capture cycle\",\n \"programPointsCode\": \"Point program code\",\n \"programPointsDescription\": \"Description of points program\",\n \"notificationCode\": \"Notification code\",\n \"productCode\": \"Embedded product code\"\n },\n \"isMaterialKit\": \"Indicates the material is a kit\",\n \"productDescription\": \"Product description\",\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\n \"id\": \"Unit of measurement code\",\n \"description\": \"Description of the unit of measure\"\n },\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\n \"flexNegotiation\": { // Product price negotiation\n \"minValue\": \"Minimum value the product must have\",\n \"maxValue\": \"Maximum value the product should have\",\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\n \"proposedNetValue\": \"Proposed Net Value\" ,\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\n \"id\": \"Negotiation status code\",\n \"description\": \"Description of trading status\"\n },\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\n },\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\n }\n ],\n \"cutItems\": [ // Cut Items\n {\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\n \"id\": \"Cut item type code\",\n \"description\": \"Description of cropped item type\"\n },\n \"productCode\": \"Product code\",\n \"productName\": \"Product Name\",\n \"quantity\": \"Product quantity\",\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\n \"id\": \"Cut ratio code\",\n \"description\": \"Description of the reason of cut\"\n },\n \"unitTableValue\": \"Unit table value\",\n \"unitMarketValue\": \"Unit value practiced\",\n \"isMaterialKit\": \"Indicates the material is a kit\",\n \"productDescription\": \"Product description\",\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\n }\n ],\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\n \"orderBusinessStatus\": { // Order business status - Possible values in glossary (Order Business Status)\n \"code\": \"Order status code\",\n \"description\": \"Description of the commercial status of the order\",\n \"dateCreated\": \"Order creation date\"\n },\n \"paymentPlans\": { // Default payment plan chosen for the order\n \"administrateTax\": \"Tax administrative\",\n \"code\": \"Payment plan code\",\n \"contingentPaymentPlans\": [], // contingency payment plans\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\n \"description\": \"Description of credit treatment\",\n \"id\": \"Credit handling code\"\n },\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\n \"description\": \"Description of external payment method\",\n \"id\": \"External payment method code\"\n },\n \"isBlocked\":\"Indicates if the payment plan is unavailable to be used in the current context of the order\",\n \"marketingMessages\": [], // List of marketing messages displayed for payment plan\n \"minimumInstallmentAmount\": \"Minimum amount of installments\",\n \"name\": \"Payment plan name\",\n \"paymentInfo\": [ // Payment information\n {\n \"installments\": [], // Installments\n \"installmentsQuantity\": \"Number of installments\"\n }\n ],\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\n \"description\": \"Description of payment method\",\n \"id\": \"Payment method code\"\n },\n \"showCreditConsumptionData\": { // Credit Consumption Data Setting - Possible values in glossary (Consumption Data Settings Credit)\n \"description\": \"No\",\n \"id\": 0\n },\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\n \"description\": \"Description of payment plan type\",\n \"id\": \"Payment plan type code\"\n }\n },\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\"\n }"}],"_postman_id":"4ee7cf2a-9ce4-4200-b710-9b014f2c091c"}],"id":"454bf7b8-7519-4066-904c-b76a50fef07a","description":"In this step, the application checks if there is any open order for the user who owns the order. If the endpoint returns the 204 No Content error, the application must continue the flow below to create a new request. If an order is returned, we must skip to step Capture Order.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a7f9ebfd-29d1-43a9-8dc7-57d67f2311cd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"80ee4614-8bd9-4a89-a51b-852a3ac508b5"}}],"_postman_id":"454bf7b8-7519-4066-904c-b76a50fef07a"},{"name":"3.2 Get Data to Start Order","item":[{"name":"3.2.1 Define Business Rule","item":[{"name":"See business rule","id":"b1b9915b-a5bc-4612-8ab3-b1bf662751df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/sellers/:id/businessModels?orderingSystemCode=&functionCode=&momentControlCenter=&associationControlCenterType=&businessModelCode=&applicationCode=&fixedDistributionCenterCode=&orderNumber=","description":"In the return object of the business model, there is the configurationSystem array. In it we have the business rule settings (these settings can be changed through the Let registration screen).
\n Even if a single business rule is used, it is important to go through this step to obtain the code of the currently active rule and the settings defined in the Let registration screen.
\n","urlObject":{"path":["api","sellers",":id","businessModels"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required) Collection system code.
\n","type":"text/plain"},"key":"orderingSystemCode","value":""},{"description":{"content":"(Mandatory)
\n Code of the possible functions of the business rule currently used:
\n |Code|Function|\n |-- -|-- -|\n |1|Reseller|\n |2|Collaborator|\n |9|End Consumer|
\n Heads up
\n When a person has more than one function, the application must send a functionCode parameter to each of the functions.
\n E.g.: &functionCode=&functionCode=
\n","type":"text/plain"},"key":"functionCode","value":""},{"description":{"content":"Time when the control center is used.
\n","type":"text/plain"},"key":"momentControlCenter","value":""},{"description":{"content":"Control center membership type:
\n\n\n\n | \n | \n
\n\n\n\n| 1 | \nNotApplicable | \n
\n\n| 2 | \nWhole Order | \n
\n\n| 3 | \nProduct | \n
\n\n
\n
Heads up
\n The application must send an associationControlCenterType parameter to each code.
\n E.g.: &associationassociationControlCenterType=2&associationControlCenterType3
\n","type":"text/plain"},"key":"associationControlCenterType","value":""},{"description":{"content":"Business rule code.
\n","type":"text/plain"},"key":"businessModelCode","value":""},{"description":{"content":"Application code.
\n","type":"text/plain"},"key":"applicationCode","value":""},{"description":{"content":"Fixed distribution center code, if the authenticated person is responsible for a CD.
\n","type":"text/plain"},"key":"fixedDistributionCenterCode","value":""},{"description":{"content":"For eCommerce orders, it is not recommended to use this parameter. It is used to get the business rule from an existing order.
\n","type":"text/plain"},"key":"orderNumber","value":""}],"variable":[{"id":"1f074dc5-af40-46b5-b1d5-3a5686626b5b","description":{"content":"(Mandatory)
\n Order owner user code.
\n","type":"text/plain"},"type":"any","value":"{{donoPedido}}","key":"id"}]}},"response":[{"id":"3e041132-2246-4a5a-8907-4b53acab0b47","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/businessModels?orderingSystemCode=&functionCode=&momentControlCenter=&associationControlCenterType=&businessModelCode=&applicationCode=&fixedDistributionCenterCode=&orderNumber=","host":["{{baseUrl}}"],"path":["api","sellers",":id","businessModels"],"query":[{"key":"orderingSystemCode","value":"","description":"**(Required)** Collection system code."},{"key":"functionCode","value":"","description":"**(Mandatory)**\n\n Code of the possible functions of the business rule currently used:\n\n |Code|Function|\n |-- -|-- -|\n |1|Reseller|\n |2|Collaborator|\n |9|End Consumer|\n\n **Heads up**\n\n When a person has more than one function, the application must send a `functionCode` parameter to each of the functions. \n\n E.g.: &functionCode=1&functionCode=2"},{"key":"momentControlCenter","value":"","description":"Time when the control center"},{"key":"associationControlCenterType","value":"","description":"Association Control Center Type:\n\n |||\n |-- |-- |\n |1|NotApplicable|\n |2|Whole Order|\n |3|Product|\n\n **Heads up**\n\n The application must send an `associationControlCenterType` parameter to each code. \n\n E.g.: &associationAccountType%5B%5D=2&associationAccountType%5B%5D=3"},{"key":"businessModelCode","value":"","description":"Business rule code."},{"key":"applicationCode","value":"","description":"Application code."},{"key":"fixedDistributionCenterCode","value":"","description":"Fixed distribution center code, if the authenticated person is responsible for a CD."},{"key":"orderNumber","value":"","description":"For eCommerce orders, it is not recommended to use this parameter. It is used to get the business rule from an existing order."}],"variable":[{"key":"id","value":"{{donoPedido}}","description":"**(Required)** Order owner user code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"Business rule code\",\n \"name\": \"Business rule name\",\n \"function\": { // Function for which the business rule is configured and has been filtered\n \"code\": \"Function code\"\n },\n \"role\": [ // List of roles for which the business rule is configured\n {\n \"code\": \"Paper code\",\n \"name\": \"Role name\"\n }\n ],\n \"orderingDescription\": \"Business rule alternative name\",\n \"businessModelDefault\": \"Default business rule\",\n \"profitabilityDefault\": \"Profitability Default\",\n \"configurationSystem\": { // Business rule settings for the source system (orderingSystemCode) entered \n \"allowsGiftPackaging\": \"Allows to select gift packaging\",\n \"allowsMultiplePackagingItems\": \"Allows multiple items in gift packaging\",\n \"creditLimitConsideringTolerance\": \"Display credit limit considering tolerance\",\n \"displayAlertMenssageExpiredData\": \"Display Expired Data Alert Message\",\n \"displayExportImportItems\": \"Allows to export/import items\",\n \"displayModalProductReplacement\": \"Allows displaying modal with substitute product\",\n \"useAlternativeOrderingDescription\": \"Use alternative description of business model in capture\",\n \"useCompositeMarketing\": \"Use marketing composite\",\n \"useCompositeMarketingPastCycles\": \"Use Composite Marketing Past Cycles\",\n \"quantityPastCyclesCompositeMarketing\": \"Amount of past cycles to be used in the marketing mix\",\n \"useCompositeMarketingFutureCycles\": \"Use Composite Marketing Future Cycles\",\n \"quantityFutureCyclesCompositeMarketing\": \"Amount of future cycles to be used in the marketing composite\",\n \"savesReserveOrder\": \"Allows to keep order reserved\",\n \"allowsCheckingAccountAdjustment\": \"Allows to change residual current account\",\n \"displayAlertPartialPromotions\": \"Display alert modal with partially won promotions\",\n \"allowAddAddressesApplication\": \"Allow add address\",\n \"allowShowEditableAddresses\": \"Allows to display addresses that can be edited\",\n \"requiredSelectAccount\": \"Requires selection of an account\",\n \"usesBarcode\": \"Uses barcode\" \n },\n \"minimumScore\": \"Minimum score\",\n \"maximumScore\": \"Maximum score\",\n \"minimumMileageScore\": \"Minimum Mileage Score\",\n \"minimumSaleScore\": \"Minimum Sale Score\",\n \"absoluteToleranceValue\": \"Absolute Tolerance Value\",\n \"absoluteExtraCreditValue\": \"Absolute Extra Credit Value\",\n \"isMaterialKitShow\": \"Indicates whether the application should show the materials that make up a Kit\",\n \"controlCenter\": [ // List of control centers\n {\n \"controlCenterNumber\": \"Control center number\",\n \"descriptionCode\": \"Control center description code\",\n \"description\": \"Control center description\",\n \"usedInCampaign\": \"Indicates if the control center is used in some campaign\",\n \"usedInOrder\": \"Indicates if the control center is used in any order\",\n \"usedInPromo\": \"Indicates if the control center is used in any promotions\",\n \"usedInMaterial\": \"Indicates if the control center is used in any material\",\n \"usedInSac\": \"Indicates if the control center is used in any SAC instance\",\n \"usedInFinancial\": \"Indicates whether the control center is used for a financial transaction\",\n \"usedInPricesFlexibility\": \"Indicates whether the control center is used for pricing flexibility\",\n \"controlType\": { // Control Center Type - Possible Glossary Values (Control Center Types)\n \"code\": \"Control center type code\",\n \"name\": \"Control center type name\" \n }\n }\n ],\n \"account\": [ // List of G/L accounts configured for business rule\n {\n \"code\": \"Account code\",\n \"name\": \"Account name\",\n \"movimentCode\": \"Motion code\"\n }\n ],\n \"isAllowedSellerIndicationInOrderItems\": \"Indicates whether a reseller can be referred to an order item\",\n \"isBlocked\": \"Indicates if the business rule is unavailable for use in the current order context\",\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\n \"id\": \"Value type code\",\n \"description\": \"Description of value type\" \n },\n \"minimumSellingMarginPercentual\": \"Minimum selling margin percentage\",\n \"isAllowedClosedBox\": \"Indicates whether it is possible to include items sold in closed boxes\"\n }\n ]"},{"id":"ba9733bf-3bbe-4f93-a5dd-2d693f645d04","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/businessModels?orderingSystemCode=3&functionCode=1&momentControlCenter=1&associationControlCenterType=2&businessModelCode=&applicationCode=2&fixedDistributionCenterCode=&orderNumber=","host":["{{baseUrl}}"],"path":["api","sellers",":id","businessModels"],"query":[{"key":"orderingSystemCode","value":"3","description":"**(Required)** Collection system code."},{"key":"functionCode","value":"1","description":"**(Mandatory)**\n\n Code of the possible functions of the business rule currently used:\n\n |Code|Function|\n |-- -|-- -|\n |1|Reseller|\n |2|Collaborator|\n |9|End Consumer|\n\n **Heads up**\n\n When a person has more than one function, the application must send a `functionCode` parameter to each of the functions. \n\n E.g.: &functionCode=1&functionCode=2"},{"key":"momentControlCenter","value":"1","description":"Time when the control center"},{"key":"associationControlCenterType","value":"2","description":"Association Control Center Type:\n\n |||\n |-- |-- |\n |1|NotApplicable|\n |2|Whole Order|\n |3|Product|\n\n **Heads up**\n\n The application must send an `associationControlCenterType` parameter to each code. \n\n E.g.: &associationAccountType%5B%5D=2&associationAccountType%5B%5D=3"},{"key":"businessModelCode","value":"","description":"Business rule code."},{"key":"applicationCode","value":"2","description":"Application code."},{"key":"fixedDistributionCenterCode","value":"","description":"Fixed distribution center code, if the authenticated person is responsible for a CD."},{"key":"orderNumber","value":"","description":"For eCommerce orders, it is not recommended to use this parameter. It is used to get the business rule from an existing order."}],"variable":[{"key":"id","value":"{{donoPedido}}","description":"**(Required)** Order owner user code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Wed, 18 Nov 2020 15:07:21 GMT"},{"key":"Content-Length","value":"887"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": 1,\n \"name\": \"Business Model 1\",\n \"function\": {\n \"code\": 1\n },\n \"orderingDescription\": \"Consultant - Resale of products - POS\",\n \"businessModelDefault\": false,\n \"profitabilityDefault\": 30,\n \"configurationSystem\": {\n \"allowsGiftPackaging\": true,\n \"allowsMultiplePackagingItems\": false,\n \"creditLimitConsideringTolerance\": true,\n \"displayAlertMenssageExpiredData\": false,\n \"displayExportImportItems\": true,\n \"displayModalProductReplacement\": true,\n \"useAlternativeOrderingDescription\": false,\n \"useCompositeMarketing\": true, \n \"useCompositeMarketingPastCycles\": false,\n \"quantityPastCyclesCompositeMarketing\": 4,\n \"useCompositeMarketingFutureCycles\": false,\n \"quantityFutureCyclesCompositeMarketing\": 3,\n \"savesReserveOrder\": true,\n \"allowsCheckingAccountAdjustment\": true,\n \"displayAlertPartialPromotions\": true,\n \"allowAddAddressesApplication\": true,\n \"allowShowEditableAddresses\": true,\n \"requiredSelectAccount\": false,\n \"usesBarcode\": false\n },\n \"minimumScore\": 0,\n \"maximumScore\": 999999900,\n \"minimumMileageScore\": 0,\n \"minimumSaleScore\": 0,\n \"absoluteToleranceValue\": 0,\n \"absoluteExtraCreditValue\": 0,\n \"isMaterialKitShow\": false,\n \"isAllowedSellerIndicationInOrderItems\": false,\n \"isBlocked\": true,\n \"minimumOrderType\": {\n \"id\": 1,\n \"description\": \"Monetary\"\n },\n \"isAllowedClosedBox\": false,\n \"controlCenter\": [\n {\n \"controlCenterNumber\": 1,\n \"descriptionCode\": \"1\",\n \"description\": \"Test Price Flexibility 001\",\n \"usedInCampaign\": false,\n \"usedInOrder\": true,\n \"usedInPromo\": true,\n \"usedInMaterial\": false,\n \"usedInSac\": false,\n \"usedInFinancial\": false,\n \"usedInPricesFlexibility\": true,\n \"controlType\": {\n \"code\": 1,\n \"name\": \"Cost Center\"\n }\n }\n ],\n \"account\": [\n {\n \"code\": 2,\n \"name\": \"Outgoing by sale (Outgoing to Sale)\",\n \"motionCode\": 1\n }\n ]\n },\n {\n \"code\": 4,\n \"name\": \"Business model cod. two\",\n \"function\": {\n \"code\": 1\n },\n \"orderingDescription\": \"QA Test - Consultant - Initial Order for Resale Products - POS\",\n \"businessModelDefault\": false,\n \"profitabilityDefault\": 0,\n \"configurationSystem\": {\n \"allowsGiftPackaging\": false,\n \"allowsMultiplePackagingItems\": false,\n \"creditLimitConsideringTolerance\": true,\n \"displayAlertMenssageExpiredData\": false,\n \"displayExportImportItems\": true,\n \"displayModalProductReplacement\": false,\n \"useAlternativeOrderingDescription\": false,\n \"useCompositeMarketing\": true,\n \"useCompositeMarketingPastCycles\": false,\n \"quantityPastCyclesCompositeMarketing\": 4,\n \"useCompositeMarketingFutureCycles\": false,\n \"quantityFutureCyclesCompositeMarketing\": 3,\n \"savesReserveOrder\": true,\n \"allowsCheckingAccountAdjustment\": true,\n \"displayAlertPartialPromotions\": false,\n \"allowAddAddressesApplication\": false,\n \"allowShowEditableAddresses\": true,\n \"requiredSelectAccount\": false,\n \"usesBarcode\": false\n },\n \"minimumScore\": 100,\n \"maximumScore\": 100000000,\n \"minimumMileageScore\": 0,\n \"minimumSaleScore\": 100,\n \"absoluteToleranceValue\": 0,\n \"absoluteExtraCreditValue\": 0,\n \"isMaterialKitShow\": false,\n \"account\": [\n {\n \"code\": 2,\n \"name\": \"Outgoing by sale (Outgoing to Sale)\",\n \"motionCode\": 1\n }\n ],\n \"isAllowedSellerIndicationInOrderItems\": false,\n \"isBlocked\": true,\n \"minimumOrderType\": {\n \"id\": 0,\n \"description\": \"Points\"\n },\n \"isAllowedClosedBox\": false\n },\n {\n \"code\": 12,\n \"name\": \"Direct sales model\",\n \"function\": {\n \"code\": 1\n },\n \"orderingDescription\": \"POS\",\n \"businessModelDefault\": false,\n \"profitabilityDefault\": 10,\n \"configurationSystem\": {\n \"allowsGiftPackaging\": false,\n \"allowsMultiplePackagingItems\": false,\n \"creditLimitConsideringTolerance\": true,\n \"displayAlertMenssageExpiredData\": false,\n \"displayExportImportItems\": true,\n \"displayModalProductReplacement\": false,\n \"useAlternativeOrderingDescription\": false,\n \"useCompositeMarketing\": true,\n \"useCompositeMarketingPastCycles\": false,\n \"quantityPastCyclesCompositeMarketing\": 4,\n \"useCompositeMarketingFutureCycles\": false,\n \"quantityFutureCyclesCompositeMarketing\": 3,\n \"savesReserveOrder\": true, \n \"allowsCheckingAccountAdjustment\": false,\n \"displayAlertPartialPromotions\": false,\n \"allowAddAddressesApplication\": false,\n \"allowShowEditableAddresses\": false,\n \"requiredSelectAccount\": false,\n \"usesBarcode\": false\n },\n \"minimumScore\": 1000,\n \"maximumScore\": 1000000,\n \"minimumMileageScore\": 0,\n \"minimumSaleScore\": 1000,\n \"absoluteToleranceValue\": 0,\n \"absoluteExtraCreditValue\": 0,\n \"isMaterialKitShow\": false,\n \"account\": [\n {\n \"code\": 1,\n \"name\": \"Entry by Acquisition (Entry by Local Purchase)\",\n \"motionCode\": 31\n }\n ],\n \"isAllowedSellerIndicationInOrderItems\": false,\n \"isBlocked\": true,\n \"minimumOrderType\": {\n \"id\": 1,\n \"description\": \"Monetary\"\n },\n \"isAllowedClosedBox\": false\n },\n {\n \"code\": 25,\n \"name\": \"INNOVATE 1 Model\",\n \"function\": {\n \"code\": 1\n },\n \"orderingDescription\": \"Consultant - Product resale - Innovation\",\n \"businessModelDefault\": true,\n \"profitabilityDefault\": 30,\n \"configurationSystem\": {\n \"allowsGiftPackaging\": false,\n \"allowsMultiplePackagingItems\": false,\n \"creditLimitConsideringTolerance\": true,\n \"displayAlertMenssageExpiredData\": false,\n \"displayExportImportItems\": true,\n \"displayModalProductReplacement\": true,\n \"useAlternativeOrderingDescription\": true,\n \"useCompositeMarketing\": true,\n \"useCompositeMarketingPastCycles\": false,\n \"quantityPastCyclesCompositeMarketing\": 4,\n \"useCompositeMarketingFutureCycles\": false,\n \"quantityFutureCyclesCompositeMarketing\": 3,\n \"savesReserveOrder\": true,\n \"allowsCheckingAccountAdjustment\": true,\n \"displayAlertPartialPromotions\": true,\n \"allowAddAddressesApplication\": true, \n \"allowShowEditableAddresses\": true,\n \"requiredSelectAccount\": false,\n \"usesBarcode\": false\n },\n \"minimumScore\": 10000,\n \"maximumScore\": 100000000,\n \"minimumMileageScore\": 0,\n \"minimumSaleScore\": 10000,\n \"absoluteToleranceValue\": 0,\n \"absoluteExtraCreditValue\": 0,\n \"isMaterialKitShow\": false,\n \"account\": [\n {\n \"code\": 1,\n \"name\": \"Entry by Acquisition (Entry by Local Purchase)\",\n \"motionCode\": 31\n },\n {\n \"code\": 2,\n \"name\": \"Outgoing by sale (Outgoing to Sale)\", \n \"motionCode\": 1\n }\n ],\n \"isAllowedSellerIndicationInOrderItems\": false,\n \"isBlocked\": true,\n \"minimumOrderType\": {\n \"id\": 1,\n \"description\": \"Monetary\"\n },\n \"isAllowedClosedBox\": false\n }\n ]"}],"_postman_id":"b1b9915b-a5bc-4612-8ab3-b1bf662751df"},{"name":"Consult delivery mode","id":"3eba9525-0a02-47dd-a342-a95c5f6a1693","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/sellers/:sellerId/businessModels/:businessModelsId/deliveryMode","description":"Each business rule has delivery methods configured (eg, receive at delivery address or the CDs the person can pick up from).
\n What defines whether the order should be withdrawn on a CD or delivered is the isWithdrawalCenter return parameter of this call. If the value of this parameter is true, then the order must be checked out on a CD. If it is false, it must be delivered.
\n","urlObject":{"path":["api","sellers",":sellerId","businessModels",":businessModelsId","deliveryMode"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"Fixed distribution center code, if the authenticated person is responsible for a CD.
\n","type":"text/plain"},"key":"fixedDistributionCenterCode","value":""}],"variable":[{"id":"a650a63d-3354-4f07-8cb1-7af199e9f3a2","description":{"content":"(Required) Order owner user code.
\n","type":"text/plain"},"type":"any","value":"{{donoPedido}}","key":"sellerid"},{"id":"f0ba56d1-a797-44e1-be64-ed968758f147","description":{"content":"(Required) Business rule code.
\n","type":"text/plain"},"type":"any","value":"","key":"businessModelsId"}]}},"response":[{"id":"1d4c5884-749e-4864-b126-0a85efd2be50","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:sellerId/businessModels/:businessModelsId/deliveryMode","host":["{{baseUrl}}"],"path":["api","sellers",":sellerId","businessModels",":businessModelsId","deliveryMode"],"query":[{"key":"fixedDistributionCenterCode","value":"","description":"Fixed distribution center code, if the authenticated person is responsible for a CD.","disabled":true}],"variable":[{"key":"sellerid","value":"{{donoPedido}}","description":"**(Required)** Order owner user code."},{"key":"businessModelsId","value":"","description":"**(Required)** Business rule code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 16 Nov 2020 18:57:04 GMT"},{"key":"Content-Length","value":"200"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\n \"distributionCenterCode\": \"Distribution center code\",\n \"distributionCenterName\": \"Distribution Center Name\",\n \"address\": \"Distribution center address\"\n }\n ]"},{"id":"0d2fe287-8c12-44a9-9242-c8cf577820a3","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:sellerId/businessModels/:businessModelsId/deliveryMode","host":["{{baseUrl}}"],"path":["api","sellers",":sellerId","businessModels",":businessModelsId","deliveryMode"],"query":[{"key":"fixedDistributionCenterCode","value":"","description":"Fixed distribution center code, if the authenticated person is responsible for a CD.","disabled":true}],"variable":[{"key":"sellerid","value":"{{donoPedido}}","description":"**(Required)** Order owner user code."},{"key":"businessModelsId","value":"5","description":"**(Required)** Business rule code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 16 Nov 2020 18:57:04 GMT"},{"key":"Content-Length","value":"200"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"isWithdrawalCenter\": false,\n \"distributionCenterCode\": 1,\n \"distributionCenterName\": \"Ecommerce Order Capture Center\",\n \"address\": \"AVENIDA IGUAÇU 2820 - ÁGUA VERDE - CURITIBA - PR - BRAZIL - CEP: 80240-031\"\n }\n ]"}],"_postman_id":"3eba9525-0a02-47dd-a342-a95c5f6a1693"}],"id":"21d8134e-25b1-4c19-b7b6-f7ce75ef90e7","description":"To define the business rule to be used in the order, you must first get the person's roles.
\n On the return object from this call, there is the code attribute. The value of this attribute will be inserted as a parameter in the call to get delivery mode.
\nDefine G/L Account
\n In the return object of the Get Business Rule call, there is an attribute called \"account\", as we can see below:
\n \"account\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"motionCode\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"motionCode\": \"\"\n }\n ]
\n These are the possible G/L accounts that the user can choose to capture the order. If no account is defined, the platform will automatically select the first one related to the rule.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"cddeb37d-6951-4787-be88-8da132351c06"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ee00aea8-0658-4e81-8e95-d996e4875d81"}}],"_postman_id":"21d8134e-25b1-4c19-b7b6-f7ce75ef90e7"},{"name":"3.2.2 Define Sales Cycle","item":[{"name":"Change sales cycle","id":"60fc403c-a8ee-4ccc-b969-1f40e64b15f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{baseUrl}}/api/sellers/:id/nextCycle?functionCode=&businessModelCode=","description":"This call is used to change a user's sales cycle.
\n","urlObject":{"path":["api","sellers",":id","nextCycle"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Mandatory)
\n Function code of the business rule that will be used in the order.
\n","type":"text/plain"},"key":"functionCode","value":""},{"description":{"content":"(Mandatory)
\n Code of the business rule that will be used in the order.
\n","type":"text/plain"},"key":"businessModelCode","value":""}],"variable":[{"id":"888bce7b-f975-4a4a-8ca7-8065a50255c7","description":{"content":"(Mandatory)
\n User code that owns the order, whose cycle will be exchanged.
\n","type":"text/plain"},"type":"any","value":"{{donoPedido}}","key":"id"}]}},"response":[{"id":"3c85ede7-a965-4788-bbed-441757fbe86d","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/nextCycle?functionCode=&businessModelCode=","host":["{{baseUrl}}"],"path":["api","sellers",":id","nextCycle"],"query":[{"key":"functionCode","value":"","description":"**(Mandatory)**\n\n Function code of the business rule that will be used in the order."},{"key":"businessModelCode","value":"","description":"**(Mandatory)**\n\n Code of the business rule that will be used in the order."}],"variable":[{"key":"id","value":"{{donoPedido}}","description":"**(Mandatory)**\n\n User code that owns the order, whose cycle will be exchanged."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"60fc403c-a8ee-4ccc-b969-1f40e64b15f3"}],"id":"d2ec1685-4e84-4dd5-9cca-8942b31e3694","description":"In this step, the sales cycle in which the order will be captured will be defined. If the user has permission and chooses to seize the order in the next cycle, it will be switched to the future cycle.
\n In the callback object to get shopper info, there are some important attributes highlighted below:
\n\nbusinessData:
\nnextCycle: Person's next cycle, if there is future cycle open for structure;
\ncurrentCycle: Current cycle of the person who will be used in the order.
\n
\n If the current cycle is different from the future cycle, there are two open cycles. If the user/system has permission, he can perform a capture in one of the cycles.
\n If the system parameter AllowCaptureOnNextCampaignInExtendedPeriodWithoutCloseBuyerCampaign is true, it is possible to place an order in a future cycle without closing the current cycle (more details in Create Order). If it is false, to capture an order in the future cycle, it is necessary to close the current cycle.
\n Heads up
\n Once the call has been made and the API has been successfully processed, the person will be switched to the next cycle. As a result, it will no longer have the option to capture in the previous cycle.
\n When performing this process, it is necessary to get business rule again, because with the change of cycle, the data can be changed.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"033087a0-ed6f-4e24-9849-3ca4badf8025"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0cfaa28a-71a8-42cf-991c-66b3fd2dcb75"}}],"_postman_id":"d2ec1685-4e84-4dd5-9cca-8942b31e3694"},{"name":"3.2.3 Define Marketing Cycle and Sub-cycle","item":[],"id":"1b2580af-1286-4308-8cf7-3e5ae3bb2954","description":"After defining the sales cycle, the marketing cycle and sub-cycle can be defined, if the commercial rule allows it.
\n Marketing cycle and sub-cycle are a bonus provided by the company so that the customer can benefit from prices and promotions from future and/or past cycles.
\n With business rule settings:
\n\nuseCompositeMarketing: Allows you to use composite marketing cycles;
\nuseCompositeMarketingPastCycles: Allows you to use past composite marketing cycles;
\nquantityPastCyclesCompositeMarketing: Number of past cycles to be used in the marketing composite;
\nuseCompositeMarketingFutureCycles: Allows you to use future composite marketing cycles;
\nquantityFutureCyclesCompositeMarketing: Number of future cycles to be used in the marketing composite;
\n
\nGet Marketing Cycle
\n The application must first get the available marketing cycles. The initialCycle and cycleOffset parameters are taken from the call response to get the business rule.
\n\ninitialCycle: This parameter indicates the cycle from which the counting should start. In the response object of the call to get person info, the current cycle of this person is returned via the currentCycle attribute;
\ncycleOffset: This parameter indicates the number of cycles desired in the callback list. This number can be positive or negative, depending on the response parameters of the call to get business rule:
\nIf the useCompositeMarketingPastCycles attribute is enabled, the value of cycleOffset will be negative, with cardinality equal to the value of the quantityPastCyclesCompositeMarketing attribute;
\nIf the useCompositeMarketingFutureCycles attribute is enabled, the value of cycleOffset is positive, with cardinality equal to the value of the quantityFutureCyclesCompositeMarketing attribute.
\n
\nGet Marketing Cycle Details.
\n After obtaining the possible cycles for the marketing mix, you need to get cycle details, such as date, sub-cycle and days to close.
\n This call must be made for each cycle returned from the marketing mix (17/2016, 01/2017, 02/2017, 03/2017, 04/2017).
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6503ab28-afd6-425c-b9b3-1bcc50a91cdd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7cedf10c-ab36-46ba-a9a9-a43d6c06a24c"}}],"_postman_id":"1b2580af-1286-4308-8cf7-3e5ae3bb2954"}],"id":"d54dc9d0-5b04-42cb-ac19-e417a4cf45e5","description":"There are three ways to work with an order:
\n\nEC- eCommerce;
\nPOS- Point of Sales;
\nVI- Indirect sales;
\n
\n If the order is typeECorPOS, the application must get the mode of delivery right after obtaining the business rule.
\n Before starting an order, we need to obtain a series of information to define some essential details for the capture.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d6391636-9784-41c6-8a8d-81eeb8ccb339"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"240e9ce7-f895-4658-97b8-f807de3e23d5"}}],"_postman_id":"d54dc9d0-5b04-42cb-ac19-e417a4cf45e5"},{"name":"3.3 Get Start Kit","item":[{"name":"Consult items to incorporate","id":"37f1db08-4b13-4c7f-b709-adacea1f092d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/sellers/:id/itemsToChoose?businessModelCode=&originSystem={{originSystem}}","description":"This call is used to get the items present in KIT Home.
\n","urlObject":{"path":["api","sellers",":id","itemsToChoose"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required) Code of the business rule chosen for the order.
\n","type":"text/plain"},"key":"businessModelCode","value":""},{"description":{"content":"(Required) Source system code.
\n","type":"text/plain"},"key":"originSystem","value":"{{originSystem}}"}],"variable":[{"id":"4335ad33-c6cf-4c38-bed7-ee27a0b94b4c","description":{"content":"(Required) Order owner code.
\n","type":"text/plain"},"type":"any","value":"{{donoPedido}}","key":"id"}]}},"response":[{"id":"b41dbe42-ae45-4952-9670-9c63247a70a6","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/itemsToChoose?businessModelCode=5&originSystem={{originSystem}}","host":["{{baseUrl}}"],"path":["api","sellers",":id","itemsToChoose"],"query":[{"key":"businessModelCode","value":"5","description":"**(Required)** Code of the business rule chosen for the order."},{"key":"originSystem","value":"{{originSystem}}","description":"**(Required)** Source system code."}],"variable":[{"key":"id","value":"{{donoPedido}}","description":"**(Required)** Order owner code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-Record-Count","value":"1"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Tue, 17 Nov 2020 14:53:40 GMT"},{"key":"Content-Length","value":"472"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": 3247,\n \"typeInfo\": {\n \"id\": 1,\n \"description\": \"Sale\"\n },\n \"sourceInfo\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"quantity\": 1,\n \"productStructure\": {\n \"code\": 7,\n \"name\": \"Male\"\n },\n \"products\": [\n {\n \"code\": 17,\n \"name\": \"Product 17\",\n \"isMaterialKit\": false,\n \"productDescription\": \"Product 17\"\n },\n {\n \"code\": 24,\n \"name\": \"Product 24\", \n \"isMaterialKit\": false,\n \"productDescription\": \"Sensual Fougere.\"\n },\n {\n \"code\": 35,\n \"name\": \"Impression Eau de Perfum\",\n \"isMaterialKit\": false,\n \"productDescription\": \"Impression Eau de Perfum\"\n },\n {\n \"code\": 38,\n \"name\": \"Coffe Man\",\n \"isMaterialKit\": false,\n \"productDescription\": \"Coffe Man\"\n },\n {\n \"code\": 41,\n \"name\": \"ZAAD Vision\",\n \"isMaterialKit\": false,\n \"productDescription\": \"ZAAD Vision\"\n },\n {\n \"code\": 42,\n \"name\": \"ZAAD MONDO\",\n \"isMaterialKit\": false,\n \"productDescription\": \"ZAAD MONDO\"\n },\n {\n \"code\": 47,\n \"name\": \"Kaiak deo colonia Adventure Male\",\n \"isMaterialKit\": false,\n \"productDescription\": \"Product Description 47\"\n }\n ],\n \"isMandatory\": false\n }\n ]"},{"id":"25f9aa19-2af8-413a-b96e-5df66f2b5c4f","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/sellers/:id/itemsToChoose?businessModelCode=5&originSystem={{originSystem}}","host":["{{baseUrl}}"],"path":["api","sellers",":id","itemsToChoose"],"query":[{"key":"businessModelCode","value":"5","description":"**(Required)** Code of the business rule chosen for the order."},{"key":"originSystem","value":"{{originSystem}}","description":"**(Required)** Source system code."}],"variable":[{"key":"id","value":"{{donoPedido}}","description":"**(Required)** Order owner code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-Record-Count","value":"1"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Tue, 17 Nov 2020 14:53:40 GMT"},{"key":"Content-Length","value":"472"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"Code of list of items to embed\",\n \"isMandatory\": \"Indicates that the user must choose a product from the list\",\n \"productStructure\": { // Product Structure\n \"code\": \"Product structure code\",\n \"name\": \"Product structure name\"\n },\n \"products\": [ // List of products\n {\n \"code\": \"Product code\",\n \"name\": \"Product name\",\n \"isMaterialKit\": \"Indicates the material is a Kit\",\n \"productDescription\": \"Product Description\"\n }\n ],\n \"quantity\": \"Quantity of the product that will be incorporated into the order\",\n \"typeInfo\": { // Type of embedded item - Possible values in the glossary (Types of Embedded Items)\n \"id\": \"Embedded item type code\",\n \"description\": \"Description of embedded item type\"\n },\n \"sourceInfo\": { // Source of embedded item - Possible values in glossary (Product Source)\n \"id\": \"Embedded item source code\",\n \"description\": \"Description of the embedded item's origin\"\n }\n }\n ]"}],"_postman_id":"37f1db08-4b13-4c7f-b709-adacea1f092d"}],"id":"f6774afa-9bbb-4826-a230-ba459a684c7d","description":"After obtaining the necessary data to initiate the order, the application should get Starter Kit listings. To proceed, the user must choose at least one item from each Kit. The information for each product chosen must be used when creating the order.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4846b94d-3bf5-4b70-a328-2f5fe463fb37"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"118cb148-6bde-4506-970d-6656b5f9a402"}}],"_postman_id":"f6774afa-9bbb-4826-a230-ba459a684c7d"},{"name":"3.4 Create Order (*)","item":[{"name":"create new order","event":[{"listen":"test","script":{"exec":["var created = tests[\"Status code is 201\"] = responseCode.code === 201;\r","postman.setEnvironmentVariable(\"codigoPedido\", null);\r","\r","if(created)\r","{\r"," // Set the new token to the Local let environment\r"," var data = JSON.parse(responseBody);\r"," var codigoPedido = data.number\r"," postman.setEnvironmentVariable(\"codigoPedido\", codigoPedido);\r","}"],"type":"text/javascript","id":"bfce4d98-c978-44d1-b07f-7ce479d3fb0b"}}],"id":"47d5cd0b-372c-4409-96e7-9e5bfd6164a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"representativeCode","value":"{{donoPedido}}","description":"Order owner code.
\n"},{"key":"businessModelCode","value":"","description":"Code of the business rule chosen for the order.
\n"},{"key":"controlCenterCode","value":"","description":"Got from call response object to get business rule.
\n"},{"key":"itemsToChoose","value":"[{\"productCode\":\"\"\"itemToChooseCode\":\"\"}]","description":"List of chosen items to embed.
\n\nproductCode: Product code;itemToChooseCode: Code of the item to embed;
\n"},{"key":"accountingAccountCode","value":"","description":"Got from call response object to get business rule.
\n"},{"key":"accountingMovementType","value":"","description":"Got from call response object to get business rule.
\n"},{"key":"collectionMode","value":"{{collectionMode}}","description":"Capture mode code.
\n"},{"key":"isWithdrawalCenter","value":"","description":"If the order being created is of type EC or VI, this parameter must be passed with its due value, according to the call response object to obtain the delivery mode. If it is POS, the parameter must be deactivated at this time.
\n\n\n\n | \n | \n
\n\n\n\ntrue | \nOrder must be picked up at a distribution center | \n
\n\nfalse | \nOrder must be delivered to a registered address | \n
\n\n
\n
If the above parameter is enabled and its value is true, this must also be enabled. Its value is taken from the same source as the above parameter.
\n"},{"key":"collectionSystem","value":"{{collectionSystem}}","description":"Capture system code.
\n"},{"key":"marketingcycle","value":"","description":"Marketing cycle to be used in ordering. Obtained in step \"Defining Marketing Cycle and Sub-cycle\".
\n"},{"key":"marketingSubCycle","value":"","description":"Marketing sub-cycle to be used in ordering. Obtained in step \"Defining Marketing Cycle and Sub-cycle\".
\n"},{"key":"originSystem","value":"{{originSystem}}","description":"Source system code.
\n"},{"key":"orderIndicatedSellerCode","value":"","description":"If the order is for an end consumer, this parameter must be activated and its value must be equal to the code of the end consumer for which the order is being captured.
\n"},{"key":"startNewCycle","value":"","description":"If the system parameter AllowCaptureOnNextCampaignInExtendedPeriodWithoutCloseBuyerCampaign is true, this parameter is also true.
\n"},{"key":"choosePaymentPlan","value":"","description":"Payment plan definition moment.
\n If the order to be captured is a type VI, the payment plan must be defined before initiating the order. For this, code 1 must be passed.
\n In the case of EC and POS orders, the payment plan must be defined at the end of the qualification process. For this, code 2 must be passed.
\n"}]},"url":"{{baseUrl}}/api/orders","description":"This call is used to create a new order.
\n After creating the order, a code 201 - Created and an object with the data of the created order will be returned.
\n","urlObject":{"path":["api","orders"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"edbcedda-d151-444a-8117-57f93eb9e8d7","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"representativeCode","value":"{{donoPedido}}","description":"Order owner code."},{"key":"businessModelCode","value":"","description":"Code of the business rule chosen for the order."},{"key":"controlCenterCode","value":"","description":"Got from call response object to get business rule."},{"key":"itemsToChoose","value":"[{\"productCode\":\"\"\"itemToChooseCode\":\"\"]","description":"List of chosen items to embed. \n\n * `productCode`: Product code;\n * `itemToChooseCode`: Code of the item to embed;"},{"key":"accountingAccountCode","value":"","description":"Got from call response object to get business rule."},{"key":"accountingMovementType","value":"","description":"Got from call response object to get business rule."},{"key":"collectionMode","value":"{{collectionMode}}","description":"Capture mode code."},{"key":"isWithdrawalCenter","value":"","description":"If the order being created is of type EC or VI, this parameter must be passed with its due value, according to the call response object to obtain the delivery mode. If it is POS, the parameter must be deactivated at this time. \n\n |||\n |-- |-- |\n |`true`|Order must be picked up at a distribution center|\n |`false`|Order must be delivered to a registered address|"},{"key":"distributionCenterCode","value":"","description":"If the above parameter is enabled and its value is `true`, this must also be enabled. Its value is taken from the same source as the above parameter."},{"key":"collectionSystem","value":"{{collectionSystem}}","description":"Capture system code."},{"key":"marketingcycle","value":"","description":"Marketing cycle to be used in ordering. Obtained in step \"Defining Marketing Cycle and Sub-cycle\"."},{"key":"marketingSubCycle","value":"","description":"Marketing sub-cycle to be used in ordering. Obtained in step \"Defining Marketing Cycle and Sub-cycle\"."},{"key":"originSystem","value":"{{originSystem}}","description":"Source system code."},{"key":"orderIndicatedSellerCode","value":"","description":"If the order is for an end consumer, this parameter must be activated and its value must be equal to the code of the end consumer for which the order is being captured."},{"key":"startNewCycle","value":"","description":"If the system parameter `AllowCaptureOnNextCampaignInExtendedPeriodWithoutCloseBuyerCampaign` is `true`, this parameter is also `true`."},{"key":"choosePaymentPlan","value":"{{choosePaymentPlan}}","description":"Payment plan definition moment. \n\n If the order to be captured is a type VI, the payment plan must be defined before initiating the order. For this, code 1 must be passed. \n\n In the case of EC and POS orders, the payment plan must be defined at the end of the qualification process. For this, code 2 must be passed."}]},"url":"{{baseUrl}}/api/orders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\",\r\n \"businessInformation\": { // Business information\r\n \"paid\": \"Indicates if the order has already been paid\",\r\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\r\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\r\n \"itemsQuantity\": \"Quantity of items included in the order\",\r\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\r\n \"pointsQuantity\": \"Amount of points earned on order\",\r\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"tableValue\": \"Product table value\",\r\n \"marketValue\": \"Product value practiced\",\r\n \"netValue\": \"Net product value\",\r\n \"businessModelCode\": \"Business rule code\",\r\n \"businessModelName\": \"Business Rule Name\",\r\n \"functionCode\": \"Person's Function Code\",\r\n \"simulatedValue\": \"Simulated order value\",\r\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\r\n \"simulatedOrderPoints\": \"Simulated order point value\",\r\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\r\n \"distributionCenterCode\": \"Distribution center code\",\r\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\r\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\r\n \"id\": \"Value type code\",\r\n \"description\": \"Description of value type\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\r\n \"flexBalanceAvailable\": \"Available flex budget amount\",\r\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\r\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\r\n \"proposedNetValue\": \"Proposed trading value\",\r\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \r\n },\r\n \"businessStructure\": { // Business Structure\r\n \"businessStructureCode\": \"Business Structure Code\"\r\n },\r\n \"cutItems\": [ // Cut Items\r\n {\r\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\r\n \"id\": \"Cut item type code\",\r\n \"description\": \"Description of cropped item type\"\r\n },\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\",\r\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\r\n \"id\": \"Cut ratio code\",\r\n \"description\": \"Description of the cut ratio\"\r\n },\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\r\n \"items\": [ // List of items included in the order\r\n {\r\n \"number\": \"Item number\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Name of product\",\r\n \"quantity\": \"Quantity of item on order\",\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"unitNetValue\": \"Net unit value\",\r\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\r\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\",\r\n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\r\n \"associatedItem\": \"Indicates if the product is associated with another\",\r\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\r\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins) \r\n \"id\": \"Source code of associated item\",\r\n \"description\": \"Description of the associated item's origin\"\r\n },\r\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\r\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\r\n \"profitabilityValue\": \"Profitability Value\",\r\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\r\n \"id\": \"Item source code\",\r\n \"description\": \"Description of the item's origin\"\r\n },\r\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\r\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\r\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\r\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\r\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\r\n \"id\": \"Embedded item source code\",\r\n \"description\": \"Description of the embedded item's origin\"\r\n },\r\n \"promotionCode\": \"Promotion code\",\r\n \"promotionDescription\": \"Promotion description\",\r\n \"order\": \"Order\",\r\n \"collectionDate\": \"Date of collection\",\r\n \"orderCycle\": \"Capture cycle\",\r\n \"programPointsCode\": \"Point program code\",\r\n \"programPointsDescription\": \"Description of points program\",\r\n \"notificationCode\": \"Notification code\",\r\n \"productCode\": \"Embedded product code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\r\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Unit of measurement code\",\r\n \"description\": \"Description of the unit of measure\" \r\n },\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"flexNegotiation\": { // Product price negotiation\r\n \"minValue\": \"Minimum value the product must have\",\r\n \"maxValue\": \"Maximum value the product should have\",\r\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\r\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\r\n \"proposedNetValue\": \"Proposed Net Value\" ,\r\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\r\n \"id\": \"Negotiation status code\",\r\n \"description\": \"Description of trading status\" \r\n },\r\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\r\n },\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"number\": \"Order number\",\r\n \"orderBusinessStatus\": { // Order business status - Possible values in glossary (Order Business Status)\r\n \"code\": \"Order status code\",\r\n \"description\": \"Description of the commercial status of the order\",\r\n \"dateCreated\": \"Order creation date\"\r\n }\r\n }"},{"id":"8cba3dce-ae88-4bba-8a96-86a3efa81504","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"representativeCode","value":"{{donoPedido}}","description":"Order owner code."},{"key":"businessModelCode","value":"5","description":"Code of the business rule chosen for the order."},{"key":"controlCenterCode","value":"","description":"Got from call response object to get business rule.","disabled":true},{"key":"itemsToChoose","value":"[{\"productCode\":\"\"\"itemToChooseCode\":\"\"]","description":"List of chosen items to embed. \n\n * `productCode`: Product code;\n * `itemToChooseCode`: Code of the item to embed;","disabled":true},{"key":"accountingAccountCode","value":"","description":"Got from call response object to get business rule.","disabled":true},{"key":"accountingMovementType","value":"","description":"Got from call response object to get business rule.","disabled":true},{"key":"collectionMode","value":"{{collectionMode}}","description":"Capture mode code."},{"key":"isWithdrawalCenter","value":"false","description":"If the order being created is of type EC or VI, this parameter must be passed with its due value, according to the call response object to obtain the delivery mode. If it is POS, the parameter must be deactivated at this time. \n\n |||\n |-- |-- |\n |`true`|Order must be picked up at a distribution center|\n |`false`|Order must be delivered to a registered address|"},{"key":"distributionCenterCode","value":"","description":"If the above parameter is enabled and its value is `true`, this must also be enabled. Its value is taken from the same source as the above parameter.","disabled":true},{"key":"collectionSystem","value":"{{collectionSystem}}","description":"Capture system code."},{"key":"marketingcycle","value":"","description":"Marketing cycle to be used in ordering. Obtained in step \"Defining Marketing Cycle and Sub-cycle\"."},{"key":"marketingSubCycle","value":"","description":"Marketing sub-cycle to be used in ordering. Obtained in step \"Defining Marketing Cycle and Sub-cycle\".","disabled":true},{"key":"originSystem","value":"{{originSystem}}","description":"Source system code."},{"key":"orderIndicatedSellerCode","value":"","description":"If the order is for an end consumer, this parameter must be activated and its value must be equal to the code of the end consumer for which the order is being captured.","disabled":true},{"key":"startNewCycle","value":"false","description":"If the system parameter `AllowCaptureOnNextCampaignInExtendedPeriodWithoutCloseBuyerCampaign` is `true`, this parameter is also `true`."},{"key":"choosePaymentPlan","value":"{{choosePaymentPlan}}","description":"Payment plan definition moment. \n\n If the order to be captured is a type VI, the payment plan must be defined before initiating the order. For this, code 1 must be passed. \n\n In the case of EC and POS orders, the payment plan must be defined at the end of the qualification process. For this, code 2 must be passed."}]},"url":"{{baseUrl}}/api/orders"},"status":"created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"location","value":"http://inovadevapisgi.geravd.com.br/api/orders/16276113"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 23 Nov 2020 15:56:18 GMT"},{"key":"Content-Length","value":"729"}],"cookie":[],"responseTime":null,"body":"{\n \"number\": 16276113,\n \"businessInformation\": {\n \"paid\": false,\n \"orderingCycle\": 202011,\n \"marketingCycle\": 202011,\n \"itemsQuantity\": 0,\n \"productsQuantity\": 0,\n \"pointsQuantity\": 0,\n \"minimumPointsQuantity\": 11100,\n \"tableValue\": 0,\n \"marketValue\": 0,\n \"netValue\": 0,\n \"businessModelCode\": 5,\n \"businessModelName\": \"Business Model - Final Consumer\",\n \"functionCode\": 9,\n \"simulatedValue\": 0,\n \"simulatedPoints\": 14223,\n \"simulatedOrderPoints\": 0,\n \"simulatedValueProfitabilityGifts\": 0,\n \"distributionCenterCode\": 1,\n \"isWithdrawalCenter\": false,\n \"minimumPointsQuantityConsideredOrder\": 0,\n \"minimumOrderType\": {\n \"id\": 1,\n \"description\": \"Monetary\"\n },\n \"allowChangeIncorporatedItemQuantity\": true,\n \"flexBalanceAvailable\": 0,\n \"flexBalanceAmountConsumed\": 0,\n \"flexBalanceUpdatedAvailable\": 0,\n \"proposedNetValue\": 0,\n \"allowFlexNegotiation\": false\n },\n \"businessStructure\": {\n \"businessStructureCode\": 30\n },\n \"items\": [\n {\n \"number\": 1,\n \"productCode\": 23,\n \"productName\": \"Product 01\",\n \"quantity\": 1,\n \"unitTableValue\": 18,\n \"unitMarketValue\": 18,\n \"unitNetValue\": 18,\n \"unitPointsQuantity\": 1800,\n \"unitKitPointsQuantity\": 0,\n \"unitMultilevelPointsQuantity\": 0,\n \"associatedItem\": true,\n \"associatedItemRequired\": false,\n \"associatedItemOrigin\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"simulatedValueProfitability\": 18,\n \"simulatedValueProfitabilityUnit\": 18,\n \"profitabilityValue\": 0,\n \"origin\": {\n \"id\": 1,\n \"description\": \"Sale\"\n }, \n \"isBloquedRemoveItem\": false,\n \"isBlockedEditQuantity\": true,\n \"confirmAssociatedItemDeletion\": false,\n \"associatedItemOriginDetails\": {\n \"origin\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"promotionCode\": 12351,\n \"promotionDescription\": \"Promotion 01\",\n \"order\": 12345,\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\n \"orderCycle\": 202001,\n \"programPointsCode\": 2,\n \"programPointsDescription\": \"Points Program 01\",\n \"notificationCode\": 2,\n \"productCode\": 32\n },\n \"isMaterialKit\": false,\n \"productDescription\": \"Product 01\",\n \"hasDiscountValue\": false,\n \"hasAppliedProfitabilityValueAddItem\": false,\n \"multipleSaleRestriction\": 1,\n \"displayItemWithDiscountPromotion\": false,\n \"unitMeasurementType\": {\n \"id\": 1,\n \"description\": \"un\"\n },\n \"quantityUnitMeasurement\": 1,\n \"pricePerUnitMeasurement\": 18,\n \"flexNegotiation\": {\n \"minValue\": 17.99,\n \"maxValue\": 19.99,\n \"initialUnitNetValue\": 18,\n \"proposedUnitNetValue\": 0,\n \"proposedNetValue\": 0,\n \"status\": {\n \"id\": 1,\n \"description\": \"Not traded\" \n },\n \"allowFlexNegotiation\": true\n },\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n }\n ],\n \"cutItems\": [\n {\n \"type\": {\n \"id\": 3,\n \"description\": \"Embedded\"\n },\n \"productCode\": 17,\n \"productName\": \"Product 01\",\n \"quantity\": 1,\n \"cutReason\": {\n \"id\": 2,\n \"description\": \"Price not registered\"\n },\n \"unitTableValue\": 0,\n \"unitMarketValue\": 0,\n \"isMaterialKit\": false, \n \"productDescription\": \"Product Description 01\",\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n },\n {\n \"type\": {\n \"id\": 3,\n \"description\": \"Embedded\"\n },\n \"productCode\": 22,\n \"productName\": \"Product 02\",\n \"quantity\": 1,\n \"cutReason\": {\n \"id\": 8,\n \"description\": \"Discontinued product\"\n },\n \"unitTableValue\": 0,\n \"unitMarketValue\": 0,\n \"isMaterialKit\": false,\n \"productDescription\": \"Product Description 02\",\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n }\n ],\n \"externalPreAuthorization\": false,\n \"orderBusinessStatus\": {\n \"code\": 1,\n \"description\": \"\",\n \"dateCreated\": \"2020-11-23T12:56:12.983Z\"\n },\n \"allRewardsPromotion\": false\n }"}],"_postman_id":"47d5cd0b-372c-4409-96e7-9e5bfd6164a6"}],"id":"41678312-a962-4281-9905-5ea78e3f6dd6","description":"After obtaining the Starter Kit, the application should create a new order. To define the value of some parameters, the application must define the type of order to be created (EC, PDV, VI).
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f70ea2d0-d349-4eca-ba21-e6fc68e715a0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"02f6596b-1ddb-44e7-8ceb-ce76726d46a7"}}],"_postman_id":"41678312-a962-4281-9905-5ea78e3f6dd6"},{"name":"Order VI - Order Payment (*)","item":[],"id":"93d4397e-d94e-45e3-b892-967429b4fd48","description":"If the order is of type VI, the application must define the payment plan for the order before proceeding with the capture. This will be indicated by the parameter choosePaymentPlan = 1 in the order object.
\n First the application must see payment plans. After user selection, application must select payment plan chosen.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"06e1995d-7408-4679-bc8b-8b6400be407e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"581bdc6a-1ffd-4021-bd9a-07941e44afd8"}}],"_postman_id":"93d4397e-d94e-45e3-b892-967429b4fd48"},{"name":"CF Request - Appoint consultant","item":[{"name":"Select consultant","id":"45280039-1bef-491f-92bb-d08f407530c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PATCH","header":[],"url":"{{baseUrl}}/api/orders/:id/orderIndicatedSeller?orderIndicatedSellerCode=","description":"This call is used to select a consultant for a referral.
\n","urlObject":{"path":["api","orders",":id","orderIndicatedSeller"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required) Consultant code.
\n","type":"text/plain"},"key":"orderIndicatedSellerCode","value":""}],"variable":[{"id":"3c84cfe2-33f0-4399-a5ed-e6b372f822ac","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"156a2fb3-6765-41c2-aa68-3158a8d86b07","name":"OK","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/orderIndicatedSeller?orderIndicatedSellerCode=","host":["{{baseUrl}}"],"path":["api","orders",":id","orderIndicatedSeller"],"query":[{"key":"orderIndicatedSellerCode","value":"","description":"**(Required)** Consultant code."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"45280039-1bef-491f-92bb-d08f407530c9"},{"name":"Remove consultant","id":"3124b31a-0a45-4c93-a0e1-938e60aeb5f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{baseUrl}}/api/orders/:id/orderIndicatedSeller","description":"This call is used to remove an indication.
\n","urlObject":{"path":["api","orders",":id","orderIndicatedSeller"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"c23acede-2e5e-4232-a9ca-0056c3b0a2ff","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"fc418671-d99d-46f7-87e5-f2a379a5e93f","name":"OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/orderIndicatedSeller","host":["{{baseUrl}}"],"path":["api","orders",":id","orderIndicatedSeller"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3124b31a-0a45-4c93-a0e1-938e60aeb5f9"}],"id":"a33299c5-6b59-43f6-bb82-1e2fd3fefb32","description":"If the order is for end consumer and the user wants to refer a known reseller, the application must follow this flow.
\nSearch Valid Consultants
\n To search for valid consultants, the user can use its geographic structure, the name or code of the consultant.
\nSelect Consultant
\n After user selection, application should select consultant desired.
\nRemove Consultant
\n If the user wants to remove the selected advisor, the application must remove the advisor from the order.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"466cc364-ba85-48b6-a0d8-6039d1b6c495"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"909dee0b-c82e-4916-b62d-32e6672dbffc"}}],"_postman_id":"a33299c5-6b59-43f6-bb82-1e2fd3fefb32"},{"name":"3.5 Get Valid Promotions","item":[{"name":"Consult promotions","id":"78471a6e-c09f-49c8-a9e3-4e776a68bc0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/Orders/:id/promotions?display=&suggest=","description":"This call is used to look up promotions available for an order.
\n","urlObject":{"path":["api","Orders",":id","promotions"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"This parameter configures the display filter for promotions registered in the system.
\n\n\n\n | \n | \n
\n\n\n\ntrue (Default) | \nShows promotions configured to be displayed on the screen | \n
\n\nfalse | \nShows promotions configured not to be displayed on the screen | \n
\n\n
\n
Suggests promotion.
\n","type":"text/plain"},"key":"suggest","value":""}],"variable":[{"id":"ba344da0-f5a4-418e-88da-e8aea328ffb3","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"f4cc36ab-123a-4fa6-bc85-81be319d2f95","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/Orders/:id/promotions?display=&suggest=","host":["{{baseUrl}}"],"path":["api","Orders",":id","promotions"],"query":[{"key":"display","value":""},{"key":"suggest","value":""}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"Promotion code\",\n \"title\": \"Promotion title\",\n \"description\": \"Description of the promotion\",\n \"destination\": { // Promotion destination - Possible values in glossary (Promotion destinations)\n \"id\": \"Destination code\",\n \"description\": \"Destination description\"\n },\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\n \"maxRangeValuesToDisplay\": \"Maximum value of promotions to be displayed\",\n \"orderExhibition\": \"Orders the displayed promotions\",\n \"display\": \"Indicates if the application displays the won promotion\",\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\"\n }\n ]"},{"id":"8053275d-2228-4ae1-b14a-6d7b9eb08758","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/Orders/:id/promotions?display=true&suggest=true","host":["{{baseUrl}}"],"path":["api","Orders",":id","promotions"],"query":[{"key":"display","value":"true","description":"This parameter configures the display filter for promotions registered in the system. \n\n |||\n |-- |-- |\n |`true` (*Default value*)|Shows promotions configured to be displayed on the screen|\n |`false`|Shows promotions configured not to be displayed on the screen|"},{"key":"suggest","value":"true","description":"Suggests promotion."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 23 Nov 2020 18:02:03 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"code\": 573,\r\n \"description\": \"Product: 5 and 6\",\r\n \"destination\": {\r\n \"id\": 1,\r\n \"description\": \"Reseller\"\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Scenario 4\"\r\n },\r\n {\r\n \"code\": 570,\r\n \"description\": \"Product: 2 and 3\",\r\n \"destination\": {\r\n \"id\": 1,\r\n \"description\": \"Reseller\"\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Scenario 2\"\r\n },\r\n {\r\n \"code\": 569,\r\n \"description\": \"Product: 2 and 3\",\r\n \"destination\": {\r\n \"id\": 1,\r\n \"description\": \"Reseller\"\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Scenario 3\"\r\n }\r\n ]"}],"_postman_id":"78471a6e-c09f-49c8-a9e3-4e776a68bc0f"}],"id":"5b0c3951-a436-4a8b-8ab9-dadbfe1c1dfb","description":"","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e3baa487-1a2b-4e13-88e9-0ba5a4e27fca"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6886c3ae-38c1-4e04-8873-eccd0106c3de"}}],"_postman_id":"5b0c3951-a436-4a8b-8ab9-dadbfe1c1dfb"},{"name":"Book/Cancel Order","item":[{"name":"book order","id":"0768dea8-eafd-4f39-8cd3-ec0a668f4058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{baseUrl}}/api/orders/:id/reserve","description":"There is a setting in Letto cancel an order - releasing stock of products - after a period of inactivity (can be set inLet; Default = 2 hours).
\n If the user intends to initiate an order in the morning and finish it at the end of the day, this call should be used to store the order data - not losing the information after the downtime is reached.
\n There are two ways to save order information. In the response object of the call to get the business rule, there is an object called configurationSystem. This object has the savesReserveOrder attribute. If this attribute is enabled (value == true), the user can save the order. If disabled (value == false), a purchase suggestion is generated with the order information.
\n","urlObject":{"path":["api","orders",":id","reserve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"f94adf36-d09e-4239-8e06-f256c9a088b1","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"f983bfb5-98c5-460b-97c4-2c2464979eac","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/reserve","host":["{{baseUrl}}"],"path":["api","orders",":id","reserve"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 23 Nov 2020 18:12:41 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": \"Order number\",\r\n \"businessInformation\": { // Business Information\r\n \"paid\": \"Indicates if the order has already been paid\",\r\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\r\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\r\n \"itemsQuantity\": \"Quantity of items included in the order\",\r\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\r\n \"pointsQuantity\": \"Amount of points earned on order\",\r\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"tableValue\": \"Product table value\",\r\n \"marketValue\": \"Product value practiced\",\r\n \"netValue\": \"Net product value\",\r\n \"businessModelCode\": \"Business rule code\",\r\n \"businessModelName\": \"Business Rule Name\",\r\n \"functionCode\": \"Person's Function Code\",\r\n \"simulatedValue\": \"Simulated order value\",\r\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\r\n \"simulatedOrderPoints\": \"Simulated order point value\",\r\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\r\n \"distributionCenterCode\": \"Distribution center code\",\r\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\r\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\r\n \"id\": \"Value type code\",\r\n \"description\": \"Description of value type\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\r\n \"flexBalanceAvailable\": \"Available flex budget amount\",\r\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\r\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\r\n \"proposedNetValue\": \"Proposed trading value\",\r\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \r\n },\r\n \"businessStructure\": { // Business Structure\r\n \"businessStructureCode\": \"Business Structure Code\"\r\n },\r\n \"items\": [ // List of items included in the order\r\n {\r\n \"number\": \"Item number\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Quantity of item on order\",\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"unitNetValue\": \"Net unit value\",\r\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\r\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \r\n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\r\n \"associatedItem\": \"Indicates if the product is associated with another\",\r\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\r\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\r\n \"id\": \"Source code of associated item\",\r\n \"description\": \"Description of the associated item's origin\"\r\n },\r\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\r\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\r\n \"profitabilityValue\": \"Profitability Value\",\r\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\r\n \"id\": \"Item source code\",\r\n \"description\": \"Description of the item's origin\"\r\n },\r\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\r\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\r\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\r\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\r\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\r\n \"id\": \"Embedded item source code\",\r\n \"description\": \"Description of the embedded item's origin\"\r\n },\r\n \"promotionCode\": \"Promotion code\",\r\n \"promotionDescription\": \"Description of the promotion\",\r\n \"order\": \"Order\",\r\n \"collectionDate\": \"Date of collection\",\r\n \"orderCycle\": \"Capture cycle\",\r\n \"programPointsCode\": \"Point program code\",\r\n \"programPointsDescription\": \"Description of points program\",\r\n \"notificationCode\": \"Notification code\",\r\n \"productCode\": \"Embedded product code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\r\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Unit of measurement code\",\r\n \"description\": \"Description of the unit of measure\"\r\n },\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"flexNegotiation\": { // Product price negotiation\r\n \"minValue\": \"Minimum value the product must have\",\r\n \"maxValue\": \"Maximum value the product should have\",\r\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\r\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\r\n \"proposedNetValue\": \"Proposed Net Value\" ,\r\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\r\n \"id\": \"Negotiation status code\",\r\n \"description\": \"Description of trading status\"\r\n },\r\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\r\n },\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"cutItems\": [ // Cut Items\r\n {\r\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\r\n \"id\": \"Cut item type code\",\r\n \"description\": \"Description of cropped item type\"\r\n },\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\",\r\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\r\n \"id\": \"Cut ratio code\",\r\n \"description\": \"Description of the reason of cut\"\r\n },\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\r\n \"orderBusinessStatus\": { // Order business status - Possible values in glossary (Order Business Status)\r\n \"code\": \"Order status code\",\r\n \"description\": \"Description of the commercial status of the order\",\r\n \"dateCreated\": \"Order creation date\"\r\n },\r\n \"paymentPlans\": { // Default payment plan chosen for the order\r\n \"administrateTax\": \"Tax administrative\",\r\n \"code\": \"Payment plan code\",\r\n \"contingentPaymentPlans\": [], // contingency payment plans\r\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\r\n \"description\": \"Description of credit treatment\",\r\n \"id\": \"Credit handling code\"\r\n },\r\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\r\n \"description\": \"Description of external payment method\",\r\n \"id\": \"External payment method code\"\r\n },\r\n \"isBlocked\":\"Indicates if the payment plan is unavailable to be used in the current context of the order\",\r\n \"marketingMessages\": [], // List of marketing messages displayed for payment plan\r\n \"minimumInstallmentAmount\": \"Minimum Installment Value\",\r\n \"name\": \"Payment plan name\",\r\n \"paymentInfo\": [ // Payment information\r\n {\r\n \"installments\": [], // Installments\r\n \"installmentsQuantity\": \"Number of installments\"\r\n }\r\n ],\r\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\r\n \"description\": \"Description of payment method\",\r\n \"id\": \"Payment method code\"\r\n },\r\n \"showCreditConsumptionData\": { // Credit Consumption Data Setting - Possible values in glossary (Credit Consumption Data Settings) \r\n \"description\": \"Configuration description\",\r\n \"id\": \"Configuration code\"\r\n },\r\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\r\n \"description\": \"Description of payment plan type\",\r\n \"id\": \"Payment plan type code\"\r\n }\r\n },\r\n \"acquiredPromotion\": [ // List of earned promotions\r\n {\r\n \"code\": \"Code of the earned promotion\",\r\n \"deliveryDiscountPromotion\": [ // List of promotions won by the selected delivery option\r\n {\r\n \"discount\": \"Discount\",\r\n \"type\": { // Type of award\r\n \"id\": \"Award Type Code\",\r\n \"description\": \"Description of award type\"\r\n }\r\n }\r\n ],\r\n \"description\": \"Description of the achieved promotion\",\r\n \"destination\": { // Promotion destination - Possible values in glossary (Promotion destinations)\r\n \"id\": \"Destination code\",\r\n \"description\": \"Destination description\"\r\n },\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Displays the missing items for a promotion to be won\",\r\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\r\n \"itemOrderDeliveryDiscountPromotion\": [ // List of items with discounts earned by the selected delivery option \r\n {\r\n \"discount\": \"Discount\",\r\n \"type\": { // Type of award\r\n \"id\": \"Award Type Code\",\r\n \"description\": \"Description of award type\"\r\n }\r\n }\r\n ],\r\n \"mileagePromotion\": [ // List of conquered promotions that generate points\r\n {\r\n \"points\": \"Amount of points earned\",\r\n \"type\": { // Type of award\r\n \"id\": \"Award Type Code\",\r\n \"description\": \"Description of award type\"\r\n }\r\n }\r\n ],\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"rewards\": [ // List of prizes awarded by the promotion \r\n {\r\n \"discount\": \"Discount granted\",\r\n \"isGiftToChoose\": \"Indicates if the prize is a gift\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productCode\": \"Product code\",\r\n \"productDescription\": \"Product description\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\"\r\n }\r\n ],\r\n \"type\": { // Award type of the won promotion - Possible values in the glossary (Promotion Award Types)\r\n \"id\": \"Promotion Prize Type Code\",\r\n \"description\": \"Description of promotion prize type\"\r\n },\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can come to win in the request\",\r\n \"title\": \"Promotion title\"\r\n }\r\n ],\r\n \"partialPromotions\": [ // List of promotions not yet reached\r\n {\r\n \"code\": \"Promotion code\",\r\n \"description\": \"Description of the promotion\",\r\n \"destination\": { // Destination of the promotion\r\n \"description\": \"Destination description\",\r\n \"id\": \"Destination code\"\r\n },\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\r\n \"orderExhibition\": \"Orders promotions displayed\",\r\n \"requirements\": // List of conditions for the promotion to be achieved\r\n [\r\n {\r\n \"description\": \"Description of the condition of winning the promotion\",\r\n \"logicOperator\": { // Logical operator - Possible values in glossary (Logical Operators)\r\n \"description\": \"Description of the logical operator\",\r\n \"id\": \"Logical operator code\"\r\n },\r\n \"missingValue\": \"Value required for the condition to be satisfied\",\r\n \"productRequired\": { // Product required\r\n \"isKit\": \"Indicates if the product is a Kit\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"points\": \"Amount of points the product is worth\", \r\n \"productCode\": \"Product code required\",\r\n \"productDescription\": \"Description of required product\",\r\n \"productName\": \"Required product name\",\r\n \"unityPrice\": \"Unit price of product required\"\r\n },\r\n \"valueType\": { // Value Type - Possible Glossary Values (Value Types)\r\n \"description\": \"Description of value type\",\r\n \"id\": \"Value type code\"\r\n }\r\n }\r\n ],\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\"\r\n }\r\n ],\r\n \"paymentPlansByProduct\": [ // List of payment plans payment by product\r\n {\r\n \"administrateTax\": \"Administrative tax\",\r\n \"code\": \"Code of payment plan by product\",\r\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\r\n \"description\": \"Description of credit treatment\",\r\n \"id\": \"Credit handling code\"\r\n },\r\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\r\n \"description\": \"Description of external payment method\",\r\n \"id\": \"External payment method code\"\r\n },\r\n \"isBlocked\": \"Indicates if the payment plan is unavailable to be used in the current context of the order\" ,\r\n \"marketingMessages\": [], // List of marketing messages displayed for payment plan\r\n \"minimumInstallmentAmount\": \"Minimum Installment Value\",\r\n \"name\": \"Payment plan name\",\r\n \"paymentInfo\": [ // Payment information\r\n {\r\n \"installments\": [], // Installments\r\n \"installmentsQuantity\": \"Number of installments\"\r\n }\r\n ],\r\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\r\n \"description\": \"Description of payment method\",\r\n \"id\": \"Payment method code\"\r\n },\r\n \"productCode\": \"Product code associated with payment plan\",\r\n \"showCreditConsumptionData\": { // Credit consumption data configuration - Possible values in the glossary (Credit consumption data settings)\r\n \"description\": \"Configuration description\",\r\n \"id\": \"Configuration code\"\r\n },\r\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\r\n \"description\": \"Description of payment plan type\",\r\n \"id\": \"Payment plan type code\"\r\n }\r\n }\r\n ],\r\n \"representative\": { // Order owner\r\n \"representativeCode\": \"Order owner code\"\r\n },\r\n \"rewardsToChoosePromotions\": [ // List of available rewards\r\n {\r\n \"chosenDiscount\": \"Indicates that the user chose a discount\",\r\n \"chosenProducts\": \"Indicates the user has chosen products\",\r\n \"code\": \"Promotion code\",\r\n \"description\": \"Description of the promotion\",\r\n \"destination\": { // Destination of the promotion\r\n \"description\": \"Destination description\",\r\n \"id\": \"Destination code\"\r\n },\r\n \"discountDescription\": \"Discount description\",\r\n \"discountNumber\": \"Discount number\",\r\n \"discountToChoose\": [ // List of available discounts\r\n {\r\n \"auxiliaryDescription\": \"Auxiliary Description\",\r\n \"code\": \"Discount code\",\r\n \"discountTargetType\": { // Discount Target Type - Possible Glossary Values (Discount Target Types) \r\n \"description\": \"Description of target type\",\r\n \"id\": \"Target Type Code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"rewardType\": { // Reward Type - Possible Glossary Values (Reward Types)\r\n \"description\": \"Description of the type of award\",\r\n \"id\": \"Award Type Code\"\r\n },\r\n \"value\": \"Discount amount\"\r\n }\r\n ],\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"giftItemNumber\": \"Gift Item Number\",\r\n \"giftNumber\": \"Gift number\", \r\n \"giftValue\": \"Gift Value\",\r\n \"giftValueType\": { // Gift Value Type - Possible values in the glossary (Gift Value Types)\r\n \"description\": \"Description of the type of gift value\",\r\n \"id\": \"Gift Value Type Code\"\r\n },\r\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\r\n \"message\": \"Message\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"productsToChoose\": [ // List of available products\r\n {\r\n \"chosenQuantity\": \"Chosen Quantity\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"isReorderAllowed\": \"Indicates that the product can be incorporated into a future order if it does not currently exist inventory\",\r\n \"productCode\": \"Product code\",\r\n \"productDescription\": \"Product description\",\r\n \"productName\": \"Product Name\",\r\n \"unavailable\": \"Indicates if the item is available\",\r\n \"value\": \"Product value\"\r\n }\r\n ],\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\",\r\n \"unavaiableDiscount\": \"Indicates if the discount is unavailable\"\r\n }\r\n ],\r\n \"totals\": { // Total order values\r\n \"allowsCheckingAccountAdjustment\": \"Indicates whether it is possible to edit the residual checking account value\",\r\n \"checkingAccountOriginalValue\": \"Value original of the residual current account\",\r\n \"checkingAccountTotalValue\": \"Total value of the residual current account\",\r\n \"checkingAccountValue\": \"Updated residual current account value\",\r\n \"collectionFee\": \"Payment Plan Charge Rate\",\r\n \"commissionValue\": \"Commission Value\",\r\n \"creditCheckingAccountValue\": \"Total amount available on credit account\",\r\n \"debitCheckingAccountValue\": \"Total amount available on debit account\",\r\n \"deliveryTax\": \"Delivery rate\",\r\n \"negotiationDiscount\": \"Negotiated discount\",\r\n \"productsValue\": \"Value of products\",\r\n \"promotionDiscount\": \"Promotion Discount\",\r\n \"simulatedNetValue\": \"Simulated net value\",\r\n \"taxesValue\": \"Value of taxes\", \r\n \"totalProductValueWithoutDiscount\": \"Total value of products without discount\",\r\n \"totalValue\": \"Total Value\",\r\n \"totalValueWithoutDiscount\": \"Total value without discount\"\r\n },\r\n \"unavailablePromotions\": [ // List of unavailable promotions\r\n {\r\n \"code\": \"Promotion code\",\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\"\r\n } \r\n ],\r\n \"validPromotion\": [ // List of valid promotions for the order\r\n {\r\n \"number\": \"Valid promotion number\",\r\n \"productCode\": \"Product code that activates the promotion\",\r\n \"productName\": \"Name of the product that activates the promotion\",\r\n \"promotion\": { // Promotion settings\r\n \"code\": \"Promotion code\",\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Title of promotion\"\r\n },\r\n \"quantity\": \"Amount of product needed to win the promotion\"\r\n }\r\n ],\r\n \"deliveryAddress\": { // Delivery address\r\n \"addressLevel0\": \"Name of the geographic structure referring to level 0 of the address\",\r\n \"addressLevel1\": \"Name of the geographic structure that refers to the first level of the address\",\r\n \"addressLevel2\": \"Name of the geographic structure that refers to the second level of the address\",\r\n \"addressLevel3\": \"Name of the geographic structure that refers to the third level of the address\",\r\n \"addressLevel4\": \"Name of the geographic structure that refers to the fourth level of the address\",\r\n \"areaCode\": \"Area Code\",\r\n \"externalStructureCode\": \"Code of external structure\",\r\n \"formattedAddress\": \"Formatted address\",\r\n \"number\": \"Number\",\r\n \"people\": { // Person associated with address\r\n \"code\": \"Code of the person associated with the address\",\r\n \"name\": \"Name of person associated with address\"\r\n },\r\n \"readOnly\": \"Cannot be edited; only consulted\",\r\n \"regionCode\": \"Region code\",\r\n \"selected\": \"Indicates the shipping address is selected\",\r\n \"type\": { // Address Type - Possible Glossary Values (Address Types) - In this scenario, only residential, business and delivery addresses are accepted. \r\n \"id\": \"Address type code\",\r\n \"description\": \"Description of address type\"\r\n }\r\n },\r\n \"deliveryOption\": { // Delivery mode\r\n \"code\": \"Delivery mode code\",\r\n \"description\": \"Description of delivery mode\",\r\n \"name\": \"Delivery mode name\",\r\n \"scheduledDate\": \"Scheduled delivery date\",\r\n \"scheduledDeliveryType\": { // Scheduled Delivery Type - Possible Glossary Values (Scheduled Delivery Types)\r\n \"id\": \"Scheduled delivery type code\",\r\n \"description\": \"Description of scheduled delivery type\"\r\n },\r\n \"selected\": \"Indicates if the delivery option is selected\",\r\n \"term\": \"Amount of days of delivery time\",\r\n \"type\": { // Delivery Type - Possible Glossary Values (Delivery Types)\r\n \"id\": \"Delivery type code\",\r\n \"description\": \"Description of delivery type\"\r\n },\r\n \"value\": \"Cost of delivery\"\r\n },\r\n \"deliveryInformation\": { // Delivery Information\r\n \"carrierCode\": \"Carrier Code\",\r\n \"carrierName\": \"Carrier Name\",\r\n \"originalScheduledDeliveryDate\": \"Original delivery date\",\r\n \"scheduledDeliveryDate\": \"Updated delivery date\"\r\n },\r\n \"withdrawalsOptions\": { // Withdrawals Options\r\n \"deliveryOptionCode\": \"Delivery Option Code\"\r\n },\r\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\"\r\n }"},{"id":"1774d926-1181-4c6b-a06a-d4ef87187680","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/reserve","host":["{{baseUrl}}"],"path":["api","orders",":id","reserve"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 23 Nov 2020 18:12:41 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": 16276089,\r\n \"businessInformation\": {\r\n \"paid\": false,\r\n \"orderingCycle\": 202011,\r\n \"marketingCycle\": 202011,\r\n \"itemsQuantity\": 1,\r\n \"productsQuantity\": 1,\r\n \"pointsQuantity\": 1800,\r\n \"minimumPointsQuantity\": 11100,\r\n \"tableValue\": 18,\r\n \"marketValue\": 18,\r\n \"netValue\": 18,\r\n \"businessModelCode\": 5,\r\n \"businessModelName\": \"Business Model - Final Consumer\",\r\n \"functionCode\": 9,\r\n \"simulatedValue\": 18,\r\n \"simulatedPoints\": 12423,\r\n \"simulatedOrderPoints\": 1800,\r\n \"simulatedValueProfitabilityGifts\": 0,\r\n \"distributionCenterCode\": 1,\r\n \"isWithdrawalCenter\": false,\r\n \"minimumPointsQuantityConsideredOrder\": 1800,\r\n \"minimumOrderType\": {\r\n \"id\": 1,\r\n \"description\": \"Monetary\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": true,\r\n \"flexBalanceAvailable\": 0,\r\n \"flexBalanceAmountConsumed\": 0,\r\n \"flexBalanceUpdatedAvailable\": 0,\r\n \"proposedNetValue\": 0,\r\n \"allowFlexNegotiation\": false\r\n },\r\n \"businessStructure\": {\r\n \"businessStructureCode\": 30\r\n },\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"productCode\": 23, \r\n \"productName\": \"Product 01\",\r\n \"quantity\": 1,\r\n \"unitTableValue\": 18,\r\n \"unitMarketValue\": 18,\r\n \"unitNetValue\": 18,\r\n \"unitPointsQuantity\": 1800,\r\n \"unitKitPointsQuantity\": 0,\r\n \"unitMultilevelPointsQuantity\": 0,\r\n \"associatedItem\": true,\r\n \"associatedItemRequired\": false,\r\n \"associatedItemOrigin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"simulatedValueProfitability\": 18,\r\n \"simulatedValueProfitabilityUnit\": 18,\r\n \"profitabilityValue\": 0,\r\n \"origin\": {\r\n \"id\": 1,\r\n \"description\": \"Sale\" \r\n },\r\n \"isBloquedRemoveItem\": false,\r\n \"isBlockedEditQuantity\": true,\r\n \"confirmAssociatedItemDeletion\": false,\r\n \"associatedItemOriginDetails\": {\r\n \"origin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"promotionCode\": 12351,\r\n \"promotionDescription\": \"Promotion 01\",\r\n \"order\": 12345,\r\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\r\n \"orderCycle\": 202001,\r\n \"programPointsCode\": 2,\r\n \"programPointsDescription\": \"Points Program 01\",\r\n \"notificationCode\": 2,\r\n \"productCode\": 32\r\n },\r\n \"isMaterialKit\": false, \r\n \"productDescription\": \"Product 01\",\r\n \"hasDiscountValue\": false,\r\n \"hasAppliedProfitabilityValueAddItem\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"displayItemWithDiscountPromotion\": false,\r\n \"unitMeasurementType\": {\r\n \"id\": 1,\r\n \"description\": \"un\"\r\n },\r\n \"quantityUnitMeasurement\": 1,\r\n \"pricePerUnitMeasurement\": 18,\r\n \"flexNegotiation\": {\r\n \"minValue\": 17.99,\r\n \"maxValue\": 19.99,\r\n \"initialUnitNetValue\": 18,\r\n \"proposedUnitNetValue\": 0,\r\n \"proposedNetValue\": 0,\r\n \"status\": {\r\n \"id\": 1,\r\n \"description\": \"No negotiated\"\r\n },\r\n \"allowFlexNegotiation\": true\r\n },\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"cutItems\": [\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 17,\r\n \"productName\": \"Product 02\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 2,\r\n \"description\": \"Price not registered\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 02\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n },\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 22,\r\n \"productName\": \"Product 03\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 8,\r\n \"description\": \"Discontinued product\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 03\",\r\n \"isClosedBoxProduct\": false, \r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"externalPreAuthorization\": false,\r\n \"orderBusinessStatus\": {\r\n \"code\": 7,\r\n \"description\": \"Reserved\",\r\n \"dateCreated\": \"2020-11-13T16:24:05.197Z\"\r\n },\r\n \"allRewardsPromotion\": false,\r\n \"paymentPlans\": {\r\n \"administrateTax\": 0,\r\n \"code\": 17,\r\n \"contingentPaymentPlans\": [],\r\n \"creditTreatment\": {\r\n \"description\": \"Ignore credit - does not consume credit\",\r\n \"id\": 3\r\n },\r\n \"externalPaymentMethod\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"isBlocked\": false,\r\n \"marketingMessages\": [\r\n {\r\n \"priority\": 0,\r\n \"text\": \"Message when selecting the receiving plan\"\r\n }\r\n ],\r\n \"minimumInstallmentAmount\": 0,\r\n \"name\": \"Currency(BRL)\",\r\n \"paymentInfo\": [\r\n {\r\n \"installments\":[1] ,\r\n \"installmentsQuantity\": 1\r\n }\r\n ],\r\n \"paymentMode\": {\r\n \"description\": \"In Kind\",\r\n \"id\": 11\r\n },\r\n \"showCreditConsumptionData\": {\r\n \"description\": \"No\", \r\n \"id\": 0\r\n },\r\n \"type\": {\r\n \"description\": \"Prepaid\",\r\n \"id\": 1\r\n }\r\n },\r\n \"acquiredPromotion\": [\r\n {\r\n \"code\": 568,\r\n \"deliveryDiscountPromotion\": [\r\n {\r\n \"discount\": 10,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Percentage Discount\"\r\n }\r\n }\r\n ],\r\n \"description\": \"Product code 1\",\r\n \"destination\": {\r\n \"id\": 1,\r\n \"description\": \"Reseller\"\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"itemOrderDeliveryDiscountPromotion\": [\r\n {\r\n \"discount\": 10,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Percentage Discount\"\r\n }\r\n }\r\n ],\r\n \"mileagePromotion\": [\r\n {\r\n \"points\": 100,\r\n \"type\": {\r\n \"id\": 5,\r\n \"description\": \"Miles\"\r\n }\r\n }\r\n ],\r\n \"orderExhibition\": 2147483647,\r\n \"rewards\": [\r\n {\r\n \"discount\": 3, \r\n \"isGiftToChoose\": false,\r\n \"isMaterialKit\": true,\r\n \"productCode\": 1,\r\n \"productDescription\": \"Product Kit Home - 1\",\r\n \"productName\": \"Product Kit Home - 1\",\r\n \"quantity\": 3\r\n }\r\n ],\r\n \"type\": {\r\n \"id\": 4,\r\n \"description\": \"Absolute discount\"\r\n },\r\n \"suggest\": true,\r\n \"title\": \"Promo Scenario 01\"\r\n }\r\n ],\r\n \"deliveryAddress\": {\r\n \"addressLevel0\": \"BRAZIL\",\r\n \"addressLevel1\": \"PR\",\r\n \"addressLevel2\": \"CURITIBA\",\r\n \"addressLevel3\": \"SANTA CÂNDIDA\", \r\n \"addressLevel4\": \"RUA IZIDORO WOSCH\",\r\n \"areaCode\": \"82650-500\",\r\n \"externalStructureCode\": \"\",\r\n \"formattedAddress\": \"RUA IZIDORO WOSCH 491 - SANTA CÂNDIDA - CURITIBA - PR - BRAZIL - CEP: 82650-500\",\r\n \"number\": \"491\",\r\n \"people\": {\r\n \"code\": 216,\r\n \"name\": \"ADRIANO TEST\"\r\n },\r\n \"readOnly\": true,\r\n \"regionCode\": 316220,\r\n \"selected\": true,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Delivery\"\r\n }\r\n },\r\n \"deliveryOption\": {\r\n \"code\": 1,\r\n \"description\": \"PAC - PR\",\r\n \"name\": \"PAC - PR\",\r\n \"scheduledDate\": \"2020-12-02T03:00:00Z\",\r\n \"scheduledDeliveryType\": {\r\n \"id\": 0,\r\n \"description\": \"Normal\"\r\n },\r\n \"selected\": true,\r\n \"term\": 8,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Delivery\"\r\n },\r\n \"value\": 10\r\n },\r\n \"partialPromotions\": [\r\n {\r\n \"code\": 577,\r\n \"description\": \"Products: 7,8,9,10\",\r\n \"destination\": {\r\n \"description\": \"Reseller\",\r\n \"id\": 1\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"requirements\":\r\n [\r\n {\r\n \"description\": \"Product 8\",\r\n \"logicOperator\": {\r\n \"description\": \"And\",\r\n \"id\": 1\r\n },\r\n \"missingValue\": 1,\r\n \"productRequired\": {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 9500,\r\n \"productCode\": 8,\r\n \"productDescription\": \"Product 8\",\r\n \"productName\": \"Product 8\",\r\n \"unityPrice\": 95\r\n },\r\n \"valueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n }\r\n },\r\n {\r\n \"description\": \"Product 9\",\r\n \"logicOperator\": {\r\n \"description\": \"And\",\r\n \"id\": 1\r\n },\r\n \"missingValue\": 1,\r\n \"productRequired\": {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 3000,\r\n \"productCode\": 9,\r\n \"productDescription\": \"Product 9\",\r\n \"productName\": \"Product 9\",\r\n \"unityPrice\": 30\r\n },\r\n \"valueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n } \r\n },\r\n {\r\n \"description\": \"Product 10\",\r\n \"missingValue\": 1,\r\n \"productRequired\": {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 6700,\r\n \"pricePerUnitMeasurement\": 33.5,\r\n \"productCode\": 10,\r\n \"productDescription\": \"\",\r\n \"productName\": \"Product 10\",\r\n \"quantityUnitMeasurement\": 2,\r\n \"unitMeasurementType\": {\r\n \"description\": \"Box\",\r\n \"id\": 2\r\n },\r\n \"unityPrice\": 67,\r\n \"valueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n } \r\n }\r\n }\r\n ],\r\n \"suggest\": true,\r\n \"title\": \"Scenario 5\"\r\n }\r\n ],\r\n \"paymentPlansByProduct\": [\r\n {\r\n \"administrateTax\": 2,\r\n \"code\": 19,\r\n \"creditTreatment\": {\r\n \"description\": \"Check credit\",\r\n \"id\": 1\r\n },\r\n \"externalPaymentMethod\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"isBlocked\": false,\r\n \"marketingMessages\": [\r\n {\r\n \"priority\": 0,\r\n \"text\": \"Message when selecting the plan receivement\"\r\n }\r\n ],\r\n \"minimumInstallmentAmount\": 0,\r\n \"name\": \"5x\",\r\n \"paymentInfo\": [\r\n {\r\n \"installments\": [1, 2, 3, 4, 5],\r\n \"installmentsQuantity\": 5\r\n }\r\n ],\r\n \"paymentMode\": {\r\n \"description\": \"Boleto\",\r\n \"id\": 1\r\n },\r\n \"productCode\": 21,\r\n \"showCreditConsumptionData\": {\r\n \"description\": \"Yes\",\r\n \"id\": 1\r\n },\r\n \"type\": {\r\n \"description\": \"Postpaid\",\r\n \"id\": 2\r\n }\r\n } \r\n ],\r\n \"representative\": {\r\n \"representativeCode\": 216\r\n },\r\n \"rewardsToChoosePromotions\": [\r\n {\r\n \"chosenDiscount\": true,\r\n \"chosenProducts\": false,\r\n \"code\": 578,\r\n \"description\": \"Gift Or Discount Promotion Test\",\r\n \"destination\": {\r\n \"description\": \"Reseller\",\r\n \"id\": 1\r\n },\r\n \"discountDescription\": \"2 - Order\",\r\n \"discountNumber\": 2,\r\n \"discountToChoose\": [\r\n {\r\n \"auxiliaryDescription\": \"\",\r\n \"code\": 0,\r\n \"discountTargetType\": {\r\n \"description\": \"Order\",\r\n \"id\": 4\r\n },\r\n \"isMaterialKit\": false,\r\n \"rewardType\": {\r\n \"description\": \"Percentage Discount\",\r\n \"id\": 3\r\n },\r\n \"value\": 10\r\n }\r\n ],\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"giftItemNumber\": 1,\r\n \"giftNumber\": 1,\r\n \"giftValue\": 6,\r\n \"giftValueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n },\r\n \"isCupomPromotion\": false,\r\n \"message\": \"\",\r\n \"orderExhibition\": 2147483647,\r\n \"productsToChoose\": [\r\n {\r\n \"chosenQuantity\": 0,\r\n \"isMaterialKit\": false,\r\n \"isReorderAllowed\": false,\r\n \"productCode\": 6,\r\n \"productDescription\": \"Product 6\",\r\n \"productName\": \"Product 6\",\r\n \"unavailable\": true,\r\n \"value\": 1\r\n },\r\n {\r\n \"chosenQuantity\": 0,\r\n \"isMaterialKit\": false,\r\n \"isReorderAllowed\": false,\r\n \"productCode\": 50,\r\n \"productDescription\": \"Product 50\",\r\n \"productName\": \"Product 50\",\r\n \"unavailable\": true,\r\n \"value\": 1\r\n },\r\n {\r\n \"chosenQuantity\": 0,\r\n \"isMaterialKit\": false,\r\n \"isReorderAllowed\": false,\r\n \"productCode\": 178,\r\n \"productDescription\": \"Product 178\",\r\n \"productName\": \"Product 178\",\r\n \"unavailable\": false,\r\n \"value\": 1\r\n }\r\n ],\r\n \"suggest\": true,\r\n \"title\": \"Gift Or Discount Promotion Test\",\r\n \"unavaiableDiscount\": false\r\n }\r\n ],\r\n \"totals\": {\r\n \"allowsCheckingAccountAdjustment\": true,\r\n \"checkingAccountOriginalValue\": -39.87,\r\n \"checkingAccountTotalValue\": -39.87,\r\n \"checkingAccountValue\": -39.87,\r\n \"collectionFee\": 0,\r\n \"commissionValue\": -61.8,\r\n \"creditCheckingAccountValue\": 39.87,\r\n \"debitCheckingAccountValue\": 0,\r\n \"deliveryTax\": 10,\r\n \"negotiationDiscount\": 0,\r\n \"productsValue\": 206,\r\n \"promotionDiscount\": 0,\r\n \"simulatedNetValue\": 14420,\r\n \"taxesValue\": 0,\r\n \"totalProductValueWithoutDiscount\": 206,\r\n \"totalValue\": 114.33,\r\n \"totalValueWithoutDiscount\": 114.33\r\n },\r\n \"unavailablePromotions\": [\r\n {\r\n \"code\": 575,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false, \r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": false,\r\n \"title\": \"Promo test\"\r\n }\r\n ],\r\n \"validPromotion\": [\r\n {\r\n \"number\": 6,\r\n \"productCode\": 8,\r\n \"productName\": \"Product 8\",\r\n \"promotion\": {\r\n \"code\": 774,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Promocao 2701 Qt 10 Product 14\"\r\n },\r\n \"quantity\": 1\r\n },\r\n {\r\n \"number\": 11,\r\n \"productCode\": 178,\r\n \"productName\": \"Product 8\",\r\n \"promotion\": {\r\n \"code\": 781,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Promocao 2701 Qt 10 Product 14\"\r\n },\r\n \"quantity\": 2\r\n }\r\n ],\r\n \"withdrawalsOptions\": {\r\n \"deliveryOptionCode\": 1\r\n }\r\n }"}],"_postman_id":"0768dea8-eafd-4f39-8cd3-ec0a668f4058"},{"name":"cancel order","id":"74b90210-277f-4911-a3ad-920ee337f4b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{baseUrl}}/api/orders/:id","description":"This call cancels an open or reset order for the release of all your in-stock products. This event type is used for a request that will be abandoned.
\n After canceling an order: to perform a new capture, the application must return to step Define Order Owner or [Initiate Order](#13eea15c-c065-4fb0-a0c0- 19bb9b104b04).
\n","urlObject":{"path":["api","orders",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"ec1be3d9-dd2f-487b-9c4c-4f7d4ba0d122","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"d1182ff6-fe5d-4d78-9fbe-5bce0cbe7b0f","name":"OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id","host":["{{baseUrl}}"],"path":["api","orders",":id"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"74b90210-277f-4911-a3ad-920ee337f4b2"}],"id":"619e69fd-c0a4-4c21-8fd5-f5fd944e5ff9","description":"At any time during the capture, the user can choose to book the order, or cancel it.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1c585247-939b-4c58-bbcd-fda3b13d0099"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c0b8c1db-f784-4149-8b8b-f8cbef1d686f"}}],"_postman_id":"619e69fd-c0a4-4c21-8fd5-f5fd944e5ff9"}],"id":"f08668a8-e1ec-41cb-ad5d-c510d35c88ba","description":"In this step, a series of calls will be made before creating an order. This is necessary to know if there is already an open order for the person in question. If there is no open order, a new order will be created. For this, obtaining some information is necessary.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b9477ee5-7074-4ad2-824b-3d0b190ab870"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"88380cce-cf77-49db-8b1c-6b530b7d7fd6"}}],"_postman_id":"f08668a8-e1ec-41cb-ad5d-c510d35c88ba"},{"name":"Step 4 - Capture Order","item":[{"name":"Get Updated Order Status","item":[{"name":"Consult order status","id":"ed06f338-850e-42e2-be4a-e004d4ca56b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/state","description":"At any time when an order is captured, the application can consult the latest status of the order through this call.
\n","urlObject":{"path":["api","orders",":id","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e62b487f-7394-4670-a35e-33024cc0cd9b","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"e988b1e5-2dbc-4062-9206-b7a23478905d","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/state","host":["{{baseUrl}}"],"path":["api","orders",":id","state"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Tue, 24 Nov 2020 15:38:39 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": 16276089,\r\n \"businessInformation\": {\r\n \"paid\": false,\r\n \"orderingCycle\": 202011,\r\n \"marketingCycle\": 202011,\r\n \"itemsQuantity\": 1,\r\n \"productsQuantity\": 1,\r\n \"pointsQuantity\": 1800,\r\n \"minimumPointsQuantity\": 11100,\r\n \"tableValue\": 18,\r\n \"marketValue\": 18,\r\n \"netValue\": 18,\r\n \"businessModelCode\": 5,\r\n \"businessModelName\": \"Business Model - Final Consumer\",\r\n \"functionCode\": 9,\r\n \"simulatedValue\": 18,\r\n \"simulatedPoints\": 12423,\r\n \"simulatedOrderPoints\": 1800,\r\n \"simulatedValueProfitabilityGifts\": 0,\r\n \"distributionCenterCode\": 1,\r\n \"isWithdrawalCenter\": false,\r\n \"minimumPointsQuantityConsideredOrder\": 1800,\r\n \"minimumOrderType\": {\r\n \"id\": 1,\r\n \"description\": \"Monetary\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": true,\r\n \"flexBalanceAvailable\": 0,\r\n \"flexBalanceAmountConsumed\": 0,\r\n \"flexBalanceUpdatedAvailable\": 0,\r\n \"proposedNetValue\": 0,\r\n \"allowFlexNegotiation\": false\r\n },\r\n \"businessStructure\": {\r\n \"businessStructureCode\": 30\r\n },\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"productCode\": 23, \r\n \"productName\": \"Product 01\",\r\n \"quantity\": 1,\r\n \"unitTableValue\": 18,\r\n \"unitMarketValue\": 18,\r\n \"unitNetValue\": 18,\r\n \"unitPointsQuantity\": 1800,\r\n \"unitKitPointsQuantity\": 0,\r\n \"unitMultilevelPointsQuantity\": 0,\r\n \"associatedItem\": true,\r\n \"associatedItemRequired\": false,\r\n \"associatedItemOrigin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"simulatedValueProfitability\": 18,\r\n \"simulatedValueProfitabilityUnit\": 18,\r\n \"profitabilityValue\": 0,\r\n \"origin\": {\r\n \"id\": 1,\r\n \"description\": \"Sale\" \r\n },\r\n \"isBloquedRemoveItem\": false,\r\n \"isBlockedEditQuantity\": true,\r\n \"confirmAssociatedItemDeletion\": false,\r\n \"associatedItemOriginDetails\": {\r\n \"origin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"promotionCode\": 12351,\r\n \"promotionDescription\": \"Promotion 01\",\r\n \"order\": 12345,\r\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\r\n \"orderCycle\": 202001,\r\n \"programPointsCode\": 2,\r\n \"programPointsDescription\": \"Points Program 01\",\r\n \"notificationCode\": 2,\r\n \"productCode\": 32\r\n },\r\n \"isMaterialKit\": false, \r\n \"productDescription\": \"Product 01\",\r\n \"hasDiscountValue\": false,\r\n \"hasAppliedProfitabilityValueAddItem\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"displayItemWithDiscountPromotion\": false,\r\n \"unitMeasurementType\": {\r\n \"id\": 1,\r\n \"description\": \"un\"\r\n },\r\n \"quantityUnitMeasurement\": 1,\r\n \"pricePerUnitMeasurement\": 18,\r\n \"flexNegotiation\": {\r\n \"minValue\": 17.99,\r\n \"maxValue\": 19.99,\r\n \"initialUnitNetValue\": 18,\r\n \"proposedUnitNetValue\": 0,\r\n \"proposedNetValue\": 0,\r\n \"status\": {\r\n \"id\": 1,\r\n \"description\": \"No negotiated\"\r\n },\r\n \"allowFlexNegotiation\": true\r\n },\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"cutItems\": [\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 17,\r\n \"productName\": \"Product 02\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 2,\r\n \"description\": \"Price not registered\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 02\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n },\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 22,\r\n \"productName\": \"Product 03\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 8,\r\n \"description\": \"Discontinued product\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 03\",\r\n \"isClosedBoxProduct\": false, \r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"externalPreAuthorization\": false,\r\n \"orderBusinessStatus\": {\r\n \"code\": 7,\r\n \"description\": \"Reserved\",\r\n \"dateCreated\": \"2020-11-13T16:24:05.197Z\"\r\n },\r\n \"allRewardsPromotion\": false,\r\n \"paymentPlans\": {\r\n \"administrateTax\": 0,\r\n \"code\": 17,\r\n \"contingentPaymentPlans\": [],\r\n \"creditTreatment\": {\r\n \"description\": \"Ignore credit - does not consume credit\",\r\n \"id\": 3\r\n },\r\n \"externalPaymentMethod\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"isBlocked\": false,\r\n \"marketingMessages\": [],\r\n \"minimumInstallmentAmount\": 0,\r\n \"name\": \"Currency(BRL)\",\r\n \"paymentInfo\": [\r\n {\r\n \"installments\":[1] ,\r\n \"installmentsQuantity\": 1\r\n }\r\n ],\r\n \"paymentMode\": {\r\n \"description\": \"In Kind\",\r\n \"id\": 11\r\n },\r\n \"showCreditConsumptionData\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"type\": {\r\n \"description\": \"Prepaid\",\r\n \"id\": 1\r\n } \r\n },\r\n \"acquiredPromotion\": [\r\n {\r\n \"code\": 568,\r\n \"deliveryDiscountPromotion\": [\r\n {\r\n \"discount\": 10,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Percentage Discount\"\r\n }\r\n }\r\n ],\r\n \"description\": \"Product code 1\",\r\n \"destination\": {\r\n \"id\": 1,\r\n \"description\": \"Reseller\"\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"itemOrderDeliveryDiscountPromotion\": [\r\n { \r\n \"discount\": 10,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Percentage Discount\"\r\n }\r\n }\r\n ],\r\n \"mileagePromotion\": [\r\n {\r\n \"points\": 100,\r\n \"type\": {\r\n \"id\": 5,\r\n \"description\": \"Miles\"\r\n }\r\n }\r\n ],\r\n \"orderExhibition\": 2147483647,\r\n \"rewards\": [\r\n {\r\n \"discount\": 3,\r\n \"isGiftToChoose\": false,\r\n \"isMaterialKit\": true,\r\n \"productCode\": 1,\r\n \"productDescription\": \"Product Kit Home - 1\", \r\n \"productName\": \"Product Kit Home - 1\",\r\n \"quantity\": 3\r\n }\r\n ],\r\n \"type\": {\r\n \"id\": 4,\r\n \"description\": \"Absolute discount\"\r\n },\r\n \"suggest\": true,\r\n \"title\": \"Promo Scenario 01\"\r\n }\r\n ],\r\n \"deliveryAddress\": {\r\n \"addressLevel0\": \"BRAZIL\",\r\n \"addressLevel1\": \"PR\",\r\n \"addressLevel2\": \"CURITIBA\",\r\n \"addressLevel3\": \"SANTA CÂNDIDA\",\r\n \"addressLevel4\": \"RUA IZIDORO WOSCH\",\r\n \"areaCode\": \"82650-500\",\r\n \"externalStructureCode\": \"\",\r\n \"formattedAddress\": \"RUA IZIDORO WOSCH 491 -SANTA CÂNDIDA- CURITIBA -PR- BRAZIL - CEP: 82650-500\",\r\n \"number\": \"491\",\r\n \"people\": {\r\n \"code\": 216,\r\n \"name\": \"ADRIANO TEST\"\r\n },\r\n \"readOnly\": true,\r\n \"regionCode\": 316220,\r\n \"selected\": true,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Delivery\"\r\n }\r\n },\r\n \"deliveryInformation\": {},\r\n \"deliveryOption\": {\r\n \"code\": 1,\r\n \"description\": \"PAC -PR\",\r\n \"name\": \"PAC- PR\",\r\n \"scheduledDate\": \"2020-12-02T03:00:00Z\",\r\n \"scheduledDeliveryType\": {\r\n \"id\": 0, \r\n \"description\": \"Normal\"\r\n },\r\n \"selected\": true,\r\n \"term\": 8,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Delivery\"\r\n },\r\n \"value\": 10\r\n },\r\n \"partialPromotions\": [],\r\n \"paymentPlansByProduct\": [],\r\n \"representative\": {\r\n \"representativeCode\": 216\r\n },\r\n \"rewardsToChoosePromotions\": [],\r\n \"totals\": {\r\n \"allowsCheckingAccountAdjustment\": true,\r\n \"checkingAccountOriginalValue\": -39.87,\r\n \"checkingAccountTotalValue\": -39.87,\r\n \"checkingAccountValue\": -39.87, \r\n \"collectionFee\": 0,\r\n \"commissionValue\": -61.8,\r\n \"creditCheckingAccountValue\": 39.87,\r\n \"debitCheckingAccountValue\": 0,\r\n \"deliveryTax\": 10,\r\n \"negotiationDiscount\": 0,\r\n \"productsValue\": 206,\r\n \"promotionDiscount\": 0,\r\n \"simulatedNetValue\": 14420,\r\n \"taxesValue\": 0,\r\n \"totalProductValueWithoutDiscount\": 206,\r\n \"totalValue\": 114.33,\r\n \"totalValueWithoutDiscount\": 114.33\r\n },\r\n \"unavailablePromotions\": [\r\n {\r\n \"code\": 575,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": false,\r\n \"title\": \"Promo test\"\r\n }\r\n ],\r\n \"validPromotion\": [],\r\n \"withdrawalsOptions\": {\r\n \"deliveryOptionCode\": 1\r\n }\r\n }"},{"id":"64ebaa95-1690-4b70-b893-081e89cf2b91","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/state","host":["{{baseUrl}}"],"path":["api","orders",":id","state"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Tue, 24 Nov 2020 15:38:39 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": \"Order number\",\r\n \"businessInformation\": { // Business Information\r\n \"paid\": \"Indicates if the order has already been paid\",\r\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\r\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\r\n \"itemsQuantity\": \"Quantity of items included in the order\",\r\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\r\n \"pointsQuantity\": \"Amount of points earned on order\",\r\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"tableValue\": \"Product table value\",\r\n \"marketValue\": \"Product value practiced\",\r\n \"netValue\": \"Net product value\",\r\n \"businessModelCode\": \"Business rule code\",\r\n \"businessModelName\": \"Business Rule Name\",\r\n \"functionCode\": \"Person's Function Code\",\r\n \"simulatedValue\": \"Simulated order value\",\r\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\r\n \"simulatedOrderPoints\": \"Simulated order point value\",\r\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\r\n \"distributionCenterCode\": \"Distribution center code\",\r\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\r\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\r\n \"id\": \"Value type code\",\r\n \"description\": \"Description of value type\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\r\n \"flexBalanceAvailable\": \"Available flex budget amount\",\r\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\r\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\r\n \"proposedNetValue\": \"Proposed trading value\",\r\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \r\n },\r\n \"businessStructure\": { // Business Structure\r\n \"businessStructureCode\": \"Business Structure Code\"\r\n },\r\n \"items\": [ // List of items included in the order\r\n {\r\n \"number\": \"Item number\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Quantity of item on order\",\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"unitNetValue\": \"Net unit value\",\r\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\r\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \r\n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\r\n \"associatedItem\": \"Indicates if the product is associated with another\",\r\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\r\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\r\n \"id\": \"Source code of associated item\",\r\n \"description\": \"Description of the associated item's origin\"\r\n },\r\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\r\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\r\n \"profitabilityValue\": \"Profitability Value\",\r\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\r\n \"id\": \"Item source code\",\r\n \"description\": \"Description of the item's origin\"\r\n },\r\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\r\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\r\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\r\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\r\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\r\n \"id\": \"Embedded item source code\",\r\n \"description\": \"Description of the embedded item's origin\"\r\n },\r\n \"promotionCode\": \"Promotion code\",\r\n \"promotionDescription\": \"Description of the promotion\",\r\n \"order\": \"Order\",\r\n \"collectionDate\": \"Date of collection\",\r\n \"orderCycle\": \"Capture cycle\",\r\n \"programPointsCode\": \"Point program code\",\r\n \"programPointsDescription\": \"Description of points program\",\r\n \"notificationCode\": \"Notification code\",\r\n \"productCode\": \"Embedded product code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\r\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Unit of measurement code\",\r\n \"description\": \"Description of the unit of measure\"\r\n },\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"flexNegotiation\": { // Product price negotiation\r\n \"minValue\": \"Minimum value the product must have\",\r\n \"maxValue\": \"Maximum value the product should have\",\r\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\r\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\r\n \"proposedNetValue\": \"Proposed Net Value\" ,\r\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\r\n \"id\": \"Negotiation status code\",\r\n \"description\": \"Description of trading status\"\r\n },\r\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\r\n },\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"cutItems\": [ // Cut Items\r\n {\r\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\r\n \"id\": \"Cut item type code\",\r\n \"description\": \"Description of cropped item type\"\r\n },\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\",\r\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\r\n \"id\": \"Cut ratio code\",\r\n \"description\": \"Description of the reason of cut\"\r\n },\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\r\n \"orderBusinessStatus\": { // Order business status - Possible values in glossary (Order Business Status)\r\n \"code\": \"Order status code\",\r\n \"description\": \"Description of the commercial status of the order\",\r\n \"dateCreated\": \"Order creation date\"\r\n },\r\n \"paymentPlans\": { // Default payment plan chosen for the order\r\n \"administrateTax\": \"Tax administrative\",\r\n \"code\": \"Payment plan code\",\r\n \"contingentPaymentPlans\": [], // contingency payment plans\r\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\r\n \"description\": \"Description of credit treatment\",\r\n \"id\": \"Credit handling code\"\r\n },\r\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\r\n \"description\": \"Description of external payment method\",\r\n \"id\": \"External payment method code\"\r\n },\r\n \"isBlocked\":\"Indicates if the payment plan is unavailable to be used in the current context of the order\",\r\n \"marketingMessages\": [], // List of marketing messages displayed for payment plan\r\n \"minimumInstallmentAmount\": \"Minimum Installment Value\",\r\n \"name\": \"Payment plan name\",\r\n \"paymentInfo\": [ // Payment information\r\n {\r\n \"installments\": [], // Installments\r\n \"installmentsQuantity\": \"Number of installments\"\r\n }\r\n ],\r\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\r\n \"description\": \"Description of payment method\",\r\n \"id\": \"Payment method code\"\r\n },\r\n \"showCreditConsumptionData\": { // Credit Consumption Data Setting - Possible values in glossary (Credit Consumption Data Settings) \r\n \"description\": \"Configuration description\",\r\n \"id\": \"Configuration code\"\r\n },\r\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\r\n \"description\": \"Description of payment plan type\",\r\n \"id\": \"Payment plan type code\"\r\n }\r\n },\r\n \"acquiredPromotion\": [ // List of earned promotions\r\n {\r\n \"code\": \"Code of the earned promotion\",\r\n \"deliveryDiscountPromotion\": [ // List of promotions won by the selected delivery option\r\n {\r\n \"discount\": \"Discount\",\r\n \"type\": { // Type of award\r\n \"id\": \"Award Type Code\",\r\n \"description\": \"Description of award type\"\r\n }\r\n }\r\n ],\r\n \"description\": \"Description of the achieved promotion\",\r\n \"destination\": { // Promotion destination - Possible values in glossary (Promotion destinations)\r\n \"id\": \"Destination code\",\r\n \"description\": \"Destination description\"\r\n },\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Displays the missing items for a promotion to be won\",\r\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\r\n \"itemOrderDeliveryDiscountPromotion\": [ // List of items with discounts earned by the selected delivery option \r\n {\r\n \"discount\": \"Discount\",\r\n \"type\": { // Type of award\r\n \"id\": \"Award Type Code\",\r\n \"description\": \"Description of award type\"\r\n }\r\n }\r\n ],\r\n \"mileagePromotion\": [ // List of conquered promotions that generate points\r\n {\r\n \"points\": \"Amount of points earned\",\r\n \"type\": { // Type of award\r\n \"id\": \"Award Type Code\",\r\n \"description\": \"Description of award type\"\r\n }\r\n }\r\n ],\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"rewards\": [ // List of prizes awarded by the promotion \r\n {\r\n \"discount\": \"Discount granted\",\r\n \"isGiftToChoose\": \"Indicates if the prize is a gift\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productCode\": \"Product code\",\r\n \"productDescription\": \"Product description\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\"\r\n }\r\n ],\r\n \"type\": { // Award type of the won promotion - Possible values in the glossary (Promotion Award Types)\r\n \"id\": \"Type of promotion award\",\r\n \"description\": \"Description of promotion prize type\"\r\n },\r\n \"suggest\": \"Shows suggestions for promotions\",\r\n \"title\": \"Title of promotion\"\r\n }\r\n ],\r\n \"partialPromotions\": [ // List of promotions not yet reached\r\n {\r\n \"code\": \"Promotion code\",\r\n \"description\": \"Description of the promotion\",\r\n \"destination\": { // Destination of the promotion\r\n \"description\": \"Destination description\",\r\n \"id\": \"Destination code\"\r\n },\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"requirements\": // List of conditions for the promotion to be earned\r\n [\r\n {\r\n \"description\": \"Description of the condition of winning the promotion\",\r\n \"logicOperator\": { // Logical operator - Possible values in glossary (Logical Operators)\r\n \"description\": \"Description of the logical operator\",\r\n \"id\": \"Logical operator code\"\r\n },\r\n \"missingValue\": \"Value required for the condition to be satisfied\",\r\n \"productRequired\": { // Product required\r\n \"isKit\": \"Indicates if the product is a Kit\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"points\": \"Amount of points the product is worth\",\r\n \"productCode\": \"Product code required\", \r\n \"productDescription\": \"Description of required product\",\r\n \"productName\": \"Required product name\",\r\n \"unityPrice\": \"Unit price of product required\"\r\n },\r\n \"valueType\": { // Value Type - Possible Glossary Values (Value Types)\r\n \"description\": \"Description of value type\",\r\n \"id\": \"Value type code\"\r\n }\r\n }\r\n ],\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\"\r\n }\r\n ],\r\n \"paymentPlansByProduct\": [ // List of payment plans by product\r\n {\r\n \"administrateTax\": \"Administrative tax\",\r\n \"code\": \"Code of payment plan by product\",\r\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\r\n \"description\": \"Description of credit treatment\",\r\n \"id\": \"Credit handling code\"\r\n },\r\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\r\n \"description\": \"Description of external payment method\",\r\n \"id\": \"External payment method code\"\r\n },\r\n \"isBlocked\": \"Indicates if the payment plan is unavailable to be used in the current context of the order\" ,\r\n \"marketingMessages\": [], // List of marketing messages displayed for the plan payment\r\n \"minimumInstallmentAmount\": \"Minimum Installment Value\",\r\n \"name\": \"Payment plan name\",\r\n \"paymentInfo\": [ // Payment information\r\n {\r\n \"installments\": [], // Installments\r\n \"installmentsQuantity\": \"Number of installments\"\r\n }\r\n ],\r\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\r\n \"description\": \"Description of payment method\",\r\n \"id\": \"Payment method code\"\r\n },\r\n \"productCode\": \"Product code associated with payment plan\",\r\n \"showCreditConsumptionData\": { // Credit Consumption Data Configuration - Possible Glossary Values (Credit Consumption Data Settings)\r\n \"description\": \"Configuration description\",\r\n \"id\": \"Configuration code\"\r\n },\r\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\r\n \"description\": \"Description of payment plan type\",\r\n \"id\": \"Payment plan type code\"\r\n }\r\n }\r\n ],\r\n \"representative\": { // Order owner\r\n \"representativeCode\": \"Order owner code\"\r\n },\r\n \"rewardsToChoosePromotions\": [ // List of available rewards\r\n {\r\n \"chosenDiscount\": \"Indicates that the user has chosen a discount\",\r\n \"chosenProducts\": \"Indicates that the user has chosen products\",\r\n \"code\": \"Promotion code\",\r\n \"description\": \"Description of the promotion\",\r\n \"destination\": { // Destination of the promotion\r\n \"description\": \"Destination description\",\r\n \"id\": \"Destination code\"\r\n },\r\n \"discountDescription\": \"Discount description\",\r\n \"discountNumber\": \"Discount number\",\r\n \"discountToChoose\": [ // List of available discounts\r\n {\r\n \"auxiliaryDescription\": \"Auxiliary Description\",\r\n \"code\": \"Discount code\",\r\n \"discountTargetType\": { // Discount Target Type - Possible Glossary Values (Discount Target Types)\r\n \"description\": \"Description of target type\",\r\n \"id\": \"Target Type Code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"rewardType\": { // Reward Type - Possible Glossary Values (Reward Types)\r\n \"description\": \"Description of the type of award\",\r\n \"id\": \"Award Type Code\"\r\n },\r\n \"value\": \"Discount amount\"\r\n }\r\n ],\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"giftItemNumber\": \"Gift Item Number\",\r\n \"giftNumber\": \"Gift number\",\r\n \"giftValue\": \"Gift Value\",\r\n \"giftValueType\": { // Type value of gift - Possible values in the glossary (Types of value of gifts)\r\n \"description\": \"Description of the type of gift value\",\r\n \"id\": \"Gift Value Type Code\"\r\n },\r\n \"isCupomPromotion\": \"Indicates that the promotion is obtained through a coupon\",\r\n \"message\": \"Message\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"productsToChoose\": [ // List of available products\r\n {\r\n \"chosenQuantity\": \"Chosen Quantity\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"isReorderAllowed\": \"Indicates that the product can be incorporated into a future order if there is currently no stock\",\r\n \"productCode\": \"Product code\",\r\n \"productDescription\": \"Product description\",\r\n \"productName\": \"Product Name\",\r\n \"unavailable\": \"Indicates if the item is available\",\r\n \"value\": \"Product value\"\r\n }\r\n ],\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\",\r\n \"unavaiableDiscount\": \"Indicates if the discount is unavailable\"\r\n }\r\n ],\r\n \"totals\": { // Total order values\r\n \"allowsCheckingAccountAdjustment\": \"Indicates whether it is possible to edit the residual checking account value\",\r\n \"checkingAccountOriginalValue\": \"Original value of residual current account\",\r\n \"checkingAccountTotalValue\": \"Total value of the checking account residual\",\r\n \"checkingAccountValue\": \"Updated residual current account value\",\r\n \"collectionFee\": \"Payment Plan Charge Rate\",\r\n \"commissionValue\": \"Commission Value\",\r\n \"creditCheckingAccountValue\": \"Total amount available on credit account\",\r\n \"debitCheckingAccountValue\": \"Total amount available on debit account\",\r\n \"deliveryTax\": \"Delivery rate\",\r\n \"negotiationDiscount\": \"Negotiated discount\",\r\n \"productsValue\": \"Value of products\",\r\n \"promotionDiscount\": \"Promotion Discount\",\r\n \"simulatedNetValue\": \"Simulated net value\",\r\n \"taxesValue\": \"Value of taxes\",\r\n \"totalProductValueWithoutDiscount\": \"Total value of products without discount\",\r\n \"totalValue\": \"Total Value\",\r\n \"totalValueWithoutDiscount\": \"Total value without discount\"\r\n },\r\n \"unavailablePromotions\": [ // List of unavailable promotions\r\n {\r\n \"code\": \"Promotion code\",\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\"\r\n }\r\n ],\r\n \"validPromotion\": [ // List of valid promotions for the order\r\n { \r\n \"number\": \"Valid promotion number\",\r\n \"productCode\": \"Product code that activates the promotion\",\r\n \"productName\": \"Name of the product that activates the promotion\",\r\n \"promotion\": { // Promotion settings\r\n \"code\": \"Promotion code\",\r\n \"display\": \"Indicates if the application displays the won promotion\",\r\n \"displayMissingItemsToWin\": \"Indicates if the application shows the missing items for a promotion to be won\",\r\n \"orderExhibition\": \"Orders the displayed promotions\",\r\n \"suggest\": \"Indicates whether the application shows the promotion as a suggestion that the person can win in the order\",\r\n \"title\": \"Promotion title\"\r\n },\r\n \"quantity\": \"Amount of product needed to win the promotion\" \r\n }\r\n ],\r\n \"deliveryAddress\": { // Delivery address\r\n \"addressLevel0\": \"Name of the geographic structure referring to level 0 of the address\",\r\n \"addressLevel1\": \"Name of the geographic structure that refers to the first level of the address\",\r\n \"addressLevel2\": \"Name of the geographic structure that refers to the second level of the address\",\r\n \"addressLevel3\": \"Name of the geographic structure that refers to the third level of the address\",\r\n \"addressLevel4\": \"Name of the geographic structure that refers to the fourth level of the address\",\r\n \"areaCode\": \"Area Code\",\r\n \"externalStructureCode\": \"External Structure Code\",\r\n \"formattedAddress\": \"Formatted address\",\r\n \"number\": \"Number\", \r\n \"people\": { // Person associated with address\r\n \"code\": \"Code of the person associated with the address\",\r\n \"name\": \"Name of person associated with address\"\r\n },\r\n \"readOnly\": \"Cannot be edited; only consulted\",\r\n \"regionCode\": \"Region code\",\r\n \"selected\": \"Indicates the shipping address is selected\",\r\n \"type\": { // Address Type - Possible Glossary Values (Address Types) - In this scenario, only residential, business and delivery addresses are accepted. \r\n \"id\": \"Address type code\",\r\n \"description\": \"Description of address type\"\r\n }\r\n },\r\n \"deliveryOption\": { // Delivery mode\r\n \"code\": \"Delivery mode code\",\r\n \"description\": \"Description of delivery mode\",\r\n \"name\": \"Delivery mode name\",\r\n \"scheduledDate\": \"Scheduled delivery date\",\r\n \"scheduledDeliveryType\": { // Scheduled Delivery Type - Possible Glossary Values (Scheduled Delivery Types)\r\n \"id\": \"Scheduled delivery type code\",\r\n \"description\": \"Description of scheduled delivery type\"\r\n },\r\n \"selected\": \"Indicates if the delivery option is selected\",\r\n \"term\": \"Amount of days of delivery time\",\r\n \"type\": { // Delivery Type - Possible Glossary Values (Delivery Types)\r\n \"id\": \"Delivery type code\",\r\n \"description\": \"Description of delivery type\"\r\n },\r\n \"value\": \"Cost of delivery\"\r\n },\r\n \"deliveryInformation\": { // Delivery Information\r\n \"carrierCode\": \"Carrier Code\",\r\n \"carrierName\": \"Carrier Name\",\r\n \"originalScheduledDeliveryDate\": \"2020-12-02T00:00:00Z\",\r\n \"scheduledDeliveryDate\": \"2020-12-02T00:00:00Z\"\r\n },\r\n \"withdrawalsOptions\": { // Withdrawals Options\r\n \"deliveryOptionCode\": \"Delivery Option Code\"\r\n },\r\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\"\r\n }"}],"_postman_id":"ed06f338-850e-42e2-be4a-e004d4ca56b7"}],"id":"04cfca6b-5172-4d4e-995e-d78c7b1eab85","description":"After creating - or returning - an order, the application can request the object of that order in its most up-to-date form.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"156f9619-b275-421e-bd25-f9a90068c9c8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3de7777c-0bd2-416b-9677-324dbeec2cd1"}}],"_postman_id":"04cfca6b-5172-4d4e-995e-d78c7b1eab85"},{"name":"4.1 Get Purchase Suggestion (Model Order)","item":[{"name":"See purchase suggestion","id":"963ee964-3638-4dd8-ae78-9bdffdfaa865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/purchaseSuggestion?showModelsBeginCollection=&showModelsDuringCollection=&showModelsPromotionApplication=&purchaseSuggestionTypes=&sortOptionsPurchaseSuggestionTypes=","description":"There are 3 times in which a purchase suggestion can be obtained:
\n\n- Start of fundraising
\n- During capture
\n- When applying for a promotion
\n
\n For each desired moment, the application must pass the parameter of the respective activated moment and the others deactivated.
\n","urlObject":{"path":["api","orders",":id","purchaseSuggestion"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Get purchase suggestions created and configured for the moment when the order starts to be captured.
\n","type":"text/plain"},"key":"showModelsBeginCollection","value":""},{"description":{"content":"Get purchase suggestions created and configured for the moment of capture.
\n","type":"text/plain"},"key":"showModelsDuringCollection","value":""},{"description":{"content":"Get purchase suggestions created and configured for the promotion application time.
\n","type":"text/plain"},"key":"showModelsPromotionApplication","value":""},{"description":{"content":"Byte array with the desired purchase suggestion types:
\n |||\n |-- -|-- -|\n |1 - Stock Rupture|Products cut into separation due to lack of stock. |\n |2 - Corporate|Records of products suggested by the company.|\n |3 - Abandoned Purchase|Purchase suggestion generated from a purchase canceled by abandonment.|\n |4 - Reserved Order|When saving an order, if the savesReserveOrder attribute (defined in the business rule) is disabled, a purchase suggestion is generated.|\n |5 - Cut Products|When cutting a product purchased during capture, it can be turned into a purchase suggestion.|\n |6 - Customized|Product records generated especially for the owner of the order, according to their purchasing activities.|\n |7 - Quotation Request|When generating a quotation request, a purchase suggestion is generated with its content, after its cancellation.|
\n","type":"text/plain"},"key":"purchaseSuggestionTypes","value":""},{"description":{"content":"Ordering options for purchase suggestions:
\n\n\n\n | \n | \n
\n\n\n\n| 1 - Draft | \nOrders by not expired | \n
\n\n| 2 - Last Update | \nOrder by last modified | \n
\n\n
\n
(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"b9f91c1e-a763-4810-bb89-d8a654e2d4d3","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/purchaseSuggestion?showModelsBeginCollection=&showModelsDuringCollection=&showModelsPromotionApplication=&purchaseSuggestionTypes=&sortOptionsPurchaseSuggestionTypes=","host":["{{baseUrl}}"],"path":["api","orders",":id","purchaseSuggestion"],"query":[{"key":"showModelsBeginCollection","value":"","description":"Get purchase suggestions created and configured for the moment when the order starts to be captured."},{"key":"showModelsDuringCollection","value":"","description":"Get purchase suggestions created and configured for the moment of capture."},{"key":"showModelsPromotionApplication","value":"","description":"Get purchase suggestions created and configured for the promotion application time."},{"key":"purchaseSuggestionTypes","value":"","description":"Byte array with the desired purchase suggestion types:\n\n |||\n |-- -|-- -|\n |1 - Stock Rupture|Products cut into separation due to lack of stock. |\n |2 - Corporate|Records of products suggested by the company.|\n |3 - Abandoned Purchase|Purchase suggestion generated from a purchase canceled by abandonment.|\n |4 - Reserved Order|When saving an order, if the `savesReserveOrder` attribute (defined in the business rule) is disabled, a purchase suggestion is generated.|\n |5 - Cut Products|When cutting a product purchased during capture, it can be turned into a purchase suggestion.|\n |6 - Customized|Product records generated especially for the owner of the order, according to their purchasing activities.|\n |7 - Quotation Request|When generating a quotation request, a purchase suggestion is generated with its content, after its cancellation.|"},{"key":"sortOptionsPurchaseSuggestionTypes","value":"","description":"Ordering options for purchase suggestions:\n\n |||\n |-- |-- |\n |1 - Draft|Orders by not expired.|\n |2 - Last Update|Order by last modified.|"}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"displayOrder\": \"Display order\",\r\n \"name\": \"Buy Suggestion Name\",\r\n \"purchaseSuggestionDetails\": [ // Purchase suggestion details list\r\n {\r\n \"displayOrder\": \"Display order\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // It must be included in multiples of x\"\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"suggestedQuantity\": \"Suggested Quantity\"\r\n }\r\n ],\r\n \"purchaseSuggestionType\": { // Purchase Suggestion Type - Possible values in glossary (Types of Purchasing Suggestions)\r\n \"id\": \"Purchase Suggestion Type Code\",\r\n \"description\": \"Description of purchase suggestion type\"\r\n }\r\n }\r\n ]"},{"id":"0d6c4ff9-9591-4b4d-a265-0ebc5f9b5da4","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/purchaseSuggestion?showModelsBeginCollection=&showModelsDuringCollection=&showModelsPromotionApplication=&purchaseSuggestionTypes=&sortOptionsPurchaseSuggestionTypes=","host":["{{baseUrl}}"],"path":["api","orders",":id","purchaseSuggestion"],"query":[{"key":"showModelsBeginCollection","value":"","description":"Get purchase suggestions created and configured for the moment when the order starts to be captured."},{"key":"showModelsDuringCollection","value":"","description":"Get purchase suggestions created and configured for the moment of capture."},{"key":"showModelsPromotionApplication","value":"","description":"Get purchase suggestions created and configured for the promotion application time."},{"key":"purchaseSuggestionTypes","value":"","description":"Byte array with the desired purchase suggestion types:\n\n |||\n |-- -|-- -|\n |1 - Stock Rupture|Products cut into separation due to lack of stock. |\n |2 - Corporate|Records of products suggested by the company.|\n |3 - Abandoned Purchase|Purchase suggestion generated from a purchase canceled by abandonment.|\n |4 - Reserved Order|When saving an order, if the `savesReserveOrder` attribute (defined in the business rule) is disabled, a purchase suggestion is generated.|\n |5 - Cut Products|When cutting a product purchased during capture, it can be turned into a purchase suggestion.|\n |6 - Customized|Product records generated especially for the owner of the order, according to their purchasing activities.|\n |7 - Quotation Request|When generating a quotation request, a purchase suggestion is generated with its content, after its cancellation.|"},{"key":"sortOptionsPurchaseSuggestionTypes","value":"","description":"Ordering options for purchase suggestions:\n\n |||\n |-- |-- |\n |1 - Draft|Orders by not expired.|\n |2 - Last Update|Order by last modified.|"}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"displayOrder\": 2,\n \"name\": \"Automated Test - Purchase Suggestion 1\",\n \"purchaseSuggestionDetails\": [\n {\n \"displayOrder\": 1,\n \"multipleSaleRestriction\": 1,\n \"pricePerUnitMeasurement\": 25,\n \"productCode\": 1,\n \"productName\": \"Product Kit Home - 1\",\n \"quantityUnitMeasurement\": 1,\n \"suggestedQuantity\": 1\n }\n ],\n \"purchaseSuggestionType\": {\n \"id\": 2,\n \"description\": \"Corporate\"\n }\n },\n {\n \"displayOrder\": 2,\n \"name\": \"Automated Test - Suggestion Purchase 2\",\n \"purchaseSuggestionDetails\": [\n {\n \"displayOrder\": 2,\n \"multipleSaleRestriction\": 1,\n \"pricePerUnitMeasurement\": 26,\n \"productCode\": 1,\n \"productName\": \"Product Kit Home - 2\",\n \"quantityUnitMeasurement\": 1,\n \"suggestedQuantity\": 1\n }\n ],\n \"purchaseSuggestionType\": {\n \"id\": 2,\n \"description\": \"Corporate\"\n }\n }\n ]"}],"_postman_id":"963ee964-3638-4dd8-ae78-9bdffdfaa865"}],"id":"9750ddfc-8c03-462d-84db-32e06997b69d","description":"While taking an order, the application can get purchase suggestions for the user. A purchase suggestion is generated from certain situations (eg when an order is booked, saved as a quote, or even when a product is cut due to lack of stock), creating a list of items that the user can add to the order .
\n Observation
\n There is a deprecated endpoint, to get the wish list. Instead of calling an endpoint to get the wish list, the application generates one when the custom purchase suggestion type is chosen.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dcd0f3c5-3538-4e60-8c5a-f64cd3431135"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"db1b37f8-2a84-4a70-92fd-2f8c6d2136e8"}}],"_postman_id":"9750ddfc-8c03-462d-84db-32e06997b69d"},{"name":"4.2 Get Points Campaign","item":[{"name":"Consult frequent flyer/point program","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"c6b6d8bb-7f2b-40c7-aee0-f4d1cfe0f915"}}],"id":"3969f2fb-17f5-4b7b-ba1e-ac8670730717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/pointsProgram","description":"This call is used to query the frequent flyer/point programs available for the order.
\n When there is no points program available, the system should display the message \"Point program not found for this order.\"
\n In the return object, you get the value of the code attribute, which will be passed in the value of the mileageId parameter in the next call.
\n","urlObject":{"path":["api","orders",":id","pointsProgram"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"e0984106-1a1c-44b5-b647-fd145c29dbec","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 27 Nov 2020 14:41:08 GMT"},{"key":"Content-Length","value":"62"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"Mileage program code\",\n \"name\": \"Name of frequent flyer program\"\n }\n ]"},{"id":"2c691a13-e329-43fd-81b0-7de334b8eef1","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram"],"variable":[{"key":"id","value":"16276137","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 27 Nov 2020 14:41:08 GMT"},{"key":"Content-Length","value":"62"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": 1,\n \"name\": \"Mileage Program 1\"\n },\n {\n \"code\": 2,\n \"name\": \"Mileage Program 2\"\n }\n ]"}],"_postman_id":"3969f2fb-17f5-4b7b-ba1e-ac8670730717"},{"name":"See items available for redemption","id":"512f6bb0-3116-401e-8029-b4758ebb7276","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId/details","description":"This call is used to consult the items available in the frequent flyer/points program.
\n","urlObject":{"path":["api","orders",":id","pointsProgram",":mileageId","details"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"b5d78e91-4bc6-469e-b4d0-b52b98760da5","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"c2128f43-e84c-48f8-9e37-77694eca6210","description":{"content":"(Required) Mileage/points program code.
\n","type":"text/plain"},"type":"any","value":"","key":"mileageId"}]}},"response":[{"id":"847e2484-2967-49aa-86f0-d43a17437304","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId/details","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram",":mileageId","details"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"mileageId","value":"","description":"**(Required)** Mileage/points program code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 27 Nov 2020 14:43:30 GMT"},{"key":"Content-Length","value":"535"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"Mileage program code\",\n \"name\": \"Name of frequent flyer program\",\n \"details\": { // Mileage program details\n \"remainingPoints\": \"Remaining Points\",\n \"orderUsedPoints\": \"Points used in current order\",\n \"otherOrdersUsedPoints\": \"Points used in other orders\",\n \"recoveredProducts\": [ // List of recovered products\n {\n \"code\": \"Redeemed product code\",\n \"name\": \"Name of redeemed product\",\n \"requiredPoints\": \"Required Points\",\n \"requiredPointsUnit\": \"Amount of unit points required\",\n \"associatedItemCode\": \"Associated item code\",\n \"associatedItemQuantity\": \"Associated item quantity\", \n \"associatedItemNotUsed\": \"Indicates if the associated item was not used\"\n }\n ],\n \"availableProducts\": [ // List of available products\n {\n \"code\": \"Available product code\",\n \"name\": \"Available product name\",\n \"requiredPoints\": \"Required Points\",\n \"requiredPointsUnit\": \"Amount of unit points required\",\n \"associatedItemNotUsed\": \"Indicates if the associated item was not used\"\n }\n ]\n }\n }"},{"id":"33de3ee7-5a1d-4da0-92dd-5995e255c2ad","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId/details","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram",":mileageId","details"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"mileageId","value":"","description":"**(Required)** Mileage/points program code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 27 Nov 2020 14:43:30 GMT"},{"key":"Content-Length","value":"535"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 1,\n \"name\": \"Mileage Program 1\",\n \"details\": {\n \"remainingPoints\": 185,\n \"orderUsedPoints\": 10,\n \"otherOrdersUsedPoints\": 5,\n \"recoveredProducts\": [\n {\n \"code\": 14,\n \"name\": \"Product 14\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3651,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 17,\n \"name\": \"Product 17\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3652,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n },\n {\n \"code\": 22,\n \"name\": \"Product 22\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3653,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n },\n {\n \"code\": 23,\n \"name\": \"Product 23\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3654,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": false\n },\n { \n \"code\": 24,\n \"name\": \"Product 24\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3655,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n },\n {\n \"code\": 25,\n \"name\": \"Product 25\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3656,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n },\n {\n \"code\": 27,\n \"name\": \"Product 27\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1, \n \"associatedItemCode\": 3657,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n },\n {\n \"code\": 28,\n \"name\": \"Product 28\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3658,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n },\n {\n \"code\": 29,\n \"name\": \"Product 29\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3659,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true \n },\n {\n \"code\": 32,\n \"name\": \"Product 32\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemCode\": 3660,\n \"associatedItemQuantity\": 1,\n \"associatedItemNotUsed\": true\n }\n ],\n \"availableProducts\": [\n {\n \"code\": 14,\n \"name\": \"Product 14\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 17,\n \"name\": \"Product 17\",\n \"requiredPoints\": 1, \n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 22,\n \"name\": \"Product 22\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 23,\n \"name\": \"Product 23\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 24,\n \"name\": \"Product 24\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 25,\n \"name\": \"Product 25\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 27,\n \"name\": \"Product 27\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 28,\n \"name\": \"Product 28\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n }, \n {\n \"code\": 29,\n \"name\": \"Product 29\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n },\n {\n \"code\": 32,\n \"name\": \"Product 32\",\n \"requiredPoints\": 1,\n \"requiredPointsUnit\": 1,\n \"associatedItemNotUsed\": false\n }\n ]\n }\n }"}],"_postman_id":"512f6bb0-3116-401e-8029-b4758ebb7276"},{"name":"redeem items","id":"c532dfa2-5ee5-4823-941d-fe306bb863d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"code","value":"","description":"Product code.
\n","type":"text"},{"key":"name","value":"","description":"Product's name.
\n","type":"text"},{"key":"requiredPoints","value":"","description":"Points needed.
\n","type":"text"},{"key":"associatedItemCode","value":"","description":"Associated item code.
\n","type":"text"},{"key":"associatedItemQuantity","value":"","description":"Quantity of the associated item.
\n","type":"text"}]},"url":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId/recover","description":"This call is used to redeem items available in a frequent flyer/points program.
\n For each desired item, the respective parameters must be sent in the call body.
\n","urlObject":{"path":["api","orders",":id","pointsProgram",":mileageId","recover"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"580b122f-0aa6-40d7-9b25-11d2993c39a7","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"995024c2-0c54-49be-b7b0-25be6176830e","description":{"content":"(Required) Mileage/points program code.
\n","type":"text/plain"},"type":"any","value":"","key":"mileageId"}]}},"response":[{"id":"e275f532-dee3-4f46-aa7f-784cecf432e8","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"code","value":"","description":"Product code.","type":"text"},{"key":"name","value":"","description":"Product's name.","type":"text"},{"key":"requiredPoints","value":"","description":"Points needed.","type":"text"},{"key":"associatedItemCode","value":"","description":"Associated item code.","type":"text"},{"key":"associatedItemQuantity","value":"","description":"Quantity of the associated item.","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId/recover","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram",":mileageId","recover"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Mandatory)**\n\n Request code."},{"key":"mileageId","value":"","description":"**(Mandatory)**\n\n Mileage/points program code."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"number\": \"Order number\",\n \"businessInformation\": { // Business Information\n \"paid\": \"Indicates if the order has already been paid\",\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\n \"itemsQuantity\": \"Quantity of items included in the order\",\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\n \"pointsQuantity\": \"Amount of points earned on order\",\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\n \"tableValue\": \"Product table value\",\n \"marketValue\": \"Product value practiced\",\n \"netValue\": \"Net product value\",\n \"businessModelCode\": \"Business rule code\",\n \"businessModelName\": \"Business Rule Name\",\n \"functionCode\": \"Person's Function Code\",\n \"simulatedValue\": \"Simulated order value\",\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\n \"simulatedOrderPoints\": \"Simulated order point value\",\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\n \"distributionCenterCode\": \"Distribution center code\",\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\n \"id\": \"Value type code\",\n \"description\": \"Description of value type\"\n },\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\n \"flexBalanceAvailable\": \"Available flex budget amount\",\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\n \"proposedNetValue\": \"Proposed trading value\",\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \n },\n \"businessStructure\": { // Business Structure\n \"businessStructureCode\": \"Business Structure Code\"\n },\n \"items\": [ // List of items included in the order\n {\n \"number\": \"Item number\",\n \"productCode\": \"Product code\",\n \"productName\": \"Product Name\",\n \"quantity\": \"Quantity of item on order\",\n \"unitTableValue\": \"Unit table value\",\n \"unitMarketValue\": \"Unit value practiced\",\n \"unitNetValue\": \"Net unit value\",\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\n \"associatedItem\": \"Indicates if the product is associated with another\",\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\n \"id\": \"Source code of associated item\",\n \"description\": \"Description of the associated item's origin\"\n },\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\n \"profitabilityValue\": \"Profitability Value\",\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\n \"id\": \"Item source code\",\n \"description\": \"Description of the item's origin\"\n },\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\n \"id\": \"Embedded item source code\",\n \"description\": \"Description of the embedded item's origin\"\n },\n \"promotionCode\": \"Promotion code\",\n \"promotionDescription\": \"Description of the promotion\",\n \"order\": \"Order\",\n \"collectionDate\": \"Date of collection\",\n \"orderCycle\": \"Capture cycle\",\n \"programPointsCode\": \"Point program code\",\n \"programPointsDescription\": \"Description of points program\",\n \"notificationCode\": \"Notification code\",\n \"productCode\": \"Embedded product code\"\n },\n \"isMaterialKit\": \"Indicates the material is a kit\",\n \"productDescription\": \"Product description\",\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\n \"id\": \"Unit of measurement code\",\n \"description\": \"Description of the unit of measure\"\n },\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\n \"flexNegotiation\": { // Product price negotiation\n \"minValue\": \"Minimum value the product must have\",\n \"maxValue\": \"Maximum value the product should have\",\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\n \"proposedNetValue\": \"Proposed Net Value\" ,\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\n \"id\": \"Negotiation status code\",\n \"description\": \"Description of trading status\"\n },\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\n },\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\n }\n ],\n \"cutItems\": [ // Cut Items\n {\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\n \"id\": \"Cut item type code\",\n \"description\": \"Description of cropped item type\"\n },\n \"productCode\": \"Product code\",\n \"productName\": \"Product Name\",\n \"quantity\": \"Product quantity\",\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\n \"id\": \"Cut ratio code\",\n \"description\": \"Description of the reason of cut\"\n },\n \"unitTableValue\": \"Unit table value\",\n \"unitMarketValue\": \"Unit value practiced\",\n \"isMaterialKit\": \"Indicates the material is a kit\",\n \"productDescription\": \"Product description\",\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\n }\n ],\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\"\n }"},{"id":"697aa313-5182-4fa3-b0ad-b4d31c7b3f9f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"code","value":"23","description":"Product code.","type":"text"},{"key":"name","value":"","description":"Product's name.","type":"text"},{"key":"requiredPoints","value":"1","description":"Points needed.","type":"text"},{"key":"associatedItemCode","value":"3654","description":"Associated item code.","type":"text"},{"key":"associatedItemQuantity","value":"1","description":"Quantity of the associated item.","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId/recover","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram",":mileageId","recover"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Mandatory)**\n\n Request code."},{"key":"mileageId","value":"1","description":"**(Mandatory)**\n\n Mileage/points program code."}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"number\": 16276137,\n \"businessInformation\": {\n \"paid\": false,\n \"orderingCycle\": 202011,\n \"marketingCycle\": 202011,\n \"itemsQuantity\": 0,\n \"productsQuantity\": 0,\n \"pointsQuantity\": 0,\n \"minimumPointsQuantity\": 11100,\n \"tableValue\": 0,\n \"marketValue\": 0,\n \"netValue\": 0,\n \"businessModelCode\": 5,\n \"businessModelName\": \"Business Model - Final Consumer\",\n \"functionCode\": 9,\n \"simulatedValue\": 0,\n \"simulatedPoints\": 14223,\n \"simulatedOrderPoints\": 0,\n \"simulatedValueProfitabilityGifts\": 0,\n \"distributionCenterCode\": 1,\n \"isWithdrawalCenter\": false,\n \"minimumPointsQuantityConsideredOrder\": 0,\n \"minimumOrderType\": {\n \"id\": 1,\n \"description\": \"Monetary\"\n },\n \"allowChangeIncorporatedItemQuantity\": true,\n \"flexBalanceAvailable\": 0,\n \"flexBalanceAmountConsumed\": 0,\n \"flexBalanceUpdatedAvailable\": 0,\n \"proposedNetValue\": 0,\n \"allowFlexNegotiation\": false\n },\n \"businessStructure\": {\n \"businessStructureCode\": 30\n },\n \"items\": [\n {\n \"number\": 1,\n \"productCode\": 23,\n \"productName\": \"Product 01\",\n \"quantity\": 1,\n \"unitTableValue\": 18,\n \"unitMarketValue\": 18,\n \"unitNetValue\": 18,\n \"unitPointsQuantity\": 1800,\n \"unitKitPointsQuantity\": 0,\n \"unitMultilevelPointsQuantity\": 0,\n \"associatedItem\": true,\n \"associatedItemRequired\": false,\n \"associatedItemOrigin\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"simulatedValueProfitability\": 18,\n \"simulatedValueProfitabilityUnit\": 18,\n \"profitabilityValue\": 0,\n \"origin\": {\n \"id\": 1,\n \"description\": \"Sale\"\n }, \n \"isBloquedRemoveItem\": false,\n \"isBlockedEditQuantity\": true,\n \"confirmAssociatedItemDeletion\": false,\n \"associatedItemOriginDetails\": {\n \"origin\": {\n \"id\": 3,\n \"description\": \"Start Kit\"\n },\n \"promotionCode\": 12351,\n \"promotionDescription\": \"Promotion 01\",\n \"order\": 12345,\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\n \"orderCycle\": 202001,\n \"programPointsCode\": 2,\n \"programPointsDescription\": \"Points Program 01\",\n \"notificationCode\": 2,\n \"productCode\": 32\n },\n \"isMaterialKit\": false,\n \"productDescription\": \"Product 01\",\n \"hasDiscountValue\": false,\n \"hasAppliedProfitabilityValueAddItem\": false,\n \"multipleSaleRestriction\": 1,\n \"displayItemWithDiscountPromotion\": false,\n \"unitMeasurementType\": {\n \"id\": 1,\n \"description\": \"un\"\n },\n \"quantityUnitMeasurement\": 1,\n \"pricePerUnitMeasurement\": 18,\n \"flexNegotiation\": {\n \"minValue\": 17.99,\n \"maxValue\": 19.99,\n \"initialUnitNetValue\": 18,\n \"proposedUnitNetValue\": 0,\n \"proposedNetValue\": 0,\n \"status\": {\n \"id\": 1,\n \"description\": \"Not traded\" \n },\n \"allowFlexNegotiation\": true\n },\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n }\n ],\n \"cutItems\": [\n {\n \"type\": {\n \"id\": 3,\n \"description\": \"Embedded\"\n },\n \"productCode\": 17,\n \"productName\": \"Product 02\",\n \"quantity\": 1,\n \"cutReason\": {\n \"id\": 2,\n \"description\": \"Price not registered\"\n },\n \"unitTableValue\": 0,\n \"unitMarketValue\": 0,\n \"isMaterialKit\": false, \n \"productDescription\": \"Product 02\",\n \"isClosedBoxProduct\": false,\n \"isPromotionRequirementProduct\": false\n },\n {\n \"type\": {\n \"id\": 3,\n \"description\": \"Embedded\"\n },\n \"productCode\": 22,\n \"productName\": \"Product 03\",\n \"quantity\": 1,\n \"cutReason\": {\n \"id\": 8,\n \"description\": \"Discontinued product\"\n },\n \"unitTableValue\": 0,\n \"unitMarketValue\": 0,\n \"isMaterialKit\": false,\n \"productDescription\": \"Product 03\",\n \"isClosedBoxProduct\": false, \n \"isPromotionRequirementProduct\": false\n }\n ],\n \"externalPreAuthorization\": false,\n \"allRewardsPromotion\": false\n }"}],"_postman_id":"c532dfa2-5ee5-4823-941d-fe306bb863d7"},{"name":"Remove frequent flyer/point program","id":"e4e875ae-978f-47c6-bfd9-f8fb25976470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"recovered Items","value":"[{\"code\":\"\",\"associatedItemCode\":\"\"}]","description":"List of redeemed items.
\n -code: Item code;
\n -associatedItemCode: Code of the associated item.
\n","type":"text"}]},"url":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId","description":"This call is used to remove a product list from a frequent flyer/points program from the order.
\n","urlObject":{"path":["api","orders",":id","pointsProgram",":mileageId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"(Mandatory)
\n Request code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"description":{"content":"(Mandatory)
\n Mileage/points program code.
\n","type":"text/plain"},"type":"any","value":"","key":"mileageId"}]}},"response":[{"id":"e6580906-9714-4b32-b8d6-4cd5088f5568","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"recovered Items","value":"[{\"code\":\"\",\"name\":\"\",\"requiredPoints\":\"\",\"associatedItemCode\":\"\",\"associatedItemQuantity\":\"\"}]","description":"List of redeemed items. \n\n -`code`: Item code;\n\n -`name`: Item name;\n\n -`requiredPoints`: Number of points needed to redeem the item;\n\n -`associatedItemCode`: Code of the associated item;\n\n -`associatedItemQuantity`: Quantity of the associated item.","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram",":mileageId"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Mandatory)**\n\n Request code."},{"key":"mileageId","value":"","description":"**(Mandatory)**\n\n Mileage/points program code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": 16276137,\r\n \"businessInformation\": {\r\n \"paid\": false,\r\n \"orderingCycle\": 202011,\r\n \"marketingCycle\": 202011,\r\n \"itemsQuantity\": 0,\r\n \"productsQuantity\": 0,\r\n \"pointsQuantity\": 0,\r\n \"minimumPointsQuantity\": 11100,\r\n \"tableValue\": 0,\r\n \"marketValue\": 0,\r\n \"netValue\": 0,\r\n \"businessModelCode\": 5,\r\n \"businessModelName\": \"Business Model - Final Consumer\",\r\n \"functionCode\": 9,\r\n \"simulatedValue\": 0,\r\n \"simulatedPoints\": 14223,\r\n \"simulatedOrderPoints\": 0,\r\n \"simulatedValueProfitabilityGifts\": 0,\r\n \"distributionCenterCode\": 1,\r\n \"isWithdrawalCenter\": false,\r\n \"minimumPointsQuantityConsideredOrder\": 0,\r\n \"minimumOrderType\": {\r\n \"id\": 1,\r\n \"description\": \"Monetary\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": true,\r\n \"flexBalanceAvailable\": 0,\r\n \"flexBalanceAmountConsumed\": 0,\r\n \"flexBalanceUpdatedAvailable\": 0,\r\n \"proposedNetValue\": 0,\r\n \"allowFlexNegotiation\": false\r\n },\r\n \"businessStructure\": {\r\n \"businessStructureCode\": 30\r\n },\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"productCode\": 23,\r\n \"productName\": \"Product 01\",\r\n \"quantity\": 1,\r\n \"unitTableValue\": 18,\r\n \"unitMarketValue\": 18,\r\n \"unitNetValue\": 18,\r\n \"unitPointsQuantity\": 1800,\r\n \"unitKitPointsQuantity\": 0,\r\n \"unitMultilevelPointsQuantity\": 0,\r\n \"associatedItem\": true,\r\n \"associatedItemRequired\": false,\r\n \"associatedItemOrigin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"simulatedValueProfitability\": 18,\r\n \"simulatedValueProfitabilityUnit\": 18,\r\n \"profitabilityValue\": 0,\r\n \"origin\": {\r\n \"id\": 1,\r\n \"description\": \"Sale\"\r\n }, \r\n \"isBloquedRemoveItem\": false,\r\n \"isBlockedEditQuantity\": true,\r\n \"confirmAssociatedItemDeletion\": false,\r\n \"associatedItemOriginDetails\": {\r\n \"origin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"promotionCode\": 12351,\r\n \"promotionDescription\": \"Promotion 01\",\r\n \"order\": 12345,\r\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\r\n \"orderCycle\": 202001,\r\n \"programPointsCode\": 2,\r\n \"programPointsDescription\": \"Points Program 01\",\r\n \"notificationCode\": 2,\r\n \"productCode\": 32\r\n },\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 01\",\r\n \"hasDiscountValue\": false,\r\n \"hasAppliedProfitabilityValueAddItem\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"displayItemWithDiscountPromotion\": false,\r\n \"unitMeasurementType\": {\r\n \"id\": 1,\r\n \"description\": \"un\"\r\n },\r\n \"quantityUnitMeasurement\": 1,\r\n \"pricePerUnitMeasurement\": 18,\r\n \"flexNegotiation\": {\r\n \"minValue\": 17.99,\r\n \"maxValue\": 19.99,\r\n \"initialUnitNetValue\": 18,\r\n \"proposedUnitNetValue\": 0,\r\n \"proposedNetValue\": 0,\r\n \"status\": {\r\n \"id\": 1,\r\n \"description\": \"Not traded\" \r\n },\r\n \"allowFlexNegotiation\": true\r\n },\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"cutItems\": [\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 17,\r\n \"productName\": \"Product 02\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 2,\r\n \"description\": \"Price not registered\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false, \r\n \"productDescription\": \"Product 02\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n },\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 22,\r\n \"productName\": \"Product 03\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 8,\r\n \"description\": \"Discontinued product\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 03\",\r\n \"isClosedBoxProduct\": false, \r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ]\r\n }"},{"id":"1241d660-5414-4cbf-9b4d-de7b1ea71f5e","name":"Response Parameter Details","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"recovered Items","value":"[{\"code\":\"\",\"name\":\"\",\"requiredPoints\":\"\",\"associatedItemCode\":\"\",\"associatedItemQuantity\":\"\"}]","description":"List of redeemed items. \n\n -`code`: Item code;\n\n -`name`: Item name;\n\n -`requiredPoints`: Number of points needed to redeem the item;\n\n -`associatedItemCode`: Code of the associated item;\n\n -`associatedItemQuantity`: Quantity of the associated item.","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/pointsProgram/:mileageId","host":["{{baseUrl}}"],"path":["api","orders",":id","pointsProgram",":mileageId"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Mandatory)**\n\n Request code."},{"key":"mileageId","value":"","description":"**(Mandatory)**\n\n Mileage/points program code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": \"Order number\",\r\n \"businessInformation\": { // Business Information\r\n \"paid\": \"Indicates if the order has already been paid\",\r\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\r\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\r\n \"itemsQuantity\": \"Quantity of items included in the order\",\r\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\r\n \"pointsQuantity\": \"Amount of points earned on order\",\r\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"tableValue\": \"Product table value\",\r\n \"marketValue\": \"Product value practiced\",\r\n \"netValue\": \"Net product value\",\r\n \"businessModelCode\": \"Business rule code\",\r\n \"businessModelName\": \"Business Rule Name\",\r\n \"functionCode\": \"Person's Function Code\",\r\n \"simulatedValue\": \"Simulated order value\",\r\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\r\n \"simulatedOrderPoints\": \"Simulated order point value\",\r\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\r\n \"distributionCenterCode\": \"Distribution center code\",\r\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\r\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\r\n \"id\": \"Value type code\",\r\n \"description\": \"Description of value type\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\r\n \"flexBalanceAvailable\": \"Available flex budget amount\",\r\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\r\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\r\n \"proposedNetValue\": \"Proposed trading value\",\r\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \r\n },\r\n \"businessStructure\": { // Business Structure\r\n \"businessStructureCode\": \"Business Structure Code\"\r\n },\r\n \"items\": [ // List of items included in the order\r\n {\r\n \"number\": \"Item number\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Quantity of item on order\",\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"unitNetValue\": \"Net unit value\",\r\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\r\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \r\n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\r\n \"associatedItem\": \"Indicates if the product is associated with another\",\r\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\r\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\r\n \"id\": \"Source code of associated item\",\r\n \"description\": \"Description of the associated item's origin\"\r\n },\r\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\r\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\r\n \"profitabilityValue\": \"Profitability Value\",\r\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\r\n \"id\": \"Item source code\",\r\n \"description\": \"Description of the item's origin\"\r\n },\r\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\r\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\r\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\r\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\r\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\r\n \"id\": \"Embedded item source code\",\r\n \"description\": \"Description of the embedded item's origin\"\r\n },\r\n \"promotionCode\": \"Promotion code\",\r\n \"promotionDescription\": \"Description of the promotion\",\r\n \"order\": \"Order\",\r\n \"collectionDate\": \"Date of collection\",\r\n \"orderCycle\": \"Capture cycle\",\r\n \"programPointsCode\": \"Point program code\",\r\n \"programPointsDescription\": \"Description of points program\",\r\n \"notificationCode\": \"Notification code\",\r\n \"productCode\": \"Embedded product code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\r\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Unit of measurement code\",\r\n \"description\": \"Description of the unit of measure\"\r\n },\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"flexNegotiation\": { // Product price negotiation\r\n \"minValue\": \"Minimum value the product must have\",\r\n \"maxValue\": \"Maximum value the product should have\",\r\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\r\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\r\n \"proposedNetValue\": \"Proposed Net Value\" ,\r\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\r\n \"id\": \"Negotiation status code\",\r\n \"description\": \"Description of trading status\"\r\n },\r\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\r\n },\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"cutItems\": [ // Cut Items\r\n {\r\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\r\n \"id\": \"Cut item type code\",\r\n \"description\": \"Description of cropped item type\"\r\n },\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\",\r\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\r\n \"id\": \"Cut ratio code\",\r\n \"description\": \"Description of the reason of cut\"\r\n },\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ]\r\n }"}],"_postman_id":"e4e875ae-978f-47c6-bfd9-f8fb25976470"}],"id":"448ed7cf-5e84-4ea4-8e88-4bc709a2bc7a","description":"What is a Points Campaign?
\n The points campaign is a way for the company to gain customer loyalty by awarding points when purchasing products. These points can later be exchanged for other products.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2e4a2959-822f-403a-aeac-c6a0cd7d64c5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e7c3582e-b0d3-48f8-9063-c609575a390f"}}],"_postman_id":"448ed7cf-5e84-4ea4-8e88-4bc709a2bc7a"},{"name":"4.3 Obtain Conditional Sale","item":[{"name":"See conditional sales conditions","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"444f2293-0ab6-4326-9d96-f63a12ed3b69"}}],"id":"8112fb4e-82a0-4c96-8444-e0c0430a48a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/conditionalSales","description":"This call is used to query the conditional sales terms available for an order.
\n In the return object, we get the value of the conditionalSaleCode property, which will be passed in the value of the idConditionalSale parameter in the next call.
\n","urlObject":{"path":["api","orders",":id","conditionalSales"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"1a98c1c8-e991-4d4d-bb8f-6875796b4cae","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"b9f84b33-62d8-435e-add1-6bbcf2b68347","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/conditionalSales","host":["{{baseUrl}}"],"path":["api","orders",":id","conditionalSales"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"conditionalSaleCode\": 2,\r\n \"conditionalSaleName\": \"Conditional Sale 1\",\r\n \"conditionalSaleType\": {\r\n \"id\": 1,\r\n \"description\": \"Total value of products on order\"\r\n },\r\n \"liberatedCondition\": true,\r\n \"reachedPercentageRelease\": 133.333333333333334,\r\n \"valueMissingRelease\": -50\r\n },\r\n {\r\n \"conditionalSaleCode\": \"3\",\r\n \"conditionalSaleName\": \"Conditional Sale 1\",\r\n \"conditionalSaleType\": {\r\n \"id\": 1,\r\n \"description\": \"Total value of products on order\"\r\n },\r\n \"liberatedCondition\": true,\r\n \"reachedPercentageRelease\": 133.333333333333334,\r\n \"valueMissingRelease\": -50\r\n }\r\n ]"},{"id":"cae2c2d4-37c1-42ee-a979-b7888c6170fb","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/conditionalSales","host":["{{baseUrl}}"],"path":["api","orders",":id","conditionalSales"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Mon, 30 Nov 2020 19:53:52 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"conditionalSaleCode\": \"Conditional sales code\",\r\n \"conditionalSaleName\": \"Conditional Sale Name\",\r\n \"conditionalSaleType\": { // Type of conditional sale - Possible values in the glossary (Types of Conditional Sale)\r\n \"id\": \"Code of conditional sale type\",\r\n \"description\": \"Description of the conditional sale type\"\r\n },\r\n \"liberatedCondition\": \"Indicates whether the conditional sale has been released - all conditions have been met\",\r\n \"reachedPercentageRelease\": \"Percentage reached\",\r\n \"valueMissingRelease\": \"Remaining value to reach the conditional sale\"\r\n }\r\n ]"}],"_postman_id":"8112fb4e-82a0-4c96-8444-e0c0430a48a3"},{"name":"Consult conditional sale items","id":"4352846a-0a46-437a-bd7f-550c001d0695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/conditionalSales/:idConditionalSale/items","description":"This call is used to query items that are part of a conditional sale.
\n","urlObject":{"path":["api","orders",":id","conditionalSales",":idConditionalSale","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"d1c29ba4-8a01-4f1f-8e91-b5957c5483e5","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"5d4c7fb5-b36d-4ece-8e2e-1129d8d1ddfb","description":{"content":"(Required) Conditional sale code.
\n","type":"text/plain"},"type":"any","value":"","key":"idConditionalSale"}]}},"response":[{"id":"81a586dd-3095-4d63-be89-1df84936cbfa","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/conditionalSales/:idConditionalSale/items","host":["{{baseUrl}}"],"path":["api","orders",":id","conditionalSales",":idConditionalSale","items"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"idConditionalSale","value":"","description":"**(Required)** Conditional sale code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"conditionalSaleCode\": \"Conditional sales code\",\r\n \"conditionalSaleItems\": [ // List of items in the conditional sale (these items are available for purchase after the conditional sale is achieved)\r\n {\r\n \"maximumQuantity\": \"Maximum quantity allowed\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // It must be included in multiples of x\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Code of unit of measurement\",\r\n \"description\": \"Description of the unit of measure\"\r\n },\r\n \"unitPoints\": \"Points per product unit\",\r\n \"unitPrice\": \"Unit price of the product\"\r\n }\r\n ],\r\n \"conditionalSaleName\": \"Conditional Sale Name\",\r\n \"liberatedCondition\": \"Indicates whether the conditional sale has been released - all conditions have been met\",\r\n \"reachedPercentageRelease\": \"Percentage reached\",\r\n \"valueMissingRelease\": \"Remaining value to reach the conditional sale\"\r\n }\r\n ]"},{"id":"f4bb9b93-f5a8-4908-aa3c-90bd8b4bfc6d","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/conditionalSales/:idConditionalSale/items","host":["{{baseUrl}}"],"path":["api","orders",":id","conditionalSales",":idConditionalSale","items"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"idConditionalSale","value":"","description":"**(Required)** Conditional sale code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"conditionalSaleCode\": 2,\n \"conditionalSaleItems\": [\n {\n \"maximumQuantity\": 2,\n \"multipleSaleRestriction\": 1,\n \"pricePerUnitMeasurement\": 94,\n \"productCode\": 6,\n \"productName\": \"Product 6\",\n \"quantityUnitMeasurement\": 2,\n \"unitMeasurementType\": {\n \"id\": 4,\n \"description\": \"mg\"\n },\n \"unitPoints\": 18800,\n \"unitPrice\": 188\n }\n ],\n \"conditionalSaleName\": \"Conditional sales test\",\n \"liberatedCondition\": false,\n \"reachedPercentageRelease\": 0,\n \"valueMissingRelease\": 0 \n }"}],"_postman_id":"4352846a-0a46-437a-bd7f-550c001d0695"}],"id":"5e9999d0-b8c7-4d28-8671-670114d847a8","description":"What is Conditional Selling?
\n Conditional Sales is a feature of the Let platform, where the company conditions the sale of one product to another.
\n Example: The application allows the purchase of a shampoo only if the user buys two soaps and a sponge.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"acf16eaf-1007-4941-8228-3a844c12c2fa"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d68b3e0a-cd94-4352-b382-57bc4d60ac44"}}],"_postman_id":"5e9999d0-b8c7-4d28-8671-670114d847a8"},{"name":"4.4 Include Item (*)","item":[{"name":"Browse products","id":"456cdc16-53ba-435f-ae24-d772e9599f90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/products?codeOrName=&includeOptions=priceDetails&includeOptions=isClosedBoxProduct&page=&pageSize=","description":"This call is used to query products to be included in an order.
\n This query is paginated: on callback, data is displayed according to page and number of records per page. These values are determined by the page and pageSize parameters respectively.
\n The data returned is basic; to return more complete data, it is necessary to inform the includeOptions parameter.
\n","urlObject":{"path":["api","orders",":id","products"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Item code or description.
\n","type":"text/plain"},"key":"codeOrName","value":""},{"description":{"content":"Product price details.
\n","type":"text/plain"},"key":"includeOptions","value":"priceDetails"},{"description":{"content":"It says if the product must be purchased in a sealed box.
\n E.g.: If a shampoo comes in closed boxes with 10 units, the user can only buy the product in multiples of 10.
\n","type":"text/plain"},"key":"includeOptions","value":"isClosedBoxProduct"},{"description":{"content":"Page number to be returned
\n Default: 1
\n Observation
\n This query is paginated - it will not return all records registered on the platform. A search must be done in parts, passing the page numbers to obtain all registered records.
\n In the Header of the response of this request, the parameter x-record-count is returned with the total amount of existing records for the informed filters. By dividing this amount by the value informed in the pageSize parameter, we get how many pages and how many times the query must be called to obtain all registered records.
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of records per page
\n Default: 10
\n Observation
\n This query is paginated - it will not return all records registered on the platform. A search must be done in parts, passing the page numbers to obtain all registered records.
\n In the Header of the response of this request, the parameter x-record-count is returned with the total amount of existing records for the informed filters. By dividing this amount by the value informed in the pageSize parameter, we get how many pages and how many times the query must be called to obtain all registered records.
\n","type":"text/plain"},"key":"pageSize","value":""}],"variable":[{"id":"e91d7996-d061-4302-ae04-c3280d43e6e9","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"1c2c4912-3ab3-4b06-a235-19ad809e4239","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/products?codeOrName=&includeOptions=priceDetails&includeOptions=isClosedBoxProduct&page=&pageSize=","host":["{{baseUrl}}"],"path":["api","orders",":id","products"],"query":[{"key":"codeOrName","value":"","description":"Item code or description."},{"key":"includeOptions","value":"priceDetails","description":"Product price details."},{"key":"includeOptions","value":"isClosedBoxProduct","description":"It says if the product must be purchased in a sealed box. \n\n E.g.: If a shampoo comes in closed boxes with 10 units, the user can only buy the product in multiples of 10."},{"key":"page","value":"","description":"Desired page number."},{"key":"pageSize","value":"","description":"Number of items on each page."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-Record-Count","value":"1"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Tue, 01 Dec 2020 16:23:15 GMT"},{"key":"Content-Length","value":"292"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"Product code\",\n \"name\": \"Product name\",\n \"type\": { // Product Relationship Type - Possible Glossary Values (Product Relationship Types)\n \"id\": \"Product relationship type code\",\n \"description\": \"Description of product relationship type\"\n },\n \"unitNetValue\": \"Net unit value\",\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\n \"unitTableValue\": \"Unit table value\",\n \"unitMarketValue\": \"Unit value practiced\", \n \"profitabilityValue\": \"Profitability Value\",\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\n \"id\": \"Unit of measurement code\",\n \"description\": \"Description of the unit of measure\"\n },\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\"\n }\n ]"},{"id":"f5a4c655-f8b6-4d8d-bb0a-fb190042935f","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/products?codeOrName=&includeOptions=priceDetails&includeOptions=isClosedBoxProduct&page=&pageSize=","host":["{{baseUrl}}"],"path":["api","orders",":id","products"],"query":[{"key":"codeOrName","value":"","description":"Item code or description."},{"key":"includeOptions","value":"priceDetails","description":"Product price details."},{"key":"includeOptions","value":"isClosedBoxProduct","description":"It says if the product must be purchased in a sealed box. \n\n E.g.: If a shampoo comes in closed boxes with 10 units, the user can only buy the product in multiples of 10."},{"key":"page","value":"","description":"Desired page number."},{"key":"pageSize","value":"","description":"Number of items on each page."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-Record-Count","value":"1"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Tue, 01 Dec 2020 16:23:15 GMT"},{"key":"Content-Length","value":"292"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": 21,\n \"name\": \"Product 21\",\n \"type\": {\n \"id\": 3,\n \"description\": \"Associated product\"\n },\n \"unitNetValue\": 206,\n \"unitPointsQuantity\": 20600,\n \"simulatedValueProfitabilityUnit\": 206,\n \"hasAppliedProfitabilityValueAddItem\": false,\n \"unitTableValue\": 206,\n \"unitMarketValue\": 206,\n \"profitabilityValue\": 0,\n \"hasDiscountValue\": false,\n \"multipleSaleRestriction\": 1,\n \"unitMeasurementType\": {\n \"id\": 3,\n \"description\": \"g\"\n },\n \"quantityUnitMeasurement\": 1, \n \"pricePerUnitMeasurement\": 206,\n \"isClosedBoxProduct\": false\n }\n ]"}],"_postman_id":"456cdc16-53ba-435f-ae24-d772e9599f90"},{"name":"Add/Change/Remove Item","id":"f1787076-4d95-4b1a-b303-5d3a99139d8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"productCode","value":"","description":"Product code.
\n","type":"text"},{"key":"productModelCode","value":"","description":"Model product code.
\n","type":"text"},{"key":"quantity","value":"","description":"Quantity of the product.
\n If the intention is to remove the item in question, this parameter must have the value \"0\". If the value \"0\" is passed without the item in question being present in the request, the endpoint will return an error.
\n","type":"text"},{"key":"sellerCode","value":"","description":"Code of the employee who helped the owner of the order.
\n","type":"text"},{"key":"origin","value":"","description":"Product origin:
\n\n\n\n | \n | \n
\n\n\n\n| 1 | \nSale | \n
\n\n| 2 | \nDonation | \n
\n\n
\n
Order item number.
\n","type":"text"},{"key":"confirmedAssociatedItemDeletion","value":"","description":"This parameter indicates whether the item in question should be deleted from the current order only or forever. If the value true is passed, the item leaves the list of embedded items and no longer appears in future orders from the user who owns the order. If the value false is passed, the item is excluded only from the current order, being incorporated in future orders of the user that owns the order.
\n","type":"text"},{"key":"paymentPlanCode","value":"","description":"Payment plan code.
\n","type":"text"},{"key":"removeItem","value":"","description":"Indicates whether the application should remove the item from the order.
\n Heads up
\n This parameter should only be sent together with the quantity parameter, when its value is 0
\n","type":"text"}]},"url":"{{baseUrl}}/api/orders/:id/items?eventChangeQuantity=changeDefault&eventChangeQuantity=replaceQuantity&eventChangeQuantity=sumQuantity","description":"If an error occurs when adding/modifying/removing an item, the entire order object must be retrieved to identify which items were successfully added, changed or removed. For this, the application must call the endpoint to get order status. This API always returns the entire object of the request being captured; therefore, after order completion/cancellation, this object will no longer exist.
\n The API only considers the value of the eventChangeQuantity parameter when it is used to change the quantity of an item.
\n Heads up
\n The parameters documented in the call body make up just one object. The API, however, is configured to receive a list of objects. Therefore, the content of the call body must be sent in a JSON file.
\n","urlObject":{"path":["api","orders",":id","items"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Default
\n Heads up
\n If the business rule works with barcodes (usesBarcode = true), the application always adds the amount. If it doesn't use barcode (usesBarcode= false), the setting is defined by the capture medium.
\n","type":"text/plain"},"key":"eventChangeQuantity","value":"changeDefault"},{"description":{"content":"Replaces the current quantity of the product with the value being passed in the call.
\n","type":"text/plain"},"key":"eventChangeQuantity","value":"replaceQuantity"},{"description":{"content":"Sums the current quantity of the product with the one being passed in the call.
\n","type":"text/plain"},"key":"eventChangeQuantity","value":"sumQuantity"}],"variable":[{"description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"3ce783f3-2060-4edf-b8fc-3c511e3ab256","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"productCode","value":"","description":"Product code.","type":"text"},{"key":"productModelCode","value":"","description":"Model product code.","type":"text"},{"key":"quantity","value":"","description":"Quantity of the product. \n\n If the intention is to remove the item in question, this parameter must have the value \"0\". If the value \"0\" is passed without the item in question being present in the request, the endpoint will return an error.","type":"text"},{"key":"sellerCode","value":"","description":"Code of the employee who helped the owner of the order.","type":"text"},{"key":"origin","value":"","description":"Product origin:\n\n |||\n |-- |-- |\n |1|Sale|\n |2|Donation|","type":"text"},{"key":"number","value":"","description":"Order item number.","type":"text"},{"key":"confirmedAssociatedItemDeletion","value":"","description":"In case of a removal, this parameter indicates whether the item in question should be deleted only from the current order or forever. If the value `true` is passed, the item leaves the list of embedded items and no longer appears in future orders from the user who owns the order. If the value `false` is passed, the item is excluded only from the current order, being incorporated in future orders of the user that owns the order. \n\n **Heads up**\n\n For this to work, such functionality needs to be enabled in the business rule.","type":"text"},{"key":"cutProductCode","value":"","description":"In case of a removal, product code cut off.","type":"text"},{"key":"cutProductQuantity","value":"","description":"In case of a removal, quantity of cut product.","type":"text"},{"key":"paymentPlanCode","value":"","description":"Payment plan code.","type":"text"},{"key":"removeItem","value":"","description":"Indicates whether the application should remove the item from the order. \n\n **Heads up**\n\n This parameter should only be sent together with the `quantity` parameter, when its value is `0`","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/items?eventChangeQuantity=changeDefault&eventChangeQuantity=replaceQuantity&eventChangeQuantity=sumQuantity","host":["{{baseUrl}}"],"path":["api","orders",":id","items"],"query":[{"key":"eventChangeQuantity","value":"changeDefault","description":"Default value. \n\n **Heads up**\n\n If the [business rule](#72ac4a5f-660d-4c6d-bc01-ff3f60ea45f7) works with barcodes (`usesBarcode` = `true`), the application always adds the amount. If it doesn't use barcode (`usesBarcode`= `false`), the setting is defined by the capture medium."},{"key":"eventChangeQuantity","value":"replaceQuantity","description":"Replaces the current quantity of the product with the value being passed in the call."},{"key":"eventChangeQuantity","value":"sumQuantity","description":"Sums the current quantity of the product with the one being passed in the call."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 27 Nov 2020 15:30:50 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": \"Order number\",\r\n \"businessInformation\": { // Business Information\r\n \"paid\": \"Indicates if the order has already been paid\",\r\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\r\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\r\n \"itemsQuantity\": \"Quantity of items included in the order\",\r\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\r\n \"pointsQuantity\": \"Amount of points earned on order\",\r\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"tableValue\": \"Product table value\",\r\n \"marketValue\": \"Product value practiced\",\r\n \"netValue\": \"Net product value\",\r\n \"businessModelCode\": \"Business rule code\",\r\n \"businessModelName\": \"Business Rule Name\",\r\n \"functionCode\": \"Person's Function Code\",\r\n \"simulatedValue\": \"Simulated order value\",\r\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\r\n \"simulatedOrderPoints\": \"Simulated order point value\",\r\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\r\n \"distributionCenterCode\": \"Distribution center code\",\r\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\r\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\r\n \"id\": \"Value type code\",\r\n \"description\": \"Description of value type\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\r\n \"flexBalanceAvailable\": \"Available flex budget amount\",\r\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\r\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\r\n \"proposedNetValue\": \"Proposed trading value\",\r\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \r\n },\r\n \"businessStructure\": { // Business Structure\r\n \"businessStructureCode\": \"Business Structure Code\"\r\n },\r\n \"items\": [ // List of items included in the order\r\n {\r\n \"number\": \"Item number\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Quantity of item on order\",\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"unitNetValue\": \"Net unit value\",\r\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\r\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \r\n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\r\n \"associatedItem\": \"Indicates if the product is associated with another\",\r\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\r\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\r\n \"id\": \"Source code of associated item\",\r\n \"description\": \"Description of the associated item's origin\"\r\n },\r\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\r\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\r\n \"profitabilityValue\": \"Profitability Value\",\r\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\r\n \"id\": \"Item source code\",\r\n \"description\": \"Description of the item's origin\"\r\n },\r\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\r\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\r\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\r\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\r\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\r\n \"id\": \"Embedded item source code\",\r\n \"description\": \"Description of the embedded item's origin\"\r\n },\r\n \"promotionCode\": \"Promotion code\",\r\n \"promotionDescription\": \"Description of the promotion\",\r\n \"order\": \"Order\",\r\n \"collectionDate\": \"Date of collection\",\r\n \"orderCycle\": \"Capture cycle\",\r\n \"programPointsCode\": \"Point program code\",\r\n \"programPointsDescription\": \"Description of points program\",\r\n \"notificationCode\": \"Notification code\",\r\n \"productCode\": \"Embedded product code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\r\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Unit of measurement code\",\r\n \"description\": \"Description of the unit of measure\"\r\n },\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"flexNegotiation\": { // Product price negotiation\r\n \"minValue\": \"Minimum value the product must have\",\r\n \"maxValue\": \"Maximum value the product should have\",\r\n \"initialUnitNetValue\": \"Initial net unit value of the product\",\r\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\r\n \"proposedNetValue\": \"Proposed Net Value\" ,\r\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\r\n \"id\": \"Negotiation status code\",\r\n \"description\": \"Description of trading status\"\r\n },\r\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\r\n },\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"cutItems\": [ // Cut Items\r\n {\r\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\r\n \"id\": \"Cut item type code\",\r\n \"description\": \"Description of cropped item type\"\r\n },\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\",\r\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\r\n \"id\": \"Cut ratio code\",\r\n \"description\": \"Description of the reason of cut\"\r\n },\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\r\n \"orderBusinessStatus\": { // Order business status - Possible values in glossary (Order Business Status)\r\n \"code\": \"Order status code\",\r\n \"description\": \"Description of the commercial status of the order\",\r\n \"dateCreated\": \"Order creation date\"\r\n },\r\n \"paymentPlans\": { // Default payment plan chosen for the order\r\n \"administrateTax\": \"Tax administrative\",\r\n \"code\": \"Payment plan code\",\r\n \"contingentPaymentPlans\": [], // contingency payment plans\r\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\r\n \"description\": \"Description of credit treatment\",\r\n \"id\": \"Credit handling code\"\r\n },\r\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\r\n \"description\": \"Description of external payment method\",\r\n \"id\": \"External payment method code\"\r\n },\r\n \"isBlocked\":\"Indicates if the payment plan is unavailable to be used in the current context of the order\",\r\n \"marketingMessages\": [], // List of marketing messages displayed for payment plan\r\n \"minimumInstallmentAmount\": \"Minimum Installment Value\",\r\n \"name\": \"Payment plan name\",\r\n \"paymentInfo\": [ // Payment information\r\n {\r\n \"installments\": [], // Installments\r\n \"installmentsQuantity\": \"Number of installments\"\r\n }\r\n ],\r\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\r\n \"description\": \"Description of payment method\",\r\n \"id\": \"Payment method code\"\r\n },\r\n \"showCreditConsumptionData\": { // Credit Consumption Data Setting - Possible values in glossary (Credit Consumption Data Settings) \r\n \"description\": \"Configuration description\",\r\n \"id\": \"Configuration code\"\r\n },\r\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\r\n \"description\": \"Description of payment plan type\",\r\n \"id\": \"Payment plan type code\"\r\n }\r\n },\r\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\"\r\n }"},{"id":"70f94e2c-0868-461a-9a99-d0550796a1a6","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"productCode","value":"","description":"Product code.","type":"text"},{"key":"productModelCode","value":"","description":"Model product code.","type":"text"},{"key":"quantity","value":"","description":"Quantity of the product. \n\n If the intention is to remove the item in question, this parameter must have the value \"0\". If the value \"0\" is passed without the item in question being present in the request, the endpoint will return an error.","type":"text"},{"key":"sellerCode","value":"","description":"Code of the employee who helped the owner of the order.","type":"text"},{"key":"origin","value":"","description":"Product origin:\n\n |||\n |-- |-- |\n |1|Sale|\n |2|Donation|","type":"text"},{"key":"number","value":"","description":"Order item number.","type":"text"},{"key":"confirmedAssociatedItemDeletion","value":"","description":"In case of a removal, this parameter indicates whether the item in question should be deleted only from the current order or forever. If the value `true` is passed, the item leaves the list of embedded items and no longer appears in future orders from the user who owns the order. If the value `false` is passed, the item is excluded only from the current order, being incorporated in future orders of the user that owns the order. \n\n **Heads up**\n\n For this to work, such functionality needs to be enabled in the business rule.","type":"text"},{"key":"cutProductCode","value":"","type":"text"},{"key":"cutProductQuantity","value":"","type":"text"},{"key":"paymentPlanCode","value":"","description":"Payment plan code.","type":"text"},{"key":"removeItem","value":"","description":"Indicates whether the application should remove the item from the order. \n\n **Heads up**\n\n This parameter should only be sent together with the `quantity` parameter, when its value is `0`","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/items?eventChangeQuantity=replaceQuantity","host":["{{baseUrl}}"],"path":["api","orders",":id","items"],"query":[{"key":"eventChangeQuantity","value":"changeDefault","description":"Default value. \n\n **Heads up**\n\n If the [business rule](#72ac4a5f-660d-4c6d-bc01-ff3f60ea45f7) works with barcodes (`usesBarcode` = `true`), the application always adds the amount. If it doesn't use barcode (`usesBarcode`= `false`), the setting is defined by the capture medium.","disabled":true},{"key":"eventChangeQuantity","value":"replaceQuantity","description":"Replaces the current quantity of the product with the value being passed in the call."},{"key":"eventChangeQuantity","value":"sumQuantity","description":"Sums the current quantity of the product with the one being passed in the call.","disabled":true}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"exhale","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Gives you","value":"Fri, 27 Nov 2020 15:30:50 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": 16276089,\r\n \"businessInformation\": {\r\n \"paid\": false,\r\n \"orderingCycle\": 202011,\r\n \"marketingCycle\": 202011,\r\n \"itemsQuantity\": 1,\r\n \"productsQuantity\": 1,\r\n \"pointsQuantity\": 1800,\r\n \"minimumPointsQuantity\": 11100,\r\n \"tableValue\": 18,\r\n \"marketValue\": 18,\r\n \"netValue\": 18,\r\n \"businessModelCode\": 5,\r\n \"businessModelName\": \"Business Model - Final Consumer\",\r\n \"functionCode\": 9,\r\n \"simulatedValue\": 18,\r\n \"simulatedPoints\": 12423,\r\n \"simulatedOrderPoints\": 1800,\r\n \"simulatedValueProfitabilityGifts\": 0,\r\n \"distributionCenterCode\": 1,\r\n \"isWithdrawalCenter\": false,\r\n \"minimumPointsQuantityConsideredOrder\": 1800,\r\n \"minimumOrderType\": {\r\n \"id\": 1,\r\n \"description\": \"Monetary\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": true,\r\n \"flexBalanceAvailable\": 0,\r\n \"flexBalanceAmountConsumed\": 0,\r\n \"flexBalanceUpdatedAvailable\": 0,\r\n \"proposedNetValue\": 0,\r\n \"allowFlexNegotiation\": false\r\n },\r\n \"businessStructure\": {\r\n \"businessStructureCode\": 30\r\n },\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"productCode\": 23, \r\n \"productName\": \"Product 23\",\r\n \"quantity\": 1,\r\n \"unitTableValue\": 18,\r\n \"unitMarketValue\": 18,\r\n \"unitNetValue\": 18,\r\n \"unitPointsQuantity\": 1800,\r\n \"unitKitPointsQuantity\": 0,\r\n \"unitMultilevelPointsQuantity\": 0,\r\n \"associatedItem\": true,\r\n \"associatedItemRequired\": false,\r\n \"associatedItemOrigin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"simulatedValueProfitability\": 18,\r\n \"simulatedValueProfitabilityUnit\": 18,\r\n \"profitabilityValue\": 0,\r\n \"origin\": {\r\n \"id\": 1,\r\n \"description\": \"Sale\" \r\n },\r\n \"isBloquedRemoveItem\": false,\r\n \"isBlockedEditQuantity\": true,\r\n \"confirmAssociatedItemDeletion\": false,\r\n \"associatedItemOriginDetails\": {\r\n \"origin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"promotionCode\": 12351,\r\n \"promotionDescription\": \"Promotion 01\",\r\n \"order\": 12345,\r\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\r\n \"orderCycle\": 202001,\r\n \"programPointsCode\": 2,\r\n \"programPointsDescription\": \"Points Program 01\",\r\n \"notificationCode\": 2,\r\n \"productCode\": 32\r\n },\r\n \"isMaterialKit\": false, \r\n \"productDescription\": \"Product 23\",\r\n \"hasDiscountValue\": false,\r\n \"hasAppliedProfitabilityValueAddItem\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"displayItemWithDiscountPromotion\": false,\r\n \"unitMeasurementType\": {\r\n \"id\": 1,\r\n \"description\": \"un\"\r\n },\r\n \"quantityUnitMeasurement\": 1,\r\n \"pricePerUnitMeasurement\": 18,\r\n \"flexNegotiation\": {\r\n \"minValue\": 17.99,\r\n \"maxValue\": 19.99,\r\n \"initialUnitNetValue\": 18,\r\n \"proposedUnitNetValue\": 0,\r\n \"proposedNetValue\": 0,\r\n \"status\": {\r\n \"id\": 1,\r\n \"description\": \"No negotiated\"\r\n },\r\n \"allowFlexNegotiation\": true\r\n },\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"cutItems\": [\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 17,\r\n \"productName\": \"Product 17\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 2,\r\n \"description\": \"Price not registered\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 17\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n },\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 22,\r\n \"productName\": \"Product 22\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 8,\r\n \"description\": \"Discontinued product\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 22\",\r\n \"isClosedBoxProduct\": false, \r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"externalPreAuthorization\": false,\r\n \"orderBusinessStatus\": {\r\n \"code\": 7,\r\n \"description\": \"Reserved\",\r\n \"dateCreated\": \"2020-11-13T16:24:05.197Z\"\r\n },\r\n \"allRewardsPromotion\": false,\r\n \"paymentPlans\": {\r\n \"administrateTax\": 0,\r\n \"code\": 17,\r\n \"contingentPaymentPlans\": [],\r\n \"creditTreatment\": {\r\n \"description\": \"Ignore credit - does not consume credit\",\r\n \"id\": 3\r\n },\r\n \"externalPaymentMethod\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"isBlocked\": false,\r\n \"marketingMessages\": [],\r\n \"minimumInstallmentAmount\": 0,\r\n \"name\": \"Currency(BRL)\",\r\n \"paymentInfo\": [\r\n {\r\n \"installments\":[1] ,\r\n \"installmentsQuantity\": 1\r\n }\r\n ],\r\n \"paymentMode\": {\r\n \"description\": \"In Kind\",\r\n \"id\": 11\r\n },\r\n \"showCreditConsumptionData\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"type\": {\r\n \"description\": \"Prepaid\",\r\n \"id\": 1\r\n } \r\n }\r\n }"}],"_postman_id":"f1787076-4d95-4b1a-b303-5d3a99139d8c"},{"name":"Get model product","id":"a4475513-de78-4529-98d3-e004c32fb040","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/products/:productModelId/models","urlObject":{"path":["api","orders",":id","products",":productModelId","models"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"322f6ac9-aa24-4b6f-868d-575506878b40","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"b63e1e44-2274-48dd-995b-0aac0c4af784","description":{"content":"(Required) Model product code.
\n","type":"text/plain"},"type":"any","value":"","key":"productModelId"}]}},"response":[{"id":"cd21fd54-442d-4155-9f5b-fb0a07b2b4c3","name":"Response Product Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/products/:productModelId/models","host":["{{baseUrl}}"],"path":["api","orders",":id","products",":productModelId","models"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"productModelId","value":"","description":"**(Required)** Model product code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"41ccaac7-58a6-46c3-909e-df3a30d29de1","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/products/:productModelId/models","host":["{{baseUrl}}"],"path":["api","orders",":id","products",":productModelId","models"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"productModelId","value":"","description":"**(Required)** Model product code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a4475513-de78-4529-98d3-e004c32fb040"},{"name":"Obtain replacement product","id":"a2391204-eb47-4e67-bbff-262a537e26cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/replacementProducts/:productId","description":"This call is used to query the substitute products related to an item when the item is cut due to lack of stock.
\n","urlObject":{"path":["api","orders",":id","replacementProducts",":productId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"bf70bd10-2c3e-41c0-862d-d60e5bde56d6","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"3faefd83-ec37-44a8-a9ff-16424f1a1567","description":{"content":"(Required) Product code.
\n","type":"text/plain"},"type":"any","value":"","key":"productId"}]}},"response":[{"id":"b4d4fd9a-07c5-4a15-8dbe-a484f3a3d5f8","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/replacementProducts/:productId","host":["{{baseUrl}}"],"path":["api","orders",":id","replacementProducts",":productId"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"productId","value":"","description":"**(Required)** Product code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"isKit\": \"Indicates if the product is a Kit\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"points\": \"Amount of points the product is worth\",\r\n \"productCode\": \"Product code\",\r\n \"productDescription\": \"Product description\",\r\n \"productName\": \"Product Name\",\r\n \"unityPrice\": \"Unit Price\"\r\n }\r\n ]"},{"id":"f4a21b1d-8502-4ac7-a671-31dac7f0e865","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/replacementProducts/:productId","host":["{{baseUrl}}"],"path":["api","orders",":id","replacementProducts",":productId"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"productId","value":"","description":"**(Required)** Product code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 10300,\r\n \"productCode\": 2,\r\n \"productDescription\": \"Product Kit Home - 2\",\r\n \"productName\": \"Product Kit Home - 2\",\r\n \"unityPrice\": 103\r\n },\r\n {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 20002,\r\n \"productCode\": 3,\r\n \"productDescription\": \"Product Kit Home - 3\",\r\n \"productName\": \"Product Kit Home - 3\",\r\n \"unityPrice\": 200.02\r\n }\r\n ]"}],"_postman_id":"a2391204-eb47-4e67-bbff-262a537e26cb"},{"name":"Export order item template","id":"fba0d1cf-17f7-4962-8008-f4cba68fbf2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/exportTemplate","urlObject":{"path":["api","orders",":id","exportTemplate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"8a6627b3-1b3e-4ca2-be6f-0213096fa473","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"f5779447-0cfd-4ada-97e0-fb215d98c129","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/exportTemplate","host":["{{baseUrl}}"],"path":["api","orders",":id","exportTemplate"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"url\":\"Template download URL\"\r\n }"},{"id":"aa27251d-ba7a-4162-b13e-87b3faf23c94","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/exportTemplate","host":["{{baseUrl}}"],"path":["api","orders",":id","exportTemplate"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"url\": \"https://inovadevsgi.geravd.com.br/Temp/ItensPedido_974d4ed58-aa30-43b8-adc6-8265a77c71e11.xls\"\r\n }"}],"_postman_id":"fba0d1cf-17f7-4962-8008-f4cba68fbf2e"},{"name":"Import order item template","id":"d97fc85f-bf11-4d46-a247-208cb7ee767f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"filet","value":"","description":"File with list of items.
\n","type":"text"}]},"url":"{{baseUrl}}/api/orders/:id/items/import","urlObject":{"path":["api","orders",":id","items","import"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"699adaae-632b-4034-a12d-8227e66cf713","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"}]}},"response":[{"id":"a64d3087-9c6a-40a6-b7bd-a58f32781afd","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"filet","value":"","description":"File with list of items.","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/items/import","host":["{{baseUrl}}"],"path":["api","orders",":id","items","import"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"importRows\": [\r\n {\r\n \"containsError\": true,\r\n \"error\": {\r\n \"code\": \"\",\r\n \"description\": \"Product code 1 (Home Kit Product - 1) cut into 1 unit(s) (Insufficient stock).\"\r\n },\r\n \"importRow\": {\r\n \"code\": \"1\",\r\n \"quantity\": \"1\"\r\n },\r\n \"rowDescription\": \"1|1\",\r\n \"rowNumber\": 2\r\n },\r\n {\r\n \"containsError\": false,\r\n \"importRow\": {\r\n \"code\": \"2\",\r\n \"quantity\": \"1\"\r\n },\r\n \"rowDescription\": \"2|1\",\r\n \"rowNumber\": 3\r\n },\r\n {\r\n \"containsError\": false,\r\n \"importRow\": {\r\n \"code\": \"3\",\r\n \"quantity\": \"1\"\r\n },\r\n \"rowDescription\": \"3|1\",\r\n \"rowNumber\": 4\r\n }\r\n ],\r\n \"quantityImportRowsError\": 1,\r\n \"quantityImportRowsSuccess\": 2,\r\n \"returnObject\": {\r\n \"number\": 16276089,\r\n \"businessInformation\": {\r\n \"paid\": false,\r\n \"orderingCycle\": 202011,\r\n \"marketingCycle\": 202011,\r\n \"itemsQuantity\": 1,\r\n \"productsQuantity\": 1,\r\n \"pointsQuantity\": 1800,\r\n \"minimumPointsQuantity\": 11100,\r\n \"tableValue\": 18, \r\n \"marketValue\": 18,\r\n \"netValue\": 18,\r\n \"businessModelCode\": 5,\r\n \"businessModelName\": \"Business Model - Final Consumer\",\r\n \"functionCode\": 9,\r\n \"simulatedValue\": 18,\r\n \"simulatedPoints\": 12423,\r\n \"simulatedOrderPoints\": 1800,\r\n \"simulatedValueProfitabilityGifts\": 0,\r\n \"distributionCenterCode\": 1,\r\n \"isWithdrawalCenter\": false,\r\n \"minimumPointsQuantityConsideredOrder\": 1800,\r\n \"minimumOrderType\": {\r\n \"id\": 1,\r\n \"description\": \"Monetary\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": true,\r\n \"flexBalanceAvailable\": 0,\r\n \"flexBalanceAmountConsumed\": 0,\r\n \"flexBalanceUpdatedAvailable\": 0,\r\n \"proposedNetValue\": 0,\r\n \"allowFlexNegotiation\": false\r\n },\r\n \"businessStructure\": {\r\n \"businessStructureCode\": 30\r\n },\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"productCode\": 23,\r\n \"productName\": \"Product 23\",\r\n \"quantity\": 1,\r\n \"unitTableValue\": 18,\r\n \"unitMarketValue\": 18,\r\n \"unitNetValue\": 18,\r\n \"unitPointsQuantity\": 1800,\r\n \"unitKitPointsQuantity\": 0,\r\n \"unitMultilevelPointsQuantity\": 0,\r\n \"associatedItem\": true,\r\n \"associatedItemRequired\": false,\r\n \"associatedItemOrigin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"simulatedValueProfitability\": 18,\r\n \"simulatedValueProfitabilityUnit\": 18,\r\n \"profitabilityValue\": 0,\r\n \"origin\": {\r\n \"id\": 1,\r\n \"description\": \"Sale\"\r\n },\r\n \"isBloquedRemoveItem\": false,\r\n \"isBlockedEditQuantity\": true,\r\n \"confirmAssociatedItemDeletion\": false,\r\n \"associatedItemOriginDetails\": {\r\n \"origin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"promotionCode\": 12351, \r\n \"promotionDescription\": \"Promotion 01\",\r\n \"order\": 12345,\r\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\r\n \"orderCycle\": 202001,\r\n \"programPointsCode\": 2,\r\n \"programPointsDescription\": \"Points Program 01\",\r\n \"notificationCode\": 2,\r\n \"productCode\": 32\r\n },\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 23\",\r\n \"hasDiscountValue\": false,\r\n \"hasAppliedProfitabilityValueAddItem\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"displayItemWithDiscountPromotion\": false,\r\n \"unitMeasurementType\": {\r\n \"id\": 1,\r\n \"description\": \"un\" \r\n },\r\n \"quantityUnitMeasurement\": 1,\r\n \"pricePerUnitMeasurement\": 18,\r\n \"flexNegotiation\": {\r\n \"minValue\": 17.99,\r\n \"maxValue\": 19.99,\r\n \"initialUnitNetValue\": 18,\r\n \"proposedUnitNetValue\": 0,\r\n \"proposedNetValue\": 0,\r\n \"status\": {\r\n \"id\": 1,\r\n \"description\": \"Not traded\"\r\n },\r\n \"allowFlexNegotiation\": true\r\n },\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"cutItems\": [\r\n {\r\n \"type\": { \r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 17,\r\n \"productName\": \"Product 17\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 2,\r\n \"description\": \"Price not registered\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 17\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n },\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n }, \r\n \"productCode\": 22,\r\n \"productName\": \"Product 22\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 8,\r\n \"description\": \"Discontinued product\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 22\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"externalPreAuthorization\": false,\r\n \"allRewardsPromotion\": false\r\n }\r\n }"},{"id":"ae1ab8fc-8d3d-48e9-b025-88955394b928","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"filet","value":"","description":"File with list of items.","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/items/import","host":["{{baseUrl}}"],"path":["api","orders",":id","items","import"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"importRows\": [ // List of imported rows\r\n {\r\n \"containsError\": \"Indicates if the line contains an error\",\r\n \"error\": { // Error found in line\r\n \"code\": \"Error code\",\r\n \"description\": \"Error description\"\r\n },\r\n \"importRow\": { // Imported row\r\n \"code\": \"Item code\",\r\n \"quantity\": \"Item quantity\"\r\n },\r\n \"rowDescription\": \"Row description\",\r\n \"rowNumber\": \"Row number\"\r\n }\r\n ],\r\n \"quantityImportRowsError\": \"Amount of rows with errors\",\r\n \"quantityImportRowsSuccess\": \"Amount of successful rows\",\r\n \"returnObject\": { // Return object \r\n \"number\": \"Order number\",\r\n \"businessInformation\": { // Business information\r\n \"paid\": \"Indicates if the order has already been paid\",\r\n \"orderingCycle\": \"Sales cycle in which the order is being picked up\",\r\n \"marketingCycle\": \"Marketing cycle in which the order is being captured\",\r\n \"itemsQuantity\": \"Quantity of items included in the order\",\r\n \"productsQuantity\": \"Amount of times the product was entered in the order with the same origin (Donation/Sale). This is generally used when working with Sales Kits\",\r\n \"pointsQuantity\": \"Amount of points earned on order\",\r\n \"minimumPointsQuantity\": \"Minimum order value (in points or currency) so that the capture can be completed\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"tableValue\": \"Product table value\",\r\n \"marketValue\": \"Product value practiced\",\r\n \"netValue\": \"Net product value\",\r\n \"businessModelCode\": \"Business rule code\",\r\n \"businessModelName\": \"Business Rule Name\",\r\n \"functionCode\": \"Person's Function Code\",\r\n \"simulatedValue\": \"Simulated order value\",\r\n \"simulatedPoints\": \"Simulated value of points that the owner of the order currently has\",\r\n \"simulatedOrderPoints\": \"Simulated order point value\",\r\n \"simulatedValueProfitabilityGifts\":\"Total profit forecast from order gifts\",\r\n \"distributionCenterCode\": \"Distribution center code\",\r\n \"isWithdrawalCenter\": \"Indicates whether the order should be picked up at a distribution center\",\r\n \"minimumPointsQuantityConsideredOrder\": \"Minimum value (in points or currency) reached at the time of capture\", // Always returns an integer value. If the amount is to be converted to currency, a division is performed by 100\r\n \"minimumOrderType\": { // The type of value that should be considered for the minimum order - 0 for points and 1 for monetary values\r\n \"id\": \"Value type code\",\r\n \"description\": \"Description of value type\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": \"Allows you to change the quantity of an embedded item (PermissaoConferenciaItensIncorporate)\",\r\n \"flexBalanceAvailable\": \"Available flex budget amount\",\r\n \"flexBalanceAmountConsumed\": \"Amount of flex budget consumed in the order\",\r\n \"flexBalanceUpdatedAvailable\": \"Updated amount of available flex budget\",\r\n \"proposedNetValue\": \"Proposed trading value\",\r\n \"allowFlexNegotiation\": \"Allows the user to use flex budget\" \r\n },\r\n \"businessStructure\": { // Business Structure\r\n \"businessStructureCode\": \"Business Structure Code\"\r\n },\r\n \"items\": [ // List of items included in the order\r\n {\r\n \"number\": \"Item number\",\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Quantity of item on order\",\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"unitNetValue\": \"Net unit value\",\r\n \"unitPointsQuantity\": \"Amount of points earned per product unit\",\r\n \"unitKitPointsQuantity\": \"Amount of points earned per product unit in relation to the kit\", \r\n \"unitMultilevelPointsQuantity\": \"Amount of points earned per product unit in a multilevel environment\",\r\n \"associatedItem\": \"Indicates if the product is associated with another\",\r\n \"associatedItemRequired\": \"Indicates whether the associated product should be purchased\",\r\n \"associatedItemOrigin\": { // Origin of associated item - Possible values in glossary (Embedded Item Origins)\r\n \"id\": \"Source code of associated item\",\r\n \"description\": \"Description of the associated item's origin\"\r\n },\r\n \"simulatedValueProfitability\": \"Simulated Profitability Value\",\r\n \"simulatedValueProfitabilityUnit\": \"Simulated Profitability Value per unit\",\r\n \"profitabilityValue\": \"Profitability Value\",\r\n \"origin\": { // Item Origin - Possible Glossary Values (Product Origins)\r\n \"id\": \"Item source code\",\r\n \"description\": \"Description of the item's origin\"\r\n },\r\n \"isBloquedRemoveItem\": \"Indicates whether the item can be removed\",\r\n \"isBloquedEditQuantity\": \"Indicates whether the item quantity can be edited\",\r\n \"confirmAssociatedItemDeletion\": \"Indicates the product will be removed forever\",\r\n \"associatedItemOriginDetails\": { // Embedded Item Origin Details\r\n \"origin\": { // Origin of associated item - Possible values in glossary (Origins of Embedded Item)\r\n \"id\": \"Embedded item source code\",\r\n \"description\": \"Description of the embedded item's origin\"\r\n },\r\n \"promotionCode\": \"Promotion code\",\r\n \"promotionDescription\": \"Description of the promotion\",\r\n \"order\": \"Order\",\r\n \"collectionDate\": \"Date of collection\",\r\n \"orderCycle\": \"Capture cycle\",\r\n \"programPointsCode\": \"Point program code\",\r\n \"programPointsDescription\": \"Description of points program\",\r\n \"notificationCode\": \"Notification code\",\r\n \"productCode\": \"Embedded product code\"\r\n },\r\n \"isMaterialKit\": \"Indicates the material is a kit\",\r\n \"productDescription\": \"Product description\",\r\n \"hasDiscountValue\": \"Indicates if the product has a discount\",\r\n \"hasAppliedProfitabilityValueAddItem\": \"Indicates whether the order owner's profitability is applied to the product inclusion\",\r\n \"multipleSaleRestriction\": \"Multiple sales quantity that the product has\", // Must be included in multiples of x\r\n \"displayItemWithDiscountPromotion\": \"Indicates if the item has any promotion discount\",\r\n \"unitMeasurementType\": { // Type of unit of measure - Possible values in glossary (Units of Measure for Product)\r\n \"id\": \"Unit of measurement code\",\r\n \"description\": \"Description of the unit of measure\"\r\n },\r\n \"quantityUnitMeasurement\": \"Quantity of measurement units\",\r\n \"pricePerUnitMeasurement\": \"Price per unit of measure\",\r\n \"flexNegotiation\": { // Product price negotiation\r\n \"minValue\": \"Minimum value the product must have\",\r\n \"maxValue\": \"Maximum value the product should have\",\r\n \"initialUnitNetValue\": \"Initial net unit value of the product\", \r\n \"proposedUnitNetValue\": \"Proposed Net Unit Value\",\r\n \"proposedNetValue\": \"Proposed Net Value\" ,\r\n \"status\": { // Product Price Negotiation Status - Possible values in the glossary (Product Value Negotiation Status)\r\n \"id\": \"Negotiation status code\",\r\n \"description\": \"Description of trading status\"\r\n },\r\n \"allowFlexNegotiation\": \"Indicates whether the user can negotiate the product's value\"\r\n },\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"cutItems\": [ // Cut Items\r\n {\r\n \"type\": { // Type of item clipped - Possible values in glossary (Types of item clipped)\r\n \"id\": \"Cut item type code\",\r\n \"description\": \"Description of cropped item type\"\r\n },\r\n \"productCode\": \"Product code\",\r\n \"productName\": \"Product Name\",\r\n \"quantity\": \"Product quantity\",\r\n \"cutReason\": { // Cut Reason - Possible Glossary Values (Product Cut Reasons)\r\n \"id\": \"Cut ratio code\",\r\n \"description\": \"Description of the reason of cut\"\r\n },\r\n \"unitTableValue\": \"Unit table value\",\r\n \"unitMarketValue\": \"Unit value practiced\",\r\n \"isMaterialKit\": \"Indicates the material is a kit\", \r\n \"productDescription\": \"Product description\",\r\n \"isClosedBoxProduct\": \"Indicates that the product is sold in a closed box, with x units\",\r\n \"isPromotionRequirementProduct\": \"Indicates if the product is a requirement for a promotion\"\r\n }\r\n ],\r\n \"externalPreAuthorization\": \"Indicates if the order has previous external authorization\",\r\n \"allRewardsPromotion\": \"Indicates if all available gifts have already been chosen\"\r\n }\r\n }"}],"_postman_id":"d97fc85f-bf11-4d46-a247-208cb7ee767f"}],"id":"883a0e20-66da-447b-835b-cfa6b09407cc","description":"In this step, the user can consult an item and add it - if the user already has the code of an item he wants to add, he can do it directly - or change/remove an item already added to the order. In this step, the endpoints of model product, cut items, and substitute product are also documented.
\nAdd/Change/Remove Item
\n In the body of the call, there is an attribute that deserves attention:
\n\nconfirmedAssociatedItemDeletion: This attribute indicates whether the item in question should be deleted from the current order only or forever. If the value true is passed, the item leaves the list of embedded items and no longer appears in future orders from the user who owns the order. If the value false is passed, the item is excluded only from the current order, being incorporated in future orders of the user that owns the order.
\n If the business rule is configured to allow permanent deletion of an embedded item, the confirmAssociatedItemDeletion attribute is returned in the return object of this call. If the value of this attribute is true, the application should display an alert to the user, asking whether deleting this item should permanently remove the product from the list of embedded items or not. If this feature is enabled, when deleting the item after questioning, the confirmedAssociatedItemDeletion parameter must be passed the value true or false when making the call.
\n After adding/changing/removing an item, if the user wants to add more items, it will be necessary to return to the step of Get Conditional Sale. Otherwise, proceed to next step.
\nModel Product
\n When there are variations of the same product (red, pink, black lipstick), a Model Product is created. This product is associated with its variations, which can be obtained from the model products query.
\nCut Product
\n There are several reasons for a product to be cut from an order. The most common of these is the lack of units in stock. In this case, the system performs the cut when inserting the product, as it will not be possible to make the sale. The cut can also occur for gifts (products that are of the donation type) or Home Kit items (products that are incorporated).
\n To find out if there are hacked products associated with the order, the application must get order status. The cut products will be returned inside the array cutItems.
\nSubstitute Product
\n When registering a product, it is possible to link it to a material. The substitute product will be used in cases where the material is out of stock.
\n To get the replacement product in case of out of stock, the application must call the endpoint below.
\nImport Order
\n The user can choose to import a file with all the items they want. The application can export a template for the user to fill in the desired information. Then the application should import the order file.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"400e2e02-a91a-4f28-afe2-972b8e57afd3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"fedd0f75-4ba3-4bc9-a743-8bb51dc93e3c"}}],"_postman_id":"883a0e20-66da-447b-835b-cfa6b09407cc"},{"name":"Order VI (*)","item":[{"name":"Item Payment Plans","item":[{"name":"View product payment plans","id":"1d3ea111-a5a0-4d36-905e-079aa673e3df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/orders/:id/item/:numberOrderItemId/paymentPlans?paymentMode=","urlObject":{"path":["api","orders",":id","item",":numberOrderItemId","paymentPlans"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Payment Mode Filter.
\n","type":"text/plain"},"key":"paymentMode","value":""}],"variable":[{"id":"312fb20a-2cc3-47a1-a980-e6c3a02da003","description":{"content":"(Required) Order code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"906b20e8-3684-4d61-93e7-43ebeb263f94","description":{"content":"(Required) Item code in the order.
\n","type":"text/plain"},"type":"any","value":"","key":"numberOrderItemId"}]}},"response":[{"id":"3014a48b-9655-4262-ba79-b758200436fd","name":"Response Parameter Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/item/:numberOrderItemId/paymentPlans?paymentMode=","host":["{{baseUrl}}"],"path":["api","orders",":id","item",":numberOrderItemId","paymentPlans"],"query":[{"key":"paymentMode","value":"","description":"Payment Mode Filter."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"numberOrderItemId","value":"","description":"**(Required)** Item code in the order."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"administrateTax\": \"Administrative tax\",\r\n \"code\": \"Code of payment plan by product\",\r\n \"contingentPaymentPlans\": [], // List of contingency payment plans\r\n \"creditTreatment\": { // Credit Treatment - Possible values in the glossary (Credit Treatments)\r\n \"description\": \"Description of credit treatment\",\r\n \"id\": \"Credit handling code\"\r\n },\r\n \"externalPaymentMethod\": { // External payment method - Possible values in the glossary (External Payment Methods)\r\n \"description\": \"Description of external payment method\",\r\n \"id\": \"External payment method code\"\r\n },\r\n \"isBlocked\": \"Indicates if the payment plan is unavailable to be used in the current context of the order\",\r\n \"marketingMessages\": [], // List of marketing messages displayed for payment plan\r\n \"minimumInstallmentAmount\": \"Minimum Installment Value\",\r\n \"name\": \"Payment plan name\",\r\n \"paymentInfo\": [ // Payment information\r\n {\r\n \"installments\": [], // Installments\r\n \"installmentsQuantity\": \"Number of installments\"\r\n }\r\n ],\r\n \"paymentMode\": { // Payment Method - Possible values in the glossary (Payment Methods - Payment Plan)\r\n \"description\": \"Description of payment method\",\r\n \"id\": \"Payment method code\"\r\n },\r\n \"productCode\": \"Product code associated with payment plan\", \r\n \"showCreditConsumptionData\": { // Credit Consumption Data Setting - Possible values in glossary (Credit Consumption Data Settings)\r\n \"description\": \"Configuration description\",\r\n \"id\": \"Configuration code\"\r\n },\r\n \"type\": { // Payment plan type - Possible values in glossary (Payment plan types)\r\n \"description\": \"Description of payment plan type\",\r\n \"id\": \"Payment plan type code\"\r\n }\r\n }\r\n ]"},{"id":"ff3feb3e-b9c4-49a2-80bc-6aa5bece4566","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/orders/:id/item/:numberOrderItemId/paymentPlans?paymentMode=","host":["{{baseUrl}}"],"path":["api","orders",":id","item",":numberOrderItemId","paymentPlans"],"query":[{"key":"paymentMode","value":"","description":"Payment Mode Filter."}],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"numberOrderItemId","value":"","description":"**(Required)** Item code in the order."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"administrateTax\": 2,\n \"code\": 19,\n \"creditTreatment\": {\n \"description\": \"Check credit\",\n \"id\": 1\n },\n \"externalPaymentMethod\": {\n \"description\": \"No\",\n \"id\": 0\n },\n \"isBlocked\": false,\n \"marketingMessages\": [\n {\n \"priority\": 0,\n \"text\": \"Message when selecting the receiving plan\"\n }\n ],\n \"minimumInstallmentAmount\": 0,\n \"name\": \"5x\",\n \"paymentInfo\": [\n {\n \"installments\": [\n 1, \n two,\n 3,\n 4,\n 5\n ],\n \"installmentsQuantity\": 5\n }\n ],\n \"paymentMode\": {\n \"description\": \"Boleto\",\n \"id\": 1\n },\n \"productCode\": 21,\n \"showCreditConsumptionData\": {\n \"description\": \"Yes\",\n \"id\": 1\n },\n \"type\": {\n \"description\": \"Postpaid\",\n \"id\": 2\n }\n }\n ]"}],"_postman_id":"1d3ea111-a5a0-4d36-905e-079aa673e3df"},{"name":"Change product payment plan","id":"04d747f9-950e-4d95-af09-ecd3ce4b075d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"paymentPlanCode","value":"","description":"Payment plan code.
\n"},{"key":"paymentModeId","value":"","description":"Payment method code.
\n"},{"key":"creditCardType","value":"","description":"Credit card type.
\n It must only be passed when the method of payment is credit card.
\n"},{"key":"installmentsQuantity","value":"","description":"Number of installments. It should only be passed when the payment mode has multiple payments.
\n"},{"key":"productCode","value":"","description":"Product code.
\n"}]},"url":"{{baseUrl}}/api/orders/:id/item/:numberOrderItemId/paymentPlansByOrderItem","description":"This call is used to change the payment plan for a specific product on order.
\n","urlObject":{"path":["api","orders",":id","item",":numberOrderItemId","paymentPlansByOrderItem"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"7f152467-4712-4099-8589-8f3c6a71b6f4","description":{"content":"(Mandatory)
\n Request code.
\n","type":"text/plain"},"type":"any","value":"{{codigoPedido}}","key":"id"},{"id":"ccd28866-1f89-448d-8174-f4d13b08e7db","description":{"content":"(Mandatory)
\n Item code in the order.
\n","type":"text/plain"},"type":"any","value":"","key":"numberOrderItemId"}]}},"response":[{"id":"6bce8713-7897-4c70-b1c4-1b4ed6429c00","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"paymentPlanCode","value":"","description":"Payment plan code."},{"key":"paymentModeId","value":"","description":"Payment method code."},{"key":"creditCardType","value":"","description":"Credit card type. \n\n It must only be passed when the method of payment is credit card."},{"key":"installmentsQuantity","value":"","description":"Number of installments. It should only be passed when the payment mode has multiple payments."},{"key":"productCode","value":"","description":"Product code."}]},"url":{"raw":"{{baseUrl}}/api/orders/:id/item/:numberOrderItemId/paymentPlansByOrderItem","host":["{{baseUrl}}"],"path":["api","orders",":id","item",":numberOrderItemId","paymentPlansByOrderItem"],"variable":[{"key":"id","value":"{{codigoPedido}}","description":"**(Required)** Order code."},{"key":"numberOrderItemId","value":"","description":"**(Required)** Item code in the order."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"number\": 16276089,\r\n \"businessInformation\": {\r\n \"paid\": false,\r\n \"orderingCycle\": 202011,\r\n \"marketingCycle\": 202011,\r\n \"itemsQuantity\": 1,\r\n \"productsQuantity\": 1,\r\n \"pointsQuantity\": 1800,\r\n \"minimumPointsQuantity\": 11100,\r\n \"tableValue\": 18,\r\n \"marketValue\": 18,\r\n \"netValue\": 18,\r\n \"businessModelCode\": 5,\r\n \"businessModelName\": \"Business Model - Final Consumer\",\r\n \"functionCode\": 9,\r\n \"simulatedValue\": 18,\r\n \"simulatedPoints\": 12423,\r\n \"simulatedOrderPoints\": 1800,\r\n \"simulatedValueProfitabilityGifts\": 0,\r\n \"distributionCenterCode\": 1,\r\n \"isWithdrawalCenter\": false,\r\n \"minimumPointsQuantityConsideredOrder\": 1800,\r\n \"minimumOrderType\": {\r\n \"id\": 1,\r\n \"description\": \"Monetary\"\r\n },\r\n \"allowChangeIncorporatedItemQuantity\": true,\r\n \"flexBalanceAvailable\": 0,\r\n \"flexBalanceAmountConsumed\": 0,\r\n \"flexBalanceUpdatedAvailable\": 0,\r\n \"proposedNetValue\": 0,\r\n \"allowFlexNegotiation\": false\r\n },\r\n \"businessStructure\": {\r\n \"businessStructureCode\": 30\r\n },\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"productCode\": 23, \r\n \"productName\": \"Product 01\",\r\n \"quantity\": 1,\r\n \"unitTableValue\": 18,\r\n \"unitMarketValue\": 18,\r\n \"unitNetValue\": 18,\r\n \"unitPointsQuantity\": 1800,\r\n \"unitKitPointsQuantity\": 0,\r\n \"unitMultilevelPointsQuantity\": 0,\r\n \"associatedItem\": true,\r\n \"associatedItemRequired\": false,\r\n \"associatedItemOrigin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"simulatedValueProfitability\": 18,\r\n \"simulatedValueProfitabilityUnit\": 18,\r\n \"profitabilityValue\": 0,\r\n \"origin\": {\r\n \"id\": 1,\r\n \"description\": \"Sale\" \r\n },\r\n \"isBloquedRemoveItem\": false,\r\n \"isBlockedEditQuantity\": true,\r\n \"confirmAssociatedItemDeletion\": false,\r\n \"associatedItemOriginDetails\": {\r\n \"origin\": {\r\n \"id\": 3,\r\n \"description\": \"Start Kit\"\r\n },\r\n \"promotionCode\": 12351,\r\n \"promotionDescription\": \"Promotion 01\",\r\n \"order\": 12345,\r\n \"collectionDate\": \"2020-11-18T20:53:26.074Z\",\r\n \"orderCycle\": 202001,\r\n \"programPointsCode\": 2,\r\n \"programPointsDescription\": \"Points Program 01\",\r\n \"notificationCode\": 2,\r\n \"productCode\": 32\r\n },\r\n \"isMaterialKit\": false, \r\n \"productDescription\": \"Product 01\",\r\n \"hasDiscountValue\": false,\r\n \"hasAppliedProfitabilityValueAddItem\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"displayItemWithDiscountPromotion\": false,\r\n \"unitMeasurementType\": {\r\n \"id\": 1,\r\n \"description\": \"un\"\r\n },\r\n \"quantityUnitMeasurement\": 1,\r\n \"pricePerUnitMeasurement\": 18,\r\n \"flexNegotiation\": {\r\n \"minValue\": 17.99,\r\n \"maxValue\": 19.99,\r\n \"initialUnitNetValue\": 18,\r\n \"proposedUnitNetValue\": 0,\r\n \"proposedNetValue\": 0,\r\n \"status\": {\r\n \"id\": 1,\r\n \"description\": \"No negotiated\"\r\n },\r\n \"allowFlexNegotiation\": true\r\n },\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"cutItems\": [\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 17,\r\n \"productName\": \"Product 02\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 2,\r\n \"description\": \"Price not registered\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 02\",\r\n \"isClosedBoxProduct\": false,\r\n \"isPromotionRequirementProduct\": false\r\n },\r\n {\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Embedded\"\r\n },\r\n \"productCode\": 22,\r\n \"productName\": \"Product 03\",\r\n \"quantity\": 1,\r\n \"cutReason\": {\r\n \"id\": 8,\r\n \"description\": \"Discontinued product\"\r\n },\r\n \"unitTableValue\": 0,\r\n \"unitMarketValue\": 0,\r\n \"isMaterialKit\": false,\r\n \"productDescription\": \"Product 03\",\r\n \"isClosedBoxProduct\": false, \r\n \"isPromotionRequirementProduct\": false\r\n }\r\n ],\r\n \"externalPreAuthorization\": false,\r\n \"orderBusinessStatus\": {\r\n \"code\": 7,\r\n \"description\": \"Reserved\",\r\n \"dateCreated\": \"2020-11-13T16:24:05.197Z\"\r\n },\r\n \"allRewardsPromotion\": false,\r\n \"paymentPlans\": {\r\n \"administrateTax\": 0,\r\n \"code\": 17,\r\n \"contingentPaymentPlans\": [],\r\n \"creditTreatment\": {\r\n \"description\": \"Ignore credit - does not consume credit\",\r\n \"id\": 3\r\n },\r\n \"externalPaymentMethod\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"isBlocked\": false,\r\n \"marketingMessages\": [\r\n {\r\n \"priority\": 0,\r\n \"text\": \"Message when selecting the receiving plan\"\r\n }\r\n ],\r\n \"minimumInstallmentAmount\": 0,\r\n \"name\": \"Currency(BRL)\",\r\n \"paymentInfo\": [\r\n {\r\n \"installments\":[1] ,\r\n \"installmentsQuantity\": 1\r\n }\r\n ],\r\n \"paymentMode\": {\r\n \"description\": \"In Kind\",\r\n \"id\": 11\r\n },\r\n \"showCreditConsumptionData\": {\r\n \"description\": \"No\", \r\n \"id\": 0\r\n },\r\n \"type\": {\r\n \"description\": \"Prepaid\",\r\n \"id\": 1\r\n }\r\n },\r\n \"acquiredPromotion\": [\r\n {\r\n \"code\": 568,\r\n \"deliveryDiscountPromotion\": [\r\n {\r\n \"discount\": 10,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Percentage Discount\"\r\n }\r\n }\r\n ],\r\n \"description\": \"Product code 1\",\r\n \"destination\": {\r\n \"id\": 1,\r\n \"description\": \"Reseller\"\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"itemOrderDeliveryDiscountPromotion\": [\r\n {\r\n \"discount\": 10,\r\n \"type\": {\r\n \"id\": 3,\r\n \"description\": \"Percentage Discount\"\r\n }\r\n }\r\n ],\r\n \"mileagePromotion\": [\r\n {\r\n \"points\": 100,\r\n \"type\": {\r\n \"id\": 5,\r\n \"description\": \"Miles\"\r\n }\r\n }\r\n ],\r\n \"orderExhibition\": 2147483647,\r\n \"rewards\": [\r\n {\r\n \"discount\": 3, \r\n \"isGiftToChoose\": false,\r\n \"isMaterialKit\": true,\r\n \"productCode\": 1,\r\n \"productDescription\": \"Product Kit Home - 1\",\r\n \"productName\": \"Product Kit Home - 1\",\r\n \"quantity\": 3\r\n }\r\n ],\r\n \"type\": {\r\n \"id\": 4,\r\n \"description\": \"Absolute discount\"\r\n },\r\n \"suggest\": true,\r\n \"title\": \"Promo Scenario 01\"\r\n }\r\n ],\r\n \"partialPromotions\": [\r\n {\r\n \"code\": 577,\r\n \"description\": \"Products: 7,8,9,10\",\r\n \"destination\": {\r\n \"description\": \"Reseller\", \r\n \"id\": 1\r\n },\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"requirements\":\r\n [\r\n {\r\n \"description\": \"Product 8\",\r\n \"logicOperator\": {\r\n \"description\": \"And\",\r\n \"id\": 1\r\n },\r\n \"missingValue\": 1,\r\n \"productRequired\": {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 9500,\r\n \"productCode\": 8,\r\n \"productDescription\": \"Product 8\",\r\n \"productName\": \"Product 8\", \r\n \"unityPrice\": 95\r\n },\r\n \"valueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n }\r\n },\r\n {\r\n \"description\": \"Product 9\",\r\n \"logicOperator\": {\r\n \"description\": \"And\",\r\n \"id\": 1\r\n },\r\n \"missingValue\": 1,\r\n \"productRequired\": {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 3000,\r\n \"productCode\": 9,\r\n \"productDescription\": \"Product 9\",\r\n \"productName\": \"Product 9\",\r\n \"unityPrice\": 30\r\n }, \r\n \"valueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n }\r\n },\r\n {\r\n \"description\": \"Product 10\",\r\n \"missingValue\": 1,\r\n \"productRequired\": {\r\n \"isKit\": false,\r\n \"multipleSaleRestriction\": 1,\r\n \"points\": 6700,\r\n \"pricePerUnitMeasurement\": 33.5,\r\n \"productCode\": 10,\r\n \"productDescription\": \"\",\r\n \"productName\": \"Product 10\",\r\n \"quantityUnitMeasurement\": 2,\r\n \"unitMeasurementType\": {\r\n \"description\": \"Box\",\r\n \"id\": 2\r\n },\r\n \"unityPrice\": 67, \r\n \"valueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n }\r\n }\r\n }\r\n ],\r\n \"suggest\": true,\r\n \"title\": \"Scenario 5\"\r\n }\r\n ],\r\n \"paymentPlansByProduct\": [\r\n {\r\n \"administrateTax\": 2,\r\n \"code\": 19,\r\n \"creditTreatment\": {\r\n \"description\": \"Check credit\",\r\n \"id\": 1\r\n },\r\n \"externalPaymentMethod\": {\r\n \"description\": \"No\",\r\n \"id\": 0\r\n },\r\n \"isBlocked\": false,\r\n \"marketingMessages\": [\r\n {\r\n \"priority\": 0,\r\n \"text\": \"Message when selecting the receiving plan\"\r\n }\r\n ],\r\n \"minimumInstallmentAmount\": 0,\r\n \"name\": \"5x\",\r\n \"paymentInfo\": [\r\n {\r\n \"installments\": [1, 2, 3, 4, 5],\r\n \"installmentsQuantity\": 5\r\n }\r\n ],\r\n \"paymentMode\": {\r\n \"description\": \"Boleto\",\r\n \"id\": 1\r\n },\r\n \"productCode\": 21,\r\n \"showCreditConsumptionData\": {\r\n \"description\": \"Yes\",\r\n \"id\": 1\r\n },\r\n \"type\": { \r\n \"description\": \"Postpaid\",\r\n \"id\": 2\r\n }\r\n }\r\n ],\r\n \"representative\": {\r\n \"representativeCode\": 216\r\n },\r\n \"rewardsToChoosePromotions\": [\r\n {\r\n \"chosenDiscount\": true,\r\n \"chosenProducts\": false,\r\n \"code\": 578,\r\n \"description\": \"Gift Or Discount Promotion Test\",\r\n \"destination\": {\r\n \"description\": \"Reseller\",\r\n \"id\": 1\r\n },\r\n \"discountDescription\": \"2 - Order\",\r\n \"discountNumber\": 2,\r\n \"discountToChoose\": [\r\n {\r\n \"auxiliaryDescription\": \"\",\r\n \"code\": 0,\r\n \"discountTargetType\": {\r\n \"description\": \"Order\",\r\n \"id\": 4\r\n },\r\n \"isMaterialKit\": false,\r\n \"rewardType\": {\r\n \"description\": \"Percentage Discount\",\r\n \"id\": 3\r\n },\r\n \"value\": 10\r\n }\r\n ],\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"giftItemNumber\": 1,\r\n \"giftNumber\": 1,\r\n \"giftValue\": 6,\r\n \"giftValueType\": {\r\n \"description\": \"Items\",\r\n \"id\": 1\r\n },\r\n \"isCupomPromotion\": false,\r\n \"message\": \"\",\r\n \"orderExhibition\": 2147483647,\r\n \"productsToChoose\": [\r\n {\r\n \"chosenQuantity\": 0,\r\n \"isMaterialKit\": false,\r\n \"isReorderAllowed\": false,\r\n \"productCode\": 6,\r\n \"productDescription\": \"Product 6\",\r\n \"productName\": \"Product 6\",\r\n \"unavailable\": true,\r\n \"value\": 1\r\n },\r\n {\r\n \"chosenQuantity\": 0,\r\n \"isMaterialKit\": false,\r\n \"isReorderAllowed\": false,\r\n \"productCode\": 50,\r\n \"productDescription\": \"Product 50\",\r\n \"productName\": \"Product 50\", \r\n \"unavailable\": true,\r\n \"value\": 1\r\n },\r\n {\r\n \"chosenQuantity\": 0,\r\n \"isMaterialKit\": false,\r\n \"isReorderAllowed\": false,\r\n \"productCode\": 178,\r\n \"productDescription\": \"Product 178\",\r\n \"productName\": \"Product 178\",\r\n \"unavailable\": false,\r\n \"value\": 1\r\n }\r\n ],\r\n \"suggest\": true,\r\n \"title\": \"Gift Or Discount Promotion Test\",\r\n \"unavaiableDiscount\": false\r\n }\r\n ],\r\n \"totals\": {\r\n \"allowsCheckingAccountAdjustment\": true,\r\n \"checkingAccountOriginalValue\": -39.87,\r\n \"checkingAccountTotalValue\": -39.87,\r\n \"checkingAccountValue\": -39.87,\r\n \"collectionFee\": 0,\r\n \"commissionValue\": -61.8,\r\n \"creditCheckingAccountValue\": 39.87,\r\n \"debitCheckingAccountValue\": 0,\r\n \"deliveryTax\": 10,\r\n \"negotiationDiscount\": 0,\r\n \"productsValue\": 206,\r\n \"promotionDiscount\": 0,\r\n \"simulatedNetValue\": 14420,\r\n \"taxesValue\": 0,\r\n \"totalProductValueWithoutDiscount\": 206,\r\n \"totalValue\": 114.33,\r\n \"totalValueWithoutDiscount\": 114.33\r\n },\r\n \"unavailablePromotions\": [\r\n {\r\n \"code\": 575,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"isCupomPromotion\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": false,\r\n \"title\": \"Promo test\"\r\n }\r\n ],\r\n \"validPromotion\": [\r\n {\r\n \"number\": 6,\r\n \"productCode\": 8,\r\n \"productName\": \"Product 8\",\r\n \"promotion\": {\r\n \"code\": 774,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": false,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Promocao 2701 Qt 10 Product 14\"\r\n }, \r\n \"quantity\": 1\r\n },\r\n {\r\n \"number\": 11,\r\n \"productCode\": 178,\r\n \"productName\": \"Product 8\",\r\n \"promotion\": {\r\n \"code\": 781,\r\n \"display\": true,\r\n \"displayMissingItemsToWin\": true,\r\n \"orderExhibition\": 2147483647,\r\n \"suggest\": true,\r\n \"title\": \"Promocao 2701 Qt 10 Product 14\"\r\n },\r\n \"quantity\": 2\r\n }\r\n ]\r\n }"},{"id":"244702f8-ebd9-4c95-a13d-f0d2beaca15e","name":"Response Parameter Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"paymentPlanCode","value":"","description":"Payment plan code."},{"key":"paymentModeId","value":"","description":"Payment method code."},{"key":"creditCardType","value":"