Register: creates or replaces a single register on the merchant.

POST /api/merchants/{id}/registers deprecated

Requires: Merchants.Merchants.Update, merchant scope.

Example: `POST /api/merchants/3fa85f64-5717-4562-b3fc-2c963f66afa6/registers` with body ``` { "friendlyId": "LANE1", "name": "Front lane", "enabled": true } ``` Every other register and merchant setting is left untouched. A validation failure is reported under an indexed member name (`Registers[0].friendlyId`), matching the full-document save. POST rather than PUT, deliberately: the path names the collection, and `PUT` there reads as "replace the collection", which is the one thing this endpoint promises not to do. It shares the path with the existing `GET /api/merchants/{id}/registers` list read.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a MerchantRegisterDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/merchants/{id}/registers" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "friendlyId": ""
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "friendlyId": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/merchants/{id}/registers' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MerchantsApi } from '@winkpg/winkpg-api';

const api = new MerchantsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.registersSaveRegister("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "friendlyId": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/registers', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "friendlyId": ""
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MerchantsApi(config);
var body = JsonSerializer.Deserialize<MerchantRegisterDto>("""
    {
      "friendlyId": ""
    }
    """);

var result = await api.RegistersSaveRegisterAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/merchants/{id}/registers");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "friendlyId": ""
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MerchantsApi(client)
    body = winkpg_api.MerchantRegisterDto.from_dict({
      "friendlyId": ""
    })
    result = api.registers_save_register("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "friendlyId": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/merchants/{id}/registers",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The merchant id.
`If-Match` required	header	string	The merchant's concurrency stamp, read from the `If-Match` header. When supplied and stale the write is rejected with 409; when omitted, no concurrency check is performed.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`id` required	string (uuid)
`friendlyId` required	string	A user-friendly identifier for this register. Required. nullablemin length 3max length 20
`name` required	string	A unique name for this register. Optional. nullable
`description` required	string	A brief description of this register and/or its purpose. Optional. nullablemax length 40
`enabled` required	boolean
`terminal1` required	RegisterTerminal	A terminal slot on a `MerchantRegister`.
`terminal2` required	RegisterTerminal	A terminal slot on a `MerchantRegister`.
`terminal3` required	RegisterTerminal	A terminal slot on a `MerchantRegister`.
`terminal4` required	RegisterTerminal	A terminal slot on a `MerchantRegister`.
`terminal5` required	RegisterTerminal	A terminal slot on a `MerchantRegister`.
`legacyNumber` required	integer (int64)	The integer key the v1 API addresses this register by (its `RegisterKey`). Server-owned: allocated once, when the register is first saved, and never reassigned. nullable

This request body has no documented fields.