Update a warehouse

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/warehouses/1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "warehouse": {
      "description": "Main warehouse for New South Wales"
    }
  }'

from exsited import build_client

client = build_client()

response = client.settings.update_settings_warehouse(
    "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {"warehouse": {"description": "Main warehouse for New South Wales"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.updateSettingsWarehouse('1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    warehouse: {description: 'Main warehouse for New South Wales'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->settings->updateSettingsWarehouse('1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'warehouse' => ['description' => 'Main warehouse for New South Wales'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsWarehouseRead;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsWarehouseRead> response = client.settings().updateSettingsWarehouse(
        "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of("warehouse", Map.of("description", "Main warehouse for New South Wales")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.UpdateSettingsWarehouseAsync(
    "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["warehouse"] = new Dictionary<string, object?>
        {
            ["description"] = "Main warehouse for New South Wales",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.settings.updateSettingsWarehouse(
  '1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'warehouse': {'description': 'Main warehouse for New South Wales'},
  },
);
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.Settings().UpdateSettingsWarehouse(context.Background(), "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"warehouse": map[string]any{
		"description": "Main warehouse for New South Wales",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "warehouse": {
    "city": "<string>",
    "country": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "is_default": true,
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "post_code": "<string>",
    "state": "<string>",
    "status": "<string>",
    "version": 123
  }
}

PATCH

settings

warehouses

{warehouse_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/warehouses/1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "warehouse": {
      "description": "Main warehouse for New South Wales"
    }
  }'

from exsited import build_client

client = build_client()

response = client.settings.update_settings_warehouse(
    "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {"warehouse": {"description": "Main warehouse for New South Wales"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.updateSettingsWarehouse('1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    warehouse: {description: 'Main warehouse for New South Wales'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->settings->updateSettingsWarehouse('1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'warehouse' => ['description' => 'Main warehouse for New South Wales'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsWarehouseRead;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsWarehouseRead> response = client.settings().updateSettingsWarehouse(
        "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of("warehouse", Map.of("description", "Main warehouse for New South Wales")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.UpdateSettingsWarehouseAsync(
    "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["warehouse"] = new Dictionary<string, object?>
        {
            ["description"] = "Main warehouse for New South Wales",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.settings.updateSettingsWarehouse(
  '1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'warehouse': {'description': 'Main warehouse for New South Wales'},
  },
);
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.Settings().UpdateSettingsWarehouse(context.Background(), "1f1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"warehouse": map[string]any{
		"description": "Main warehouse for New South Wales",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "warehouse": {
    "city": "<string>",
    "country": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "is_default": true,
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "post_code": "<string>",
    "state": "<string>",
    "status": "<string>",
    "version": 123
  }
}

Send the fields to change under warehouse, such as description. The response’s country reads null although the record has one.

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. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

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

Path Parameters

warehouse_id

string

required

The warehouse's id, as a listing or a create returns it.

Body

application/json

warehouse

object

required

Show child attributes

Response

200 - application/json

The updated warehouse, under warehouse.

warehouse

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response