Retrieve a shipping rule

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/shipping_rules/sr_7f8091a2b3c4d5e6f708192a3b4c5d6e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.shippingRules.getSettingsShippingRule('sr_7f8091a2b3c4d5e6f708192a3b4c5d6e');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->shippingRules->getSettingsShippingRule('sr_7f8091a2b3c4d5e6f708192a3b4c5d6e');
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;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsShippingRule> response = client.shippingRules().getSettingsShippingRule(
        "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ShippingRules.GetSettingsShippingRuleAsync("sr_7f8091a2b3c4d5e6f708192a3b4c5d6e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.shippingRules.getSettingsShippingRule(
  'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e',
);
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().GetSettingsShippingRule(context.Background(), "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", 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
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

settings

shipping_rules

{shipping_rule_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/shipping_rules/sr_7f8091a2b3c4d5e6f708192a3b4c5d6e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.shippingRules.getSettingsShippingRule('sr_7f8091a2b3c4d5e6f708192a3b4c5d6e');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->shippingRules->getSettingsShippingRule('sr_7f8091a2b3c4d5e6f708192a3b4c5d6e');
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;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsShippingRule> response = client.shippingRules().getSettingsShippingRule(
        "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ShippingRules.GetSettingsShippingRuleAsync("sr_7f8091a2b3c4d5e6f708192a3b4c5d6e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.shippingRules.getSettingsShippingRule(
  'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e',
);
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().GetSettingsShippingRule(context.Background(), "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", 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
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Returns the rule under shipping_rule, with its name, description, status, version and configuration.

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.

Path Parameters

shipping_rule_id

string

required

The shipping rule's id, from the listing.

Response

The shipping rule, under shipping_rule.

shipping_rule

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response