Update a shipping rule

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/shipping_rules/sr_7f8091a2b3c4d5e6f708192a3b4c5d6e" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "shipping_rule": {
      "name": "Standard shipping",
      "description": "Flat rate within Australia"
    }
  }'

from exsited import build_client

client = build_client()

response = client.shipping_rules.update_settings_shipping_rule(
    "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e",
    {
        "shipping_rule": {
            "name": "Standard shipping",
            "description": "Flat rate within Australia",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.shippingRules.updateSettingsShippingRule('sr_7f8091a2b3c4d5e6f708192a3b4c5d6e', {
    shipping_rule: {name: 'Standard shipping', description: 'Flat rate within Australia'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->shippingRules->updateSettingsShippingRule(
    'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e',
    [
        'shipping_rule' => [
            'name' => 'Standard shipping',
            'description' => 'Flat rate within Australia',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.shipping_rules.shipping_rules_dto.ShippingRulesDto.SettingsShippingRule;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsShippingRule> response = client.shippingRules().updateSettingsShippingRule(
        "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e",
        Map.of(
                "shipping_rule", Map.of(
                        "name", "Standard shipping",
                        "description", "Flat rate within Australia")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ShippingRules.UpdateSettingsShippingRuleAsync(
    "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e",
    new Dictionary<string, object?>
    {
        ["shipping_rule"] = new Dictionary<string, object?>
        {
            ["name"] = "Standard shipping",
            ["description"] = "Flat rate within Australia",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.shippingRules.updateSettingsShippingRule(
  'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e',
  {
    'shipping_rule': {
      'name': 'Standard shipping',
      'description': 'Flat rate within Australia',
    },
  },
);
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.ShippingRules().UpdateSettingsShippingRule(context.Background(), "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", map[string]any{
	"shipping_rule": map[string]any{
		"name":        "Standard shipping",
		"description": "Flat rate within Australia",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "shipping_rule": {
    "configuration": {
      "rate": "<unknown>",
      "zones": "<array>"
    },
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "shipping_class": "<unknown>",
    "status": "<string>",
    "version": 123
  }
}

PATCH

settings

shipping_rules

{shipping_rule_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/shipping_rules/sr_7f8091a2b3c4d5e6f708192a3b4c5d6e" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "shipping_rule": {
      "name": "Standard shipping",
      "description": "Flat rate within Australia"
    }
  }'

from exsited import build_client

client = build_client()

response = client.shipping_rules.update_settings_shipping_rule(
    "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e",
    {
        "shipping_rule": {
            "name": "Standard shipping",
            "description": "Flat rate within Australia",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.shippingRules.updateSettingsShippingRule('sr_7f8091a2b3c4d5e6f708192a3b4c5d6e', {
    shipping_rule: {name: 'Standard shipping', description: 'Flat rate within Australia'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->shippingRules->updateSettingsShippingRule(
    'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e',
    [
        'shipping_rule' => [
            'name' => 'Standard shipping',
            'description' => 'Flat rate within Australia',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.shipping_rules.shipping_rules_dto.ShippingRulesDto.SettingsShippingRule;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsShippingRule> response = client.shippingRules().updateSettingsShippingRule(
        "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e",
        Map.of(
                "shipping_rule", Map.of(
                        "name", "Standard shipping",
                        "description", "Flat rate within Australia")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ShippingRules.UpdateSettingsShippingRuleAsync(
    "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e",
    new Dictionary<string, object?>
    {
        ["shipping_rule"] = new Dictionary<string, object?>
        {
            ["name"] = "Standard shipping",
            ["description"] = "Flat rate within Australia",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.shippingRules.updateSettingsShippingRule(
  'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e',
  {
    'shipping_rule': {
      'name': 'Standard shipping',
      'description': 'Flat rate within Australia',
    },
  },
);
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.ShippingRules().UpdateSettingsShippingRule(context.Background(), "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", map[string]any{
	"shipping_rule": map[string]any{
		"name":        "Standard shipping",
		"description": "Flat rate within Australia",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "shipping_rule": {
    "configuration": {
      "rate": "<unknown>",
      "zones": "<array>"
    },
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "shipping_class": "<unknown>",
    "status": "<string>",
    "version": 123
  }
}

Send the changes under shipping_rule, such as a new name or description.

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

shipping_rule_id

string

required

The shipping rule's id, from the listing.

Body

application/json

shipping_rule

object

required

Show child attributes

Response

200 - application/json

The updated shipping rule, under shipping_rule.

shipping_rule

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response