Relay

GET

relay

merchants

{merchant_id}

shipping-zones

curl --request GET \
  --url https://sandbox-api.violet.io/v1/relay/merchants/{merchant_id}/shipping-zones

{
  "content": [
    {
      "external_id": "457216524578",
      "name": "Domestic",
      "display_order": 1,
      "enabled": true,
      "regions": [
        {
          "name": "United States",
          "code": "US",
          "type": "COUNTRY",
          "enabled": true,
          "display_order": 1,
          "sub_regions": [
            {
              "name": "Washington",
              "code": "WA",
              "type": "PROVINCE",
              "enabled": true,
              "display_order": 55,
              "metadata": [
                {
                  "type": "STRING",
                  "key": "tax_name",
                  "value": "State Tax"
                },
                {
                  "type": "DECIMAL",
                  "key": "tax",
                  "value": 0.065
                },
                {
                  "type": "DECIMAL",
                  "key": "tax_percentage",
                  "value": 6.5
                }
              ]
            }
          ],
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "tax",
              "value": 0
            },
            {
              "type": "STRING",
              "key": "tax_name",
              "value": "Federal Tax"
            }
          ]
        }
      ],
      "methods": [
        {
          "external_id": "641084293410",
          "name": "Free Ground Shipping Over $50",
          "price": 0,
          "type": "PRICE",
          "min_price": 5000,
          "price_type": "SUBTOTAL"
        },
        {
          "external_id": "641084326178",
          "name": "Economy",
          "price": 490,
          "type": "WEIGHT",
          "min_weight": 0,
          "max_weight": 5,
          "weight_unit": "POUND"
        },
        {
          "external_id": "641084358946",
          "name": "Economy",
          "price": 1990,
          "type": "WEIGHT",
          "min_weight": 5,
          "max_weight": 70,
          "weight_unit": "POUND"
        },
        {
          "external_id": "641084457250",
          "name": "First Class Package",
          "carrier_name": "USPS",
          "type": "CARRIER",
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "percent_modifier",
              "value": 0
            },
            {
              "type": "DECIMAL",
              "key": "flat_modifier",
              "value": 0
            }
          ]
        },
        {
          "external_id": "641084457250",
          "name": "Priority Mail Express",
          "carrier_name": "USPS",
          "type": "CARRIER",
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "percent_modifier",
              "value": 0
            },
            {
              "type": "DECIMAL",
              "key": "flat_modifier",
              "value": 0
            }
          ]
        },
        {
          "external_id": "641084457250",
          "name": "Priority Mail",
          "carrier_name": "USPS",
          "type": "CARRIER",
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "percent_modifier",
              "value": 0
            },
            {
              "type": "DECIMAL",
              "key": "flat_modifier",
              "value": 0
            }
          ]
        }
      ],
      "free_shipping": {
        "enabled": true,
        "min_price": 5000,
        "price_type": "SUBTOTAL",
        "exclude_products_with_custom_shipping": true
      }
    }
  ]
}

Most metadata returned in the response is unique to a commerce platform. This is data that does not fit into a universal schema but may still provide value.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Path Parameters

merchant_id

integer

required

Response

default - application/json

content

object[]

content.external_id

string

The ID of the shipping zone in the external commerce platform.

content.name

string

The name of the shipping zone in the external commerce platform.

content.display_order

integer

The display order of the shipping zone in the external commerce platform.

content.enabled

boolean

Is the shipping zone enabled in the external commerce platform.

content.regions

object[]

The regions included for this shipping zone.

content.regions.external_id

string

The ID of the shipping zone region in the external commerce platform.

content.regions.name

string

The abbreviated code of the shipping zone region in the external commerce platform.

content.regions.type

enum<string>

The type of the shipping zone region in the external commerce platform.

Available options:

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT,

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT

content.regions.enabled

boolean

Is the shipping zone region enabled in the external commerce platform.

content.regions.display_order

integer

The display order of the shipping zone region in the external commerce platform.

content.regions.sub_regions

object[]

Sub regions (if any) that belong to this parent shipping region.

content.regions.sub_regions.external_id

string

The ID of the shipping zone region in the external commerce platform.

content.regions.sub_regions.name

string

The abbreviated code of the shipping zone region in the external commerce platform.

content.regions.sub_regions.type

enum<string>

The type of the shipping zone region in the external commerce platform.

Available options:

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT,

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT

content.regions.sub_regions.enabled

boolean

Is the shipping zone region enabled in the external commerce platform.

content.regions.sub_regions.display_order

integer

The display order of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions

object[]

Sub regions (if any) that belong to this parent shipping region.

content.regions.sub_regions.sub_regions.external_id

string

The ID of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.name

string

The abbreviated code of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.type

enum<string>

The type of the shipping zone region in the external commerce platform.

Available options:

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT,

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT

content.regions.sub_regions.sub_regions.enabled

boolean

Is the shipping zone region enabled in the external commerce platform.

content.regions.sub_regions.sub_regions.display_order

integer

The display order of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions

object[]

Sub regions (if any) that belong to this parent shipping region.

content.regions.sub_regions.sub_regions.sub_regions.external_id

string

The ID of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.name

string

The abbreviated code of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.type

enum<string>

The type of the shipping zone region in the external commerce platform.

Available options:

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT,

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT

content.regions.sub_regions.sub_regions.sub_regions.enabled

boolean

Is the shipping zone region enabled in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.display_order

integer

The display order of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions

object[]

Sub regions (if any) that belong to this parent shipping region.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.external_id

string

The ID of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.name

string

The abbreviated code of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.type

enum<string>

The type of the shipping zone region in the external commerce platform.

Available options:

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT,

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.enabled

boolean

Is the shipping zone region enabled in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.display_order

integer

The display order of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions

object[]

Sub regions (if any) that belong to this parent shipping region.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.external_id

string

The ID of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.name

string

The abbreviated code of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.type

enum<string>

The type of the shipping zone region in the external commerce platform.

Available options:

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT,

COUNTRY,

PROVINCE,

POSTCODE,

CONTINENT

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.enabled

boolean

Is the shipping zone region enabled in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.display_order

integer

The display order of the shipping zone region in the external commerce platform.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions

any[]

Sub regions (if any) that belong to this parent shipping region.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.sub_regions.metadata

object[]

Additional data about the shipping zone region.

content.regions.sub_regions.sub_regions.sub_regions.sub_regions.metadata

object[]

Additional data about the shipping zone region.

content.regions.sub_regions.sub_regions.sub_regions.metadata

object[]

Additional data about the shipping zone region.

content.regions.sub_regions.sub_regions.metadata

object[]

Additional data about the shipping zone region.

content.regions.sub_regions.metadata

object[]

Additional data about the shipping zone region.

content.regions.metadata

object[]

Additional data about the shipping zone region.

content.methods

object[]

The methods included for this shipping zone.

content.methods.external_id

string

The ID of the shipping method in the external commerce platform.

content.methods.name

string

The name of the shipping method in the external commerce platform.

content.methods.carrier_name

string

The name of the carrier (if any) in the external commerce platform. May be null or empty when not of type CARRIER.

content.methods.display_order

integer

The display order of the shipping method in the external commerce platform.

content.methods.enabled

boolean

Is the shipping method enabled in the external commerce platform.

content.methods.price

integer

The price of the shipping method in the external commerce platform. May be null for carrier rates.

content.methods.type

enum<string>

The type of shipping method in the external commerce platform

Available options:

ORDER,

WEIGHT,

PRICE,

CARRIER,

ORDER,

WEIGHT,

PRICE,

CARRIER

content.methods.min_price

integer

The minimum price of a price constrained shipping method in the external commerce platform. Will be null when not of type PRICE.

content.methods.max_price

integer

The maximum price of a price constrained shipping method in the external commerce platform. Will be null when not of type PRICE.

content.methods.price_type

enum<string>

The type of the price, whether it applies to the subtotal or the total. Will be null when not of type PRICE.

Available options:

SUBTOTAL,

TOTAL,

SUBTOTAL,

TOTAL

content.methods.min_weight

number

The minimum weight of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.

content.methods.max_weight

number

The maximum weight of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.

content.methods.weight_unit

enum<string>

The weight unit of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.

Available options:

CARAT,

GRAM,

OUNCE,

POUND,

KILOGRAM,

TON,

TONNE

content.methods.metadata

object[]

Additional data about the shipping method.

content.free_shipping

object

A summary of the free shipping (if any) for a shipping zone.

content.metadata

object[]

Additional data about the shipping zone.

Was this page helpful?

Get Custom Connection Health Report

curl --request GET \
  --url https://sandbox-api.violet.io/v1/relay/merchants/{merchant_id}/shipping-zones

{
  "content": [
    {
      "external_id": "457216524578",
      "name": "Domestic",
      "display_order": 1,
      "enabled": true,
      "regions": [
        {
          "name": "United States",
          "code": "US",
          "type": "COUNTRY",
          "enabled": true,
          "display_order": 1,
          "sub_regions": [
            {
              "name": "Washington",
              "code": "WA",
              "type": "PROVINCE",
              "enabled": true,
              "display_order": 55,
              "metadata": [
                {
                  "type": "STRING",
                  "key": "tax_name",
                  "value": "State Tax"
                },
                {
                  "type": "DECIMAL",
                  "key": "tax",
                  "value": 0.065
                },
                {
                  "type": "DECIMAL",
                  "key": "tax_percentage",
                  "value": 6.5
                }
              ]
            }
          ],
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "tax",
              "value": 0
            },
            {
              "type": "STRING",
              "key": "tax_name",
              "value": "Federal Tax"
            }
          ]
        }
      ],
      "methods": [
        {
          "external_id": "641084293410",
          "name": "Free Ground Shipping Over $50",
          "price": 0,
          "type": "PRICE",
          "min_price": 5000,
          "price_type": "SUBTOTAL"
        },
        {
          "external_id": "641084326178",
          "name": "Economy",
          "price": 490,
          "type": "WEIGHT",
          "min_weight": 0,
          "max_weight": 5,
          "weight_unit": "POUND"
        },
        {
          "external_id": "641084358946",
          "name": "Economy",
          "price": 1990,
          "type": "WEIGHT",
          "min_weight": 5,
          "max_weight": 70,
          "weight_unit": "POUND"
        },
        {
          "external_id": "641084457250",
          "name": "First Class Package",
          "carrier_name": "USPS",
          "type": "CARRIER",
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "percent_modifier",
              "value": 0
            },
            {
              "type": "DECIMAL",
              "key": "flat_modifier",
              "value": 0
            }
          ]
        },
        {
          "external_id": "641084457250",
          "name": "Priority Mail Express",
          "carrier_name": "USPS",
          "type": "CARRIER",
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "percent_modifier",
              "value": 0
            },
            {
              "type": "DECIMAL",
              "key": "flat_modifier",
              "value": 0
            }
          ]
        },
        {
          "external_id": "641084457250",
          "name": "Priority Mail",
          "carrier_name": "USPS",
          "type": "CARRIER",
          "metadata": [
            {
              "type": "DECIMAL",
              "key": "percent_modifier",
              "value": 0
            },
            {
              "type": "DECIMAL",
              "key": "flat_modifier",
              "value": 0
            }
          ]
        }
      ],
      "free_shipping": {
        "enabled": true,
        "min_price": 5000,
        "price_type": "SUBTOTAL",
        "exclude_products_with_custom_shipping": true
      }
    }
  ]
}

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Apps

Operations

Relay - Get Shipping Zones

Headers

Path Parameters

Response