Content API for Shopping . orderinvoices

Instance Methods

close()

Close httplib2 connections.

createchargeinvoice(merchantId, orderId, body=None, x__xgafv=None)

Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.

createrefundinvoice(merchantId, orderId, body=None, x__xgafv=None)

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.

Method Details

close()
Close httplib2 connections.
createchargeinvoice(merchantId, orderId, body=None, x__xgafv=None)
Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body.
    The object takes the form of:

{
    "invoiceId": "A String", # [required] The ID of the invoice.
    "operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order.
    "invoiceSummary": { # [required] Invoice summary.
      "additionalChargeSummaries": [ # Summary of the total amounts of the additional charges.
        {
          "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
          "totalAmount": { # [required] Total additional charge for this type.
            "taxAmount": { # [required] Tax value.
              "value": "A String", # The price represented as a number.
              "currency": "A String", # The currency of the price.
            },
            "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order.
              "value": "A String", # The price represented as a number.
              "currency": "A String", # The currency of the price.
            },
          },
        },
      ],
      "productTotal": { # [required] Total price for the product.
        "taxAmount": { # [required] Tax value.
          "value": "A String", # The price represented as a number.
          "currency": "A String", # The currency of the price.
        },
        "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order.
          "value": "A String", # The price represented as a number.
          "currency": "A String", # The currency of the price.
        },
      },
    },
    "lineItemInvoices": [ # [required] Invoice details per line item.
      {
        "unitInvoice": { # [required] Invoice details for a single unit.
          "unitPriceTaxes": [ # Tax amounts to apply to the unit price.
            {
              "taxName": "A String", # Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.
              "taxAmount": { # [required] Tax amount for the tax type.
                "value": "A String", # The price represented as a number.
                "currency": "A String", # The currency of the price.
              },
              "taxType": "A String", # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`"
            },
          ],
          "unitPrice": { # [required] Pre-tax or post-tax price of the unit depending on the locality of the order.
            "value": "A String", # The price represented as a number.
            "currency": "A String", # The currency of the price.
          },
          "additionalCharges": [ # Additional charges for a unit, e.g. shipping costs.
            {
              "additionalChargeAmount": { # [required] Amount of the additional charge.
                "taxAmount": { # [required] Tax value.
                  "value": "A String", # The price represented as a number.
                  "currency": "A String", # The currency of the price.
                },
                "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order.
                  "value": "A String", # The price represented as a number.
                  "currency": "A String", # The currency of the price.
                },
              },
              "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
            },
          ],
        },
        "productId": "A String", # ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.
        "lineItemId": "A String", # ID of the line item. Either lineItemId or productId must be set.
        "shipmentUnitIds": [ # [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).
          "A String",
        ],
      },
    ],
    "shipmentGroupId": "A String", # [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse".
    "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
  }
createrefundinvoice(merchantId, orderId, body=None, x__xgafv=None)
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.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  orderId: string, The ID of the order. (required)
  body: object, The request body.
    The object takes the form of:

{
    "invoiceId": "A String", # [required] The ID of the invoice.
    "shipmentInvoices": [ # Invoice details for different shipment groups.
      {
        "shipmentGroupId": "A String", # [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.
        "lineItemInvoices": [ # [required] Invoice details per line item.
          {
            "unitInvoice": { # [required] Invoice details for a single unit.
              "unitPriceTaxes": [ # Tax amounts to apply to the unit price.
                {
                  "taxName": "A String", # Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.
                  "taxAmount": { # [required] Tax amount for the tax type.
                    "value": "A String", # The price represented as a number.
                    "currency": "A String", # The currency of the price.
                  },
                  "taxType": "A String", # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`"
                },
              ],
              "unitPrice": { # [required] Pre-tax or post-tax price of the unit depending on the locality of the order.
                "value": "A String", # The price represented as a number.
                "currency": "A String", # The currency of the price.
              },
              "additionalCharges": [ # Additional charges for a unit, e.g. shipping costs.
                {
                  "additionalChargeAmount": { # [required] Amount of the additional charge.
                    "taxAmount": { # [required] Tax value.
                      "value": "A String", # The price represented as a number.
                      "currency": "A String", # The currency of the price.
                    },
                    "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order.
                      "value": "A String", # The price represented as a number.
                      "currency": "A String", # The currency of the price.
                    },
                  },
                  "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
                },
              ],
            },
            "productId": "A String", # ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.
            "lineItemId": "A String", # ID of the line item. Either lineItemId or productId must be set.
            "shipmentUnitIds": [ # [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).
              "A String",
            ],
          },
        ],
        "invoiceSummary": { # [required] Invoice summary.
          "additionalChargeSummaries": [ # Summary of the total amounts of the additional charges.
            {
              "type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
              "totalAmount": { # [required] Total additional charge for this type.
                "taxAmount": { # [required] Tax value.
                  "value": "A String", # The price represented as a number.
                  "currency": "A String", # The currency of the price.
                },
                "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order.
                  "value": "A String", # The price represented as a number.
                  "currency": "A String", # The currency of the price.
                },
              },
            },
          ],
          "productTotal": { # [required] Total price for the product.
            "taxAmount": { # [required] Tax value.
              "value": "A String", # The price represented as a number.
              "currency": "A String", # The currency of the price.
            },
            "priceAmount": { # [required] The pre-tax or post-tax price depending on the location of the order.
              "value": "A String", # The price represented as a number.
              "currency": "A String", # The currency of the price.
            },
          },
        },
      },
    ],
    "refundOnlyOption": { # Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided.
      "description": "A String", # Optional description of the refund reason.
      "reason": "A String", # [required] Reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
    },
    "operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order.
    "returnOption": { # Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided.
      "reason": "A String", # [required] Reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
      "description": "A String", # Optional description of the return reason.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse".
  }