Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

REST Resource: settlementtransactions

Resource: SettlementTransaction

Settlement transactions give a detailed breakdown of the settlement report.

JSON representation
{
  "identifiers": {
    object (SettlementTransactionIdentifiers)
  },
  "transaction": {
    object (SettlementTransactionTransaction)
  },
  "amount": {
    object (SettlementTransactionAmount)
  },
  "kind": string
}
Fields
identifiers

object (SettlementTransactionIdentifiers)

Identifiers of the transaction.

transaction

object (SettlementTransactionTransaction)

Details of the transaction.

amount

object (SettlementTransactionAmount)

The amount for the transaction.

kind

string

Identifies what kind of resource this is. Value: the fixed string "content#settlementTransaction"

SettlementTransactionIdentifiers

JSON representation
{
  "settlementEntryId": string,
  "transactionId": string,
  "merchantOrderId": string,
  "shipmentIds": [
    string
  ],
  "adjustmentId": string,
  "orderItemId": string
}
Fields
settlementEntryId

string

The unique ID of the settlement transaction entry.

transactionId

string

The Google transaction ID.

merchantOrderId

string

The merchant provided order ID.

shipmentIds[]

string

The shipment ids for the item.

adjustmentId

string

The identifier of the adjustments, if it is available.

orderItemId

string

The identifier of the item.

SettlementTransactionTransaction

JSON representation
{
  "type": string,
  "postDate": string
}
Fields
type

string

The type of the transaction that occurred.

Acceptable values are:

  • "order"
  • "reversal"
  • "orderRefund"
  • "reversalRefund"
  • "issueRelatedRefundAndReplacement"
  • "returnLabelShippingFeeTransaction"
  • "reversalIssueRelatedRefundAndReplacement"
  • "reversalReturnLabelShippingFeeTransaction"
  • "lumpSumCorrectionTransaction"

postDate

string

The time on which the event occurred in ISO 8601 format.

SettlementTransactionAmount

JSON representation
{
  "type": string,
  "description": string,
  "commission": {
    object (SettlementTransactionAmountCommission)
  },
  "transactionAmount": {
    object (Price)
  }
}
Fields
type

string

The type of the amount.

Acceptable values are:

  • "itemPrice"
  • "orderPrice"
  • "refund"
  • "earlyRefund"
  • "courtesyRefund"
  • "returnRefund"
  • "returnLabelShippingFeeAmount"
  • "lumpSumCorrectionAmount"

description

string

The description of the event.

Acceptable values are:

  • "taxWithhold"
  • "principal"
  • "principalAdjustment"
  • "shippingFee"
  • "merchantRemittedSalesTax"
  • "googleRemittedSalesTax"
  • "merchantCoupon"
  • "merchantCouponTax"
  • "merchantRemittedDisposalTax"
  • "googleRemittedDisposalTax"
  • "merchantRemittedRedemptionFee"
  • "googleRemittedRedemptionFee"
  • "eeeEcoFee"
  • "furnitureEcoFee"
  • "copyPrivateFee"
  • "eeeEcoFeeCommission"
  • "furnitureEcoFeeCommission"
  • "copyPrivateFeeCommission"
  • "principalRefund"
  • "principalRefundTax"
  • "itemCommission"
  • "adjustmentCommission"
  • "shippingFeeCommission"
  • "commissionRefund"
  • "damaged"
  • "damagedOrDefectiveItem"
  • "expiredItem"
  • "faultyItem"
  • "incorrectItemReceived"
  • "itemMissing"
  • "qualityNotExpected"
  • "receivedTooLate"
  • "storePackageMissing"
  • "transitPackageMissing"
  • "unsuccessfulDeliveryUndeliverable"
  • "wrongChargeInStore"
  • "wrongItem"
  • "returns"
  • "undeliverable"
  • "issueRelatedRefundAndReplacementAmountDescription"
  • "refundFromMerchant"
  • "returnLabelShippingFee"
  • "lumpSumCorrection"
  • "pspFee"

commission

object (SettlementTransactionAmountCommission)

transactionAmount

object (Price)

The amount that contributes to the line item price.

SettlementTransactionAmountCommission

JSON representation
{
  "category": string,
  "rate": string
}
Fields
category

string

The category of the commission.

Acceptable values are:

  • "animalsAndPetSupplies"
  • "dogCatFoodAndCatLitter"
  • "apparelAndAccessories"
  • "shoesHandbagsAndSunglasses"
  • "costumesAndAccessories"
  • "jewelry"
  • "watches"
  • "hobbiesArtsAndCrafts"
  • "homeAndGarden"
  • "entertainmentCollectibles"
  • "collectibleCoins"
  • "sportsCollectibles"
  • "sportingGoods"
  • "toysAndGames"
  • "musicalInstruments"
  • "giftCards"
  • "babyAndToddler"
  • "babyFoodWipesAndDiapers"
  • "businessAndIndustrial"
  • "camerasOpticsAndPhotography"
  • "consumerElectronics"
  • "electronicsAccessories"
  • "personalComputers"
  • "videoGameConsoles"
  • "foodAndGrocery"
  • "beverages"
  • "tobaccoProducts"
  • "furniture"
  • "hardware"
  • "buildingMaterials"
  • "tools"
  • "healthAndPersonalCare"
  • "beauty"
  • "householdSupplies"
  • "kitchenAndDining"
  • "majorAppliances"
  • "luggageAndBags"
  • "media"
  • "officeSupplies"
  • "softwareAndVideoGames"
  • "vehiclePartsAndAccessories"
  • "vehicleTiresAndWheels"
  • "vehicles"
  • "everythingElse"

rate

string

Rate of the commission in percentage.

Methods

list

Retrieves a list of transactions for the settlement.