REST Resource: accounts.shippingSettings

资源:ShippingSettings

商家账号的配送设置

JSON 表示法
{
  "name": string,
  "services": [
    {
      object (Service)
    }
  ],
  "warehouses": [
    {
      object (Warehouse)
    }
  ],
  "etag": string
}
字段
name

string

标识符。配送设置的资源名称。格式:accounts/{account}/shippingSetting

services[]

object (Service)

可选。目标账号的服务列表。

warehouses[]

object (Warehouse)

可选。可在 services 中引用的仓库列表。

etag

string

必需。此字段用于避免异步问题。请确保在 get 调用和 insert 调用之间,配送设置数据没有更改。用户应执行以下步骤:

  1. 将 etag 字段设置为空字符串,以便初始创建配送设置。

  2. 初始创建后,请调用 get 方法以获取 etag 和当前配送设置数据,然后再调用 insert。

  3. 修改为所需的配送设置信息。

  4. 使用从第 2 步中获取的 etag 调用 insert 方法,并提供所需的配送设置信息。

  5. 如果配送设置数据在第 2 步和第 4 步之间发生了变化。由于每次运费设置数据发生变化时 etag 都会发生变化,因此插入请求将会失败。用户应使用新的 etag 重复第 2-4 步。

服务

配送服务。

JSON 表示法
{
  "deliveryCountries": [
    string
  ],
  "rateGroups": [
    {
      object (RateGroup)
    }
  ],
  "loyaltyPrograms": [
    {
      object (LoyaltyProgram)
    }
  ],
  "serviceName": string,
  "active": boolean,
  "currencyCode": string,
  "deliveryTime": {
    object (DeliveryTime)
  },
  "shipmentType": enum (ShipmentType),
  "minimumOrderValue": {
    object (Price)
  },
  "minimumOrderValueTable": {
    object (MinimumOrderValueTable)
  },
  "storeConfig": {
    object (StoreConfig)
  }
}
字段
deliveryCountries[]

string

必需。服务适用的国家/地区的 CLDR 地区代码。

rateGroups[]

object (RateGroup)

可选。配送费率组定义。只有最后一个组可以包含空的 applicableShippingLabels,表示“所有其他内容”。其他 applicableShippingLabels 不得重叠。

loyaltyPrograms[]

object (LoyaltyProgram)

可选。此配送服务仅适用于的会员回馈活动。

serviceName

string

必需。服务的自由形式名称。在目标账号中必须是唯一的。

active

boolean

必需。一个布尔值,用于显示配送服务的有效状态。

currencyCode

string

此服务适用的币种的 CLDR 代码。必须与费率组中的价格一致。

deliveryTime

object (DeliveryTime)

必需。从下单到商品送达所花费的各个方面时间。

shipmentType

enum (ShipmentType)

此服务可配送到的地点类型。

minimumOrderValue

object (Price)

此服务的最低订单金额。如果设置,则表示客户必须至少消费此金额。同一服务中的所有价格都必须采用相同的币种。不能与 minimumOrderValueTable 一起设置。

minimumOrderValueTable

object (MinimumOrderValueTable)

下表显示了每家商店针对自提履单类型的最低订单金额。不能与 minimumOrderValue 一起设置。

storeConfig

object (StoreConfig)

商品发货商店的列表。此属性仅适用于本地配送配送类型。

DeliveryTime

从下单到商品送达所花费的各个方面时间。

JSON 表示法
{
  "warehouseBasedDeliveryTimes": [
    {
      object (WarehouseBasedDeliveryTime)
    }
  ],
  "minTransitDays": integer,
  "maxTransitDays": integer,
  "cutoffTime": {
    object (CutoffTime)
  },
  "minHandlingDays": integer,
  "maxHandlingDays": integer,
  "transitTimeTable": {
    object (TransitTable)
  },
  "handlingBusinessDayConfig": {
    object (BusinessDayConfig)
  },
  "transitBusinessDayConfig": {
    object (BusinessDayConfig)
  }
}
字段
warehouseBasedDeliveryTimes[]

object (WarehouseBasedDeliveryTime)

可选。表示应根据所选运输公司的设置,按仓库(发货地点)计算送货时间。设置此字段后,[送货时间][[google.shopping.content.bundles.ShippingSetting.DeliveryTime]] 中的任何其他与运送时间相关的字段都不应设置。

minTransitDays

integer

商品在运输过程中所需的最短工作日数。0 表示当天送达,1 表示次日送达。必须设置 minTransitDaysmaxTransitDaystransitTimeTable,但不能同时设置这两者。

maxTransitDays

integer

运送所需的最长工作日数。0 表示当天送达,1 表示次日送达。必须大于或等于 minTransitDays

cutoffTime

object (CutoffTime)

工作日截止时间定义。如果未配置,截止时间将默认为太平洋标准时间上午 8:00。

minHandlingDays

integer

订单发货前所需的最短工作日天数。0 表示当天发货,1 表示次日发货。“minHandlingDays”和“maxHandlingDays”应同时设置或同时不设置。

maxHandlingDays

integer

订单发货前所需的最长工作日天数。0 表示当天发货,1 表示次日发货。必须大于或等于 minHandlingDays。“minHandlingDays”和“maxHandlingDays”应同时设置或同时不设置。

transitTimeTable

object (TransitTable)

运送时间表,根据行和列维度显示运送所需的工作日数。您可以设置 minTransitDaysmaxTransitDaystransitTimeTable,但不能同时设置这两者。

handlingBusinessDayConfig

object (BusinessDayConfig)

可以处理订单的工作日。如果未提供,系统会假定为周一至周五的工作日。

transitBusinessDayConfig

object (BusinessDayConfig)

订单在运输过程中所需的工作日数。如果未提供,系统会假定为周一至周五的工作日。

CutoffTime

工作日截止时间定义。

JSON 表示法
{
  "hour": integer,
  "minute": integer,
  "timeZone": string
}
字段
hour

integer

必需。截止时间(下单截止时间),订单必须在此之前下单,才能在当天处理。

minute

integer

必需。截止时间的分钟数,订单必须在此时间之前下单,才能在当天处理。

timeZone

string

必需。时区标识符,例如“Europe/Zurich”。

TransitTable

运送时间表,根据行和列维度显示运送所需的工作日数。您可以设置 minTransitDaysmaxTransitDaystransitTimeTable,但不能同时设置这两者。

JSON 表示法
{
  "postalCodeGroupNames": [
    string
  ],
  "transitTimeLabels": [
    string
  ],
  "rows": [
    {
      object (TransitTimeRow)
    }
  ]
}
字段
postalCodeGroupNames[]

string

必需。区域名称列表 Region.name。最后一个值可以是 "all other locations"。示例:["zone 1", "zone 2", "all other locations"]。提及的邮政编码组必须与服务的送货国家/地区一致。

transitTimeLabels[]

string

必需。运送时间标签列表。最后一个值可以是 "all other labels"。示例:["food", "electronics", "all other labels"]

rows[]

object (TransitTimeRow)

必需。如果只有一个 postalCodeGroupNamestransitTimeLabels 维度集,则有多个行,每行包含一个该维度的值。如果有两个维度,则每行对应于 postalCodeGroupNames,列(值)对应于 transitTimeLabels

TransitTimeRow

如果只有一个 postalCodeGroupNamestransitTimeLabels 维度集,则有多个行,每行包含一个该维度的值。如果有两个维度,则每行对应于 postalCodeGroupNames,列(值)对应于 transitTimeLabels

JSON 表示法
{
  "values": [
    {
      object (TransitTimeValue)
    }
  ]
}
字段
values[]

object (TransitTimeValue)

必需。运送时间范围(最短-最长)(以工作日计)。

TransitTimeValue

运送时间范围(最短-最长)(以工作日计)。

JSON 表示法
{
  "minTransitDays": integer,
  "maxTransitDays": integer
}
字段
minTransitDays

integer

最短运送时间范围(以工作日计)。0 表示当天送达,1 表示次日送达。

maxTransitDays

integer

必须大于或等于 minTransitDays

BusinessDayConfig

仓库的工作日。

JSON 表示法
{
  "businessDays": [
    enum (Weekday)
  ]
}
字段
businessDays[]

enum (Weekday)

必需。正常工作日。不得为空。

星期几

枚举
WEEKDAY_UNSPECIFIED
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

WarehouseBasedDeliveryTime

表示应根据所选运输公司的设置,按仓库(发货地点)计算送货时间。设置此字段后,不应在 deliveryTime 中设置任何其他与运送时间相关的字段。

JSON 表示法
{
  "carrier": string,
  "carrierService": string,
  "warehouse": string
}
字段
carrier

string

必需。运营商,例如 "UPS""Fedex"支持的运营商

carrierService

string

必需。运营商服务,例如 "ground""2 days"。服务的名称必须在 eddSupportedServices 列表中。

warehouse

string

必需。仓库名称。此值应与 [warehouse][ShippingSetting.warehouses.name] 相匹配

RateGroup

配送费率组定义。只有最后一个组可以包含空的 applicableShippingLabels,表示“所有其他内容”。其他 applicableShippingLabels 不得重叠。

JSON 表示法
{
  "applicableShippingLabels": [
    string
  ],
  "subtables": [
    {
      object (Table)
    }
  ],
  "carrierRates": [
    {
      object (CarrierRate)
    }
  ],
  "singleValue": {
    object (Value)
  },
  "mainTable": {
    object (Table)
  },
  "name": string
}
字段
applicableShippingLabels[]

string

必需。配送标签列表,用于定义此费率组适用的商品。这是一个析取运算:只要其中一个标签匹配,费率组就会应用。只有服务的最后一个费率组可以为空。

subtables[]

object (Table)

可选。mainTable 引用的子表的列表。仅当已设置 mainTable 时才能设置此项。

carrierRates[]

object (CarrierRate)

可选。可由 mainTablesingleValue 引用的运营商费率列表。

singleValue

object (Value)

费率组的值(例如固定费率 10 美元)。只有在未设置 mainTablesubtables 时才能设置此项。

mainTable

object (Table)

singleValue 表达力不足时,用于定义费率组的表。仅当未设置 singleValue 时才能设置此项。

name

string

可选。费率组的名称。如果已设置,则必须在配送服务中是唯一的。

费率组的单个值或费率组表格的单元格的值。必须设置 noShippingflatRatepricePercentagecarrier_rateNamesubtable_name 中的一个。

JSON 表示法
{
  "noShipping": boolean,
  "flatRate": {
    object (Price)
  },
  "pricePercentage": string,
  "carrierRate": string,
  "subtable": string
}
字段
noShipping

boolean

如果为 true,则表示商品无法配送。设置时必须为 true,只有在未设置所有其他字段时才能设置。

flatRate

object (Price)

固定费率。只有在未设置所有其他字段的情况下才能设置此字段。

pricePercentage

string

价格的百分比,表示为小数形式的数字(例如 "5.4")。仅当所有其他字段均未设置时才能设置。

carrierRate

string

运输公司费率的名称,是指在同一费率组中定义的运输公司费率。只有在未设置所有其他字段的情况下才能设置此字段。

subtable

string

子表格的名称。只能在表格单元格中设置(例如,不能为单个值设置),并且只有在所有其他字段均未设置的情况下才能设置。

singleValue 表达力不足时,用于定义费率组的表格。

JSON 表示法
{
  "rows": [
    {
      object (Row)
    }
  ],
  "name": string,
  "rowHeaders": {
    object (Headers)
  },
  "columnHeaders": {
    object (Headers)
  }
}
字段
rows[]

object (Row)

必需。构成表格的行列表。必须与 rowHeaders 的长度相同。

name

string

表的名称。子表格需要提供,主表格会被忽略。

rowHeaders

object (Headers)

必需。表格的行标题。

columnHeaders

object (Headers)

表格的列标题。可选:如果未设置,则表格只有一个维度。

标头

表格的行或列标题的非空列表。必须设置 pricesweightsnum_itemspostalCodeGroupNameslocation 中的一个。

JSON 表示法
{
  "prices": [
    {
      object (Price)
    }
  ],
  "weights": [
    {
      object (Weight)
    }
  ],
  "numberOfItems": [
    string
  ],
  "postalCodeGroupNames": [
    string
  ],
  "locations": [
    {
      object (LocationIdSet)
    }
  ]
}
字段
prices[]

object (Price)

必需。包含上限的订单价格上限列表。通过将 price amountMicros 设置为 -1,可以将最后一个价格的值设为无穷大。例如,[{"amountMicros": 10000000, "currencyCode": "USD"}, {"amountMicros": 500000000, "currencyCode": "USD"}, {"amountMicros": -1, "currencyCode": "USD"}] 表示标头“<= $10”“<= $500”和“> $500”。同一服务中的所有价格都必须采用相同的币种。不得为空。必须为正值(-1 除外)。只有在未设置所有其他字段的情况下才能设置此字段。

weights[]

object (Weight)

必需。包含上限的订单重量上限列表。通过将 price amountMicros 设置为 -1,可以将最后一个权重的值设为无穷大。例如,[{"amountMicros": 10000000, "unit": "kg"}, {"amountMicros": 50000000, "unit": "kg"}, {"amountMicros": -1, "unit": "kg"}] 表示标题“<= 10kg”“<= 50kg”和“> 50kg”。服务中的所有权重都必须使用相同的单位。不得为空。必须为正值(-1 除外)。只有在未设置所有其他字段的情况下才能设置此字段。

numberOfItems[]

string

必需。包含商品数量上限(包括该数值)的列表。最后一个值可以是 "infinity"。例如,["10", "50", "infinity"] 表示标题“<= 10 项”“<= 50 项”和“> 50 项”。不得为空。只有在未设置所有其他字段的情况下才能设置此字段。

postalCodeGroupNames[]

string

必需。邮政组名称列表。最后一个值可以是 "all other locations"。示例:["zone 1", "zone 2", "all other locations"]。提及的邮政编码组必须与服务的送货国家/地区一致。不得为空。只有在未设置所有其他字段的情况下才能设置此字段。

locations[]

object (LocationIdSet)

必需。位置 ID 集的列表。不得为空。只有在未设置所有其他字段的情况下才能设置此字段。

重量

权重,表示为字符串值和单位。

JSON 表示法
{
  "unit": enum (WeightUnit),
  "amountMicros": string
}
字段
unit

enum (WeightUnit)

必需。重量单位。可接受的值为:kg 和 lb

amountMicros

string (int64 format)

必需。重量,以微克数表示(100 万微克等于 1 个货币标准单位,例如 1 千克 = 1000000 微克)。您也可以将此字段设置为无穷大,方法是将其设置为 -1。此字段仅支持 -1 和正值。

WeightUnit

重量单位。

枚举
WEIGHT_UNIT_UNSPECIFIED 未指定单位
POUND 磅单位。
KILOGRAM 公斤单位。

LocationIdSet

位置 ID 集的列表。不得为空。只有在未设置所有其他字段的情况下才能设置此字段。

JSON 表示法
{
  "locationIds": [
    string
  ]
}
字段
locationIds[]

string

必需。地理位置 ID 的非空列表。它们必须都属于同一地理位置类型(例如州)。

添加单元格列表。

JSON 表示法
{
  "cells": [
    {
      object (Value)
    }
  ]
}
字段
cells[]

object (Value)

必需。构成该行的单元格列表。对于二维表格,必须与 columnHeaders 的长度相同;对于一维表格,长度为 1。

CarrierRate

可由 mainTablesingleValue 引用的运营商费率列表。https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only 中列出了受支持的快递公司服务。

JSON 表示法
{
  "name": string,
  "carrier": string,
  "carrierService": string,
  "originPostalCode": string,
  "percentageAdjustment": string,
  "flatAdjustment": {
    object (Price)
  }
}
字段
name

string

必需。运营商费率的名称。每个费率组的编号必须是唯一的。

carrier

string

必需。运营商服务,例如 "UPS""Fedex"

carrierService

string

必需。运营商服务,例如 "ground""2 days"

originPostalCode

string

必需。此运输公司费率的配送起点。

percentageAdjustment

string

可选。以十进制表示的乘法配送费率修饰符。可以为负数。例如,"5.4" 会将费率提高 5.4%,"-3" 会将费率降低 3%。

flatAdjustment

object (Price)

可选。加法运费修饰符。可以为负数。例如,{ "amountMicros": 1, "currencyCode" : "USD" } 会将费率增加 1 美元,{ "amountMicros": -3, "currencyCode" : "USD" } 会将费率减少 3 美元。

ShipmentType

配送服务的配送类型。

枚举
SHIPMENT_TYPE_UNSPECIFIED 此服务未指定配送类型。
DELIVERY 此服务会将订单配送到客户选择的地址。
LOCAL_DELIVERY 此服务会将订单配送到客户选择的地址。订单将从附近的本地商店发货。
COLLECTION_POINT 此服务会将订单配送到客户选择的地址。订单从取件点发货。

MinimumOrderValueTable

自提履单类型的每家商店最低订单金额表。

JSON 表示法
{
  "storeCodeSetWithMovs": [
    {
      object (StoreCodeSetWithMov)
    }
  ]
}
字段
storeCodeSetWithMovs[]

object (StoreCodeSetWithMov)

必需。共享相同最低订单金额 (MOV) 的商店代码集列表。至少需要两个集,并且最后一个集必须为空,表示“MOV for all other stores”(适用于所有其他商店)。每个商店代码在所有组中只能出现一次。同一服务中的所有价格都必须采用相同的币种。

StoreCodeSetWithMov

共享相同最低订单金额的商店代码集的列表。至少需要两个集,并且最后一个集必须为空,表示“MOV for all other stores”(适用于所有其他商店)。每个商店代码在所有组中只能出现一次。同一服务中的所有价格都必须采用相同的币种。

JSON 表示法
{
  "storeCodes": [
    string
  ],
  "value": {
    object (Price)
  }
}
字段
storeCodes[]

string

可选。唯一商店代码的列表,如果是全局性代码,则为空。

value

object (Price)

指定商店的最低订单金额。

StoreConfig

商品发货商店的列表。此属性仅适用于本地配送配送类型。

JSON 表示法
{
  "storeCodes": [
    string
  ],
  "storeServiceType": enum (StoreServiceType),
  "cutoffConfig": {
    object (CutoffConfig)
  },
  "serviceRadius": {
    object (Distance)
  }
}
字段
storeCodes[]

string

可选。提供本地配送的实体店代码列表。如果为空,则 all_stores 必须为 true。

storeServiceType

enum (StoreServiceType)

指明此商家列出的所有商店或部分商店是否提供本地配送服务。

cutoffConfig

object (CutoffConfig)

与本地送达相关的配置当天结束。

serviceRadius

object (Distance)

最大配送半径。只有本地配送配送类型才需要此属性。

StoreServiceType

指明商家列出的所有商店或部分商店是否提供本地配送服务。

枚举
STORE_SERVICE_TYPE_UNSPECIFIED 未指定商店服务类型。
ALL_STORES 指示此商家列出的所有当前和未来的商店是否提供本地配送服务。
SELECTED_STORES 表示只有 storeCodes 中列出的商店符合本地配送条件。

CutoffConfig

与本地送达相关的配置当天结束。

JSON 表示法
{
  "localCutoffTime": {
    object (LocalCutoffTime)
  },
  "storeCloseOffsetHours": string,
  "noDeliveryPostCutoff": boolean
}
字段
localCutoffTime

object (LocalCutoffTime)

当天本地送达服务的结束时间。

storeCloseOffsetHours

string (int64 format)

仅适用于本地送货方式。以商店打烊前的小时数表示截止时间。它与 localCutoffTime 是互斥的。

noDeliveryPostCutoff

boolean

如果商家将配送服务配置为“n 天送达”,则可以选择不显示“n+1 天送达”。例如,如果配送服务定义了当天送达,并且已超过截止时间,将此字段设置为 true 会导致计算出的配送服务费率返回 NO_DELIVERY_POST_CUTOFF。在同一示例中,将此字段设置为 false 会导致计算出的送货时间为 1 天。此功能仅适用于本地配送。

LocalCutoffTime

当天本地送达服务的结束时间。

JSON 表示法
{
  "hour": string,
  "minute": string
}
字段
hour

string (int64 format)

当天送达服务的订单必须在截止时间之前下单,才能当天处理。

minute

string (int64 format)

必须在分钟级本地送达服务的下单截止时间之前下单,才能当天处理。

距离

最大配送半径。只有本地配送配送类型才需要此属性。

JSON 表示法
{
  "value": string,
  "unit": enum (Unit)
}
字段
value

string (int64 format)

距离的整数值。

unit

enum (Unit)

单位可能会因国家/地区而异,其参数包括英里和公里。

单位

单位可能会因国家/地区而异,其参数包括英里和公里。

枚举
UNIT_UNSPECIFIED 未指定单位
MILES 单位为英里
KILOMETERS 单位为公里

LoyaltyProgram

商家提供的会员回馈活动

JSON 表示法
{
  "loyaltyProgramTiers": [
    {
      object (LoyaltyProgramTiers)
    }
  ],
  "programLabel": string
}
字段
loyaltyProgramTiers[]

object (LoyaltyProgramTiers)

可选。此配送服务的会员回馈活动层级。

programLabel

string

这是您在 Merchant Center 的会员回馈活动设置中设定的会员回馈活动标签。通过该子属性,Google 可以将您的会员回馈活动映射到符合条件的商品。

LoyaltyProgramTiers

商家会员回馈活动的子集。

JSON 表示法
{
  "tierLabel": string
}
字段
tierLabel

string

层级标签 [tierLabel] 子属性用于区分各个层级的商品级福利。此值也是在 Merchant Center 的会员回馈活动设置中设定的;即使您的会员回馈活动只有一个层级,在更改数据源时也必须提供此子属性。

仓库

用于存储和处理商品的履单仓库。

JSON 表示法
{
  "name": string,
  "shippingAddress": {
    object (Address)
  },
  "cutoffTime": {
    object (WarehouseCutoffTime)
  },
  "handlingDays": string,
  "businessDayConfig": {
    object (BusinessDayConfig)
  }
}
字段
name

string

必需。仓库的名称。在账号中必须是唯一的。

shippingAddress

object (Address)

必需。仓库的送货地址。

cutoffTime

object (WarehouseCutoffTime)

必需。可接受订单并开始处理的每日截止时间。之后的订单将在次日处理。时间取决于仓库的邮政编码。

handlingDays

string (int64 format)

必需。此仓库打包和配送商品所需的天数。这是仓库级别的设置,但可以根据商品的属性在商品级别替换。

businessDayConfig

object (BusinessDayConfig)

仓库的工作日。如果未设置,则默认为周一至周五。

地址

仓库的送货地址。

JSON 表示法
{
  "streetAddress": string,
  "city": string,
  "administrativeArea": string,
  "postalCode": string,
  "regionCode": string
}
字段
streetAddress

string

地址的街道级部分。例如:111w 31st Street

city

string

必需。城市、镇或公社。还可以包括乡镇/郊区或子级市行政区(例如街区或郊区)。

administrativeArea

string

必需。国家/地区的顶级行政区划。例如,加利福尼亚州(“CA”)或魁北克省(“QC”)等州/省。

postalCode

string

必需。邮政编码(例如“94043”)。

regionCode

string

必需。CLDR 国家/地区代码(例如“US”)。

WarehouseCutoffTime

可接受订单并开始处理的每日截止时间。之后的订单将在次日处理。时间取决于仓库的邮政编码。

JSON 表示法
{
  "hour": integer,
  "minute": integer
}
字段
hour

integer

必需。截止时间(小时),订单必须在此之前下单,仓库才能在当天处理。小时数以仓库所在的时区为准。

minute

integer

必需。截止时间的分钟数,订单必须在此之前下单,仓库才能在当天处理。分钟数取决于仓库所在的时区。

方法

getShippingSettings

检索配送设置信息。

insert

将商家的配送设置替换为“请求配送”设置。