Ship-from origins: updates an origin by id.

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

cURL PowerShell TypeScript C# Python

cURL

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

PowerShell

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

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

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/shipping/origins/{id}' `
    -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.shippingOriginUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "",
  "address": {}
});

TypeScript (raw HTTP)

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

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<ShippingOriginUpdateDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "",
      "address": {}
    }
    """);

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

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "",
      "address": {}
    }
    """, 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.ShippingOriginUpdateDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "",
      "address": {}
    })
    result = api.shipping_origin_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", 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": "",
  "address": {}
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/shipping/origins/{id}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

id required

path

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

merchantId required

string (uuid)

The merchant that owns this origin. Required on create, and immutable afterwards: an update that names a different merchant is refused rather than silently moving the origin. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Operator-facing name of the location, for example "Main warehouse". nullablemax length 128

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

address required

Address Address

The ship-from address. Required: an origin with no address is not somewhere a parcel can ship from. US addresses carry State and Zip; every other country carries Province and Postal Code.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of Address:

Field Type Description

id required

string (uuid)

Gets the unique identifier for the address. read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

address1 required

string

Gets or sets the first line of the address (e.g., street address). nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

address2 required

string

Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

city required

string

Gets or sets the city of the address. nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

state required

string

Gets or sets the state or region of the address. nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

province required

string

Gets or sets the province of the address (if applicable). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

zip required

string

Gets or sets the US ZIP code of the address (for example 12345 or 12345-6789). Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postalCode required

string

Gets or sets the international postal code of the address, for a country other than the US. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

country required

string

Gets or sets the country of the address. Defaults to "USA". nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isMailing required

boolean

Gets or sets a value indicating whether this address is a mailing address.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDefault required

boolean

Gets or sets a value indicating whether this address is the default address.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

phone required

string

An optional contact number for the location, which some carriers ask for when quoting. nullablemax length 32

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDefault required

boolean

Whether this is the merchant's default origin. A merchant's first origin is the default whatever this says; setting it on another origin moves the flag there. It cannot be switched off on the current default while the merchant has other origins.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

OK

Body: ShippingOriginDto ShippingOriginDto Each item has these fields.

Field Type Description

extraProperties required

object

nullableread only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDeleted required

boolean

Indicates whether this entity has been deleted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deleterId required

string (uuid)

The ID of the user who deleted this entity, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deletionTime required

string (date-time)

The date and time when this entity was deleted, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

The merchant that owns this origin.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Operator-facing name of the location. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

address required

Address Address

The ship-from address.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of Address:

Field Type Description

id required

string (uuid)

Gets the unique identifier for the address. read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

address1 required

string

Gets or sets the first line of the address (e.g., street address). nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

address2 required

string

Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

city required

string

Gets or sets the city of the address. nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

state required

string

Gets or sets the state or region of the address. nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

province required

string

Gets or sets the province of the address (if applicable). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

zip required

string

Gets or sets the US ZIP code of the address (for example 12345 or 12345-6789). Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postalCode required

string

Gets or sets the international postal code of the address, for a country other than the US. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

country required

string

Gets or sets the country of the address. Defaults to "USA". nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isMailing required

boolean

Gets or sets a value indicating whether this address is a mailing address.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDefault required

boolean

Gets or sets a value indicating whether this address is the default address.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

addressSummary required

string

The address on one line, for a grid or a picker: street, city, region and postal code, with the country when it is not the US. Derived at read time from `address`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

phone required

string

An optional contact number for the location. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDefault required

boolean

Whether this is the merchant's default origin.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

Optimistic concurrency token. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 409 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
409 Conflict Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Shipping

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Ship-from origins: updates an origin by id.

Example request

Parameters

Request body

Responses

Errors

Authentication