WooCommerce · Schema

ShippingMethod

A shipping method configured within a shipping zone.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name Type Description
id integer Shipping method unique identifier.
instance_id integer Shipping method instance ID within the zone.
title string Shipping method display name.
order integer Display order within the zone.
enabled boolean Whether this shipping method is enabled.
method_id string Shipping method type ID (e.g. flat_rate, free_shipping, local_pickup).
method_title string Shipping method type title.
method_description string Shipping method type description.
View JSON Schema on GitHub

JSON Schema

woocommerce-rest-api-shipping-method-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-shipping-method-schema.json",
  "title": "ShippingMethod",
  "description": "A shipping method configured within a shipping zone.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Shipping method unique identifier.",
      "example": 1
    },
    "instance_id": {
      "type": "integer",
      "description": "Shipping method instance ID within the zone.",
      "example": 1
    },
    "title": {
      "type": "string",
      "description": "Shipping method display name.",
      "example": "Example Name"
    },
    "order": {
      "type": "integer",
      "description": "Display order within the zone.",
      "example": 1
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this shipping method is enabled.",
      "example": true
    },
    "method_id": {
      "type": "string",
      "description": "Shipping method type ID (e.g. flat_rate, free_shipping, local_pickup).",
      "example": "500123"
    },
    "method_title": {
      "type": "string",
      "description": "Shipping method type title.",
      "example": "Example Name"
    },
    "method_description": {
      "type": "string",
      "description": "Shipping method type description.",
      "example": "A sample description"
    }
  }
}