/
Extend WMS API Integration Guide

Extend WMS API Integration Guide

Use the Extend WMS REST API to read and manage data in a specific Extend WMS client environment. The detailed API documentation is available in Scalar: Scalar API documentation. Use this Confluence page as a high-level guide for connection, authentication, and common integration considerations rather than duplicating all technical endpoint details.

The API base URL is client-specific. For example, one environment may use https://demoews.lxir.se/, but your own URL can be different. The client identifier is also dynamic and must be supplied for your tenant.

API access credentials are provided by Extend Support at http://support.extend.se. Username and password are connected to a licensed service.

Scalar API documentation: Detailed endpoint definitions, request/response schemas, and examples are maintained in Scalar. Refer to Scalar for technical endpoint details; this Confluence page focuses on overview, access, and usage guidance.

Connection overview

All requests follow the same base pattern:

{{URL}}/v1/{{CLIENT}}/...

The integration requires four values:

  • URL — the base URL for your Extend WMS environment

  • CLIENT — your client or tenant identifier

  • USERNAME — the API username provided by Extend Support

  • PASSWORD — the API password provided by Extend Support

Setting

Description

Setting

Description

URL

Base address to your Extend WMS environment, for example https://demoews.lxir.se

CLIENT

The tenant/client path value used in requests under /v1/{client}/...

USERNAME

Credential used for HTTP Basic Authentication

PASSWORD

Password paired with the username for HTTP Basic Authentication

Authentication

Extend WMS uses HTTP Basic Authentication in the provided API collection. Each request is authenticated with the supplied username and password.

If you are testing with Postman or another API client, store credentials as environment variables rather than hardcoding them in individual requests.

Example authorization model:

Authorization: Basic <base64(username:password)>

If authentication fails, the API can return 401 Unauthorized. The first thing to verify is that the username, password, URL, and client value all belong to the same licensed environment.

Base request structure

Current product-related endpoints use the following resource structure:

  • GET {{URL}}/v1/{{CLIENT}}/Products/

  • GET {{URL}}/v1/{{CLIENT}}/Products/{productNumber}

  • POST {{URL}}/v1/{{CLIENT}}/Products

  • PUT {{URL}}/v1/{{CLIENT}}/Products/{productNumber}

  • DELETE {{URL}}/v1/{{CLIENT}}/Products/{productNumber}

The examples in the collection use TEST5628 as a sample product number. Replace this with a real product number from your own environment when testing.

Getting started

  1. Request API access from Extend Support and confirm that licensing is enabled for your environment.

  2. Collect the four required values: URL, CLIENT, USERNAME, and PASSWORD.

  3. Configure your API tool or integration platform to use HTTP Basic Authentication.

  4. Test connectivity with a read operation such as GET /v1/{client}/Products/.

  5. After successful authentication, continue with create, update, and delete operations as needed.

API endpoints

Example integration pattern

A typical integration flow looks like this:

  1. Authenticate using the licensed username and password.

  2. Read existing products to validate connectivity and data shape.

  3. Create new products when they do not yet exist in Extend WMS.

  4. Update products when source data changes.

  5. Delete products only when the business process explicitly requires removal.

Best practice: start with non-destructive operations such as GET before enabling POST, PUT, or DELETE in production integrations.

Implementation notes

  • Environment-specific values: never hardcode demo URLs or client values across customers.

  • Credential handling: store credentials securely in a secrets manager, integration platform, or protected environment configuration.

  • Content type: use application/json for create and update requests.

  • Product numbers: make sure the identifier used in the path and payload is consistent.

  • Testing: validate against a non-production environment before connecting live business flows.

Troubleshooting

Issue

What to check

Issue

What to check

401 Unauthorized

Verify username and password, and confirm the credentials belong to the same URL and client environment

No data returned

Check that the client identifier is correct and that the environment contains product records

Update does not affect expected product

Confirm the product number in the URL matches the product number in the JSON body

Create or update fails

Validate JSON structure, required fields, and use of Content-Type: application/json

FAQ

Contact Extend Support through support.extend.se. API credentials are provided as part of a licensed setup.

No. The URL is environment-specific. One customer may use a demo or customer-specific domain, while another uses a different base URL.

Yes. The current API structure in the provided collection includes the client identifier as part of the request path under /v1/{client}/....

The provided API collection uses HTTP Basic Authentication with a username and password.

References