JSON-REST on Product Documentation

JSON-REST Interfaces

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This page is the entry point for JSON-REST interfaces in the BE-Commerce module.

Scope

Export endpoints for master data, prices, inventory, and status information
Import endpoints for sales orders, contacts, returns, and reservations
Consistent conventions for filters, request payloads, and responses

Guardrails

Slugs and endpoint names remain ASCII and consistent.
Required filters (for example webshop channel code) are mandatory per endpoint.
Payload changes must be aligned with webshop integration and downstream processes.

Export Item

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns item data for a webshop channel including optional expansions such as descriptions, categories, attributes, cross-selling, and variants.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/items?$filter=webshopChannelCode eq '<webshop-channel-code>' and no eq '<item-no>'&$expand=itemDescriptions($expand=descriptions),categories,itemDynamicAttributes,itemFreeTextAttributes($expand=freeTextLanguages),crossSellingItems,itemSelectionVariants($expand=crossSellingVariants)

Required Parameters

webshopChannelCode in the filter
no (item number) in the filter

Optional Expansions

itemDescriptions
categories
itemDynamicAttributes
itemFreeTextAttributes
crossSellingItems
itemSelectionVariants

Key Response Fields

Item header: systemId, webshopChannelCode, no, released, firstReleasedDate, vendorNo, itemDescription
Descriptions: language, meta title, description types
Category assignment: code and main flag
Attributes: dynamic and free-text attributes with language values
Variants and cross-selling relations

Result

The webshop receives a consolidated item JSON payload for the requested channel and item filter.

Export Price

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint provides price data per webshop channel, optionally filtered to a single item.

Endpoint

Method: GET
URL pattern (channel-wide): http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/itemPrices?$filter=webshopChannelCode eq '<webshop-channel-code>'&$expand=itemVariantPrices($expand=prices)
URL pattern (single item): http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/itemPrices?$filter=webshopChannelCode eq '<webshop-channel-code>' and itemNo eq '<item-no>'&$expand=itemVariantPrices($expand=prices)

Required Parameters

webshopChannelCode in the filter

Key Response Fields

Header: systemId, webshopChannelCode, itemNo, salesPricesSentToWebshop, lastSalesPriceChangeAt
Variants: code
Price lines: currency, unitPrice, customerPriceGroup, priceIncludesVAT

Result

The webshop receives current pricing structures per channel and optionally per item.

Import Sales Order

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint imports webshop order data into the Business Central import container.

Endpoint

Method: POST
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Import/v2.0/companies(<company-system-id>)/orders?$filter=webshopChannelCode eq '<webshop-channel-code>'

Required Parameters

webshopChannelCode filter
JSON payload with order header and at least one orderLines entry

Payload Core Areas

Order header: channel, order ID, date, totals, currency, customer and contact references
Addresses: sell-to, bill-to, and ship-to
Payment and shipping information
Line data (orderLines) including type, item, price, quantity, and optional metadata

Processing Note

The API call primarily performs syntactic import into the container.
Semantic validation and document creation run in downstream processing.

Result

The order is available as an imported record for further BC processing.

Import Contact

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint imports contact data from the webshop into the Business Central contact import container.

Endpoint

Method: POST
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Import/v2.0/companies(<company-system-id>)/webshopContacts

Required Parameters

webshopChannel in the payload
JSON body with contact header data

Payload Core Areas

Contact header: channel, contact number, name, address, language, country, communication data
Optional additional fields such as salutation, first/last name, and company name
Contact lines (webshopcontactLines) for ship-to specific information

Response Behavior

The API returns the imported record as JSON.
With $expand=webshopcontactLines, the response can include contact line data.

Result

The webshop contact is available for downstream processing in BC.

Export Item List

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns the item list for a webshop channel, including send-state and change timestamp.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/itemsList?$filter=webshopChannelCode eq '<webshop-channel-code>' and sentToWebshop eq <true|false> and changedForWebshopAt eq <datetime>

Required Parameter

webshopChannelCode in filter

Optional Filters

sentToWebshop
changedForWebshopAt

Key Response Fields

systemId, itemNo, webshopChannelCode, changedForWebshopAt, sentToWebshop

Result

The webshop receives item list records for delta or full synchronization.

Export Inventory

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns inventory data for one item, including optional variant information.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/inventories?$filter=webshopChannelCode eq '<webshop-channel-code>' and itemNo eq '<item-no>'&$expand=itemVariants

Required Parameters

webshopChannelCode in filter
itemNo in filter

Key Response Fields

Header: systemId, webshopChannelCode, itemNo
Variants: code, inventory

Result

The webshop receives current inventory levels per item and variant.

Export Inventory Item List

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns channel-wide inventory list records including delta indicators.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/inventoriesItemsList?$filter=webshopChannelCode eq '<webshop-channel-code>'

Required Parameter

webshopChannelCode in filter

Key Response Fields

systemId, webshopChannelCode, itemNo, inventorySentToWebshop, lastStockChangeAt

Result

The webshop receives inventory synchronization records for all channel items.

Export Contact

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns contact master data and related ship-to addresses for webshop synchronization.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/contacts?$expand=contactsShipTo

Filters and Expands

Contact filtering is done by contact number
Ship-to addresses are provided via $expand=contactsShipTo

Key Response Fields

Contact: no, name, address, postCode, city, country, email
Ship-to: shipToCode, shipToName, shipToAddress, shipToPostCode, shipToCity

Result

The webshop receives contact data including ship-to structures.

Export Contact Status

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns contact processing status including error text.

Endpoint

Method: POST
URL pattern: http://<server>:<odata-port>/<service-tier>/ODataV4/<serviceName>_ContactStatusExportOData?company=<companyName|companyId>

Required Payload Fields

webshopChannel_P
contactNo_P or eMail_P

Response

The response contains a JSON object in value with contactNo and errorText.

Result

The webshop can check asynchronous contact processing status.

Export Location

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns all locations assigned to a webshop channel.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/channels('<webshop-channel-code>')?$expand=locations

Required Parameter

webshop-channel-code in the channel URL

Key Response Fields

Channel: code
Location: code, name, address, postCode, city, countryRegion, phoneNo, eMail

Result

The webshop receives linked warehouse locations for shipping and availability logic.

Export Vendor

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns vendor master data for integration scenarios.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/vendors

Key Response Fields

systemId, no, name, address, postCode, city, countryRegionCode
eMail, currencyCode, languageCode, paymentTermsCode, shipmentMethodCode, blocked

Result

External systems receive current vendor master data from BC.

Export Webshop Category

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint provides channel category records including hierarchy data and optional translated texts.

Endpoint

Method: GET
URL pattern categories: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/webshopCategories?$filter=webshopChannelCode eq '<webshop-channel-code>'
URL pattern category descriptions: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/webshopCategoryDescriptions?$filter=webshopChannelCode eq '<webshop-channel-code>' and webshopCategorySystemId eq <category-system-id>

Required Parameters

webshopChannelCode
For descriptions additionally webshopCategorySystemId

Key Response Fields

Category: systemId, webshopCategoryCode, parentCategoryCode, active, hidden
Texts: language, text, webshopCategorySystemId

Result

The webshop receives category tree data and multilingual category labels.

Import Return

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint imports return orders from the webshop into the BC import container.

Endpoint

Method: POST
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Import/v2.0/companies(<company-system-id>)/returnOrders

Required Payload Fields

Header: webshopChannelCode, orderId, orderType, orderDate, currency, customerNo, contactNo
Lines (returnOrderLines): at least one line with id, type, amount and source order references (orderNo, orderLineNo)

Response Behavior

Returns imported header as JSON.
Optional $expand=returnOrderLines includes imported lines.

Result

The return order is available for downstream BC processing.

Import Reservation

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint imports reservation orders from the webshop.

Endpoint

Method: POST
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Import/v2.0/companies(<company-system-id>)/webshopReservations?$expand=webshopReservationLines

Required Payload Fields

Header: webshopChannelCode, reservationOrderId, orderType, orderDate, currency
Lines (webshopReservationLines): at least one line with id, type, itemNumber, amount

Key Notes

Empty fields may be omitted in the payload.
Address and contact data can be included when required.

Result

The reservation order is available for further BC processing.

Export Item Description

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This page describes exporting item descriptions (meta title, short description, long description) per language.

Endpoints

Via item export with expand: http://<server>:<port>/<service-tier>/api/beTerna/export/v2.0/companies(<company-system-id>)/items?$filter=webshopChannelCode eq '<webshop-channel-code>' and no eq '<item-no>'&$expand=wsItemDescriptions
Direct description query: http://<server>:<port>/<service-tier>/api/beTerna/export/v2.0/companies(<company-system-id>)/wsItemDescriptions?$filter=webshopChannel eq '<webshop-channel-code>'

Required Parameters

webshopChannelCode or webshopChannel
For item export additionally no

Key Response Fields

itemNo, language, descriptionType, descriptionText

Result

The webshop receives language-specific item content for product and SEO presentation.

Export Order Status

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint provides order status history on both header and line level.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/orderStatusCodes?$filter=webshopChannelCode eq '<webshop-channel-code>' and externalDocumentNo eq '<external-document-no>'

Required Parameters

webshopChannelCode
externalDocumentNo

Key Response Fields

statusCode, documentType, documentNo, externalDocumentNo, lineNo, itemNo, systemCreatedAt

Result

The webshop can track processing status per order and line.

Order Import API - Voucher Processing

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This page describes how to submit voucher lines correctly in the JSON-REST sales order import.

Relevant Endpoint

POST /api/BEterna/Import/v2.0/companies(<company-system-id>)/orders

Voucher Line Types

type = 2: voucher purchase
type = 5: voucher redemption

Core Rules

voucherCode is mandatory for both voucher line types.
For type = 5, singlePrice must be negative or 0.
subtotal is calculated without type = 5 lines.
totalAmount includes all lines, including type = 5.
Redemption total must not exceed subtotal.

Result

Voucher scenarios are imported consistently and processed correctly in BC.

Export Sales Order History

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint provides sales order history data including line-level details.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/orderHistoryHeaders?$filter=webshopChannelCode eq '<webshop-channel-code>'&$expand=orderHistoryLines

Required Parameter

webshopChannelCode in filter

Key Response Fields

Header: webshopOrderNo, salesOrderNo, createdAt, type, postedDocumentNo, trackingNo
Lines: orderLineNo, itemNo, variantCode, quantity, lineAmount, postedDocumentLineNo

Result

The webshop receives order history for tracking and customer visibility.

Export Document Status

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns processing status for a document, including error text.

Endpoint

Method: POST
URL pattern: http://<server>:<odata-port>/<service-tier>/ODataV4/<serviceName>_DocumentStatusExportOData?company=<companyName|companyId>

Required Payload Fields

webshopChannelCode
orderType
orderNo

Response

The response contains JSON in value with documentCreated and errorText.

Result

Integrations can validate whether posting was successful or failed.

Export Dynamic Attributes

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This page describes exporting dynamic attributes including value and language datasets.

Endpoints

Attributes: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/dynamicAttributes
Attribute descriptions: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/dynamicAttributeDescriptions?$filter=webshopChannelCode eq '<webshop-channel-code>' and dynamicAttributeSystemId eq <dynamic-attribute-system-id>
Attribute values: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/dynamicAttributeValues?$filter=dynamicAttributeCode eq '<dynamic-attribute-code>'
Value descriptions: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/dynamicAttributeValueDescriptions?$filter=webshopChannelCode eq '<webshop-channel-code>' and dynamicAttributeValueSystemId eq <dynamic-attribute-value-system-id>

Key Response Fields

Attributes: dynamicAttributeCode, filter, show
Values: dynamicAttributeValueCode
Descriptions: language, text

Result

The webshop receives structured attribute and translation data for product presentation.

Export Branch Inventory Item Variant List

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint returns item variants with branch inventory changes since the last synchronization.

Endpoint

Method: GET
URL pattern: http://<server>:<port>/<service-tier>/api/beTerna/export/v2.0/companies(<company-system-id>)/branchinventoriesItemVariantsList?$filter=webshopChannelCode eq '<webshop-channel-code>' and branchinvSentToWebshop eq false

Required Parameter

webshopChannelCode in filter

Key Response Fields

itemNo, variantCode, branchInvSentToWebshop, lastBranchStockChangeAt

Result

This list is used as a high-performance trigger for detailed branch inventory requests.

Export Branch Inventory

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This endpoint provides per-branch inventory for one item including variant structure.

Endpoint

Method: GET
URL pattern: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/branchInventories?$filter=webshopChannelCode eq '<webshop-channel-code>' and no eq '<item-no>'&$expand=branchItemVariants($expand=branchLocations)

Required Parameters

webshopChannelCode in filter
no (item number) in filter

Key Response Fields

Header: webshopChannelCode, no
Variants: code
Branch data: code, inventory, calculationTimeStamp

Result

The webshop receives branch-level availability data.

Export Free Text Attributes

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This page describes exporting free text attributes and their translations.

Endpoints

Free text attributes: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/freeTextAttributes
Free text attribute descriptions: http://<server>:<odata-port>/<service-tier>/api/BEterna/Export/v2.0/companies(<company-system-id>)/freeTextAttributeDescriptions?$filter=webshopChannelCode eq '<webshop-channel-code>' and freeTextAttributeSystemId eq '<free-text-attribute-system-id>'

Required Parameters

For descriptions: webshopChannelCode and freeTextAttributeSystemId

Key Response Fields

Attributes: code
Descriptions: language, text

Result

The webshop receives free text content fields with language-specific labels.

JSON-REST on Product Documentation

JSON-REST Interfaces

Purpose

Scope

Guardrails

Export Item

Purpose

Endpoint

Required Parameters

Optional Expansions

Key Response Fields

Result

Export Price

Purpose

Endpoint

Required Parameters

Key Response Fields

Result

Import Sales Order

Purpose

Endpoint

Required Parameters

Payload Core Areas

Processing Note

Result

See Also

Import Contact

Purpose

Endpoint

Required Parameters

Payload Core Areas

Response Behavior

Result

Export Item List

Purpose

Endpoint

Required Parameter

Optional Filters

Key Response Fields

Result

Export Inventory

Purpose

Endpoint

Required Parameters

Key Response Fields

Result

Export Inventory Item List

Purpose

Endpoint

Required Parameter

Key Response Fields

Result

Export Contact

Purpose

Endpoint

Filters and Expands

Key Response Fields

Result

Export Contact Status

Purpose

Endpoint

Required Payload Fields

Response

Result

Export Location

Purpose

Endpoint

Required Parameter

Key Response Fields

Result

Export Vendor

Purpose

Endpoint

Key Response Fields

Result

Export Webshop Category

Purpose

Endpoint

Required Parameters

Key Response Fields