2024-08-26
▼ ▲ content.orderinvoices.createchargeinvoice
Path: {merchantId}/orderinvoices/{orderId}/createChargeInvoice
Flat Path: {merchantId}/orderinvoices/{orderId}/createChargeInvoice
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
▼ ▲ content.orderinvoices.createrefundinvoice
Path: {merchantId}/orderinvoices/{orderId}/createRefundInvoice
Flat Path: {merchantId}/orderinvoices/{orderId}/createRefundInvoice
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.
▼ ▲ content.orderreports.listdisbursements
Path: {merchantId}/orderreports/disbursements
Flat Path: {merchantId}/orderreports/disbursements
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
maxResults
Description: The maximum number of disbursements to return in the response, used for paging.
Location: query
Type: integer
Format: uint32
pageToken
Description: The token returned by the previous request.
Location: query
Type: string
disbursementStartDate
Description: The first date which disbursements occurred. In ISO 8601 format.
Location: query
Type: string
disbursementEndDate
Description: The last date which disbursements occurred. In ISO 8601 format. Default: current date.
Location: query
Type: string
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves a report for disbursements from your Merchant Center account.
▼ ▲ content.orderreports.listtransactions
Path: {merchantId}/orderreports/disbursements/{disbursementId}/transactions
Flat Path: {merchantId}/orderreports/disbursements/{disbursementId}/transactions
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
disbursementId
Description: The Google-provided ID of the disbursement (found in Wallet).
Location: path
Required: Yes
Type: string
maxResults
Description: The maximum number of disbursements to return in the response, used for paging.
Location: query
Type: integer
Format: uint32
pageToken
Description: The token returned by the previous request.
Location: query
Type: string
transactionStartDate
Description: The first date in which transaction occurred. In ISO 8601 format.
Location: query
Type: string
transactionEndDate
Description: The last date in which transaction occurred. In ISO 8601 format. Default: current date.
Location: query
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves a list of transactions for a disbursement from your Merchant Center account.
▼ ▲ content.orderreturns.acknowledge
Path: {merchantId}/orderreturns/{returnId}/acknowledge
Flat Path: {merchantId}/orderreturns/{returnId}/acknowledge
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
returnId
Description: The ID of the return.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Acks an order return in your Merchant Center account.
▼ ▲ content.orderreturns.createorderreturn
Path: {merchantId}/orderreturns/createOrderReturn
Flat Path: {merchantId}/orderreturns/createOrderReturn
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Description: Create return in your Merchant Center account.
▼ ▲ content.orderreturns.get
Path: {merchantId}/orderreturns/{returnId}
Flat Path: {merchantId}/orderreturns/{returnId}
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
returnId
Description: Merchant order return ID generated by Google.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves an order return from your Merchant Center account.
▼ ▲ content.orderreturns.list
Path: {merchantId}/orderreturns
Flat Path: {merchantId}/orderreturns
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
maxResults
Description: The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.
Location: query
Type: integer
Format: uint32
orderBy
Description: Return the results in the specified order.
Location: query
Type: string
Enum Descriptions:
Enum:
createdStartDate
Description: Obtains order returns created after this date (inclusively), in ISO 8601 format.
Location: query
Type: string
createdEndDate
Description: Obtains order returns created before this date (inclusively), in ISO 8601 format.
Location: query
Type: string
pageToken
Description: The token returned by the previous request.
Location: query
Type: string
shipmentTypes
Description: Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.
Location: query
Repeated: Yes
Type: string
Enum Descriptions:
Enum:
shipmentStatus
Description: Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.
Location: query
Repeated: Yes
Type: string
Enum Descriptions:
Enum:
shipmentStates
Description: Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.
Location: query
Repeated: Yes
Type: string
Enum Descriptions:
Enum:
acknowledged
Description: Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned.
Location: query
Type: boolean
googleOrderIds
Description: Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.
Location: query
Repeated: Yes
Type: string
shipmentTrackingNumbers
Description: Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.
Location: query
Repeated: Yes
Type: string
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Description: Lists order returns in your Merchant Center account.
▼ ▲ content.orderreturns.process
Path: {merchantId}/orderreturns/{returnId}/process
Flat Path: {merchantId}/orderreturns/{returnId}/process
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
returnId
Description: The ID of the return.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Processes return in your Merchant Center account.
▼ ▲ content.orderreturns.labels.create
Path: {merchantId}/orderreturns/{returnId}/labels
Flat Path: {merchantId}/orderreturns/{returnId}/labels
HTTP Method: POST
Parameters:
merchantId
Description: Required. The merchant the Return Shipping Label belongs to.
Location: path
Required: Yes
Type: string
Format: int64
returnId
Description: Required. Provide the Google-generated merchant order return ID.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Links a return shipping label to a return id. You can only create one return label per return id. Since the label is sent to the buyer, the linked return label cannot be updated or deleted. If you try to create multiple return shipping labels for a single return id, every create request except the first will fail.
▼ ▲ content.orders.acknowledge
Path: {merchantId}/orders/{orderId}/acknowledge
Flat Path: {merchantId}/orders/{orderId}/acknowledge
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Marks an order as acknowledged.
▼ ▲ content.orders.advancetestorder
Path: {merchantId}/testorders/{orderId}/advance
Flat Path: {merchantId}/testorders/{orderId}/advance
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the test order to modify.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".
▼ ▲ content.orders.cancel
Path: {merchantId}/orders/{orderId}/cancel
Flat Path: {merchantId}/orders/{orderId}/cancel
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order to cancel.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Cancels all line items in an order, making a full refund.
▼ ▲ content.orders.cancellineitem
Path: {merchantId}/orders/{orderId}/cancelLineItem
Flat Path: {merchantId}/orders/{orderId}/cancelLineItem
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Cancels a line item, making a full refund.
▼ ▲ content.orders.canceltestorderbycustomer
Path: {merchantId}/testorders/{orderId}/cancelByCustomer
Flat Path: {merchantId}/testorders/{orderId}/cancelByCustomer
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the test order to cancel.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Sandbox only. Cancels a test order for customer-initiated cancellation.
▼ ▲ content.orders.createtestorder
Path: {merchantId}/testorders
Flat Path: {merchantId}/testorders
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that should manage the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Description: Sandbox only. Creates a test order.
▼ ▲ content.orders.createtestreturn
Path: {merchantId}/orders/{orderId}/testreturn
Flat Path: {merchantId}/orders/{orderId}/testreturn
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Sandbox only. Creates a test return.
▼ ▲ content.orders.get
Path: {merchantId}/orders/{orderId}
Flat Path: {merchantId}/orders/{orderId}
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves an order from your Merchant Center account.
▼ ▲ content.orders.getbymerchantorderid
Path: {merchantId}/ordersbymerchantid/{merchantOrderId}
Flat Path: {merchantId}/ordersbymerchantid/{merchantOrderId}
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
merchantOrderId
Description: The merchant order ID to be looked for.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves an order using merchant order ID.
▼ ▲ content.orders.gettestordertemplate
Path: {merchantId}/testordertemplates/{templateName}
Flat Path: {merchantId}/testordertemplates/{templateName}
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that should manage the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
templateName
Description: The name of the template to retrieve.
Location: path
Required: Yes
Type: string
Enum Descriptions:
Enum:
country
Description: The country of the template to retrieve. Defaults to "`US`".
Location: query
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
▼ ▲ content.orders.instorerefundlineitem
Path: {merchantId}/orders/{orderId}/inStoreRefundLineItem
Flat Path: {merchantId}/orders/{orderId}/inStoreRefundLineItem
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding through Google then through an in-store return.
▼ ▲ content.orders.list
Path: {merchantId}/orders
Flat Path: {merchantId}/orders
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
maxResults
Description: The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
Location: query
Type: integer
Format: uint32
pageToken
Description: The token returned by the previous request.
Location: query
Type: string
statuses
Description: Obtains orders that match any of the specified statuses. Note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.
Location: query
Repeated: Yes
Type: string
Enum Descriptions:
Enum:
placedDateStart
Description: Obtains orders placed after this date (inclusively), in ISO 8601 format.
Location: query
Type: string
placedDateEnd
Description: Obtains orders placed before this date (exclusively), in ISO 8601 format.
Location: query
Type: string
orderBy
Description: Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc
Location: query
Type: string
acknowledged
Description: Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.
Location: query
Type: boolean
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Description: Lists the orders in your Merchant Center account.
▼ ▲ content.orders.refunditem
Path: {merchantId}/orders/{orderId}/refunditem
Flat Path: {merchantId}/orders/{orderId}/refunditem
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order to refund.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Issues a partial or total refund for items and shipment.
▼ ▲ content.orders.refundorder
Path: {merchantId}/orders/{orderId}/refundorder
Flat Path: {merchantId}/orders/{orderId}/refundorder
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order to refund.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Issues a partial or total refund for an order.
▼ ▲ content.orders.rejectreturnlineitem
Path: {merchantId}/orders/{orderId}/rejectReturnLineItem
Flat Path: {merchantId}/orders/{orderId}/rejectReturnLineItem
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Rejects return on an line item.
▼ ▲ content.orders.returnrefundlineitem
Path: {merchantId}/orders/{orderId}/returnRefundLineItem
Flat Path: {merchantId}/orders/{orderId}/returnRefundLineItem
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Returns and refunds a line item. Note that this method can only be called on fully shipped orders. The Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.
▼ ▲ content.orders.setlineitemmetadata
Path: {merchantId}/orders/{orderId}/setLineItemMetadata
Flat Path: {merchantId}/orders/{orderId}/setLineItemMetadata
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided through other methods. Submitted key-value pairs can be retrieved as part of the orders resource.
▼ ▲ content.orders.shiplineitems
Path: {merchantId}/orders/{orderId}/shipLineItems
Flat Path: {merchantId}/orders/{orderId}/shipLineItems
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Marks line item(s) as shipped.
▼ ▲ content.orders.updatelineitemshippingdetails
Path: {merchantId}/orders/{orderId}/updateLineItemShippingDetails
Flat Path: {merchantId}/orders/{orderId}/updateLineItemShippingDetails
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Updates ship by and delivery by dates for a line item.
▼ ▲ content.orders.updatemerchantorderid
Path: {merchantId}/orders/{orderId}/updateMerchantOrderId
Flat Path: {merchantId}/orders/{orderId}/updateMerchantOrderId
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Updates the merchant order ID for a given order.
▼ ▲ content.orders.updateshipment
Path: {merchantId}/orders/{orderId}/updateShipment
Flat Path: {merchantId}/orders/{orderId}/updateShipment
HTTP Method: POST
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: uint64
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Updates a shipment's status, carrier, and/or tracking ID.
▼ ▲ content.orders.captureOrder
Path: {merchantId}/orders/{orderId}/captureOrder
Flat Path: {merchantId}/orders/{orderId}/captureOrder
HTTP Method: POST
Parameters:
merchantId
Description: Required. The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Required: Yes
Type: string
Format: int64
orderId
Description: Required. The ID of the Order.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Capture funds from the customer for the current order total. This method should be called after the merchant verifies that they are able and ready to start shipping the order. This method blocks until a response is received from the payment processsor. If this method succeeds, the merchant is guaranteed to receive funds for the order after shipment. If the request fails, it can be retried or the order may be cancelled. This method cannot be called after the entire order is already shipped. A rejected error code is returned when the payment service provider has declined the charge. This indicates a problem between the PSP and either the merchant's or customer's account. Sometimes this error will be resolved by the customer. We recommend retrying these errors once per day or cancelling the order with reason `failedToCaptureFunds` if the items cannot be held.
▼ ▲ content.buyongoogleprograms.get
Path: {merchantId}/buyongoogleprograms/{regionCode}
Flat Path: {merchantId}/buyongoogleprograms/{regionCode}
HTTP Method: GET
Parameters:
merchantId
Description: Required. The ID of the account.
Location: path
Required: Yes
Type: string
Format: int64
regionCode
Description: Required. The Program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves a status of the BoG program for your Merchant Center account.
▼ ▲ content.buyongoogleprograms.patch
Path: {merchantId}/buyongoogleprograms/{regionCode}
Flat Path: {merchantId}/buyongoogleprograms/{regionCode}
HTTP Method: PATCH
Parameters:
merchantId
Description: Required. The ID of the account.
Location: path
Required: Yes
Type: string
Format: int64
regionCode
Description: Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.
Location: path
Required: Yes
Type: string
updateMask
Description: The list of fields to update. If the update mask is not provided, then all the fields set in buyOnGoogleProgramStatus will be updated. Clearing fields is only possible if update mask is provided.
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Updates the status of the BoG program for your Merchant Center account.
▼ ▲ content.buyongoogleprograms.onboard
Path: {merchantId}/buyongoogleprograms/{regionCode}/onboard
Flat Path: {merchantId}/buyongoogleprograms/{regionCode}/onboard
HTTP Method: POST
Parameters:
merchantId
Description: Required. The ID of the account.
Location: path
Required: Yes
Type: string
Format: int64
regionCode
Description: Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Onboards the BoG program in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.
▼ ▲ content.buyongoogleprograms.requestreview
Path: {merchantId}/buyongoogleprograms/{regionCode}/requestreview
Flat Path: {merchantId}/buyongoogleprograms/{regionCode}/requestreview
HTTP Method: POST
Parameters:
merchantId
Description: Required. The ID of the account.
Location: path
Required: Yes
Type: string
Format: int64
regionCode
Description: Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. This method is only available to selected merchants.
▼ ▲ content.buyongoogleprograms.activate
Path: {merchantId}/buyongoogleprograms/{regionCode}/activate
Flat Path: {merchantId}/buyongoogleprograms/{regionCode}/activate
HTTP Method: POST
Parameters:
merchantId
Description: Required. The ID of the account.
Location: path
Required: Yes
Type: string
Format: int64
regionCode
Description: Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, for example, when paused. This method is only available to selected merchants.
▼ ▲ content.buyongoogleprograms.pause
Path: {merchantId}/buyongoogleprograms/{regionCode}/pause
Flat Path: {merchantId}/buyongoogleprograms/{regionCode}/pause
HTTP Method: POST
Parameters:
merchantId
Description: Required. The ID of the account.
Location: path
Required: Yes
Type: string
Format: int64
regionCode
Description: Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants.