--- title: "POST /shippingsettings/batch" method: POST path: "/shippingsettings/batch" tags: ["shippingsettings"] --- # POST /shippingsettings/batch `POST /shippingsettings/batch` Retrieves and updates the shipping settings of multiple accounts in a single request. ## Request body - ShippingsettingsCustomBatchRequest - `entries` ShippingsettingsCustomBatchRequestEntry[] — The request entries to be processed in the batch. - `shippingSettings` ShippingSettings — The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role. - `accountId` string, uint64 — The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses. - `warehouses` Warehouse[] — Optional. A list of warehouses which can be referred to in `services`. - `name` string — Required. The name of the warehouse. Must be unique within account. - `cutoffTime` WarehouseCutoffTime - `hour` integer — Required. Hour (24-hour clock) of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. - `minute` integer — Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. - `handlingDays` string, int64 — Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. - `shippingAddress` Address - `country` string — Required. [CLDR country code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml) (for example, "US"). - `streetAddress` string — Street-level part of the address. Use `\n` to add a second line. - `postalCode` string — Required. Postal code or ZIP (for example, "94043"). - `city` string — Required. City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs). - `administrativeArea` string — Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). - `businessDayConfig` BusinessDayConfig - `businessDays` string[] — Regular business days, such as '"monday"'. May not be empty. - `postalCodeGroups` PostalCodeGroup[] — A list of postal code groups that can be referred to in `services`. Optional. - `postalCodeRanges` PostalCodeRange[] — A range of postal codes. Required. - `postalCodeRangeBegin` string — A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required. - `postalCodeRangeEnd` string — A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`. - `name` string — The name of the postal code group, referred to in headers. Required. - `country` string — The CLDR territory code of the country the postal code group applies to. Required. - `services` Service[] — The target account's list of services. Optional. - `active` boolean — A boolean exposing the active status of the shipping service. Required. - `minimumOrderValue` Price - `value` string — The price represented as a number. - `currency` string — The currency of the price. - `currency` string — The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. - `name` string — Free-form name of the service. Must be unique within target account. Required. - `eligibility` string — Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" - `storeConfig` ServiceStoreConfig — Stores that provide local delivery. Only valid with local delivery fulfillment. - `serviceRadius` Distance — Distance represented by an integer and unit. - `unit` string — The distance unit. Acceptable values are `None`, `Miles`, and `Kilometers`. - `value` string, int64 — The distance represented as a number. - `cutoffConfig` ServiceStoreConfigCutoffConfig — Time local delivery ends for the day based on the local timezone of the store. `local_cutoff_time` and `store_close_offset_hours` are mutually exclusive. - `noDeliveryPostCutoff` boolean — Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery. - `localCutoffTime` ServiceStoreConfigCutoffConfigLocalCutoffTime — Time in hours and minutes in the local timezone when local delivery ends. - … - `storeCloseOffsetHours` string, int64 — Represents cutoff time as the number of hours before store closing. Mutually exclusive with other fields (hour and minute). - `storeServiceType` string — Indicates whether all stores listed by this merchant provide local delivery or not. Acceptable values are `all stores` and `selected stores` - `storeCodes` string[] — A list of store codes that provide local delivery. If empty, then `store_service_type` must be `all_stores`, or an error is thrown. If not empty, then `store_service_type` must be `selected_stores`, or an error is thrown. - `rateGroups` RateGroup[] — Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap. - `name` string — Name of the rate group. Optional. If set has to be unique within shipping service. - `singleValue` Value — The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. - `flatRate` Price - … - `noShipping` boolean — If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set. - `pricePercentage` string — A percentage of the price represented as a number in decimal notation (for example, `"5.4"`). Can only be set if all other fields are not set. - `carrierRateName` string — The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. - `subtableName` string — The name of a subtable. Can only be set in table cells (not for single values), and only if all other fields are not set. - `carrierRates` CarrierRate[] — A list of carrier rates that can be referred to by `mainTable` or `singleValue`. - `carrierName` string — Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved through the `getSupportedCarriers` method. Required. - `carrierService` string — Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved through the `getSupportedCarriers` method. Required. - `percentageAdjustment` string — Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional. - `name` string — Name of the carrier rate. Must be unique per rate group. Required. - `originPostalCode` string — Shipping origin for this carrier rate. Required. - `flatAdjustment` Price - … - `subtables` Table[] — A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set. - `name` string — Name of the table. Required for subtables, ignored for the main table. - `rowHeaders` Headers — A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. - … - `columnHeaders` Headers — A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. - … - `rows` Row[] — The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required. - … - `mainTable` Table - `name` string — Name of the table. Required for subtables, ignored for the main table. - `rowHeaders` Headers — A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. - … - `columnHeaders` Headers — A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. - … - `rows` Row[] — The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required. - … - `applicableShippingLabels` string[] — A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required. - `shipmentType` string — Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup` (deprecated)" - "`local_delivery`" - "`collection_point`" - `deliveryCountry` string — The CLDR territory code of the country to which the service applies. Required. - `pickupService` PickupCarrierService - `carrierName` string — The name of the pickup carrier (for example, `"UPS"`). Required. - `serviceName` string — The name of the pickup service (for example, `"Access point"`). Required. - `deliveryTime` DeliveryTime - `holidayCutoffs` HolidayCutoff[] — Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping. - `deadlineTimezone` string — Timezone identifier for the deadline hour (for example, "Europe/Zurich"). List of identifiers. Required. - `deadlineDate` string — Date of the order deadline, in ISO 8601 format. For example, "2016-11-29" for 29th November 2016. Required. - `holidayId` string — Unique identifier for the holiday. Required. - `deadlineHour` integer — Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required. - `visibleFromDate` string — Date on which the deadline will become visible to consumers in ISO 8601 format. For example, "2016-10-31" for 31st October 2016. Required. - `minTransitTimeInDays` integer — Minimum number of business days that are spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both. - `cutoffTime` CutoffTime - `hour` integer — Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required. - `minute` integer — Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required. - `timezone` string — Timezone identifier for the cutoff time (for example, "Europe/Zurich"). List of identifiers. Required. - `transitTimeTable` TransitTable - `postalCodeGroupNames` string[] — A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. - `transitTimeLabels` string[] — A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`. - `rows` TransitTableTransitTimeRow[] - … - `handlingBusinessDayConfig` BusinessDayConfig - `businessDays` string[] — Regular business days, such as '"monday"'. May not be empty. - `maxTransitTimeInDays` integer — Maximum number of business days that are spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`. - `maxHandlingTimeInDays` integer — Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`. - `transitBusinessDayConfig` BusinessDayConfig - `businessDays` string[] — Regular business days, such as '"monday"'. May not be empty. - `minHandlingTimeInDays` integer — Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. - `warehouseBasedDeliveryTimes` WarehouseBasedDeliveryTime[] — Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set. - `carrierService` string — Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved through the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. - `originCity` string — Shipping origin's city. - `originCountry` string — Shipping origin's country represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). - `carrier` string — Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved through the `listSupportedCarriers` method. - `originPostalCode` string — Shipping origin. - `originAdministrativeArea` string — Shipping origin's state. - `warehouseName` string — The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse. - `originStreetAddress` string — Shipping origin's street address. - `minimumOrderValueTable` MinimumOrderValueTable - `storeCodeSetWithMovs` MinimumOrderValueTableStoreCodeSetWithMov[] - `value` Price - … - `storeCodes` string[] — A list of unique store codes or empty for the catch all. - `method` string — The method of the batch entry. Acceptable values are: - "`get`" - "`update`" - `merchantId` string, uint64 — The ID of the managing account. - `batchId` integer — An entry ID, unique within the batch request. - `accountId` string, uint64 — The ID of the account for which to get/update account shipping settings. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/content.md) · [All operations](https://skmtc.net/google/apis/content/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/content/revisions/1033388fc86f/schema)