List fulfillment profiles

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/fulfillment_profiles?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.fulfillment_profiles.fulfillment_profiles_dto.FulfillmentProfilesDto.SettingsFulfillmentProfileList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsFulfillmentProfileList> response = client.fulfillmentProfiles().getSettingsFulfillmentProfiles(
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.FulfillmentProfiles.GetSettingsFulfillmentProfilesAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.fulfillmentProfiles
    .getSettingsFulfillmentProfiles(queryParams: {'limit': 20});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.FulfillmentProfiles().GetSettingsFulfillmentProfiles(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

GET

settings

fulfillment_profiles

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/fulfillment_profiles?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.fulfillment_profiles.fulfillment_profiles_dto.FulfillmentProfilesDto.SettingsFulfillmentProfileList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsFulfillmentProfileList> response = client.fulfillmentProfiles().getSettingsFulfillmentProfiles(
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.FulfillmentProfiles.GetSettingsFulfillmentProfilesAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.fulfillmentProfiles
    .getSettingsFulfillmentProfiles(queryParams: {'limit': 20});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.FulfillmentProfiles().GetSettingsFulfillmentProfiles(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Returns profiles under data, each with its name, display_name, description, status and version. Set the page size with limit and fetch the next page with cursor. Other fields filter as filter_<field>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit

integer

How many records to return on one page.

Example:

20

cursor

string

The next_cursor from the previous page, to fetch the page after it.

sort

string

The field to sort by. Prefix it with - to sort descending, as in -created_on.

Example:

"-created_on"

Response

200 - application/json

A page of fulfillment profiles, under data.

data

object[]

Show child attributes

object

string

pagination

object

Show child attributes

url

string

Guides

API reference

Authorizations

Query Parameters

Response