Parcel presets: creates a preset. A merchant's first preset becomes its default.

POST /api/shipping/parcel-presets deprecated

Requires: Shipping.ParcelPresets, Shipping.ParcelPresets.Create, merchant scope.

**Required permissions**: `Shipping.ParcelPresets`, `Shipping.ParcelPresets.Create` **Scope**: merchant

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 ParcelPresetCreateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/shipping/parcel-presets" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": ""
}'

PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/shipping/parcel-presets' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/shipping/parcel-presets', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": ""
  }),
});

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 ShippingApi(config);
var body = JsonSerializer.Deserialize<ParcelPresetCreateDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    }
    """);

var result = await api.ParcelPresetCreateAsync(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/shipping/parcel-presets");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    }
    """, 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.ShippingApi(client)
    body = winkpg_api.ParcelPresetCreateDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": ""
    })
    result = api.parcel_preset_create(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/shipping/parcel-presets",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`merchantId` required	string (uuid)	The merchant that owns this preset. Required on create, and immutable afterwards: an update that names a different merchant is refused rather than silently moving the preset. nullable
`name` required	string	Operator-facing name of the box, for example "Small box". nullablemax length 128
`weight` required	number (double)	The packed weight of a parcel shipped in this box, in `weightUnit`. Positive. min 0max 100000
`weightUnit` required	all of ShippingWeightUnit	The unit `weight` is expressed in.
`length` required	number (double)	The longest outer dimension, in `dimensionUnit`. Positive. min 0max 10000
`width` required	number (double)	The second outer dimension, in `dimensionUnit`. Positive. min 0max 10000
`height` required	number (double)	The third outer dimension, in `dimensionUnit`. Positive. min 0max 10000
`dimensionUnit` required	all of ShippingDimensionUnit	The unit the three dimensions are expressed in.
`isDefault` required	boolean	Whether this is the merchant's default preset. A merchant's first preset is the default whatever this says; setting it on another preset moves the flag there. It cannot be switched off on the current default while the merchant has other presets.

This request body has no documented fields.