List Fallback Shipping Methods

Lists the merchant's fallback shipping methods. Methods missing a handle are assigned one (derived from the label) on read.

List Merchant Fallback Shipping Methods

get

Lists the merchant's fallback shipping methods. Methods missing a handle are assigned one (derived from the label) on read.

Path parameters

merchant_idinteger · int32Required

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

200

The merchant's fallback shipping methods.

application/json

labelstringOptional

The name of the shipping method.

descriptionstringOptional

Description of the shipping method.

priceinteger · int32Optional

The price of the shipping method in cents.

currencystring · enumOptional

The currency of the shipping method.

Possible values:

handlestringOptional

The handle or external ID to use when utilizing this method.

calculation_typestring · enum · nullableOptional

Whether the price is calculated per the entire order or per item.

Possible values:

get/merchants/{merchant_id}/shipping-methods

HTTPcURLJavaScriptPython

GET /v1/merchants/{merchant_id}/shipping-methods HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

200

The merchant's fallback shipping methods.

[
  {
    "label": "Standard",
    "description": "5-7 business days",
    "price": 500,
    "currency": "USD",
    "handle": "standard",
    "calculation_type": "PER_ORDER",
    "conditions": {
      "applicable_countries": [
        "US",
        "CA"
      ],
      "min_order_amount": 1000
    }
  }
]