Petra2 Java API – SjOrderFacadeInterface.cancel

Method description

Avbokar en hel beställning eller valda beställningsrader. Observera att raderna i beställningen kommer att finnas kvar även efter avbokningen, de har bara bytt status.

Vid avboka hel beställning avbokas rader som utifrån dess status (OrderItemStatus) borde kunna avbokas. T ex försöker men ej avboka rader som redan är avbokade. Detta ger att FailedOrderItemResultList i svaret innehåller allvarliga fel som t ex För sent att avboka.

Vid avboka enstaka rader försöker man avboka alla begärda rader. Detta ger att att FailedOrderItemResultList i svaret då även kan innehålla t ex Tidigare avbeställd.


For Javadoc, click here.

Input

CancelOrderSpecification

CancelWithWarning
Om flaggan är true kommer avbokning inte utföras om återköpsvärdet understiger aktuellt pris för någon rad. I dessa fall kommer en CancelOrderWarning att returneras i svaret.

OrderItemIdList
Om en eller flera beställningsrader anges kommer endast dessa att avbokas annars avbokas hela beställningen.

IgnoreResult
Om klienten inte är intresserad av resultatet så kan detta sättas till true. Då kommer ett tomt CancelOrderResult att returneras.

returnCreditAmount
Om true och avbokningen genomförs så returneras totala återköpsvärdet för aktuella rader.

ExternalEventSpecification
Används ifrån externa system där man har en egen varukorg.

Output

CancelOrderResult

Om en CancelOrderWarning returneras har ingenting avbokats. Annars har avbokningen gått bra förutom eventuella undantag i FailedOrderItemResultList. Om frågan är ställd med IgnoreResult=true komer ett tomt CancelOrderResult att returneras.

CancelOrderWarning
Ingenting har avbokats eftersom återköpsvärdet understiger aktuellt pris för någon rad. Förutsatt att man angett CancelWithWarning=true i frågan.

FailedOrderItemResultList
De beställningsrader som ej kunnde avbokats med förklaring. T ex för sent att avboka.

OrderDescription
En beskrivning av hur beställningen ser ut efter avbokningen.

CancellationReference
En avbokningsreferens som oftast skall visas/lämnas till användaren(kunden).

CreditAmount
Totala återköpsvärdet för de rader som avbokats i denna avbokning. Förutsatt att man angett returnCreditAmount=true i frågan.