Returns and refunds a line item. Note that this method can only be called on fully shipped orders.

Scopes

You will need authorization for the https://www.googleapis.com/auth/content scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/content. You can set the scope for this method like this: content2-sandbox --scope <scope> orders returnrefundlineitem ...

Required Scalar Arguments

  • <merchant-id> (string)
    • The ID of the account that manages the order. This cannot be a multi-client account.
  • <order-id> (string)
    • The ID of the order.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

OrdersReturnRefundLineItemRequest:
  amount-pretax:
    currency: string
    value: string
  amount-tax:
    currency: string
    value: string
  line-item-id: string
  operation-id: string
  product-id: string
  quantity: integer
  reason: string
  reason-text: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .amount-pretax currency=aliquyam
    • The currency of the price.

  • value=ipsum

    • The price represented as a number.

  • ..amount-tax currency=et

    • The currency of the price.

  • value=sanctus

    • The price represented as a number.

  • .. line-item-id=lorem

    • The ID of the line item to return. Either lineItemId or productId is required.
  • operation-id=est
    • The ID of the operation. Unique across all operations for a given order.
  • product-id=sed
    • The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity=72
    • The quantity to return and refund.
  • reason=dolores
    • The reason for the return.
  • reason-text=dolores
    • The explanation of the reason.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.