https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/ Recent content in SOAP on Product Documentation Hugo en-US https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/overview/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/overview/ <h2 id="purpose">Purpose</h2> <p>This page is the entry point for SOAP-based interfaces in the BE-Commerce module.</p> <h2 id="scope">Scope</h2> <ul> <li>XML-based export and import operations</li> <li>Channel-specific transfer using a unique webshop identifier</li> <li>Processing through container and downstream module processes</li> </ul> <h2 id="guardrails">Guardrails</h2> <ul> <li>Requests and responses follow operation-specific XML schemas.</li> <li>Required parameters must be provided for each method.</li> <li>Semantic validation is often executed in downstream processing steps.</li> </ul> <section class="bt-docs-block bt-docs-block--links"> <header class="bt-docs-block__header"> <p class="bt-docs-block__eyebrow">Links</p> <h2 class="bt-docs-block__title">Further Information</h2> </header> <div class="bt-docs-block__body"> <div class="bt-docs-link-groups"><section class="bt-docs-link-groups__group"> <h3 class="bt-docs-link-groups__title">SOAP Endpoints</h3> <div class="bt-docs-link-groups__body bt-docs-link-block"> <ul> <li><a href="https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/reference-processes/">Reference Processes</a></li> </ul> </div> </section> <section class="bt-docs-link-groups__group"> <h3 class="bt-docs-link-groups__title">Related Content</h3> <div class="bt-docs-link-groups__body bt-docs-link-block"> <ul> <li><a href="https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/json-rest/overview/">JSON-REST Interfaces</a></li> </ul> </div> </section> </div> </div> </section> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-item/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-item/ <h2 id="purpose">Purpose</h2> <p>This SOAP method exports item data for a webshop channel, optionally filtered to a single item.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>ItemExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameters">Optional Parameters</h2> <ul> <li><code>itemNo_P</code></li> <li><code>incremental_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>itemExport_PX</code> with item header, descriptions, categories, attributes, and variants.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives current item master data for synchronization and product display.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-item-list/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-item-list/ <h2 id="purpose">Purpose</h2> <p>This method returns a list of item numbers changed since a given timestamp.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>ItemListExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameter">Optional Parameter</h2> <ul> <li><code>changedSince_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>itemListExport_PX</code> with affected item numbers.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop can run delta synchronization and fetch only changed items.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-sales-order-history/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-sales-order-history/ <h2 id="purpose">Purpose</h2> <p>This method returns history entries for webshop orders including line references.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>OrderHistoryExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameters">Optional Parameters</h2> <ul> <li><code>changedSince_P</code></li> <li><code>orderNo_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>orderHistoryExport_PX</code> with history headers and line details.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop can track processing history per order and per line.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-inventory/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-inventory/ <h2 id="purpose">Purpose</h2> <p>This method returns inventory values for items and variants.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>InventoryExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameters">Optional Parameters</h2> <ul> <li><code>changedSince_P</code></li> <li><code>itemNo_P</code></li> <li><code>incremental_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>inventoryExport_PX</code> with items, variants, and stock values.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives inventory for availability and synchronization.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-document-status/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-document-status/ <h2 id="purpose">Purpose</h2> <p>This method returns document creation status including error text.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>DocumentStatusExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameters">Required Parameters</h2> <ul> <li><code>webshopChannel_P</code></li> <li><code>OrderType_P</code></li> <li><code>OrderNo_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li><code>return_value</code> with success or failure status</li> <li><code>errortext_P</code> in error cases</li> </ul> <h2 id="result">Result</h2> <ul> <li>Integrations can verify whether posting succeeded.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-dynamic-attributes/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-dynamic-attributes/ <h2 id="purpose">Purpose</h2> <p>This method returns dynamic attributes with translations and possible values.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>DynamicAttributeExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameter">Optional Parameter</h2> <ul> <li><code>attributeCode_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>dynamicAttributeExport_PX</code> with attributes, value sets, and labels.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives attribute metadata for filtering and product representation.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-branch-inventory/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-branch-inventory/ <h2 id="purpose">Purpose</h2> <p>This method returns available stock per branch, item, and variant.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>BranchInventoryExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameter">Optional Parameter</h2> <ul> <li><code>itemNo_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>branchInventoryExport_PX</code> with variants and mapped branch quantities.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop can display branch-level availability.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-free-text-attributes/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-free-text-attributes/ <h2 id="purpose">Purpose</h2> <p>This method returns free text attributes including language-specific labels.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>FreeTextAttributeExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameter">Optional Parameter</h2> <ul> <li><code>freeTextAttributeCode_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>freeTextAttributeExport_PX</code> with attribute code and description nodes.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives free text metadata for product content and UI labels.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-voucher/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-voucher/ <h2 id="purpose">Purpose</h2> <p>This method returns voucher status and balance information for a webshop channel.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>VoucherExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameter">Optional Parameter</h2> <ul> <li><code>VoucherNo_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>voucherExport_PX</code> with voucher ID, state, amount, and currency.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop can synchronize voucher validation and voucher status display.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-contact/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-contact/ <h2 id="purpose">Purpose</h2> <p>This method exports contact master data per channel, optionally filtered to one contact.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>ContactExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameters">Optional Parameters</h2> <ul> <li><code>contactNo_P</code></li> <li><code>incremental_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>contactExport_PX</code> with contact fields such as name, address, country, and communication data.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives current contact master data.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-contact-status/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-contact-status/ <h2 id="purpose">Purpose</h2> <p>This method returns processing status for contact creation or update.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>ContactStatusExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameters">Required Parameters</h2> <ul> <li><code>webshopChannel_P</code></li> <li><code>contactNo_P</code> or <code>eMail_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li><code>return_value</code> and optional <code>errortext_P</code>.</li> </ul> <h2 id="result">Result</h2> <ul> <li>External systems can verify contact processing completion.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-location/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-location/ <h2 id="purpose">Purpose</h2> <p>This method exports location master data for a sales channel.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>LocationExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML in <code>locationBranchExport_PX</code> with location code, name, and address data.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives channel-relevant location data.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-price/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-price/ <h2 id="purpose">Purpose</h2> <p>This method provides channel-based price information including customer groups and VAT flag.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>PriceExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameters">Optional Parameters</h2> <ul> <li><code>changedSince_P</code></li> <li><code>itemNo_P</code></li> <li><code>incremental_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML with variant prices, currency, list price fields, and <code>priceIncludesVAT</code>.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives price structures for catalog and checkout calculations.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-webshop-category/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/export-webshop-category/ <h2 id="purpose">Purpose</h2> <p>This method exports webshop categories including parent relationship and multilingual descriptions.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>CategoryExport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="optional-parameter">Optional Parameter</h2> <ul> <li><code>categoryCode_P</code></li> </ul> <h2 id="response">Response</h2> <ul> <li>XML with category code, parent, active/hidden flags, and description nodes.</li> </ul> <h2 id="result">Result</h2> <ul> <li>The webshop receives category tree data and translated labels.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-sales-order/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-sales-order/ <h2 id="purpose">Purpose</h2> <p>This method imports sales order payload from the webshop into BC import tables.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>OrderImport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="payload-core">Payload Core</h2> <ul> <li><code>webshopOrderImport_PX</code> with header, addresses, payment data, and <code>orderlines</code></li> </ul> <h2 id="processing-logic">Processing Logic</h2> <ul> <li>SOAP import performs primarily syntactic validation.</li> <li>Semantic validation and document creation run in a background process.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-contact/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-contact/ <h2 id="purpose">Purpose</h2> <p>This method imports contact payload and prepares it for downstream processing.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>CreateOrUpdateSingleContact</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="payload-core">Payload Core</h2> <ul> <li><code>webshopContactImport_PX</code> with <code>webshopContact</code> structure</li> </ul> <h2 id="processing-logic">Processing Logic</h2> <ul> <li>Syntactic validation at import time.</li> <li>Semantic validation and create/update in follow-up processing.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-return/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-return/ <h2 id="purpose">Purpose</h2> <p>This method imports returns from the webshop into BC import containers.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>ReturnImport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="payload-core">Payload Core</h2> <ul> <li><code>webshopReturnImport_PX</code> with <code>returnOrder</code> and <code>returnOrderLines</code></li> </ul> <h2 id="processing-logic">Processing Logic</h2> <ul> <li>Syntactic validation during SOAP call.</li> <li>Semantic processing and document creation in downstream steps.</li> </ul> https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-reservation/ Mon, 01 Jan 0001 00:00:00 +0000 https://bc.help.be-terna.com/en-us/docs/business-central/cross-industry-solutions/commerce-interface/be-commerce/interface/soap/import-reservation/ <h2 id="purpose">Purpose</h2> <p>This method imports reservation payload including lines and address data.</p> <h2 id="method">Method</h2> <ul> <li>Operation: <code>ReservationImport</code></li> <li>Service: Codeunit <code>BEConnect</code> as SOAP web service</li> </ul> <h2 id="required-parameter">Required Parameter</h2> <ul> <li><code>webshopChannel_P</code></li> </ul> <h2 id="payload-core">Payload Core</h2> <ul> <li><code>webshopReservationImport_PX</code> with header, <code>reservationOrder</code>, and <code>reservationOrderLines</code></li> </ul> <h2 id="processing-logic">Processing Logic</h2> <ul> <li>Syntactic validation during import.</li> <li>Semantic processing in the background process.</li> </ul>