Skip to content

Commit daa4e02

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
feat(merchantapi)!: update the API
BREAKING CHANGE: This release has breaking changes. #### merchantapi:accounts_v1beta The following keys were changed: - schemas.Accepted.description - schemas.CheckoutSettings.properties.eligibleDestinations.description - schemas.WarehouseBasedDeliveryTime.properties.warehouse.description #### merchantapi:inventories_v1beta The following keys were changed: - schemas.LocalInventory.properties.price.description - schemas.LocalInventory.properties.salePrice.description - schemas.LocalInventory.properties.salePriceEffectiveDate.description - schemas.RegionalInventory.properties.price.description - schemas.RegionalInventory.properties.salePrice.description - schemas.RegionalInventory.properties.salePriceEffectiveDate.description #### merchantapi:ordertracking_v1beta The following keys were deleted: - resources.accounts.resources.ordertrackingsignals.methods.create.description - resources.accounts.resources.ordertrackingsignals.methods.create.flatPath - resources.accounts.resources.ordertrackingsignals.methods.create.httpMethod - resources.accounts.resources.ordertrackingsignals.methods.create.id - resources.accounts.resources.ordertrackingsignals.methods.create.parameterOrder - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.orderTrackingSignalId.description - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.orderTrackingSignalId.location - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.orderTrackingSignalId.type - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.parent.description - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.parent.location - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.parent.pattern - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.parent.required - resources.accounts.resources.ordertrackingsignals.methods.create.parameters.parent.type - resources.accounts.resources.ordertrackingsignals.methods.create.path - resources.accounts.resources.ordertrackingsignals.methods.create.request.$ref - resources.accounts.resources.ordertrackingsignals.methods.create.response.$ref - resources.accounts.resources.ordertrackingsignals.methods.create.scopes The following keys were added: - resources.accounts.resources.orderTrackingSignals.methods.create.description - resources.accounts.resources.orderTrackingSignals.methods.create.flatPath - resources.accounts.resources.orderTrackingSignals.methods.create.httpMethod - resources.accounts.resources.orderTrackingSignals.methods.create.id - resources.accounts.resources.orderTrackingSignals.methods.create.parameterOrder - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.orderTrackingSignalId.description - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.orderTrackingSignalId.location - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.orderTrackingSignalId.type - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.parent.description - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.parent.location - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.parent.pattern - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.parent.required - resources.accounts.resources.orderTrackingSignals.methods.create.parameters.parent.type - resources.accounts.resources.orderTrackingSignals.methods.create.path - resources.accounts.resources.orderTrackingSignals.methods.create.request.$ref - resources.accounts.resources.orderTrackingSignals.methods.create.response.$ref - resources.accounts.resources.orderTrackingSignals.methods.create.scopes #### merchantapi:products_v1beta The following keys were changed: - resources.accounts.resources.productInputs.methods.delete.parameters.name.description - resources.accounts.resources.productInputs.methods.patch.parameters.name.description - resources.accounts.resources.products.methods.get.parameters.name.description - schemas.Product.properties.name.description - schemas.ProductInput.properties.name.description #### merchantapi:promotions_v1beta The following keys were changed: - schemas.Attributes.properties.promotionDestinations.description
1 parent 6a2dbef commit daa4e02

10 files changed

+46
-46
lines changed

‎discovery/merchantapi-accounts_v1beta.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2311,7 +2311,7 @@
23112311
}
23122312
}
23132313
},
2314-
"revision": "20250721",
2314+
"revision": "20250729",
23152315
"rootUrl": "https://merchantapi.googleapis.com/",
23162316
"schemas": {
23172317
"About": {
@@ -2356,7 +2356,7 @@
23562356
"type": "object"
23572357
},
23582358
"Accepted": {
2359-
"description": "Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service).",
2359+
"description": "Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service).",
23602360
"id": "Accepted",
23612361
"properties": {
23622362
"acceptedBy": {
@@ -2926,7 +2926,7 @@
29262926
"readOnly": true
29272927
},
29282928
"eligibleDestinations": {
2929-
"description": "Optional. The destinations to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`",
2929+
"description": "Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`",
29302930
"items": {
29312931
"enum": [
29322932
"DESTINATION_ENUM_UNSPECIFIED",
@@ -5406,7 +5406,7 @@
54065406
"type": "string"
54075407
},
54085408
"warehouse": {
5409-
"description": "Required. Warehouse name. This should match [warehouse](/merchant/api/reference/rest/accounts_v1beta/accounts.shippingSettings#warehouse)",
5409+
"description": "Required. Warehouse name. This should match warehouse.",
54105410
"type": "string"
54115411
}
54125412
},

‎discovery/merchantapi-inventories_v1beta.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@
300300
}
301301
}
302302
},
303-
"revision": "20250721",
303+
"revision": "20250727",
304304
"rootUrl": "https://merchantapi.googleapis.com/",
305305
"schemas": {
306306
"CustomAttribute": {
@@ -425,7 +425,7 @@
425425
},
426426
"price": {
427427
"$ref": "Price",
428-
"description": "Price of the product at this store."
428+
"description": "Optional. Price of the product at this store."
429429
},
430430
"quantity": {
431431
"description": "Quantity of the product available at this store. Must be greater than or equal to zero.",
@@ -434,11 +434,11 @@
434434
},
435435
"salePrice": {
436436
"$ref": "Price",
437-
"description": "Sale price of the product at this store. Mandatory if `salePriceEffectiveDate` is defined."
437+
"description": "Optional. Sale price of the product at this store. Mandatory if `salePriceEffectiveDate` is defined."
438438
},
439439
"salePriceEffectiveDate": {
440440
"$ref": "Interval",
441-
"description": "The `TimePeriod` of the sale at this store."
441+
"description": "Optional. The `TimePeriod` of the sale at this store."
442442
},
443443
"storeCode": {
444444
"description": "Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.",
@@ -642,19 +642,19 @@
642642
},
643643
"price": {
644644
"$ref": "Price",
645-
"description": "Price of the product in this region."
645+
"description": "Optional. Price of the product in this region."
646646
},
647647
"region": {
648648
"description": "Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details.",
649649
"type": "string"
650650
},
651651
"salePrice": {
652652
"$ref": "Price",
653-
"description": "Sale price of the product in this region. Mandatory if `salePriceEffectiveDate` is defined."
653+
"description": "Optional. Sale price of the product in this region. Mandatory if `salePriceEffectiveDate` is defined."
654654
},
655655
"salePriceEffectiveDate": {
656656
"$ref": "Interval",
657-
"description": "The `TimePeriod` of the sale price in this region."
657+
"description": "Optional. The `TimePeriod` of the sale price in this region."
658658
}
659659
},
660660
"type": "object"

‎discovery/merchantapi-ordertracking_v1beta.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@
107107
"resources": {
108108
"accounts": {
109109
"resources": {
110-
"ordertrackingsignals": {
110+
"orderTrackingSignals": {
111111
"methods": {
112112
"create": {
113113
"description": "Creates new order tracking signal.",
114-
"flatPath": "ordertracking/v1beta/accounts/{accountsId}/ordertrackingsignals",
114+
"flatPath": "ordertracking/v1beta/accounts/{accountsId}/orderTrackingSignals",
115115
"httpMethod": "POST",
116-
"id": "merchantapi.accounts.ordertrackingsignals.create",
116+
"id": "merchantapi.accounts.orderTrackingSignals.create",
117117
"parameterOrder": [
118118
"parent"
119119
],
@@ -131,7 +131,7 @@
131131
"type": "string"
132132
}
133133
},
134-
"path": "ordertracking/v1beta/{+parent}/ordertrackingsignals",
134+
"path": "ordertracking/v1beta/{+parent}/orderTrackingSignals",
135135
"request": {
136136
"$ref": "OrderTrackingSignal"
137137
},
@@ -147,7 +147,7 @@
147147
}
148148
}
149149
},
150-
"revision": "20250621",
150+
"revision": "20250727",
151151
"rootUrl": "https://merchantapi.googleapis.com/",
152152
"schemas": {
153153
"DateTime": {

‎discovery/merchantapi-products_v1beta.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
"type": "string"
125125
},
126126
"name": {
127-
"description": "Required. The name of the product input resource to delete. Format: `accounts/{account}/productInputs/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/productInputs/online~en~US~sku123`.",
127+
"description": "Required. The name of the product input resource to delete. Format: `accounts/{account}/productInputs/{product}` where the last section `product` consists of: `content_language~feed_label~offer_id` example for product name is `accounts/123/productInputs/en~US~sku123`.",
128128
"location": "path",
129129
"pattern": "^accounts/[^/]+/productInputs/[^/]+$",
130130
"required": true,
@@ -187,7 +187,7 @@
187187
"type": "string"
188188
},
189189
"name": {
190-
"description": "Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123`",
190+
"description": "Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of: `content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/en~US~sku123`. A legacy local product input name would be `accounts/123/productInputs/local~en~US~sku123`. Note: For calls to the v1beta version, the `productInput` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productInputs/online~en~US~sku123`.",
191191
"location": "path",
192192
"pattern": "^accounts/[^/]+/productInputs/[^/]+$",
193193
"required": true,
@@ -225,7 +225,7 @@
225225
],
226226
"parameters": {
227227
"name": {
228-
"description": "Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123`",
228+
"description": "Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of: `content_language~feed_label~offer_id` example for product name is `accounts/123/products/en~US~sku123`. A legacy local product name would be `accounts/123/products/local~en~US~sku123`. Note: For calls to the v1beta version, the `product` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.",
229229
"location": "path",
230230
"pattern": "^accounts/[^/]+/products/[^/]+$",
231231
"required": true,
@@ -281,7 +281,7 @@
281281
}
282282
}
283283
},
284-
"revision": "20250724",
284+
"revision": "20250727",
285285
"rootUrl": "https://merchantapi.googleapis.com/",
286286
"schemas": {
287287
"Attributes": {
@@ -1283,7 +1283,7 @@
12831283
"type": "string"
12841284
},
12851285
"name": {
1286-
"description": "The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123`",
1286+
"description": "The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of: `content_language~feed_label~offer_id` example for product name is `accounts/123/products/en~US~sku123`. A legacy local product name would be `accounts/123/products/local~en~US~sku123`. Note: For calls to the v1beta version, the `product` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.",
12871287
"type": "string"
12881288
},
12891289
"offerId": {
@@ -1464,7 +1464,7 @@
14641464
"type": "string"
14651465
},
14661466
"name": {
1467-
"description": "Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123`",
1467+
"description": "Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of: `content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/en~US~sku123`. A legacy local product input name would be `accounts/123/productInputs/local~en~US~sku123`. Note: For calls to the v1beta version, the `productInput` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/productInputs/online~en~US~sku123`.",
14681468
"type": "string"
14691469
},
14701470
"offerId": {

‎discovery/merchantapi-promotions_v1beta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@
203203
}
204204
}
205205
},
206-
"revision": "20250628",
206+
"revision": "20250727",
207207
"rootUrl": "https://merchantapi.googleapis.com/",
208208
"schemas": {
209209
"Attributes": {
@@ -380,7 +380,7 @@
380380
"type": "array"
381381
},
382382
"promotionDestinations": {
383-
"description": "Required. The list of destinations where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)",
383+
"description": "Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)",
384384
"items": {
385385
"enum": [
386386
"DESTINATION_ENUM_UNSPECIFIED",

‎src/apis/merchantapi/accounts_v1beta.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ export namespace merchantapi_accounts_v1beta {
140140
uri?: string | null;
141141
}
142142
/**
143-
* Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service).
143+
* Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service).
144144
*/
145145
export interface Schema$Accepted {
146146
/**
@@ -566,7 +566,7 @@ export namespace merchantapi_accounts_v1beta {
566566
*/
567567
effectiveUriSettings?: Schema$UriSettings;
568568
/**
569-
* Optional. The destinations to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
569+
* Optional. The destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`
570570
*/
571571
eligibleDestinations?: string[] | null;
572572
/**
@@ -2130,7 +2130,7 @@ export namespace merchantapi_accounts_v1beta {
21302130
*/
21312131
carrierService?: string | null;
21322132
/**
2133-
* Required. Warehouse name. This should match [warehouse](/merchant/api/reference/rest/accounts_v1beta/accounts.shippingSettings#warehouse)
2133+
* Required. Warehouse name. This should match warehouse.
21342134
*/
21352135
warehouse?: string | null;
21362136
}

‎src/apis/merchantapi/inventories_v1beta.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -217,19 +217,19 @@ export namespace merchantapi_inventories_v1beta {
217217
*/
218218
pickupSla?: string | null;
219219
/**
220-
* Price of the product at this store.
220+
* Optional. Price of the product at this store.
221221
*/
222222
price?: Schema$Price;
223223
/**
224224
* Quantity of the product available at this store. Must be greater than or equal to zero.
225225
*/
226226
quantity?: string | null;
227227
/**
228-
* Sale price of the product at this store. Mandatory if `salePriceEffectiveDate` is defined.
228+
* Optional. Sale price of the product at this store. Mandatory if `salePriceEffectiveDate` is defined.
229229
*/
230230
salePrice?: Schema$Price;
231231
/**
232-
* The `TimePeriod` of the sale at this store.
232+
* Optional. The `TimePeriod` of the sale at this store.
233233
*/
234234
salePriceEffectiveDate?: Schema$Interval;
235235
/**
@@ -333,19 +333,19 @@ export namespace merchantapi_inventories_v1beta {
333333
*/
334334
name?: string | null;
335335
/**
336-
* Price of the product in this region.
336+
* Optional. Price of the product in this region.
337337
*/
338338
price?: Schema$Price;
339339
/**
340340
* Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details.
341341
*/
342342
region?: string | null;
343343
/**
344-
* Sale price of the product in this region. Mandatory if `salePriceEffectiveDate` is defined.
344+
* Optional. Sale price of the product in this region. Mandatory if `salePriceEffectiveDate` is defined.
345345
*/
346346
salePrice?: Schema$Price;
347347
/**
348-
* The `TimePeriod` of the sale price in this region.
348+
* Optional. The `TimePeriod` of the sale price in this region.
349349
*/
350350
salePriceEffectiveDate?: Schema$Interval;
351351
}

‎src/apis/merchantapi/ordertracking_v1beta.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -400,10 +400,10 @@ export namespace merchantapi_ordertracking_v1beta {
400400

401401
export class Resource$Accounts {
402402
context: APIRequestContext;
403-
ordertrackingsignals: Resource$Accounts$Ordertrackingsignals;
403+
orderTrackingSignals: Resource$Accounts$Ordertrackingsignals;
404404
constructor(context: APIRequestContext) {
405405
this.context = context;
406-
this.ordertrackingsignals = new Resource$Accounts$Ordertrackingsignals(
406+
this.orderTrackingSignals = new Resource$Accounts$Ordertrackingsignals(
407407
this.context
408408
);
409409
}
@@ -445,7 +445,7 @@ export namespace merchantapi_ordertracking_v1beta {
445445
* google.options({auth: authClient});
446446
*
447447
* // Do the magic
448-
* const res = await merchantapi.accounts.ordertrackingsignals.create({
448+
* const res = await merchantapi.accounts.orderTrackingSignals.create({
449449
* // Output only. The ID that uniquely identifies this order tracking signal.
450450
* orderTrackingSignalId: 'placeholder-value',
451451
* // Required. The account of the business for which the order signal is created. Format: accounts/{account\}
@@ -557,7 +557,7 @@ export namespace merchantapi_ordertracking_v1beta {
557557
options: Object.assign(
558558
{
559559
url: (
560-
rootUrl + '/ordertracking/v1beta/{+parent}/ordertrackingsignals'
560+
rootUrl + '/ordertracking/v1beta/{+parent}/orderTrackingSignals'
561561
).replace(/([^:]\/)\/+/g, '$1'),
562562
method: 'POST',
563563
apiVersion: '',

0 commit comments

Comments
 (0)