--- title: Migrating from SOAP WebServices slug: merchant-api/migrating-from-soap-webservices createdAt: 2021-10-05T15:57:20.000Z --- # What are we talking about? Neteven has a legacy set of [SOAP WebServices](https://ws1-4.neteven.com/NWS/) that merchants used to create and update products, update stock and prices and manage the order sales cycle. This legacy SOAP WebServices which spanned over 4 different versions is considered obsolete with the release of the RESTful Merchant API. Merchants connected to the SOAP WebServices are **strongly advised **to migrate over to the RESTful Merchant API, as it will be the only one maintained over time. # Am I concerned? You are only concerned by this section if you have an already live connection to Neteven using the Neteven SOAP WebServices and you need to migrate existing methods to the REST API. # What is still the same? While the entry point changes from SOAP WebServices to a RESTful API, the Neteven system behind remains the same: the content of products, orders, workflows etc. is unchanged. # What has changed? Not only interaction protocols have changed (from SOAP to HTTP) but also the way to authenticate, the structure of datatype of the message body (from XML to JSON) and the fields themselves, as well as the workflow logic behind the API. An important aspect of switching from SOAP to REST is how ressources, methods and endpoints are now separated. With the SOAP WebServices, only 4 different endpoints were available and they were used for different things. Furthermore, you will need a new specific set of credentials to use the Merchant API. Please refer to your Neteven point of contact to receive it. ### Content comparison: - Field names are more explicit and transparent as to what is visible in the UI and exports - Updating Items (Stock / Price) is relatively similar: the SKU is the main product identifier in both API's - Orders Lines are now properly regrouped under the 'parent' `order_id` - Marketplace names between SOAP Webservices and the REST API may slightly differ. We recommend using the field marketplace\_ID rather than the field marketplace\_name if your internal process varies depending on the marketplace. Below is an example to illustrate the difference of content between the SOAP Webservices and the REST API when retrieving a single Marketplace order object. :::::VerticalSplit{layout="middle"} ::::VerticalSplitItem **SOAP Webservices** :::CodeblockTabs GetOrders Response ```xml 1 1 9811700 7526358 9811700 Confirmed 13982125 19 SANDBOX_7501319_002 SANDBOX_7501319_3_002 sandbox SANDBOX_7501319_002 HPOLBICNOINOI-M 2014-09-24T15:18:16 2014-09-24T15:18:16 TestWS1-1-Order001-TrackingNumber-7526358 TestWS1-1-Order001-TrackingInfo-7526358 TestWS1-1-Order001-TrackingURL-7526358 77.69 Unknown 1 77.69 0.00 0.00 0.00 0.00 12.95 77.69 0.00 0.00 0.00 513 1 anonymized anonymized anonymized anonymized NESGO livraison 95500 livraison FR FRANCE livraison anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized NESGO 95500 FR FRANCE anonymized anonymized anonymized anonymized anonymized anonymized 9811701 7526358 9811701 toConfirm 13982125 19 SANDBOX_7501319_002 SANDBOX_7501319_2_002 sandbox SANDBOX_7501319_002 69023-AAM-GHTP 2014-09-24T15:18:16 2014-09-24T15:18:16 TestWS1-1-Order001-TrackingNumber-7526358 TestWS1-1-Order001-TrackingInfo-7526358 TestWS1-1-Order001-TrackingURL-7526358 2878.80 Unknown 3 2878.80 0.00 0.00 0.00 0.00 479.80 2878.80 0.00 0.00 0.00 0 anonymized anonymized anonymized anonymized NESGO livraison 95500 livraison FR FRANCE livraison anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized NESGO 95500 FR FRANCE anonymized anonymized anonymized anonymized anonymized anonymized 9811699 7526358 9811699 toConfirm 13982125 19 SANDBOX_7501319_002 SANDBOX_7501319_1_002 sandbox SANDBOX_7501319_002 HCAPLEONOI-TU 2014-09-24T15:18:16 2014-09-24T15:18:16 TestWS1-1-Order001-TrackingNumber-7526358 TestWS1-1-Order001-TrackingInfo-7526358 TestWS1-1-Order001-TrackingURL-7526358 190.31 Unknown 1 190.31 0.00 0.00 0.00 0.00 31.72 190.31 0.00 0.00 0.00 0 anonymized anonymized anonymized anonymized NESGO livraison 95500 livraison FR FRANCE livraison anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized anonymized NESGO 95500 FR FRANCE anonymized anonymized anonymized anonymized anonymized anonymized ``` ::: :::: ::::VerticalSplitItem **REST API** :::CodeblockTabs GET /merchant/orders/ ```json { "data": { "order": { "order_id": 7526358, "marketplace_order_id": "SANDBOX_7501319_002", "order_lines_count": 3, "date_creation": "2014-09-24T15:22:21", "date_sale": "2014-09-24T15:18:16", "date_payment": "2014-09-24T15:18:16", "prices": { "currency_id": "EUR", "total_price_including_taxes_excluding_shipping": 3146.80, "total_price_excluding_taxes_excluding_shipping": 2622.33 }, "shipping_information": { "carrier_name": "TestWS1-1-Order001-TrackingInfo-7526358", "tracking_url": "TestWS1-1-Order001-TrackingURL-7526358", "tracking_number": "TestWS1-1-Order001-TrackingNumber-7526358" }, "address_delivery": { "title": "anonymized", "first_name": "anonymized", "last_name": "anonymized", "street1": "anonymized", "street2": "anonymized", "city": "anonymized", "country_code": "FR", "country": "FRANCE", "postcode": "95500", "phone1": "secret", "phone2": "anonymized", "fax": "anonymized", "email": "anonymized", "login": "anonymized", "company_name1": "anonymized", "company_name2": "anonymized", "delivery_relay_name": "anonymized", "delivery_relay_contractlevel": "anonymized", "delivery_relay_id": "anonymized" }, "address_invoice": { "title": "anonymized", "first_name": "anonymized", "last_name": "anonymized", "street1": "anonymized", "street2": "anonymized", "city": "anonymized", "country_code": "FR", "country": "FRANCE", "postcode": "95500", "phone1": "secret", "phone2": "anonymized", "fax": "anonymized", "email": "anonymized", "login": "anonymized", "company_name1": "anonymized", "company_name2": "anonymized" }, "order_lines": [ { "order_line_id": 9811699, "marketplace_order_line_id": "SANDBOX_7501319_1_002", "status_current": "TO CONFIRM", "item": { "sku": "HCAPLEONOI-TU", "ean": "3606852811431", "marketplace_product_id": "SANDBOX_PRODUCT_3029_HCAPLEONOI-TU", "quantity": 1 }, "prices": { "currency_id": "EUR", "total_price_including_taxes_excluding_shipping": 190.31, "total_price_excluding_taxes_excluding_shipping": 158.59 } }, { "order_line_id": 9811700, "marketplace_order_line_id": "SANDBOX_7501319_3_002", "status_current": "TO SHIP", "item": { "sku": "HPOLBICNOINOI-M", "marketplace_product_id": "SANDBOX_PRODUCT_3029_HPOLBICNOINOI-M", "quantity": 1, "warehouse_name": "Aurel_warehouse" }, "prices": { "currency_id": "EUR", "total_price_including_taxes_excluding_shipping": 77.69, "total_price_excluding_taxes_excluding_shipping": 64.74 } }, { "order_line_id": 9811701, "marketplace_order_line_id": "SANDBOX_7501319_2_002", "status_current": "TO CONFIRM", "item": { "sku": "69023-AAM-GHTP", "ean": "3231760424042", "marketplace_product_id": "SANDBOX_PRODUCT_3029_69023-AAM-GHTP", "quantity": 3 }, "prices": { "currency_id": "EUR", "total_price_including_taxes_excluding_shipping": 2878.80, "total_price_excluding_taxes_excluding_shipping": 2399.00 } } ] } }, "metadata": { "number_of_results": 1, "api_version": 1, "api_version_expiration_date": "2022-12-31" } } ``` ::: :::: ::::: # Action mapping tables ### Authentication | **Action** | **SOAP WS method** | **REST API endpoint** | | ------------ | ------------------------------------------- | --------------------------------------------------- | | Authenticate | **Request body header:**
md5 signature | **POST**`/login`
time limited JWT Bearer token | ### Product, stock and prices | **Action** | **SOAP WS method** | **REST API endpoint** | | -------------------------------- | ------------------------------------------------------------ | --------------------------------------------- | | Create a new product | `PostItems` | **POST **`merchant/products/import-file` | | Update product content | `PostItems` | **POST **`merchant/products/import-file` | | Create a warehouse | *N/A* | **POST**`/merchant/warehouses` | | Retrieve the existing warehouses | *N/A* | **GET**`/merchant/warehouses` | | Retrieve product data | `GetItems`
Parse Response Body for relevant information | N/A | | Update Stock information | `PostItems` | **PATCH** `/merchant/items/stocks` | | Update Price information | `PostItems` | **PATCH** `/merchant/items/prices` | | Retrieve Stock information | `GetItems`
Parse Response Body for relevant information | **GET**`/merchant/items/stocks` | | Retrieve Price information | `GetItems`
Parse Response Body for relevant information | **GET**`/merchant/items/prices` | ### Order management | **Action** | **SOAP WS method** | **REST API endpoint** | | ------------------------------------ | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | Retrieve new orders | `GetOrders`
**Request Body fields:**
Custom filters | **GET**` /merchant/orders/new` | | Retrieve a specific order | `GetOrders`
**Request Body fields:**
OrderID | **GET**`/merchant/orders/{order-id}` | | Acknowledge order lines | `PostOrders` (WS1-3 +)
**Request Body fields: **OrderLineAck / MerchantOrderLineId | **PATCH** `/merchant/orders/{order-id}/lines/{order-line-id}/ack` | | Confirm order lines | `PostOrders`
**Request Body fields:**
**Status =** Confirmed | **PATCH** `/merchant/orders/{order-id}/lines/{order-line-id}/confirm` | | Cancel order lines | `PostOrders`
**Request Body fields:**
**Status =** Canceled | **PATCH** `/merchant/orders/{order-id}/lines/{order-line-id}/cancel` | | Ship order lines | `PostOrders`
**Request Body fields:**
**Status =** Shipped | **PATCH** `/merchant/orders/{order-id}/lines/{order-line-id}/ship` | | Refund order lines | `PostOrders`
**Request Body fields:**
**Status =** Refunded | **PATCH** `/merchant/orders/{order-id}/lines/{order-line-id}/refund` | | Check state of Status change request | *N/A* | **GET** `/merchant/orders/{order-id}/lines/{order-line-id}/status` |