Ship-from origins: retrieves a continuation-token paged list of origins.

GET /api/shipping/origins/continuation deprecated

Requires: Shipping.Origins, merchant scope.

**Required permissions**: `Shipping.Origins` **Scope**: merchant

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/shipping/origins/continuation" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/shipping/origins/continuation' `
    -Headers $headers

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.shippingOriginGetContinuationList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/shipping/origins/continuation', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

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

var api = new ShippingApi(config);
var result = await api.ShippingOriginGetContinuationListAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/shipping/origins/continuation");
request.Headers.Add("api-key", "{{API_KEY}}");

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)
    result = api.shipping_origin_get_continuation_list()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

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

Parameters

Name	In	Type	Description
`MerchantId` required	query	string (uuid)
`IsDefault` required	query	boolean
`Name` required	query	string
`Ids` required	query	array of string (uuid)
`Filter.Logic` required	query	FilterLogic
`Filter.Rules` required	query	array of FilterRule
`Filter.Groups` required	query	array of FilterGroup
`MaxResultCount` required	query	integer (int32)
`ContinuationToken` required	query	string
`Sorting.Field` required	query	string
`Sorting.Descending` required	query	boolean
`MaxCreationTime` required	query	string (date-time)	Upper bound on creation time.
`MinCreationTime` required	query	string (date-time)	Lower bound on creation time.
`MaxModificationTime` required	query	string (date-time)	Upper bound on last-modification time.
`MaxModifitionTime` required	query	string (date-time)	Deprecated misspelled alias of `maxModificationTime`. Deprecated misspelling kept for compatibility. Use MinModificationTime or MaxModificationTime instead. When a request sends both spellings of the same bound, the correctly spelled parameter is used and this one is ignored.
`MinModificationTime` required	query	string (date-time)	Lower bound on last-modification time.
`MinModifitionTime` required	query	string (date-time)	Deprecated misspelled alias of `minModificationTime`. Deprecated misspelling kept for compatibility. Use MinModificationTime or MaxModificationTime instead. When a request sends both spellings of the same bound, the correctly spelled parameter is used and this one is ignored.
`IncludeDeleted` required	query	boolean
`IncludeInactive` required	query	boolean
`IncludeApproxTotalCount` required	query	boolean	Set to false to skip the approximate total count and receive a null count; omit it or set it to true to receive the count as before.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.