Voorbeeldactie van orderitemsamenvattingen annuleren

Deze invoer is een door Apex gedefinieerde variabele van de klasse ConnectApi.ChangeInputRepresentation.

De variabele heeft één veld: changeItems. Dit veld bestaat uit een lijst door Apex gedefinieerde variabelen van de klasse ConnectApi.ChangeItemInputRepresentation. Elke variabele bevat deze velden:

• changeItemFees: een lijst met door Apex gedefinieerde variabelen van de klasse ConnectApi.ReturnOrderLineItemInputRepresentation. Elke variabele heeft deze velden:
  • amount: verplicht. Waarde die wordt gebruikt om het bedrag aan kosten te berekenen zoals voorgeschreven door het amountType. Dit moet een positieve waarde zijn.
  • amountType: verplicht. Beschrijft hoe het bedrag aan kosten wordt berekend. Dit kan een van de volgende waarden hebben:
    • AmountWithTax: amount is het kostenbedrag, inclusief belasting.
    • AmountWithoutTax: amount is het kostenbedrag, exclusief belasting. Belasting wordt berekend over de waarde en wordt er bij opgeteld.
    • Percentage: amount is een percentage. Het kostenbedrag is amount gedeeld door 100 en vervolgens vermenigvuldigd met de TotalPrice en TotalTaxAmount van de gekoppelde samenvatting van orderproduct, pro rata voor de hoeveelheid die wordt geretourneerd.
    • PercentageGross: amount is een percentage. Het kostenbedrag is amount gedeeld door 100 en vervolgens vermenigvuldigd met TotalLineAmountWithTax van de bijbehorende samenvatting van orderproduct, pro rata voor de hoeveelheid die wordt geretourneerd.
  • description: beschrijving van de kosten.
  • priceBookEntryId: verplicht tenzij prijslijsten optioneel zijn in de organisatie. ID van het prijslijstitem dat is gekoppeld aan de kosten product.
  • product2Id: verplicht. ID van het product dat de kosten vertegenwoordigt.
  • reason: verplicht. Reden voor de kosten. De waarde moet overeenkomen met een ingang in de keuzelijst Reden voor het object Wijziging in samenvatting van orderproduct.
• orderItemSummaryId: verplicht. ID van een te annuleren orderproductsamenvatting. Het kan geen verzendkostenproduct zijn.
• quantity: verplicht. Te annuleren hoeveelheid.
• reason: verplicht. Reden voor annuleren. De waarde moet overeenkomen met een van de waarden uit de keuzelijst op het Reden-veld van het Wijzigen-object Samenvatting van orderproduct,
• shippingReductionFlag: verplicht. Booleaanse vlag die aangeeft of gerelateerde leveringskosten naar rato moeten worden berekend op basis van de prijswijziging.

Deze uitvoer is een door Apex gedefinieerde variabele van de klasseConnectApi.PreviewCancelOutputRepresentation, die de waarden bevat waarmee een wijzigingsorderrecord zou worden gevuld voor de voorgestelde annulering.

Het teken van een waarde in het veld changeBalances is het tegenovergestelde van de bijbehorende waarde op een wijzigingsorderrecord. Een korting is bijvoorbeeld een positieve waarde in changeBalances en een negatieve waarde op een wijzigingsorderrecord.

Het veld orderSummaryId is de ID van de ordersamenvatting die is opgegeven in de invoer.

Het veld changeBalances is een door Apex gedefinieerde variabele van de klasse ConnectApi.ChangeItemOutputRepresentation, die de volgende velden bevat.

• grandTotalAmount: wijziging in het totaal inclusief belasting.
• totalAdjDeliveryAmtWithTax: wijziging in het subtotaal van aangepaste levering inclusief belasting.
• totalAdjDistAmountWithTax: wijziging in de totale orderaanpassingen inclusief belasting.
• totalAdjProductAmtWithTax: wijziging in het subtotaal van aangepast product inclusief belasting.
• totalAdjustedDeliveryAmount: wijziging in het subtotaal van aangepaste levering.
• totalAdjustedDeliveryTaxAmount: wijziging in de belasting van het subtotaal van aangepaste levering.
• totalAdjustedProductAmount: wijziging in het subtotaal van aangepast product.
• totalAdjustedProductTaxAmount: wijziging in de belasting van het subtotaal van aangepast product.
• totalAdjustmentDistributedAmount: wijziging in de totale orderaanpassingen.
• totalAdjustmentDistributedTaxAmount: wijziging in de totale belasting van de orderaanpassingen.
• totalAmount: wijziging in het totaal vóór belasting.
• totalExcessFundsAmount: het bedrag van extra fondsen beschikbaar op de samenvattingen van orderbetalingen gerelateerd aan de ordersamenvatting. Het is gelijk aan het vastgelegde bedrag dat is verschuldigd als een restitutie maar dat niet is gekoppeld aan een factuur of kredietmemo. Extra fondsen treden normaliter op wanneer orderproducten worden geannuleerd voordat ze worden uitgeleverd maar nadat de betaling is vastgelegd. Deze situatie doet zich zelden voor in de V.S. waar het gebruikelijk is dat fondsen worden geautoriseerd maar niet worden vastgelegd totdat het uitleveringsproces begint. De waarde is inclusief alle extra fondsen gerelateerd aan de ordersamenvatting, en niet alleen de fondsen gerelateerd aan de huidige actie.
• totalFeeAmount: het totaalbedrag van de kosten die in rekening zijn gebracht voor de annulering.
• totalFeeTaxAmount: het totaalbedrag aan belasting op de kosten die in rekening zijn gebracht voor de annulering.
• totalRefundableAmount: het totale bedrag beschikbaar voor restitutie. Het is de som van de extra fondsen plus alle eventueel uitstaande grand total bedragen voor wijzigingsorder die van toepassing zijn op wijzigingen na het uitleveren. De waarde is inclusief alle te restitueren bedragen gerelateerd aan de ordersamenvatting, en niet alleen de bedragen gerelateerd aan de huidige actie.
• totalTaxAmount: wijziging in de totale belasting.