cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/shipping_packages/sp_2b3c4d5e6f708192a3b4c5d6e7f8091a" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"shipping_package": {
"display_name": "Small box",
"description": "Up to 2 kg"
}
}'from exsited import build_client
client = build_client()
response = client.shipping_packages.update_settings_shipping_package(
"sp_2b3c4d5e6f708192a3b4c5d6e7f8091a",
{"shipping_package": {"display_name": "Small box", "description": "Up to 2 kg"}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.shippingPackages.updateSettingsShippingPackage('sp_2b3c4d5e6f708192a3b4c5d6e7f8091a', {
shipping_package: {display_name: 'Small box', description: 'Up to 2 kg'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->shippingPackages->updateSettingsShippingPackage(
'sp_2b3c4d5e6f708192a3b4c5d6e7f8091a',
['shipping_package' => ['display_name' => 'Small box', 'description' => 'Up to 2 kg']],
);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.shipping_packages.shipping_packages_dto.ShippingPackagesDto.SettingsShippingPackage;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsShippingPackage> response = client.shippingPackages().updateSettingsShippingPackage(
"sp_2b3c4d5e6f708192a3b4c5d6e7f8091a",
Map.of("shipping_package", Map.of("display_name", "Small box", "description", "Up to 2 kg")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.ShippingPackages.UpdateSettingsShippingPackageAsync(
"sp_2b3c4d5e6f708192a3b4c5d6e7f8091a",
new Dictionary<string, object?>
{
["shipping_package"] = new Dictionary<string, object?>
{
["display_name"] = "Small box",
["description"] = "Up to 2 kg",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.shippingPackages.updateSettingsShippingPackage(
'sp_2b3c4d5e6f708192a3b4c5d6e7f8091a',
{
'shipping_package': {
'display_name': 'Small box',
'description': 'Up to 2 kg',
},
},
);
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.ShippingPackages().UpdateSettingsShippingPackage(context.Background(), "sp_2b3c4d5e6f708192a3b4c5d6e7f8091a", map[string]any{
"shipping_package": map[string]any{
"display_name": "Small box",
"description": "Up to 2 kg",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"shipping_package": {
"created_by": "<unknown>",
"created_on": "<string>",
"cubic": "<unknown>",
"cubic_uom": "<unknown>",
"description": "<string>",
"display_name": "<string>",
"height": 123,
"height_uom": "<unknown>",
"href": "<string>",
"id": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"length": 123,
"length_uom": "<unknown>",
"name": "<string>",
"object": "<string>",
"status": "<string>",
"weight": 123,
"weight_uom": "<unknown>",
"width": 123,
"width_uom": "<unknown>"
}
}Shipping packages
Update a shipping package
Changes a shipping package and returns it.
PATCH
/
settings
/
shipping_packages
/
{shipping_package_id}
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/shipping_packages/sp_2b3c4d5e6f708192a3b4c5d6e7f8091a" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"shipping_package": {
"display_name": "Small box",
"description": "Up to 2 kg"
}
}'from exsited import build_client
client = build_client()
response = client.shipping_packages.update_settings_shipping_package(
"sp_2b3c4d5e6f708192a3b4c5d6e7f8091a",
{"shipping_package": {"display_name": "Small box", "description": "Up to 2 kg"}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.shippingPackages.updateSettingsShippingPackage('sp_2b3c4d5e6f708192a3b4c5d6e7f8091a', {
shipping_package: {display_name: 'Small box', description: 'Up to 2 kg'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->shippingPackages->updateSettingsShippingPackage(
'sp_2b3c4d5e6f708192a3b4c5d6e7f8091a',
['shipping_package' => ['display_name' => 'Small box', 'description' => 'Up to 2 kg']],
);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.shipping_packages.shipping_packages_dto.ShippingPackagesDto.SettingsShippingPackage;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsShippingPackage> response = client.shippingPackages().updateSettingsShippingPackage(
"sp_2b3c4d5e6f708192a3b4c5d6e7f8091a",
Map.of("shipping_package", Map.of("display_name", "Small box", "description", "Up to 2 kg")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.ShippingPackages.UpdateSettingsShippingPackageAsync(
"sp_2b3c4d5e6f708192a3b4c5d6e7f8091a",
new Dictionary<string, object?>
{
["shipping_package"] = new Dictionary<string, object?>
{
["display_name"] = "Small box",
["description"] = "Up to 2 kg",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.shippingPackages.updateSettingsShippingPackage(
'sp_2b3c4d5e6f708192a3b4c5d6e7f8091a',
{
'shipping_package': {
'display_name': 'Small box',
'description': 'Up to 2 kg',
},
},
);
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.ShippingPackages().UpdateSettingsShippingPackage(context.Background(), "sp_2b3c4d5e6f708192a3b4c5d6e7f8091a", map[string]any{
"shipping_package": map[string]any{
"display_name": "Small box",
"description": "Up to 2 kg",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"shipping_package": {
"created_by": "<unknown>",
"created_on": "<string>",
"cubic": "<unknown>",
"cubic_uom": "<unknown>",
"description": "<string>",
"display_name": "<string>",
"height": 123,
"height_uom": "<unknown>",
"href": "<string>",
"id": "<string>",
"last_updated_by": "<unknown>",
"last_updated_on": "<string>",
"length": 123,
"length_uom": "<unknown>",
"name": "<string>",
"object": "<string>",
"status": "<string>",
"weight": 123,
"weight_uom": "<unknown>",
"width": 123,
"width_uom": "<unknown>"
}
}Send the changes under
shipping_package, such as a new display_name, description or dimension.
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
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The shipping package's id, from the listing.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The updated shipping package, under shipping_package.
Show child attributes
Show child attributes