REST API / JSON

Commerce data.
Clearly connected.

NetSeller makes key store data available through defined resources. Each API client gets the permissions, stores and context needed for its task.

Open the API reference

NetSeller API200 OK

GET/api/v1/products

shopId=1language=encurrency=CHF

{
  "data": [{
    "id": 1042,
    "sku": "AB-FJ-01",
    "name": "Pine green fleece jacket",
    "hasVariants": true,
    "availability": { "status": "in_stock" },
    "price": { "amount": "129.00", "currency": "CHF" }
  }],
  "errors": []
}

RESTdefined endpoints
JSONstructured responses
14permission scopes
CHstore context

Configured API clients in NetSeller with German interface labels — API clientsPermissions · stores · keys

01 / Access

One client.
Defined permissions.

Each integration gets its own API client. Its status, permissions, store assignments and key metadata stay visible in one place.

Activate or deactivate clients individually
Limit access to selected stores
Revoke keys and review their use

02 / Resources

What the API connects.

The versioned API provides read and write endpoints for catalogue, inventory, checkout, orders, customers, marketing, settings and webhooks.

Catalogue

Exchange products, variants, categories, media, prices and relationships.

catalog:read · catalog:write

Inventory & checkout

Manage stock, baskets and checkout flows on the server side.

inventory:read · inventory:write · checkout:write

Orders

Work with orders, statuses, documents, refunds and shipments.

orders:read · orders:write

Customers & companies

Maintain profiles, addresses, companies, members and store assignments.

customers:read · customers:write

Marketing & stores

Connect coupons, gift cards, promotions and public store settings.

marketing:read · marketing:write · settings:read

Webhooks & API contract

Deliver signed events and find every operation in the OpenAPI contract.

webhooks:read · webhooks:write

03 / Commerce context

Data for the right store.

Request products and prices for a specific store, language, currency and price list. This keeps integrations unambiguous across multiple stores.

GET /products?shopId=1language=encurrency=CHFpriceListId=2

01API client
02Store
03Language
04Currency
05Price list
✓matching data

04 / Security

Only the access required.

An API client can access only its assigned scopes and stores. Authentication uses bearer keys whose values are shown only when they are created.

catalog:readcatalog:writeinventory:readinventory:writeorders:readorders:writecustomers:readcustomers:writemarketing:readmarketing:writecheckout:writesettings:readwebhooks:readwebhooks:write

API client with assigned permissions and demo stores in the German interface — Permissions14 scopes · 2 stores

05 / Example

One request.
A clear response.

Send API requests to the relevant NetSeller installation. api.netseller.net provides the reference only. Keep the real key in the connected application’s protected configuration.

curl "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF",
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);
const payload = await response.json();

<?php
$client = curl_init(
  "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF"
);
curl_setopt_array($client, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Authorization: Bearer YOUR_API_KEY"]
]);
$payload = json_decode(curl_exec($client), true);

import requests

response = requests.get(
    "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
payload = response.json()

import java.net.URI;
import java.net.http.*;

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF"))
  .header("Authorization", "Bearer YOUR_API_KEY")
  .build();
var response = HttpClient.newHttpClient()
  .send(request, HttpResponse.BodyHandlers.ofString());

using System.Net.Http.Headers;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
  new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var payload = await client.GetStringAsync(
  "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF"
);

cfhttp(
  url = "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF",
  method = "get",
  result = "apiResponse"
) {
  cfhttpparam(
    type = "header",
    name = "Authorization",
    value = "Bearer YOUR_API_KEY"
  );
}

payload = deserializeJSON(apiResponse.fileContent);

request, _ := http.NewRequest(
  http.MethodGet,
  "https://shop.example.com/api/v1/products?shopId=1&language=en&currency=CHF",
  nil,
)
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := http.DefaultClient.Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()

200 OK{ "data": [ ... ], "meta": { ... }, "errors": [] }

06 / Architecture

Controlled access to commerce data.

The API provides a versioned contract between NetSeller and connected systems. Its public reference describes available operations, inputs, responses and errors from the live OpenAPI specification.

Full API reference

Keep exploring

Commerce data.Clearly connected.

One client.Defined permissions.