Save general shopping schema

POST 
/openapi/2026-07/shipping-schemas/general

Create or Modify a general shipping schema.

Request

application/json

Body

Bodyrequired

shipping_schemas object
Shipping schemas
idstring
Shipping schema ID; updates the record if it exists, creates a new one otherwise
namestringrequired
Name of the shipping schema
shippings object[]
List of shipping zone configurations
Array [
idstring
Shipping zone ID; updates the record if it exists, creates a new one otherwise
namestringrequired
Name of the shipping zone
support_codint32
Whether cash on delivery is supported:
• 1: supported
• 0: not supported
plans object[]
List of shipping rate plans for this zone
Array [
idstring
Shipping plan ID; updates the record if it exists, creates a new one otherwise
namestringrequired
Name of the shipping rate plan
descstring
Description of the shipping rate plan
rule_typestring
Condition type for range rules:
• price: order total
• quantity: grouped quantity
• weight: grouped weight
• pass: no condition
rule_range_minstring
Minimum value of the condition range
rule_range_maxstring
Maximum value of the condition range
rule_range_infiniteint32
Flag indicating the maximum value is unbounded (infinity)
rule_range_unitstring
Unit of the range value, e.g. weight unit "kg", quantity unit "piece", price unit as currency code
rate_typestring
Rate calculation method:
• normal: flat fee
• weight: first-weight + additional-weight
• percent: percentage-based
• third: third-party carrier
rate_amountstring
Rate value corresponding to the rate type:
• flat fee amount
• first-weight fee
• percentage value
• empty for third-party.
rate_first_rangestring
Weight threshold for the first-weight tier
rate_first_unitstring
Unit for the first-weight tier (e.g. "kg")
rate_additional_amountstring
Additional fee charged per additional weight unit beyond the first-weight tier
rate_additional_unitstring
Unit for the additional-weight tier (e.g. "kg")
rate_additional_rangestring
Weight increment per additional-weight unit
plan_typeint32
Plan type:
• 1: custom
• 2: third-party carrier
plan_type_valuestring
Configuration value associated with the plan type (e.g. third-party carrier identifier)
rule_type_scopeint32
Scope of the range rule:
• 1: order level
• 2: group level
• 3: other
]
areas object[]
List of geographic areas covered by this zone
Array [
country_namestringrequired
Display name of the country
country_codestringrequired
ISO country code
province_codesstring[]
List of province/state codes covered by this area
]
]

Example

{
  "shipping_schemas": {
    "id": "string",
    "name": "string",
    "shippings": [
      {
        "id": "string",
        "name": "string",
        "support_cod": 0,
        "plans": [
          {
            "id": "string",
            "name": "string",
            "desc": "string",
            "rule_type": "string",
            "rule_range_min": "string",
            "rule_range_max": "string",
            "rule_range_infinite": 0,
            "rule_range_unit": "string",
            "rate_type": "string",
            "rate_amount": "string",
            "rate_first_range": "string",
            "rate_first_unit": "string",
            "rate_additional_amount": "string",
            "rate_additional_unit": "string",
            "rate_additional_range": "string",
            "plan_type": 0,
            "plan_type_value": "string",
            "rule_type_scope": 0
          }
        ],
        "areas": [
          {
            "country_name": "string",
            "country_code": "string",
            "province_codes": [
              "string"
            ]
          }
        ]
      }
    ]
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
shipping_schemas object
The saved general shipping schema
idstring
Shipping schema ID
namestring
Name of the shipping schema
schema_typeint32
Schema type:
• 0: general
• 1: custom
variant_numint32
Number of product variants associated with this schema
shippings object[]
List of shipping zones under this schema
Array [
idstring
Shipping ID
namestring
Name of the shipping zone
schema_idstring
ID of the shipping schema this zone belongs to
support_codint32
Whether cash on delivery is supported; 1 = supported, 0 = not supported
plans object[]
List of shipping rate plans for this zone
Array [
idstring
Shipping rate plan ID
shipping_idstring
ID of the shipping zone this plan belongs to
namestring
Name of the shipping rate plan
descstring
Description of the shipping rate plan
support_codint32
Whether cash on delivery is supported:
• 1: supported
• 0: not supported
rule_typestring
Condition type for range rules:
• price: order total
• quantity: grouped quantity
• weight: grouped weight
• pass: no condition
rule_range_minstring
Minimum value of the condition range
rule_range_maxstring
Maximum value of the condition range
rule_range_infiniteint32
Flag indicating the maximum value is unbounded (infinity)
rule_range_unitstring
Unit of the range value, e.g. weight unit "kg", quantity unit "piece", price unit as currency code
rate_typestring
Rate calculation method:
• normal: flat fee
• weight: first-weight + additional-weight
• percent: percentage-based
• third: third-party carrier
rate_amountstring
Rate value corresponding to the rate type:
• flat fee amount
• first-weight fee
• percentage value
• empty for third-party.
rate_first_rangestring
Weight threshold for the first-weight tier
rate_first_unitstring
Unit for the first-weight tier (e.g. "kg")
rate_additional_amountstring
Additional fee charged per additional weight unit beyond the first-weight tier
rate_additional_unitstring
Unit for the additional-weight tier (e.g. "kg")
rate_additional_rangestring
Weight increment per additional-weight unit
store_idstring
ID of the store this plan belongs to
created_timestring
Timestamp when the plan was created
updated_timestring
Timestamp when the plan was last updated
plan_typeint32
Plan type:
• 1: custom
• 2: third-party carrier
plan_type_valuestring
Configuration value associated with the plan type (e.g. third-party carrier identifier)
rule_type_scopeint32
Scope of the range rule:
• 1: order level
• 2: group level
• 3: other
]
areas object[]
List of geographic areas covered by this zone
Array [
shipping_idstring
ID of the shipping zone this area belongs to
country_namestring
Display name of the country
country_codestring
ISO country code
province_codesstring[]
List of province/state codes covered by this area
]
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "shipping_schemas": {
      "id": "string",
      "name": "string",
      "schema_type": 0,
      "variant_num": 0,
      "shippings": [
        {
          "id": "string",
          "name": "string",
          "schema_id": "string",
          "support_cod": 0,
          "plans": [
            {
              "id": "string",
              "shipping_id": "string",
              "name": "string",
              "desc": "string",
              "support_cod": 0,
              "rule_type": "string",
              "rule_range_min": "string",
              "rule_range_max": "string",
              "rule_range_infinite": 0,
              "rule_range_unit": "string",
              "rate_type": "string",
              "rate_amount": "string",
              "rate_first_range": "string",
              "rate_first_unit": "string",
              "rate_additional_amount": "string",
              "rate_additional_unit": "string",
              "rate_additional_range": "string",
              "store_id": "string",
              "created_time": "string",
              "updated_time": "string",
              "plan_type": 0,
              "plan_type_value": "string",
              "rule_type_scope": 0
            }
          ],
          "areas": [
            {
              "shipping_id": "string",
              "country_name": "string",
              "country_code": "string",
              "province_codes": [
                "string"
              ]
            }
          ]
        }
      ]
    }
  }
}