Method: orders.createWithCustomToken

  • This document explains the orders:createWithCustomToken method, which creates new Google Orders using a custom, Google-minted token.

  • Developers should include the userToken provided by Google in the request.

  • This process is typically used when developers or merchants directly save orders to Google on behalf of the order, rather than using Transactions or AMP flows.

  • The request body must include a header, order details (with at least one line item and a specified vertical), and the userToken.

  • A successful response will return the created Order object.

Creates and returns the new Order using a custom token minted by google. Developers using this method should set the userToken passed by google in the request. This method is used in cases where developers/merchant directly saves orders to Google on behalf of order (instead of Transactions and AMP flow).

HTTP request

POST https://actions.googleapis.com/v3/orders:createWithCustomToken

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "header": {
    object (OrderRequestHeader)
  },
  "order": {
    object (Order)
  },
  "userToken": string
}
Fields
header

object (OrderRequestHeader)

Required: Header for the create order request.

order

object (Order)

Required: Order to be created.

Note: 1. Following fields are always required to create a valid order: order.create_time, order.merchant_order_id, order.contents.line_items, order.contents.line_items.id 2. Order must have at-least 1 line item and line item must have defined vertical/extension. 3. All extensions (both at order level and line_item level) must map to 1 vertical type ie. an order is not a valid order if it represents more than 1 vertical.
userToken

string

Required: Encrypted token provided to partner by Google via asynchronous channel.

Response body

If successful, the response body contains an instance of Order.