> ## Documentation Index > Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Set a shipping rule's configuration > Sets the zones and rate of a shipping rule and returns the rule. Send the configuration under `configuration`: `zones` lists each zone by its UUID with dashes in `zone`, and `rate` gives the rate's `name`, `method` such as `FLAT_RATE`, `handling_cost` and `shipping_cost`. > [!NOTE] > > The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). 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](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload. ## OpenAPI ````yaml POST /settings/shipping_rules/{shipping_rule_id}/configuration openapi: 3.1.0 info: title: Exsited API version: v4 servers: - url: https://{host}/api/v4 variables: host: default: your-api-host.example.com description: Your Exsited API host name, without https://. security: - bearerAuth: [] tags: - name: Authentication - name: Accounts - name: Account emails - name: Account groups - name: Communications - name: Communication profiles - name: Orders - name: Quote orders - name: Express - name: Usages - name: Sales reps - name: Gift certificates - name: Invoices - name: Pro-forma invoices - name: Payments - name: Refunds - name: Credit notes - name: Credit note applications - name: Reconciliations - name: Items - name: Inventory adjustments - name: Units of measurement - name: Zones - name: Shipping packages - name: Shipping rules - name: Fulfillment profiles - name: Fulfillment terms - name: Item fulfillments - name: Item receipts - name: Bookings - name: Rental assets - name: Return merchandise authorisations - name: Purchase orders - name: Purchase invoices - name: Purchase payments - name: Purchase refunds - name: Purchase credit notes - name: Purchase credit note applications - name: Purchase express - name: Return vendor authorizations - name: ABA files - name: Receive terms - name: Labours - name: Tasks - name: Timesheets - name: Milestones - name: Employees - name: Departments - name: Designations - name: Teams - name: Time periods - name: Workflows - name: Workflow settings - name: Events - name: Custom events - name: System events - name: Approvals - name: Approval profiles - name: Approval user groups - name: Alerts - name: Alert responsibility settings - name: Alert responsibilities - name: Action scripts - name: Note groups - name: Note attachments - name: Instance settings - name: Accounting codes - name: Additional codes - name: Billing periods - name: Charging periods - name: Pricing periods - name: Invoice terms - name: Days of the month - name: Countries - name: Salutations - name: Document templates - name: Email templates - name: Roles - name: Operators - name: Operator groups - name: User settings - name: Custom attributes - name: Custom components - name: Custom features - name: Custom fields - name: Custom forms - name: Attribute attachments - name: Portal - name: Integration connections - name: External databases - name: Reports - name: Applications - name: Organisation - name: Child organisations - name: Webhooks paths: /settings/shipping_rules/{shipping_rule_id}/configuration: post: tags: - Shipping rules summary: Set a shipping rule's configuration description: >- Send the configuration under `configuration`: `zones` lists each zone by its UUID with dashes in `zone`, and `rate` gives the rate's `name`, `method` such as `FLAT_RATE`, `handling_cost` and `shipping_cost`. operationId: shipping_rules_create_settings_shipping_rule_configuration parameters: - name: shipping_rule_id in: path required: true description: The shipping rule's `id`, from the listing. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: configuration: type: object properties: zones: type: array items: type: object properties: zone: type: string description: The zone's UUID with dashes, not its `zn_` id. required: - zone rate: type: object properties: name: type: string method: type: string description: Such as `FLAT_RATE`. handling_cost: type: number shipping_cost: type: number required: - configuration example: configuration: zones: - zone: 0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9 rate: name: Flat rate method: FLAT_RATE handling_cost: 1 shipping_cost: 5 responses: '201': description: The shipping rule with its configuration, under `shipping_rule`. content: application/json: schema: $ref: '#/components/schemas/ShippingRuleResponse' '400': description: >- A zone is given by its `zn_` id or as its 32 hex digits alone: `zone not found`. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: bash label: cURL source: >- curl -X POST "$EXSITED_BASE_URL/api/v4/settings/shipping_rules/sr_7f8091a2b3c4d5e6f708192a3b4c5d6e/configuration" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "configuration": { "zones": [ { "zone": "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9" } ], "rate": { "name": "Flat rate", "method": "FLAT_RATE", "handling_cost": 1, "shipping_cost": 5 } } }' - lang: python label: Python source: > from exsited import build_client client = build_client() response = client.shipping_rules.create_settings_shipping_rule_configuration( "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", { "configuration": { "zones": [{"zone": "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9"}], "rate": { "name": "Flat rate", "method": "FLAT_RATE", "handling_cost": 1, "shipping_cost": 5, }, } }, ) print(response.data) - lang: javascript label: JavaScript source: > import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.shippingRules.createSettingsShippingRuleConfiguration( 'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e', { configuration: { zones: [{zone: '0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9'}], rate: {name: 'Flat rate', method: 'FLAT_RATE', handling_cost: 1, shipping_cost: 5}, }, }, ); console.log(response.data); - lang: php label: PHP source: > use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->shippingRules->createSettingsShippingRuleConfiguration( 'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e', [ 'configuration' => [ 'zones' => [['zone' => '0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9']], 'rate' => [ 'name' => 'Flat rate', 'method' => 'FLAT_RATE', 'handling_cost' => 1, 'shipping_cost' => 5, ], ], ], ); print_r($response->data); - lang: java label: Java source: > 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.List; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.shippingRules().createSettingsShippingRuleConfiguration( "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", Map.of( "configuration", Map.of( "zones", List.of(Map.of("zone", "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9")), "rate", Map.of( "name", "Flat rate", "method", "FLAT_RATE", "handling_cost", 1, "shipping_cost", 5)))); System.out.println(response.getMap()); - lang: csharp label: .NET source: > using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.ShippingRules.CreateSettingsShippingRuleConfigurationAsync( "sr_7f8091a2b3c4d5e6f708192a3b4c5d6e", new Dictionary { ["configuration"] = new Dictionary { ["zones"] = new List { new Dictionary { ["zone"] = "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9", }, }, ["rate"] = new Dictionary { ["name"] = "Flat rate", ["method"] = "FLAT_RATE", ["handling_cost"] = 1, ["shipping_cost"] = 5, }, }, }); Console.WriteLine(response.Json); - lang: dart label: Dart source: | import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.shippingRules .createSettingsShippingRuleConfiguration( 'sr_7f8091a2b3c4d5e6f708192a3b4c5d6e', { 'configuration': { 'zones': [ {'zone': '0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9'}, ], 'rate': { 'name': 'Flat rate', 'method': 'FLAT_RATE', 'handling_cost': 1, 'shipping_cost': 5, }, }, }, ); print(response.map); - lang: go label: Go source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.ShippingRules().CreateSettingsShippingRuleConfiguration(context.Background(), \"sr_7f8091a2b3c4d5e6f708192a3b4c5d6e\", map[string]any{\n\t\"configuration\": map[string]any{\n\t\t\"zones\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"zone\": \"0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9\",\n\t\t\t},\n\t\t},\n\t\t\"rate\": map[string]any{\n\t\t\t\"name\": \"Flat rate\",\n\t\t\t\"method\": \"FLAT_RATE\",\n\t\t\t\"handling_cost\": 1,\n\t\t\t\"shipping_cost\": 5,\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: ShippingRuleResponse: type: object properties: shipping_rule: $ref: '#/components/schemas/ShippingRule' Error: type: object description: Every failed call returns this body. properties: object: type: string description: Always `error`. request_id: type: string description: Quote this to support. status: type: integer description: The HTTP status. code: type: string description: What went wrong, such as `validation_error`. message: type: string description: A short description of the problem. doc_url: type: string description: A link to more about this error. errors: type: array description: One entry per field that failed. items: type: object properties: field: type: string code: type: string message: type: string doc_url: type: string ShippingRule: type: object properties: configuration: $ref: '#/components/schemas/ShippingRuleConfiguration' created_by: {} created_on: type: string description: type: string href: type: string id: type: string last_updated_by: {} last_updated_on: type: string name: type: string object: type: string shipping_class: {} status: type: string version: type: integer ShippingRuleConfiguration: type: object properties: rate: description: The rate the rule charges. zones: type: array description: The zones the rule applies to. securitySchemes: bearerAuth: type: http scheme: bearer description: >- An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.