Get shipping rule

TypeScript

import { Configuration, RulesApi } from "@zippendo/sdk"

const api = new RulesApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.getShippingRule({ orgId: "...", ruleId: "..." })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.RulesApi(client).get_shipping_rule("...", "...")

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\RulesApi(new GuzzleHttp\Client(), $config);
$result = $api->getShippingRule("...", "...");

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.RulesAPI.GetShippingRule(ctx, "...", "...").Execute()

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zippendo.com/orgs/{orgId}/shipping-rules/{ruleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "rule_01HZX9K2QF",
  "name": "Standard DK",
  "description": "Standard levering i Danmark",
  "direction": "outbound",
  "carrierId": "carr_01HZX9K2QF",
  "productId": "PNL13",
  "services": [
    "EMAIL_NOTIFICATION"
  ],
  "additionalParameters": {
    "returnFunctionality": "LABELLESS",
    "returnQrEmail": true
  },
  "addressId": "addr_01HZX9K2QF",
  "receivingCountries": [
    "DK",
    "SE"
  ],
  "emailNotification": true,
  "phoneNotification": false,
  "minWeight": 0,
  "maxWeight": 20,
  "minOrderValue": 0,
  "maxOrderValue": 5000,
  "conditions": [
    {
      "type": "flatRate",
      "shippingPrice": 39,
      "currency": "DKK"
    }
  ],
  "generateProformaInvoice": false,
  "generateCommercialInvoice": false,
  "generatePackingList": false,
  "autoPrintLabels": false,
  "autoPrintDocuments": false,
  "labelPrinterId": null,
  "documentPrinterId": null,
  "returnShippingRuleId": null,
  "autoCreateReturnShipment": false,
  "orgId": "org_01HZX9K2QF",
  "brandId": "brnd_8f3kd92ld0",
  "createdAt": "2026-06-22T09:00:00.000Z",
  "updatedAt": "2026-06-22T09:00:00.000Z",
  "carrier": {
    "id": "carr_01HZX9K2QF",
    "name": "PostNord",
    "carrierSlug": "postnord",
    "config": {
      "customerNumber": "123456"
    },
    "orgId": "org_01HZX9K2QF",
    "brandId": "brnd_8f3kd92ld0",
    "createdAt": "2026-06-22T09:00:00.000Z",
    "updatedAt": "2026-06-22T09:00:00.000Z"
  },
  "address": {
    "id": "addr_01HZX9K2QF",
    "name": "Zippendo ApS",
    "description": "Main warehouse, Copenhagen",
    "attContact": "Mette Hansen",
    "address1": "Vesterbrogade 1",
    "address2": "2. sal",
    "zipcode": "1620",
    "city": "København",
    "phone": "+4533123456",
    "countryCode": "DK",
    "state": null,
    "email": "[email protected]",
    "addressTypes": [
      "sender"
    ],
    "orgId": "org_01HZX9K2QF",
    "brandId": "brnd_8f3kd92ld0",
    "createdAt": "2026-06-22T09:00:00.000Z",
    "updatedAt": "2026-06-22T09:00:00.000Z",
    "customs": {
      "eori": "DK12345678"
    }
  },
  "labelPrinter": {
    "id": "prn_01HZX9K2QF",
    "name": "Zebra ZD420 Lager"
  },
  "documentPrinter": {
    "id": "prn_01HZX9K2QF",
    "name": "Zebra ZD420 Lager"
  },
  "returnShippingRule": {
    "id": "rule_01HZX9K2QF",
    "name": "Retur DK"
  }
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

GET

orgs

{orgId}

shipping-rules

{ruleId}

TypeScript

import { Configuration, RulesApi } from "@zippendo/sdk"

const api = new RulesApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.getShippingRule({ orgId: "...", ruleId: "..." })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.RulesApi(client).get_shipping_rule("...", "...")

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\RulesApi(new GuzzleHttp\Client(), $config);
$result = $api->getShippingRule("...", "...");

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.RulesAPI.GetShippingRule(ctx, "...", "...").Execute()

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zippendo.com/orgs/{orgId}/shipping-rules/{ruleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "rule_01HZX9K2QF",
  "name": "Standard DK",
  "description": "Standard levering i Danmark",
  "direction": "outbound",
  "carrierId": "carr_01HZX9K2QF",
  "productId": "PNL13",
  "services": [
    "EMAIL_NOTIFICATION"
  ],
  "additionalParameters": {
    "returnFunctionality": "LABELLESS",
    "returnQrEmail": true
  },
  "addressId": "addr_01HZX9K2QF",
  "receivingCountries": [
    "DK",
    "SE"
  ],
  "emailNotification": true,
  "phoneNotification": false,
  "minWeight": 0,
  "maxWeight": 20,
  "minOrderValue": 0,
  "maxOrderValue": 5000,
  "conditions": [
    {
      "type": "flatRate",
      "shippingPrice": 39,
      "currency": "DKK"
    }
  ],
  "generateProformaInvoice": false,
  "generateCommercialInvoice": false,
  "generatePackingList": false,
  "autoPrintLabels": false,
  "autoPrintDocuments": false,
  "labelPrinterId": null,
  "documentPrinterId": null,
  "returnShippingRuleId": null,
  "autoCreateReturnShipment": false,
  "orgId": "org_01HZX9K2QF",
  "brandId": "brnd_8f3kd92ld0",
  "createdAt": "2026-06-22T09:00:00.000Z",
  "updatedAt": "2026-06-22T09:00:00.000Z",
  "carrier": {
    "id": "carr_01HZX9K2QF",
    "name": "PostNord",
    "carrierSlug": "postnord",
    "config": {
      "customerNumber": "123456"
    },
    "orgId": "org_01HZX9K2QF",
    "brandId": "brnd_8f3kd92ld0",
    "createdAt": "2026-06-22T09:00:00.000Z",
    "updatedAt": "2026-06-22T09:00:00.000Z"
  },
  "address": {
    "id": "addr_01HZX9K2QF",
    "name": "Zippendo ApS",
    "description": "Main warehouse, Copenhagen",
    "attContact": "Mette Hansen",
    "address1": "Vesterbrogade 1",
    "address2": "2. sal",
    "zipcode": "1620",
    "city": "København",
    "phone": "+4533123456",
    "countryCode": "DK",
    "state": null,
    "email": "[email protected]",
    "addressTypes": [
      "sender"
    ],
    "orgId": "org_01HZX9K2QF",
    "brandId": "brnd_8f3kd92ld0",
    "createdAt": "2026-06-22T09:00:00.000Z",
    "updatedAt": "2026-06-22T09:00:00.000Z",
    "customs": {
      "eori": "DK12345678"
    }
  },
  "labelPrinter": {
    "id": "prn_01HZX9K2QF",
    "name": "Zebra ZD420 Lager"
  },
  "documentPrinter": {
    "id": "prn_01HZX9K2QF",
    "name": "Zebra ZD420 Lager"
  },
  "returnShippingRule": {
    "id": "rule_01HZX9K2QF",
    "name": "Retur DK"
  }
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

Authorizations

Authorization

string

header

required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId

string

required

Organization ID

Example:

"org_01HZX9K2QF"

ruleId

string

required

Shipping Rule ID

Example:

"rule_01HZX9K2QF"

Response

Default Response

string

required

Unique shipping rule identifier

Example:

"rule_01HZX9K2QF"

name

string

required

Shipping rule name

Minimum string length: 1

Example:

"Standard DK"

description

string | null

required

Optional description

Example:

"Standard levering i Danmark"

direction

enum<string>

default:outbound

required

Whether this rule is for outbound or inbound (return) shipments

Available options:

outbound,

inbound

Example:

"outbound"

carrierId

string

required

Carrier ID

Example:

"carr_01HZX9K2QF"

productId

string

required

Product ID from carrier

Example:

"PNL13"

services

string[]

required

List of selected services

Service code

Example:

["EMAIL_NOTIFICATION"]

additionalParameters

object

required

Carrier-specific extra parameters, keyed by the carrier parameter key from the product's additionalParameters[].key.

Show child attributes

Example:

{
  "returnFunctionality": "LABELLESS",
  "returnQrEmail": true
}

addressId

string

required

Sender address ID

Example:

"addr_01HZX9K2QF"

receivingCountries

string[]

required

List of supported country codes

ISO country code

Example:

["DK", "SE"]

emailNotification

boolean

default:false

required

Send an email notification to the receiver

Example:

true

phoneNotification

boolean

default:false

required

Send an SMS notification to the receiver

Example:

false

minWeight

number | null

required

Minimum required weight in kg. Orders below this are excluded from the rule.

Required range: x >= 0

Example:

0

maxWeight

number | null

required

Maximum allowed weight in kg. Orders exceeding this are excluded from the rule.

Required range: x >= 0

Example:

20

minOrderValue

number | null

required

Minimum required order value in currency units. Orders below this are excluded from the rule.

Required range: x >= 0

Example:

0

maxOrderValue

number | null

required

Maximum allowed order value in currency units. Orders exceeding this are excluded from the rule.

Required range: x >= 0

Example:

5000

conditions

object[]

required

Rule conditions (weight/price/quantity)

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

Example:

[
  {
    "type": "flatRate",
    "shippingPrice": 39,
    "currency": "DKK"
  }
]

generateProformaInvoice

boolean

default:false

required

Generate proforma invoice for shipments

Example:

false

generateCommercialInvoice

boolean

default:false

required

Generate commercial invoice for international shipments

Example:

false

generatePackingList

boolean

default:false

required

Generate a packing slip with parcel and item details

Example:

false

autoPrintLabels

boolean

default:false

required

Automatically print labels when shipment is sent

Example:

false

autoPrintDocuments

boolean

default:false

required

Automatically print documents when shipment is sent

Example:

false

labelPrinterId

string | null

required

ID of the label printer

Example:

null

documentPrinterId

string | null

required

ID of the document printer

Example:

null

returnShippingRuleId

string | null

required

ID of the return shipping rule

Example:

null

autoCreateReturnShipment

boolean

default:false

required

Automatically create and send a return shipment on dispatch

Example:

false

orgId

string

required

Owning organization ID

Example:

"org_01HZX9K2QF"

brandId

string | null

required

Brand this record belongs to, or null when it is organization-wide

Example:

"brnd_8f3kd92ld0"

createdAt

string

required

Creation timestamp (ISO 8601)

Example:

"2026-06-22T09:00:00.000Z"

updatedAt

string

required

Last update timestamp (ISO 8601)

Example:

"2026-06-22T09:00:00.000Z"

carrier

object

required

Show child attributes

address

object

required

Show child attributes

labelPrinter

object | null

Show child attributes

documentPrinter

object | null

Show child attributes

returnShippingRule

object | null

Show child attributes

Overview

SDKs

MCP server

System

Tokens

Orgs

Brands

Addresses

Carriers

Rules

Quotes

Shipments

Orders

Order Channels

Carrier Catalog

Billing

Webhooks

Get shipping rule

Authorizations

Path Parameters

Response