We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

ShipmentInvoiceLineItemInvoice

JSON representation
{
  "lineItemId": string,
  "productId": string,
  "shipmentUnitIds": [
    string
  ],
  "unitInvoice": {
    object (UnitInvoice)
  }
}
Fields
lineItemId

string

ID of the line item. Either lineItemId or productId must be set.

productId

string

ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.

shipmentUnitIds[]

string

[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).

unitInvoice

object (UnitInvoice)

[required] Invoice details for a single unit.

UnitInvoice

JSON representation
{
  "unitPriceTaxes": [
    {
      object (UnitInvoiceTaxLine)
    }
  ],
  "additionalCharges": [
    {
      object (UnitInvoiceAdditionalCharge)
    }
  ],
  "unitPrice": {
    object (Price)
  }
}
Fields
unitPriceTaxes[]

object (UnitInvoiceTaxLine)

Tax amounts to apply to the unit price.

additionalCharges[]

object (UnitInvoiceAdditionalCharge)

Additional charges for a unit, e.g. shipping costs.

unitPrice

object (Price)

[required] Pre-tax or post-tax price of the unit depending on the locality of the order.

UnitInvoiceTaxLine

JSON representation
{
  "taxType": string,
  "taxAmount": {
    object (Price)
  },
  "taxName": string
}
Fields
taxType

string

[required] Type of the tax.

Acceptable values are:

  • "otherFee"
  • "otherFeeTax"
  • "sales"

taxAmount

object (Price)

[required] Tax amount for the tax type.

taxName

string

Optional name of the tax type. This should only be provided if taxType is otherFeeTax.

UnitInvoiceAdditionalCharge

JSON representation
{
  "type": string,
  "additionalChargeAmount": {
    object (Amount)
  }
}
Fields
type

string

[required] Type of the additional charge.

Acceptable values are:

  • "shipping"

additionalChargeAmount

object (Amount)

[required] Amount of the additional charge.